defs.h 47.3 KB
Newer Older
1
2
3
4
5
/*
 * 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
Cedric Roux's avatar
Cedric Roux committed
6
 * the OAI Public License, Version 1.1  (the "License"); you may not use this file
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
 * 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
#ifdef Rel14
#include "SystemInformationBlockType1-v1310-IEs.h"
72
#include "SystemInformationBlockType18-r12.h"
73
#endif
74
#include "RadioResourceConfigCommonSIB.h"
75
76
#include "nfapi_interface.h"
#include "PHY_INTERFACE/IF_Module.h"
77

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

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

88
#define SCH_PAYLOAD_SIZE_MAX 4096
Tien-Thinh Nguyen's avatar
Tien-Thinh Nguyen committed
89
#define DCH_PAYLOAD_SIZE_MAX 4096
90
91
/// 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
92
#if defined(Rel10) || defined(Rel14)
93

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

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

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

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

152
153
154
#define LCID_EMPTY 0
#define LCID_NOT_EMPTY 1

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

161
162
163
/*!\brief maximum number of slices / groups */
#define MAX_NUM_SLICES 4 

164
165
166
/* 
 * eNB part 
 */ 
167

168
169
170
171
172

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

179
/*!\brief  MAC header of Random Access Response for backoff indicator (BI)*/
180
typedef struct {
gauthier's avatar
gauthier committed
181
182
183
184
  uint8_t BI:4;
  uint8_t R:2;
  uint8_t T:1;
  uint8_t E:1;
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
213
214
} __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
*/
215
/*!\brief  MAC subheader short with 7bit Length field */
216
typedef struct {
gauthier's avatar
gauthier committed
217
218
219
220
221
  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
222
} __attribute__((__packed__))SCH_SUBHEADER_SHORT;
223
/*!\brief  MAC subheader long  with 15bit Length field */
224
typedef struct {
gauthier's avatar
gauthier committed
225
226
227
228
229
230
231
  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;
232
} __attribute__((__packed__))SCH_SUBHEADER_LONG;
233
/*!\brief MAC subheader short without length field */
234
typedef struct {
gauthier's avatar
gauthier committed
235
236
237
  uint8_t LCID:5;
  uint8_t E:1;
  uint8_t R:2;
238
239
} __attribute__((__packed__))SCH_SUBHEADER_FIXED;

240

knopp's avatar
knopp committed
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258

/*!\brief  MAC subheader long  with 24bit DST field */
typedef struct {
  uint8_t   R0:4; 
  uint8_t   V:4;//Version number: Possible values "0001", "0010", "0011" based on TS36.321 section 6.2.3.
  uint8_t  SRC07; //Prose UE source ID. Size 24 bits.
  uint8_t  SRC815; //Prose UE source ID. Size 24 bits.
  uint8_t  SRC1623; //Prose UE source ID. Size 24 bits.
  uint8_t  DST07; //Prose UE destination ID. Size 24 bits.
  uint8_t  DST815; //Prose UE destination ID. Size 24 bits.
  uint8_t  DST1623; //Prose UE destination ID. Size 24 bits.
  uint8_t  LCID:5;
  uint8_t  E:1;
  uint8_t  R1:2;
  uint8_t  L:7;	// Length field indicating the size of the corresponding SDU in bytes. 
  uint8_t  F:1;
}__attribute__((__packed__))SLSCH_SUBHEADER_24_Bit_DST_SHORT;

259
260
/*!\brief  MAC subheader long  with 24bit DST field */
typedef struct {
knopp's avatar
knopp committed
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
  uint8_t   R0:4; 
  uint8_t   V:4;//Version number: Possible values "0001", "0010", "0011" based on TS36.321 section 6.2.3.
  uint8_t  SRC07; //Prose UE source ID. Size 24 bits.
  uint8_t  SRC815; //Prose UE source ID. Size 24 bits.
  uint8_t  SRC1623; //Prose UE source ID. Size 24 bits.
  uint8_t  DST07; //Prose UE destination ID. Size 24 bits.
  uint8_t  DST815; //Prose UE destination ID. Size 24 bits.
  uint8_t  DST1623; //Prose UE destination ID. Size 24 bits.
  uint8_t  LCID:5;
  uint8_t  E:1;
  uint8_t  R1:2;
  uint8_t  L_MSB:7;	// Length field indicating the size of the corresponding SDU in bytes. 
  uint8_t  F:1;
  uint8_t  L_LSB:8;
}__attribute__((__packed__))SLSCH_SUBHEADER_24_Bit_DST_LONG;

