mac.h 53.6 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
#include "COMMON/platform_constants.h"
47
#include "BCCH-BCH-Message.h"
48
#include "RadioResourceConfigCommon.h"
49
#include "RadioResourceConfigCommonSIB.h"
50 51
#include "RadioResourceConfigDedicated.h"
#include "MeasGapConfig.h"
52
#include "SchedulingInfoList.h"
53 54 55
#include "TDD-Config.h"
#include "RACH-ConfigCommon.h"
#include "MeasObjectToAddModList.h"
56
#include "MobilityControlInfo.h"
57
#if (RRC_VERSION >= MAKE_VERSION(9, 0, 0))
58 59 60
#include "MBSFN-AreaInfoList-r9.h"
#include "MBSFN-SubframeConfigList.h"
#include "PMCH-InfoList-r9.h"
61 62
#endif
#if (RRC_VERSION >= MAKE_VERSION(10, 0, 0))
Raymond Knopp's avatar
 
Raymond Knopp committed
63
#include "SCellToAddMod-r10.h"
64
#endif
65
#if (RRC_VERSION >= MAKE_VERSION(13, 0, 0))
66
#include "SystemInformationBlockType1-v1310-IEs.h"
67
#include "SystemInformationBlockType18-r12.h"
68
#endif
69
#include "RadioResourceConfigCommonSIB.h"
70 71
#include "nfapi_interface.h"
#include "PHY_INTERFACE/IF_Module.h"
72

73 74 75
#include "PHY/TOOLS/time_meas.h"

#include "PHY/defs_common.h" // for PRACH_RESOURCES_t
76
#include "PHY/LTE_TRANSPORT/transport_common.h"
77 78 79

#include "targets/ARCH/COMMON/common_lib.h"

80 81
/** @defgroup _mac  MAC
 * @ingroup _oai2
82 83 84
 * @{
 */

85
#define BCCH_PAYLOAD_SIZE_MAX 128
86
#define CCCH_PAYLOAD_SIZE_MAX 128
87
#define PCCH_PAYLOAD_SIZE_MAX 128
88
#define RAR_PAYLOAD_SIZE_MAX 128
89

90
#define SCH_PAYLOAD_SIZE_MAX 8192
91
#define DCH_PAYLOAD_SIZE_MAX 4096
92 93
/// Logical channel ids from 36-311 (Note BCCH is not specified in 36-311, uses the same as first DRB)

94
#if (RRC_VERSION >= MAKE_VERSION(14, 0, 0))
95

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

#define printk printf

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

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

152 153 154
#define LCID_EMPTY 0
#define LCID_NOT_EMPTY 1

hbilel's avatar
hbilel 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
/*!\brief maximum number of slices / groups */
162
#define MAX_NUM_SLICES 10
163

164

165 166
#define U_PLANE_INACTIVITY_VALUE 6000

Cedric Roux's avatar
Cedric Roux committed
167 168
/*
 * eNB part
169
 */
170

171

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

