defs.h 27.4 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
# ifdef OPENAIR2
56
#   if ENABLE_RAL
57 58 59 60
#     include "collection/hashtable/hashtable.h"
#     include "COMMON/ral_messages_types.h"
#     include "UTIL/queue.h"
#   endif
61 62 63 64 65
#   include "log.h"
#   define msg(aRGS...) LOG_D(PHY, ##aRGS)
# else
#   define msg printf
# endif
66 67
#endif
//use msg in the real-time thread context
68
#define msg_nrt printf
69
//use msg_nrt in the non real-time context (for initialization, ...)
Cedric Roux's avatar
Cedric Roux committed
70 71 72 73 74 75
#ifndef malloc16
#  ifdef __AVX2__
#    define malloc16(x) memalign(32,x)
#  else
#    define malloc16(x) memalign(16,x)
#  endif
76
#endif
77 78 79 80 81 82
#define free16(y,x) free(y)
#define bigmalloc malloc
#define bigmalloc16 malloc16
#define openair_free(y,x) free((y))
#define PAGE_SIZE 4096

83 84 85 86 87 88 89
//#ifdef SHRLIBDEV
//extern int rxrescale;
//#define RX_IQRESCALELEN rxrescale
//#else
//#define RX_IQRESCALELEN 15
//#endif

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

104 105


106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122
#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))

123 124 125
/// suppress compiler warning for unused arguments
#define UNUSED(x) (void)x;

126 127 128 129 130 131 132

#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"
133
#include "platform_types.h"
134 135 136 137 138 139

#ifdef OPENAIR_LTE

//#include "PHY/LTE_ESTIMATION/defs.h"

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

142 143
#include "targets/ARCH/COMMON/common_lib.h"

144 145 146 147
#define NUM_DCI_MAX 32

#define NUMBER_OF_eNB_SECTORS_MAX 3

148 149
#define NB_BANDS_MAX 8

150
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;
151

152
enum transmission_access_mode {
153 154 155 156 157
  NO_ACCESS=0,
  POSTPONED_ACCESS,
  CANCELED_ACCESS,
  UNKNOWN_ACCESS,
  SCHEDULED_ACCESS,
158 159
  CBA_ACCESS};

160
typedef enum  {
161
  eNodeB_3GPP=0,   // classical eNodeB function
162
  eNodeB_3GPP_BBU, // eNodeB with NGFI IF5
163 164 165
  NGFI_RRU_IF5,    // NGFI_RRU with IF5
  NGFI_RRU_IF4,    // NGFI_RRU (NGFI remote radio-unit, currently split at common - ue_specific interface, IF4) 
  NGFI_RCC_IF4     // NGFI_RCC (NGFI radio cloud center, currently split at common - ue_specific interface, IF4) 
166
} eNB_func_t;
167

168 169 170 171 172 173
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;


knopp's avatar
knopp committed
174

175 176
typedef struct UE_SCAN_INFO_s {
  /// 10 best amplitudes (linear) for each pss signals
177
  int32_t amp[3][10];
178
  /// 10 frequency offsets (kHz) corresponding to best amplitudes, with respect do minimum DL frequency in the band
179
  int32_t freq_offset_Hz[3][10];
180 181
} UE_SCAN_INFO_t;

182
#if ENABLE_RAL
183 184 185 186 187 188 189
typedef struct ral_threshold_phy_s {
  SLIST_ENTRY(ral_threshold_phy_s) ral_thresholds;
  ral_threshold_t                  threshold;
  ral_th_action_t                  th_action;
  ral_link_param_t                 link_param;
  long                             timer_id;
} ral_threshold_phy_t;
190 191
#endif