/*!\brief  MAC subheader long  with 24bit DST field */
278
typedef struct {
knopp's avatar
knopp committed
279
280
281
282
283
284
285
286
287
288
289
290
  uint8_t   R0:4; 
  uint8_t   V:4;//Version number: Possible values "0001", "0010", "0011" based on TS36.321 section 6.2.3.
  uint8_t  SRC07; //Prose UE source ID. Size 24 bits.
  uint8_t  SRC815; //Prose UE source ID. Size 24 bits.
  uint8_t  DST07; //Prose UE destination ID. Size 16 bits.
  uint8_t  DST815; //Prose UE destination ID. Size 16 bits.
  uint8_t  LCID:5;
  uint8_t  E:1;
  uint8_t  R1:2;
  uint8_t  L:7;	// Length field indicating the size of the corresponding SDU in bytes. 
  uint8_t  F:1;
}__attribute__((__packed__))SLSCH_SUBHEADER_16_Bit_DST_SHORT;
291

knopp's avatar
knopp committed
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
/*!\brief  MAC subheader long  with 24bit DST field */
typedef struct {
  uint8_t   R0:4; 
  uint8_t   V:4;//Version number: Possible values "0001", "0010", "0011" based on TS36.321 section 6.2.3.
  uint8_t  SRC07; //Prose UE source ID. Size 24 bits.
  uint8_t  SRC815; //Prose UE source ID. Size 24 bits.
  uint8_t  SRC1623; //Prose UE source ID. Size 24 bits.
  uint8_t  DST07; //Prose UE destination ID. Size 16 bits.
  uint8_t  DST815; //Prose UE destination ID. Size 16 bits.
  uint8_t  LCID:5;
  uint8_t  E:1;
  uint8_t  R1:2;
  uint8_t  L_MSB:7;	// Length field indicating the size of the corresponding SDU in bytes. 
  uint8_t  F:1;
  uint8_t  L_LSB:8;
}__attribute__((__packed__))SLSCH_SUBHEADER_16_Bit_DST_LONG;
308

309
/*!\brief  mac control element: short buffer status report for a specific logical channel group ID*/
310
typedef struct {
gauthier's avatar
gauthier committed
311
312
  uint8_t Buffer_size:6;  // octet 1 LSB
  uint8_t LCGID:2;        // octet 1 MSB
313
314
315
} __attribute__((__packed__))BSR_SHORT;

typedef BSR_SHORT BSR_TRUNCATED;
316
/*!\brief  mac control element: long buffer status report for all logical channel group ID*/
317
typedef struct {
fnabet's avatar
fnabet committed
318
319
320
321
  uint8_t Buffer_size3:6;
  uint8_t Buffer_size2:6;
  uint8_t Buffer_size1:6;
  uint8_t Buffer_size0:6;
322
323
} __attribute__((__packed__))BSR_LONG;

324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
// Panos:
/*!\brief  mac control element: sidelink buffer status report */
typedef struct {
	uint8_t DST_1:4;
	uint8_t LCGID_1: 2;
	uint8_t Buffer_size_1:6;
	uint8_t DST_2:4;
	uint8_t LCGID_2: 2;
	uint8_t Buffer_size_2:6;
}__attribute__((__packed__))SL_BSR;

/*!\brief  mac control element: truncated sidelink buffer status report */
typedef struct {
	uint8_t DST:4;
	uint8_t LCGID: 2;
	uint8_t Buffer_size:6;
	uint8_t R1:1;
	uint8_t R2:1;
	uint8_t R3:1;
	uint8_t R4:1;
}__attribute__((__packed__))SL_BSR_Truncated;



348
#define BSR_LONG_SIZE  (sizeof(BSR_LONG))
349
/*!\brief  mac control element: timing advance  */
350
typedef struct {
gauthier's avatar
gauthier committed
351
352
  uint8_t TA:6;
  uint8_t R:2;
353
} __attribute__((__packed__))TIMING_ADVANCE_CMD;
354
/*!\brief  mac control element: power headroom report  */
355
typedef struct {
gauthier's avatar
gauthier committed
356
357
  uint8_t PH:6;
  uint8_t R:2;
358
359
} __attribute__((__packed__))POWER_HEADROOM_CMD;

