defs.h 38.2 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
#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"

50
51
52
53


#include "PHY/defs.h"
#include "PHY/LTE_TRANSPORT/defs.h"
54
#include "COMMON/platform_constants.h"
55
#include "BCCH-BCH-Message.h"
56
57
58
#include "RadioResourceConfigCommon.h"
#include "RadioResourceConfigDedicated.h"
#include "MeasGapConfig.h"
59
#include "SchedulingInfoList.h"
60
61
62
#include "TDD-Config.h"
#include "RACH-ConfigCommon.h"
#include "MeasObjectToAddModList.h"
63
#include "MobilityControlInfo.h"
Cedric Roux's avatar
Cedric Roux committed
64
#if defined(Rel10) || defined(Rel14)
65
66
67
#include "MBSFN-AreaInfoList-r9.h"
#include "MBSFN-SubframeConfigList.h"
#include "PMCH-InfoList-r9.h"
knopp's avatar
   
knopp committed
68
#include "SCellToAddMod-r10.h"
69
#endif
70
71
72
#ifdef Rel14
#include "SystemInformationBlockType1-v1310-IEs.h"
#endif
73

74
75
#include "nfapi_interface.h"
#include "PHY_INTERFACE/IF_Module.h"
76

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

82
#define BCCH_PAYLOAD_SIZE_MAX 128
83
#define CCCH_PAYLOAD_SIZE_MAX 128
84
#define PCCH_PAYLOAD_SIZE_MAX 128
85
#define RAR_PAYLOAD_SIZE_MAX 128
86

87
88
89
#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
90
#if defined(Rel10) || defined(Rel14)
91

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

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

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

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

150
151
152
#define LCID_EMPTY 0
#define LCID_NOT_EMPTY 1

Bilel's avatar
Bilel committed
153
154
155
156
157
158
/*!\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)

159
160
161
/*!\brief maximum number of slices / groups */
#define MAX_NUM_SLICES 4 

162
163
164
/* 
 * eNB part 
 */ 
165

166
167
168
169
170

/* 
 * UE/ENB common part 
 */ 
/*!\brief MAC header of Random Access Response for Random access preamble identifier (RAPID) */
171
typedef struct {
gauthier's avatar
gauthier committed
172
173
174
  uint8_t RAPID:6;
  uint8_t T:1;
  uint8_t E:1;
175
176
} __attribute__((__packed__))RA_HEADER_RAPID;

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

238
/*!\brief  mac control element: short buffer status report for a specific logical channel group ID*/
239
typedef struct {
gauthier's avatar
gauthier committed
240
241
  uint8_t Buffer_size:6;  // octet 1 LSB
  uint8_t LCGID:2;        // octet 1 MSB
242
243
244
} __attribute__((__packed__))BSR_SHORT;

typedef BSR_SHORT BSR_TRUNCATED;
245
/*!\brief  mac control element: long buffer status report for all logical channel group ID*/
246
typedef struct {
fnabet's avatar
fnabet committed
247
248
249
250
  uint8_t Buffer_size3:6;
  uint8_t Buffer_size2:6;
  uint8_t Buffer_size1:6;
  uint8_t Buffer_size0:6;
251
252
253
} __attribute__((__packed__))BSR_LONG;

#define BSR_LONG_SIZE  (sizeof(BSR_LONG))
254
/*!\brief  mac control element: timing advance  */
255
typedef struct {
gauthier's avatar
gauthier committed
256
257
  uint8_t TA:6;
  uint8_t R:2;
258
} __attribute__((__packed__))TIMING_ADVANCE_CMD;
259
/*!\brief  mac control element: power headroom report  */
260
typedef struct {
gauthier's avatar
gauthier committed
261
262
  uint8_t PH:6;
  uint8_t R:2;
263
264
} __attribute__((__packed__))POWER_HEADROOM_CMD;

265
/*! \brief MIB payload */
266
typedef struct {
267
268
  uint8_t payload[3] ;
} __attribute__((__packed__))MIB_PDU;
269
/*! \brief CCCH payload */
270
typedef struct {
271
  uint8_t payload[CCCH_PAYLOAD_SIZE_MAX] ;
272
} __attribute__((__packed__))CCCH_PDU;
273
/*! \brief BCCH payload */
274
typedef struct {
275
  uint8_t payload[BCCH_PAYLOAD_SIZE_MAX] ;
276
} __attribute__((__packed__))BCCH_PDU;
277
278
279
280
/*! \brief RAR payload */
typedef struct {
  uint8_t payload[RAR_PAYLOAD_SIZE_MAX];
} __attribute__ ((__packed__)) RAR_PDU;
281
282
283
284
/*! \brief BCCH payload */
typedef struct {
  uint8_t payload[PCCH_PAYLOAD_SIZE_MAX] ;
} __attribute__((__packed__))PCCH_PDU;
285

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

