defs.h 40.7 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
/*
 * Licensed to the OpenAirInterface (OAI) Software Alliance under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The OpenAirInterface Software Alliance licenses this file to You under
 * the OAI Public License, Version 1.0  (the "License"); you may not use this file
 * except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.openairinterface.org/?page_id=698
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *-------------------------------------------------------------------------------
 * For more information about the OpenAirInterface (OAI) Software Alliance:
 *      contact@openairinterface.org
 */

22
/*! \file LAYER2/MAC/defs.h
23
* \brief MAC data structures, constant, and function prototype
24
* \author Navid Nikaein and Raymond Knopp
25 26
* \date 2011
* \version 0.5
27
* \email navid.nikaein@eurecom.fr
28 29

*/
30 31 32 33
/** @defgroup _oai2  openair2 Reference Implementation
 * @ingroup _ref_implementation_
 * @{
 */
34

35
/*@}*/
36

37 38 39 40 41 42 43 44 45 46 47 48 49
#ifndef __LAYER2_MAC_DEFS_H__
#define __LAYER2_MAC_DEFS_H__



#ifdef USER_MODE
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#endif

//#include "COMMON/openair_defs.h"

50 51 52 53


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

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

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

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

87 88 89
#define SCH_PAYLOAD_SIZE_MAX 4096
/// Logical channel ids from 36-311 (Note BCCH is not specified in 36-311, uses the same as first DRB)

Cedric Roux's avatar
Cedric Roux committed
90
#if defined(Rel10) || defined(Rel14)
91

92
// Mask for identifying subframe for MBMS
93 94 95 96 97 98 99 100 101 102 103 104 105 106
#define MBSFN_TDD_SF3 0x80// for TDD
#define MBSFN_TDD_SF4 0x40
#define MBSFN_TDD_SF7 0x20
#define MBSFN_TDD_SF8 0x10
#define MBSFN_TDD_SF9 0x08
#define MBSFN_FDD_SF1 0x80// for FDD
#define MBSFN_FDD_SF2 0x40
#define MBSFN_FDD_SF3 0x20
#define MBSFN_FDD_SF6 0x10
#define MBSFN_FDD_SF7 0x08
#define MBSFN_FDD_SF8 0x04

#define MAX_MBSFN_AREA 8
#define MAX_PMCH_perMBSFN 15
107
/*!\brief MAX MCCH payload size  */
108
#define MCCH_PAYLOAD_SIZE_MAX 128
109
//#define MCH_PAYLOAD_SIZE_MAX 16384// this value is using in case mcs and TBS index are high
110 111 112 113 114 115
#endif

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

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

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

150 151 152
#define LCID_EMPTY 0
#define LCID_NOT_EMPTY 1

Bilel's avatar
Bilel committed
153 154 155 156 157 158
/*!\brief minimum RLC PDU size to be transmitted = min RLC Status PDU or RLC UM PDU SN 5 bits */
#define MIN_RLC_PDU_SIZE    (2)

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

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

162 163 164
/* 
 * eNB part 
 */ 
165

166 167 168 169 170

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

