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

nikaeinn's avatar
nikaeinn 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


nikaeinn's avatar
nikaeinn 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

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

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

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

*******************************************************************************/
29
/*! \file LAYER2/MAC/defs.h
30
* \brief MAC data structures, constant, and function prototype
31
* \author Navid Nikaein and Raymond Knopp
32
33
* \date 2011
* \version 0.5
34
* \email navid.nikaein@eurecom.fr
35
36

*/
37
38
39
40
/** @defgroup _oai2  openair2 Reference Implementation
 * @ingroup _ref_implementation_
 * @{
 */
41

42
/*@}*/
43

44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
#ifndef __LAYER2_MAC_DEFS_H__
#define __LAYER2_MAC_DEFS_H__



#ifdef USER_MODE
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#endif

//#include "COMMON/openair_defs.h"

#include "COMMON/platform_constants.h"
#include "COMMON/mac_rrc_primitives.h"
#include "PHY/defs.h"
#include "RadioResourceConfigCommon.h"
#include "RadioResourceConfigDedicated.h"
#include "MeasGapConfig.h"
#include "TDD-Config.h"
#include "RACH-ConfigCommon.h"
#include "MeasObjectToAddModList.h"
66
#include "MobilityControlInfo.h"
67
68
69
70
#ifdef Rel10
#include "MBSFN-AreaInfoList-r9.h"
#include "MBSFN-SubframeConfigList.h"
#include "PMCH-InfoList-r9.h"
knopp's avatar
   
knopp committed
71
#include "SCellToAddMod-r10.h"
72
73
74
75
76
77
#endif

//#ifdef PHY_EMUL
//#include "SIMULATION/PHY_EMULATION/impl_defs.h"
//#endif

78
79
/** @defgroup _mac  MAC
 * @ingroup _oai2
80
81
82
 * @{
 */

83
#define BCCH_PAYLOAD_SIZE_MAX 128
84
#define CCCH_PAYLOAD_SIZE_MAX 128
85

86
87
88
89
90
#define SCH_PAYLOAD_SIZE_MAX 4096
/// Logical channel ids from 36-311 (Note BCCH is not specified in 36-311, uses the same as first DRB)

#ifdef Rel10

91
// Mask for identifying subframe for MBMS
92
93
94
95
96
97
98
99
100
101
102
103
104
105
#define MBSFN_TDD_SF3 0x80// for TDD
#define MBSFN_TDD_SF4 0x40
#define MBSFN_TDD_SF7 0x20
#define MBSFN_TDD_SF8 0x10
#define MBSFN_TDD_SF9 0x08
#define MBSFN_FDD_SF1 0x80// for FDD
#define MBSFN_FDD_SF2 0x40
#define MBSFN_FDD_SF3 0x20
#define MBSFN_FDD_SF6 0x10
#define MBSFN_FDD_SF7 0x08
#define MBSFN_FDD_SF8 0x04

#define MAX_MBSFN_AREA 8
#define MAX_PMCH_perMBSFN 15
106
/*!\brief MAX MCCH payload size  */
107
#define MCCH_PAYLOAD_SIZE_MAX 128
108
//#define MCH_PAYLOAD_SIZE_MAX 16384// this value is using in case mcs and TBS index are high
109
110
111
112
113
114
#endif

#ifdef USER_MODE
#define printk printf
#endif //USER_MODE

115
/*!\brief Maximum number of logical channl group IDs */
116
#define MAX_NUM_LCGID 4
117
118
119
120
121
122
123
124
125
/*!\brief logical channl group ID 0 */
#define LCGID0 0
/*!\brief logical channl group ID 1 */
#define LCGID1 1
/*!\brief logical channl group ID 2 */
#define LCGID2 2
/*!\brief logical channl group ID 3 */
#define LCGID3 3
/*!\brief Maximum number of logical chanels */
126
#define MAX_NUM_LCID 11
127
/*!\brief Maximum number od control elemenets */
128
#define MAX_NUM_CE 5
129
/*!\brief Maximum number of random access process */
130
#define NB_RA_PROC_MAX 4
131
/*!\brief size of buffer status report table */
132
#define BSR_TABLE_SIZE 64
133
/*!\brief The power headroom reporting range is from -23 ...+40 dB and beyond, with step 1 */
134
#define PHR_MAPPING_OFFSET 23  // if ( x>= -23 ) val = floor (x + 23) 
135
/*!\brief maximum number of resource block groups */
136
#define N_RBG_MAX 25 // for 20MHz channel BW
137
/*!\brief minimum value for channel quality indicator */
138
#define MIN_CQI_VALUE  0
139
/*!\brief maximum value for channel quality indicator */
140
141
#define MAX_CQI_VALUE  15

142

143
144
145
#define LCID_EMPTY 0
#define LCID_NOT_EMPTY 1

146
147
148
/* 
 * eNB part 
 */ 
149

150
151
152
153
154

/* 
 * UE/ENB common part 
 */ 
/*!\brief MAC header of Random Access Response for Random access preamble identifier (RAPID) */
155
typedef struct {
gauthier's avatar
gauthier committed
156
157
158
  uint8_t RAPID:6;
  uint8_t T:1;
  uint8_t E:1;
159
160
} __attribute__((__packed__))RA_HEADER_RAPID;