360
/*! \brief MIB payload */
361
typedef struct {
362
363
  uint8_t payload[3] ;
} __attribute__((__packed__))MIB_PDU;
364
/*! \brief CCCH payload */
365
typedef struct {
366
  uint8_t payload[CCCH_PAYLOAD_SIZE_MAX] ;
367
} __attribute__((__packed__))CCCH_PDU;
368
/*! \brief BCCH payload */
369
typedef struct {
370
  uint8_t payload[BCCH_PAYLOAD_SIZE_MAX] ;
371
} __attribute__((__packed__))BCCH_PDU;
372
373
374
375
/*! \brief RAR payload */
typedef struct {
  uint8_t payload[RAR_PAYLOAD_SIZE_MAX];
} __attribute__ ((__packed__)) RAR_PDU;
376
377
378
379
/*! \brief BCCH payload */
typedef struct {
  uint8_t payload[PCCH_PAYLOAD_SIZE_MAX] ;
} __attribute__((__packed__))PCCH_PDU;
380

Cedric Roux's avatar
Cedric Roux committed
381
#if defined(Rel10) || defined(Rel14)
382
/*! \brief MCCH payload */
383
typedef struct {
384
  uint8_t payload[MCCH_PAYLOAD_SIZE_MAX] ;
385
} __attribute__((__packed__))MCCH_PDU;
386
/*!< \brief MAC control element for activation and deactivation of component carriers */
387
388
389
390
391
392
393
394
395
396
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;
397
/*! \brief MAC control element: MCH Scheduling Information */
398
typedef struct {
gauthier's avatar
gauthier committed
399
400
401
  uint8_t stop_sf_MSB:3; // octet 1 LSB
  uint8_t lcid:5;        // octet 2 MSB
  uint8_t stop_sf_LSB:8;
402
} __attribute__((__packed__))MSI_ELEMENT;
403
404
#endif
/*! \brief Values of CCCH LCID for DLSCH */ 
405
#define CCCH_LCHANID 0
406
/*!\brief Values of BCCH logical channel (fake)*/
407
#define BCCH 3  // SI 
408
/*!\brief Values of PCCH logical channel (fake)*/
409
#define PCCH 4  // Paging 
410
411
/*!\brief Values of PCCH logical channel (fake) */
#define MIBCH 5  // MIB 
412
413
414
415
/*!\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 
416
417
418
419
420
421
422
423
424
425
426
427
428
429
/*!\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*/
430
#define UE_CONT_RES 28
431
/*!\brief LCID of timing advance for DLSCH */
432
#define TIMING_ADV_CMD 29
433
/*!\brief LCID of discontinous reception mode for DLSCH */
434
#define DRX_CMD 30
435
/*!\brief LCID of padding LCID for DLSCH */
436
437
#define SHORT_PADDING 31

Cedric Roux's avatar
Cedric Roux committed
438
#if defined(Rel10) || defined(Rel14)
439
// MCH LCHAN IDs (table6.2.1-4 TS36.321)
440
/*!\brief LCID of MCCH for DL */
441
#define MCCH_LCHANID 0
442
443
444
/*!\brief LCID of MCH scheduling info for DL */
#define MCH_SCHDL_INFO 3
/*!\brief LCID of Carrier component activation/deactivation */
445
#define CC_ACT_DEACT 27
Tien-Thinh Nguyen's avatar
Tien-Thinh Nguyen committed
446
447
//TTN (for D2D)
#define SL_DISCOVERY 8 //LCID (fake)
448
449
450
#endif

// ULSCH LCHAN IDs
451
/*!\brief LCID of extended power headroom for ULSCH */
452
#define EXTENDED_POWER_HEADROOM 25
453
/*!\brief LCID of power headroom for ULSCH */
454
#define POWER_HEADROOM 26
455
/*!\brief LCID of CRNTI for ULSCH */
456
#define CRNTI 27
457
/*!\brief LCID of truncated BSR for ULSCH */
458
#define TRUNCATED_BSR 28
459
/*!\brief LCID of short BSR for ULSCH */
460
#define SHORT_BSR 29
461
/*!\brief LCID of long BSR for ULSCH */
462
#define LONG_BSR 30
fnabet's avatar
fnabet committed
463
464
465
466
467
/*!\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 */
468
469


