defs.h 32.5 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
/*
 * Licensed to the OpenAirInterface (OAI) Software Alliance under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The OpenAirInterface Software Alliance licenses this file to You under
 * the OAI Public License, Version 1.0  (the "License"); you may not use this file
 * except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.openairinterface.org/?page_id=698
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *-------------------------------------------------------------------------------
 * For more information about the OpenAirInterface (OAI) Software Alliance:
 *      contact@openairinterface.org
 */
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39

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

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

75 76 77 78 79 80 81
//#ifdef SHRLIBDEV
//extern int rxrescale;
//#define RX_IQRESCALELEN rxrescale
//#else
//#define RX_IQRESCALELEN 15
//#endif

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

96 97


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

115 116 117
/// suppress compiler warning for unused arguments
#define UNUSED(x) (void)x;

118 119 120 121 122 123 124

#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
125
#include "platform_types.h"
126

Thomas Laurent's avatar
Thomas Laurent committed
127 128
#ifdef OPENAIR_LTE

129
#include "PHY/LTE_TRANSPORT/defs.h"
130
#include <pthread.h>
131

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

134 135 136 137
#define NUM_DCI_MAX 32

#define NUMBER_OF_eNB_SECTORS_MAX 3

138 139
#define NB_BANDS_MAX 8

Thomas Laurent's avatar
Thomas Laurent committed
140 141 142
#ifdef OCP_FRAMEWORK
#include <enums.h>
#else
143
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;
144

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

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

162 163 164 165
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;
Thomas Laurent's avatar
Thomas Laurent committed
166
#endif
167

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

175 176 177 178 179 180 181 182 183 184 185 186 187 188
/// 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
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 214 215 216
/// 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;
217 218 219 220 221 222 223 224 225 226 227 228 229 230 231

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;

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

346 347 348

/// Context data structure for RX/TX portion of subframe processing
typedef struct {
Wilson's avatar
Wilson committed
349 350
  /// index of the current UE RX/TX proc
  int                  proc_id;
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 377 378 379 380 381 382 383
  /// 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
384 385 386 387 388 389
  /// 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;
390 391 392
  /// \brief Instance count for synch thread.
  /// \internal This variable is protected by \ref mutex_synch.
  int instance_cnt_synch;
knopp's avatar
knopp committed
393
  /// pthread attributes for synch processing thread
394 395 396 397 398 399 400 401 402 403 404 405
  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;
406 407

/// Top-level PHY Data Structure for eNB
408
typedef struct PHY_VARS_eNB_s {
409
  /// Module ID indicator for this instance
410 411
  module_id_t          Mod_id;
  uint8_t              CC_id;
412
  eNB_proc_t           proc;
413
  eNB_func_t           node_function;
414
  eNB_timing_t         node_timing;
knopp's avatar
knopp committed
415
  int                  single_thread_flag;
knopp's avatar
knopp committed
416
  openair0_rf_map      rf_map;
417
  int                  abstraction_flag;
knopp's avatar
knopp committed
418 419
  void                 (*do_prach)(struct PHY_VARS_eNB_s *eNB);
  void                 (*fep)(struct PHY_VARS_eNB_s *eNB);
420 421
  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 *);
422 423 424
  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
425
  void                 (*rx_fh)(struct PHY_VARS_eNB_s *eNB,int *frame, int *subframe);
426 427
  int                  (*start_rf)(struct PHY_VARS_eNB_s *eNB);
  int                  (*start_if)(struct PHY_VARS_eNB_s *eNB);
knopp's avatar
knopp committed
428
  void                 (*fh_asynch)(struct PHY_VARS_eNB_s *eNB,int *frame, int *subframe);
429
  uint8_t              local_flag;
430 431 432 433 434 435 436 437 438 439 440 441 442 443
  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;
  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];
444 445

  /// cell-specific reference symbols
446 447
  uint32_t         lte_gold_table[20][2][14];

448
  /// UE-specific reference symbols (p=5), TM 7
449
  uint32_t         lte_gold_uespec_port5_table[NUMBER_OF_UE_MAX][20][38];