161
/*!\brief  MAC header of Random Access Response for backoff indicator (BI)*/
162
typedef struct {
gauthier's avatar
gauthier committed
163
164
165
166
  uint8_t BI:4;
  uint8_t R:2;
  uint8_t T:1;
  uint8_t E:1;
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
} __attribute__((__packed__))RA_HEADER_BI;
/*
typedef struct {
  uint64_t padding:16;
  uint64_t t_crnti:16;
  uint64_t hopping_flag:1;
  uint64_t rb_alloc:10;
  uint64_t mcs:4;
  uint64_t TPC:3;
  uint64_t UL_delay:1;
  uint64_t cqi_req:1;
  uint64_t Timing_Advance_Command:11;  // first/2nd octet LSB
  uint64_t R:1;                        // octet MSB
  } __attribute__((__packed__))RAR_PDU;

typedef struct {
  uint64_t padding:16;
  uint64_t R:1;                        // octet MSB
  uint64_t Timing_Advance_Command:11;  // first/2nd octet LSB
  uint64_t cqi_req:1;
  uint64_t UL_delay:1;
  uint64_t TPC:3;
  uint64_t mcs:4;
  uint64_t rb_alloc:10;
  uint64_t hopping_flag:1;
  uint64_t t_crnti:16;
  } __attribute__((__packed__))RAR_PDU;

#define sizeof_RAR_PDU 6
*/
197
/*!\brief  MAC subheader short with 7bit Length field */
198
typedef struct {
gauthier's avatar
gauthier committed
199
200
201
202
203
  uint8_t LCID:5;  // octet 1 LSB
  uint8_t E:1;
  uint8_t R:2;     // octet 1 MSB
  uint8_t L:7;     // octet 2 LSB
  uint8_t F:1;     // octet 2 MSB
204
} __attribute__((__packed__))SCH_SUBHEADER_SHORT;
205
/*!\brief  MAC subheader long  with 15bit Length field */
206
typedef struct {
gauthier's avatar
gauthier committed
207
208
209
210
211
212
213
  uint8_t LCID:5;   // octet 1 LSB
  uint8_t E:1;
  uint8_t R:2;      // octet 1 MSB
  uint8_t L_MSB:7;
  uint8_t F:1;      // octet 2 MSB
  uint8_t L_LSB:8;
  uint8_t padding;
214
} __attribute__((__packed__))SCH_SUBHEADER_LONG;
215
/*!\brief MAC subheader short without length field */
216
typedef struct {
gauthier's avatar
gauthier committed
217
218
219
  uint8_t LCID:5;
  uint8_t E:1;
  uint8_t R:2;
220
221
} __attribute__((__packed__))SCH_SUBHEADER_FIXED;

222
/*!\brief  mac control element: short buffer status report for a specific logical channel group ID*/
223
typedef struct {
gauthier's avatar
gauthier committed
224
225
  uint8_t Buffer_size:6;  // octet 1 LSB
  uint8_t LCGID:2;        // octet 1 MSB
226
227
228
} __attribute__((__packed__))BSR_SHORT;

typedef BSR_SHORT BSR_TRUNCATED;
229
/*!\brief  mac control element: long buffer status report for all logical channel group ID*/
230
typedef struct {
gauthier's avatar
gauthier committed
231
232
233
234
235
  uint32_t Buffer_size3:6;
  uint32_t Buffer_size2:6;
  uint32_t Buffer_size1:6;
  uint32_t Buffer_size0:6;
  uint32_t padding:8;
236
237
238
} __attribute__((__packed__))BSR_LONG;

#define BSR_LONG_SIZE  (sizeof(BSR_LONG))
239
/*!\brief  mac control element: timing advance  */
240
typedef struct {
gauthier's avatar
gauthier committed
241
242
  uint8_t TA:6;
  uint8_t R:2;
243
} __attribute__((__packed__))TIMING_ADVANCE_CMD;
244
/*!\brief  mac control element: power headroom report  */
245
typedef struct {
gauthier's avatar
gauthier committed
246
247
  uint8_t PH:6;
  uint8_t R:2;
248
249
} __attribute__((__packed__))POWER_HEADROOM_CMD;

250
/*!\brief  DCI PDU filled by MAC for the PHY  */
251
typedef struct {
gauthier's avatar
gauthier committed
252
253
  uint8_t Num_ue_spec_dci ;
  uint8_t Num_common_dci  ;
254
255
  uint32_t nCCE;
  uint32_t num_pdcch_symbols;
256
257
  DCI_ALLOC_t dci_alloc[NUM_DCI_MAX] ;
} DCI_PDU;
258
/*! \brief CCCH payload */
259
typedef struct {
260
  uint8_t payload[CCCH_PAYLOAD_SIZE_MAX] ;
261
} __attribute__((__packed__))CCCH_PDU;
262
/*! \brief BCCH payload */
263
typedef struct {
264
  uint8_t payload[BCCH_PAYLOAD_SIZE_MAX] ;
265
266
267
} __attribute__((__packed__))BCCH_PDU;