470
/*! \brief Downlink SCH PDU Structure */
471
typedef struct {
472
  uint8_t payload[8][SCH_PAYLOAD_SIZE_MAX];
gauthier's avatar
gauthier committed
473
  uint16_t Pdu_size[8];
474
475
} __attribute__ ((__packed__)) DLSCH_PDU;

476

477
/*! \brief MCH PDU Structure */
478
typedef struct {
gauthier's avatar
gauthier committed
479
480
  int8_t payload[SCH_PAYLOAD_SIZE_MAX];
  uint16_t Pdu_size;
481
  uint8_t mcs;
482
483
484
  uint8_t sync_area;
  uint8_t msi_active;
  uint8_t mcch_active;
485
  uint8_t mtch_active;
486
487
} __attribute__ ((__packed__)) MCH_PDU;

488
/*! \brief Uplink SCH PDU Structure */
489
typedef struct {
gauthier's avatar
gauthier committed
490
491
  int8_t payload[SCH_PAYLOAD_SIZE_MAX];         /*!< \brief SACH payload */
  uint16_t Pdu_size;
492
493
} __attribute__ ((__packed__)) ULSCH_PDU;

Tien-Thinh Nguyen's avatar
Tien-Thinh Nguyen committed
494
495
496
497
498
499
500

/*! \brief Uplink SCH PDU Structure */
typedef struct {
  int8_t payload[DCH_PAYLOAD_SIZE_MAX];         /*!< \brief SACH payload */
  uint16_t Pdu_size;
} __attribute__ ((__packed__)) ULDCH_PDU;

501
502
#include "PHY/impl_defs_top.h"

503
/*!\brief  UE ULSCH scheduling states*/
504
505
506
typedef enum {
  S_UL_NONE =0,
  S_UL_WAITING,
507
508
  S_UL_SCHEDULED,
  S_UL_BUFFERED,
509
510
511
  S_UL_NUM_STATUS
} UE_ULSCH_STATUS;

512
/*!\brief  UE DLSCH scheduling states*/
513
514
515
typedef enum {
  S_DL_NONE =0,
  S_DL_WAITING,
516
517
  S_DL_SCHEDULED,
  S_DL_BUFFERED,
518
519
520
  S_DL_NUM_STATUS
} UE_DLSCH_STATUS;

521
/*!\brief  scheduling policy for the contention-based access */
522
typedef enum {
523
524
525
526
527
  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
528
529
530
} CBA_POLICY;