450

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

454
  /// mbsfn reference symbols
455
  uint32_t         lte_gold_mbsfn_table[10][3][42];
456

457
  uint32_t X_u[64][839];
458

459
  uint8_t pbch_pdu[4]; //PBCH_PDU_SIZE
460 461 462
  char eNB_generate_rar;

  /// Indicator set to 0 after first SR
463
  uint8_t first_sr[NUMBER_OF_UE_MAX];
464

465
  uint32_t max_peak_val;
466 467
  int max_eNB_id, max_sync_pos;

468
  int              N_TA_offset; ///timing offset used in TDD
469

470 471
  /// \brief sinr for all subcarriers of the current link (used only for abstraction).
  /// first index: ? [0..N_RB_DL*12[
472 473
  double *sinr_dB;

474
  /// N0 (used for abstraction)
475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491
  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

492
  /// if ==0 enables phy only test mode
493 494
  int mac_enabled;

495
  /// For emulation only (used by UE abstraction to retrieve DCI)
496 497
  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
498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521
  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];
522
  uint8_t ncs_cell[20][7];
523 524 525 526 527

  // Scheduling Request Config
  SCHEDULING_REQUEST_CONFIG scheduling_request_config[NUMBER_OF_UE_MAX];

  // Transmission mode per UE
528
  uint8_t transmission_mode[NUMBER_OF_UE_MAX];
529 530 531

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

533 534 535
  // Pointers for active physicalConfigDedicated to be applied in current subframe
  struct PhysicalConfigDedicated *physicalConfigDedicated[NUMBER_OF_UE_MAX];

536

537 538
  uint32_t rb_mask_ul[4];

539 540 541 542
  /// Information regarding TM5
  MU_MIMO_mode mu_mimo_mode[NUMBER_OF_UE_MAX];


543 544 545 546 547 548 549 550 551
  /// 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;

552
  ///check for Total Transmissions
553
  uint32_t check_for_total_transmissions;
554 555

  ///check for MU-MIMO Transmissions
556
  uint32_t check_for_MUMIMO_transmissions;
557 558

  ///check for SU-MIMO Transmissions
559
  uint32_t check_for_SUMIMO_transmissions;
560 561

  ///check for FULL MU-MIMO Transmissions
562
  uint32_t  FULL_MUMIMO_transmissions;
563 564

  /// Counter for total bitrate, bits and throughput in downlink
565 566 567
  uint32_t total_dlsch_bitrate;
  uint32_t total_transmitted_bits;
  uint32_t total_system_throughput;
568

569 570
  int              hw_timing_advance;

571 572 573 574
  time_stats_t phy_proc;
  time_stats_t phy_proc_tx;
  time_stats_t phy_proc_rx;
  time_stats_t rx_prach;
575

576 577 578
  time_stats_t ofdm_mod_stats;
  time_stats_t dlsch_encoding_stats;
  time_stats_t dlsch_modulation_stats;
579
  time_stats_t dlsch_scrambling_stats;
580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601
  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;
602

603 604 605
#ifdef LOCALIZATION
  /// time state for localization
  time_stats_t localization_stats;
606
#endif 
607

608 609
  int32_t pucch1_stats_cnt[NUMBER_OF_UE_MAX][10];
  int32_t pucch1_stats[NUMBER_OF_UE_MAX][10*1024];
610
  int32_t pucch1_stats_thres[NUMBER_OF_UE_MAX][10*1024];
611
  int32_t pucch1ab_stats_cnt[NUMBER_OF_UE_MAX][10];
612
  int32_t pucch1ab_stats[NUMBER_OF_UE_MAX][2*10*1024];
613 614 615 616 617
  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];
618 619 620 621
  
  /// RF and Interface devices per CC
  openair0_device rfdevice; 
  openair0_device ifdevice;
Sandeep Kumar's avatar
Sandeep Kumar committed
622 623
  /// Pointer for ifdevice buffer struct
  if_buffer_t ifbuffer;
gauthier's avatar
gauthier committed
624