Cedric Roux's avatar
Cedric Roux committed
343
#if defined(Rel10) || defined(Rel14)
344
// MCH LCHAN IDs (table6.2.1-4 TS36.321)
345
/*!\brief LCID of MCCH for DL */
346
#define MCCH_LCHANID 0
347
348
349
/*!\brief LCID of MCH scheduling info for DL */
#define MCH_SCHDL_INFO 3
/*!\brief LCID of Carrier component activation/deactivation */
350
#define CC_ACT_DEACT 27
351
352
353
#endif

// ULSCH LCHAN IDs
354
/*!\brief LCID of extended power headroom for ULSCH */
355
#define EXTENDED_POWER_HEADROOM 25
356
/*!\brief LCID of power headroom for ULSCH */
357
#define POWER_HEADROOM 26
358
/*!\brief LCID of CRNTI for ULSCH */
359
#define CRNTI 27
360
/*!\brief LCID of truncated BSR for ULSCH */
361
#define TRUNCATED_BSR 28
362
/*!\brief LCID of short BSR for ULSCH */
363
#define SHORT_BSR 29
364
/*!\brief LCID of long BSR for ULSCH */
365
#define LONG_BSR 30
fnabet's avatar
fnabet committed
366
367
368
369
370
/*!\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 */
371
372


373
/*! \brief Downlink SCH PDU Structure */
374
typedef struct {
375
  uint8_t payload[8][SCH_PAYLOAD_SIZE_MAX];
gauthier's avatar
gauthier committed
376
  uint16_t Pdu_size[8];
377
378
} __attribute__ ((__packed__)) DLSCH_PDU;

379

380
/*! \brief MCH PDU Structure */
381
typedef struct {
gauthier's avatar
gauthier committed
382
383
  int8_t payload[SCH_PAYLOAD_SIZE_MAX];
  uint16_t Pdu_size;
384
  uint8_t mcs;
385
386
387
  uint8_t sync_area;
  uint8_t msi_active;
  uint8_t mcch_active;
388
  uint8_t mtch_active;
389
390
} __attribute__ ((__packed__)) MCH_PDU;

391
/*! \brief Uplink SCH PDU Structure */
392
typedef struct {
gauthier's avatar
gauthier committed
393
394
  int8_t payload[SCH_PAYLOAD_SIZE_MAX];         /*!< \brief SACH payload */
  uint16_t Pdu_size;
395
396
397
398
} __attribute__ ((__packed__)) ULSCH_PDU;

#include "PHY/impl_defs_top.h"

399
/*!\brief  UE ULSCH scheduling states*/
400
401
402
typedef enum {
  S_UL_NONE =0,
  S_UL_WAITING,
403
404
  S_UL_SCHEDULED,
  S_UL_BUFFERED,
405
406
407
  S_UL_NUM_STATUS
} UE_ULSCH_STATUS;

408
/*!\brief  UE DLSCH scheduling states*/
409
410
411
typedef enum {
  S_DL_NONE =0,
  S_DL_WAITING,
412
413
  S_DL_SCHEDULED,
  S_DL_BUFFERED,
414
415
416
  S_DL_NUM_STATUS
} UE_DLSCH_STATUS;

417
/*!\brief  scheduling policy for the contention-based access */
418
typedef enum {
419
420
421
422
423
  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
424
425
426
} CBA_POLICY;


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

  uint32_t total_ulsch_bitrate;
  //
  uint32_t total_ulsch_bytes_rx;
  //
  uint32_t total_ulsch_pdus_rx;
  
499
500
501
502
503
504
505
  
  /// MAC agent-related stats
  /// total number of scheduling decisions
  int sched_decisions;
  /// missed deadlines
  int missed_deadlines;

