defs.h 34.5 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
/*! \file LAYER2/MAC/defs.h
23
* \brief MAC data structures, constant, and function prototype
24
* \author Navid Nikaein and Raymond Knopp
25
26
* \date 2011
* \version 0.5
27
* \email navid.nikaein@eurecom.fr
28
29

*/
30
31
32
33
/** @defgroup _oai2  openair2 Reference Implementation
 * @ingroup _ref_implementation_
 * @{
 */
34

35
/*@}*/
36

37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
#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"
59
#include "MobilityControlInfo.h"
60
61
62
63
#ifdef Rel10
#include "MBSFN-AreaInfoList-r9.h"
#include "MBSFN-SubframeConfigList.h"
#include "PMCH-InfoList-r9.h"
knopp's avatar
   
knopp committed
64
#include "SCellToAddMod-r10.h"
65
66
67
68
69
70
#endif

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

71
72
/** @defgroup _mac  MAC
 * @ingroup _oai2
73
74
75
 * @{
 */

76
#define BCCH_PAYLOAD_SIZE_MAX 128
77
#define CCCH_PAYLOAD_SIZE_MAX 128
78
#define PCCH_PAYLOAD_SIZE_MAX 128
79

80
81
82
83
84
#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

85
// Mask for identifying subframe for MBMS
86
87
88
89
90
91
92
93
94
95
96
97
98
99
#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
100
/*!\brief MAX MCCH payload size  */
101
#define MCCH_PAYLOAD_SIZE_MAX 128
102
//#define MCH_PAYLOAD_SIZE_MAX 16384// this value is using in case mcs and TBS index are high
103
104
105
106
107
108
#endif

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

109
/*!\brief Maximum number of logical channl group IDs */
110
#define MAX_NUM_LCGID 4
111
112
113
114
115
116
117
118
119
/*!\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 */
120
#define MAX_NUM_LCID 11
121
/*!\brief Maximum number od control elemenets */
122
#define MAX_NUM_CE 5
123
/*!\brief Maximum number of random access process */
124
#define NB_RA_PROC_MAX 4
125
/*!\brief size of buffer status report table */
126
#define BSR_TABLE_SIZE 64
127
/*!\brief The power headroom reporting range is from -23 ...+40 dB and beyond, with step 1 */
128
#define PHR_MAPPING_OFFSET 23  // if ( x>= -23 ) val = floor (x + 23) 
129
/*!\brief maximum number of resource block groups */
130
#define N_RBG_MAX 25 // for 20MHz channel BW
131
/*!\brief minimum value for channel quality indicator */
132
#define MIN_CQI_VALUE  0
133
/*!\brief maximum value for channel quality indicator */
134
135
#define MAX_CQI_VALUE  15

136

137
138
139
#define LCID_EMPTY 0
#define LCID_NOT_EMPTY 1

140
141
142
/* 
 * eNB part 
 */ 
143

144
145
146
147
148

/* 
 * UE/ENB common part 
 */ 
/*!\brief MAC header of Random Access Response for Random access preamble identifier (RAPID) */
149
typedef struct {
gauthier's avatar
gauthier committed
150
151
152
  uint8_t RAPID:6;
  uint8_t T:1;
  uint8_t E:1;
153
154
} __attribute__((__packed__))RA_HEADER_RAPID;

155
/*!\brief  MAC header of Random Access Response for backoff indicator (BI)*/
156
typedef struct {
gauthier's avatar
gauthier committed
157
158
159
160
  uint8_t BI:4;
  uint8_t R:2;
  uint8_t T:1;
  uint8_t E:1;
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
} __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
*/
191
/*!\brief  MAC subheader short with 7bit Length field */
192
typedef struct {
gauthier's avatar
gauthier committed
193
194
195
196
197
  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
198
} __attribute__((__packed__))SCH_SUBHEADER_SHORT;
199
/*!\brief  MAC subheader long  with 15bit Length field */
200
typedef struct {
gauthier's avatar
gauthier committed
201
202
203
204
205
206
207
  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;
208
} __attribute__((__packed__))SCH_SUBHEADER_LONG;
209
/*!\brief MAC subheader short without length field */
210
typedef struct {
gauthier's avatar
gauthier committed
211
212
213
  uint8_t LCID:5;
  uint8_t E:1;
  uint8_t R:2;
214
215
} __attribute__((__packed__))SCH_SUBHEADER_FIXED;