625 626 627
} PHY_VARS_eNB;

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

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

697 698 699 700 701
  //Paging parameters
  uint32_t              IMSImod1024;
  uint32_t              PF;
  uint32_t              PO;

702
  // For abstraction-purposes only
703 704 705
  uint8_t               sr[10];
  uint8_t               pucch_sel[10];
  uint8_t               pucch_payload[22];
706 707 708

  UE_MODE_t        UE_mode[NUMBER_OF_CONNECTED_eNB_MAX];
  /// cell-specific reference symbols
709 710
  uint32_t lte_gold_table[7][20][2][14];

711
  /// UE-specific reference symbols (p=5), TM 7
712
  uint32_t lte_gold_uespec_port5_table[20][38];
713

714
  /// ue-specific reference symbols
715
  uint32_t lte_gold_uespec_table[2][20][2][21];
716

717 718
  /// mbsfn reference symbols
  uint32_t lte_gold_mbsfn_table[10][3][42];
719

720
  uint32_t X_u[64][839];
721

722
  uint32_t high_speed_flag;
723
  uint32_t perfect_ce;
724
  int16_t ch_est_alpha;
725 726
  int generate_ul_signal[NUMBER_OF_CONNECTED_eNB_MAX];

727
  UE_SCAN_INFO_t scan_info[NB_BANDS_MAX];
728

729 730
  char ulsch_no_allocation_counter[NUMBER_OF_CONNECTED_eNB_MAX];

731 732


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

788 789 790
  /// if ==0 enables phy only test mode
  int mac_enabled;

791
  /// Flag to initialize averaging of PHY measurements
792
  int init_averaging;
793

794 795
  /// \brief sinr for all subcarriers of the current link (used only for abstraction).
  /// - first index: ? [0..12*N_RB_DL[
796
  double *sinr_dB;
797

798 799
  /// \brief sinr for all subcarriers of first symbol for the CQI Calculation.
  /// - first index: ? [0..12*N_RB_DL[
800 801
  double *sinr_CQI_dB;

802 803 804
  /// sinr_effective used for CQI calulcation
  double sinr_eff;

805 806
  /// N0 (used for abstraction)
  double N0;
807

808 809 810 811 812
  /// 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];
813

814 815 816 817 818 819 820
  /// 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];

821
  uint8_t ncs_cell[20][7];
822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839

  /// 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
840
  uint8_t transmission_mode[NUMBER_OF_CONNECTED_eNB_MAX];
841

842 843 844
  time_stats_t phy_proc;
  time_stats_t phy_proc_tx;
  time_stats_t phy_proc_rx;
845

846 847
  uint32_t use_ia_receiver;

848 849 850 851 852 853 854 855 856 857
  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;
858
  time_stats_t dlsch_rx_pdcch_stats;
859 860 861 862 863 864 865 866 867
  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;
868
  time_stats_t dlsch_unscrambling_stats;
knopp's avatar
knopp committed
869 870 871
  time_stats_t dlsch_rate_matching_stats;
  time_stats_t dlsch_turbo_encoding_stats;
  time_stats_t dlsch_interleaving_stats;
872 873 874 875 876 877 878
  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;
879
  time_stats_t tx_prach;
880

knopp's avatar
knopp committed
881 882 883
  /// RF and Interface devices per CC
  openair0_device rfdevice; 

884 885
} PHY_VARS_UE;

886 887
void exit_fun(const char* s);

888
static inline int wait_on_condition(pthread_mutex_t *mutex,pthread_cond_t *cond,int *instance_cnt,char *name) {
889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909

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

910
static inline int wait_on_busy_condition(pthread_mutex_t *mutex,pthread_cond_t *cond,int *instance_cnt,char *name) {
911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931

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

932
static inline int release_thread(pthread_mutex_t *mutex,int *instance_cnt,char *name) {
933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948

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

950 951 952 953 954 955 956 957

#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"
Thomas Laurent's avatar
Thomas Laurent committed
958
#endif
959
#endif //  __PHY_DEFS__H__