defs.h 32.3 KB
Newer Older
1
/*******************************************************************************
2
    OpenAirInterface
ghaddab's avatar
ghaddab committed
3
    Copyright(c) 1999 - 2014 Eurecom
4

ghaddab's avatar
ghaddab committed
5 6 7 8
    OpenAirInterface is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
9 10


ghaddab's avatar
ghaddab committed
11 12 13 14
    OpenAirInterface is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
15

ghaddab's avatar
ghaddab committed
16
    You should have received a copy of the GNU General Public License
17 18
    along with OpenAirInterface.The full GNU General Public License is
   included in this distribution in the file called "COPYING". If not,
ghaddab's avatar
ghaddab committed
19
   see <http://www.gnu.org/licenses/>.
20 21

  Contact Information
ghaddab's avatar
ghaddab committed
22 23
  OpenAirInterface Admin: openair_admin@eurecom.fr
  OpenAirInterface Tech : openair_tech@eurecom.fr
24
  OpenAirInterface Dev  : openair4g-devel@lists.eurecom.fr
25

ghaddab's avatar
ghaddab committed
26
  Address      : Eurecom, Campus SophiaTech, 450 Route des Chappes, CS 50193 - 06904 Biot Sophia Antipolis cedex, FRANCE
27

ghaddab's avatar
ghaddab committed
28
 *******************************************************************************/
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47