216
/*!\brief  mac control element: short buffer status report for a specific logical channel group ID*/
217
typedef struct {
gauthier's avatar
gauthier committed
218
219
  uint8_t Buffer_size:6;  // octet 1 LSB
  uint8_t LCGID:2;        // octet 1 MSB
220
221
222
} __attribute__((__packed__))BSR_SHORT;

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

#define BSR_LONG_SIZE  (sizeof(BSR_LONG))
233
/*!\brief  mac control element: timing advance  */
234
typedef struct {
gauthier's avatar
gauthier committed
235
236
  uint8_t TA:6;
  uint8_t R:2;
237
} __attribute__((__packed__))TIMING_ADVANCE_CMD;
238
/*!\brief  mac control element: power headroom report  */
239
typedef struct {
gauthier's avatar
gauthier committed
240
241
  uint8_t PH:6;
  uint8_t R:2;
242
243
} __attribute__((__packed__))POWER_HEADROOM_CMD;

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

#ifdef Rel10
266
/*! \brief MCCH payload */
267
typedef struct {
268
  uint8_t payload[MCCH_PAYLOAD_SIZE_MAX] ;
269
} __attribute__((__packed__))MCCH_PDU;
270
/*!< \brief MAC control element for activation and deactivation of component carriers */
271
272
273
274
275
276
277
278
279
280
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;
281
/*! \brief MAC control element: MCH Scheduling Information */
282
typedef struct {
gauthier's avatar
gauthier committed
283
284
285
  uint8_t stop_sf_MSB:3; // octet 1 LSB
  uint8_t lcid:5;        // octet 2 MSB
  uint8_t stop_sf_LSB:8;
286
} __attribute__((__packed__))MSI_ELEMENT;
287
288
#endif
/*! \brief Values of CCCH LCID for DLSCH */ 
289
#define CCCH_LCHANID 0
290
291
/*!\brief Values of BCCH logical channel */
#define BCCH 3  // SI 
292
293
/*!\brief Values of PCCH logical channel */
#define PCCH 4  // Paging 
294
295
296
297
298
299
300
301
302
303
304
305
306
307
/*!\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
#define LONG_BSR 30
calvin wang's avatar
calvin wang committed
339
340
341
342
343
344
345
346
/*!\brief first level bsr type for ULSCH: Regular BSR,Padding BSR,Periodic BSR*/
#define BSR_TYPE_FIRST_LEVEL 3
/*!\brief  first level bsr type states*/
typedef enum {
  REGULAR_BSR =0,
  PADDING_BSR,
  PERIODIC_BSR
} UE_FIRST_LEVEL_BSR_TYPE;
347

348
/*! \brief Downlink SCH PDU Structure */
349
typedef struct {
gauthier's avatar
gauthier committed
350
351
  int8_t payload[8][SCH_PAYLOAD_SIZE_MAX];
  uint16_t Pdu_size[8];
352
353
} __attribute__ ((__packed__)) DLSCH_PDU;

354
/*! \brief MCH PDU Structure */
355
typedef struct {
gauthier's avatar
gauthier committed
356
357
  int8_t payload[SCH_PAYLOAD_SIZE_MAX];
  uint16_t Pdu_size;
358
  uint8_t mcs;
359
360
361
  uint8_t sync_area;
  uint8_t msi_active;
  uint8_t mcch_active;
362
  uint8_t mtch_active;
363
364
} __attribute__ ((__packed__)) MCH_PDU;

365
/*! \brief Uplink SCH PDU Structure */
366
typedef struct {
gauthier's avatar
gauthier committed
367
368
  int8_t payload[SCH_PAYLOAD_SIZE_MAX];         /*!< \brief SACH payload */
  uint16_t Pdu_size;
369
370
371
372
} __attribute__ ((__packed__)) ULSCH_PDU;

#include "PHY/impl_defs_top.h"

373
/*!\brief  UE ULSCH scheduling states*/
374
375
376
typedef enum {
  S_UL_NONE =0,
  S_UL_WAITING,
377
378
  S_UL_SCHEDULED,
  S_UL_BUFFERED,
379
380
381
  S_UL_NUM_STATUS
} UE_ULSCH_STATUS;

382
/*!\brief  UE DLSCH scheduling states*/
383
384
385
typedef enum {
  S_DL_NONE =0,
  S_DL_WAITING,
386
387
  S_DL_SCHEDULED,
  S_DL_BUFFERED,
388
389
390
  S_DL_NUM_STATUS
} UE_DLSCH_STATUS;

