defs.h 31 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
/*! \file PHY/defs.h
 \brief Top-level defines and structure definitions
 \author R. Knopp, F. Kaltenberger
 \date 2011
 \version 0.1
 \company Eurecom
 \email: knopp@eurecom.fr,florian.kaltenberger@eurecom.fr
 \note
 \warning
*/
#ifndef __PHY_DEFS__H__
#define __PHY_DEFS__H__

#include <stdio.h>
#include <stdlib.h>
#include <malloc.h>
#include <string.h>
#include <math.h>
19 20
#include "common_lib.h"

21
//#include <complex.h>
22
#include "assertions.h"
23
#ifdef MEX
24
# define msg mexPrintf
25
#else
26 27 28 29 30 31
# ifdef OPENAIR2
#   include "log.h"
#   define msg(aRGS...) LOG_D(PHY, ##aRGS)
# else
#   define msg printf
# endif
32 33
#endif
//use msg in the real-time thread context
34
#define msg_nrt printf
35
//use msg_nrt in the non real-time context (for initialization, ...)
Cedric Roux's avatar
Cedric Roux committed
36 37 38 39 40 41
#ifndef malloc16
#  ifdef __AVX2__
#    define malloc16(x) memalign(32,x)
#  else
#    define malloc16(x) memalign(16,x)
#  endif
42
#endif
43 44 45 46 47 48
#define free16(y,x) free(y)
#define bigmalloc malloc
#define bigmalloc16 malloc16
#define openair_free(y,x) free((y))
#define PAGE_SIZE 4096

49 50 51 52 53 54 55
//#ifdef SHRLIBDEV
//extern int rxrescale;
//#define RX_IQRESCALELEN rxrescale
//#else
//#define RX_IQRESCALELEN 15
//#endif

56 57 58 59
//! \brief Allocate \c size bytes of memory on the heap with alignment 16 and zero it afterwards.
//! If no more memory is available, this function will terminate the program with an assertion error.
static inline void* malloc16_clear( size_t size )
{
60 61 62
#ifdef __AVX2__
  void* ptr = memalign(32, size);
#else
63
  void* ptr = memalign(16, size);
64
#endif
65 66 67 68
  DevAssert(ptr);
  memset( ptr, 0, size );
  return ptr;
}
69

70 71


72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
#define PAGE_MASK 0xfffff000
#define virt_to_phys(x) (x)

#define openair_sched_exit() exit(-1)


#define max(a,b)  ((a)>(b) ? (a) : (b))
#define min(a,b)  ((a)<(b) ? (a) : (b))


#define bzero(s,n) (memset((s),0,(n)))

#define cmax(a,b)  ((a>b) ? (a) : (b))
#define cmin(a,b)  ((a<b) ? (a) : (b))

#define cmax3(a,b,c) ((cmax(a,b)>c) ? (cmax(a,b)) : (c))

89 90 91
/// suppress compiler warning for unused arguments
#define UNUSED(x) (void)x;

92 93 94 95 96 97 98

#include "impl_defs_top.h"
#include "impl_defs_lte.h"

#include "PHY/TOOLS/time_meas.h"
#include "PHY/CODING/defs.h"
#include "PHY/TOOLS/defs.h"
gauthier's avatar
gauthier committed
99
#include "platform_types.h"
100 101

#include "PHY/LTE_TRANSPORT/defs.h"
knopp's avatar
 
knopp committed
102
#include <pthread.h>
103

104 105
#include "targets/ARCH/COMMON/common_lib.h"

106 107 108 109
#define NUM_DCI_MAX 32

#define NUMBER_OF_eNB_SECTORS_MAX 3

110 111
#define NB_BANDS_MAX 8

112
typedef enum {normal_txrx=0,rx_calib_ue=1,rx_calib_ue_med=2,rx_calib_ue_byp=3,debug_prach=4,no_L2_connect=5,calib_prach_tx=6,rx_dump_frame=7,loop_through_memory=8} runmode_t;
113

114
enum transmission_access_mode {
115 116 117 118 119
  NO_ACCESS=0,
  POSTPONED_ACCESS,
  CANCELED_ACCESS,
  UNKNOWN_ACCESS,
  SCHEDULED_ACCESS,
120 121
  CBA_ACCESS};

122
typedef enum  {
123
  eNodeB_3GPP=0,   // classical eNodeB function
124
  eNodeB_3GPP_BBU, // eNodeB with NGFI IF5
knopp's avatar
knopp committed
125 126 127 128
  NGFI_RCC_IF4p5,  // NGFI_RCC (NGFI radio cloud center) 
  NGFI_RAU_IF4p5,
  NGFI_RRU_IF5,    // NGFI_RRU (NGFI remote radio-unit,IF5)
  NGFI_RRU_IF4p5   // NGFI_RRU (NGFI remote radio-unit,IF4p5) 
129
} eNB_func_t;
130

131 132 133 134
typedef enum {
  synch_to_ext_device=0,  // synch to RF or Ethernet device
  synch_to_other          // synch to another source (timer, other CC_id)
} eNB_timing_t;
135

136 137
typedef struct UE_SCAN_INFO_s {
  /// 10 best amplitudes (linear) for each pss signals
138
  int32_t amp[3][10];
139
  /// 10 frequency offsets (kHz) corresponding to best amplitudes, with respect do minimum DL frequency in the band
140
  int32_t freq_offset_Hz[3][10];
141 142
} UE_SCAN_INFO_t;

143 144 145 146 147 148 149 150 151 152 153
/// Top-level PHY Data Structure for RN
typedef struct {
  /// Module ID indicator for this instance
  uint8_t Mod_id;
  uint32_t frame;
  // phy_vars_eNB
  // phy_vars ue
  // cuurently only used to store and forward the PMCH
  uint8_t mch_avtive[10];
  uint8_t sync_area[10]; // num SF
  LTE_UE_DLSCH_t   *dlsch_rn_MCH[10];
154

155 156
} PHY_VARS_RN;

knopp's avatar
knopp committed
157
/// Context data structure for RX/TX portion of subframe processing
knopp's avatar
 