531
/*! \brief temporary struct for ULSCH sched */
532
typedef struct {
gauthier's avatar
gauthier committed
533
  rnti_t rnti;
gauthier's avatar
gauthier committed
534
535
  uint16_t subframe;
  uint16_t serving_num;
536
537
  UE_ULSCH_STATUS status;
} eNB_ULSCH_INFO;
538
/*! \brief temp struct for DLSCH sched */
539
typedef struct {
gauthier's avatar
gauthier committed
540
  rnti_t rnti;
gauthier's avatar
gauthier committed
541
542
543
  uint16_t weight;
  uint16_t subframe;
  uint16_t serving_num;
544
545
  UE_DLSCH_STATUS status;
} eNB_DLSCH_INFO;
546
/*! \brief eNB overall statistics */
547
typedef struct {
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
  /// 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
567
568
569
570
571
  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;
572
573
  /// aggregation
  /// total avilable nccc : num control channel element
574
  uint16_t available_ncces;
575
576
  // only for a new transmission, should be extended for retransmission
  // current dlsch  bit rate for all transport channels
577
578
579
580
581
  uint32_t dlsch_bitrate;
  //
  uint32_t dlsch_bytes_tx;
  //
  uint32_t dlsch_pdus_tx;
582
  //
583
584
585
586
587
  uint32_t total_dlsch_bitrate;
  //
  uint32_t total_dlsch_bytes_tx;
  //
  uint32_t total_dlsch_pdus_tx;
588
589
  
  // here for RX
590
591
592
593
594
  //
  uint32_t ulsch_bitrate;
  //
  uint32_t ulsch_bytes_rx;
  //
595
596
597
598
599
600
601
602
  uint64_t ulsch_pdus_rx; 

  uint32_t total_ulsch_bitrate;
  //
  uint32_t total_ulsch_bytes_rx;
  //
  uint32_t total_ulsch_pdus_rx;
  
603
604
605
606
607
608
609
  
  /// MAC agent-related stats
  /// total number of scheduling decisions
  int sched_decisions;
  /// missed deadlines
  int missed_deadlines;

610
} eNB_STATS;
611
/*! \brief eNB statistics for the connected UEs*/
612
typedef struct {
613
614

  /// CRNTI of UE
gauthier's avatar
gauthier committed
615
  rnti_t crnti; ///user id (rnti) of connected UEs
616
  // rrc status
617
618
619
  uint8_t rrc_status;
  /// harq pid
  uint8_t harq_pid;
620
  /// harq rounf
621
622
623
624
625
  uint8_t harq_round;
  /// 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;
626
  /// total nccc used for a new transmission: num control channel element
627
  uint16_t ncce_used;
628
  /// total avilable nccc for a retransmission: num control channel element
629
  uint16_t ncce_used_retx;
630
631

  // mcs1 before the rate adaptaion
632
  uint8_t dlsch_mcs1;
633
  /// Target mcs2 after rate-adaptation
634
  uint8_t dlsch_mcs2;
635
  //  current TBS with mcs2
636
  uint32_t TBS;
637
  //  total TBS with mcs2
638
  //  uint32_t total_TBS;
639
  //  total rb used for a new transmission
640
  uint32_t total_rbs_used;
641
  //  total rb used for retransmission
642
  uint32_t total_rbs_used_retx;
643

644
   /// TX
645
646
647
648
649
650
651
652
  /// 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];
653
654

  /// overall
655
  //
656
657
658
659
  uint32_t  dlsch_bitrate;
  //total
  uint32_t  total_dlsch_bitrate;
  /// headers+ CE +  padding bytes for a MAC PDU
660
  uint64_t overhead_bytes;
661
  /// headers+ CE +  padding bytes for a MAC PDU
662
  uint64_t total_overhead_bytes;
663
  /// headers+ CE +  padding bytes for a MAC PDU
664
  uint64_t avg_overhead_bytes;
665
  // MAC multiplexed payload
666
667
668
  uint64_t total_sdu_bytes;
  // total MAC pdu bytes
  uint64_t total_pdu_bytes;
669

670
671
672
673
  // total num pdu
  uint32_t total_num_pdus;
  //
  //  uint32_t avg_pdu_size;
674
675

  /// RX
676

677
678
679
680
681
682
  /// 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;
683
684
685
686
687
  /// preassigned mcs after rate adaptation
  uint8_t ulsch_mcs1;
  /// adjusted mcs
  uint8_t ulsch_mcs2;

688
689
690
691
  /// estimated average pdu inter-departure time
  uint32_t avg_pdu_idt;
  /// estimated average pdu size
  uint32_t avg_pdu_ps;
692
  ///
693
694
  uint32_t aggregated_pdu_size;
  uint32_t aggregated_pdu_arrival;
695

696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
  ///  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;

712
  /// num rx pdu
713
  uint32_t num_pdu_rx[NB_RB_MAX];
714
  /// num bytes rx
715
  uint32_t num_bytes_rx[NB_RB_MAX];
716
  /// instantaneous rx throughput for each TTI
717
  //  uint32_t tti_goodput[NB_RB_MAX];
718
719
  /// errors
  uint32_t num_errors_rx;
720
721
722
723
724
725
726
727
728
729
  
  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;
730
  /// overall
731
732
  ///  MAC pdu bytes
  uint64_t pdu_bytes_rx;
733
  /// total MAC pdu bytes
734
  uint64_t total_pdu_bytes_rx;
735
  /// total num pdu
736
  uint32_t total_num_pdus_rx;
737
  /// num of error pdus
738
  uint32_t total_num_errors_rx;
739

740
} eNB_UE_STATS;
741
/*! \brief eNB template for UE context information  */
742
typedef struct {
743
  /// C-RNTI of UE
gauthier's avatar
gauthier committed
744
  rnti_t rnti;
745
746
  /// NDI from last scheduling
  uint8_t oldNDI[8];
747
748
749
750
  /// mcs1 from last scheduling
  uint8_t oldmcs1[8];
  /// mcs2 from last scheduling
  uint8_t oldmcs2[8];
751
752
  /// NDI from last UL scheduling
  uint8_t oldNDI_UL[8];
753
754
755
756
  /// mcs from last UL scheduling
  uint8_t mcs_UL[8];
  /// TBS from last UL scheduling
  uint8_t TBS_UL[8];
757
  /// Flag to indicate UL has been scheduled at least once
gauthier's avatar
gauthier committed
758
  boolean_t ul_active;
knopp's avatar
   
knopp committed
759
760
  /// Flag to indicate UE has been configured (ACK from RRCConnectionSetup received)
  boolean_t configured;
761

762
763
764
765
766
767
  /// MCS from last scheduling
  uint8_t mcs[8];

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

768
769
770
  // PHY interface info

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

773
  /// Number of Allocated RBs for UL after scheduling
774
  uint16_t nb_rb_ul[8]; // num_max_harq
775

776
777
778
779
780
781
  /// 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

782
783
  /// Number of Allocated RBs by the ulsch preprocessor
  uint8_t pre_allocated_nb_rb_ul;
784

785
786
  /// index of Allocated RBs by the ulsch preprocessor
  int8_t pre_allocated_rb_table_index_ul;
787

788
789
  /// total allocated RBs
  int8_t total_allocated_rbs;
790

791
  /// pre-assigned MCS by the ulsch preprocessor
792
  uint8_t pre_assigned_mcs_ul;
793
794
795
796

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

797
  /// DL DAI
gauthier's avatar
gauthier committed
798
  uint8_t DAI;
799
800

  /// UL DAI
gauthier's avatar
gauthier committed
801
  uint8_t DAI_ul[10];
802
803

  /// UL Scheduling Request Received
gauthier's avatar
gauthier committed
804
  uint8_t ul_SR;
805

806
  ///Resource Block indication for each sub-band in MU-MIMO
gauthier's avatar
gauthier committed
807
  uint8_t rballoc_subband[8][50];
808
809
810

  // Logical channel info for link with RLC

811
  /// Last received UE BSR info for each logical channel group id
gauthier's avatar
gauthier committed
812
  uint8_t bsr_info[MAX_NUM_LCGID];
813

814
815
816
  /// LCGID mapping
  long lcgidmap[11];

817
  /// phr information
818
  int8_t phr_info;
819

820
821
822
  /// phr information
  int8_t phr_info_configured;

823
  ///dl buffer info
gauthier's avatar
gauthier committed
824
  uint32_t dl_buffer_info[MAX_NUM_LCID];
825
  /// total downlink buffer info
gauthier's avatar
gauthier committed
826
  uint32_t dl_buffer_total;
827
  /// total downlink pdus
gauthier's avatar
gauthier committed
828
  uint32_t dl_pdus_total;
829
  /// downlink pdus for each LCID
gauthier's avatar
gauthier committed
830
  uint32_t dl_pdus_in_buffer[MAX_NUM_LCID];
831
  /// creation time of the downlink buffer head for each LCID
gauthier's avatar
gauthier committed
832
  uint32_t dl_buffer_head_sdu_creation_time[MAX_NUM_LCID];
833
  /// maximum creation time of the downlink buffer head across all LCID
834
  uint32_t  dl_buffer_head_sdu_creation_time_max;
835
  /// a flag indicating that the downlink head SDU is segmented  
gauthier's avatar
gauthier committed
836
  uint8_t    dl_buffer_head_sdu_is_segmented[MAX_NUM_LCID];
837
  /// size of remaining size to send for the downlink head SDU
gauthier's avatar
gauthier committed
838
  uint32_t dl_buffer_head_sdu_remaining_size_to_send[MAX_NUM_LCID];
839

840
  /// total uplink buffer size 
841
  uint32_t ul_total_buffer;
842
  /// uplink buffer creation time for each LCID
843
  uint32_t ul_buffer_creation_time[MAX_NUM_LCGID];
844
  /// maximum uplink buffer creation time across all the LCIDs
845
  uint32_t ul_buffer_creation_time_max;
846
  /// uplink buffer size per LCID
847
848
  uint32_t ul_buffer_info[MAX_NUM_LCGID];

849
850
851
  /// UE tx power
  int32_t ue_tx_power;

kaltenbe's avatar
kaltenbe committed
852
  /// stores the frame where the last TPC was transmitted
knopp's avatar
knopp committed
853
854
855
856
  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
857

858
859
860
#ifdef LOCALIZATION
  eNB_UE_estimated_distances distance;
#endif
861
862
863

#ifdef Rel14
  uint8_t rach_resource_type;
864
  uint16_t mpdcch_repetition_cnt;
865
866
  frame_t Msg2_frame;
#endif
867
868
869
  sub_frame_t Msg2_subframe;

  PhysicalConfigDedicated_t  *physicalConfigDedicated;
870

871
872
} UE_TEMPLATE;

