defs.h 35.7 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"
Cedric Roux's avatar
Cedric Roux committed
60
#if defined(Rel10) || defined(Rel14)
61
62
63
#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
#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)

Cedric Roux's avatar
Cedric Roux committed
83
#if defined(Rel10) || defined(Rel14)
84

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
#define MAX_CQI_VALUE  15
135
136
137
138
/*!\briefmaximum number of supported bandwidth (1.4, 5, 10, 20 MHz) */
#define MAX_SUPPORTED_BW  4  
/*!\brief CQI values range from 1 to 15 (4 bits) */
#define CQI_VALUE_RANGE 16 
139

Bilel's avatar
Bilel committed
140
/*!\brief value for indicating BSR Timer is not running */
Bilel's avatar
Bilel committed
141
#define MAC_UE_BSR_TIMER_NOT_RUNNING   (0xFFFF)
142

143
144
145
#define LCID_EMPTY 0
#define LCID_NOT_EMPTY 1

Bilel's avatar
Bilel committed
146
147
148
149
150
151
/*!\brief minimum RLC PDU size to be transmitted = min RLC Status PDU or RLC UM PDU SN 5 bits */
#define MIN_RLC_PDU_SIZE    (2)

/*!\brief minimum MAC data needed for transmitting 1 min RLC PDU size + 1 byte MAC subHeader */
#define MIN_MAC_HDR_RLC_SIZE    (1 + MIN_RLC_PDU_SIZE)

152
153
154
/*!\brief maximum number of slices / groups */
#define MAX_NUM_SLICES 4 

155
156
157
/* 
 * eNB part 
 */ 
158

159
160
161
162
163

/* 
 * UE/ENB common part 
 */ 
/*!\brief MAC header of Random Access Response for Random access preamble identifier (RAPID) */
164
typedef struct {
gauthier's avatar
gauthier committed
165
166
167
  uint8_t RAPID:6;
  uint8_t T:1;
  uint8_t E:1;
168
169
} __attribute__((__packed__))RA_HEADER_RAPID;

170
/*!\brief  MAC header of Random Access Response for backoff indicator (BI)*/
171
typedef struct {
gauthier's avatar
gauthier committed
172
173
174
175
  uint8_t BI:4;
  uint8_t R:2;
  uint8_t T:1;
  uint8_t E:1;
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
} __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
*/
206
/*!\brief  MAC subheader short with 7bit Length field */
207
typedef struct {
gauthier's avatar
gauthier committed
208
209
210
211
212
  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
213
} __attribute__((__packed__))SCH_SUBHEADER_SHORT;
214
/*!\brief  MAC subheader long  with 15bit Length field */
215
typedef struct {
gauthier's avatar
gauthier committed
216
217
218
219
220
221
222
  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;
223
} __attribute__((__packed__))SCH_SUBHEADER_LONG;
224
/*!\brief MAC subheader short without length field */
225
typedef struct {
gauthier's avatar
gauthier committed
226
227
228
  uint8_t LCID:5;
  uint8_t E:1;
  uint8_t R:2;
229
230
} __attribute__((__packed__))SCH_SUBHEADER_FIXED;

231
/*!\brief  mac control element: short buffer status report for a specific logical channel group ID*/
232
typedef struct {
gauthier's avatar
gauthier committed
233
234
  uint8_t Buffer_size:6;  // octet 1 LSB
  uint8_t LCGID:2;        // octet 1 MSB
235
236
237
} __attribute__((__packed__))BSR_SHORT;

typedef BSR_SHORT BSR_TRUNCATED;
238
/*!\brief  mac control element: long buffer status report for all logical channel group ID*/
239
typedef struct {
fnabet's avatar
fnabet committed
240
241
242
243
  uint8_t Buffer_size3:6;
  uint8_t Buffer_size2:6;
  uint8_t Buffer_size1:6;
  uint8_t Buffer_size0:6;
244
245
246
} __attribute__((__packed__))BSR_LONG;

#define BSR_LONG_SIZE  (sizeof(BSR_LONG))
247
/*!\brief  mac control element: timing advance  */
248
typedef struct {
gauthier's avatar
gauthier committed
249
250
  uint8_t TA:6;
  uint8_t R:2;
251
} __attribute__((__packed__))TIMING_ADVANCE_CMD;
252
/*!\brief  mac control element: power headroom report  */
253
typedef struct {
gauthier's avatar
gauthier committed
254
255
  uint8_t PH:6;
  uint8_t R:2;
256
257
} __attribute__((__packed__))POWER_HEADROOM_CMD;