391
/*!\brief  scheduling policy for the contention-based access */
392
typedef enum {
393
394
395
396
397
  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
398
399
400
} CBA_POLICY;


401
/*! \brief temporary struct for ULSCH sched */
402
typedef struct {
gauthier's avatar
gauthier committed
403
  rnti_t rnti;
gauthier's avatar
gauthier committed
404
405
  uint16_t subframe;
  uint16_t serving_num;
406
407
  UE_ULSCH_STATUS status;
} eNB_ULSCH_INFO;
408
/*! \brief temp struct for DLSCH sched */
409
typedef struct {
gauthier's avatar
gauthier committed
410
  rnti_t rnti;
gauthier's avatar
gauthier committed
411
412
413
  uint16_t weight;
  uint16_t subframe;
  uint16_t serving_num;
414
415
  UE_DLSCH_STATUS status;
} eNB_DLSCH_INFO;
416
/*! \brief eNB overall statistics */
417
typedef struct {
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
  /// 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
437
438
439
440
441
  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;
442
443
  /// aggregation
  /// total avilable nccc : num control channel element
444
  uint16_t available_ncces;
445
446
  // only for a new transmission, should be extended for retransmission
  // current dlsch  bit rate for all transport channels
447
448
449
450
451
  uint32_t dlsch_bitrate;
  //
  uint32_t dlsch_bytes_tx;
  //
  uint32_t dlsch_pdus_tx;
452
  //
453
454
455
456
457
  uint32_t total_dlsch_bitrate;
  //
  uint32_t total_dlsch_bytes_tx;
  //
  uint32_t total_dlsch_pdus_tx;
458
459
  
  // here for RX
460
461
462
463
464
  //
  uint32_t ulsch_bitrate;
  //
  uint32_t ulsch_bytes_rx;
  //
465
466
467
468
469
470
471
472
  uint64_t ulsch_pdus_rx; 

  uint32_t total_ulsch_bitrate;
  //
  uint32_t total_ulsch_bytes_rx;
  //
  uint32_t total_ulsch_pdus_rx;
  
473
} eNB_STATS;
474
/*! \brief eNB statistics for the connected UEs*/
475
typedef struct {
476
477

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

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

509
   /// TX
510
511
512
513
514
515
516
517
  /// 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];
518
519

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

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

  /// RX
541
542
543
544
545
546

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

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

555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
  ///  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;

571
  /// num rx pdu
572
  uint32_t num_pdu_rx[NB_RB_MAX];
573
  /// num bytes rx
574
  uint32_t num_bytes_rx[NB_RB_MAX];
575
  /// instantaneous rx throughput for each TTI
576
  //  uint32_t tti_goodput[NB_RB_MAX];
577
578
  /// errors
  uint32_t num_errors_rx;
579
580
581
582
583
584
585
586
587
588
  
  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;
589
  /// overall
590
591
  ///  MAC pdu bytes
  uint64_t pdu_bytes_rx;
592
  /// total MAC pdu bytes
593
  uint64_t total_pdu_bytes_rx;
594
  /// total num pdu
595
  uint32_t total_num_pdus_rx;
596
  /// num of error pdus
597
  uint32_t total_num_errors_rx;
598

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

  // PHY interface info

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

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

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

  /// DCI buffer for DLSCH
625
626
627
  /* rounded to 32 bits unit (actual value should be 8 due to the logic
   * of the function generate_dci0) */
  uint8_t DLSCH_DCI[8][(((MAX_DCI_SIZE_BITS)+31)>>5)*4];
628
629

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

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

635
636
  /// Number of Allocated RBs by the ulsch preprocessor
  uint8_t pre_allocated_nb_rb_ul;
637

638
639
  /// index of Allocated RBs by the ulsch preprocessor
  int8_t pre_allocated_rb_table_index_ul;
640

641
642
  /// total allocated RBs
  int8_t total_allocated_rbs;
643

644
  /// pre-assigned MCS by the ulsch preprocessor
645
  uint8_t pre_assigned_mcs_ul;
646
647
648
649

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

650
  /// DCI buffer for ULSCH
651
652
653
  /* rounded to 32 bits unit (actual value should be 8 due to the logic
   * of the function generate_dci0) */
  uint8_t ULSCH_DCI[8][(((MAX_DCI_SIZE_BITS)+31)>>5)*4];
654
655

  /// DL DAI
gauthier's avatar
gauthier committed
656
  uint8_t DAI;
657
658

  /// UL DAI
gauthier's avatar
gauthier committed
659
  uint8_t DAI_ul[10];
660
661

  /// UL Scheduling Request Received
gauthier's avatar
gauthier committed
662
  uint8_t ul_SR;
663

664
  ///Resource Block indication for each sub-band in MU-MIMO
gauthier's avatar
gauthier committed
665
  uint8_t rballoc_subband[8][50];
666
667
668

  // Logical channel info for link with RLC

669
  /// Last received UE BSR info for each logical channel group id
gauthier's avatar
gauthier committed
670
  uint8_t bsr_info[MAX_NUM_LCGID];
671

672
673
674
  /// LCGID mapping
  long lcgidmap[11];

675
  /// phr information
676
  int8_t phr_info;
677

678
679
680
  /// phr information
  int8_t phr_info_configured;

681
  ///dl buffer info
gauthier's avatar
gauthier committed
682
  uint32_t dl_buffer_info[MAX_NUM_LCID];
683
  /// total downlink buffer info
gauthier's avatar
gauthier committed
684
  uint32_t dl_buffer_total;
685
  /// total downlink pdus
gauthier's avatar
gauthier committed
686
  uint32_t dl_pdus_total;
687
  /// downlink pdus for each LCID
gauthier's avatar
gauthier committed
688
  uint32_t dl_pdus_in_buffer[MAX_NUM_LCID];
689
  /// creation time of the downlink buffer head for each LCID
gauthier's avatar
gauthier committed
690
  uint32_t dl_buffer_head_sdu_creation_time[MAX_NUM_LCID];
691
  /// maximum creation time of the downlink buffer head across all LCID
692
  uint32_t  dl_buffer_head_sdu_creation_time_max;
693
  /// a flag indicating that the downlink head SDU is segmented  
gauthier's avatar
gauthier committed
694
  uint8_t    dl_buffer_head_sdu_is_segmented[MAX_NUM_LCID];
695
  /// size of remaining size to send for the downlink head SDU
gauthier's avatar
gauthier committed
696
  uint32_t dl_buffer_head_sdu_remaining_size_to_send[MAX_NUM_LCID];
697

698
  /// total uplink buffer size 
699
  uint32_t ul_total_buffer;
700
  /// uplink buffer creation time for each LCID
701
  uint32_t ul_buffer_creation_time[MAX_NUM_LCGID];
702
  /// maximum uplink buffer creation time across all the LCIDs
703
  uint32_t ul_buffer_creation_time_max;
704
  /// uplink buffer size per LCID
705
706
  uint32_t ul_buffer_info[MAX_NUM_LCGID];

707
708
709
  /// UE tx power
  int32_t ue_tx_power;

kaltenbe's avatar
kaltenbe committed
710
  /// stores the frame where the last TPC was transmitted
knopp's avatar
knopp committed
711
712
713
714
  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
715

716
717
718
#ifdef LOCALIZATION
  eNB_UE_estimated_distances distance;
#endif
719
720
} UE_TEMPLATE;