#ifdef Rel10
268
/*! \brief MCCH payload */
269
typedef struct {
270
  uint8_t payload[MCCH_PAYLOAD_SIZE_MAX] ;
271
} __attribute__((__packed__))MCCH_PDU;
272
/*!< \brief MAC control element for activation and deactivation of component carriers */
273
274
275
276
277
278
279
280
281
282
typedef struct {
  uint8_t C7:1;/*!< \brief Component carrier 7 */
  uint8_t C6:1;/*!< \brief Component carrier 6 */
  uint8_t C5:1;/*!< \brief Component carrier 5 */
  uint8_t C4:1;/*!< \brief Component carrier 4 */
  uint8_t C3:1;/*!< \brief Component carrier 3 */
  uint8_t C2:1;/*!< \brief Component carrier 2 */
  uint8_t C1:1;/*!< \brief Component carrier 1 */
  uint8_t R:1;/*!< \brief Reserved  */
} __attribute__((__packed__))CC_ELEMENT;
283
/*! \brief MAC control element: MCH Scheduling Information */
284
typedef struct {
gauthier's avatar
gauthier committed
285
286
287
  uint8_t stop_sf_MSB:3; // octet 1 LSB
  uint8_t lcid:5;        // octet 2 MSB
  uint8_t stop_sf_LSB:8;
288
} __attribute__((__packed__))MSI_ELEMENT;
289
290
#endif
/*! \brief Values of CCCH LCID for DLSCH */ 
291
#define CCCH_LCHANID 0
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
/*!\brief Values of BCCH logical channel */
#define BCCH 3  // SI 
/*!\brief Value of CCCH / SRB0 logical channel */
#define CCCH 0  // srb0
/*!\brief DCCH / SRB1 logical channel */
#define DCCH 1  // srb1
/*!\brief DCCH1 / SRB2  logical channel */
#define DCCH1 2 // srb2
/*!\brief DTCH DRB1  logical channel */
#define DTCH 3 // LCID
/*!\brief MCCH logical channel */
#define MCCH 4 
/*!\brief MTCH logical channel */
#define MTCH 1 
// DLSCH LCHAN ID
/*!\brief LCID of UE contention resolution identity for DLSCH*/
308
#define UE_CONT_RES 28
309
/*!\brief LCID of timing advance for DLSCH */
310
#define TIMING_ADV_CMD 29
311
/*!\brief LCID of discontinous reception mode for DLSCH */
312
#define DRX_CMD 30
313
/*!\brief LCID of padding LCID for DLSCH */
314
315
316
317
#define SHORT_PADDING 31

#ifdef Rel10
// MCH LCHAN IDs (table6.2.1-4 TS36.321)
318
/*!\brief LCID of MCCH for DL */
319
#define MCCH_LCHANID 0
320
321
322
/*!\brief LCID of MCH scheduling info for DL */
#define MCH_SCHDL_INFO 3
/*!\brief LCID of Carrier component activation/deactivation */
323
#define CC_ACT_DEACT 27
324
325
326
#endif

// ULSCH LCHAN IDs
327
/*!\brief LCID of extended power headroom for ULSCH */
328
#define EXTENDED_POWER_HEADROOM 25
329
/*!\brief LCID of power headroom for ULSCH */
330
#define POWER_HEADROOM 26
331
/*!\brief LCID of CRNTI for ULSCH */
332
#define CRNTI 27
333
/*!\brief LCID of truncated BSR for ULSCH */
334
#define TRUNCATED_BSR 28
335
/*!\brief LCID of short BSR for ULSCH */
336
#define SHORT_BSR 29
337
/*!\brief LCID of long BSR for ULSCH */
338
339
#define LONG_BSR 30

340
/*! \brief Downlink SCH PDU Structure */
341
typedef struct {
gauthier's avatar
gauthier committed
342
343
  int8_t payload[8][SCH_PAYLOAD_SIZE_MAX];
  uint16_t Pdu_size[8];
344
345
} __attribute__ ((__packed__)) DLSCH_PDU;

346
/*! \brief MCH PDU Structure */
347
typedef struct {
gauthier's avatar
gauthier committed
348
349
  int8_t payload[SCH_PAYLOAD_SIZE_MAX];
  uint16_t Pdu_size;
350
  uint8_t mcs;
351
352
353
  uint8_t sync_area;
  uint8_t msi_active;
  uint8_t mcch_active;
354
  uint8_t mtch_active;
355
356
} __attribute__ ((__packed__)) MCH_PDU;

357
/*! \brief Uplink SCH PDU Structure */
358
typedef struct {
gauthier's avatar
gauthier committed
359
360
  int8_t payload[SCH_PAYLOAD_SIZE_MAX];         /*!< \brief SACH payload */
  uint16_t Pdu_size;
361
362
363
364
} __attribute__ ((__packed__)) ULSCH_PDU;

#include "PHY/impl_defs_top.h"

365
/*!\brief  UE ULSCH scheduling states*/
366
367
368
typedef enum {
  S_UL_NONE =0,
  S_UL_WAITING,
369
370
  S_UL_SCHEDULED,
  S_UL_BUFFERED,
371
372
373
  S_UL_NUM_STATUS
} UE_ULSCH_STATUS;

374
/*!\brief  UE DLSCH scheduling states*/
375
376
377
typedef enum {
  S_DL_NONE =0,
  S_DL_WAITING,
378
379
  S_DL_SCHEDULED,
  S_DL_BUFFERED,
380
381
382
  S_DL_NUM_STATUS
} UE_DLSCH_STATUS;