177
/*!\brief  MAC header of Random Access Response for backoff indicator (BI)*/
178
typedef struct {
gauthier's avatar
gauthier committed
179 180 181 182
  uint8_t BI:4;
  uint8_t R:2;
  uint8_t T:1;
  uint8_t E:1;
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
} __attribute__((__packed__))RA_HEADER_BI;
/*
typedef struct {
  uint64_t padding:16;
  uint64_t t_crnti:16;
  uint64_t hopping_flag:1;
  uint64_t rb_alloc:10;
  uint64_t mcs:4;
  uint64_t TPC:3;
  uint64_t UL_delay:1;
  uint64_t cqi_req:1;
  uint64_t Timing_Advance_Command:11;  // first/2nd octet LSB
  uint64_t R:1;                        // octet MSB
  } __attribute__((__packed__))RAR_PDU;

typedef struct {
  uint64_t padding:16;
  uint64_t R:1;                        // octet MSB
  uint64_t Timing_Advance_Command:11;  // first/2nd octet LSB
  uint64_t cqi_req:1;
  uint64_t UL_delay:1;
  uint64_t TPC:3;
  uint64_t mcs:4;
  uint64_t rb_alloc:10;
  uint64_t hopping_flag:1;
  uint64_t t_crnti:16;
  } __attribute__((__packed__))RAR_PDU;

#define sizeof_RAR_PDU 6
*/
213
/*!\brief  MAC subheader short with 7bit Length field */
214
typedef struct {
gauthier's avatar
gauthier committed
215 216 217 218 219
  uint8_t LCID:5;  // octet 1 LSB
  uint8_t E:1;
  uint8_t R:2;     // octet 1 MSB
  uint8_t L:7;     // octet 2 LSB
  uint8_t F:1;     // octet 2 MSB
220
} __attribute__((__packed__))SCH_SUBHEADER_SHORT;
221
/*!\brief  MAC subheader long  with 15bit Length field */
222
typedef struct {
gauthier's avatar
gauthier committed
223 224 225 226 227 228 229
  uint8_t LCID:5;   // octet 1 LSB
  uint8_t E:1;
  uint8_t R:2;      // octet 1 MSB
  uint8_t L_MSB:7;
  uint8_t F:1;      // octet 2 MSB
  uint8_t L_LSB:8;
  uint8_t padding;
230
} __attribute__((__packed__))SCH_SUBHEADER_LONG;
231
/*!\brief MAC subheader short without length field */
232
typedef struct {
gauthier's avatar
gauthier committed
233 234 235
  uint8_t LCID:5;
  uint8_t E:1;
  uint8_t R:2;
236 237
} __attribute__((__packed__))SCH_SUBHEADER_FIXED;

238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264

// Panos:
/*!\brief  MAC subheader long  with 24bit DST field */
typedef struct {
	uint8_t   V:4; //Version number: Possible values "0001", "0010", "0011" based on TS36.321 section 6.2.3.
	uint32_t  SRC:24; //Prose UE source ID. Size 24 bits.
	uint32_t  DST:24; //Prose UE destination ID. Size 16 or 24 bits.
	uint8_t   LCID:5;
	uint8_t   L:7;	// Length field indicating the size of the corresponding SDU in byes. Not sure about the size of this field (7).
	uint8_t	  F:1;
	uint8_t	  E:1;
	uint8_t	  R:1;
}__attribute__((__packed__))SLSCH_SUBHEADER_24_Bit_DST;

/*!\brief  MAC subheader long  with 16bit DST field */
typedef struct {
	uint8_t   V:4; //Version number: Possible values "0001", "0010", "0011" based on TS36.321 section 6.2.3.
	uint32_t  SRC:24; //Prose UE source ID. Size 24 bits.
	uint32_t  DST:16; //Prose UE destination ID. Size 16 or 24 bits.
	uint8_t   LCID:5;
	uint8_t   L:7;	// Length field indicating the size of the corresponding SDU in byes. Not sure about the size of this field (7).
	uint8_t	  F:1;
	uint8_t	  E:1;
	uint8_t	  R:1;
}__attribute__((__packed__))SLSCH_SUBHEADER_16_Bit_DST;


265
/*!\brief  mac control element: short buffer status report for a specific logical channel group ID*/
266
typedef struct {
gauthier's avatar
gauthier committed
267 268
  uint8_t Buffer_size:6;  // octet 1 LSB
  uint8_t LCGID:2;        // octet 1 MSB
269 270 271
} __attribute__((__packed__))BSR_SHORT;

typedef BSR_SHORT BSR_TRUNCATED;
272
/*!\brief  mac control element: long buffer status report for all logical channel group ID*/
273
typedef struct {
fnabet's avatar
fnabet committed
274 275 276 277
  uint8_t Buffer_size3:6;
  uint8_t Buffer_size2:6;
  uint8_t Buffer_size1:6;
  uint8_t Buffer_size0:6;
278 279
} __attribute__((__packed__))BSR_LONG;

280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303
// 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;



304
#define BSR_LONG_SIZE  (sizeof(BSR_LONG))
305
/*!\brief  mac control element: timing advance  */
306
typedef struct {
gauthier's avatar
gauthier committed
307 308
  uint8_t TA:6;
  uint8_t R:2;
309
} __attribute__((__packed__))TIMING_ADVANCE_CMD;
310
/*!\brief  mac control element: power headroom report  */
311
typedef struct {
gauthier's avatar
gauthier committed
312 313
  uint8_t PH:6;
  uint8_t R:2;
314 315
} __attribute__((__packed__))POWER_HEADROOM_CMD;