721
/*! \brief scheduling control information set through an API (not used)*/
722
typedef struct {
723
  ///UL transmission bandwidth in RBs
724
  uint8_t ul_bandwidth[MAX_NUM_LCID];
725
  ///DL transmission bandwidth in RBs
726
  uint8_t dl_bandwidth[MAX_NUM_LCID];
727

728
729
  //To do GBR bearer
  uint8_t min_ul_bandwidth[MAX_NUM_LCID];
730

731
  uint8_t min_dl_bandwidth[MAX_NUM_LCID];
732

733
  ///aggregated bit rate of non-gbr bearer per UE
734
  uint64_t  ue_AggregatedMaximumBitrateDL;
735
  ///aggregated bit rate of non-gbr bearer per UE
736
  uint64_t  ue_AggregatedMaximumBitrateUL;
737
  ///CQI scheduling interval in subframes.
738
  uint16_t cqiSchedInterval;
739
  ///Contention resolution timer used during random access
740
  uint8_t mac_ContentionResolutionTimer;
741

742
  uint16_t max_allowed_rbs[MAX_NUM_LCID];
743

744
  uint8_t max_mcs[MAX_NUM_LCID];
745

746
  uint16_t priority[MAX_NUM_LCID];
747

748
749
750
751
752
753
  // 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];
754
  uint16_t      ta_timer;
755
756
  int16_t       ta_update;
  int32_t       context_active_timer;
757
  int32_t       cqi_req_timer;
758
  int32_t       ul_inactivity_timer;
759
  int32_t       ul_failure_timer;
760
  int32_t       ul_scheduled;
761
  int32_t       ra_pdcch_order_sent;
Florian Kaltenberger's avatar
Florian Kaltenberger committed
762
  int32_t       ul_out_of_sync;
763
  int32_t       phr_received;
764
} UE_sched_ctrl;
765
/*! \brief eNB template for the Random access information */
766
767
typedef struct {
  /// Flag to indicate this process is active
gauthier's avatar
gauthier committed
768
  boolean_t RA_active;
769
  /// Size of DCI for RA-Response (bytes)
gauthier's avatar
gauthier committed
770
  uint8_t RA_dci_size_bytes1;
771
  /// Size of DCI for RA-Response (bits)
gauthier's avatar
gauthier committed
772
  uint8_t RA_dci_size_bits1;
773
  /// Actual DCI to transmit for RA-Response
gauthier's avatar
gauthier committed
774
  uint8_t RA_alloc_pdu1[(MAX_DCI_SIZE_BITS>>3)+1];
775
  /// DCI format for RA-Response (should be 1A)
gauthier's avatar
gauthier committed
776
  uint8_t RA_dci_fmt1;
777
  /// Size of DCI for Msg4/ContRes (bytes)
gauthier's avatar
gauthier committed
778
  uint8_t RA_dci_size_bytes2;
779
  /// Size of DCI for Msg4/ContRes (bits)
gauthier's avatar
gauthier committed
780
  uint8_t RA_dci_size_bits2;
781
  /// Actual DCI to transmit for Msg4/ContRes
gauthier's avatar
gauthier committed
782
  uint8_t RA_alloc_pdu2[(MAX_DCI_SIZE_BITS>>3)+1];
783
  /// DCI format for Msg4/ContRes (should be 1A)
gauthier's avatar
gauthier committed
784
  uint8_t RA_dci_fmt2;
785
  /// Flag to indicate the eNB should generate RAR.  This is triggered by detection of PRACH
gauthier's avatar
gauthier committed
786
  uint8_t generate_rar;
787
  /// Subframe where preamble was received
gauthier's avatar
gauthier committed
788
  uint8_t preamble_subframe;
789
  /// Subframe where Msg3 is to be sent
gauthier's avatar
gauthier committed
790
  uint8_t Msg3_subframe;
791
  /// 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.
792
  uint8_t generate_Msg4;
793
  /// Flag to indicate that eNB is waiting for ACK that UE has received Msg3.
gauthier's avatar
gauthier committed
794
  uint8_t wait_ack_Msg4;
795
  /// UE RNTI allocated during RAR
gauthier's avatar
gauthier committed
796
  rnti_t rnti;
797
  /// RA RNTI allocated from received PRACH
gauthier's avatar
gauthier committed
798
  uint16_t RA_rnti;
799
  /// Received preamble_index
gauthier's avatar
gauthier committed
800
  uint8_t preamble_index;
801
  /// Received UE Contention Resolution Identifier
gauthier's avatar
gauthier committed
802
  uint8_t cont_res_id[6];
803
  /// Timing offset indicated by PHY
gauthier's avatar
gauthier committed
804
  int16_t timing_offset;
805
  /// Timeout for RRC connection
gauthier's avatar
gauthier committed
806
  int16_t RRC_timer;
807
808
809
} RA_TEMPLATE;


