defs.h 48.2 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
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
#ifndef __LAYER2_MAC_DEFS_H__
#define __LAYER2_MAC_DEFS_H__



#include <stdio.h>
#include <stdlib.h>
#include <string.h>
45 46 47

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

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

77
#define BCCH_PAYLOAD_SIZE_MAX 128
78
#define CCCH_PAYLOAD_SIZE_MAX 128
79
#define PCCH_PAYLOAD_SIZE_MAX 128
80
#define RAR_PAYLOAD_SIZE_MAX 128
81

82
#define SCH_PAYLOAD_SIZE_MAX 4096
83
#define DCH_PAYLOAD_SIZE_MAX 4096
84 85
/// 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
86
#if defined(Rel10) || defined(Rel14)
87

88
// Mask for identifying subframe for MBMS
89
#define MBSFN_TDD_SF3 0x80	// for TDD
90 91 92 93
#define MBSFN_TDD_SF4 0x40
#define MBSFN_TDD_SF7 0x20
#define MBSFN_TDD_SF8 0x10
#define MBSFN_TDD_SF9 0x08
94
#define MBSFN_FDD_SF1 0x80	// for FDD
95 96 97 98 99 100 101 102
#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
103
/*!\brief MAX MCCH payload size  */
104
#define MCCH_PAYLOAD_SIZE_MAX 128
105
//#define MCH_PAYLOAD_SIZE_MAX 16384// this value is using in case mcs and TBS index are high
106 107 108 109
#endif

#define printk printf

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

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

148 149 150
#define LCID_EMPTY 0
#define LCID_NOT_EMPTY 1

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

157
/*!\brief maximum number of slices / groups */
158
#define MAX_NUM_SLICES 4
159

160

161 162
#define U_PLANE_INACTIVITY_VALUE 6000

Cedric Roux's avatar
Cedric Roux committed
163 164
/*
 * eNB part
165
 */
166

167

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

178
/*!\brief  MAC header of Random Access Response for backoff indicator (BI)*/
179
typedef struct {
180 181 182 183 184
    uint8_t BI:4;
    uint8_t R:2;
    uint8_t T:1;
    uint8_t E:1;
} __attribute__ ((__packed__)) RA_HEADER_BI;
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
/*
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
*/
214
/*!\brief  MAC subheader short with 7bit Length field */
215
typedef struct {
216 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
} __attribute__ ((__packed__)) SCH_SUBHEADER_SHORT;
222
/*!\brief  MAC subheader long  with 15bit Length field */
223
typedef struct {
224 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;
} __attribute__ ((__packed__)) SCH_SUBHEADER_LONG;
232
/*!\brief MAC subheader short without length field */
233
typedef struct {
234 235 236 237
    uint8_t LCID:5;
    uint8_t E:1;
    uint8_t R:2;
} __attribute__ ((__packed__)) SCH_SUBHEADER_FIXED;
238

239

knopp's avatar
knopp committed
240 241 242

/*!\brief  MAC subheader long  with 24bit DST field */
typedef struct {
243
  uint8_t   R0:4;
knopp's avatar
knopp committed
244 245 246 247 248 249 250 251 252 253
  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;
254
  uint8_t  L:7;	// Length field indicating the size of the corresponding SDU in bytes.
knopp's avatar
knopp committed
255 256 257
  uint8_t  F:1;
}__attribute__((__packed__))SLSCH_SUBHEADER_24_Bit_DST_SHORT;