316
/*! \brief MIB payload */
317
typedef struct {
318 319
  uint8_t payload[3] ;
} __attribute__((__packed__))MIB_PDU;
320
/*! \brief CCCH payload */
321
typedef struct {
322
  uint8_t payload[CCCH_PAYLOAD_SIZE_MAX] ;
323
} __attribute__((__packed__))CCCH_PDU;
324
/*! \brief BCCH payload */
325
typedef struct {
326
  uint8_t payload[BCCH_PAYLOAD_SIZE_MAX] ;
327
} __attribute__((__packed__))BCCH_PDU;
328 329 330 331
/*! \brief RAR payload */
typedef struct {
  uint8_t payload[RAR_PAYLOAD_SIZE_MAX];
} __attribute__ ((__packed__)) RAR_PDU;
332 333 334 335
/*! \brief BCCH payload */
typedef struct {
  uint8_t payload[PCCH_PAYLOAD_SIZE_MAX] ;
} __attribute__((__packed__))PCCH_PDU;
336

Cedric Roux's avatar
Cedric Roux committed
337
#if defined(Rel10) || defined(Rel14)
338
/*! \brief MCCH payload */
339
typedef struct {
340
  uint8_t payload[MCCH_PAYLOAD_SIZE_MAX] ;
341
} __attribute__((__packed__))MCCH_PDU;
342
/*!< \brief MAC control element for activation and deactivation of component carriers */
343 344 345 346 347 348 349 350 351 352
typedef struct {
  uint8_t C7:1;/*!< \brief Component carrier 7 */
  uint8_t C6:1;/*!< \brief Component carrier 6 */
  uint8_t C5:1;/*!< \brief Component carrier 5 */
  uint8_t C4:1;/*!< \brief Component carrier 4 */
  uint8_t C3:1;/*!< \brief Component carrier 3 */
  uint8_t C2:1;/*!< \brief Component carrier 2 */
  uint8_t C1:1;/*!< \brief Component carrier 1 */
  uint8_t R:1;/*!< \brief Reserved  */
} __attribute__((__packed__))CC_ELEMENT;
353
/*! \brief MAC control element: MCH Scheduling Information */
354
typedef struct {
gauthier's avatar
gauthier committed
355 356 357
  uint8_t stop_sf_MSB:3; // octet 1 LSB
  uint8_t lcid:5;        // octet 2 MSB
  uint8_t stop_sf_LSB:8;
358
} __attribute__((__packed__))MSI_ELEMENT;
359 360
#endif
/*! \brief Values of CCCH LCID for DLSCH */ 
361
#define CCCH_LCHANID 0
362
/*!\brief Values of BCCH logical channel (fake)*/
363
#define BCCH 3  // SI 
364
/*!\brief Values of PCCH logical channel (fake)*/
365
#define PCCH 4  // Paging 
366 367
/*!\brief Values of PCCH logical channel (fake) */
#define MIBCH 5  // MIB 
368 369 370 371
/*!\brief Values of BCCH SIB1_BR logical channel (fake) */
#define BCCH_SIB1_BR 6  // SIB1_BR 
/*!\brief Values of BCCH SIB_BR logical channel (fake) */
#define BCCH_SI_BR 7  // SI-BR 
372 373 374 375 376 377 378 379 380 381 382 383 384 385
/*!\brief Value of CCCH / SRB0 logical channel */
#define CCCH 0  // srb0
/*!\brief DCCH / SRB1 logical channel */
#define DCCH 1  // srb1
/*!\brief DCCH1 / SRB2  logical channel */
#define DCCH1 2 // srb2
/*!\brief DTCH DRB1  logical channel */
#define DTCH 3 // LCID
/*!\brief MCCH logical channel */
#define MCCH 4 
/*!\brief MTCH logical channel */
#define MTCH 1 
// DLSCH LCHAN ID
/*!\brief LCID of UE contention resolution identity for DLSCH*/
386
#define UE_CONT_RES 28
387
/*!\brief LCID of timing advance for DLSCH */
388
#define TIMING_ADV_CMD 29
389
/*!\brief LCID of discontinous reception mode for DLSCH */
390
#define DRX_CMD 30
391
/*!\brief LCID of padding LCID for DLSCH */
392 393
#define SHORT_PADDING 31