258
/*!\brief  DCI PDU filled by MAC for the PHY  */
259
typedef struct {
gauthier's avatar
gauthier committed
260
261
  uint8_t Num_ue_spec_dci ;
  uint8_t Num_common_dci  ;
262
  //  uint32_t nCCE;
263
  uint32_t num_pdcch_symbols;
264
265
  DCI_ALLOC_t dci_alloc[NUM_DCI_MAX] ;
} DCI_PDU;
266
/*! \brief CCCH payload */
267
typedef struct {
268
  uint8_t payload[CCCH_PAYLOAD_SIZE_MAX] ;
269
} __attribute__((__packed__))CCCH_PDU;
270
/*! \brief BCCH payload */
271
typedef struct {
272
  uint8_t payload[BCCH_PAYLOAD_SIZE_MAX] ;
273
} __attribute__((__packed__))BCCH_PDU;
274
275
276
277
/*! \brief BCCH payload */
typedef struct {
  uint8_t payload[PCCH_PAYLOAD_SIZE_MAX] ;
} __attribute__((__packed__))PCCH_PDU;
278

Cedric Roux's avatar
Cedric Roux committed
279
#if defined(Rel10) || defined(Rel14)
280
/*! \brief MCCH payload */
281
typedef struct {
282
  uint8_t payload[MCCH_PAYLOAD_SIZE_MAX] ;
283
} __attribute__((__packed__))MCCH_PDU;
284
/*!< \brief MAC control element for activation and deactivation of component carriers */
285
286
287
288
289
290
291
292
293
294
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;
295
/*! \brief MAC control element: MCH Scheduling Information */
296
typedef struct {
gauthier's avatar
gauthier committed
297
298
299
  uint8_t stop_sf_MSB:3; // octet 1 LSB
  uint8_t lcid:5;        // octet 2 MSB
  uint8_t stop_sf_LSB:8;
300
} __attribute__((__packed__))MSI_ELEMENT;
301
302
#endif
/*! \brief Values of CCCH LCID for DLSCH */ 
303
#define CCCH_LCHANID 0
304
305
/*!\brief Values of BCCH logical channel */
#define BCCH 3  // SI 
306
307
/*!\brief Values of PCCH logical channel */
#define PCCH 4  // Paging 
308
309
310
311
312
313
314
315
316
317
318
319
320
321
/*!\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*/
322
#define UE_CONT_RES 28
323
/*!\brief LCID of timing advance for DLSCH */
324
#define TIMING_ADV_CMD 29
325
/*!\brief LCID of discontinous reception mode for DLSCH */
326
#define DRX_CMD 30
327
/*!\brief LCID of padding LCID for DLSCH */
328
329
#define SHORT_PADDING 31

Cedric Roux's avatar
Cedric Roux committed
330
#if defined(Rel10) || defined(Rel14)
331
// MCH LCHAN IDs (table6.2.1-4 TS36.321)
332
/*!\brief LCID of MCCH for DL */
333
#define MCCH_LCHANID 0
334
335
336
/*!\brief LCID of MCH scheduling info for DL */
#define MCH_SCHDL_INFO 3
/*!\brief LCID of Carrier component activation/deactivation */
337
#define CC_ACT_DEACT 27
338
339
340
#endif

// ULSCH LCHAN IDs
341
/*!\brief LCID of extended power headroom for ULSCH */
342
#define EXTENDED_POWER_HEADROOM 25
343
/*!\brief LCID of power headroom for ULSCH */
344
#define POWER_HEADROOM 26
345
/*!\brief LCID of CRNTI for ULSCH */
346
#define CRNTI 27
347
/*!\brief LCID of truncated BSR for ULSCH */
348
#define TRUNCATED_BSR 28
349
/*!\brief LCID of short BSR for ULSCH */
350
#define SHORT_BSR 29
351
/*!\brief LCID of long BSR for ULSCH */
352
#define LONG_BSR 30
fnabet's avatar
fnabet committed
353
354
355
356
357
/*!\bitmaps for BSR Triggers */
#define	BSR_TRIGGER_NONE		(0)			/* No BSR Trigger */
#define	BSR_TRIGGER_REGULAR		(1)			/* For Regular and ReTxBSR Expiry Triggers */
#define	BSR_TRIGGER_PERIODIC	(2)			/* For BSR Periodic Timer Expiry Trigger */
#define	BSR_TRIGGER_PADDING		(4)			/* For Padding BSR Trigger */
358
359