182
/*!\brief  MAC header of Random Access Response for backoff indicator (BI)*/
183
typedef struct {
184 185 186 187 188
    uint8_t BI:4;
    uint8_t R:2;
    uint8_t T:1;
    uint8_t E:1;
} __attribute__ ((__packed__)) RA_HEADER_BI;
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 215 216 217
/*
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
*/
218
/*!\brief  MAC subheader short with 7bit Length field */
219
typedef struct {
220 221 222 223 224 225
    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;
226
/*!\brief  MAC subheader long  with 15bit Length field */
227
typedef struct {
228 229 230 231 232 233 234 235
    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;
236
/*!\brief MAC subheader short without length field */
237
typedef struct {
238 239 240 241
    uint8_t LCID:5;
    uint8_t E:1;
    uint8_t R:2;
} __attribute__ ((__packed__)) SCH_SUBHEADER_FIXED;
242

243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311


/*!\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;

/*!\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_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 */
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  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;

/*!\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;

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

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

327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349
/*!\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;



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

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

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

440
#if (RRC_VERSION >= MAKE_VERSION(10, 0, 0))
441
// MCH LCHAN IDs (table6.2.1-4 TS36.321)
442
/*!\brief LCID of MCCH for DL */
443
#define MCCH_LCHANID 0
444
/*!\brief LCID of MCH scheduling info for DL */
445
#define MCH_SCHDL_INFO 30
446
/*!\brief LCID of Carrier component activation/deactivation */
447
#define CC_ACT_DEACT 27
448 449 450
//TTN (for D2D)
#define SL_DISCOVERY 8 //LCID (fake)
#define MAX_NUM_DEST 10
451 452 453
#endif

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


473
/*! \brief Downlink SCH PDU Structure */
474
typedef struct {
475 476
    uint8_t payload[8][SCH_PAYLOAD_SIZE_MAX];
    uint16_t Pdu_size[8];
477 478
} __attribute__ ((__packed__)) DLSCH_PDU;

479

480
/*! \brief MCH PDU Structure */
481
typedef struct {
482 483 484 485 486 487 488
    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;
489 490
} __attribute__ ((__packed__)) MCH_PDU;

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

497 498 499 500 501 502
/*! \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;

503 504 505 506 507 508
/*!\brief RA process state*/
typedef enum {
    IDLE = 0,
    MSG2,
    WAITMSG3,
    MSG4,
Xu Bo's avatar
Xu Bo committed
509 510 511
    WAITMSG4ACK,
    MSGCRNTI,
    MSGCRNTI_ACK
512 513
} RA_state;

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

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

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

541 542 543 544 545 546
/*!\brief  scheduler mode */
typedef enum {
    SCHED_MODE_DEFAULT = 0,			/// default cheduler
    SCHED_MODE_FAIR_RR			/// fair raund robin
} SCHEDULER_MODES;

547

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

Cedric Roux's avatar
Cedric Roux committed
574
    /// num CCCH PDU per CC
575
    uint32_t total_num_ccch_pdu;
Cedric Roux's avatar
Cedric Roux committed
576
    /// BCCH buffer size
577
    uint32_t ccch_buffer;
Cedric Roux's avatar
Cedric Roux committed
578
    /// total BCCH buffer size
579 580 581
    uint32_t total_ccch_buffer;
    /// BCCH MCS
    uint32_t ccch_mcs;
582

583 584 585 586 587 588
  /// 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;
589
  /// BCCH MCS
590
  uint32_t pcch_mcs;
591 592

/// num active users
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 627 628 629 630 631 632 633 634
    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;
635

636
} eNB_STATS;
637
/*! \brief eNB statistics for the connected UEs*/
638
typedef struct {
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 670 671 672 673 674 675 676 677
    /// 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
678
    // Number of received MAC SDU
679 680 681 682 683
    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
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 723 724 725 726 727 728 729

    /// 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;
Cedric Roux's avatar
Cedric Roux committed
730

731
    uint32_t total_ulsch_TBS;
732 733 734 735 736 737 738 739 740

    ///  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
741
    /// normalized rx power
742
    int32_t normalized_rx_power;
Cedric Roux's avatar
Cedric Roux committed
743
    /// target rx power
744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772
    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;
773 774 775 776
    // 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];
777

778
} eNB_UE_STATS;
779
/*! \brief eNB template for UE context information  */
780
typedef struct {
781 782 783 784 785 786 787 788 789 790 791 792 793
    /// 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
794
    int TBS_UL[8];
795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820
    /// 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
821
    uint8_t pre_allocated_nb_rb_ul[MAX_NUM_SLICES];
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

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

852 853 854
	///UE logical channel priority
    long lcgidpriority[11];

855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872
    /// 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
873
    /// a flag indicating that the downlink head SDU is segmented
874 875 876 877 878 879 880 881 882 883 884
    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];

885 886 887 888 889
    /// uplink bytes that are currently scheduled
    int scheduled_ul_bytes;
    /// estimation of the UL buffer size
    int estimated_ul_buffer;

890 891
    /// UE tx power
    int32_t ue_tx_power;
892

893 894 895 896 897
    /// 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
898

899
#ifdef LOCALIZATION
900
    eNB_UE_estimated_distances distance;
901
#endif
902

903
#if (RRC_VERSION >= MAKE_VERSION(14, 0, 0))
904 905 906
    uint8_t rach_resource_type;
    uint16_t mpdcch_repetition_cnt;
    frame_t Msg2_frame;
907
#endif
908
    sub_frame_t Msg2_subframe;
909

910
    PhysicalConfigDedicated_t *physicalConfigDedicated;
911

912 913
} UE_TEMPLATE;