Cedric Roux's avatar
Cedric Roux committed
394
#if defined(Rel10) || defined(Rel14)
395
// MCH LCHAN IDs (table6.2.1-4 TS36.321)
396
/*!\brief LCID of MCCH for DL */
397
#define MCCH_LCHANID 0
398 399 400
/*!\brief LCID of MCH scheduling info for DL */
#define MCH_SCHDL_INFO 3
/*!\brief LCID of Carrier component activation/deactivation */
401
#define CC_ACT_DEACT 27
402 403 404
#endif

// ULSCH LCHAN IDs
405
/*!\brief LCID of extended power headroom for ULSCH */
406
#define EXTENDED_POWER_HEADROOM 25
407
/*!\brief LCID of power headroom for ULSCH */
408
#define POWER_HEADROOM 26
409
/*!\brief LCID of CRNTI for ULSCH */
410
#define CRNTI 27
411
/*!\brief LCID of truncated BSR for ULSCH */
412
#define TRUNCATED_BSR 28
413
/*!\brief LCID of short BSR for ULSCH */
414
#define SHORT_BSR 29
415
/*!\brief LCID of long BSR for ULSCH */
416
#define LONG_BSR 30
fnabet's avatar
fnabet committed
417 418 419 420 421
/*!\bitmaps for BSR Triggers */
#define	BSR_TRIGGER_NONE		(0)			/* No BSR Trigger */
#define	BSR_TRIGGER_REGULAR		(1)			/* For Regular and ReTxBSR Expiry Triggers */
#define	BSR_TRIGGER_PERIODIC	(2)			/* For BSR Periodic Timer Expiry Trigger */
#define	BSR_TRIGGER_PADDING		(4)			/* For Padding BSR Trigger */
422 423


424
/*! \brief Downlink SCH PDU Structure */
425
typedef struct {
426
  uint8_t payload[8][SCH_PAYLOAD_SIZE_MAX];
gauthier's avatar
gauthier committed
427
  uint16_t Pdu_size[8];
428 429
} __attribute__ ((__packed__)) DLSCH_PDU;

430

431
/*! \brief MCH PDU Structure */
432
typedef struct {
gauthier's avatar
gauthier committed
433 434
  int8_t payload[SCH_PAYLOAD_SIZE_MAX];
  uint16_t Pdu_size;
435
  uint8_t mcs;
436 437 438
  uint8_t sync_area;
  uint8_t msi_active;
  uint8_t mcch_active;
439
  uint8_t mtch_active;
440 441
} __attribute__ ((__packed__)) MCH_PDU;

442
/*! \brief Uplink SCH PDU Structure */
443
typedef struct {
gauthier's avatar
gauthier committed
444 445
  int8_t payload[SCH_PAYLOAD_SIZE_MAX];         /*!< \brief SACH payload */
  uint16_t Pdu_size;
446 447 448 449
} __attribute__ ((__packed__)) ULSCH_PDU;

#include "PHY/impl_defs_top.h"

450
/*!\brief  UE ULSCH scheduling states*/
451 452 453
typedef enum {
  S_UL_NONE =0,
  S_UL_WAITING,
454 455
  S_UL_SCHEDULED,
  S_UL_BUFFERED,
456 457 458
  S_UL_NUM_STATUS
} UE_ULSCH_STATUS;

459
/*!\brief  UE DLSCH scheduling states*/
460 461 462
typedef enum {
  S_DL_NONE =0,
  S_DL_WAITING,
463 464
  S_DL_SCHEDULED,
  S_DL_BUFFERED,
465 466 467
  S_DL_NUM_STATUS
} UE_DLSCH_STATUS;

468
/*!\brief  scheduling policy for the contention-based access */
469
typedef enum {
470 471 472 473 474
  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
475 476 477
} CBA_POLICY;