258 259
/*!\brief  MAC subheader long  with 24bit DST field */
typedef struct {
260
  uint8_t   R0:4;
knopp's avatar
knopp committed
261 262 263 264 265 266 267 268 269 270
  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;
271
  uint8_t  L_MSB:7;	// Length field indicating the size of the corresponding SDU in bytes.
knopp's avatar
knopp committed
272 273 274 275 276
  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 */
277
typedef struct {
278
  uint8_t   R0:4;
knopp's avatar
knopp committed
279 280 281 282 283 284 285 286
  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;
287
  uint8_t  L:7;	// Length field indicating the size of the corresponding SDU in bytes.
knopp's avatar
knopp committed
288 289
  uint8_t  F:1;
}__attribute__((__packed__))SLSCH_SUBHEADER_16_Bit_DST_SHORT;
290

knopp's avatar
knopp committed
291 292
/*!\brief  MAC subheader long  with 24bit DST field */
typedef struct {
293
  uint8_t   R0:4;
knopp's avatar
knopp committed
294 295 296 297 298 299 300 301 302
  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;
303
  uint8_t  L_MSB:7;	// Length field indicating the size of the corresponding SDU in bytes.
knopp's avatar
knopp committed
304 305 306
  uint8_t  F:1;
  uint8_t  L_LSB:8;
}__attribute__((__packed__))SLSCH_SUBHEADER_16_Bit_DST_LONG;
307

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

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

323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346
// 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;



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

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

Cedric Roux's avatar
Cedric Roux committed
380
#if defined(Rel10) || defined(Rel14)
381
/*! \brief MCCH payload */
382
typedef struct {
383 384
    uint8_t payload[MCCH_PAYLOAD_SIZE_MAX];
} __attribute__ ((__packed__)) MCCH_PDU;
385
/*!< \brief MAC control element for activation and deactivation of component carriers */
386
typedef struct {
387 388 389 390 391 392 393 394 395
    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;
396
/*! \brief MAC control element: MCH Scheduling Information */
397
typedef struct {
398 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;
} __attribute__ ((__packed__)) MSI_ELEMENT;
402
#endif
403
/*! \brief Values of CCCH LCID for DLSCH */
404
#define CCCH_LCHANID 0
405
/*!\brief Values of BCCH logical channel (fake)*/
406
#define BCCH 3			// SI
407
/*!\brief Values of PCCH logical channel (fake)*/
408
#define PCCH 4			// Paging
409
/*!\brief Values of PCCH logical channel (fake) */
410
#define MIBCH 5			// MIB
411
/*!\brief Values of BCCH SIB1_BR logical channel (fake) */
412
#define BCCH_SIB1_BR 6		// SIB1_BR
413
/*!\brief Values of BCCH SIB_BR logical channel (fake) */
414
#define BCCH_SI_BR 7		// SI-BR
415
/*!\brief Value of CCCH / SRB0 logical channel */
416
#define CCCH 0			// srb0
417
/*!\brief DCCH / SRB1 logical channel */
418
#define DCCH 1			// srb1
419
/*!\brief DCCH1 / SRB2  logical channel */
420
#define DCCH1 2			// srb2
421
/*!\brief DTCH DRB1  logical channel */
422
#define DTCH 3			// LCID
423
/*!\brief MCCH logical channel */
424
#define MCCH 4
425
/*!\brief MTCH logical channel */
426
#define MTCH 1
427 428
// DLSCH LCHAN ID
/*!\brief LCID of UE contention resolution identity for DLSCH*/
429
#define UE_CONT_RES 28
430
/*!\brief LCID of timing advance for DLSCH */
431
#define TIMING_ADV_CMD 29
432
/*!\brief LCID of discontinous reception mode for DLSCH */
433
#define DRX_CMD 30
434
/*!\brief LCID of padding LCID for DLSCH */
435 436
#define SHORT_PADDING 31

Cedric Roux's avatar
Cedric Roux committed
437
#if defined(Rel10) || defined(Rel14)
438
// MCH LCHAN IDs (table6.2.1-4 TS36.321)
439
/*!\brief LCID of MCCH for DL */
440
#define MCCH_LCHANID 0
441 442 443
/*!\brief LCID of MCH scheduling info for DL */
#define MCH_SCHDL_INFO 3
/*!\brief LCID of Carrier component activation/deactivation */
444
#define CC_ACT_DEACT 27
445 446
//TTN (for D2D)
#define SL_DISCOVERY 8 //LCID (fake)
447
#define MAX_NUM_DEST 10
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
463
/*!\bitmaps for BSR Triggers */
464 465 466 467
#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 473
    uint8_t payload[8][SCH_PAYLOAD_SIZE_MAX];
    uint16_t Pdu_size[8];
474 475
} __attribute__ ((__packed__)) DLSCH_PDU;

476

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

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

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 504 505 506 507 508 509 510 511
/*!\brief RA process state*/
typedef enum {
    IDLE = 0,
    MSG2,
    WAITMSG3,
    MSG4,
    WAITMSG4ACK
} RA_state;

512
/*!\brief  UE ULSCH scheduling states*/
513
typedef enum {
514 515 516 517 518
    S_UL_NONE = 0,
    S_UL_WAITING,
    S_UL_SCHEDULED,
    S_UL_BUFFERED,
    S_UL_NUM_STATUS
519 520
} UE_ULSCH_STATUS;

521
/*!\brief  UE DLSCH scheduling states*/
522
typedef enum {
523 524 525 526 527
    S_DL_NONE = 0,
    S_DL_WAITING,
    S_DL_SCHEDULED,
    S_DL_BUFFERED,
    S_DL_NUM_STATUS
528 529
} UE_DLSCH_STATUS;

530
/*!\brief  scheduling policy for the contention-based access */
531
typedef enum {
532 533 534 535 536
    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
537 538 539
} CBA_POLICY;


540
/*! \brief temporary struct for ULSCH sched */
541
typedef struct {
542 543 544 545
    rnti_t rnti;
    uint16_t subframe;
    uint16_t serving_num;
    UE_ULSCH_STATUS status;
546
} eNB_ULSCH_INFO;
547
/*! \brief temp struct for DLSCH sched */
548
typedef struct {
549 550 551 552 553
    rnti_t rnti;
    uint16_t weight;
    uint16_t subframe;
    uint16_t serving_num;
    UE_DLSCH_STATUS status;
554
} eNB_DLSCH_INFO;
555
/*! \brief eNB overall statistics */
556
typedef struct {
Cedric Roux's avatar
Cedric Roux committed
557
    /// num BCCH PDU per CC
558
    uint32_t total_num_bcch_pdu;
Cedric Roux's avatar
Cedric Roux committed
559
    /// BCCH buffer size
560
    uint32_t bcch_buffer;
Cedric Roux's avatar
Cedric Roux committed
561
    /// total BCCH buffer size
562 563 564 565
    uint32_t total_bcch_buffer;
    /// BCCH MCS
    uint32_t bcch_mcs;

Cedric Roux's avatar
Cedric Roux committed
566
    /// num CCCH PDU per CC
567
    uint32_t total_num_ccch_pdu;
Cedric Roux's avatar
Cedric Roux committed
568
    /// BCCH buffer size
569
    uint32_t ccch_buffer;
Cedric Roux's avatar
Cedric Roux committed
570
    /// total BCCH buffer size
571 572 573
    uint32_t total_ccch_buffer;
    /// BCCH MCS
    uint32_t ccch_mcs;
574

575 576 577 578 579 580
  /// num PCCH PDU per CC
  uint32_t total_num_pcch_pdu;
  /// PCCH buffer size
  uint32_t pcch_buffer;
  /// total PCCH buffer size
  uint32_t total_pcch_buffer;
581
  /// BCCH MCS
582
  uint32_t pcch_mcs;
583 584

/// num active users
585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626
    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;
    /// aggregation
    /// total avilable nccc : num control channel element
    uint16_t available_ncces;
    // only for a new transmission, should be extended for retransmission
    // current dlsch  bit rate for all transport channels
    uint32_t dlsch_bitrate;
    //
    uint32_t dlsch_bytes_tx;
    //
    uint32_t dlsch_pdus_tx;
    //
    uint32_t total_dlsch_bitrate;
    //
    uint32_t total_dlsch_bytes_tx;
    //
    uint32_t total_dlsch_pdus_tx;

    // here for RX
    //
    uint32_t ulsch_bitrate;
    //
    uint32_t ulsch_bytes_rx;
    //
    uint64_t ulsch_pdus_rx;

    uint32_t total_ulsch_bitrate;
    //
    uint32_t total_ulsch_bytes_rx;
    //
    uint32_t total_ulsch_pdus_rx;


    /// MAC agent-related stats
    /// total number of scheduling decisions
    int sched_decisions;
    /// missed deadlines
    int missed_deadlines;
627

628
} eNB_STATS;
629
/*! \brief eNB statistics for the connected UEs*/
630
typedef struct {
631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669
    /// CRNTI of UE
    rnti_t crnti;		///user id (rnti) of connected UEs
    // rrc status
    uint8_t rrc_status;
    /// harq pid
    uint8_t harq_pid;
    /// harq rounf
    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;
    /// total nccc used for a new transmission: num control channel element
    uint16_t ncce_used;
    /// total avilable nccc for a retransmission: num control channel element
    uint16_t ncce_used_retx;

    // mcs1 before the rate adaptaion
    uint8_t dlsch_mcs1;
    /// Target mcs2 after rate-adaptation
    uint8_t dlsch_mcs2;
    //  current TBS with mcs2
    uint32_t TBS;
    //  total TBS with mcs2
    //  uint32_t total_TBS;
    //  total rb used for a new transmission
    uint32_t total_rbs_used;
    //  total rb used for retransmission
    uint32_t total_rbs_used_retx;

    /// TX
    /// 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];
Cedric Roux's avatar
Cedric Roux committed
670
    // Number of received MAC SDU
671 672 673 674 675
    uint32_t num_mac_sdu_tx;
    // LCID related to SDU
    unsigned char lcid_sdu[NB_RB_MAX];
    // Length of SDU Got from LC DL
    uint32_t sdu_length_tx[NB_RB_MAX];
Cedric Roux's avatar
Cedric Roux committed
676

677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722

    /// overall
    //
    uint32_t dlsch_bitrate;
    //total
    uint32_t total_dlsch_bitrate;
    /// headers+ CE +  padding bytes for a MAC PDU
    uint64_t overhead_bytes;
    /// headers+ CE +  padding bytes for a MAC PDU
    uint64_t total_overhead_bytes;
    /// headers+ CE +  padding bytes for a MAC PDU
    uint64_t avg_overhead_bytes;
    // MAC multiplexed payload
    uint64_t total_sdu_bytes;
    // total MAC pdu bytes
    uint64_t total_pdu_bytes;

    // total num pdu
    uint32_t total_num_pdus;
    //
    //  uint32_t avg_pdu_size;

    /// RX

    /// 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;
    /// preassigned mcs after rate adaptation
    uint8_t ulsch_mcs1;
    /// adjusted mcs
    uint8_t ulsch_mcs2;

    /// estimated average pdu inter-departure time
    uint32_t avg_pdu_idt;
    /// estimated average pdu size
    uint32_t avg_pdu_ps;
    ///
    uint32_t aggregated_pdu_size;
    uint32_t aggregated_pdu_arrival;

    ///  uplink transport block size
    uint32_t ulsch_TBS;

723
    uint32_t total_ulsch_TBS;
724 725 726 727 728 729 730 731 732

    ///  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;
Cedric Roux's avatar
Cedric Roux committed
733
    /// normalized rx power
734
    int32_t normalized_rx_power;
Cedric Roux's avatar
Cedric Roux committed
735
    /// target rx power
736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764
    int32_t target_rx_power;

    /// num rx pdu
    uint32_t num_pdu_rx[NB_RB_MAX];
    /// num bytes rx
    uint32_t num_bytes_rx[NB_RB_MAX];
    /// instantaneous rx throughput for each TTI
    //  uint32_t tti_goodput[NB_RB_MAX];
    /// errors
    uint32_t num_errors_rx;

    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;
    /// overall
    ///  MAC pdu bytes
    uint64_t pdu_bytes_rx;
    /// total MAC pdu bytes
    uint64_t total_pdu_bytes_rx;
    /// total num pdu
    uint32_t total_num_pdus_rx;
    /// num of error pdus
    uint32_t total_num_errors_rx;
765 766 767 768
    // Number of error PDUS
    uint32_t num_mac_sdu_rx;
    // Length of SDU Got from LC UL - Size array can be refined
    uint32_t      sdu_length_rx[NB_RB_MAX];
769

770
} eNB_UE_STATS;
771
/*! \brief eNB template for UE context information  */
772
typedef struct {
773 774 775 776 777 778 779 780 781 782 783 784 785
    /// C-RNTI of UE
    rnti_t rnti;
    /// NDI from last scheduling
    uint8_t oldNDI[8];
    /// mcs1 from last scheduling
    uint8_t oldmcs1[8];
    /// mcs2 from last scheduling
    uint8_t oldmcs2[8];
    /// NDI from last UL scheduling
    uint8_t oldNDI_UL[8];
    /// mcs from last UL scheduling
    uint8_t mcs_UL[8];
    /// TBS from last UL scheduling
786
    int TBS_UL[8];
787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812
    /// Flag to indicate UL has been scheduled at least once
    boolean_t ul_active;
    /// Flag to indicate UE has been configured (ACK from RRCConnectionSetup received)
    boolean_t configured;

    /// MCS from last scheduling
    uint8_t mcs[8];

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

    // PHY interface info

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

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

    /// 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

    /// Number of Allocated RBs by the ulsch preprocessor
813
    uint8_t pre_allocated_nb_rb_ul[MAX_NUM_SLICES];
814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861

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

    /// total allocated RBs
    int8_t total_allocated_rbs;

    /// pre-assigned MCS by the ulsch preprocessor
    uint8_t pre_assigned_mcs_ul;

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

    /// DL DAI
    uint8_t DAI;

    /// UL DAI
    uint8_t DAI_ul[10];

    /// UL Scheduling Request Received
    uint8_t ul_SR;

    ///Resource Block indication for each sub-band in MU-MIMO
    uint8_t rballoc_subband[8][50];

    // Logical channel info for link with RLC

    /// LCGID mapping
    long lcgidmap[11];

    /// phr information
    int8_t phr_info;

    /// phr information
    int8_t phr_info_configured;

    ///dl buffer info
    uint32_t dl_buffer_info[MAX_NUM_LCID];
    /// total downlink buffer info
    uint32_t dl_buffer_total;
    /// total downlink pdus
    uint32_t dl_pdus_total;
    /// downlink pdus for each LCID
    uint32_t dl_pdus_in_buffer[MAX_NUM_LCID];
    /// creation time of the downlink buffer head for each LCID
    uint32_t dl_buffer_head_sdu_creation_time[MAX_NUM_LCID];
    /// maximum creation time of the downlink buffer head across all LCID
    uint32_t dl_buffer_head_sdu_creation_time_max;
Cedric Roux's avatar
Cedric Roux committed
862
    /// a flag indicating that the downlink head SDU is segmented
863 864 865 866 867 868 869 870 871 872 873
    uint8_t dl_buffer_head_sdu_is_segmented[MAX_NUM_LCID];
    /// size of remaining size to send for the downlink head SDU
    uint32_t dl_buffer_head_sdu_remaining_size_to_send[MAX_NUM_LCID];

    /// uplink buffer creation time for each LCID
    uint32_t ul_buffer_creation_time[MAX_NUM_LCGID];
    /// maximum uplink buffer creation time across all the LCIDs
    uint32_t ul_buffer_creation_time_max;
    /// uplink buffer size per LCID
    uint32_t ul_buffer_info[MAX_NUM_LCGID];

874 875 876 877 878
    /// uplink bytes that are currently scheduled
    int scheduled_ul_bytes;
    /// estimation of the UL buffer size
    int estimated_ul_buffer;

879 880
    /// UE tx power
    int32_t ue_tx_power;
881

882 883 884 885 886
    /// stores the frame where the last TPC was transmitted
    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
887

888
#ifdef LOCALIZATION
889
    eNB_UE_estimated_distances distance;
890
#endif
891 892

#ifdef Rel14
893 894 895
    uint8_t rach_resource_type;
    uint16_t mpdcch_repetition_cnt;
    frame_t Msg2_frame;
896
#endif
897
    sub_frame_t Msg2_subframe;
898

899
    PhysicalConfigDedicated_t *physicalConfigDedicated;
900

901 902
} UE_TEMPLATE;

903
/*! \brief scheduling control information set through an API (not used)*/
904
typedef struct {
905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923
    ///UL transmission bandwidth in RBs
    uint8_t ul_bandwidth[MAX_NUM_LCID];
    ///DL transmission bandwidth in RBs
    uint8_t dl_bandwidth[MAX_NUM_LCID];

    //To do GBR bearer
    uint8_t min_ul_bandwidth[MAX_NUM_LCID];

    uint8_t min_dl_bandwidth[MAX_NUM_LCID];

    ///aggregated bit rate of non-gbr bearer per UE
    uint64_t ue_AggregatedMaximumBitrateDL;
    ///aggregated bit rate of non-gbr bearer per UE
    uint64_t ue_AggregatedMaximumBitrateUL;
    ///CQI scheduling interval in subframes.
    uint16_t cqiSchedInterval;
    ///Contention resolution timer used during random access
    uint8_t mac_ContentionResolutionTimer;

924
    uint16_t max_rbs_allowed_slice[MAX_NUM_CCs][MAX_NUM_SLICES];
925
    uint16_t max_rbs_allowed_slice_uplink[MAX_NUM_CCs][MAX_NUM_SLICES];
926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948

    uint8_t max_mcs[MAX_NUM_LCID];

    uint16_t priority[MAX_NUM_LCID];

    // resource scheduling information

    /// 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];
    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];
    uint16_t ta_timer;
    int16_t ta_update;
    uint16_t ul_consecutive_errors;
    int32_t context_active_timer;
    int32_t cqi_req_timer;
    int32_t ul_inactivity_timer;
    int32_t ul_failure_timer;
949 950
    uint32_t ue_reestablishment_reject_timer;
    uint32_t ue_reestablishment_reject_timer_thres;
951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981
    int32_t ul_scheduled;
    int32_t ra_pdcch_order_sent;
    int32_t ul_out_of_sync;
    int32_t phr_received;
    uint8_t periodic_ri_received[NFAPI_CC_MAX];
    uint8_t aperiodic_ri_received[NFAPI_CC_MAX];
    uint8_t pucch1_cqi_update[NFAPI_CC_MAX];
    uint8_t pucch1_snr[NFAPI_CC_MAX];
    uint8_t pucch2_cqi_update[NFAPI_CC_MAX];
    uint8_t pucch2_snr[NFAPI_CC_MAX];
    uint8_t pucch3_cqi_update[NFAPI_CC_MAX];
    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];
    uint8_t dl_cqi[NFAPI_CC_MAX];