knopp's avatar
knopp committed
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 217 218 219
/// 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;
knopp's avatar
knopp committed
220
/// Context data structure for eNB subframe processing
221
typedef struct eNB_proc_t_s {
222
  /// Component Carrier index
223
  uint8_t              CC_id;
224 225 226 227
  /// thread index
  int thread_index;
  /// timestamp received from HW
  openair0_timestamp timestamp_rx;
228
  /// subframe to act upon for reception
knopp's avatar
knopp committed
229
  int subframe_rx;
230 231
  /// subframe to act upon for PRACH
  int subframe_prach;
232
  /// frame to act upon for reception
knopp's avatar
knopp committed
233
  int frame_rx;
234 235
  /// frame to act upon for PRACH
  int frame_prach;
236 237 238
  /// \brief Instance count for FH processing thread.
  /// \internal This variable is protected by \ref mutex_FH.
  int instance_cnt_FH;
239
  /// \brief Instance count for rx processing thread.
240 241
  /// \internal This variable is protected by \ref mutex_prach.
  int instance_cnt_prach;
242 243 244 245
  /// pthread structure for FH processing thread
  pthread_t pthread_FH;
  /// pthread structure for asychronous RX processing thread
  pthread_t pthread_asynch_rx;
246 247
  /// flag to indicate first RX acquisition
  int first_rx;
248 249
  /// pthread attributes for FH processing thread
  pthread_attr_t attr_FH;
250 251
  /// pthread attributes for prach processing thread
  pthread_attr_t attr_prach;
252 253 254 255
  /// pthread attributes for asynchronous RX thread
  pthread_attr_t attr_asynch_rx;
  /// scheduling parameters for FH thread
  struct sched_param sched_param_FH;
256 257
  /// scheduling parameters for prach thread
  struct sched_param sched_param_prach;
258 259 260
  /// scheduling parameters for asynch_rx thread
  struct sched_param sched_param_asynch_rx;
  /// condition variable for FH thread
knopp's avatar
knopp committed
261
  pthread_t pthread_prach;
262 263 264
  /// condition variable for FH thread
  pthread_cond_t cond_FH;
  /// condition variable for PRACH processing thread;
265
  pthread_cond_t cond_prach;
266 267 268
  /// mutex for FH
  pthread_mutex_t mutex_FH;
  /// mutex for PRACH thread
269
  pthread_mutex_t mutex_prach;
knopp's avatar
knopp committed
270 271
  /// set of scheduling variables RXn-TXnp4 threads
  eNB_rxtx_proc_t proc_rxtx[2];
272 273 274 275
  /// number of slave threads
  int                  num_slaves;
  /// array of pointers to slaves
  struct eNB_proc_t_s           **slave_proc;
knopp's avatar
knopp committed
276 277
} eNB_proc_t;

278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313

/// 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
314 315 316 317 318 319
  /// 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;
320 321 322
  /// \brief Instance count for synch thread.
  /// \internal This variable is protected by \ref mutex_synch.
  int instance_cnt_synch;
knopp's avatar
knopp committed
323
  /// pthread attributes for synch processing thread
324 325 326 327 328 329 330 331 332 333 334 335
  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;
336 337

/// Top-level PHY Data Structure for eNB
338
typedef struct PHY_VARS_eNB_s {
339
  /// Module ID indicator for this instance
knopp's avatar
knopp committed
340 341
  module_id_t          Mod_id;
  uint8_t              CC_id;
342
  eNB_proc_t           proc;
343
  eNB_func_t           node_function;
344
  eNB_timing_t         node_timing;
knopp's avatar
knopp committed
345
  uint8_t              local_flag;
346 347 348 349 350 351
  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;
352 353 354
  /// \brief ?.
  /// - first index: UE [0..NUMBER_OF_UE_MAX[ (hard coded)
  /// - second index: UE [0..NUMBER_OF_UE_MAX[
355 356 357 358 359 360 361 362
  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];
363 364

  /// cell-specific reference symbols
knopp's avatar
knopp committed
365 366 367 368
  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];
369

370
  /// mbsfn reference symbols
knopp's avatar
knopp committed
371
  uint32_t         lte_gold_mbsfn_table[10][3][42];
372

373
  uint32_t X_u[64][839];
374

375
  uint8_t pbch_pdu[4]; //PBCH_PDU_SIZE
376 377 378
  char eNB_generate_rar;

  /// Indicator set to 0 after first SR
379
  uint8_t first_sr[NUMBER_OF_UE_MAX];
380

381
  uint32_t max_peak_val;
382 383
  int max_eNB_id, max_sync_pos;

384
  int              N_TA_offset; ///timing offset used in TDD
385

386 387
  /// \brief sinr for all subcarriers of the current link (used only for abstraction).
  /// first index: ? [0..N_RB_DL*12[
388 389
  double *sinr_dB;

390
  /// N0 (used for abstraction)
391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407
  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

408
  /// if ==0 enables phy only test mode
409 410
  int mac_enabled;

411
  /// For emulation only (used by UE abstraction to retrieve DCI)
412 413
  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
414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437
  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];
438
  uint8_t ncs_cell[20][7];