383
/*!\brief  scheduling policy for the contention-based access */
384
typedef enum {
385
386
387
388
389
  CBA_ES=0, /// equal share of RB among groups w
  CBA_ES_S,  /// equal share of RB among groups with small allocation
  CBA_PF, /// proportional fair (kind of)
  CBA_PF_S,  /// proportional fair (kind of) with small RB allocation
  CBA_RS /// random allocation
390
391
392
} CBA_POLICY;


393
/*! \brief temporary struct for ULSCH sched */
394
typedef struct {
gauthier's avatar
gauthier committed
395
  rnti_t rnti;
gauthier's avatar
gauthier committed
396
397
  uint16_t subframe;
  uint16_t serving_num;
398
399
  UE_ULSCH_STATUS status;
} eNB_ULSCH_INFO;
400
/*! \brief temp struct for DLSCH sched */
401
typedef struct {
gauthier's avatar
gauthier committed
402
  rnti_t rnti;
gauthier's avatar
gauthier committed
403
404
405
  uint16_t weight;
  uint16_t subframe;
  uint16_t serving_num;
406
407
  UE_DLSCH_STATUS status;
} eNB_DLSCH_INFO;
408
/*! \brief eNB overall statistics */
409
typedef struct {
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
  /// num BCCH PDU per CC 
  uint32_t total_num_bcch_pdu;
  /// BCCH buffer size  
  uint32_t bcch_buffer;
  /// total BCCH buffer size  
  uint32_t total_bcch_buffer;
  /// BCCH MCS
  uint32_t bcch_mcs;

  /// num CCCH PDU per CC 
  uint32_t total_num_ccch_pdu;
  /// BCCH buffer size  
  uint32_t ccch_buffer;
  /// total BCCH buffer size  
  uint32_t total_ccch_buffer;
  /// BCCH MCS
  uint32_t ccch_mcs;

/// num active users
429
430
431
432
433
  uint16_t num_dlactive_UEs;
  ///  available number of PRBs for a give SF
  uint16_t available_prbs;
  /// total number of PRB available for the user plane
  uint32_t total_available_prbs;
434
435
  /// aggregation
  /// total avilable nccc : num control channel element
436
  uint16_t available_ncces;
437
438
  // only for a new transmission, should be extended for retransmission
  // current dlsch  bit rate for all transport channels
439
440
441
442
443
  uint32_t dlsch_bitrate;
  //
  uint32_t dlsch_bytes_tx;
  //
  uint32_t dlsch_pdus_tx;
444
  //
445
446
447
448
449
  uint32_t total_dlsch_bitrate;
  //
  uint32_t total_dlsch_bytes_tx;
  //
  uint32_t total_dlsch_pdus_tx;
450
451
  
  // here for RX
452
453
454
455
456
  //
  uint32_t ulsch_bitrate;
  //
  uint32_t ulsch_bytes_rx;
  //
457
458
459
460
461
462
463
464
  uint64_t ulsch_pdus_rx; 

  uint32_t total_ulsch_bitrate;
  //
  uint32_t total_ulsch_bytes_rx;
  //
  uint32_t total_ulsch_pdus_rx;
  
465
466
467
468
469
470
471
  
  /// MAC agent-related stats
  /// total number of scheduling decisions
  int sched_decisions;
  /// missed deadlines
  int missed_deadlines;

472
} eNB_STATS;
473
/*! \brief eNB statistics for the connected UEs*/
474
typedef struct {
475
476

  /// CRNTI of UE
gauthier's avatar
gauthier committed
477
  rnti_t crnti; ///user id (rnti) of connected UEs
478
  // rrc status
479
480
481
  uint8_t rrc_status;
  /// harq pid
  uint8_t harq_pid;
482
  /// harq rounf
483
  uint8_t harq_round;
484
  /// DL Wideband CQI index (2 TBs)
485
486
487
488
489
  uint8_t dl_cqi;
  /// total available number of PRBs for a new transmission
  uint16_t rbs_used;
  /// total available number of PRBs for a retransmission
  uint16_t rbs_used_retx;
490
  /// total nccc used for a new transmission: num control channel element
491
  uint16_t ncce_used;
492
  /// total avilable nccc for a retransmission: num control channel element
493
  uint16_t ncce_used_retx;
494
495

  // mcs1 before the rate adaptaion
496
  uint8_t dlsch_mcs1;
497
  /// Target mcs2 after rate-adaptation
498
  uint8_t dlsch_mcs2;
499
  //  current TBS with mcs2
500
  uint32_t TBS;
501
  //  total TBS with mcs2
502
  //  uint32_t total_TBS;
503
  //  total rb used for a new transmission
504
  uint32_t total_rbs_used;
505
  //  total rb used for retransmission
506
  uint32_t total_rbs_used_retx;
507

508
   /// TX
509
510
511
512
513
514
515
516
  /// Num pkt
  uint32_t num_pdu_tx[NB_RB_MAX];
  /// num bytes
  uint32_t num_bytes_tx[NB_RB_MAX];
  /// num retransmission / harq
  uint32_t num_retransmission;
  /// instantaneous tx throughput for each TTI
  //  uint32_t tti_throughput[NB_RB_MAX];
517
518

  /// overall
519
  //
520
521
522
523
  uint32_t  dlsch_bitrate;
  //total
  uint32_t  total_dlsch_bitrate;
  /// headers+ CE +  padding bytes for a MAC PDU
524
  uint64_t overhead_bytes;
525
  /// headers+ CE +  padding bytes for a MAC PDU
526
  uint64_t total_overhead_bytes;
527
  /// headers+ CE +  padding bytes for a MAC PDU
528
  uint64_t avg_overhead_bytes;
529
  // MAC multiplexed payload
530
531
532
  uint64_t total_sdu_bytes;
  // total MAC pdu bytes
  uint64_t total_pdu_bytes;
533

534
535
536
537
  // total num pdu
  uint32_t total_num_pdus;
  //
  //  uint32_t avg_pdu_size;
538
539

  /// RX
540
541
542
543
544
545

  /// preassigned mcs after rate adaptation
  uint8_t ulsch_mcs1;
  /// adjusted mcs
  uint8_t ulsch_mcs2;

546
547
548
549
  /// estimated average pdu inter-departure time
  uint32_t avg_pdu_idt;
  /// estimated average pdu size
  uint32_t avg_pdu_ps;
550
  ///
551
552
  uint32_t aggregated_pdu_size;
  uint32_t aggregated_pdu_arrival;
553

554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
  ///  uplink transport block size
  uint32_t ulsch_TBS;

  ///  total rb used for a new uplink transmission
  uint32_t num_retransmission_rx;
  ///  total rb used for a new uplink transmission
  uint32_t rbs_used_rx;
   ///  total rb used for a new uplink retransmission
  uint32_t rbs_used_retx_rx;
  ///  total rb used for a new uplink transmission
  uint32_t total_rbs_used_rx;
  /// normalized rx power 
  int32_t      normalized_rx_power;
   /// target rx power 
  int32_t    target_rx_power;

570
  /// num rx pdu
571
  uint32_t num_pdu_rx[NB_RB_MAX];
572
  /// num bytes rx
573
  uint32_t num_bytes_rx[NB_RB_MAX];
574
  /// instantaneous rx throughput for each TTI
575
  //  uint32_t tti_goodput[NB_RB_MAX];
576
577
  /// errors
  uint32_t num_errors_rx;
578
579
580
581
582
583
584
585
586
587
  
  uint64_t overhead_bytes_rx;
  /// headers+ CE +  padding bytes for a MAC PDU
  uint64_t total_overhead_bytes_rx;
  /// headers+ CE +  padding bytes for a MAC PDU
  uint64_t avg_overhead_bytes_rx;
 //
  uint32_t  ulsch_bitrate;
  //total
  uint32_t  total_ulsch_bitrate;
588
  /// overall
589
590
  ///  MAC pdu bytes
  uint64_t pdu_bytes_rx;
591
  /// total MAC pdu bytes
592
  uint64_t total_pdu_bytes_rx;
593
  /// total num pdu
594
  uint32_t total_num_pdus_rx;
595
  /// num of error pdus
596
  uint32_t total_num_errors_rx;
597

598
} eNB_UE_STATS;
599
/*! \brief eNB template for UE context information  */
600
typedef struct {
601
  /// C-RNTI of UE
gauthier's avatar
gauthier committed
602
  rnti_t rnti;
603
604
605
606
  /// NDI from last scheduling
  uint8_t oldNDI[8];
  /// NDI from last UL scheduling
  uint8_t oldNDI_UL[8];
607
  /// Flag to indicate UL has been scheduled at least once
gauthier's avatar
gauthier committed
608
  boolean_t ul_active;
knopp's avatar
   
knopp committed
609
610
  /// Flag to indicate UE has been configured (ACK from RRCConnectionSetup received)
  boolean_t configured;
611
612
613
614

  // PHY interface info

  /// DCI format for DLSCH
gauthier's avatar
gauthier committed
615
  uint16_t DLSCH_dci_fmt;
616

617
  /// Current Aggregation Level for DCI
gauthier's avatar
gauthier committed
618
  uint8_t DCI_aggregation_min;
619

620
  /// size of DLSCH size in bit 
gauthier's avatar
gauthier committed
621
  uint8_t DLSCH_dci_size_bits;
622
623

  /// DCI buffer for DLSCH
gauthier's avatar
gauthier committed
624
  uint8_t DLSCH_DCI[8][(MAX_DCI_SIZE_BITS>>3)+1];
625
626

  /// Number of Allocated RBs for DL after scheduling (prior to frequency allocation)
627
  uint16_t nb_rb[8]; // num_max_harq
628
629

  /// Number of Allocated RBs for UL after scheduling (prior to frequency allocation)
630
  uint16_t nb_rb_ul[8]; // num_max_harq
631

632
633
  /// Number of Allocated RBs by the ulsch preprocessor
  uint8_t pre_allocated_nb_rb_ul;
634

635
636
  /// index of Allocated RBs by the ulsch preprocessor
  int8_t pre_allocated_rb_table_index_ul;
637

638
639
  /// total allocated RBs
  int8_t total_allocated_rbs;
640

641
  /// pre-assigned MCS by the ulsch preprocessor
642
  uint8_t pre_assigned_mcs_ul;
643
644
645
646

  /// assigned MCS by the ulsch scheduler
  uint8_t assigned_mcs_ul;

647
  /// DCI buffer for ULSCH
gauthier's avatar
gauthier committed
648
  uint8_t ULSCH_DCI[8][(MAX_DCI_SIZE_BITS>>3)+1];
649
650

  /// DL DAI
gauthier's avatar
gauthier committed
651
  uint8_t DAI;
652
653

  /// UL DAI
gauthier's avatar
gauthier committed
654
  uint8_t DAI_ul[10];
655
656

  /// UL Scheduling Request Received
gauthier's avatar
gauthier committed
657
  uint8_t ul_SR;
658

659
  ///Resource Block indication for each sub-band in MU-MIMO
gauthier's avatar
gauthier committed
660
  uint8_t rballoc_subband[8][50];
661
662
663
664

  // Logical channel info for link with RLC

  /// UE BSR info for each logical channel group id
gauthier's avatar
gauthier committed
665
  uint8_t bsr_info[MAX_NUM_LCGID];
666
667

  /// phr information
668
  int8_t phr_info;
669

670
671
672
  /// phr information
  int8_t phr_info_configured;

673
  ///dl buffer info
gauthier's avatar
gauthier committed
674
  uint32_t dl_buffer_info[MAX_NUM_LCID];
675
  /// total downlink buffer info
gauthier's avatar
gauthier committed
676
  uint32_t dl_buffer_total;
677
  /// total downlink pdus
gauthier's avatar
gauthier committed
678
  uint32_t dl_pdus_total;
679
  /// downlink pdus for each LCID
gauthier's avatar
gauthier committed
680
  uint32_t dl_pdus_in_buffer[MAX_NUM_LCID];
681
  /// creation time of the downlink buffer head for each LCID
gauthier's avatar
gauthier committed
682
  uint32_t dl_buffer_head_sdu_creation_time[MAX_NUM_LCID];
683
  /// maximum creation time of the downlink buffer head across all LCID
684
  uint32_t  dl_buffer_head_sdu_creation_time_max;
685
  /// a flag indicating that the downlink head SDU is segmented  
gauthier's avatar
gauthier committed
686
  uint8_t    dl_buffer_head_sdu_is_segmented[MAX_NUM_LCID];
687
  /// size of remaining size to send for the downlink head SDU
gauthier's avatar
gauthier committed
688
  uint32_t dl_buffer_head_sdu_remaining_size_to_send[MAX_NUM_LCID];
689

690
  /// total uplink buffer size 
691
  uint32_t ul_total_buffer;
692
  /// uplink buffer creation time for each LCID
693
  uint32_t ul_buffer_creation_time[MAX_NUM_LCGID];
694
  /// maximum uplink buffer creation time across all the LCIDs
695
  uint32_t ul_buffer_creation_time_max;
696
  /// uplink buffer size per LCID
697
698
  uint32_t ul_buffer_info[MAX_NUM_LCGID];

699
700
701
  /// UE tx power
  int32_t ue_tx_power;

kaltenbe's avatar
kaltenbe committed
702
  /// stores the frame where the last TPC was transmitted
knopp's avatar
knopp committed
703
704
705
706
  uint32_t pusch_tpc_tx_frame;
  uint32_t pusch_tpc_tx_subframe;
  uint32_t pucch_tpc_tx_frame;
  uint32_t pucch_tpc_tx_subframe;
kaltenbe's avatar
kaltenbe committed
707

708
709
710
#ifdef LOCALIZATION
  eNB_UE_estimated_distances distance;
#endif
711
712
} UE_TEMPLATE;