982
    int32_t       uplane_inactivity_timer;
983
} UE_sched_ctrl;
984
/*! \brief eNB template for the Random access information */
985
typedef struct {
986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033
    /// Flag to indicate this process is active
    RA_state state;
    /// Subframe where preamble was received
    uint8_t preamble_subframe;
    /// Subframe where Msg2 is to be sent
    uint8_t Msg2_subframe;
    /// Frame where Msg2 is to be sent
    frame_t Msg2_frame;
    /// Subframe where Msg3 is to be sent
    sub_frame_t Msg3_subframe;
    /// Frame where Msg3 is to be sent
    frame_t Msg3_frame;
    /// Subframe where Msg4 is to be sent
    sub_frame_t Msg4_subframe;
    /// Frame where Msg4 is to be sent
    frame_t Msg4_frame;
    /// harq_pid used for Msg4 transmission
    uint8_t harq_pid;
    /// UE RNTI allocated during RAR
    rnti_t rnti;
    /// RA RNTI allocated from received PRACH
    uint16_t RA_rnti;
    /// Received preamble_index
    uint8_t preamble_index;
    /// Received UE Contention Resolution Identifier
    uint8_t cont_res_id[6];
    /// Timing offset indicated by PHY
    int16_t timing_offset;
    /// Timeout for RRC connection
    int16_t RRC_timer;
    /// Msg3 first RB
    uint8_t msg3_first_rb;
    /// Msg3 number of RB
    uint8_t msg3_nb_rb;
    /// Msg3 MCS
    uint8_t msg3_mcs;
    /// Msg3 TPC command
    uint8_t msg3_TPC;
    /// Msg3 ULdelay command
    uint8_t msg3_ULdelay;
    /// Msg3 cqireq command
    uint8_t msg3_cqireq;
    /// Round of Msg3 HARQ
    uint8_t msg3_round;
    /// TBS used for Msg4
    int msg4_TBsize;
    /// MCS used for Msg4
    int msg4_mcs;
1034
#ifdef Rel14
1035 1036 1037 1038 1039
    uint8_t rach_resource_type;
    uint8_t msg2_mpdcch_repetition_cnt;
    uint8_t msg4_mpdcch_repetition_cnt;
    uint8_t msg2_narrowband;
    uint8_t msg34_narrowband;
1040
#endif
1041
} RA_t;
1042 1043