439 440 441 442 443

  // Scheduling Request Config
  SCHEDULING_REQUEST_CONFIG scheduling_request_config[NUMBER_OF_UE_MAX];

  // Transmission mode per UE
444
  uint8_t transmission_mode[NUMBER_OF_UE_MAX];
445 446 447

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

449 450 451
  // Pointers for active physicalConfigDedicated to be applied in current subframe
  struct PhysicalConfigDedicated *physicalConfigDedicated[NUMBER_OF_UE_MAX];

452

453 454
  uint32_t rb_mask_ul[4];

455 456 457 458
  /// Information regarding TM5
  MU_MIMO_mode mu_mimo_mode[NUMBER_OF_UE_MAX];


459 460 461 462 463 464 465 466 467
  /// 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;

468
  ///check for Total Transmissions
knopp's avatar
knopp committed
469
  uint32_t check_for_total_transmissions;
470 471

  ///check for MU-MIMO Transmissions
knopp's avatar
knopp committed
472
  uint32_t check_for_MUMIMO_transmissions;
473 474

  ///check for SU-MIMO Transmissions
knopp's avatar
knopp committed
475
  uint32_t check_for_SUMIMO_transmissions;
476 477

  ///check for FULL MU-MIMO Transmissions
knopp's avatar
knopp committed
478
  uint32_t  FULL_MUMIMO_transmissions;
479 480

  /// Counter for total bitrate, bits and throughput in downlink
knopp's avatar
knopp committed
481 482 483
  uint32_t total_dlsch_bitrate;
  uint32_t total_transmitted_bits;
  uint32_t total_system_throughput;
484

485 486
  int              hw_timing_advance;

487 488 489 490
  time_stats_t phy_proc;
  time_stats_t phy_proc_tx;
  time_stats_t phy_proc_rx;
  time_stats_t rx_prach;
491

492 493 494
  time_stats_t ofdm_mod_stats;
  time_stats_t dlsch_encoding_stats;
  time_stats_t dlsch_modulation_stats;
495
  time_stats_t dlsch_scrambling_stats;
496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517
  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;
518

519 520 521
#ifdef LOCALIZATION
  /// time state for localization
  time_stats_t localization_stats;
522
#endif 
523

524 525
  int32_t pucch1_stats_cnt[NUMBER_OF_UE_MAX][10];
  int32_t pucch1_stats[NUMBER_OF_UE_MAX][10*1024];
526
  int32_t pucch1_stats_thres[NUMBER_OF_UE_MAX][10*1024];
527
  int32_t pucch1ab_stats_cnt[NUMBER_OF_UE_MAX][10];
528
  int32_t pucch1ab_stats[NUMBER_OF_UE_MAX][2*10*1024];
529 530 531 532 533
  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];
534 535 536 537
  
  /// RF and Interface devices per CC
  openair0_device rfdevice; 
  openair0_device ifdevice;
538 539
  /// Pointer for ifdevice buffer struct
  if_buffer_t ifbuffer;
gauthier's avatar
gauthier committed
540

541 542 543
} PHY_VARS_eNB;

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