478
/*! \brief temporary struct for ULSCH sched */
479
typedef struct {
gauthier's avatar
gauthier committed
480
  rnti_t rnti;
gauthier's avatar
gauthier committed
481 482
  uint16_t subframe;
  uint16_t serving_num;
483 484
  UE_ULSCH_STATUS status;
} eNB_ULSCH_INFO;
485
/*! \brief temp struct for DLSCH sched */
486
typedef struct {
gauthier's avatar
gauthier committed
487
  rnti_t rnti;
gauthier's avatar
gauthier committed
488 489 490
  uint16_t weight;
  uint16_t subframe;
  uint16_t serving_num;
491 492
  UE_DLSCH_STATUS status;
} eNB_DLSCH_INFO;
493
/*! \brief eNB overall statistics */
494
typedef struct {
495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513
  /// num BCCH PDU per CC 
  uint32_t total_num_bcch_pdu;
  /// BCCH buffer size  
  uint32_t bcch_buffer;
  /// total BCCH buffer size  
  uint32_t total_bcch_buffer;
  /// BCCH MCS
  uint32_t bcch_mcs;

  /// num CCCH PDU per CC 
  uint32_t total_num_ccch_pdu;
  /// BCCH buffer size  
  uint32_t ccch_buffer;
  /// total BCCH buffer size  
  uint32_t total_ccch_buffer;
  /// BCCH MCS
  uint32_t ccch_mcs;

/// num active users
514 515 516 517 518
  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;
519 520
  /// aggregation
  /// total avilable nccc : num control channel element
521
  uint16_t available_ncces;
522 523
  // only for a new transmission, should be extended for retransmission
  // current dlsch  bit rate for all transport channels
524 525 526 527 528
  uint32_t dlsch_bitrate;
  //
  uint32_t dlsch_bytes_tx;
  //
  uint32_t dlsch_pdus_tx;
529
  //
530 531 532 533 534
  uint32_t total_dlsch_bitrate;
  //
  uint32_t total_dlsch_bytes_tx;
  //
  uint32_t total_dlsch_pdus_tx;
535 536
  
  // here for RX
537 538 539 540 541
  //
  uint32_t ulsch_bitrate;
  //
  uint32_t ulsch_bytes_rx;
  //
542 543 544 545 546 547 548 549
  uint64_t ulsch_pdus_rx; 

  uint32_t total_ulsch_bitrate;
  //
  uint32_t total_ulsch_bytes_rx;
  //
  uint32_t total_ulsch_pdus_rx;
  
550 551 552 553 554 555 556
  
  /// MAC agent-related stats
  /// total number of scheduling decisions
  int sched_decisions;
  /// missed deadlines
  int missed_deadlines;

557
} eNB_STATS;
558
/*! \brief eNB statistics for the connected UEs*/
559
typedef struct {
560 561

  /// CRNTI of UE
gauthier's avatar
gauthier committed
562
  rnti_t crnti; ///user id (rnti) of connected UEs
563
  // rrc status
564 565 566
  uint8_t rrc_status;
  /// harq pid
  uint8_t harq_pid;
567
  /// harq rounf
568
  uint8_t harq_round;
569
  /// DL Wideband CQI index (2 TBs)
570 571 572 573 574
  uint8_t dl_cqi;
  /// total available number of PRBs for a new transmission
  uint16_t rbs_used;
  /// total available number of PRBs for a retransmission
  uint16_t rbs_used_retx;
575
  /// total nccc used for a new transmission: num control channel element
576
  uint16_t ncce_used;
577
  /// total avilable nccc for a retransmission: num control channel element
578
  uint16_t ncce_used_retx;
579 580

  // mcs1 before the rate adaptaion
581
  uint8_t dlsch_mcs1;
582
  /// Target mcs2 after rate-adaptation
583
  uint8_t dlsch_mcs2;
584
  //  current TBS with mcs2
585
  uint32_t TBS;
586
  //  total TBS with mcs2
587
  //  uint32_t total_TBS;
588
  //  total rb used for a new transmission
589
  uint32_t total_rbs_used;
590
  //  total rb used for retransmission
591
  uint32_t total_rbs_used_retx;
592

593
   /// TX
594 595 596 597 598 599 600 601
  /// 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];
602 603

  /// overall
604
  //
605 606 607 608
  uint32_t  dlsch_bitrate;
  //total
  uint32_t  total_dlsch_bitrate;
  /// headers+ CE +  padding bytes for a MAC PDU
609
  uint64_t overhead_bytes;
610
  /// headers+ CE +  padding bytes for a MAC PDU
611
  uint64_t total_overhead_bytes;
612
  /// headers+ CE +  padding bytes for a MAC PDU
613
  uint64_t avg_overhead_bytes;
614
  // MAC multiplexed payload
615 616 617
  uint64_t total_sdu_bytes;
  // total MAC pdu bytes
  uint64_t total_pdu_bytes;
618

619 620 621 622
  // total num pdu
  uint32_t total_num_pdus;
  //
  //  uint32_t avg_pdu_size;
623 624

  /// RX
625

626 627 628 629 630 631
  /// 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;
632 633 634 635 636
  /// preassigned mcs after rate adaptation
  uint8_t ulsch_mcs1;
  /// adjusted mcs
  uint8_t ulsch_mcs2;

637 638 639 640
  /// estimated average pdu inter-departure time
  uint32_t avg_pdu_idt;
  /// estimated average pdu size
  uint32_t avg_pdu_ps;
641
  ///
642 643
  uint32_t aggregated_pdu_size;
  uint32_t aggregated_pdu_arrival;
644

645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660
  ///  uplink transport block size
  uint32_t ulsch_TBS;

  ///  total rb used for a new uplink transmission
  uint32_t num_retransmission_rx;
  ///  total rb used for a new uplink transmission
  uint32_t rbs_used_rx;
   ///  total rb used for a new uplink retransmission
  uint32_t rbs_used_retx_rx;
  ///  total rb used for a new uplink transmission
  uint32_t total_rbs_used_rx;
  /// normalized rx power 
  int32_t      normalized_rx_power;
   /// target rx power 
  int32_t    target_rx_power;

661
  /// num rx pdu
662
  uint32_t num_pdu_rx[NB_RB_MAX];
663
  /// num bytes rx
664
  uint32_t num_bytes_rx[NB_RB_MAX];
665
  /// instantaneous rx throughput for each TTI
666
  //  uint32_t tti_goodput[NB_RB_MAX];
667 668
  /// errors
  uint32_t num_errors_rx;
669 670 671 672 673 674 675 676 677 678
  
  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;
679
  /// overall
680 681
  ///  MAC pdu bytes
  uint64_t pdu_bytes_rx;
682
  /// total MAC pdu bytes
683
  uint64_t total_pdu_bytes_rx;
684
  /// total num pdu
685
  uint32_t total_num_pdus_rx;
686
  /// num of error pdus
687
  uint32_t total_num_errors_rx;
688

689
} eNB_UE_STATS;
690
/*! \brief eNB template for UE context information  */
691
typedef struct {
692
  /// C-RNTI of UE
gauthier's avatar
gauthier committed
693
  rnti_t rnti;
694 695
  /// NDI from last scheduling
  uint8_t oldNDI[8];
696 697 698 699
  /// mcs1 from last scheduling
  uint8_t oldmcs1[8];
  /// mcs2 from last scheduling
  uint8_t oldmcs2[8];
700 701
  /// NDI from last UL scheduling
  uint8_t oldNDI_UL[8];
702
  /// Flag to indicate UL has been scheduled at least once
gauthier's avatar
gauthier committed
703
  boolean_t ul_active;
knopp's avatar
 
knopp committed
704 705
  /// Flag to indicate UE has been configured (ACK from RRCConnectionSetup received)
  boolean_t configured;
706

707 708 709 710 711 712
  /// MCS from last scheduling
  uint8_t mcs[8];

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

713 714 715
  // PHY interface info

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

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

721 722 723 724 725 726
  /// 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

727 728
  /// Number of Allocated RBs by the ulsch preprocessor
  uint8_t pre_allocated_nb_rb_ul;
729

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

733 734
  /// total allocated RBs
  int8_t total_allocated_rbs;
735

736
  /// pre-assigned MCS by the ulsch preprocessor
737
  uint8_t pre_assigned_mcs_ul;
738 739 740 741

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

742
  /// DL DAI
gauthier's avatar
gauthier committed
743
  uint8_t DAI;
744 745

  /// UL DAI
gauthier's avatar
gauthier committed
746
  uint8_t DAI_ul[10];
747 748

  /// UL Scheduling Request Received
gauthier's avatar
gauthier committed
749
  uint8_t ul_SR;
750

751
  ///Resource Block indication for each sub-band in MU-MIMO
gauthier's avatar
gauthier committed
752
  uint8_t rballoc_subband[8][50];
753 754 755

  // Logical channel info for link with RLC

756
  /// Last received UE BSR info for each logical channel group id
gauthier's avatar
gauthier committed
757
  uint8_t bsr_info[MAX_NUM_LCGID];
758

759 760 761
  /// LCGID mapping
  long lcgidmap[11];

762
  /// phr information
763
  int8_t phr_info;
764

765 766 767
  /// phr information
  int8_t phr_info_configured;

768
  ///dl buffer info
gauthier's avatar
gauthier committed
769
  uint32_t dl_buffer_info[MAX_NUM_LCID];
770
  /// total downlink buffer info
gauthier's avatar
gauthier committed
771
  uint32_t dl_buffer_total;
772
  /// total downlink pdus
gauthier's avatar
gauthier committed
773
  uint32_t dl_pdus_total;
774
  /// downlink pdus for each LCID
gauthier's avatar
gauthier committed
775
  uint32_t dl_pdus_in_buffer[MAX_NUM_LCID];
776
  /// creation time of the downlink buffer head for each LCID
gauthier's avatar
gauthier committed
777
  uint32_t dl_buffer_head_sdu_creation_time[MAX_NUM_LCID];
778
  /// maximum creation time of the downlink buffer head across all LCID
779
  uint32_t  dl_buffer_head_sdu_creation_time_max;
780
  /// a flag indicating that the downlink head SDU is segmented  
gauthier's avatar
gauthier committed
781
  uint8_t    dl_buffer_head_sdu_is_segmented[MAX_NUM_LCID];
782
  /// size of remaining size to send for the downlink head SDU
gauthier's avatar
gauthier committed
783
  uint32_t dl_buffer_head_sdu_remaining_size_to_send[MAX_NUM_LCID];
784

785
  /// total uplink buffer size 
786
  uint32_t ul_total_buffer;
787
  /// uplink buffer creation time for each LCID
788
  uint32_t ul_buffer_creation_time[MAX_NUM_LCGID];
789
  /// maximum uplink buffer creation time across all the LCIDs
790
  uint32_t ul_buffer_creation_time_max;
791
  /// uplink buffer size per LCID
792 793
  uint32_t ul_buffer_info[MAX_NUM_LCGID];

794 795 796
  /// UE tx power
  int32_t ue_tx_power;

kaltenbe's avatar
kaltenbe committed
797
  /// stores the frame where the last TPC was transmitted
knopp's avatar
knopp committed
798 799 800 801
  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
802

803 804 805
#ifdef LOCALIZATION
  eNB_UE_estimated_distances distance;
#endif
806 807
} UE_TEMPLATE;