810
/*! \brief subband bitmap confguration (for ALU icic algo purpose), in test phase */
811
812
813
814
815
816
817
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;
818
/*! \brief UE list used by eNB to order UEs/CC for scheduling*/ 
819
typedef struct {
820
  /// DLSCH pdu 
knopp's avatar
   
knopp committed
821
822
823
824
825
  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];
826
  /// sorted downlink component carrier for the scheduler 
knopp's avatar
   
knopp committed
827
  int ordered_CCids[MAX_NUM_CCs][NUMBER_OF_UE_MAX];
828
  /// number of downlink active component carrier 
knopp's avatar
   
knopp committed
829
  int numactiveCCs[NUMBER_OF_UE_MAX];
830
  /// sorted uplink component carrier for the scheduler 
knopp's avatar
   
knopp committed
831
  int ordered_ULCCids[MAX_NUM_CCs][NUMBER_OF_UE_MAX];
832
  /// number of uplink active component carrier 
knopp's avatar
   
knopp committed
833
  int numactiveULCCs[NUMBER_OF_UE_MAX];
834
  /// number of downlink active component carrier 
835
  uint8_t dl_CC_bitmap[NUMBER_OF_UE_MAX];
836
  /// eNB to UE statistics
knopp's avatar
   
knopp committed
837
  eNB_UE_STATS eNB_UE_stats[MAX_NUM_CCs][NUMBER_OF_UE_MAX];