545 546
/// Top-level PHY Data Structure for UE
typedef struct {
knopp's avatar
knopp committed
547
  /// \brief Module ID indicator for this instance
548
  uint8_t Mod_id;
knopp's avatar
knopp committed
549
  /// \brief Component carrier ID for this PHY instance
knopp's avatar
knopp committed
550
  uint8_t CC_id;
knopp's avatar
knopp committed
551 552 553 554 555
  //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;
556 557
  /// \brief Indicator that UE should perform coarse scanning around carrier
  int UE_scan_carrier;
knopp's avatar
knopp committed
558
  /// \brief Indicator that UE is synchronized to an eNB
559
  int is_synchronized;
560 561
  /// Data structure for UE process scheduling
  UE_proc_t proc;
knopp's avatar
knopp committed
562
  /// \brief Total gain of the TX chain (16-bit baseband I/Q to antenna)
knopp's avatar
knopp committed
563
  uint32_t tx_total_gain_dB;
knopp's avatar
knopp committed
564
  /// \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.
565
  uint32_t rx_total_gain_dB;
knopp's avatar
knopp committed
566
  /// \brief Total gains with maximum RF gain stage (ExpressMIMO2/Lime)
knopp's avatar
knopp committed
567
  uint32_t rx_gain_max[4];
knopp's avatar
knopp committed
568
  /// \brief Total gains with medium RF gain stage (ExpressMIMO2/Lime)
knopp's avatar
knopp committed
569
  uint32_t rx_gain_med[4];
knopp's avatar
knopp committed
570
  /// \brief Total gains with bypassed RF gain stage (ExpressMIMO2/Lime)
knopp's avatar
knopp committed
571
  uint32_t rx_gain_byp[4];
knopp's avatar
knopp committed
572
  /// \brief Current transmit power
573
  int8_t tx_power_dBm;
knopp's avatar
knopp committed
574
  /// \brief Total number of REs in current transmission
knopp's avatar
knopp committed
575
  int tx_total_RE;
knopp's avatar
knopp committed
576
  /// \brief Maximum transmit power
577
  int8_t tx_power_max_dBm;
knopp's avatar
knopp committed
578
  /// \brief Number of eNB seen by UE
579
  uint8_t n_connected_eNB;
knopp's avatar
knopp committed
580
  /// \brief indicator that Handover procedure has been initiated
581
  uint8_t ho_initiated;
knopp's avatar
knopp committed
582
  /// \brief indicator that Handover procedure has been triggered
583
  uint8_t ho_triggered;
584
  /// \brief Measurement variables.
585 586
  PHY_MEASUREMENTS measurements;
  LTE_DL_FRAME_PARMS  frame_parms;
587
  /// \brief Frame parame before ho used to recover if ho fails.
588 589 590 591 592 593 594 595 596 597 598 599 600 601 602
  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];
  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];
  LTE_UE_DLSCH_t   *dlsch_SI[NUMBER_OF_CONNECTED_eNB_MAX],*dlsch_ra[NUMBER_OF_CONNECTED_eNB_MAX];
  LTE_UE_DLSCH_t   *dlsch_MCH[NUMBER_OF_CONNECTED_eNB_MAX];
knopp's avatar
knopp committed
603 604 605
  // This is for SIC in the UE, to store the reencoded data
  LTE_eNB_DLSCH_t  *dlsch_eNB[NUMBER_OF_CONNECTED_eNB_MAX];

606
  // For abstraction-purposes only
607 608 609
  uint8_t               sr[10];
  uint8_t               pucch_sel[10];
  uint8_t               pucch_payload[22];
610 611 612

  UE_MODE_t        UE_mode[NUMBER_OF_CONNECTED_eNB_MAX];
  /// cell-specific reference symbols
knopp's avatar
knopp committed
613 614 615 616
  uint32_t lte_gold_table[7][20][2][14];

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

knopp's avatar
knopp committed
618 619
  /// mbsfn reference symbols
  uint32_t lte_gold_mbsfn_table[10][3][42];
620

621
  uint32_t X_u[64][839];
622

623
  uint32_t high_speed_flag;
knopp's avatar
knopp committed
624
  uint32_t perfect_ce;
625
  int16_t ch_est_alpha;
626 627
  int generate_ul_signal[NUMBER_OF_CONNECTED_eNB_MAX];

628
  UE_SCAN_INFO_t scan_info[NB_BANDS_MAX];
629

630 631
  char ulsch_no_allocation_counter[NUMBER_OF_CONNECTED_eNB_MAX];

632 633


634 635 636
  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];
637 638
  PRACH_RESOURCES_t *prach_resources[NUMBER_OF_CONNECTED_eNB_MAX];
  int turbo_iterations, turbo_cntl_iterations;
639 640
  /// \brief ?.
  /// - first index: eNB [0..NUMBER_OF_CONNECTED_eNB_MAX[ (hard coded)
knopp's avatar
knopp committed
641
  uint32_t total_TBS[NUMBER_OF_CONNECTED_eNB_MAX];
642 643
  /// \brief ?.
  /// - first index: eNB [0..NUMBER_OF_CONNECTED_eNB_MAX[ (hard coded)
knopp's avatar
knopp committed
644
  uint32_t total_TBS_last[NUMBER_OF_CONNECTED_eNB_MAX];
645 646
  /// \brief ?.
  /// - first index: eNB [0..NUMBER_OF_CONNECTED_eNB_MAX[ (hard coded)
knopp's avatar
knopp committed
647
  uint32_t bitrate[NUMBER_OF_CONNECTED_eNB_MAX];
648 649
  /// \brief ?.
  /// - first index: eNB [0..NUMBER_OF_CONNECTED_eNB_MAX[ (hard coded)