808
/*! \brief scheduling control information set through an API (not used)*/
809
typedef struct {
810
  ///UL transmission bandwidth in RBs
811
  uint8_t ul_bandwidth[MAX_NUM_LCID];
812
  ///DL transmission bandwidth in RBs
813
  uint8_t dl_bandwidth[MAX_NUM_LCID];
814

815 816
  //To do GBR bearer
  uint8_t min_ul_bandwidth[MAX_NUM_LCID];
817

818
  uint8_t min_dl_bandwidth[MAX_NUM_LCID];
819

820
  ///aggregated bit rate of non-gbr bearer per UE
821
  uint64_t  ue_AggregatedMaximumBitrateDL;
822
  ///aggregated bit rate of non-gbr bearer per UE
823
  uint64_t  ue_AggregatedMaximumBitrateUL;
824
  ///CQI scheduling interval in subframes.
825
  uint16_t cqiSchedInterval;
826
  ///Contention resolution timer used during random access
827
  uint8_t mac_ContentionResolutionTimer;
828

829
  uint16_t max_allowed_rbs[MAX_NUM_LCID];
830

831
  uint8_t max_mcs[MAX_NUM_LCID];
832

833
  uint16_t priority[MAX_NUM_LCID];
834

835 836 837
  // resource scheduling information
  uint8_t       harq_pid[MAX_NUM_CCs];
  uint8_t       round[MAX_NUM_CCs];
838
  uint8_t       round_UL[8][MAX_NUM_CCs];
839 840 841
  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];