914
/*! \brief scheduling control information set through an API (not used)*/
915
typedef struct {
916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934
    ///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;

935 936
    uint16_t max_rbs_allowed_slice[NFAPI_CC_MAX][MAX_NUM_SLICES];
    uint16_t max_rbs_allowed_slice_uplink[NFAPI_CC_MAX][MAX_NUM_SLICES];
937 938 939 940 941 942 943 944

    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
945
    uint8_t round[NFAPI_CC_MAX][10];
946
    /// Current Active TBs per harq_pid on each CC
947
    uint8_t tbcnt[NFAPI_CC_MAX][10];
948
    /// Current UL harq round per harq_pid on each CC
949 950 951 952
    uint8_t round_UL[NFAPI_CC_MAX][8];
    uint8_t dl_pow_off[NFAPI_CC_MAX];
    uint16_t pre_nb_available_rbs[NFAPI_CC_MAX];
    unsigned char rballoc_sub_UE[NFAPI_CC_MAX][N_RBG_MAX];
953 954 955 956
    uint16_t ta_timer;
    int16_t ta_update;
    uint16_t ul_consecutive_errors;
    int32_t context_active_timer;
957
    /// timer for regular CQI request on PUSCH
958
    int32_t cqi_req_timer;
959 960
    /// indicator that CQI was received on PUSCH when requested
    int32_t cqi_received;
961 962
    int32_t ul_inactivity_timer;
    int32_t ul_failure_timer;
963 964
    uint32_t ue_reestablishment_reject_timer;
    uint32_t ue_reestablishment_reject_timer_thres;
965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995
    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];
Xu Bo's avatar
Xu Bo committed
996 997
    int32_t uplane_inactivity_timer;
    uint8_t crnti_reconfigurationcomplete_flag;
998
    uint8_t cqi_req_flag;
999
} UE_sched_ctrl;
1000
/*! \brief eNB template for the Random access information */
1001
typedef struct {
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 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049
    /// 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;
1050
#if (RRC_VERSION >= MAKE_VERSION(14, 0, 0))
1051 1052 1053 1054 1055
    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;
1056
#endif
Xu Bo's avatar
Xu Bo committed
1057 1058
    int32_t  crnti_rrc_mui;
    int8_t   crnti_harq_pid;
1059
} RA_t;
1060 1061