knopp committed
158
typedef struct {
159
  /// Component Carrier index
160
  uint8_t              CC_id;
knopp's avatar
knopp committed
161 162
  /// timestamp transmitted to HW
  openair0_timestamp timestamp_tx;
163
  /// subframe to act upon for transmission
knopp's avatar
 
knopp committed
164
  int subframe_tx;
165
  /// subframe to act upon for reception
knopp's avatar
 
knopp committed
166
  int subframe_rx;
167
  /// frame to act upon for transmission
knopp's avatar
 
knopp committed
168
  int frame_tx;
169
  /// frame to act upon for reception
knopp's avatar
 
knopp committed
170
  int frame_rx;
knopp's avatar
knopp committed
171 172 173 174 175 176 177
  /// \brief Instance count for RXn-TXnp4 processing thread.
  /// \internal This variable is protected by \ref mutex_rxtx.
  int instance_cnt_rxtx;
  /// pthread structure for RXn-TXnp4 processing thread
  pthread_t pthread_rxtx;
  /// pthread attributes for RXn-TXnp4 processing thread
  pthread_attr_t attr_rxtx;
knopp's avatar
 
knopp committed
178
  /// condition variable for tx processing thread
knopp's avatar
knopp committed
179 180 181 182 183 184
  pthread_cond_t cond_rxtx;
  /// mutex for RXn-TXnp4 processing thread
  pthread_mutex_t mutex_rxtx;
  /// scheduling parameters for RXn-TXnp4 thread
  struct sched_param sched_param_rxtx;
} eNB_rxtx_proc_t;
185 186 187 188 189 190 191 192 193 194 195 196 197 198 199

typedef struct {
  struct PHY_VARS_eNB_s *eNB;
  int UE_id;
  int harq_pid;
  int llr8_flag;
  int ret;
} td_params;

typedef struct {
  struct PHY_VARS_eNB_s *eNB;
  LTE_eNB_DLSCH_t *dlsch;
  int G;
} te_params;

knopp's avatar
 
knopp committed
200
/// Context data structure for eNB subframe processing
201
typedef struct eNB_proc_t_s {
202
  /// Component Carrier index
203
  uint8_t              CC_id;
204 205 206 207
  /// thread index
  int thread_index;
  /// timestamp received from HW
  openair0_timestamp timestamp_rx;
208
  /// subframe to act upon for reception
knopp's avatar
 
knopp committed
209
  int subframe_rx;
210 211
  /// subframe to act upon for PRACH
  int subframe_prach;
212
  /// frame to act upon for reception
knopp's avatar
 
knopp committed
213
  int frame_rx;
214 215
  /// frame to act upon for PRACH
  int frame_prach;
216 217
  /// \internal This variable is protected by \ref mutex_fep.
  int instance_cnt_fep;
218 219 220 221
  /// \internal This variable is protected by \ref mutex_td.
  int instance_cnt_td;
  /// \internal This variable is protected by \ref mutex_te.
  int instance_cnt_te;
222 223 224
  /// \brief Instance count for FH processing thread.
  /// \internal This variable is protected by \ref mutex_FH.
  int instance_cnt_FH;
225
  /// \brief Instance count for rx processing thread.
226 227
  /// \internal This variable is protected by \ref mutex_prach.
  int instance_cnt_prach;
228 229
  /// \internal This variable is protected by \ref mutex_asynch_rxtx.
  int instance_cnt_asynch_rxtx;
230 231
  /// pthread structure for FH processing thread
  pthread_t pthread_FH;
knopp's avatar
knopp committed
232 233
  /// pthread structure for eNB single processing thread
  pthread_t pthread_single;
234 235
  /// pthread structure for asychronous RX/TX processing thread
  pthread_t pthread_asynch_rxtx;
236 237
  /// flag to indicate first RX acquisition
  int first_rx;
knopp's avatar
knopp committed
238 239
  /// flag to indicate first TX transmission
  int first_tx;
240 241
  /// pthread attributes for parallel fep thread
  pthread_attr_t attr_fep;
242 243 244 245
  /// pthread attributes for parallel turbo-decoder thread
  pthread_attr_t attr_td;
  /// pthread attributes for parallel turbo-encoder thread
  pthread_attr_t attr_te;
246 247
  /// pthread attributes for FH processing thread
  pthread_attr_t attr_FH;
knopp's avatar
knopp committed
248 249
  /// pthread attributes for single eNB processing thread
  pthread_attr_t attr_single;
250 251
  /// pthread attributes for prach processing thread
  pthread_attr_t attr_prach;
252
  /// pthread attributes for asynchronous RX thread
253
  pthread_attr_t attr_asynch_rxtx;
254 255
  /// scheduling parameters for parallel fep thread
  struct sched_param sched_param_fep;
256 257 258 259
  /// scheduling parameters for parallel turbo-decoder thread
  struct sched_param sched_param_td;
  /// scheduling parameters for parallel turbo-encoder thread
  struct sched_param sched_param_te;
260 261
  /// scheduling parameters for FH thread
  struct sched_param sched_param_FH;
knopp's avatar
knopp committed
262 263
  /// scheduling parameters for single eNB thread
  struct sched_param sched_param_single;
264 265
  /// scheduling parameters for prach thread
  struct sched_param sched_param_prach;
266 267
  /// scheduling parameters for asynch_rxtx thread
  struct sched_param sched_param_asynch_rxtx;
268 269
  /// pthread structure for parallel fep thread
  pthread_t pthread_fep;
270 271 272 273
  /// pthread structure for parallel turbo-decoder thread
  pthread_t pthread_td;
  /// pthread structure for parallel turbo-encoder thread
  pthread_t pthread_te;
274
  /// pthread structure for PRACH thread
knopp's avatar
knopp committed
275
  pthread_t pthread_prach;
276 277
  /// condition variable for parallel fep thread
  pthread_cond_t cond_fep;
278 279 280 281
  /// condition variable for parallel turbo-decoder thread
  pthread_cond_t cond_td;
  /// condition variable for parallel turbo-encoder thread
  pthread_cond_t cond_te;
282 283 284
  /// condition variable for FH thread
  pthread_cond_t cond_FH;
  /// condition variable for PRACH processing thread;
285
  pthread_cond_t cond_prach;
286 287
  /// condition variable for asynch RX/TX thread
  pthread_cond_t cond_asynch_rxtx;
288 289
  /// mutex for parallel fep thread
  pthread_mutex_t mutex_fep;
290 291 292 293
  /// mutex for parallel turbo-decoder thread
  pthread_mutex_t mutex_td;
  /// mutex for parallel turbo-encoder thread
  pthread_mutex_t mutex_te;
294 295 296
  /// mutex for FH
  pthread_mutex_t mutex_FH;
  /// mutex for PRACH thread
297
  pthread_mutex_t mutex_prach;
298 299
  /// mutex for asynch RX/TX thread
  pthread_mutex_t mutex_asynch_rxtx;
300 301 302 303
  /// parameters for turbo-decoding worker thread
  td_params tdp;
  /// parameters for turbo-encoding worker thread
  te_params tep;
knopp's avatar
knopp committed
304 305
  /// set of scheduling variables RXn-TXnp4 threads
  eNB_rxtx_proc_t proc_rxtx[2];
306 307 308 309
  /// number of slave threads
  int                  num_slaves;
  /// array of pointers to slaves
  struct eNB_proc_t_s           **slave_proc;
knopp's avatar
 
knopp committed
310 311
} eNB_proc_t;