506
} eNB_STATS;
507
/*! \brief eNB statistics for the connected UEs*/
508
typedef struct {
509
510

  /// CRNTI of UE
gauthier's avatar
gauthier committed
511
  rnti_t crnti; ///user id (rnti) of connected UEs
512
  // rrc status
513
514
515
  uint8_t rrc_status;
  /// harq pid
  uint8_t harq_pid;
516
  /// harq rounf
517
  uint8_t harq_round;
518
  /// DL Wideband CQI index (2 TBs)
519
520
521
522
523
  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;
524
  /// total nccc used for a new transmission: num control channel element
525
  uint16_t ncce_used;
526
  /// total avilable nccc for a retransmission: num control channel element
527
  uint16_t ncce_used_retx;
528
529

  // mcs1 before the rate adaptaion
530
  uint8_t dlsch_mcs1;
531
  /// Target mcs2 after rate-adaptation
532
  uint8_t dlsch_mcs2;
533
  //  current TBS with mcs2
534
  uint32_t TBS;
535
  //  total TBS with mcs2
536
  //  uint32_t total_TBS;
537
  //  total rb used for a new transmission
538
  uint32_t total_rbs_used;
539
  //  total rb used for retransmission
540
  uint32_t total_rbs_used_retx;
541

542
   /// TX
543
544
545
546
547
548
549
550
  /// 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];
551
552

  /// overall
553
  //
554
555
556
557
  uint32_t  dlsch_bitrate;
  //total
  uint32_t  total_dlsch_bitrate;
  /// headers+ CE +  padding bytes for a MAC PDU
558
  uint64_t overhead_bytes;
559
  /// headers+ CE +  padding bytes for a MAC PDU
560
  uint64_t total_overhead_bytes;
561
  /// headers+ CE +  padding bytes for a MAC PDU
562
  uint64_t avg_overhead_bytes;
563
  // MAC multiplexed payload
564
565
566
  uint64_t total_sdu_bytes;
  // total MAC pdu bytes
  uint64_t total_pdu_bytes;
567

568
569
570
571
  // total num pdu
  uint32_t total_num_pdus;
  //
  //  uint32_t avg_pdu_size;
572
573

  /// RX
574

575
576
577
578
579
580
  /// PUCCH1a/b power (dBm)
  int32_t Po_PUCCH_dBm;
  /// Indicator that Po_PUCCH has been updated by PHY
  int32_t Po_PUCCH_update;
  /// Uplink measured RSSI
  int32_t UL_rssi;
581
582
583
584
585
  /// preassigned mcs after rate adaptation
  uint8_t ulsch_mcs1;
  /// adjusted mcs
  uint8_t ulsch_mcs2;

586
587
588
589
  /// estimated average pdu inter-departure time
  uint32_t avg_pdu_idt;
  /// estimated average pdu size
  uint32_t avg_pdu_ps;
590
  ///
591
592
  uint32_t aggregated_pdu_size;
  uint32_t aggregated_pdu_arrival;
593

594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
  ///  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;

610
  /// num rx pdu
611
  uint32_t num_pdu_rx[NB_RB_MAX];
612
  /// num bytes rx
613
  uint32_t num_bytes_rx[NB_RB_MAX];
614
  /// instantaneous rx throughput for each TTI
615
  //  uint32_t tti_goodput[NB_RB_MAX];
616
617
  /// errors
  uint32_t num_errors_rx;
618
619
620
621
622
623
624
625
626
627
  
  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;
628
  /// overall
629
630
  ///  MAC pdu bytes
  uint64_t pdu_bytes_rx;
631
  /// total MAC pdu bytes
632
  uint64_t total_pdu_bytes_rx;
633
  /// total num pdu
634
  uint32_t total_num_pdus_rx;
635
  /// num of error pdus
636
  uint32_t total_num_errors_rx;
637

638
} eNB_UE_STATS;
639
/*! \brief eNB template for UE context information  */
640
typedef struct {
641
  /// C-RNTI of UE
gauthier's avatar
gauthier committed
642
  rnti_t rnti;
643
644
  /// NDI from last scheduling
  uint8_t oldNDI[8];
645
646
647
648
  /// mcs1 from last scheduling
  uint8_t oldmcs1[8];
  /// mcs2 from last scheduling
  uint8_t oldmcs2[8];
649
650
  /// NDI from last UL scheduling
  uint8_t oldNDI_UL[8];
651
  /// Flag to indicate UL has been scheduled at least once
gauthier's avatar
gauthier committed
652
  boolean_t ul_active;
knopp's avatar
   
knopp committed
653
654
  /// Flag to indicate UE has been configured (ACK from RRCConnectionSetup received)
  boolean_t configured;
655

656
657
658
659
660
661
  /// MCS from last scheduling
  uint8_t mcs[8];

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

662
663
664
  // PHY interface info

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

667
  /// Number of Allocated RBs for UL after scheduling
668
  uint16_t nb_rb_ul[8]; // num_max_harq
669

670
671
672
673
674
675
  /// Number of Allocated RBs for UL after scheduling
  uint16_t first_rb_ul[8]; // num_max_harq

  /// Cyclic shift for DMRS after scheduling
  uint16_t cshift[8]; // num_max_harq

676
677
  /// Number of Allocated RBs by the ulsch preprocessor
  uint8_t pre_allocated_nb_rb_ul;
678

679
680
  /// index of Allocated RBs by the ulsch preprocessor
  int8_t pre_allocated_rb_table_index_ul;
681

682
683
  /// total allocated RBs
  int8_t total_allocated_rbs;
684

685
  /// pre-assigned MCS by the ulsch preprocessor
686
  uint8_t pre_assigned_mcs_ul;
687
688
689
690

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

691
  /// DL DAI
gauthier's avatar
gauthier committed
692
  uint8_t DAI;
693
694

  /// UL DAI
gauthier's avatar
gauthier committed
695
  uint8_t DAI_ul[10];
696
697

  /// UL Scheduling Request Received
gauthier's avatar
gauthier committed
698
  uint8_t ul_SR;
699

700
  ///Resource Block indication for each sub-band in MU-MIMO
gauthier's avatar
gauthier committed
701
  uint8_t rballoc_subband[8][50];
702
703
704

  // Logical channel info for link with RLC

705
  /// Last received UE BSR info for each logical channel group id
gauthier's avatar
gauthier committed
706
  uint8_t bsr_info[MAX_NUM_LCGID];
707

708
709
710
  /// LCGID mapping
  long lcgidmap[11];

711
  /// phr information
712
  int8_t phr_info;
713

714
715
716
  /// phr information
  int8_t phr_info_configured;

717
  ///dl buffer info
gauthier's avatar
gauthier committed
718
  uint32_t dl_buffer_info[MAX_NUM_LCID];
719
  /// total downlink buffer info
gauthier's avatar
gauthier committed
720
  uint32_t dl_buffer_total;
721
  /// total downlink pdus
gauthier's avatar
gauthier committed
722
  uint32_t dl_pdus_total;
723
  /// downlink pdus for each LCID
gauthier's avatar
gauthier committed
724
  uint32_t dl_pdus_in_buffer[MAX_NUM_LCID];
725
  /// creation time of the downlink buffer head for each LCID
gauthier's avatar
gauthier committed
726
  uint32_t dl_buffer_head_sdu_creation_time[MAX_NUM_LCID];
727
  /// maximum creation time of the downlink buffer head across all LCID
728
  uint32_t  dl_buffer_head_sdu_creation_time_max;
729
  /// a flag indicating that the downlink head SDU is segmented  
gauthier's avatar
gauthier committed
730
  uint8_t    dl_buffer_head_sdu_is_segmented[MAX_NUM_LCID];
731
  /// size of remaining size to send for the downlink head SDU
gauthier's avatar
gauthier committed
732
  uint32_t dl_buffer_head_sdu_remaining_size_to_send[MAX_NUM_LCID];
733

734
  /// total uplink buffer size 
735
  uint32_t ul_total_buffer;
736
  /// uplink buffer creation time for each LCID
737
  uint32_t ul_buffer_creation_time[MAX_NUM_LCGID];
738
  /// maximum uplink buffer creation time across all the LCIDs
739
  uint32_t ul_buffer_creation_time_max;
740
  /// uplink buffer size per LCID
741
742
  uint32_t ul_buffer_info[MAX_NUM_LCGID];

743
744
745
  /// UE tx power
  int32_t ue_tx_power;

kaltenbe's avatar
kaltenbe committed
746
  /// stores the frame where the last TPC was transmitted
knopp's avatar
knopp committed
747
748
749
750
  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
751

752
753
754
#ifdef LOCALIZATION
  eNB_UE_estimated_distances distance;
#endif
755
756
} UE_TEMPLATE;