1062
/*! \brief subband bitmap confguration (for ALU icic algo purpose), in test phase */
1063
typedef struct {
1064
    uint8_t sbmap[13];	//13 = number of SB MAX for 100 PRB
1065 1066 1067 1068
    uint8_t periodicity;
    uint8_t first_subframe;
    uint8_t sb_size;
    uint8_t nb_active_sb;
1069
} SBMAP_CONF;
1070
/*! \brief UE list used by eNB to order UEs/CC for scheduling*/
1071
typedef struct {
1072 1073
    /// Dedicated information for UEs
    struct PhysicalConfigDedicated
1074
	*physicalConfigDedicated[NFAPI_CC_MAX][MAX_MOBILES_PER_ENB];
Cedric Roux's avatar
Cedric Roux committed
1075
    /// DLSCH pdu
1076
    DLSCH_PDU DLSCH_pdu[NFAPI_CC_MAX][2][MAX_MOBILES_PER_ENB];
1077
    /// DCI template and MAC connection parameters for UEs
1078
    UE_TEMPLATE UE_template[NFAPI_CC_MAX][MAX_MOBILES_PER_ENB];
1079
    /// DCI template and MAC connection for RA processes
1080
    int pCC_id[MAX_MOBILES_PER_ENB];
Cedric Roux's avatar
Cedric Roux committed
1081
    /// sorted downlink component carrier for the scheduler
1082
    int ordered_CCids[NFAPI_CC_MAX][MAX_MOBILES_PER_ENB];
Cedric Roux's avatar
Cedric Roux committed
1083
    /// number of downlink active component carrier
1084
    int numactiveCCs[MAX_MOBILES_PER_ENB];
Cedric Roux's avatar
Cedric Roux committed
1085
    /// sorted uplink component carrier for the scheduler
1086
    int ordered_ULCCids[NFAPI_CC_MAX][MAX_MOBILES_PER_ENB];
Cedric Roux's avatar
Cedric Roux committed
1087
    /// number of uplink active component carrier
1088
    int numactiveULCCs[MAX_MOBILES_PER_ENB];
Cedric Roux's avatar
Cedric Roux committed
1089
    /// number of downlink active component carrier
1090
    uint8_t dl_CC_bitmap[MAX_MOBILES_PER_ENB];
1091
    /// eNB to UE statistics
1092
    eNB_UE_STATS eNB_UE_stats[NFAPI_CC_MAX][MAX_MOBILES_PER_ENB];
1093
    /// scheduling control info
1094 1095
    UE_sched_ctrl UE_sched_ctrl[MAX_MOBILES_PER_ENB];
    int next[MAX_MOBILES_PER_ENB];
1096
    int head;
1097
    int next_ul[MAX_MOBILES_PER_ENB];
1098 1099 1100
    int head_ul;
    int avail;
    int num_UEs;
1101
    boolean_t active[MAX_MOBILES_PER_ENB];
1102 1103 1104

    /// Sorting criteria for the UE list in the MAC preprocessor
    uint16_t sorting_criteria[MAX_NUM_SLICES][CR_NUM];
Niccolò Iardella's avatar
Niccolò Iardella committed
1105
    uint16_t first_rb_offset[NFAPI_CC_MAX][MAX_NUM_SLICES];
1106

1107 1108
    int assoc_dl_slice_idx[MAX_MOBILES_PER_ENB];
    int assoc_ul_slice_idx[MAX_MOBILES_PER_ENB];
1109

Raymond Knopp's avatar
 
Raymond Knopp committed
1110
} UE_list_t;
1111

1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127
/*! \brief deleting control information*/
typedef struct {
    ///rnti of UE
    rnti_t rnti;
    ///remove UE context flag
    boolean_t removeContextFlg;
} UE_free_ctrl;
/*! \brief REMOVE UE list used by eNB to order UEs/CC for deleting*/
typedef struct {
    /// deleting control info
    UE_free_ctrl UE_free_ctrl[NUMBER_OF_UE_MAX+1];
    int num_UEs;
    int head_freelist; ///the head position of the delete list
    int tail_freelist; ///the tail position of the delete list
} UE_free_list_t;

1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145
/// Structure for saving the output of each pre_processor instance
typedef struct {
    uint16_t nb_rbs_required[NFAPI_CC_MAX][MAX_MOBILES_PER_ENB];
    uint16_t nb_rbs_accounted[NFAPI_CC_MAX][MAX_MOBILES_PER_ENB];
    uint16_t nb_rbs_remaining[NFAPI_CC_MAX][MAX_MOBILES_PER_ENB];
    uint8_t  slice_allocation_mask[NFAPI_CC_MAX][N_RBG_MAX];
    uint8_t  MIMO_mode_indicator[NFAPI_CC_MAX][N_RBG_MAX];

    uint32_t bytes_lcid[MAX_MOBILES_PER_ENB][MAX_NUM_LCID];
    uint32_t wb_pmi[NFAPI_CC_MAX][MAX_MOBILES_PER_ENB];
    uint8_t  mcs[NFAPI_CC_MAX][MAX_MOBILES_PER_ENB];

} pre_processor_results_t;

/**
 * slice specific scheduler for the DL
 */
typedef void (*slice_scheduler_dl)(module_id_t mod_id,
1146
                                   int         slice_idx,
1147 1148 1149 1150 1151
                                   frame_t     frame,
                                   sub_frame_t subframe,
                                   int        *mbsfn_flag);