842
  uint16_t      ta_timer;
843
  int16_t       ta_update;
844
  uint8_t       ul_cqi;
845
  int32_t       context_active_timer;
846
  int32_t       cqi_req_timer;
847
  int32_t       ul_inactivity_timer;
848
  int32_t       ul_failure_timer;
849
  int32_t       ul_scheduled;
850
  int32_t       ra_pdcch_order_sent;
Florian Kaltenberger's avatar
Florian Kaltenberger committed
851
  int32_t       ul_out_of_sync;
852
  int32_t       phr_received;
853
} UE_sched_ctrl;
854
/*! \brief eNB template for the Random access information */
855 856
typedef struct {
  /// Flag to indicate this process is active
gauthier's avatar
gauthier committed
857
  boolean_t RA_active;
858
  /// Size of DCI for RA-Response (bytes)
gauthier's avatar
gauthier committed
859
  uint8_t RA_dci_size_bytes1;
860
  /// Size of DCI for RA-Response (bits)
gauthier's avatar
gauthier committed
861
  uint8_t RA_dci_size_bits1;
862
  /// Actual DCI to transmit for RA-Response
gauthier's avatar
gauthier committed
863
  uint8_t RA_alloc_pdu1[(MAX_DCI_SIZE_BITS>>3)+1];
864
  /// DCI format for RA-Response (should be 1A)
gauthier's avatar
gauthier committed
865
  uint8_t RA_dci_fmt1;
866
  /// Size of DCI for Msg4/ContRes (bytes)
gauthier's avatar
gauthier committed
867
  uint8_t RA_dci_size_bytes2;
868
  /// Size of DCI for Msg4/ContRes (bits)
gauthier's avatar
gauthier committed
869
  uint8_t RA_dci_size_bits2;
870
  /// Actual DCI to transmit for Msg4/ContRes
gauthier's avatar
gauthier committed
871
  uint8_t RA_alloc_pdu2[(MAX_DCI_SIZE_BITS>>3)+1];
872
  /// DCI format for Msg4/ContRes (should be 1A)
gauthier's avatar
gauthier committed
873
  uint8_t RA_dci_fmt2;
874
  /// Flag to indicate the eNB should generate RAR.  This is triggered by detection of PRACH
gauthier's avatar
gauthier committed
875
  uint8_t generate_rar;
876
  /// Subframe where preamble was received
gauthier's avatar
gauthier committed
877
  uint8_t preamble_subframe;
878 879 880 881
  /// Subframe where Msg2 is to be sent
  uint8_t Msg2_subframe;
  /// Frame where Msg2 is to be sent
  uint8_t Msg2_frame;
882
  /// Subframe where Msg3 is to be sent
gauthier's avatar
gauthier committed
883
  uint8_t Msg3_subframe;
884
  /// Frame where Msg3 is to be sent
885
  uint8_t Msg3_frame;
886 887 888 889
  /// Subframe where Msg4 is to be sent
  uint8_t Msg4_subframe;
  /// Frame where Msg4 is to be sent
  uint8_t Msg4_frame;
890
  /// Flag to indicate the eNB should generate Msg4 upon reception of SDU from RRC.  This is triggered by first ULSCH reception at eNB for new user.
891
  uint8_t generate_Msg4;
892
  /// Flag to indicate that eNB is waiting for ACK that UE has received Msg3.
gauthier's avatar
gauthier committed
893
  uint8_t wait_ack_Msg4;
894
  /// UE RNTI allocated during RAR
gauthier's avatar
gauthier committed
895
  rnti_t rnti;
896
  /// RA RNTI allocated from received PRACH
gauthier's avatar
gauthier committed
897
  uint16_t RA_rnti;
898
  /// Received preamble_index
gauthier's avatar
gauthier committed
899
  uint8_t preamble_index;
900
  /// Received UE Contention Resolution Identifier
gauthier's avatar
gauthier committed
901
  uint8_t cont_res_id[6];
902
  /// Timing offset indicated by PHY
gauthier's avatar
gauthier committed
903
  int16_t timing_offset;
904
  /// Timeout for RRC connection
gauthier's avatar
gauthier committed
905
  int16_t RRC_timer;
906 907
  /// Round of Msg3 HARQ
  uint8_t msg3_round;
908 909 910 911 912 913 914
#ifdef Rel14
  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;
#endif
915 916 917
} RA_TEMPLATE;


918
/*! \brief subband bitmap confguration (for ALU icic algo purpose), in test phase */
919 920 921 922 923 924 925
typedef struct {
  uint8_t sbmap[NUMBER_OF_SUBBANDS_MAX]; //13 = number of SB MAX for 100 PRB
  uint8_t periodicity;
  uint8_t first_subframe;
  uint8_t sb_size;
  uint8_t nb_active_sb;
} SBMAP_CONF;
926
/*! \brief UE list used by eNB to order UEs/CC for scheduling*/ 
927
typedef struct {
928