360
/*! \brief Downlink SCH PDU Structure */
361
typedef struct {
gauthier's avatar
gauthier committed
362
363
  int8_t payload[8][SCH_PAYLOAD_SIZE_MAX];
  uint16_t Pdu_size[8];
364
365
} __attribute__ ((__packed__)) DLSCH_PDU;

366
/*! \brief MCH PDU Structure */
367
typedef struct {
gauthier's avatar
gauthier committed
368
369
  int8_t payload[SCH_PAYLOAD_SIZE_MAX];
  uint16_t Pdu_size;
370
  uint8_t mcs;
371
372
373
  uint8_t sync_area;
  uint8_t msi_active;
  uint8_t mcch_active;
374
  uint8_t mtch_active;
375
376
} __attribute__ ((__packed__)) MCH_PDU;

377
/*! \brief Uplink SCH PDU Structure */
378
typedef struct {
gauthier's avatar
gauthier committed
379
380
  int8_t payload[SCH_PAYLOAD_SIZE_MAX];         /*!< \brief SACH payload */
  uint16_t Pdu_size;
381
382
383
384
} __attribute__ ((__packed__)) ULSCH_PDU;

#include "PHY/impl_defs_top.h"

385
/*!\brief  UE ULSCH scheduling states*/
386
387
388
typedef enum {
  S_UL_NONE =0,
  S_UL_WAITING,
389
390
  S_UL_SCHEDULED,
  S_UL_BUFFERED,
391
392
393
  S_UL_NUM_STATUS
} UE_ULSCH_STATUS;

394
/*!\brief  UE DLSCH scheduling states*/
395
396
397
typedef enum {
  S_DL_NONE =0,
  S_DL_WAITING,
398
399
  S_DL_SCHEDULED,
  S_DL_BUFFERED,
400
401
402
  S_DL_NUM_STATUS
} UE_DLSCH_STATUS;

403
/*!\brief  scheduling policy for the contention-based access */
404
typedef enum {
405
406
407
408
409
  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
410
411
412
} CBA_POLICY;


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

  uint32_t total_ulsch_bitrate;
  //
  uint32_t total_ulsch_bytes_rx;
  //
  uint32_t total_ulsch_pdus_rx;
  
485
486
487
488
489
490
491
  
  /// MAC agent-related stats
  /// total number of scheduling decisions
  int sched_decisions;
  /// missed deadlines
  int missed_deadlines;