713
/*! \brief scheduling control information set through an API (not used)*/
714
typedef struct {
715
  ///UL transmission bandwidth in RBs
716
  uint8_t ul_bandwidth[MAX_NUM_LCID];
717
  ///DL transmission bandwidth in RBs
718
  uint8_t dl_bandwidth[MAX_NUM_LCID];
719

720
721
  //To do GBR bearer
  uint8_t min_ul_bandwidth[MAX_NUM_LCID];
722

723
  uint8_t min_dl_bandwidth[MAX_NUM_LCID];
724

725
  ///aggregated bit rate of non-gbr bearer per UE
726
  uint64_t  ue_AggregatedMaximumBitrateDL;
727
  ///aggregated bit rate of non-gbr bearer per UE
728
  uint64_t  ue_AggregatedMaximumBitrateUL;
729
  ///CQI scheduling interval in subframes.
730
  uint16_t cqiSchedInterval;
731
  ///Contention resolution timer used during random access
732
  uint8_t mac_ContentionResolutionTimer;
733

734
  uint16_t max_allowed_rbs[MAX_NUM_LCID];
735

736
  uint8_t max_mcs[MAX_NUM_LCID];
737

738
  uint16_t priority[MAX_NUM_LCID];
739

740
741
742
743
744
745
  // resource scheduling information
  uint8_t       harq_pid[MAX_NUM_CCs];
  uint8_t       round[MAX_NUM_CCs];
  uint8_t       dl_pow_off[MAX_NUM_CCs];
  uint16_t      pre_nb_available_rbs[MAX_NUM_CCs];
  unsigned char rballoc_sub_UE[MAX_NUM_CCs][N_RBG_MAX];
746
747
  uint16_t      ta_timer;
  int16_t      ta_update;
748
} UE_sched_ctrl;
749
/*! \brief eNB template for the Random access information */
750
751
typedef struct {
  /// Flag to indicate this process is active
gauthier's avatar
gauthier committed
752
  boolean_t RA_active;
753
  /// Size of DCI for RA-Response (bytes)
gauthier's avatar
gauthier committed
754
  uint8_t RA_dci_size_bytes1;
755
  /// Size of DCI for RA-Response (bits)
gauthier's avatar
gauthier committed
756
  uint8_t RA_dci_size_bits1;
757
  /// Actual DCI to transmit for RA-Response
gauthier's avatar
gauthier committed
758
  uint8_t RA_alloc_pdu1[(MAX_DCI_SIZE_BITS>>3)+1];
759
  /// DCI format for RA-Response (should be 1A)
gauthier's avatar
gauthier committed
760
  uint8_t RA_dci_fmt1;
761
  /// Size of DCI for Msg4/ContRes (bytes)
gauthier's avatar
gauthier committed
762
  uint8_t RA_dci_size_bytes2;
763
  /// Size of DCI for Msg4/ContRes (bits)
gauthier's avatar
gauthier committed
764
  uint8_t RA_dci_size_bits2;
765
  /// Actual DCI to transmit for Msg4/ContRes
gauthier's avatar
gauthier committed
766
  uint8_t RA_alloc_pdu2[(MAX_DCI_SIZE_BITS>>3)+1];
767
  /// DCI format for Msg4/ContRes (should be 1A)
gauthier's avatar
gauthier committed
768
  uint8_t RA_dci_fmt2;
769
  /// Flag to indicate the eNB should generate RAR.  This is triggered by detection of PRACH
gauthier's avatar
gauthier committed
770
  uint8_t generate_rar;
771
  /// Subframe where preamble was received
gauthier's avatar
gauthier committed
772
  uint8_t preamble_subframe;
773
  /// Subframe where Msg3 is to be sent
gauthier's avatar
gauthier committed
774
  uint8_t Msg3_subframe;
775
  /// Flag to indicate the eNB should generate Msg4 upon reception of SDU from RRC.  This is triggered by first ULSCH reception at eNB for new user.
776
  uint8_t generate_Msg4;
777
  /// Flag to indicate that eNB is waiting for ACK that UE has received Msg3.
gauthier's avatar
gauthier committed
778
  uint8_t wait_ack_Msg4;
779
  /// UE RNTI allocated during RAR
gauthier's avatar
gauthier committed
780
  rnti_t rnti;
781
  /// RA RNTI allocated from received PRACH
gauthier's avatar
gauthier committed
782
  uint16_t RA_rnti;
783
  /// Received preamble_index
gauthier's avatar
gauthier committed
784
  uint8_t preamble_index;
785
  /// Received UE Contention Resolution Identifier
gauthier's avatar
gauthier committed
786
  uint8_t cont_res_id[6];
787
  /// Timing offset indicated by PHY
gauthier's avatar
gauthier committed
788
  int16_t timing_offset;
789
  /// Timeout for RRC connection
gauthier's avatar
gauthier committed
790
  int16_t RRC_timer;
791
792
793
} RA_TEMPLATE;