typedef struct {
1152 1153
    slice_id_t id;

1154
    /// RB share for each slice
1155 1156
    float     pct;

1157
    /// whether this slice is isolated from the others
1158 1159 1160 1161 1162 1163 1164 1165
    int       isol;

    int       prio;

    /// Frequency ranges for slice positioning
    int       pos_low;
    int       pos_high;

1166
    // max mcs for each slice
1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183
    int       maxmcs;

    /// criteria for sorting policies of the slices
    uint32_t  sorting;

    /// Accounting policy (just greedy(1) or fair(0) setting for now)
    int       accounting;

    /// name of available scheduler
    char     *sched_name;

    /// pointer to the slice specific scheduler in DL
    slice_scheduler_dl sched_cb;

} slice_sched_conf_dl_t;

typedef void (*slice_scheduler_ul)(module_id_t   mod_id,
1184
                                   int           slice_idx,
1185 1186 1187 1188 1189 1190
                                   frame_t       frame,
                                   sub_frame_t   subframe,
                                   unsigned char sched_subframe,
                                   uint16_t     *first_rb);

typedef struct {
1191 1192
    slice_id_t id;

1193
    /// RB share for each slice
1194 1195
    float     pct;

1196
    // MAX MCS for each slice
1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215
    int       maxmcs;

    /// criteria for sorting policies of the slices
    uint32_t  sorting;

    /// starting RB (RB offset) of UL scheduling
    int       first_rb;

    /// name of available scheduler
    char     *sched_name;

    /// pointer to the slice specific scheduler in UL
    slice_scheduler_ul sched_cb;

} slice_sched_conf_ul_t;


typedef struct {
    /// counter used to indicate when all slices have pre-allocated UEs
1216
    //int      slice_counter;
1217 1218 1219 1220 1221 1222 1223 1224

    /// indicates whether remaining RBs after first intra-slice allocation will
    /// be allocated to UEs of the same slice
    int       intraslice_share_active;
    /// indicates whether remaining RBs after slice allocation will be
    /// allocated to UEs of another slice. Isolated slices will be ignored
    int       interslice_share_active;

1225
    /// number of active DL slices
1226 1227 1228
    int      n_dl;
    slice_sched_conf_dl_t dl[MAX_NUM_SLICES];

1229
    /// number of active UL slices
1230 1231 1232 1233
    int      n_ul;
    slice_sched_conf_ul_t ul[MAX_NUM_SLICES];

    pre_processor_results_t pre_processor_results[MAX_NUM_SLICES];
1234 1235 1236

    /// common rb allocation list between slices
    uint8_t rballoc_sub[NFAPI_CC_MAX][N_RBG_MAX];
1237 1238
} slice_info_t;