492
} eNB_STATS;
493
/*! \brief eNB statistics for the connected UEs*/
494
typedef struct {
495
496

  /// CRNTI of UE
gauthier's avatar
gauthier committed
497
  rnti_t crnti; ///user id (rnti) of connected UEs
498
  // rrc status
499
500
501
  uint8_t rrc_status;
  /// harq pid
  uint8_t harq_pid;
502
  /// harq rounf
503
  uint8_t harq_round;
504
  /// DL Wideband CQI index (2 TBs)
505
506
507
508
509
  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;
510
  /// total nccc used for a new transmission: num control channel element
511
  uint16_t ncce_used;
512
  /// total avilable nccc for a retransmission: num control channel element
513
  uint16_t ncce_used_retx;
514
515

  // mcs1 before the rate adaptaion
516
  uint8_t dlsch_mcs1;
517
  /// Target mcs2 after rate-adaptation
518
  uint8_t dlsch_mcs2;
519
  //  current TBS with mcs2
520
  uint32_t TBS;
521
  //  total TBS with mcs2
522
  //  uint32_t total_TBS;
523
  //  total rb used for a new transmission
524
  uint32_t total_rbs_used;
525
  //  total rb used for retransmission
526
  uint32_t total_rbs_used_retx;
527

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

  /// overall
539
  //
540
541
542
543
  uint32_t  dlsch_bitrate;
  //total
  uint32_t  total_dlsch_bitrate;
  /// headers+ CE +  padding bytes for a MAC PDU
544
  uint64_t overhead_bytes;
545
  /// headers+ CE +  padding bytes for a MAC PDU
546
  uint64_t total_overhead_bytes;
547
  /// headers+ CE +  padding bytes for a MAC PDU
548
  uint64_t avg_overhead_bytes;
549
  // MAC multiplexed payload
550
551
552
  uint64_t total_sdu_bytes;
  // total MAC pdu bytes
  uint64_t total_pdu_bytes;
553

554
555
556
557
  // total num pdu
  uint32_t total_num_pdus;
  //
  //  uint32_t avg_pdu_size;
558
559

  /// RX
560
561
562
563
564
565

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

566
567
568
569
  /// estimated average pdu inter-departure time
  uint32_t avg_pdu_idt;
  /// estimated average pdu size
  uint32_t avg_pdu_ps;
570
  ///
571
572
  uint32_t aggregated_pdu_size;
  uint32_t aggregated_pdu_arrival;
573

574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
  ///  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;

590
  /// num rx pdu
591
  uint32_t num_pdu_rx[NB_RB_MAX];
592
  /// num bytes rx
593
  uint32_t num_bytes_rx[NB_RB_MAX];
594
  /// instantaneous rx throughput for each TTI
595
  //  uint32_t tti_goodput[NB_RB_MAX];
596
597
  /// errors
  uint32_t num_errors_rx;
598
599
600
601
602
603
604
605
606
607
  
  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;
608
  /// overall
609
610
  ///  MAC pdu bytes
  uint64_t pdu_bytes_rx;
611
  /// total MAC pdu bytes
612
  uint64_t total_pdu_bytes_rx;
613
  /// total num pdu
614
  uint32_t total_num_pdus_rx;
615
  /// num of error pdus
616
  uint32_t total_num_errors_rx;
617

618
} eNB_UE_STATS;
619
/*! \brief eNB template for UE context information  */
620
typedef struct {
621
  /// C-RNTI of UE
gauthier's avatar
gauthier committed
622
  rnti_t rnti;
623
624
625
626
  /// NDI from last scheduling
  uint8_t oldNDI[8];
  /// NDI from last UL scheduling
  uint8_t oldNDI_UL[8];
627
  /// Flag to indicate UL has been scheduled at least once
gauthier's avatar
gauthier committed
628
  boolean_t ul_active;
knopp's avatar
   
knopp committed
629
630
  /// Flag to indicate UE has been configured (ACK from RRCConnectionSetup received)
  boolean_t configured;
631

632
633
634
635
636
637
  /// MCS from last scheduling
  uint8_t mcs[8];

  /// TPC from last scheduling
  uint8_t oldTPC[8];

638
639
640
  // PHY interface info

  /// DCI format for DLSCH
gauthier's avatar
gauthier committed
641
  uint16_t DLSCH_dci_fmt;
642

643
  /// Current Aggregation Level for DCI
gauthier's avatar
gauthier committed
644
  uint8_t DCI_aggregation_min;
645

646
  /// size of DLSCH size in bit 
gauthier's avatar
gauthier committed
647
  uint8_t DLSCH_dci_size_bits;
648
649

  /// DCI buffer for DLSCH
650
651
652
  /* 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];
653
654

  /// Number of Allocated RBs for DL after scheduling (prior to frequency allocation)
655
  uint16_t nb_rb[8]; // num_max_harq
656
657

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

660
661
  /// Number of Allocated RBs by the ulsch preprocessor
  uint8_t pre_allocated_nb_rb_ul;
662

663
664
  /// index of Allocated RBs by the ulsch preprocessor
  int8_t pre_allocated_rb_table_index_ul;
665

666
667
  /// total allocated RBs
  int8_t total_allocated_rbs;
668

669
  /// pre-assigned MCS by the ulsch preprocessor
670
  uint8_t pre_assigned_mcs_ul;
671
672
673
674

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

675
  /// DCI buffer for ULSCH
676
677
678
  /* 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];
679
680

  /// DL DAI
gauthier's avatar
gauthier committed
681
  uint8_t DAI;
682
683

  /// UL DAI
gauthier's avatar
gauthier committed
684
  uint8_t DAI_ul[10];
685
686

  /// UL Scheduling Request Received
gauthier's avatar
gauthier committed
687
  uint8_t ul_SR;
688

689
  ///Resource Block indication for each sub-band in MU-MIMO
gauthier's avatar
gauthier committed
690
  uint8_t rballoc_subband[8][50];
691
692
693

  // Logical channel info for link with RLC

694
  /// Last received UE BSR info for each logical channel group id
gauthier's avatar
gauthier committed
695
  uint8_t bsr_info[MAX_NUM_LCGID];
696

697
698
699
  /// LCGID mapping
  long lcgidmap[11];

700
  /// phr information
701
  int8_t phr_info;
702

703
704
705
  /// phr information
  int8_t phr_info_configured;

706
  ///dl buffer info
gauthier's avatar
gauthier committed
707
  uint32_t dl_buffer_info[MAX_NUM_LCID];
708
  /// total downlink buffer info
gauthier's avatar
gauthier committed
709
  uint32_t dl_buffer_total;
710
  /// total downlink pdus
gauthier's avatar
gauthier committed
711
  uint32_t dl_pdus_total;
712
  /// downlink pdus for each LCID
gauthier's avatar
gauthier committed
713
  uint32_t dl_pdus_in_buffer[MAX_NUM_LCID];
714
  /// creation time of the downlink buffer head for each LCID
gauthier's avatar
gauthier committed
715
  uint32_t dl_buffer_head_sdu_creation_time[MAX_NUM_LCID];
716
  /// maximum creation time of the downlink buffer head across all LCID
717
  uint32_t  dl_buffer_head_sdu_creation_time_max;
718
  /// a flag indicating that the downlink head SDU is segmented  
gauthier's avatar
gauthier committed
719
  uint8_t    dl_buffer_head_sdu_is_segmented[MAX_NUM_LCID];
720
  /// size of remaining size to send for the downlink head SDU
gauthier's avatar
gauthier committed
721
  uint32_t dl_buffer_head_sdu_remaining_size_to_send[MAX_NUM_LCID];
722

723
  /// total uplink buffer size 
724
  uint32_t ul_total_buffer;
725
  /// uplink buffer creation time for each LCID
726
  uint32_t ul_buffer_creation_time[MAX_NUM_LCGID];
727
  /// maximum uplink buffer creation time across all the LCIDs
728
  uint32_t ul_buffer_creation_time_max;
729
  /// uplink buffer size per LCID
730
731
  uint32_t ul_buffer_info[MAX_NUM_LCGID];

732
733
734
  /// UE tx power
  int32_t ue_tx_power;

kaltenbe's avatar
kaltenbe committed
735
  /// stores the frame where the last TPC was transmitted
knopp's avatar
knopp committed
736
737
738
739
  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
740

741
742
743
#ifdef LOCALIZATION
  eNB_UE_estimated_distances distance;
#endif
744
745
} UE_TEMPLATE;

746
/*! \brief scheduling control information set through an API (not used)*/
747
typedef struct {
748
  ///UL transmission bandwidth in RBs
749
  uint8_t ul_bandwidth[MAX_NUM_LCID];
750
  ///DL transmission bandwidth in RBs
751
  uint8_t dl_bandwidth[MAX_NUM_LCID];
752

753
754
  //To do GBR bearer
  uint8_t min_ul_bandwidth[MAX_NUM_LCID];
755

756
  uint8_t min_dl_bandwidth[MAX_NUM_LCID];
757

758
  ///aggregated bit rate of non-gbr bearer per UE
759
  uint64_t  ue_AggregatedMaximumBitrateDL;
760
  ///aggregated bit rate of non-gbr bearer per UE
761
  uint64_t  ue_AggregatedMaximumBitrateUL;
762
  ///CQI scheduling interval in subframes.
763
  uint16_t cqiSchedInterval;
764
  ///Contention resolution timer used during random access
765
  uint8_t mac_ContentionResolutionTimer;
766

767
  uint16_t max_allowed_rbs[MAX_NUM_LCID];
768

769
  uint8_t max_mcs[MAX_NUM_LCID];
770

771
  uint16_t priority[MAX_NUM_LCID];
772

773
774
775
776
777
778
  // 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];
779
  uint16_t      ta_timer;
780
781
  int16_t       ta_update;
  int32_t       context_active_timer;
782
  int32_t       cqi_req_timer;
783
  int32_t       ul_inactivity_timer;
784
  int32_t       ul_failure_timer;
785
  int32_t       ul_scheduled;
786
  int32_t       ra_pdcch_order_sent;
Florian Kaltenberger's avatar
Florian Kaltenberger committed
787
  int32_t       ul_out_of_sync;
788
  int32_t       phr_received;
789
} UE_sched_ctrl;
790
/*! \brief eNB template for the Random access information */
791
792
typedef struct {
  /// Flag to indicate this process is active
gauthier's avatar
gauthier committed
793
  boolean_t RA_active;
794
  /// Size of DCI for RA-Response (bytes)
gauthier's avatar
gauthier committed
795
  uint8_t RA_dci_size_bytes1;
796
  /// Size of DCI for RA-Response (bits)
gauthier's avatar
gauthier committed
797
  uint8_t RA_dci_size_bits1;
798
  /// Actual DCI to transmit for RA-Response
gauthier's avatar
gauthier committed
799
  uint8_t RA_alloc_pdu1[(MAX_DCI_SIZE_BITS>>3)+1];
800
  /// DCI format for RA-Response (should be 1A)
gauthier's avatar
gauthier committed
801
  uint8_t RA_dci_fmt1;
802
  /// Size of DCI for Msg4/ContRes (bytes)
gauthier's avatar
gauthier committed
803
  uint8_t RA_dci_size_bytes2;
804
  /// Size of DCI for Msg4/ContRes (bits)
gauthier's avatar
gauthier committed
805
  uint8_t RA_dci_size_bits2;
806
  /// Actual DCI to transmit for Msg4/ContRes
gauthier's avatar
gauthier committed
807
  uint8_t RA_alloc_pdu2[(MAX_DCI_SIZE_BITS>>3)+1];
808
  /// DCI format for Msg4/ContRes (should be 1A)
gauthier's avatar
gauthier committed
809
  uint8_t RA_dci_fmt2;
810
  /// Flag to indicate the eNB should generate RAR.  This is triggered by detection of PRACH
gauthier's avatar
gauthier committed
811
  uint8_t generate_rar;
812
  /// Subframe where preamble was received
gauthier's avatar
gauthier committed
813
  uint8_t preamble_subframe;
814
  /// Subframe where Msg3 is to be sent
gauthier's avatar
gauthier committed
815
  uint8_t Msg3_subframe;
816
  /// 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.
817
  uint8_t generate_Msg4;
818
  /// Flag to indicate that eNB is waiting for ACK that UE has received Msg3.
gauthier's avatar
gauthier committed
819
  uint8_t wait_ack_Msg4;
820
  /// UE RNTI allocated during RAR
gauthier's avatar
gauthier committed
821
  rnti_t rnti;
822
  /// RA RNTI allocated from received PRACH
gauthier's avatar
gauthier committed
823
  uint16_t RA_rnti;
824
  /// Received preamble_index
gauthier's avatar
gauthier committed
825
  uint8_t preamble_index;
826
  /// Received UE Contention Resolution Identifier
gauthier's avatar
gauthier committed
827
  uint8_t cont_res_id[6];
828
  /// Timing offset indicated by PHY
gauthier's avatar
gauthier committed
829
  int16_t timing_offset;
830
  /// Timeout for RRC connection
gauthier's avatar
gauthier committed
831
  int16_t RRC_timer;
832
833
834
} RA_TEMPLATE;


835
/*! \brief subband bitmap confguration (for ALU icic algo purpose), in test phase */
836
837
838
839
840
841
842
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;
843
/*! \brief UE list used by eNB to order UEs/CC for scheduling*/ 
844
typedef struct {
845
  /// DLSCH pdu 
knopp's avatar
   
knopp committed
846
847
848
849
850
  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];
851
  /// sorted downlink component carrier for the scheduler 
knopp's avatar
   
knopp committed
852
  int ordered_CCids[MAX_NUM_CCs][NUMBER_OF_UE_MAX];
853
  /// number of downlink active component carrier 
knopp's avatar
   
knopp committed
854
  int numactiveCCs[NUMBER_OF_UE_MAX];
855
  /// sorted uplink component carrier for the scheduler 
knopp's avatar
   
knopp committed
856
  int ordered_ULCCids[MAX_NUM_CCs][NUMBER_OF_UE_MAX];
857
  /// number of uplink active component carrier 
knopp's avatar
   
knopp committed
858
  int numactiveULCCs[NUMBER_OF_UE_MAX];
859
  /// number of downlink active component carrier 
860
  uint8_t dl_CC_bitmap[NUMBER_OF_UE_MAX];
861
  /// eNB to UE statistics
knopp's avatar
   
knopp committed
862
  eNB_UE_STATS eNB_UE_stats[MAX_NUM_CCs][NUMBER_OF_UE_MAX];
863
  /// scheduling control info
knopp's avatar
   
knopp committed
864
865
866
  UE_sched_ctrl UE_sched_ctrl[NUMBER_OF_UE_MAX];

  int next[NUMBER_OF_UE_MAX];
867
  int head;
868
869
  int next_ul[NUMBER_OF_UE_MAX];
  int head_ul;
knopp's avatar
   
knopp committed
870
871
872
873
  int avail;
  int num_UEs;
  boolean_t active[NUMBER_OF_UE_MAX];
} UE_list_t;
874