312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347

/// Context data structure for RX/TX portion of subframe processing
typedef struct {
  /// Component Carrier index
  uint8_t              CC_id;
  /// timestamp transmitted to HW
  openair0_timestamp timestamp_tx;
  /// subframe to act upon for transmission
  int subframe_tx;
  /// subframe to act upon for reception
  int subframe_rx;
  /// frame to act upon for transmission
  int frame_tx;
  /// frame to act upon for reception
  int frame_rx;
  /// \brief Instance count for RXn-TXnp4 processing thread.
  /// \internal This variable is protected by \ref mutex_rxtx.
  int instance_cnt_rxtx;
  /// pthread structure for RXn-TXnp4 processing thread
  pthread_t pthread_rxtx;
  /// pthread attributes for RXn-TXnp4 processing thread
  pthread_attr_t attr_rxtx;
  /// condition variable for tx processing thread
  pthread_cond_t cond_rxtx;
  /// mutex for RXn-TXnp4 processing thread
  pthread_mutex_t mutex_rxtx;
  /// scheduling parameters for RXn-TXnp4 thread
  struct sched_param sched_param_rxtx;
} UE_rxtx_proc_t;

/// Context data structure for eNB subframe processing
typedef struct {
  /// Component Carrier index
  uint8_t              CC_id;
  /// Last RX timestamp
  openair0_timestamp timestamp_rx;
knopp's avatar
knopp committed
348 349 350 351 352 353
  /// pthread attributes for main UE thread
  pthread_attr_t attr_ue;
  /// scheduling parameters for main UE thread
  struct sched_param sched_param_ue;
  /// pthread descriptor main UE thread
  pthread_t pthread_ue;
354 355 356
  /// \brief Instance count for synch thread.
  /// \internal This variable is protected by \ref mutex_synch.
  int instance_cnt_synch;
knopp's avatar
knopp committed
357
  /// pthread attributes for synch processing thread
358 359 360 361 362 363 364 365 366 367 368 369
  pthread_attr_t attr_synch;
  /// scheduling parameters for synch thread
  struct sched_param sched_param_synch;
  /// pthread descriptor synch thread
  pthread_t pthread_synch;
  /// condition variable for UE synch thread;
  pthread_cond_t cond_synch;
  /// mutex for UE synch thread
  pthread_mutex_t mutex_synch;
  /// set of scheduling variables RXn-TXnp4 threads
  UE_rxtx_proc_t proc_rxtx[2];
} UE_proc_t;
370 371