1239
/*! \brief eNB common channels */
1240
typedef struct {
1241 1242 1243 1244 1245 1246 1247
    int physCellId;
    int p_eNB;
    int Ncp;
    int eutra_band;
    uint32_t dl_CarrierFreq;
    BCCH_BCH_Message_t *mib;
    RadioResourceConfigCommonSIB_t *radioResourceConfigCommon;
1248
#if (RRC_VERSION >= MAKE_VERSION(14, 0, 0))
1249
    RadioResourceConfigCommonSIB_t *radioResourceConfigCommon_BR;
1250
#endif
1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262
    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;
1263 1264 1265 1266
    /// Outgoing PCCH DCI allocation
    uint32_t PCCH_alloc_pdu;
    /// Outgoing PCCH pdu for PHY
    PCCH_PDU PCCH_pdu;
1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278
    /// 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;
1279
#if (RRC_VERSION >= MAKE_VERSION(10, 0, 0))
1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299
    /// 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;
1300
#endif
1301
#if (RRC_VERSION >= MAKE_VERSION(13, 0, 0))
1302 1303 1304 1305 1306 1307
    /// 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];
1308
#endif
1309
} COMMON_channels_t;
1310
/*! \brief top level eNB MAC structure */
1311
typedef struct eNB_MAC_INST_s {
1312
    /// Ethernet parameters for northbound midhaul interface
1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326
  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[NFAPI_CC_MAX];
  /// current PDU index (BCH,MCH,DLSCH)
1327
  int16_t pdu_index[NFAPI_CC_MAX];
1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347
  
  /// NFAPI Config Request Structure
  nfapi_config_request_t config[NFAPI_CC_MAX];
  /// Preallocated DL pdu list
  nfapi_dl_config_request_pdu_t
  dl_config_pdu_list[NFAPI_CC_MAX][MAX_NUM_DL_PDU];
  /// NFAPI DL Config Request Structure
  nfapi_dl_config_request_t DL_req[NFAPI_CC_MAX];
  /// Preallocated UL pdu list
  nfapi_ul_config_request_pdu_t
  ul_config_pdu_list[NFAPI_CC_MAX][MAX_NUM_UL_PDU];
  /// Preallocated UL pdu list for ULSCH (n+k delay)
  nfapi_ul_config_request_pdu_t
  ul_config_pdu_list_tmp[NFAPI_CC_MAX][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[NFAPI_CC_MAX];
  /// NFAPI "Temporary" UL Config Request Structure, holds future UL_config requests
  nfapi_ul_config_request_t UL_req_tmp[NFAPI_CC_MAX][10];
  /// Preallocated HI_DCI0 pdu list
  nfapi_hi_dci0_request_pdu_t
1348
  hi_dci0_pdu_list[NFAPI_CC_MAX][10][MAX_NUM_HI_DCI0_PDU];
1349
  /// NFAPI HI/DCI0 Config Request Structure
1350
  nfapi_hi_dci0_request_t HI_DCI0_req[NFAPI_CC_MAX][10];
1351 1352 1353 1354 1355 1356 1357 1358
  /// Prealocated TX pdu list
  nfapi_tx_request_pdu_t
  tx_request_pdu[NFAPI_CC_MAX][MAX_NUM_TX_REQUEST_PDU];
  /// NFAPI DL PDU structure
  nfapi_tx_request_t TX_req[NFAPI_CC_MAX];
  /// UL handle
  uint32_t ul_handle;
  UE_list_t UE_list;
1359 1360 1361 1362

  /// slice-related configuration
  slice_info_t slice_info;

1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391
  ///subband bitmap configuration
  SBMAP_CONF sbmap_conf;
  /// CCE table used to build DCI scheduling information
  int CCE_table[NFAPI_CC_MAX][800];
  ///  active flag for Other lcid
  uint8_t lcid_active[NB_RB_MAX];
  /// eNB stats
  eNB_STATS eNB_stats[NFAPI_CC_MAX];
  // MAC function execution peformance profiler
  /// processing time of eNB scheduler
  time_stats_t eNB_scheduler;
  /// processing time of eNB scheduler for SI
  time_stats_t schedule_si;
  /// processing time of eNB scheduler for Random access
  time_stats_t schedule_ra;
  /// processing time of eNB ULSCH scheduler
  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;
  /// processing time of eNB DLSCH scheduler
  time_stats_t schedule_dlsch;	// include rlc_data_req + MAC header + preprocessor
  /// processing time of eNB MCH scheduler
  time_stats_t schedule_mch;
  /// processing time of eNB ULSCH reception
  time_stats_t rx_ulsch_sdu;	// include rlc_data_ind
  /// processing time of eNB PCH scheduler
  time_stats_t schedule_pch;
1392 1393 1394 1395

  UE_free_list_t UE_free_list;
  /// for scheduling selection
  SCHEDULER_MODES scheduler_mode;
1396

1397 1398
  int32_t puSch10xSnr;
  int32_t puCch10xSnr;
1399
} eNB_MAC_INST;
1400

Cedric Roux's avatar
Cedric Roux committed
1401 1402
/*
 * UE part
1403
 */
1404

1405
typedef enum {
1406 1407 1408 1409 1410 1411
    TYPE0,
    TYPE1,
    TYPE1A,
    TYPE2,
    TYPE2A,
    TYPEUESPEC
1412 1413
} MPDCCH_TYPES_t;

1414 1415
/*!\brief UE layer 2 status */
typedef enum {
1416 1417 1418 1419
    CONNECTION_OK = 0,
    CONNECTION_LOST,
    PHY_RESYNCH,
    PHY_HO_PRACH
1420 1421 1422
} UE_L2_STATE_t;

/*!\brief UE scheduling info */
1423
typedef struct {
1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481
    /// 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];
1482
} UE_SCHEDULING_INFO;
1483
/*!\brief Top level UE MAC structure */
1484
typedef struct {
1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505
    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;
1506
#if (RRC_VERSION >= MAKE_VERSION(10, 0, 0))
1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535
  /// pointer to RRC PHY configuration SCEll
  struct PhysicalConfigDedicatedSCell_r10 *physicalConfigDedicatedSCell_r10;
  /// 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;
  //SL sourceL2ID
  uint32_t sourceL2Id;
  //SL groupL2Id
  uint32_t groupL2Id;
  //SL destinationL2Id
  uint32_t destinationL2Id;
  //List of destinations
  uint32_t destinationList[MAX_NUM_DEST];
  uint8_t numCommFlows;
  uint32_t  SL_LCID[MAX_NUM_LCID];

1536
#endif
1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555
    /// pointer to TDD Configuration (NULL for FDD)
    TDD_Config_t *tdd_Config;
    /// Number of adjacent cells to measure
    uint8_t n_adj_cells;
    /// Array of adjacent physical cell ids
    uint32_t adj_cell_id[6];
    /// 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];
    /// Scheduling Information
    UE_SCHEDULING_INFO scheduling_info;
    /// Outgoing CCCH pdu for PHY
    CCCH_PDU CCCH_pdu;
    /// Outgoing RAR pdu for PHY
    RAR_PDU RAR_pdu;
    /// Incoming DLSCH pdu for PHY
1556
    DLSCH_PDU DLSCH_pdu[MAX_MOBILES_PER_ENB][2];
1557 1558 1559 1560 1561 1562
#if (RRC_VERSION >= MAKE_VERSION(14, 0, 0))
    int sltx_active;
    SLSCH_t slsch;
    SLDCH_t sldch;
    ULSCH_PDU slsch_pdu;
    int slsch_lcid;
1563
#endif
1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603
    /// number of attempt for rach
    uint8_t RA_attempt_number;
    /// Random-access procedure flag
    uint8_t RA_active;
    /// Random-access window counter
    int8_t RA_window_cnt;
    /// Random-access Msg3 size in bytes
    uint8_t RA_Msg3_size;
    /// Random-access prachMaskIndex
    uint8_t RA_prachMaskIndex;
    /// Flag indicating Preamble set (A,B) used for first Msg3 transmission
    uint8_t RA_usedGroupA;
    /// Random-access Resources
    PRACH_RESOURCES_t RA_prach_resources;
    /// Random-access PREAMBLE_TRANSMISSION_COUNTER
    uint8_t RA_PREAMBLE_TRANSMISSION_COUNTER;
    /// Random-access backoff counter
    int16_t RA_backoff_cnt;
    /// Random-access variable for window calculation (frame of last change in window counter)
    uint32_t RA_tx_frame;
    /// Random-access variable for window calculation (subframe of last change in window counter)
    uint8_t RA_tx_subframe;
    /// Random-access Group B maximum path-loss
    /// Random-access variable for backoff (frame of last change in backoff counter)
    uint32_t RA_backoff_frame;
    /// Random-access variable for backoff (subframe of last change in backoff counter)
    uint8_t RA_backoff_subframe;
    /// Random-access Group B maximum path-loss
    uint16_t RA_maxPL;
    /// Random-access Contention Resolution Timer active flag
    uint8_t RA_contention_resolution_timer_active;
    /// Random-access Contention Resolution Timer count value
    uint8_t RA_contention_resolution_cnt;
    /// power headroom reporitng reconfigured
    uint8_t PHR_reconfigured;
    /// power headroom state as configured by the higher layers
    uint8_t PHR_state;
    /// power backoff due to power management (as allowed by P-MPRc) for this cell
    uint8_t PHR_reporting_active;
    /// power backoff due to power management (as allowed by P-MPRc) for this cell
1604
    uint8_t power_backoff_db[MAX_eNB];
1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615
    /// BSR report falg management
    uint8_t BSR_reporting_active;
    /// retxBSR-Timer expires flag
    uint8_t retxBSRTimer_expires_flag;
    /// periodBSR-Timer expires flag
    uint8_t periodBSRTimer_expires_flag;

    /// MBSFN_Subframe Configuration
    struct MBSFN_SubframeConfig *mbsfn_SubframeConfig[8];	// FIXME replace 8 by MAX_MBSFN_AREA?
    /// number of subframe allocation pattern available for MBSFN sync area
    uint8_t num_sf_allocation_pattern;
1616
#if (RRC_VERSION >= MAKE_VERSION(9, 0, 0))
1617 1618 1619 1620 1621 1622 1623 1624 1625
    /// 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
1626 1627 1628 1629 1630 1631 1632 1633 1634 1635
    uint8_t msi_status_v[28];
    uint8_t msi_current_alloc;
    uint8_t msi_pmch;

    struct MBSFN_SubframeConfig *commonSF_Alloc_r9_mbsfn_SubframeConfig[8]; // FIXME replace 8 by MAX_MBSFN_AREA?
    uint8_t commonSF_AllocPeriod_r9;
    int common_num_sf_alloc;

    uint8_t pmch_lcids[28];
    uint16_t pmch_stop_mtch[28];
1636
#endif
1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656
  //#ifdef CBA
  /// CBA RNTI for each group
  uint16_t cba_rnti[NUM_MAX_CBA_GROUP];
  /// last SFN for CBA channel access
  uint8_t cba_last_access[NUM_MAX_CBA_GROUP];
  //#endif
  /// total UE scheduler processing time
  time_stats_t ue_scheduler; // total
  /// UE ULSCH tx  processing time inlcuding RLC interface (rlc_data_req) and mac header generation
  time_stats_t tx_ulsch_sdu;
  /// 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
  time_stats_t rx_dlsch_sdu ;
  /// UE query for MCH subframe processing time
  time_stats_t ue_query_mch;
  /// UE MCH rx processing time
  time_stats_t rx_mch_sdu;
  /// 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)
  time_stats_t rx_p;
1657
  /// Mutex for nfapi UL_INFO
1658
  pthread_mutex_t      UL_INFO_mutex;
1659
  /// UE_Mode variable should be used in the case of Phy_stub operation since we won't have access to PHY_VARS_UE
1660 1661 1662
  /// where the UE_mode originally is for the full stack operation mode. The transitions between the states of the UE_Mode
  /// will be triggered within phy_stub_ue.c in this case
  UE_MODE_t        UE_mode[NUMBER_OF_CONNECTED_eNB_MAX];
1663
  /// Phy_stub mode: Boolean variable to distinguish whether a Msg3 or a regular ULSCH data pdu should be generated
1664 1665 1666 1667 1668 1669 1670 1671
  /// after the reception of NFAPI_UL_CONFIG_ULSCH_PDU_TYPE.
  uint8_t first_ULSCH_Tx;
  uint8_t SI_Decoded;
  int ra_frame; 	// This variable keeps the frame in which the RA started for the specific UE. It is used in order
                    // to make sure that different UEs RA starts within a number of frames difference.

  eth_params_t         eth_params_n;

1672
} UE_MAC_INST;
1673
/*! \brief ID of the neighboring cells used for HO*/
1674
typedef struct {
1675 1676
    uint16_t cell_ids[6];
    uint8_t n_adj_cells;
1677 1678
} neigh_cell_id_t;

1679 1680 1681 1682 1683 1684 1685 1686 1687 1688
typedef struct {
  volatile uint8_t flag;
  rnti_t rnti;
  mui_t  rrc_eNB_mui;
}RRC_release_ctrl;
 
typedef struct {
    uint16_t num_UEs;
    RRC_release_ctrl RRC_release_ctrl[NUMBER_OF_UE_MAX];
} RRC_release_list_t;
wujing's avatar
wujing committed
1689 1690 1691 1692 1693 1694

typedef  struct {
  uint8_t                      rrc_mui_num;
  mui_t                        rrc_mui[128];
}mac_rlc_am_muilist_t;

1695
#include "mac_proto.h"
1696

1697
/*@}*/
1698
#endif /*__LAYER2_MAC_DEFS_H__ */