794
/*! \brief subband bitmap confguration (for ALU icic algo purpose), in test phase */
795
796
797
798
799
800
801
typedef struct {
  uint8_t sbmap[NUMBER_OF_SUBBANDS_MAX]; //13 = number of SB MAX for 100 PRB
  uint8_t periodicity;
  uint8_t first_subframe;
  uint8_t sb_size;
  uint8_t nb_active_sb;
} SBMAP_CONF;
802
/*! \brief UE list used by eNB to order UEs/CC for scheduling*/ 
803
typedef struct {
804
  /// DLSCH pdu 
knopp's avatar
   
knopp committed
805
806
807
808
809
  DLSCH_PDU DLSCH_pdu[MAX_NUM_CCs][2][NUMBER_OF_UE_MAX];
  /// DCI template and MAC connection parameters for UEs
  UE_TEMPLATE UE_template[MAX_NUM_CCs][NUMBER_OF_UE_MAX];
  /// DCI template and MAC connection for RA processes
  int pCC_id[NUMBER_OF_UE_MAX];
810
  /// sorted downlink component carrier for the scheduler 
knopp's avatar
   
knopp committed
811
  int ordered_CCids[MAX_NUM_CCs][NUMBER_OF_UE_MAX];
812
  /// number of downlink active component carrier 
knopp's avatar
   
knopp committed
813
  int numactiveCCs[NUMBER_OF_UE_MAX];
814
  /// sorted uplink component carrier for the scheduler 
knopp's avatar
   
knopp committed
815
  int ordered_ULCCids[MAX_NUM_CCs][NUMBER_OF_UE_MAX];
816
  /// number of uplink active component carrier 
knopp's avatar
   
knopp committed
817
  int numactiveULCCs[NUMBER_OF_UE_MAX];
818
  /// number of downlink active component carrier 
819
  uint8_t dl_CC_bitmap[NUMBER_OF_UE_MAX];
820
  /// eNB to UE statistics
knopp's avatar
   
knopp committed
821
  eNB_UE_STATS eNB_UE_stats[MAX_NUM_CCs][NUMBER_OF_UE_MAX];
822
  /// scheduling control info
knopp's avatar
   
knopp committed
823
824
825
  UE_sched_ctrl UE_sched_ctrl[NUMBER_OF_UE_MAX];

  int next[NUMBER_OF_UE_MAX];
826
  int head;
827
828
  int next_ul[NUMBER_OF_UE_MAX];
  int head_ul;
knopp's avatar
   
knopp committed
829
830
831
832
  int avail;
  int num_UEs;
  boolean_t active[NUMBER_OF_UE_MAX];
} UE_list_t;
833