875
/*! \brief eNB common channels */ 
876
typedef struct {
877
878
879
880
  /// Outgoing DCI for PHY generated by eNB scheduler
  DCI_PDU DCI_pdu;
  /// Outgoing BCCH pdu for PHY
  BCCH_PDU BCCH_pdu;
881
882
  /// Outgoing BCCH DCI allocation
  uint32_t BCCH_alloc_pdu;
883
884
885
  /// Outgoing CCCH pdu for PHY
  CCCH_PDU CCCH_pdu;
  RA_TEMPLATE RA_template[NB_RA_PROC_MAX];
886
887
  /// VRB map for common channels
  uint8_t vrb_map[100];
888
889
  /// MBSFN SubframeConfig
  struct MBSFN_SubframeConfig *mbsfn_SubframeConfig[8];
890
  /// number of subframe allocation pattern available for MBSFN sync area
gauthier's avatar
gauthier committed
891
  uint8_t num_sf_allocation_pattern;
Cedric Roux's avatar
Cedric Roux committed
892
#if defined(Rel10) || defined(Rel14)
893
  /// MBMS Flag
gauthier's avatar
gauthier committed
894
  uint8_t MBMS_flag;
895
896
897
  /// Outgoing MCCH pdu for PHY
  MCCH_PDU MCCH_pdu;
  /// MCCH active flag
gauthier's avatar
gauthier committed
898
  uint8_t msi_active;
899
  /// MCCH active flag
gauthier's avatar
gauthier committed
900
  uint8_t mcch_active;
901
  /// MTCH active flag
gauthier's avatar
gauthier committed
902
  uint8_t mtch_active;
903
  /// number of active MBSFN area
gauthier's avatar
gauthier committed
904
  uint8_t num_active_mbsfn_area;
905
906
907
908
909
910
911
912
913
914
  /// 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
915
  /// number of CBA groups 
916
  uint8_t num_active_cba_groups;
917
  /// RNTI for each CBA group 
918
  uint16_t cba_rnti[NUM_MAX_CBA_GROUP];
919
  /// MCS for each CBA group 
920
  uint8_t group_mcs[NUM_MAX_CBA_GROUP];
921
922
#endif
} COMMON_channels_t;
923
/*! \brief top level eNB MAC structure */ 
924
925
typedef struct {
  ///
knopp's avatar
   
knopp committed
926
927
928
929
930
931
932
933
  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;
934

935
936
  ///subband bitmap configuration
  SBMAP_CONF sbmap_conf;
937
938
  /// CCE table used to build DCI scheduling information
  int CCE_table[MAX_NUM_CCs][800];
939
  ///  active flag for Other lcid
940
  uint8_t lcid_active[NB_RB_MAX];
941
  /// eNB stats
942
  eNB_STATS eNB_stats[MAX_NUM_CCs];
943
  // MAC function execution peformance profiler
944
  /// processing time of eNB scheduler 
945
  time_stats_t eNB_scheduler;
946
  /// processing time of eNB scheduler for SI 
947
  time_stats_t schedule_si;
948
  /// processing time of eNB scheduler for Random access
949
  time_stats_t schedule_ra;
950
  /// processing time of eNB ULSCH scheduler 
951
  time_stats_t schedule_ulsch;
952
  /// processing time of eNB DCI generation
953
  time_stats_t fill_DLSCH_dci;
954
  /// processing time of eNB MAC preprocessor
955
  time_stats_t schedule_dlsch_preprocessor;
956
  /// processing time of eNB DLSCH scheduler 
957
  time_stats_t schedule_dlsch; // include rlc_data_req + MAC header + preprocessor
958
  /// processing time of eNB MCH scheduler 
959
  time_stats_t schedule_mch;
960
  /// processing time of eNB ULSCH reception
961
  time_stats_t rx_ulsch_sdu; // include rlc_data_ind
962
963

} eNB_MAC_INST;
964