/// Top-level PHY Data Structure for eNB
372
typedef struct PHY_VARS_eNB_s {
373
  /// Module ID indicator for this instance
knopp's avatar
 
knopp committed
374 375
  module_id_t          Mod_id;
  uint8_t              CC_id;
376
  eNB_proc_t           proc;
377
  eNB_func_t           node_function;
378
  eNB_timing_t         node_timing;
knopp's avatar
knopp committed
379
  int                  single_thread_flag;
knopp's avatar
knopp committed
380
  openair0_rf_map      rf_map;
381
  int                  abstraction_flag;
knopp's avatar
knopp committed
382 383
  void                 (*do_prach)(struct PHY_VARS_eNB_s *eNB);
  void                 (*fep)(struct PHY_VARS_eNB_s *eNB);
384 385
  int                  (*td)(struct PHY_VARS_eNB_s *eNB,int UE_id,int harq_pid,int llr8_flag);
  int                  (*te)(struct PHY_VARS_eNB_s *,uint8_t *,uint8_t,LTE_eNB_DLSCH_t *,int,uint8_t,time_stats_t *,time_stats_t *,time_stats_t *);
386 387 388
  void                 (*proc_uespec_rx)(struct PHY_VARS_eNB_s *eNB,eNB_rxtx_proc_t *proc,const relaying_type_t r_type);
  void                 (*proc_tx)(struct PHY_VARS_eNB_s *eNB,eNB_rxtx_proc_t *proc,relaying_type_t r_type,PHY_VARS_RN *rn);
  void                 (*tx_fh)(struct PHY_VARS_eNB_s *eNB,eNB_rxtx_proc_t *proc);
knopp's avatar
knopp committed
389
  void                 (*rx_fh)(struct PHY_VARS_eNB_s *eNB,int *frame, int *subframe);
390 391
  int                  (*start_rf)(struct PHY_VARS_eNB_s *eNB);
  int                  (*start_if)(struct PHY_VARS_eNB_s *eNB);
knopp's avatar
knopp committed
392
  void                 (*fh_asynch)(struct PHY_VARS_eNB_s *eNB,int *frame, int *subframe);
knopp's avatar
 
knopp committed
393
  uint8_t              local_flag;
394 395 396 397 398 399
  uint32_t             rx_total_gain_dB;
  LTE_DL_FRAME_PARMS   frame_parms;
  PHY_MEASUREMENTS_eNB measurements[NUMBER_OF_eNB_SECTORS_MAX]; /// Measurement variables
  LTE_eNB_COMMON       common_vars;
  LTE_eNB_SRS          srs_vars[NUMBER_OF_UE_MAX];
  LTE_eNB_PBCH         pbch;
400 401 402
  /// \brief ?.
  /// - first index: UE [0..NUMBER_OF_UE_MAX[ (hard coded)
  /// - second index: UE [0..NUMBER_OF_UE_MAX[
403 404 405 406 407 408 409 410
  LTE_eNB_PUSCH       *pusch_vars[NUMBER_OF_UE_MAX];
  LTE_eNB_PRACH        prach_vars;
  LTE_eNB_DLSCH_t     *dlsch[NUMBER_OF_UE_MAX][2];   // Nusers times two spatial streams
  LTE_eNB_ULSCH_t     *ulsch[NUMBER_OF_UE_MAX+1];      // Nusers + number of RA
  LTE_eNB_DLSCH_t     *dlsch_SI,*dlsch_ra;
  LTE_eNB_DLSCH_t     *dlsch_MCH;
  LTE_eNB_UE_stats     UE_stats[NUMBER_OF_UE_MAX];
  LTE_eNB_UE_stats    *UE_stats_ptr[NUMBER_OF_UE_MAX];
411 412

  /// cell-specific reference symbols
knopp's avatar
 
knopp committed
413 414 415 416
  uint32_t         lte_gold_table[20][2][14];

  /// UE-specific reference symbols (p=7...14), TM 8/9/10
  uint32_t         lte_gold_uespec_table[2][20][2][21];
417

418
  /// mbsfn reference symbols
knopp's avatar
 
knopp committed
419
  uint32_t         lte_gold_mbsfn_table[10][3][42];
420

gauthier's avatar
gauthier committed
421
  uint32_t X_u[64][839];
422

gauthier's avatar
gauthier committed
423
  uint8_t pbch_pdu[4]; //PBCH_PDU_SIZE
424 425 426
  char eNB_generate_rar;

  /// Indicator set to 0 after first SR
gauthier's avatar
gauthier committed
427
  uint8_t first_sr[NUMBER_OF_UE_MAX];
428

429
  uint32_t max_peak_val;
430 431
  int max_eNB_id, max_sync_pos;

432
  int              N_TA_offset; ///timing offset used in TDD
433

434 435
  /// \brief sinr for all subcarriers of the current link (used only for abstraction).
  /// first index: ? [0..N_RB_DL*12[
436 437
  double *sinr_dB;

438
  /// N0 (used for abstraction)
439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455
  double N0;

  unsigned char first_run_timing_advance[NUMBER_OF_UE_MAX];
  unsigned char first_run_I0_measurements;

  unsigned char cooperation_flag; // for cooperative communication

  unsigned char    is_secondary_eNB; // primary by default
  unsigned char    is_init_sync;     /// Flag to tell if initial synchronization is performed. This affects how often the secondary eNB will listen to the PSS from the primary system.
  unsigned char    has_valid_precoder; /// Flag to tell if secondary eNB has channel estimates to create NULL-beams from, and this B/F vector is created.
  unsigned char    PeNB_id;          /// id of Primary eNB
  int              rx_offset;        /// Timing offset (used if is_secondary_eNB)

  /// hold the precoder for NULL beam to the primary user
  int              **dl_precoder_SeNB[3];
  char             log2_maxp; /// holds the maximum channel/precoder coefficient

456
  /// if ==0 enables phy only test mode
457 458
  int mac_enabled;

459
  /// For emulation only (used by UE abstraction to retrieve DCI)
gauthier's avatar
gauthier committed
460 461
  uint8_t num_common_dci[2];                         // num_dci in even/odd subframes
  uint8_t num_ue_spec_dci[2];                         // num_dci in even/odd subframes
462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485
  DCI_ALLOC_t dci_alloc[2][NUM_DCI_MAX]; // dci_alloc from even/odd subframes


  // PDSCH Varaibles
  PDSCH_CONFIG_DEDICATED pdsch_config_dedicated[NUMBER_OF_UE_MAX];

  // PUSCH Varaibles
  PUSCH_CONFIG_DEDICATED pusch_config_dedicated[NUMBER_OF_UE_MAX];

  // PUCCH variables
  PUCCH_CONFIG_DEDICATED pucch_config_dedicated[NUMBER_OF_UE_MAX];

  // UL-POWER-Control
  UL_POWER_CONTROL_DEDICATED ul_power_control_dedicated[NUMBER_OF_UE_MAX];

  // TPC
  TPC_PDCCH_CONFIG tpc_pdcch_config_pucch[NUMBER_OF_UE_MAX];
  TPC_PDCCH_CONFIG tpc_pdcch_config_pusch[NUMBER_OF_UE_MAX];

  // CQI reporting
  CQI_REPORT_CONFIG cqi_report_config[NUMBER_OF_UE_MAX];

  // SRS Variables
  SOUNDINGRS_UL_CONFIG_DEDICATED soundingrs_ul_config_dedicated[NUMBER_OF_UE_MAX];
gauthier's avatar
gauthier committed
486
  uint8_t ncs_cell[20][7];
487 488 489 490 491

  // Scheduling Request Config
  SCHEDULING_REQUEST_CONFIG scheduling_request_config[NUMBER_OF_UE_MAX];

  // Transmission mode per UE
gauthier's avatar
gauthier committed
492
  uint8_t transmission_mode[NUMBER_OF_UE_MAX];
493 494 495

  /// cba_last successful reception for each group, used for collision detection
  uint8_t cba_last_reception[4];
496

497 498 499
  // Pointers for active physicalConfigDedicated to be applied in current subframe
  struct PhysicalConfigDedicated *physicalConfigDedicated[NUMBER_OF_UE_MAX];

500

501 502
  uint32_t rb_mask_ul[4];

503 504 505 506
  /// Information regarding TM5
  MU_MIMO_mode mu_mimo_mode[NUMBER_OF_UE_MAX];


507 508 509 510 511 512 513 514 515
  /// target_ue_dl_mcs : only for debug purposes
  uint32_t target_ue_dl_mcs;
  /// target_ue_ul_mcs : only for debug purposes
  uint32_t target_ue_ul_mcs;
  /// target_ue_dl_rballoc : only for debug purposes
  uint32_t ue_dl_rb_alloc;
  /// target ul PRBs : only for debug
  uint32_t ue_ul_nb_rb;

516
  ///check for Total Transmissions
knopp's avatar
 
knopp committed
517
  uint32_t check_for_total_transmissions;
518 519

  ///check for MU-MIMO Transmissions
knopp's avatar
 
knopp committed
520
  uint32_t check_for_MUMIMO_transmissions;
521 522

  ///check for SU-MIMO Transmissions
knopp's avatar
 
knopp committed
523
  uint32_t check_for_SUMIMO_transmissions;
524 525

  ///check for FULL MU-MIMO Transmissions
knopp's avatar
 
knopp committed
526
  uint32_t  FULL_MUMIMO_transmissions;
527 528

  /// Counter for total bitrate, bits and throughput in downlink
knopp's avatar
 
knopp committed
529 530 531
  uint32_t total_dlsch_bitrate;
  uint32_t total_transmitted_bits;
  uint32_t total_system_throughput;
532

533 534
  int              hw_timing_advance;

535 536 537 538
  time_stats_t phy_proc;
  time_stats_t phy_proc_tx;
  time_stats_t phy_proc_rx;
  time_stats_t rx_prach;
539

540 541 542
  time_stats_t ofdm_mod_stats;
  time_stats_t dlsch_encoding_stats;
  time_stats_t dlsch_modulation_stats;
gauthier's avatar
gauthier committed
543
  time_stats_t dlsch_scrambling_stats;
544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565
  time_stats_t dlsch_rate_matching_stats;
  time_stats_t dlsch_turbo_encoding_stats;
  time_stats_t dlsch_interleaving_stats;

  time_stats_t ofdm_demod_stats;
  time_stats_t rx_dft_stats;
  time_stats_t ulsch_channel_estimation_stats;
  time_stats_t ulsch_freq_offset_estimation_stats;
  time_stats_t ulsch_decoding_stats;
  time_stats_t ulsch_demodulation_stats;
  time_stats_t ulsch_rate_unmatching_stats;
  time_stats_t ulsch_turbo_decoding_stats;
  time_stats_t ulsch_deinterleaving_stats;
  time_stats_t ulsch_demultiplexing_stats;
  time_stats_t ulsch_llr_stats;
  time_stats_t ulsch_tc_init_stats;
  time_stats_t ulsch_tc_alpha_stats;
  time_stats_t ulsch_tc_beta_stats;
  time_stats_t ulsch_tc_gamma_stats;
  time_stats_t ulsch_tc_ext_stats;
  time_stats_t ulsch_tc_intl1_stats;
  time_stats_t ulsch_tc_intl2_stats;
566

567 568 569
#ifdef LOCALIZATION
  /// time state for localization
  time_stats_t localization_stats;
570
#endif 
571

572 573
  int32_t pucch1_stats_cnt[NUMBER_OF_UE_MAX][10];
  int32_t pucch1_stats[NUMBER_OF_UE_MAX][10*1024];
574
  int32_t pucch1_stats_thres[NUMBER_OF_UE_MAX][10*1024];
575
  int32_t pucch1ab_stats_cnt[NUMBER_OF_UE_MAX][10];
576
  int32_t pucch1ab_stats[NUMBER_OF_UE_MAX][2*10*1024];
577 578 579 580 581
  int32_t pusch_stats_rb[NUMBER_OF_UE_MAX][10240];
  int32_t pusch_stats_round[NUMBER_OF_UE_MAX][10240];
  int32_t pusch_stats_mcs[NUMBER_OF_UE_MAX][10240];
  int32_t pusch_stats_bsr[NUMBER_OF_UE_MAX][10240];
  int32_t pusch_stats_BO[NUMBER_OF_UE_MAX][10240];
582 583 584 585
  
  /// RF and Interface devices per CC
  openair0_device rfdevice; 
  openair0_device ifdevice;
Sandeep Kumar's avatar
Sandeep Kumar committed
586 587
  /// Pointer for ifdevice buffer struct
  if_buffer_t ifbuffer;
gauthier's avatar
gauthier committed
588

589 590 591
} PHY_VARS_eNB;