/*! \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>
48 49
#include "common_lib.h"

50
//#include <complex.h>
51
#include "assertions.h"
52
#ifdef MEX
53
# define msg mexPrintf
54
#else
55 56 57 58 59 60
# ifdef OPENAIR2
#   include "log.h"
#   define msg(aRGS...) LOG_D(PHY, ##aRGS)
# else
#   define msg printf
# endif
61 62
#endif
//use msg in the real-time thread context
63
#define msg_nrt printf
64
//use msg_nrt in the non real-time context (for initialization, ...)
Cedric Roux's avatar
Cedric Roux committed
65 66 67 68 69 70
#ifndef malloc16
#  ifdef __AVX2__
#    define malloc16(x) memalign(32,x)
#  else
#    define malloc16(x) memalign(16,x)
#  endif
71
#endif
72 73 74 75 76 77
#define free16(y,x) free(y)
#define bigmalloc malloc
#define bigmalloc16 malloc16
#define openair_free(y,x) free((y))
#define PAGE_SIZE 4096

78 79 80 81 82 83 84
//#ifdef SHRLIBDEV
//extern int rxrescale;
//#define RX_IQRESCALELEN rxrescale
//#else
//#define RX_IQRESCALELEN 15
//#endif

85 86 87 88
//! \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 )
{
89 90 91
#ifdef __AVX2__
  void* ptr = memalign(32, size);
#else
92
  void* ptr = memalign(16, size);
93
#endif
94 95 96 97
  DevAssert(ptr);
  memset( ptr, 0, size );
  return ptr;
}
98

99 100


101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117
#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))

118 119 120
/// suppress compiler warning for unused arguments
#define UNUSED(x) (void)x;

121 122 123 124 125 126 127

#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"
128
#include "platform_types.h"
129 130

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

133 134
#include "targets/ARCH/COMMON/common_lib.h"

135 136 137 138
#define NUM_DCI_MAX 32

#define NUMBER_OF_eNB_SECTORS_MAX 3

139 140
#define NB_BANDS_MAX 8

141
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;
142

143
enum transmission_access_mode {
144 145 146 147 148
  NO_ACCESS=0,
  POSTPONED_ACCESS,
  CANCELED_ACCESS,
  UNKNOWN_ACCESS,
  SCHEDULED_ACCESS,
149 150
  CBA_ACCESS};

151
typedef enum  {
152
  eNodeB_3GPP=0,   // classical eNodeB function
153
  eNodeB_3GPP_BBU, // eNodeB with NGFI IF5
knopp's avatar
knopp committed
154 155 156 157
  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) 
158
} eNB_func_t;
159

160 161 162 163 164
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;

165 166
typedef struct UE_SCAN_INFO_s {
  /// 10 best amplitudes (linear) for each pss signals
167
  int32_t amp[3][10];
168
  /// 10 frequency offsets (kHz) corresponding to best amplitudes, with respect do minimum DL frequency in the band
169
  int32_t freq_offset_Hz[3][10];
170 171
} UE_SCAN_INFO_t;

172 173 174 175 176 177 178 179 180 181 182 183 184 185
/// 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];

} PHY_VARS_RN;

knopp's avatar
knopp committed
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
/// 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;
} eNB_rxtx_proc_t;
214 215 216 217 218 219 220 221 222 223 224 225 226 227 228

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
229
/// Context data structure for eNB subframe processing
230
typedef struct eNB_proc_t_s {
231
  /// Component Carrier index
232
  uint8_t              CC_id;
233 234 235 236
  /// thread index
  int thread_index;
  /// timestamp received from HW
  openair0_timestamp timestamp_rx;
237
  /// subframe to act upon for reception
knopp's avatar
knopp committed
238
  int subframe_rx;
239 240
  /// subframe to act upon for PRACH
  int subframe_prach;
241
  /// frame to act upon for reception
knopp's avatar
knopp committed
242
  int frame_rx;
243 244
  /// frame to act upon for PRACH
  int frame_prach;
245 246
  /// \internal This variable is protected by \ref mutex_fep.
  int instance_cnt_fep;
247 248 249 250
  /// \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;
251 252 253
  /// \brief Instance count for FH processing thread.
  /// \internal This variable is protected by \ref mutex_FH.
  int instance_cnt_FH;
254
  /// \brief Instance count for rx processing thread.
255 256
  /// \internal This variable is protected by \ref mutex_prach.
  int instance_cnt_prach;
257 258
  /// \internal This variable is protected by \ref mutex_asynch_rxtx.
  int instance_cnt_asynch_rxtx;
259 260
  /// pthread structure for FH processing thread
  pthread_t pthread_FH;
knopp's avatar
knopp committed
261 262
  /// pthread structure for eNB single processing thread
  pthread_t pthread_single;
263 264
  /// pthread structure for asychronous RX/TX processing thread
  pthread_t pthread_asynch_rxtx;
265 266
  /// flag to indicate first RX acquisition
  int first_rx;
knopp's avatar
knopp committed
267 268
  /// flag to indicate first TX transmission
  int first_tx;
269 270
  /// pthread attributes for parallel fep thread
  pthread_attr_t attr_fep;
271 272 273 274
  /// pthread attributes for parallel turbo-decoder thread
  pthread_attr_t attr_td;
  /// pthread attributes for parallel turbo-encoder thread
  pthread_attr_t attr_te;
275 276
  /// pthread attributes for FH processing thread
  pthread_attr_t attr_FH;
knopp's avatar
knopp committed
277 278
  /// pthread attributes for single eNB processing thread
  pthread_attr_t attr_single;
279 280
  /// pthread attributes for prach processing thread
  pthread_attr_t attr_prach;
281
  /// pthread attributes for asynchronous RX thread
282
  pthread_attr_t attr_asynch_rxtx;
283 284
  /// scheduling parameters for parallel fep thread
  struct sched_param sched_param_fep;
285 286 287 288
  /// 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;
289 290
  /// scheduling parameters for FH thread
  struct sched_param sched_param_FH;
knopp's avatar
knopp committed
291 292
  /// scheduling parameters for single eNB thread
  struct sched_param sched_param_single;
293 294
  /// scheduling parameters for prach thread
  struct sched_param sched_param_prach;
295 296
  /// scheduling parameters for asynch_rxtx thread
  struct sched_param sched_param_asynch_rxtx;
297 298
  /// pthread structure for parallel fep thread
  pthread_t pthread_fep;
299 300 301 302
  /// pthread structure for parallel turbo-decoder thread
  pthread_t pthread_td;
  /// pthread structure for parallel turbo-encoder thread
  pthread_t pthread_te;
303
  /// pthread structure for PRACH thread
knopp's avatar
knopp committed
304
  pthread_t pthread_prach;
305 306
  /// condition variable for parallel fep thread
  pthread_cond_t cond_fep;
307 308 309 310
  /// condition variable for parallel turbo-decoder thread
  pthread_cond_t cond_td;
  /// condition variable for parallel turbo-encoder thread
  pthread_cond_t cond_te;
311 312 313
  /// condition variable for FH thread
  pthread_cond_t cond_FH;
  /// condition variable for PRACH processing thread;
314
  pthread_cond_t cond_prach;
315 316
  /// condition variable for asynch RX/TX thread
  pthread_cond_t cond_asynch_rxtx;
317 318
  /// mutex for parallel fep thread
  pthread_mutex_t mutex_fep;
319 320 321 322
  /// mutex for parallel turbo-decoder thread
  pthread_mutex_t mutex_td;
  /// mutex for parallel turbo-encoder thread
  pthread_mutex_t mutex_te;
323 324 325
  /// mutex for FH
  pthread_mutex_t mutex_FH;
  /// mutex for PRACH thread
326
  pthread_mutex_t mutex_prach;
327 328
  /// mutex for asynch RX/TX thread
  pthread_mutex_t mutex_asynch_rxtx;
329 330 331 332
  /// parameters for turbo-decoding worker thread
  td_params tdp;
  /// parameters for turbo-encoding worker thread
  te_params tep;
knopp's avatar
knopp committed
333 334
  /// set of scheduling variables RXn-TXnp4 threads
  eNB_rxtx_proc_t proc_rxtx[2];
335 336 337 338
  /// number of slave threads
  int                  num_slaves;
  /// array of pointers to slaves
  struct eNB_proc_t_s           **slave_proc;
knopp's avatar
knopp committed
339 340
} eNB_proc_t;

341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376

/// 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
377 378 379 380 381 382
  /// 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;
383 384 385
  /// \brief Instance count for synch thread.
  /// \internal This variable is protected by \ref mutex_synch.
  int instance_cnt_synch;
knopp's avatar
knopp committed
386
  /// pthread attributes for synch processing thread
387 388 389 390 391 392 393 394 395 396 397 398
  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;
399 400

/// Top-level PHY Data Structure for eNB
401
typedef struct PHY_VARS_eNB_s {
402
  /// Module ID indicator for this instance
knopp's avatar
knopp committed
403 404
  module_id_t          Mod_id;
  uint8_t              CC_id;
405
  eNB_proc_t           proc;
406
  eNB_func_t           node_function;
407
  eNB_timing_t         node_timing;
knopp's avatar
knopp committed
408
  int                  single_thread_flag;
409
  openair0_rf_map      rf_map;
410
  int                  abstraction_flag;
knopp's avatar
knopp committed
411 412
  void                 (*do_prach)(struct PHY_VARS_eNB_s *eNB);
  void                 (*fep)(struct PHY_VARS_eNB_s *eNB);
413 414
  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 *);
415 416 417
  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
418
  void                 (*rx_fh)(struct PHY_VARS_eNB_s *eNB,int *frame, int *subframe);
419 420
  int                  (*start_rf)(struct PHY_VARS_eNB_s *eNB);
  int                  (*start_if)(struct PHY_VARS_eNB_s *eNB);
knopp's avatar
knopp committed
421
  void                 (*fh_asynch)(struct PHY_VARS_eNB_s *eNB,int *frame, int *subframe);
knopp's avatar
knopp committed
422
  uint8_t              local_flag;
423 424 425 426 427 428
  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;
429 430 431
  /// \brief ?.
  /// - first index: UE [0..NUMBER_OF_UE_MAX[ (hard coded)
  /// - second index: UE [0..NUMBER_OF_UE_MAX[
432 433 434 435 436 437 438 439
  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];
440 441

  /// cell-specific reference symbols
knopp's avatar
knopp committed
442 443 444 445
  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];
446

447
  /// mbsfn reference symbols
knopp's avatar
knopp committed
448
  uint32_t         lte_gold_mbsfn_table[10][3][42];
449

450
  uint32_t X_u[64][839];
451

452
  uint8_t pbch_pdu[4]; //PBCH_PDU_SIZE
453 454 455
  char eNB_generate_rar;

  /// Indicator set to 0 after first SR
456
  uint8_t first_sr[NUMBER_OF_UE_MAX];
457

458
  uint32_t max_peak_val;
459 460
  int max_eNB_id, max_sync_pos;

461
  int              N_TA_offset; ///timing offset used in TDD
462

463 464
  /// \brief sinr for all subcarriers of the current link (used only for abstraction).
  /// first index: ? [0..N_RB_DL*12[
465 466
  double *sinr_dB;

467
  /// N0 (used for abstraction)
468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484
  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

485
  /// if ==0 enables phy only test mode
486 487
  int mac_enabled;

488
  /// For emulation only (used by UE abstraction to retrieve DCI)
489 490
  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
491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514
  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];
515
  uint8_t ncs_cell[20][7];
516 517 518 519 520

  // Scheduling Request Config
  SCHEDULING_REQUEST_CONFIG scheduling_request_config[NUMBER_OF_UE_MAX];

  // Transmission mode per UE
521
  uint8_t transmission_mode[NUMBER_OF_UE_MAX];
522 523 524

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

526 527 528
  // Pointers for active physicalConfigDedicated to be applied in current subframe
  struct PhysicalConfigDedicated *physicalConfigDedicated[NUMBER_OF_UE_MAX];

529

530 531
  uint32_t rb_mask_ul[4];

532 533 534 535
  /// Information regarding TM5
  MU_MIMO_mode mu_mimo_mode[NUMBER_OF_UE_MAX];


536 537 538 539 540 541 542 543 544
  /// 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;

545
  ///check for Total Transmissions
knopp's avatar
knopp committed
546
  uint32_t check_for_total_transmissions;
547 548

  ///check for MU-MIMO Transmissions
knopp's avatar
knopp committed
549
  uint32_t check_for_MUMIMO_transmissions;
550 551

  ///check for SU-MIMO Transmissions
knopp's avatar
knopp committed
552
  uint32_t check_for_SUMIMO_transmissions;
553 554

  ///check for FULL MU-MIMO Transmissions
knopp's avatar
knopp committed
555
  uint32_t  FULL_MUMIMO_transmissions;
556 557

  /// Counter for total bitrate, bits and throughput in downlink
knopp's avatar
knopp committed
558 559 560
  uint32_t total_dlsch_bitrate;
  uint32_t total_transmitted_bits;
  uint32_t total_system_throughput;
561

562 563
  int              hw_timing_advance;

564 565 566 567
  time_stats_t phy_proc;
  time_stats_t phy_proc_tx;
  time_stats_t phy_proc_rx;
  time_stats_t rx_prach;
568

569 570 571
  time_stats_t ofdm_mod_stats;
  time_stats_t dlsch_encoding_stats;
  time_stats_t dlsch_modulation_stats;
572
  time_stats_t dlsch_scrambling_stats;
573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594
  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;
595

596 597 598
#ifdef LOCALIZATION
  /// time state for localization
  time_stats_t localization_stats;
599
#endif 
600

601 602
  int32_t pucch1_stats_cnt[NUMBER_OF_UE_MAX][10];
  int32_t pucch1_stats[NUMBER_OF_UE_MAX][10*1024];
603
  int32_t pucch1_stats_thres[NUMBER_OF_UE_MAX][10*1024];
604
  int32_t pucch1ab_stats_cnt[NUMBER_OF_UE_MAX][10];
605
  int32_t pucch1ab_stats[NUMBER_OF_UE_MAX][2*10*1024];
606 607 608 609 610
  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];
611 612 613 614
  
  /// RF and Interface devices per CC
  openair0_device rfdevice; 
  openair0_device ifdevice;
615 616
  /// Pointer for ifdevice buffer struct
  if_buffer_t ifbuffer;
gauthier's avatar
gauthier committed
617

618 619 620
} PHY_VARS_eNB;

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

622 623
/// Top-level PHY Data Structure for UE
typedef struct {
knopp's avatar
knopp committed
624
  /// \brief Module ID indicator for this instance
625
  uint8_t Mod_id;
knopp's avatar
knopp committed
626
  /// \brief Component carrier ID for this PHY instance
knopp's avatar
knopp committed
627
  uint8_t CC_id;
628 629
  /// \brief Mapping of CC_id antennas to cards
  openair0_rf_map      rf_map;
knopp's avatar
knopp committed
630 631 632 633 634
  //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;
635 636
  /// \brief Indicator that UE should perform coarse scanning around carrier
  int UE_scan_carrier;
knopp's avatar
knopp committed
637
  /// \brief Indicator that UE is synchronized to an eNB
638
  int is_synchronized;
639 640
  /// Data structure for UE process scheduling
  UE_proc_t proc;
641 642
  /// Flag to indicate the UE shouldn't do timing correction at all
  int no_timing_correction;
knopp's avatar
knopp committed
643
  /// \brief Total gain of the TX chain (16-bit baseband I/Q to antenna)
knopp's avatar
knopp committed
644
  uint32_t tx_total_gain_dB;
knopp's avatar
knopp committed
645
  /// \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.
646
  uint32_t rx_total_gain_dB;
knopp's avatar
knopp committed
647
  /// \brief Total gains with maximum RF gain stage (ExpressMIMO2/Lime)
knopp's avatar
knopp committed
648
  uint32_t rx_gain_max[4];
knopp's avatar
knopp committed
649
  /// \brief Total gains with medium RF gain stage (ExpressMIMO2/Lime)
knopp's avatar
knopp committed
650
  uint32_t rx_gain_med[4];
knopp's avatar
knopp committed
651
  /// \brief Total gains with bypassed RF gain stage (ExpressMIMO2/Lime)
knopp's avatar
knopp committed
652
  uint32_t rx_gain_byp[4];
knopp's avatar
knopp committed
653
  /// \brief Current transmit power
654
  int8_t tx_power_dBm[10];
knopp's avatar
knopp committed
655
  /// \brief Total number of REs in current transmission
656
  int tx_total_RE[10];
knopp's avatar
knopp committed
657
  /// \brief Maximum transmit power
658
  int8_t tx_power_max_dBm;
knopp's avatar
knopp committed
659
  /// \brief Number of eNB seen by UE
660
  uint8_t n_connected_eNB;
knopp's avatar
knopp committed
661
  /// \brief indicator that Handover procedure has been initiated
662
  uint8_t ho_initiated;
knopp's avatar
knopp committed
663
  /// \brief indicator that Handover procedure has been triggered
664
  uint8_t ho_triggered;
665
  /// \brief Measurement variables.
666 667
  PHY_MEASUREMENTS measurements;
  LTE_DL_FRAME_PARMS  frame_parms;
668
  /// \brief Frame parame before ho used to recover if ho fails.
669 670 671 672 673 674 675
  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];
676
  LTE_UE_PDSCH     *pdsch_vars_p[NUMBER_OF_CONNECTED_eNB_MAX+1];
677 678 679 680 681 682
  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];
683 684 685
  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];
686
  LTE_UE_DLSCH_t   *dlsch_MCH[NUMBER_OF_CONNECTED_eNB_MAX];
knopp's avatar
knopp committed
687 688 689
  // This is for SIC in the UE, to store the reencoded data
  LTE_eNB_DLSCH_t  *dlsch_eNB[NUMBER_OF_CONNECTED_eNB_MAX];

690 691 692 693 694
  //Paging parameters
  uint32_t              IMSImod1024;
  uint32_t              PF;
  uint32_t              PO;

695
  // For abstraction-purposes only
696 697 698
  uint8_t               sr[10];
  uint8_t               pucch_sel[10];
  uint8_t               pucch_payload[22];
699 700 701

  UE_MODE_t        UE_mode[NUMBER_OF_CONNECTED_eNB_MAX];
  /// cell-specific reference symbols
knopp's avatar
knopp committed
702 703 704 705
  uint32_t lte_gold_table[7][20][2][14];

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

knopp's avatar
knopp committed
707 708
  /// mbsfn reference symbols
  uint32_t lte_gold_mbsfn_table[10][3][42];
709

710
  uint32_t X_u[64][839];
711

712
  uint32_t high_speed_flag;
knopp's avatar
knopp committed
713
  uint32_t perfect_ce;
714
  int16_t ch_est_alpha;
715 716
  int generate_ul_signal[NUMBER_OF_CONNECTED_eNB_MAX];

717
  UE_SCAN_INFO_t scan_info[NB_BANDS_MAX];
718

719 720
  char ulsch_no_allocation_counter[NUMBER_OF_CONNECTED_eNB_MAX];

721 722


723 724 725
  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];
726 727
  PRACH_RESOURCES_t *prach_resources[NUMBER_OF_CONNECTED_eNB_MAX];
  int turbo_iterations, turbo_cntl_iterations;
728 729
  /// \brief ?.
  /// - first index: eNB [0..NUMBER_OF_CONNECTED_eNB_MAX[ (hard coded)
knopp's avatar
knopp committed
730
  uint32_t total_TBS[NUMBER_OF_CONNECTED_eNB_MAX];
731 732
  /// \brief ?.
  /// - first index: eNB [0..NUMBER_OF_CONNECTED_eNB_MAX[ (hard coded)
knopp's avatar
knopp committed
733
  uint32_t total_TBS_last[NUMBER_OF_CONNECTED_eNB_MAX];
734 735
  /// \brief ?.
  /// - first index: eNB [0..NUMBER_OF_CONNECTED_eNB_MAX[ (hard coded)
knopp's avatar
knopp committed
736
  uint32_t bitrate[NUMBER_OF_CONNECTED_eNB_MAX];
737 738
  /// \brief ?.
  /// - first index: eNB [0..NUMBER_OF_CONNECTED_eNB_MAX[ (hard coded)
knopp's avatar
knopp committed
739
  uint32_t total_received_bits[NUMBER_OF_CONNECTED_eNB_MAX];
740 741 742 743 744 745 746 747 748
  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];
749 750
  int dlsch_p_received[NUMBER_OF_CONNECTED_eNB_MAX];
  int dlsch_p_errors[NUMBER_OF_CONNECTED_eNB_MAX];
751 752 753 754 755 756 757 758
  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];
759 760
  int current_dlsch_cqi[NUMBER_OF_CONNECTED_eNB_MAX];
  unsigned char first_run_timing_advance[NUMBER_OF_CONNECTED_eNB_MAX];
761 762 763 764
  uint8_t               generate_prach;
  uint8_t               prach_cnt;
  uint8_t               prach_PreambleIndex;
  //  uint8_t               prach_timer;
765 766
  int              rx_offset; /// Timing offset
  int              timing_advance; ///timing advance signalled from eNB
767
  int              hw_timing_advance;
768
  int              N_TA_offset; ///timing offset used in TDD
769
  /// Flag to tell if UE is secondary user (cognitive mode)
770
  unsigned char    is_secondary_ue;
771
  /// Flag to tell if secondary eNB has channel estimates to create NULL-beams from.
772
  unsigned char    has_valid_precoder;
773 774 775
  /// hold the precoder for NULL beam to the primary eNB
  int              **ul_precoder_S_UE;
  /// holds the maximum channel/precoder coefficient
776
  char             log2_maxp;
777

778 779 780
  /// if ==0 enables phy only test mode
  int mac_enabled;

781
  /// Flag to initialize averaging of PHY measurements
782
  int init_averaging;
783

784 785
  /// \brief sinr for all subcarriers of the current link (used only for abstraction).
  /// - first index: ? [0..12*N_RB_DL[
786
  double *sinr_dB;
787

788 789
  /// \brief sinr for all subcarriers of first symbol for the CQI Calculation.
  /// - first index: ? [0..12*N_RB_DL[
790 791
  double *sinr_CQI_dB;

792 793 794
  /// sinr_effective used for CQI calulcation
  double sinr_eff;

795 796
  /// N0 (used for abstraction)
  double N0;
797

798 799 800 801 802
  /// 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];
803

804 805 806 807 808 809 810
  /// 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];

811
  uint8_t ncs_cell[20][7];
812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829

  /// 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
830
  uint8_t transmission_mode[NUMBER_OF_CONNECTED_eNB_MAX];
831

832 833 834
  time_stats_t phy_proc;
  time_stats_t phy_proc_tx;
  time_stats_t phy_proc_rx;
835

836 837
  uint32_t use_ia_receiver;

838 839 840 841 842 843 844 845 846 847
  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;
848
  time_stats_t dlsch_rx_pdcch_stats;
849 850 851 852 853 854 855 856 857
  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;
858
  time_stats_t dlsch_unscrambling_stats;
knopp's avatar
knopp committed
859 860 861
  time_stats_t dlsch_rate_matching_stats;
  time_stats_t dlsch_turbo_encoding_stats;
  time_stats_t dlsch_interleaving_stats;
862 863 864 865 866 867 868
  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;
869
  time_stats_t tx_prach;
870

knopp's avatar
knopp committed
871 872 873
  /// RF and Interface devices per CC
  openair0_device rfdevice; 

874 875
} PHY_VARS_UE;

876 877
void exit_fun(const char* s);

878
static inline int wait_on_condition(pthread_mutex_t *mutex,pthread_cond_t *cond,int *instance_cnt,char *name) {
879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899

  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);
}

900
static inline int wait_on_busy_condition(pthread_mutex_t *mutex,pthread_cond_t *cond,int *instance_cnt,char *name) {
901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921

  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);
}

922
static inline int release_thread(pthread_mutex_t *mutex,int *instance_cnt,char *name) {
923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938

  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);
}
939

940 941 942 943 944 945 946 947 948 949

#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__