757
/*! \brief scheduling control information set through an API (not used)*/
758
typedef struct {
759
  ///UL transmission bandwidth in RBs
760
  uint8_t ul_bandwidth[MAX_NUM_LCID];
761
  ///DL transmission bandwidth in RBs
762
  uint8_t dl_bandwidth[MAX_NUM_LCID];
763

764
765
  //To do GBR bearer
  uint8_t min_ul_bandwidth[MAX_NUM_LCID];
766

767
  uint8_t min_dl_bandwidth[MAX_NUM_LCID];
768

769
  ///aggregated bit rate of non-gbr bearer per UE
770
  uint64_t  ue_AggregatedMaximumBitrateDL;
771
  ///aggregated bit rate of non-gbr bearer per UE
772
  uint64_t  ue_AggregatedMaximumBitrateUL;
773
  ///CQI scheduling interval in subframes.
774
  uint16_t cqiSchedInterval;
775
  ///Contention resolution timer used during random access
776
  uint8_t mac_ContentionResolutionTimer;
777

778
  uint16_t max_allowed_rbs[MAX_NUM_LCID];
779

780
  uint8_t max_mcs[MAX_NUM_LCID];
781

782
  uint16_t priority[MAX_NUM_LCID];
783

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


852
/*! \brief subband bitmap confguration (for ALU icic algo purpose), in test phase */
853
854
855
856
857
858
859
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;
860
/*! \brief UE list used by eNB to order UEs/CC for scheduling*/ 
861
typedef struct {
862
  /// Dedicated information for UEs
863
  struct PhysicalConfigDedicated  *physicalConfigDedicated[MAX_NUM_CCs][NUMBER_OF_UE_MAX];
864
  /// DLSCH pdu 
knopp's avatar
   
knopp committed
865
866
867
868
869
  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];
870
  /// sorted downlink component carrier for the scheduler 
knopp's avatar
   
knopp committed
871
  int ordered_CCids[MAX_NUM_CCs][NUMBER_OF_UE_MAX];
872
  /// number of downlink active component carrier 
knopp's avatar
   
knopp committed
873
  int numactiveCCs[NUMBER_OF_UE_MAX];
874
  /// sorted uplink component carrier for the scheduler 
knopp's avatar
   
knopp committed
875
  int ordered_ULCCids[MAX_NUM_CCs][NUMBER_OF_UE_MAX];
876
  /// number of uplink active component carrier 
knopp's avatar
   
knopp committed
877
  int numactiveULCCs[NUMBER_OF_UE_MAX];
878
  /// number of downlink active component carrier 
879
  uint8_t dl_CC_bitmap[NUMBER_OF_UE_MAX];
880
  /// eNB to UE statistics
knopp's avatar
   
knopp committed
881
  eNB_UE_STATS eNB_UE_stats[MAX_NUM_CCs][NUMBER_OF_UE_MAX];
882
  /// scheduling control info
knopp's avatar
   
knopp committed
883
884
  UE_sched_ctrl UE_sched_ctrl[NUMBER_OF_UE_MAX];
  int next[NUMBER_OF_UE_MAX];
885
  int head;
886
887
  int next_ul[NUMBER_OF_UE_MAX];
  int head_ul;
knopp's avatar
   
knopp committed
888
889
890
891
  int avail;
  int num_UEs;
  boolean_t active[NUMBER_OF_UE_MAX];
} UE_list_t;
892

