defs.h 32.1 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
/*
 * 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
 */

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

70
71
72
73
74
75
76
//#ifdef SHRLIBDEV
//extern int rxrescale;
//#define RX_IQRESCALELEN rxrescale
//#else
//#define RX_IQRESCALELEN 15
//#endif

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

91
92


93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
#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))

110
111
112
/// suppress compiler warning for unused arguments
#define UNUSED(x) (void)x;

113
114
115
116
117
118
119

#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
120
#include "platform_types.h"
121
122

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

125
126
#include "targets/ARCH/COMMON/common_lib.h"

127
128
129
130
#define NUM_DCI_MAX 32

#define NUMBER_OF_eNB_SECTORS_MAX 3

131
132
#define NB_BANDS_MAX 8

133
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;
134

135
enum transmission_access_mode {
136
137
138
139
140
  NO_ACCESS=0,
  POSTPONED_ACCESS,
  CANCELED_ACCESS,
  UNKNOWN_ACCESS,
  SCHEDULED_ACCESS,
141
142
  CBA_ACCESS};

143
typedef enum  {
144
  eNodeB_3GPP=0,   // classical eNodeB function
145
  eNodeB_3GPP_BBU, // eNodeB with NGFI IF5
knopp's avatar
knopp committed
146
147
148
149
  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) 
150
} eNB_func_t;
151

152
153
154
155
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;
156

157
158
typedef struct UE_SCAN_INFO_s {
  /// 10 best amplitudes (linear) for each pss signals
159
  int32_t amp[3][10];
160
  /// 10 frequency offsets (kHz) corresponding to best amplitudes, with respect do minimum DL frequency in the band
161
  int32_t freq_offset_Hz[3][10];
162
163
} UE_SCAN_INFO_t;

164
165
166
167
168
169
170
171
172
173
174
/// 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];
175

176
177
} PHY_VARS_RN;

knopp's avatar
knopp committed
178
/// Context data structure for RX/TX portion of subframe processing
knopp's avatar
   
knopp committed
179
typedef struct {
180
  /// Component Carrier index
181
  uint8_t              CC_id;
knopp's avatar
knopp committed
182
183
  /// timestamp transmitted to HW
  openair0_timestamp timestamp_tx;
184
  /// subframe to act upon for transmission
knopp's avatar
   
knopp committed
185
  int subframe_tx;
186
  /// subframe to act upon for reception
knopp's avatar
   
knopp committed
187
  int subframe_rx;
188
  /// frame to act upon for transmission
knopp's avatar
   
knopp committed
189
  int frame_tx;
190
  /// frame to act upon for reception
knopp's avatar
   
knopp committed
191
  int frame_rx;
knopp's avatar
knopp committed
192
193
194
195
196
197
198
  /// \brief Instance count for RXn-TXnp4 processing thread.
  /// \internal This variable is protected by \ref mutex_rxtx.
  int instance_cnt_rxtx;
  /// pthread structure for RXn-TXnp4 processing thread
  pthread_t pthread_rxtx;
  /// pthread attributes for RXn-TXnp4 processing thread
  pthread_attr_t attr_rxtx;
knopp's avatar
   
knopp committed
199
  /// condition variable for tx processing thread
knopp's avatar
knopp committed
200
201
202
203
204
205
  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;
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220

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

335
336
337
338
339
340
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

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

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

  /// cell-specific reference symbols
knopp's avatar
   
knopp committed
436
437
438
439
  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];
440

441
  /// mbsfn reference symbols
knopp's avatar
   
knopp committed
442
  uint32_t         lte_gold_mbsfn_table[10][3][42];
443

gauthier's avatar
gauthier committed
444
  uint32_t X_u[64][839];
445

gauthier's avatar
gauthier committed
446
  uint8_t pbch_pdu[4]; //PBCH_PDU_SIZE
447
448
449
  char eNB_generate_rar;

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

452
  uint32_t max_peak_val;
453
454
  int max_eNB_id, max_sync_pos;

455
  int              N_TA_offset; ///timing offset used in TDD
456

457
458
  /// \brief sinr for all subcarriers of the current link (used only for abstraction).
  /// first index: ? [0..N_RB_DL*12[