1044
/*! \brief subband bitmap confguration (for ALU icic algo purpose), in test phase */
1045
typedef struct {
1046
    uint8_t sbmap[13];	//13 = number of SB MAX for 100 PRB
1047 1048 1049 1050
    uint8_t periodicity;
    uint8_t first_subframe;
    uint8_t sb_size;
    uint8_t nb_active_sb;
1051
} SBMAP_CONF;
1052
/*! \brief UE list used by eNB to order UEs/CC for scheduling*/
1053
typedef struct {
1054 1055 1056
    /// Dedicated information for UEs
    struct PhysicalConfigDedicated
	*physicalConfigDedicated[MAX_NUM_CCs][NUMBER_OF_UE_MAX];
Cedric Roux's avatar
Cedric Roux committed
1057
    /// DLSCH pdu
1058 1059 1060 1061 1062
    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];
Cedric Roux's avatar
Cedric Roux committed
1063
    /// sorted downlink component carrier for the scheduler
1064
    int ordered_CCids[MAX_NUM_CCs][NUMBER_OF_UE_MAX];
Cedric Roux's avatar
Cedric Roux committed
1065
    /// number of downlink active component carrier
1066
    int numactiveCCs[NUMBER_OF_UE_MAX];
Cedric Roux's avatar
Cedric Roux committed
1067
    /// sorted uplink component carrier for the scheduler