873
/*! \brief scheduling control information set through an API (not used)*/
874
typedef struct {
875
  ///UL transmission bandwidth in RBs
876
  uint8_t ul_bandwidth[MAX_NUM_LCID];
877
  ///DL transmission bandwidth in RBs
878
  uint8_t dl_bandwidth[MAX_NUM_LCID];
879

880
881
  //To do GBR bearer
  uint8_t min_ul_bandwidth[MAX_NUM_LCID];
882

883
  uint8_t min_dl_bandwidth[MAX_NUM_LCID];
884

885
  ///aggregated bit rate of non-gbr bearer per UE
886
  uint64_t  ue_AggregatedMaximumBitrateDL;
887
  ///aggregated bit rate of non-gbr bearer per UE
888
  uint64_t  ue_AggregatedMaximumBitrateUL;
889
  ///CQI scheduling interval in subframes.
890
  uint16_t cqiSchedInterval;
891
  ///Contention resolution timer used during random access
892
  uint8_t mac_ContentionResolutionTimer;
893

894
  uint16_t max_allowed_rbs[MAX_NUM_LCID];
895

896
  uint8_t max_mcs[MAX_NUM_LCID];
897

898
  uint16_t priority[MAX_NUM_LCID];
899

900
  // resource scheduling information
901
902
903
904
905
906
907
  
  /// Current DL harq round per harq_pid on each CC
  uint8_t       round[MAX_NUM_CCs][10];
  /// Current Active TBs per harq_pid on each CC
  uint8_t       tbcnt[MAX_NUM_CCs][10];
  /// Current UL harq round per harq_pid on each CC
  uint8_t       round_UL[MAX_NUM_CCs][8];
908
909
910
  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];