459
460
  double *sinr_dB;

461
  /// N0 (used for abstraction)
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
  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

479
  /// if ==0 enables phy only test mode
480
481
  int mac_enabled;

482
  /// For emulation only (used by UE abstraction to retrieve DCI)
gauthier's avatar
gauthier committed
483
484
  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
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
  DCI_ALLOC_t dci_alloc[2][NUM_DCI_MAX]; // dci_alloc from even/odd subframes


  // PDSCH Varaibles
  PDSCH_CONFIG_DEDICATED pdsch_config_dedicated[NUMBER_OF_UE_MAX];

  // PUSCH Varaibles
  PUSCH_CONFIG_DEDICATED pusch_config_dedicated[NUMBER_OF_UE_MAX];

  // PUCCH variables
  PUCCH_CONFIG_DEDICATED pucch_config_dedicated[NUMBER_OF_UE_MAX];

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

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

  // CQI reporting
  CQI_REPORT_CONFIG cqi_report_config[NUMBER_OF_UE_MAX];

  // SRS Variables
  SOUNDINGRS_UL_CONFIG_DEDICATED soundingrs_ul_config_dedicated[NUMBER_OF_UE_MAX];
gauthier's avatar
gauthier committed
509
  uint8_t ncs_cell[20][7];
510
511
512
513
514

  // Scheduling Request Config
  SCHEDULING_REQUEST_CONFIG scheduling_request_config[NUMBER_OF_UE_MAX];

  // Transmission mode per UE
gauthier's avatar
gauthier committed
515
  uint8_t transmission_mode[NUMBER_OF_UE_MAX];
516
517
518

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

520
521
522
  // Pointers for active physicalConfigDedicated to be applied in current subframe
  struct PhysicalConfigDedicated *physicalConfigDedicated[NUMBER_OF_UE_MAX];

523

524
525
  uint32_t rb_mask_ul[4];

526
527
528
529
  /// Information regarding TM5
  MU_MIMO_mode mu_mimo_mode[NUMBER_OF_UE_MAX];


530
531
532
533
534
535
536
537
538
  /// 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;

539
  ///check for Total Transmissions
knopp's avatar
   
knopp committed
540
  uint32_t check_for_total_transmissions;
541
542

  ///check for MU-MIMO Transmissions
knopp's avatar
   
knopp committed
543
  uint32_t check_for_MUMIMO_transmissions;
544
545

  ///check for SU-MIMO Transmissions
knopp's avatar
   
knopp committed
546
  uint32_t check_for_SUMIMO_transmissions;
547
548

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

  /// Counter for total bitrate, bits and throughput in downlink
knopp's avatar
   
knopp committed
552
553
554
  uint32_t total_dlsch_bitrate;
  uint32_t total_transmitted_bits;
  uint32_t total_system_throughput;
555

556
557
  int              hw_timing_advance;

558
559
560
561
  time_stats_t phy_proc;
  time_stats_t phy_proc_tx;
  time_stats_t phy_proc_rx;
  time_stats_t rx_prach;
562

563
564
565
  time_stats_t ofdm_mod_stats;
  time_stats_t dlsch_encoding_stats;
  time_stats_t dlsch_modulation_stats;
gauthier's avatar
gauthier committed
566
  time_stats_t dlsch_scrambling_stats;
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
  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;
589

590
591
592
#ifdef LOCALIZATION
  /// time state for localization
  time_stats_t localization_stats;
593
#endif 
594

595
596
  int32_t pucch1_stats_cnt[NUMBER_OF_UE_MAX][10];
  int32_t pucch1_stats[NUMBER_OF_UE_MAX][10*1024];
597
  int32_t pucch1_stats_thres[NUMBER_OF_UE_MAX][10*1024];
598
  int32_t pucch1ab_stats_cnt[NUMBER_OF_UE_MAX][10];
599
  int32_t pucch1ab_stats[NUMBER_OF_UE_MAX][2*10*1024];
600
601
602
603
604
  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];
605
606
607
608
  
  /// RF and Interface devices per CC
  openair0_device rfdevice; 
  openair0_device ifdevice;