1068
    int ordered_ULCCids[MAX_NUM_CCs][NUMBER_OF_UE_MAX];
Cedric Roux's avatar
Cedric Roux committed
1069
    /// number of uplink active component carrier
1070
    int numactiveULCCs[NUMBER_OF_UE_MAX];
Cedric Roux's avatar
Cedric Roux committed
1071
    /// number of downlink active component carrier
1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083
    uint8_t dl_CC_bitmap[NUMBER_OF_UE_MAX];
    /// eNB to UE statistics
    eNB_UE_STATS eNB_UE_stats[MAX_NUM_CCs][NUMBER_OF_UE_MAX];
    /// scheduling control info
    UE_sched_ctrl UE_sched_ctrl[NUMBER_OF_UE_MAX];
    int next[NUMBER_OF_UE_MAX];
    int head;
    int next_ul[NUMBER_OF_UE_MAX];
    int head_ul;
    int avail;
    int num_UEs;
    boolean_t active[NUMBER_OF_UE_MAX];
1084 1085 1086 1087

    /// Sorting criteria for the UE list in the MAC preprocessor
    uint16_t sorting_criteria[MAX_NUM_SLICES][CR_NUM];

knopp's avatar
knopp committed
1088
} UE_list_t;
1089

1090
/*! \brief eNB common channels */
1091
typedef struct {
1092 1093 1094 1095 1096 1097 1098
    int physCellId;
    int p_eNB;
    int Ncp;
    int eutra_band;
    uint32_t dl_CarrierFreq;
    BCCH_BCH_Message_t *mib;
    RadioResourceConfigCommonSIB_t *radioResourceConfigCommon;
1099
#ifdef Rel14
1100
    RadioResourceConfigCommonSIB_t *radioResourceConfigCommon_BR;
1101
#endif
1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113
    TDD_Config_t *tdd_Config;
    SchedulingInfoList_t *schedulingInfoList;
    ARFCN_ValueEUTRA_t ul_CarrierFreq;
    long ul_Bandwidth;
    /// Outgoing MIB PDU for PHY
    MIB_PDU MIB_pdu;
    /// Outgoing BCCH pdu for PHY
    BCCH_PDU BCCH_pdu;
    /// Outgoing BCCH DCI allocation
    uint32_t BCCH_alloc_pdu;
    /// Outgoing CCCH pdu for PHY
    CCCH_PDU CCCH_pdu;
1114 1115 1116 1117
    /// Outgoing PCCH DCI allocation
    uint32_t PCCH_alloc_pdu;
    /// Outgoing PCCH pdu for PHY
    PCCH_PDU PCCH_pdu;
1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129
    /// Outgoing RAR pdu for PHY
    RAR_PDU RAR_pdu;
    /// Template for RA computations
    RA_t ra[NB_RA_PROC_MAX];
    /// VRB map for common channels
    uint8_t vrb_map[100];
    /// VRB map for common channels and retransmissions by PHICH
    uint8_t vrb_map_UL[100];
    /// MBSFN SubframeConfig
    struct MBSFN_SubframeConfig *mbsfn_SubframeConfig[8];
    /// number of subframe allocation pattern available for MBSFN sync area
    uint8_t num_sf_allocation_pattern;
Cedric Roux's avatar
Cedric Roux committed
1130
#if defined(Rel10) || defined(Rel14)
1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150
    /// MBMS Flag
    uint8_t MBMS_flag;
    /// Outgoing MCCH pdu for PHY
    MCCH_PDU MCCH_pdu;
    /// MCCH active flag
    uint8_t msi_active;
    /// MCCH active flag
    uint8_t mcch_active;
    /// MTCH active flag
    uint8_t mtch_active;
    /// number of active MBSFN area
    uint8_t num_active_mbsfn_area;
    /// 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;
1151
#endif
1152
#ifdef Rel14
1153 1154 1155 1156 1157 1158
    /// Rel13 parameters from SIB1
    SystemInformationBlockType1_v1310_IEs_t *sib1_v13ext;
    /// Counter for SIB1-BR scheduling
    int SIB1_BR_cnt;
    /// Outgoing BCCH-BR pdu for PHY
    BCCH_PDU BCCH_BR_pdu[20];
1159
#endif
1160
} COMMON_channels_t;
1161
/*! \brief top level eNB MAC structure */
1162
typedef struct eNB_MAC_INST_s {
1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178
    /// Ethernet parameters for northbound midhaul interface
    eth_params_t eth_params_n;
    /// Ethernet parameters for fronthaul interface
    eth_params_t eth_params_s;
    ///
    module_id_t Mod_id;
    /// frame counter
    frame_t frame;
    /// subframe counter
    sub_frame_t subframe;
    /// Pointer to IF module instance for PHY
    IF_Module_t *if_inst;
    /// Common cell resources
    COMMON_channels_t common_channels[MAX_NUM_CCs];
    /// current PDU index (BCH,MCH,DLSCH)
    uint16_t pdu_index[MAX_NUM_CCs];
1179 1180
    /// flag to enable phy-test (disables the scheduler)
    uint16_t phy_test;
1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198

    /// NFAPI Config Request Structure
    nfapi_config_request_t config[MAX_NUM_CCs];
    /// Preallocated DL pdu list
    nfapi_dl_config_request_pdu_t
	dl_config_pdu_list[MAX_NUM_CCs][MAX_NUM_DL_PDU];
    /// NFAPI DL Config Request Structure
    nfapi_dl_config_request_t DL_req[MAX_NUM_CCs];
    /// Preallocated UL pdu list
    nfapi_ul_config_request_pdu_t
	ul_config_pdu_list[MAX_NUM_CCs][MAX_NUM_UL_PDU];
    /// Preallocated UL pdu list for ULSCH (n+k delay)
    nfapi_ul_config_request_pdu_t
	ul_config_pdu_list_tmp[MAX_NUM_CCs][10][MAX_NUM_UL_PDU];
    /// NFAPI UL Config Request Structure, send to L1 4 subframes before processing takes place
    nfapi_ul_config_request_t UL_req[MAX_NUM_CCs];
    /// NFAPI "Temporary" UL Config Request Structure, holds future UL_config requests
    nfapi_ul_config_request_t UL_req_tmp[MAX_NUM_CCs][10];
Cedric Roux's avatar
Cedric Roux committed
1199
    /// Preallocated HI_DCI0 pdu list
1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221
    nfapi_hi_dci0_request_pdu_t
	hi_dci0_pdu_list[MAX_NUM_CCs][MAX_NUM_HI_DCI0_PDU];
    /// NFAPI HI/DCI0 Config Request Structure
    nfapi_hi_dci0_request_t HI_DCI0_req[MAX_NUM_CCs];
    /// Prealocated TX pdu list
    nfapi_tx_request_pdu_t
	tx_request_pdu[MAX_NUM_CCs][MAX_NUM_TX_REQUEST_PDU];
    /// NFAPI DL PDU structure
    nfapi_tx_request_t TX_req[MAX_NUM_CCs];
    /// UL handle
    uint32_t ul_handle;
    UE_list_t UE_list;

    ///subband bitmap configuration
    SBMAP_CONF sbmap_conf;
    /// CCE table used to build DCI scheduling information
    int CCE_table[MAX_NUM_CCs][800];
    ///  active flag for Other lcid
    uint8_t lcid_active[NB_RB_MAX];
    /// eNB stats
    eNB_STATS eNB_stats[MAX_NUM_CCs];
    // MAC function execution peformance profiler
Cedric Roux's avatar
Cedric Roux committed
1222
    /// processing time of eNB scheduler
1223
    time_stats_t eNB_scheduler;
Cedric Roux's avatar
Cedric Roux committed
1224
    /// processing time of eNB scheduler for SI
1225 1226 1227
    time_stats_t schedule_si;
    /// processing time of eNB scheduler for Random access
    time_stats_t schedule_ra;
Cedric Roux's avatar
Cedric Roux committed
1228
    /// processing time of eNB ULSCH scheduler
1229 1230 1231 1232 1233
    time_stats_t schedule_ulsch;
    /// processing time of eNB DCI generation
    time_stats_t fill_DLSCH_dci;
    /// processing time of eNB MAC preprocessor
    time_stats_t schedule_dlsch_preprocessor;
Cedric Roux's avatar
Cedric Roux committed
1234
    /// processing time of eNB DLSCH scheduler
1235
    time_stats_t schedule_dlsch;	// include rlc_data_req + MAC header + preprocessor
Cedric Roux's avatar
Cedric Roux committed
1236
    /// processing time of eNB MCH scheduler
1237 1238 1239
    time_stats_t schedule_mch;
    /// processing time of eNB ULSCH reception
    time_stats_t rx_ulsch_sdu;	// include rlc_data_ind
1240 1241
    /// processing time of eNB PCH scheduler
    time_stats_t schedule_pch;
1242
} eNB_MAC_INST;
1243