911
  uint16_t      ta_timer;
912
  int16_t       ta_update;
913
  uint16_t      ul_consecutive_errors;
914
  int32_t       context_active_timer;
915
  int32_t       cqi_req_timer;
916
  int32_t       ul_inactivity_timer;
917
  int32_t       ul_failure_timer; 
918
  int32_t       ul_scheduled;
919
  int32_t       ra_pdcch_order_sent;
Florian Kaltenberger's avatar
Florian Kaltenberger committed
920
  int32_t       ul_out_of_sync;
921
  int32_t       phr_received;
922
923
  uint8_t       periodic_ri_received[NFAPI_CC_MAX];
  uint8_t       aperiodic_ri_received[NFAPI_CC_MAX];
924
  uint8_t       pucch1_cqi_update[NFAPI_CC_MAX];
925
  uint8_t       pucch1_snr[NFAPI_CC_MAX];
926
  uint8_t       pucch2_cqi_update[NFAPI_CC_MAX];
927
  uint8_t       pucch2_snr[NFAPI_CC_MAX];
928
  uint8_t       pucch3_cqi_update[NFAPI_CC_MAX];
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
  uint8_t       pucch3_snr[NFAPI_CC_MAX];
  uint8_t       pusch_snr[NFAPI_CC_MAX];
  uint16_t      feedback_cnt[NFAPI_CC_MAX];
  uint16_t      timing_advance;
  uint16_t      timing_advance_r9;
  uint8_t       periodic_wideband_cqi[NFAPI_CC_MAX];
  uint8_t       periodic_wideband_spatial_diffcqi[NFAPI_CC_MAX];
  uint8_t       periodic_wideband_pmi[NFAPI_CC_MAX];
  uint8_t       periodic_subband_cqi[NFAPI_CC_MAX][16];
  uint8_t       periodic_subband_spatial_diffcqi[NFAPI_CC_MAX][16];
  uint8_t       aperiodic_subband_cqi0[NFAPI_CC_MAX][25];
  uint8_t       aperiodic_subband_pmi[NFAPI_CC_MAX][25];
  uint8_t       aperiodic_subband_diffcqi0[NFAPI_CC_MAX][25];
  uint8_t       aperiodic_subband_cqi1[NFAPI_CC_MAX][25];
  uint8_t       aperiodic_subband_diffcqi1[NFAPI_CC_MAX][25];
  uint8_t       aperiodic_wideband_cqi0[NFAPI_CC_MAX];
  uint8_t       aperiodic_wideband_pmi[NFAPI_CC_MAX];
  uint8_t       aperiodic_wideband_cqi1[NFAPI_CC_MAX];
  uint8_t       aperiodic_wideband_pmi1[NFAPI_CC_MAX];