838
  /// scheduling control info
knopp's avatar
   
knopp committed
839
840
841
  UE_sched_ctrl UE_sched_ctrl[NUMBER_OF_UE_MAX];

  int next[NUMBER_OF_UE_MAX];
842
  int head;
843
844
  int next_ul[NUMBER_OF_UE_MAX];
  int head_ul;
knopp's avatar
   
knopp committed
845
846
847
848
  int avail;
  int num_UEs;
  boolean_t active[NUMBER_OF_UE_MAX];
} UE_list_t;
849

850
/*! \brief eNB common channels */ 
851
typedef struct {
852
853
854
855
  /// Outgoing DCI for PHY generated by eNB scheduler
  DCI_PDU DCI_pdu;
  /// Outgoing BCCH pdu for PHY
  BCCH_PDU BCCH_pdu;
856
857
  /// Outgoing BCCH DCI allocation
  uint32_t BCCH_alloc_pdu;
858
859
860
  /// Outgoing CCCH pdu for PHY
  CCCH_PDU CCCH_pdu;
  RA_TEMPLATE RA_template[NB_RA_PROC_MAX];
861
862
  /// VRB map for common channels
  uint8_t vrb_map[100];
863
864
  /// MBSFN SubframeConfig
  struct MBSFN_SubframeConfig *mbsfn_SubframeConfig[8];
865
  /// number of subframe allocation pattern available for MBSFN sync area
gauthier's avatar
gauthier committed
866
  uint8_t num_sf_allocation_pattern;
867
#ifdef Rel10
868
  /// MBMS Flag
gauthier's avatar
gauthier committed
869
  uint8_t MBMS_flag;
870
871
872
  /// Outgoing MCCH pdu for PHY
  MCCH_PDU MCCH_pdu;
  /// MCCH active flag
gauthier's avatar
gauthier committed
873
  uint8_t msi_active;
874
  /// MCCH active flag
gauthier's avatar
gauthier committed
875
  uint8_t mcch_active;
876
  /// MTCH active flag
gauthier's avatar
gauthier committed
877
  uint8_t mtch_active;
878
  /// number of active MBSFN area
gauthier's avatar
gauthier committed
879
  uint8_t num_active_mbsfn_area;
880
881
882
883
884
885
886
887
888
889
  /// 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
890
  /// number of CBA groups 
891
  uint8_t num_active_cba_groups;
892
  /// RNTI for each CBA group 
893
  uint16_t cba_rnti[NUM_MAX_CBA_GROUP];
894
  /// MCS for each CBA group 
895
  uint8_t group_mcs[NUM_MAX_CBA_GROUP];
896
897
#endif
} COMMON_channels_t;
898
/*! \brief top level eNB MAC structure */ 
899
900
typedef struct {
  ///
knopp's avatar
   
knopp committed
901
902
903
904
905
906
907
908
  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;
909

910
911
  ///subband bitmap configuration
  SBMAP_CONF sbmap_conf;
912
913
  /// CCE table used to build DCI scheduling information
  int CCE_table[MAX_NUM_CCs][800];
914
  ///  active flag for Other lcid
915
  uint8_t lcid_active[NB_RB_MAX];
916
  /// eNB stats
917
  eNB_STATS eNB_stats[MAX_NUM_CCs];
918
  // MAC function execution peformance profiler
919
  /// processing time of eNB scheduler 
920
  time_stats_t eNB_scheduler;
921
  /// processing time of eNB scheduler for SI 
922
  time_stats_t schedule_si;
923
  /// processing time of eNB scheduler for Random access
924
  time_stats_t schedule_ra;
925
  /// processing time of eNB ULSCH scheduler 
926
  time_stats_t schedule_ulsch;
927
  /// processing time of eNB DCI generation
928
  time_stats_t fill_DLSCH_dci;
929
  /// processing time of eNB MAC preprocessor
930
  time_stats_t schedule_dlsch_preprocessor;
931
  /// processing time of eNB DLSCH scheduler 
932
  time_stats_t schedule_dlsch; // include rlc_data_req + MAC header + preprocessor
933
  /// processing time of eNB MCH scheduler 
934
  time_stats_t schedule_mch;
935
  /// processing time of eNB ULSCH reception
936
  time_stats_t rx_ulsch_sdu; // include rlc_data_ind