Cedric Roux's avatar
Cedric Roux committed
1244 1245
/*
 * UE part
1246
 */
1247

1248
typedef enum {
1249 1250 1251 1252 1253 1254
    TYPE0,
    TYPE1,
    TYPE1A,
    TYPE2,
    TYPE2A,
    TYPEUESPEC
1255 1256
} MPDCCH_TYPES_t;

1257 1258
/*!\brief UE layer 2 status */
typedef enum {
1259 1260 1261 1262
    CONNECTION_OK = 0,
    CONNECTION_LOST,
    PHY_RESYNCH,
    PHY_HO_PRACH
1263 1264 1265
} UE_L2_STATE_t;

/*!\brief UE scheduling info */
1266
typedef struct {
1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324
    /// buffer status for each lcgid
    uint8_t BSR[MAX_NUM_LCGID];	// should be more for mesh topology
    /// keep the number of bytes in rlc buffer for each lcgid
    int32_t BSR_bytes[MAX_NUM_LCGID];
    /// after multiplexing buffer remain for each lcid
    int32_t LCID_buffer_remain[MAX_NUM_LCID];
    /// sum of all lcid buffer size
    uint16_t All_lcid_buffer_size_lastTTI;
    /// buffer status for each lcid
    uint8_t LCID_status[MAX_NUM_LCID];
    /// SR pending as defined in 36.321
    uint8_t SR_pending;
    /// SR_COUNTER as defined in 36.321
    uint16_t SR_COUNTER;
    /// logical channel group ide for each LCID
    uint8_t LCGID[MAX_NUM_LCID];
    /// retxBSR-Timer, default value is sf2560
    uint16_t retxBSR_Timer;
    /// retxBSR_SF, number of subframe before triggering a regular BSR
    uint16_t retxBSR_SF;
    /// periodicBSR-Timer, default to infinity
    uint16_t periodicBSR_Timer;
    /// periodicBSR_SF, number of subframe before triggering a periodic BSR
    uint16_t periodicBSR_SF;
    /// default value is 0: not configured
    uint16_t sr_ProhibitTimer;
    /// sr ProhibitTime running
    uint8_t sr_ProhibitTimer_Running;
    ///  default value to n5
    uint16_t maxHARQ_Tx;
    /// default value is false
    uint16_t ttiBundling;
    /// default value is release
    struct DRX_Config *drx_config;
    /// default value is release
    struct MAC_MainConfig__phr_Config *phr_config;
    ///timer before triggering a periodic PHR
    uint16_t periodicPHR_Timer;
    ///timer before triggering a prohibit PHR
    uint16_t prohibitPHR_Timer;
    ///DL Pathloss change value
    uint16_t PathlossChange;
    ///number of subframe before triggering a periodic PHR
    int16_t periodicPHR_SF;
    ///number of subframe before triggering a prohibit PHR
    int16_t prohibitPHR_SF;
    ///DL Pathloss Change in db
    uint16_t PathlossChange_db;

    /// default value is false
    uint16_t extendedBSR_Sizes_r10;
    /// default value is false
    uint16_t extendedPHR_r10;

    //Bj bucket usage per  lcid
    int16_t Bj[MAX_NUM_LCID];
    // Bucket size per lcid
    int16_t bucket_size[MAX_NUM_LCID];
1325
} UE_SCHEDULING_INFO;
1326
/*!\brief Top level UE MAC structure */
1327
typedef struct {
1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348
    uint16_t Node_id;
    /// RX frame counter
    frame_t rxFrame;
    /// RX subframe counter
    sub_frame_t rxSubframe;
    /// TX frame counter
    frame_t txFrame;
    /// TX subframe counter
    sub_frame_t txSubframe;
    /// C-RNTI of UE
    uint16_t crnti;
    /// C-RNTI of UE before HO
    rnti_t crnti_before_ho;	///user id (rnti) of connected UEs
    /// uplink active flag
    uint8_t ul_active;
    /// pointer to RRC PHY configuration
    RadioResourceConfigCommonSIB_t *radioResourceConfigCommon;
    /// pointer to RACH_ConfigDedicated (NULL when not active, i.e. upon HO completion or T304 expiry)
    struct RACH_ConfigDedicated *rach_ConfigDedicated;
    /// pointer to RRC PHY configuration
    struct PhysicalConfigDedicated *physicalConfigDedicated;
Cedric Roux's avatar
Cedric Roux committed
1349
#if defined(Rel10) || defined(Rel14)
1350 1351
  /// pointer to RRC PHY configuration SCEll
  struct PhysicalConfigDedicatedSCell_r10 *physicalConfigDedicatedSCell_r10;
1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367
  /// Preconfiguration for Sidelink
  struct SL_Preconfiguration_r12 *SL_Preconfiguration;
  /// RX Pool for Sidelink from SIB18
  SL_CommRxPoolList_r12_t	 commRxPool_r12;
  /// TX Pool Normal for Sidelink from SIB18
  struct SL_CommTxPoolList_r12	*commTxPoolNormalCommon_r12;
  /// TX Pool Exceptional for Sidelink from SIB18
  struct SL_CommTxPoolList_r12	*commTxPoolExceptional_r12;
  /// Common Sync Config for Sidelink from SIB18
  struct SL_SyncConfigList_r12	*commSyncConfig_r12;
  /// Dedicated Sync TX control for Sidelink
  struct SL_SyncTxControl_r12 *sl_SyncTxControl_r12;
  /// Dedicated Discovery TX control for Sidelink
  struct SL_DiscConfig_r12	*sl_DiscConfig_r12;
  /// Dedicated TX config for Sidelink
  struct SL_CommConfig_r12	*sl_CommConfig_r12;
1368 1369 1370 1371 1372 1373
  //SL sourceL2ID
  uint32_t sourceL2Id;
  //SL groupL2Id
  uint32_t groupL2Id;
  //SL destinationL2Id
  uint32_t destinationL2Id;
1374 1375 1376
  //List of destinations
  uint32_t destinationList[MAX_NUM_DEST];
  uint8_t numCommFlows;
1377
  uint32_t  SL_LCID[MAX_NUM_LCID];
1378

1379
#endif
1380 1381 1382
  /// pointer to TDD Configuration (NULL for FDD)
  TDD_Config_t *tdd_Config;
  /// Number of adjacent cells to measure
1383
  uint8_t  n_adj_cells;
1384
  /// Array of adjacent physical cell ids
1385
  uint32_t adj_cell_id[6];
1386 1387 1388 1389 1390 1391
  /// Pointer to RRC MAC configuration
  MAC_MainConfig_t *macConfig;
  /// Pointer to RRC Measurement gap configuration
  MeasGapConfig_t  *measGapConfig;
  /// Pointers to LogicalChannelConfig indexed by LogicalChannelIdentity. Note NULL means LCHAN is inactive.
  LogicalChannelConfig_t *logicalChannelConfig[MAX_NUM_LCID];
1392

1393
  /// Scheduling Information
1394 1395 1396
  UE_SCHEDULING_INFO scheduling_info;
  /// Outgoing CCCH pdu for PHY
  CCCH_PDU CCCH_pdu;
1397 1398
  /// Outgoing RAR pdu for PHY
  RAR_PDU RAR_pdu;
1399
  /// Incoming DLSCH pdu for PHY
1400
  DLSCH_PDU DLSCH_pdu[NUMBER_OF_UE_MAX][2];
1401 1402 1403
#ifdef Rel14
  int sltx_active;
  SLSCH_t slsch;
1404
  SLDCH_t sldch;
1405
  ULSCH_PDU slsch_pdu;
1406
  int slsch_lcid;
1407
#endif
1408
  /// number of attempt for rach
1409
  uint8_t RA_attempt_number;
1410
  /// Random-access procedure flag
1411
  uint8_t RA_active;
1412
  /// Random-access window counter
1413
  int8_t RA_window_cnt;
1414
  /// Random-access Msg3 size in bytes
1415
  uint8_t RA_Msg3_size;
1416
  /// Random-access prachMaskIndex
1417
  uint8_t RA_prachMaskIndex;
1418
  /// Flag indicating Preamble set (A,B) used for first Msg3 transmission
1419
  uint8_t RA_usedGroupA;
1420 1421 1422
  /// Random-access Resources
  PRACH_RESOURCES_t RA_prach_resources;
  /// Random-access PREAMBLE_TRANSMISSION_COUNTER
1423
  uint8_t RA_PREAMBLE_TRANSMISSION_COUNTER;
1424
  /// Random-access backoff counter
1425
  int16_t RA_backoff_cnt;
1426
  /// Random-access variable for window calculation (frame of last change in window counter)
1427
  uint32_t RA_tx_frame;
1428
  /// Random-access variable for window calculation (subframe of last change in window counter)
1429
  uint8_t RA_tx_subframe;
1430 1431
  /// Random-access Group B maximum path-loss
  /// Random-access variable for backoff (frame of last change in backoff counter)
1432
  uint32_t RA_backoff_frame;
1433
  /// Random-access variable for backoff (subframe of last change in backoff counter)
1434
  uint8_t RA_backoff_subframe;
1435
  /// Random-access Group B maximum path-loss
1436
  uint16_t RA_maxPL;
1437
  /// Random-access Contention Resolution Timer active flag
1438
  uint8_t RA_contention_resolution_timer_active;
1439
  /// Random-access Contention Resolution Timer count value
1440
  uint8_t RA_contention_resolution_cnt;
1441
  /// power headroom reporitng reconfigured
1442
  uint8_t PHR_reconfigured;
1443
  /// power headroom state as configured by the higher layers
1444
  uint8_t PHR_state;
1445
  /// power backoff due to power management (as allowed by P-MPRc) for this cell
1446
  uint8_t PHR_reporting_active;
1447
  /// power backoff due to power management (as allowed by P-MPRc) for this cell
1448
  uint8_t power_backoff_db[NUMBER_OF_eNB_MAX];
fnabet's avatar
fnabet committed
1449 1450
  /// BSR report falg management
  uint8_t BSR_reporting_active;
1451 1452
  /// retxBSR-Timer expires flag
  uint8_t retxBSRTimer_expires_flag;
1453 1454 1455
  /// periodBSR-Timer expires flag
  uint8_t periodBSRTimer_expires_flag;

1456
  /// MBSFN_Subframe Configuration
1457
  struct MBSFN_SubframeConfig *mbsfn_SubframeConfig[8]; // FIXME replace 8 by MAX_MBSFN_AREA?
1458
  /// number of subframe allocation pattern available for MBSFN sync area
1459
  uint8_t num_sf_allocation_pattern;
Cedric Roux's avatar
Cedric Roux committed
1460
#if defined(Rel10) || defined(Rel14)
1461 1462 1463 1464 1465 1466 1467 1468 1469 1470
    /// number of active MBSFN area
    uint8_t num_active_mbsfn_area;
    /// MBSFN Area Info
    struct MBSFN_AreaInfo_r9 *mbsfn_AreaInfo[MAX_MBSFN_AREA];
    /// PMCH Config
    struct PMCH_Config_r9 *pmch_Config[MAX_PMCH_perMBSFN];
    /// MCCH status
    uint8_t mcch_status;
    /// MSI status
    uint8_t msi_status;		// could be an array if there are >1 MCH in one MBSFN area
1471
#endif
1472
  //#ifdef CBA
1473
  /// CBA RNTI for each group
1474
  uint16_t cba_rnti[NUM_MAX_CBA_GROUP];
1475
  /// last SFN for CBA channel access
1476
  uint8_t cba_last_access[NUM_MAX_CBA_GROUP];
1477
  //#endif
1478
  /// total UE scheduler processing time
1479
  time_stats_t ue_scheduler; // total
1480 1481
  /// UE ULSCH tx  processing time inlcuding RLC interface (rlc_data_req) and mac header generation
  time_stats_t tx_ulsch_sdu;
1482
  /// UE DLSCH rx  processing time inlcuding RLC interface (mac_rrc_data_ind or mac_rlc_status_ind+mac_rlc_data_ind) and mac header parser
1483 1484
  time_stats_t rx_dlsch_sdu ;
  /// UE query for MCH subframe processing time
1485
  time_stats_t ue_query_mch;
1486
  /// UE MCH rx processing time
1487
  time_stats_t rx_mch_sdu;
1488 1489 1490
  /// UE BCCH rx processing time including RLC interface (mac_rrc_data_ind)
  time_stats_t rx_si;
  /// UE PCCH rx processing time including RLC interface (mac_rrc_data_ind)
1491 1492 1493
  time_stats_t rx_p;
  /// Panos: Mutex for nfapi UL_INFO
  pthread_mutex_t      UL_INFO_mutex;
1494 1495 1496 1497