Sandeep Kumar's avatar
Sandeep Kumar committed
609
610
  /// Pointer for ifdevice buffer struct
  if_buffer_t ifbuffer;
gauthier's avatar
gauthier committed
611

612
613
614
} PHY_VARS_eNB;

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

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

684
685
686
687
688
  //Paging parameters
  uint32_t              IMSImod1024;
  uint32_t              PF;
  uint32_t              PO;

689
  // For abstraction-purposes only
gauthier's avatar
gauthier committed
690
691
692
  uint8_t               sr[10];
  uint8_t               pucch_sel[10];
  uint8_t               pucch_payload[22];
693
694
695

  UE_MODE_t        UE_mode[NUMBER_OF_CONNECTED_eNB_MAX];
  /// cell-specific reference symbols
knopp's avatar
   
knopp committed
696
697
698
699
  uint32_t lte_gold_table[7][20][2][14];

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

knopp's avatar
   
knopp committed
701
702
  /// mbsfn reference symbols
  uint32_t lte_gold_mbsfn_table[10][3][42];
703

gauthier's avatar
gauthier committed
704
  uint32_t X_u[64][839];
705

706
  uint32_t high_speed_flag;
knopp's avatar
   
knopp committed
707
  uint32_t perfect_ce;
708
  int16_t ch_est_alpha;
709
710
  int generate_ul_signal[NUMBER_OF_CONNECTED_eNB_MAX];

711
  UE_SCAN_INFO_t scan_info[NB_BANDS_MAX];
712

713
714
  char ulsch_no_allocation_counter[NUMBER_OF_CONNECTED_eNB_MAX];

715
716


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

772
773
774
  /// if ==0 enables phy only test mode
  int mac_enabled;

775
  /// Flag to initialize averaging of PHY measurements
776
  int init_averaging;
777

778
779
  /// \brief sinr for all subcarriers of the current link (used only for abstraction).
  /// - first index: ? [0..12*N_RB_DL[
780
  double *sinr_dB;
781

782
783
  /// \brief sinr for all subcarriers of first symbol for the CQI Calculation.
  /// - first index: ? [0..12*N_RB_DL[
784
785
  double *sinr_CQI_dB;

786
787
788
  /// sinr_effective used for CQI calulcation
  double sinr_eff;

789
790
  /// N0 (used for abstraction)
  double N0;
791

792
793
794
795
796
  /// 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];
797

798
799
800
801
802
803
804
  /// PUSCH contention-based access vars
  PUSCH_CA_CONFIG_DEDICATED  pusch_ca_config_dedicated[NUMBER_OF_eNB_MAX]; // lola

  /// PUCCH variables

  PUCCH_CONFIG_DEDICATED pucch_config_dedicated[NUMBER_OF_CONNECTED_eNB_MAX];

gauthier's avatar
gauthier committed
805
  uint8_t ncs_cell[20][7];
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823

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

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

  /// CQI reporting
  CQI_REPORT_CONFIG cqi_report_config[NUMBER_OF_CONNECTED_eNB_MAX];

  /// SRS Variables
  SOUNDINGRS_UL_CONFIG_DEDICATED soundingrs_ul_config_dedicated[NUMBER_OF_CONNECTED_eNB_MAX];

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

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

826
827
828
  time_stats_t phy_proc;
  time_stats_t phy_proc_tx;
  time_stats_t phy_proc_rx;
829

830
831
  uint32_t use_ia_receiver;

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

knopp's avatar
knopp committed
865
866
867
  /// RF and Interface devices per CC
  openair0_device rfdevice; 

868
869
} PHY_VARS_UE;

870
871
void exit_fun(const char* s);

872
static inline int wait_on_condition(pthread_mutex_t *mutex,pthread_cond_t *cond,int *instance_cnt,char *name) {
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893

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

894
static inline int wait_on_busy_condition(pthread_mutex_t *mutex,pthread_cond_t *cond,int *instance_cnt,char *name) {
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915

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

916
static inline int release_thread(pthread_mutex_t *mutex,int *instance_cnt,char *name) {
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932

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

934
935
936
937
938
939
940
941
942
943

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