#define debug_msg if (((mac_xface->frame%100) == 0) || (mac_xface->frame < 50)) msg
592

593 594
/// Top-level PHY Data Structure for UE
typedef struct {
knopp's avatar
 
knopp committed
595
  /// \brief Module ID indicator for this instance
gauthier's avatar
gauthier committed
596
  uint8_t Mod_id;
knopp's avatar
 
knopp committed
597
  /// \brief Component carrier ID for this PHY instance
knopp's avatar
 
knopp committed
598
  uint8_t CC_id;
knopp's avatar
knopp committed
599 600
  /// \brief Mapping of CC_id antennas to cards
  openair0_rf_map      rf_map;
knopp's avatar
 
knopp committed
601 602 603 604 605
  //uint8_t local_flag;
  /// \brief Indicator of current run mode of UE (normal_txrx, rx_calib_ue, no_L2_connect, debug_prach)
  runmode_t mode;
  /// \brief Indicator that UE should perform band scanning
  int UE_scan;
606 607
  /// \brief Indicator that UE should perform coarse scanning around carrier
  int UE_scan_carrier;
knopp's avatar
 
knopp committed
608
  /// \brief Indicator that UE is synchronized to an eNB
609
  int is_synchronized;
610 611
  /// Data structure for UE process scheduling
  UE_proc_t proc;
612 613
  /// Flag to indicate the UE shouldn't do timing correction at all
  int no_timing_correction;
knopp's avatar
 
knopp committed
614
  /// \brief Total gain of the TX chain (16-bit baseband I/Q to antenna)
knopp's avatar
 
knopp committed
615
  uint32_t tx_total_gain_dB;
knopp's avatar
 
knopp committed
616
  /// \brief Total gain of the RX chain (antenna to baseband I/Q) This is a function of rx_gain_mode (and the corresponding gain) and the rx_gain of the card.
617
  uint32_t rx_total_gain_dB;
knopp's avatar
 
knopp committed
618
  /// \brief Total gains with maximum RF gain stage (ExpressMIMO2/Lime)
knopp's avatar
 
knopp committed
619
  uint32_t rx_gain_max[4];
knopp's avatar
 
knopp committed
620
  /// \brief Total gains with medium RF gain stage (ExpressMIMO2/Lime)
knopp's avatar
 
knopp committed
621
  uint32_t rx_gain_med[4];
knopp's avatar
 
knopp committed
622
  /// \brief Total gains with bypassed RF gain stage (ExpressMIMO2/Lime)
knopp's avatar
 
knopp committed
623
  uint32_t rx_gain_byp[4];
knopp's avatar
 
knopp committed
624
  /// \brief Current transmit power
625
  int8_t tx_power_dBm[10];
knopp's avatar
 
knopp committed
626
  /// \brief Total number of REs in current transmission
627
  int tx_total_RE[10];
knopp's avatar
 
knopp committed
628
  /// \brief Maximum transmit power
gauthier's avatar
gauthier committed
629
  int8_t tx_power_max_dBm;
knopp's avatar
 
knopp committed
630
  /// \brief Number of eNB seen by UE
gauthier's avatar
gauthier committed
631
  uint8_t n_connected_eNB;
knopp's avatar
 
knopp committed
632
  /// \brief indicator that Handover procedure has been initiated
gauthier's avatar
gauthier committed
633
  uint8_t ho_initiated;
knopp's avatar
 
knopp committed
634
  /// \brief indicator that Handover procedure has been triggered
gauthier's avatar
gauthier committed
635
  uint8_t ho_triggered;
636
  /// \brief Measurement variables.
637 638
  PHY_MEASUREMENTS measurements;
  LTE_DL_FRAME_PARMS  frame_parms;
639
  /// \brief Frame parame before ho used to recover if ho fails.
640 641 642 643 644 645 646
  LTE_DL_FRAME_PARMS  frame_parms_before_ho;
  LTE_UE_COMMON    common_vars;

  LTE_UE_PDSCH     *pdsch_vars[NUMBER_OF_CONNECTED_eNB_MAX+1];
  LTE_UE_PDSCH_FLP *pdsch_vars_flp[NUMBER_OF_CONNECTED_eNB_MAX+1];
  LTE_UE_PDSCH     *pdsch_vars_SI[NUMBER_OF_CONNECTED_eNB_MAX+1];
  LTE_UE_PDSCH     *pdsch_vars_ra[NUMBER_OF_CONNECTED_eNB_MAX+1];
647
  LTE_UE_PDSCH     *pdsch_vars_p[NUMBER_OF_CONNECTED_eNB_MAX+1];
648 649 650 651 652 653
  LTE_UE_PDSCH     *pdsch_vars_MCH[NUMBER_OF_CONNECTED_eNB_MAX];
  LTE_UE_PBCH      *pbch_vars[NUMBER_OF_CONNECTED_eNB_MAX];
  LTE_UE_PDCCH     *pdcch_vars[NUMBER_OF_CONNECTED_eNB_MAX];
  LTE_UE_PRACH     *prach_vars[NUMBER_OF_CONNECTED_eNB_MAX];
  LTE_UE_DLSCH_t   *dlsch[NUMBER_OF_CONNECTED_eNB_MAX][2];
  LTE_UE_ULSCH_t   *ulsch[NUMBER_OF_CONNECTED_eNB_MAX];
654 655 656
  LTE_UE_DLSCH_t   *dlsch_SI[NUMBER_OF_CONNECTED_eNB_MAX];
  LTE_UE_DLSCH_t   *dlsch_ra[NUMBER_OF_CONNECTED_eNB_MAX];
  LTE_UE_DLSCH_t   *dlsch_p[NUMBER_OF_CONNECTED_eNB_MAX];
657
  LTE_UE_DLSCH_t   *dlsch_MCH[NUMBER_OF_CONNECTED_eNB_MAX];
knopp's avatar
knopp committed
658 659 660
  // This is for SIC in the UE, to store the reencoded data
  LTE_eNB_DLSCH_t  *dlsch_eNB[NUMBER_OF_CONNECTED_eNB_MAX];

661 662 663 664 665
  //Paging parameters
  uint32_t              IMSImod1024;
  uint32_t              PF;
  uint32_t              PO;

666
  // For abstraction-purposes only
gauthier's avatar
gauthier committed
667 668 669
  uint8_t               sr[10];
  uint8_t               pucch_sel[10];
  uint8_t               pucch_payload[22];
670 671 672

  UE_MODE_t        UE_mode[NUMBER_OF_CONNECTED_eNB_MAX];
  /// cell-specific reference symbols
knopp's avatar
 
knopp committed
673 674 675 676
  uint32_t lte_gold_table[7][20][2][14];

  /// ue-specific reference symbols
  uint32_t         lte_gold_uespec_table[2][20][2][21];
677

knopp's avatar
 
knopp committed
678 679
  /// mbsfn reference symbols
  uint32_t lte_gold_mbsfn_table[10][3][42];
680

gauthier's avatar
gauthier committed
681
  uint32_t X_u[64][839];
682

683
  uint32_t high_speed_flag;
knopp's avatar
 
knopp committed
684
  uint32_t perfect_ce;
685
  int16_t ch_est_alpha;
686 687
  int generate_ul_signal[NUMBER_OF_CONNECTED_eNB_MAX];

688
  UE_SCAN_INFO_t scan_info[NB_BANDS_MAX];
689

690 691
  char ulsch_no_allocation_counter[NUMBER_OF_CONNECTED_eNB_MAX];

692 693


694 695 696
  unsigned char ulsch_Msg3_active[NUMBER_OF_CONNECTED_eNB_MAX];
  uint32_t  ulsch_Msg3_frame[NUMBER_OF_CONNECTED_eNB_MAX];
  unsigned char ulsch_Msg3_subframe[NUMBER_OF_CONNECTED_eNB_MAX];
697 698
  PRACH_RESOURCES_t *prach_resources[NUMBER_OF_CONNECTED_eNB_MAX];
  int turbo_iterations, turbo_cntl_iterations;
699 700
  /// \brief ?.
  /// - first index: eNB [0..NUMBER_OF_CONNECTED_eNB_MAX[ (hard coded)
knopp's avatar
 
knopp committed
701
  uint32_t total_TBS[NUMBER_OF_CONNECTED_eNB_MAX];
702 703
  /// \brief ?.
  /// - first index: eNB [0..NUMBER_OF_CONNECTED_eNB_MAX[ (hard coded)
knopp's avatar
 
knopp committed
704
  uint32_t total_TBS_last[NUMBER_OF_CONNECTED_eNB_MAX];
705 706
  /// \brief ?.
  /// - first index: eNB [0..NUMBER_OF_CONNECTED_eNB_MAX[ (hard coded)
knopp's avatar
 
knopp committed
707
  uint32_t bitrate[NUMBER_OF_CONNECTED_eNB_MAX];
708 709
  /// \brief ?.
  /// - first index: eNB [0..NUMBER_OF_CONNECTED_eNB_MAX[ (hard coded)
knopp's avatar
 
knopp committed
710
  uint32_t total_received_bits[NUMBER_OF_CONNECTED_eNB_MAX];
711 712 713 714 715 716 717 718 719
  int dlsch_errors[NUMBER_OF_CONNECTED_eNB_MAX];
  int dlsch_errors_last[NUMBER_OF_CONNECTED_eNB_MAX];
  int dlsch_received[NUMBER_OF_CONNECTED_eNB_MAX];
  int dlsch_received_last[NUMBER_OF_CONNECTED_eNB_MAX];
  int dlsch_fer[NUMBER_OF_CONNECTED_eNB_MAX];
  int dlsch_SI_received[NUMBER_OF_CONNECTED_eNB_MAX];
  int dlsch_SI_errors[NUMBER_OF_CONNECTED_eNB_MAX];
  int dlsch_ra_received[NUMBER_OF_CONNECTED_eNB_MAX];
  int dlsch_ra_errors[NUMBER_OF_CONNECTED_eNB_MAX];
720 721
  int dlsch_p_received[NUMBER_OF_CONNECTED_eNB_MAX];
  int dlsch_p_errors[NUMBER_OF_CONNECTED_eNB_MAX];
722 723 724 725 726 727 728 729
  int dlsch_mch_received_sf[MAX_MBSFN_AREA][NUMBER_OF_CONNECTED_eNB_MAX];
  int dlsch_mch_received[NUMBER_OF_CONNECTED_eNB_MAX];
  int dlsch_mcch_received[MAX_MBSFN_AREA][NUMBER_OF_CONNECTED_eNB_MAX];
  int dlsch_mtch_received[MAX_MBSFN_AREA][NUMBER_OF_CONNECTED_eNB_MAX];
  int dlsch_mcch_errors[MAX_MBSFN_AREA][NUMBER_OF_CONNECTED_eNB_MAX];
  int dlsch_mtch_errors[MAX_MBSFN_AREA][NUMBER_OF_CONNECTED_eNB_MAX];
  int dlsch_mcch_trials[MAX_MBSFN_AREA][NUMBER_OF_CONNECTED_eNB_MAX];
  int dlsch_mtch_trials[MAX_MBSFN_AREA][NUMBER_OF_CONNECTED_eNB_MAX];
730 731
  int current_dlsch_cqi[NUMBER_OF_CONNECTED_eNB_MAX];
  unsigned char first_run_timing_advance[NUMBER_OF_CONNECTED_eNB_MAX];
gauthier's avatar
gauthier committed
732 733 734 735
  uint8_t               generate_prach;
  uint8_t               prach_cnt;
  uint8_t               prach_PreambleIndex;
  //  uint8_t               prach_timer;
736 737
  int              rx_offset; /// Timing offset
  int              timing_advance; ///timing advance signalled from eNB
738
  int              hw_timing_advance;
739
  int              N_TA_offset; ///timing offset used in TDD
740
  /// Flag to tell if UE is secondary user (cognitive mode)
741
  unsigned char    is_secondary_ue;
742
  /// Flag to tell if secondary eNB has channel estimates to create NULL-beams from.
743
  unsigned char    has_valid_precoder;
744 745 746
  /// hold the precoder for NULL beam to the primary eNB
  int              **ul_precoder_S_UE;
  /// holds the maximum channel/precoder coefficient
747
  char             log2_maxp;
748

749 750 751
  /// if ==0 enables phy only test mode
  int mac_enabled;

752
  /// Flag to initialize averaging of PHY measurements
753
  int init_averaging;
754

755 756
  /// \brief sinr for all subcarriers of the current link (used only for abstraction).
  /// - first index: ? [0..12*N_RB_DL[
757
  double *sinr_dB;
758

759 760
  /// \brief sinr for all subcarriers of first symbol for the CQI Calculation.
  /// - first index: ? [0..12*N_RB_DL[
761 762
  double *sinr_CQI_dB;

763 764 765
  /// sinr_effective used for CQI calulcation
  double sinr_eff;

766 767
  /// N0 (used for abstraction)
  double N0;
768

769 770 771 772 773
  /// PDSCH Varaibles
  PDSCH_CONFIG_DEDICATED pdsch_config_dedicated[NUMBER_OF_CONNECTED_eNB_MAX];

  /// PUSCH Varaibles
  PUSCH_CONFIG_DEDICATED pusch_config_dedicated[NUMBER_OF_CONNECTED_eNB_MAX];
774

775 776 777 778 779 780 781
  /// PUSCH contention-based access vars
  PUSCH_CA_CONFIG_DEDICATED  pusch_ca_config_dedicated[NUMBER_OF_eNB_MAX]; // lola

  /// PUCCH variables

  PUCCH_CONFIG_DEDICATED pucch_config_dedicated[NUMBER_OF_CONNECTED_eNB_MAX];

gauthier's avatar
gauthier committed
782
  uint8_t ncs_cell[20][7];
783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800

  /// UL-POWER-Control
  UL_POWER_CONTROL_DEDICATED ul_power_control_dedicated[NUMBER_OF_CONNECTED_eNB_MAX];

  /// TPC
  TPC_PDCCH_CONFIG tpc_pdcch_config_pucch[NUMBER_OF_CONNECTED_eNB_MAX];
  TPC_PDCCH_CONFIG tpc_pdcch_config_pusch[NUMBER_OF_CONNECTED_eNB_MAX];

  /// CQI reporting
  CQI_REPORT_CONFIG cqi_report_config[NUMBER_OF_CONNECTED_eNB_MAX];

  /// SRS Variables
  SOUNDINGRS_UL_CONFIG_DEDICATED soundingrs_ul_config_dedicated[NUMBER_OF_CONNECTED_eNB_MAX];

  /// Scheduling Request Config
  SCHEDULING_REQUEST_CONFIG scheduling_request_config[NUMBER_OF_CONNECTED_eNB_MAX];

  /// Transmission mode per eNB
gauthier's avatar
gauthier committed
801
  uint8_t transmission_mode[NUMBER_OF_CONNECTED_eNB_MAX];
802

803 804 805
  time_stats_t phy_proc;
  time_stats_t phy_proc_tx;
  time_stats_t phy_proc_rx;
806

807 808
  uint32_t use_ia_receiver;

809 810 811 812 813 814 815 816 817 818
  time_stats_t ofdm_mod_stats;
  time_stats_t ulsch_encoding_stats;
  time_stats_t ulsch_modulation_stats;
  time_stats_t ulsch_segmentation_stats;
  time_stats_t ulsch_rate_matching_stats;
  time_stats_t ulsch_turbo_encoding_stats;
  time_stats_t ulsch_interleaving_stats;
  time_stats_t ulsch_multiplexing_stats;

  time_stats_t ofdm_demod_stats;
819
  time_stats_t dlsch_rx_pdcch_stats;
820 821 822 823 824 825 826 827 828
  time_stats_t rx_dft_stats;
  time_stats_t dlsch_channel_estimation_stats;
  time_stats_t dlsch_freq_offset_estimation_stats;
  time_stats_t dlsch_decoding_stats;
  time_stats_t dlsch_demodulation_stats;
  time_stats_t dlsch_rate_unmatching_stats;
  time_stats_t dlsch_turbo_decoding_stats;
  time_stats_t dlsch_deinterleaving_stats;
  time_stats_t dlsch_llr_stats;
829
  time_stats_t dlsch_unscrambling_stats;
knopp's avatar
knopp committed
830 831 832
  time_stats_t dlsch_rate_matching_stats;
  time_stats_t dlsch_turbo_encoding_stats;
  time_stats_t dlsch_interleaving_stats;
833 834 835 836 837 838 839
  time_stats_t dlsch_tc_init_stats;
  time_stats_t dlsch_tc_alpha_stats;
  time_stats_t dlsch_tc_beta_stats;
  time_stats_t dlsch_tc_gamma_stats;
  time_stats_t dlsch_tc_ext_stats;
  time_stats_t dlsch_tc_intl1_stats;
  time_stats_t dlsch_tc_intl2_stats;
840
  time_stats_t tx_prach;
841

knopp's avatar
knopp committed
842 843 844
  /// RF and Interface devices per CC
  openair0_device rfdevice; 

845 846
} PHY_VARS_UE;