Cedric Roux's avatar
Cedric Roux committed
948
  uint8_t       dl_cqi[NFAPI_CC_MAX];
949
} UE_sched_ctrl;
950
/*! \brief eNB template for the Random access information */
951
952
typedef struct {
  /// Flag to indicate this process is active
gauthier's avatar
gauthier committed
953
  boolean_t RA_active;
954
  /// Size of DCI for RA-Response (bytes)
gauthier's avatar
gauthier committed
955
  uint8_t RA_dci_size_bytes1;
956
  /// Size of DCI for RA-Response (bits)
gauthier's avatar
gauthier committed
957
  uint8_t RA_dci_size_bits1;
958
  /// Actual DCI to transmit for RA-Response
gauthier's avatar
gauthier committed
959
  uint8_t RA_alloc_pdu1[(MAX_DCI_SIZE_BITS>>3)+1];
960
  /// DCI format for RA-Response (should be 1A)
gauthier's avatar
gauthier committed
961
  uint8_t RA_dci_fmt1;
962
  /// Size of DCI for Msg4/ContRes (bytes)
gauthier's avatar
gauthier committed
963
  uint8_t RA_dci_size_bytes2;
964
  /// Size of DCI for Msg4/ContRes (bits)
gauthier's avatar
gauthier committed
965
  uint8_t RA_dci_size_bits2;
966
  /// Actual DCI to transmit for Msg4/ContRes
gauthier's avatar
gauthier committed
967
  uint8_t RA_alloc_pdu2[(MAX_DCI_SIZE_BITS>>3)+1];
968
  /// DCI format for Msg4/ContRes (should be 1A)
gauthier's avatar
gauthier committed
969
  uint8_t RA_dci_fmt2;
970
  /// Flag to indicate the eNB should generate RAR.  This is triggered by detection of PRACH
gauthier's avatar
gauthier committed
971
  uint8_t generate_rar;
972
  /// Subframe where preamble was received
gauthier's avatar
gauthier committed
973
  uint8_t preamble_subframe;
974
975
976
  /// Subframe where Msg2 is to be sent
  uint8_t Msg2_subframe;
  /// Frame where Msg2 is to be sent
977
  frame_t Msg2_frame;
978
  /// Subframe where Msg3 is to be sent
979
  sub_frame_t Msg3_subframe;
980
  /// Frame where Msg3 is to be sent
981
  frame_t Msg3_frame;
982
  /// Subframe where Msg4 is to be sent
983
  sub_frame_t Msg4_subframe;
984
  /// Frame where Msg4 is to be sent
985
  frame_t Msg4_frame;
986
  /// 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.
987
  uint8_t generate_Msg4;
988
  /// Flag to indicate that eNB is waiting for ACK that UE has received Msg3.
gauthier's avatar
gauthier committed
989
  uint8_t wait_ack_Msg4;
990
991
  /// harq_pid used for Msg4 transmission
  uint8_t harq_pid;
992
  /// UE RNTI allocated during RAR
gauthier's avatar
gauthier committed
993
  rnti_t rnti;
994
  /// RA RNTI allocated from received PRACH