893
/*! \brief eNB common channels */ 
894
typedef struct {
895
896
897
898
899
900
  int                              physCellId;
  int                              p_eNB;
  int                              Ncp;
  int                              eutra_band;
  uint32_t                         dl_CarrierFreq;
  BCCH_BCH_Message_t               *mib;
901
902
  RadioResourceConfigCommonSIB_t   *radioResourceConfigCommon;
#ifdef Rel14
903
  RadioResourceConfigCommonSIB_t   *radioResourceConfigCommon_BR;  
904
#endif
905
  TDD_Config_t                     *tdd_Config;
906
  SchedulingInfoList_t             *schedulingInfoList;
907
908
  ARFCN_ValueEUTRA_t               ul_CarrierFreq;
  long                             ul_Bandwidth;
909
910
  /// Outgoing MIB PDU for PHY
  MIB_PDU MIB_pdu;
911
912
  /// Outgoing BCCH pdu for PHY
  BCCH_PDU BCCH_pdu;
913
914
  /// Outgoing BCCH DCI allocation
  uint32_t BCCH_alloc_pdu;
915
916
  /// Outgoing CCCH pdu for PHY
  CCCH_PDU CCCH_pdu;
917
918
919
  /// Outgoing RAR pdu for PHY
  RAR_PDU RAR_pdu;
  /// Template for RA computations
920
  RA_TEMPLATE RA_template[NB_RA_PROC_MAX];
921
922
  /// VRB map for common channels
  uint8_t vrb_map[100];
923
924
  /// MBSFN SubframeConfig
  struct MBSFN_SubframeConfig *mbsfn_SubframeConfig[8];
925
  /// number of subframe allocation pattern available for MBSFN sync area
gauthier's avatar
gauthier committed
926
  uint8_t num_sf_allocation_pattern;
Cedric Roux's avatar
Cedric Roux committed
927
#if defined(Rel10) || defined(Rel14)
928
  /// MBMS Flag
gauthier's avatar
gauthier committed
929
  uint8_t MBMS_flag;
930
931
932
  /// Outgoing MCCH pdu for PHY
  MCCH_PDU MCCH_pdu;
  /// MCCH active flag
gauthier's avatar
gauthier committed
933
  uint8_t msi_active;
934
  /// MCCH active flag
gauthier's avatar