847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909
void exit_fun(const char* s);

inline int wait_on_condition(pthread_mutex_t *mutex,pthread_cond_t *cond,int *instance_cnt,char *name) {

  if (pthread_mutex_lock(mutex) != 0) {
    LOG_E( PHY, "[SCHED][eNB] error locking mutex for %s\n",name);
    exit_fun("nothing to add");
    return(-1);
  }
  
  while (*instance_cnt < 0) {
    // most of the time the thread is waiting here
    // proc->instance_cnt_rxtx is -1
    pthread_cond_wait(cond,mutex); // this unlocks mutex_rxtx while waiting and then locks it again
  }

  if (pthread_mutex_unlock(mutex) != 0) {
    LOG_E(PHY,"[SCHED][eNB] error unlocking mutex for %s\n",name);
    exit_fun("nothing to add");
    return(-1);
  }
  return(0);
}

inline int wait_on_busy_condition(pthread_mutex_t *mutex,pthread_cond_t *cond,int *instance_cnt,char *name) {

  if (pthread_mutex_lock(mutex) != 0) {
    LOG_E( PHY, "[SCHED][eNB] error locking mutex for %s\n",name);
    exit_fun("nothing to add");
    return(-1);
  }
  
  while (*instance_cnt == 0) {
    // most of the time the thread will skip this
    // waits only if proc->instance_cnt_rxtx is 0
    pthread_cond_wait(cond,mutex); // this unlocks mutex_rxtx while waiting and then locks it again
  }

  if (pthread_mutex_unlock(mutex) != 0) {
    LOG_E(PHY,"[SCHED][eNB] error unlocking mutex for %s\n",name);
    exit_fun("nothing to add");
    return(-1);
  }
  return(0);
}

inline int release_thread(pthread_mutex_t *mutex,int *instance_cnt,char *name) {

  if (pthread_mutex_lock(mutex) != 0) {
    LOG_E( PHY, "[SCHED][eNB] error locking mutex for %s\n",name);
    exit_fun("nothing to add");
    return(-1);
  }
  
  *instance_cnt=*instance_cnt-1;
  
  if (pthread_mutex_unlock(mutex) != 0) {
    LOG_E( PHY, "[SCHED][eNB] error unlocking mutex for %s\n",name);
    exit_fun("nothing to add");
    return(-1);
  }
  return(0);
}
910

911 912 913 914 915 916 917 918 919 920

#include "PHY/INIT/defs.h"
#include "PHY/LTE_REFSIG/defs.h"
#include "PHY/MODULATION/defs.h"
#include "PHY/LTE_TRANSPORT/proto.h"
#include "PHY/LTE_ESTIMATION/defs.h"

#include "SIMULATION/ETH_TRANSPORT/defs.h"

#endif //  __PHY_DEFS__H__