knopp's avatar
knopp committed
650
  uint32_t total_received_bits[NUMBER_OF_CONNECTED_eNB_MAX];
651 652 653 654 655 656 657 658 659
  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];
660 661 662 663 664 665 666 667
  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];
668 669
  int current_dlsch_cqi[NUMBER_OF_CONNECTED_eNB_MAX];
  unsigned char first_run_timing_advance[NUMBER_OF_CONNECTED_eNB_MAX];
670 671 672 673
  uint8_t               generate_prach;
  uint8_t               prach_cnt;
  uint8_t               prach_PreambleIndex;
  //  uint8_t               prach_timer;
674 675
  int              rx_offset; /// Timing offset
  int              timing_advance; ///timing advance signalled from eNB
676
  int              hw_timing_advance;
677
  int              N_TA_offset; ///timing offset used in TDD
678
  /// Flag to tell if UE is secondary user (cognitive mode)
679
  unsigned char    is_secondary_ue;
680
  /// Flag to tell if secondary eNB has channel estimates to create NULL-beams from.
681
  unsigned char    has_valid_precoder;
682 683 684
  /// hold the precoder for NULL beam to the primary eNB
  int              **ul_precoder_S_UE;
  /// holds the maximum channel/precoder coefficient
685
  char             log2_maxp;
686

687 688 689
  /// if ==0 enables phy only test mode
  int mac_enabled;

690
  /// Flag to initialize averaging of PHY measurements
691
  int init_averaging;
692

693 694
  /// \brief sinr for all subcarriers of the current link (used only for abstraction).
  /// - first index: ? [0..12*N_RB_DL[
695
  double *sinr_dB;
696

697 698
  /// \brief sinr for all subcarriers of first symbol for the CQI Calculation.
  /// - first index: ? [0..12*N_RB_DL[
699 700
  double *sinr_CQI_dB;

701 702 703
  /// sinr_effective used for CQI calulcation
  double sinr_eff;

704 705
  /// N0 (used for abstraction)
  double N0;
706

707 708 709 710 711
  /// 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];
712

713 714 715 716 717 718 719
  /// 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];

720
  uint8_t ncs_cell[20][7];
721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738

  /// 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
739
  uint8_t transmission_mode[NUMBER_OF_CONNECTED_eNB_MAX];
740

741 742 743
  time_stats_t phy_proc;
  time_stats_t phy_proc_tx;
  time_stats_t phy_proc_rx;
744

745 746
  uint32_t use_ia_receiver;

747 748 749 750 751 752 753 754 755 756
  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;
757
  time_stats_t dlsch_rx_pdcch_stats;
758 759 760 761 762 763 764 765 766
  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;
767
  time_stats_t dlsch_unscrambling_stats;
knopp's avatar
knopp committed
768 769 770
  time_stats_t dlsch_rate_matching_stats;
  time_stats_t dlsch_turbo_encoding_stats;
  time_stats_t dlsch_interleaving_stats;
771 772 773 774 775 776 777
  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;
778
  time_stats_t tx_prach;
779

knopp's avatar
knopp committed
780 781 782
  /// RF and Interface devices per CC
  openair0_device rfdevice; 

783
#if ENABLE_RAL
784 785 786 787
  hash_table_t    *ral_thresholds_timed;
  SLIST_HEAD(ral_thresholds_gen_poll_s, ral_threshold_phy_t) ral_thresholds_gen_polled[RAL_LINK_PARAM_GEN_MAX];
  SLIST_HEAD(ral_thresholds_lte_poll_s, ral_threshold_phy_t) ral_thresholds_lte_polled[RAL_LINK_PARAM_LTE_MAX];
#endif
788 789
} PHY_VARS_UE;

790 791 792
/// Top-level PHY Data Structure for RN
typedef struct {
  /// Module ID indicator for this instance
793 794
  uint8_t Mod_id;
  uint32_t frame;
795 796
  // phy_vars_eNB
  // phy_vars ue
797
  // cuurently only used to store and forward the PMCH
798 799
  uint8_t mch_avtive[10];
  uint8_t sync_area[10]; // num SF
800
  LTE_UE_DLSCH_t   *dlsch_rn_MCH[10];
801

802
} PHY_VARS_RN;
803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820

#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 //OPENAIR_LTE


#endif //  __PHY_DEFS__H__