834
/*! \brief eNB common channels */ 
835
typedef struct {
836
837
838
839
  /// Outgoing DCI for PHY generated by eNB scheduler
  DCI_PDU DCI_pdu;
  /// Outgoing BCCH pdu for PHY
  BCCH_PDU BCCH_pdu;
840
841
  /// Outgoing BCCH DCI allocation
  uint32_t BCCH_alloc_pdu;
842
843
844
  /// Outgoing CCCH pdu for PHY
  CCCH_PDU CCCH_pdu;
  RA_TEMPLATE RA_template[NB_RA_PROC_MAX];
845
846
  /// VRB map for common channels
  uint8_t vrb_map[100];
847
848
  /// MBSFN SubframeConfig
  struct MBSFN_SubframeConfig *mbsfn_SubframeConfig[8];
849
  /// number of subframe allocation pattern available for MBSFN sync area
gauthier's avatar
gauthier committed
850
  uint8_t num_sf_allocation_pattern;
851
#ifdef Rel10
852
  /// MBMS Flag
gauthier's avatar
gauthier committed
853
  uint8_t MBMS_flag;
854
855
856
  /// Outgoing MCCH pdu for PHY
  MCCH_PDU MCCH_pdu;
  /// MCCH active flag
gauthier's avatar
gauthier committed
857
  uint8_t msi_active;
858
  /// MCCH active flag
gauthier's avatar
gauthier committed
859
  uint8_t mcch_active;
860
  /// MTCH active flag
gauthier's avatar
gauthier committed
861
  uint8_t mtch_active;
862
  /// number of active MBSFN area
gauthier's avatar
gauthier committed
863
  uint8_t num_active_mbsfn_area;
864
865
866
867
868
869
870
871
872
873
  /// MBSFN Area Info
  struct  MBSFN_AreaInfo_r9 *mbsfn_AreaInfo[MAX_MBSFN_AREA];
  /// PMCH Config
  struct PMCH_Config_r9 *pmch_Config[MAX_PMCH_perMBSFN];
  /// MBMS session info list
  struct MBMS_SessionInfoList_r9 *mbms_SessionList[MAX_PMCH_perMBSFN];
  /// Outgoing MCH pdu for PHY
  MCH_PDU MCH_pdu;
#endif
#ifdef CBA
874
  /// number of CBA groups 
875
  uint8_t num_active_cba_groups;
876
  /// RNTI for each CBA group 
877
  uint16_t cba_rnti[NUM_MAX_CBA_GROUP];
878
  /// MCS for each CBA group 
879
  uint8_t group_mcs[NUM_MAX_CBA_GROUP];
880
881
#endif
} COMMON_channels_t;
882
/*! \brief top level eNB MAC structure */ 
883
884
typedef struct {
  ///
knopp's avatar
   
knopp committed
885
886
887
888
889
890
891
892
  uint16_t Node_id;
  /// frame counter
  frame_t frame;
  /// subframe counter
  sub_frame_t subframe;
  /// Common cell resources
  COMMON_channels_t common_channels[MAX_NUM_CCs];
  UE_list_t UE_list;
893

894
895
  ///subband bitmap configuration
  SBMAP_CONF sbmap_conf;
896
897
  /// CCE table used to build DCI scheduling information
  int CCE_table[MAX_NUM_CCs][800];
898
  ///  active flag for Other lcid
knopp's avatar
   
knopp committed
899
  //  uint8_t lcid_active[NB_RB_MAX];
900
  /// eNB stats
901
  eNB_STATS eNB_stats[MAX_NUM_CCs];
902
  // MAC function execution peformance profiler
903
  /// processing time of eNB scheduler 
904
  time_stats_t eNB_scheduler;
905
  /// processing time of eNB scheduler for SI 
906
  time_stats_t schedule_si;
907
  /// processing time of eNB scheduler for Random access
908
  time_stats_t schedule_ra;
909
  /// processing time of eNB ULSCH scheduler 
910
  time_stats_t schedule_ulsch;
911
  /// processing time of eNB DCI generation
912
  time_stats_t fill_DLSCH_dci;
913
  /// processing time of eNB MAC preprocessor
914
  time_stats_t schedule_dlsch_preprocessor;
915
  /// processing time of eNB DLSCH scheduler 
916
  time_stats_t schedule_dlsch; // include rlc_data_req + MAC header + preprocessor
917
  /// processing time of eNB MCH scheduler 
918
  time_stats_t schedule_mch;
919
  /// processing time of eNB ULSCH reception
920
  time_stats_t rx_ulsch_sdu; // include rlc_data_ind
921
922

} eNB_MAC_INST;
923

924
925
926
927
928
929
930
931
932
933
934
935
936
/* 
 * UE part 
 */ 

/*!\brief UE layer 2 status */
typedef enum {
  CONNECTION_OK=0,
  CONNECTION_LOST,
  PHY_RESYNCH,
  PHY_HO_PRACH
} UE_L2_STATE_t;

/*!\brief UE scheduling info */
937
938
typedef struct {
  /// buffer status for each lcgid
gauthier's avatar
gauthier committed
939
  uint8_t  BSR[MAX_NUM_LCGID]; // should be more for mesh topology
940
  /// keep the number of bytes in rlc buffer for each lcid