defs.h 33.1 KB
Newer Older
1
/*******************************************************************************
2 3
    OpenAirInterface
    Copyright(c) 1999 - 2014 Eurecom
4

5 6 7 8
    OpenAirInterface is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
9 10


11 12 13 14
    OpenAirInterface is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
15

16 17 18 19
    You should have received a copy of the GNU General Public License
    along with OpenAirInterface.The full GNU General Public License is
    included in this distribution in the file called "COPYING". If not,
    see <http://www.gnu.org/licenses/>.
20 21

  Contact Information
22 23
  OpenAirInterface Admin: openair_admin@eurecom.fr
  OpenAirInterface Tech : openair_tech@eurecom.fr
24
  OpenAirInterface Dev  : openair4g-devel@lists.eurecom.fr
25

ghaddab's avatar
ghaddab committed
26
  Address      : Eurecom, Campus SophiaTech, 450 Route des Chappes, CS 50193 - 06904 Biot Sophia Antipolis cedex, FRANCE
27 28

*******************************************************************************/
29
/*! \file LAYER2/MAC/defs.h
30
* \brief MAC data structures, constant, and function prototype
31
* \author Navid Nikaein and Raymond Knopp
32 33
* \date 2011
* \version 0.5
34
* \email navid.nikaein@eurecom.fr
35 36

*/
37 38 39 40
/** @defgroup _oai2  openair2 Reference Implementation
 * @ingroup _ref_implementation_
 * @{
 */
41

42
/*@}*/
43

44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
#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"

#include "COMMON/platform_constants.h"
#include "COMMON/mac_rrc_primitives.h"
#include "PHY/defs.h"
#include "RadioResourceConfigCommon.h"
#include "RadioResourceConfigDedicated.h"
#include "MeasGapConfig.h"
#include "TDD-Config.h"
#include "RACH-ConfigCommon.h"
#include "MeasObjectToAddModList.h"
66
#include "MobilityControlInfo.h"
67 68 69 70
#ifdef Rel10
#include "MBSFN-AreaInfoList-r9.h"
#include "MBSFN-SubframeConfigList.h"
#include "PMCH-InfoList-r9.h"
knopp's avatar
knopp committed
71
#include "SCellToAddMod-r10.h"
72 73 74 75 76 77
#endif

//#ifdef PHY_EMUL
//#include "SIMULATION/PHY_EMULATION/impl_defs.h"
//#endif

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

83
#define BCCH_PAYLOAD_SIZE_MAX 128
84
#define CCCH_PAYLOAD_SIZE_MAX 128
85

86 87 88 89 90
#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)

#ifdef Rel10

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

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

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

142

143 144 145
#define LCID_EMPTY 0
#define LCID_NOT_EMPTY 1

146 147 148
/* 
 * eNB part 
 */ 
149

150 151 152 153 154

/* 
 * UE/ENB common part 
 */ 
/*!\brief MAC header of Random Access Response for Random access preamble identifier (RAPID) */
155
typedef struct {
156 157 158
  uint8_t RAPID:6;
  uint8_t T:1;
  uint8_t E:1;
159 160
} __attribute__((__packed__))RA_HEADER_RAPID;

161
/*!\brief  MAC header of Random Access Response for backoff indicator (BI)*/
162
typedef struct {
163 164 165 166
  uint8_t BI:4;
  uint8_t R:2;
  uint8_t T:1;
  uint8_t E:1;
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196
} __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
*/
197
/*!\brief  MAC subheader short with 7bit Length field */
198
typedef struct {
199 200 201 202 203
  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
204
} __attribute__((__packed__))SCH_SUBHEADER_SHORT;
205
/*!\brief  MAC subheader long  with 15bit Length field */
206
typedef struct {
207 208 209 210 211 212 213
  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;
214
} __attribute__((__packed__))SCH_SUBHEADER_LONG;
215
/*!\brief MAC subheader short without length field */
216
typedef struct {
217 218 219
  uint8_t LCID:5;
  uint8_t E:1;
  uint8_t R:2;
220 221
} __attribute__((__packed__))SCH_SUBHEADER_FIXED;

222
/*!\brief  mac control element: short buffer status report for a specific logical channel group ID*/
223
typedef struct {
224 225
  uint8_t Buffer_size:6;  // octet 1 LSB
  uint8_t LCGID:2;        // octet 1 MSB
226 227 228
} __attribute__((__packed__))BSR_SHORT;

typedef BSR_SHORT BSR_TRUNCATED;
229
/*!\brief  mac control element: long buffer status report for all logical channel group ID*/
230
typedef struct {
231 232 233 234 235
  uint32_t Buffer_size3:6;
  uint32_t Buffer_size2:6;
  uint32_t Buffer_size1:6;
  uint32_t Buffer_size0:6;
  uint32_t padding:8;
236 237 238
} __attribute__((__packed__))BSR_LONG;

#define BSR_LONG_SIZE  (sizeof(BSR_LONG))
239
/*!\brief  mac control element: timing advance  */
240
typedef struct {
241 242
  uint8_t TA:6;
  uint8_t R:2;
243
} __attribute__((__packed__))TIMING_ADVANCE_CMD;
244
/*!\brief  mac control element: power headroom report  */
245
typedef struct {
246 247
  uint8_t PH:6;
  uint8_t R:2;
248 249
} __attribute__((__packed__))POWER_HEADROOM_CMD;

250
/*!\brief  DCI PDU filled by MAC for the PHY  */
251
typedef struct {
252 253
  uint8_t Num_ue_spec_dci ;
  uint8_t Num_common_dci  ;
254 255
  uint32_t nCCE;
  uint32_t num_pdcch_symbols;
256 257
  DCI_ALLOC_t dci_alloc[NUM_DCI_MAX] ;
} DCI_PDU;
258
/*! \brief CCCH payload */
259
typedef struct {
260
  uint8_t payload[CCCH_PAYLOAD_SIZE_MAX] ;
261
} __attribute__((__packed__))CCCH_PDU;
262
/*! \brief BCCH payload */
263
typedef struct {
264
  uint8_t payload[BCCH_PAYLOAD_SIZE_MAX] ;
265 266 267
} __attribute__((__packed__))BCCH_PDU;

#ifdef Rel10
268
/*! \brief MCCH payload */
269
typedef struct {
270
  uint8_t payload[MCCH_PAYLOAD_SIZE_MAX] ;
271
} __attribute__((__packed__))MCCH_PDU;
272
/*!< \brief MAC control element for activation and deactivation of component carriers */
273 274 275 276 277 278 279 280 281 282
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;
283
/*! \brief MAC control element: MCH Scheduling Information */
284
typedef struct {
285 286 287
  uint8_t stop_sf_MSB:3; // octet 1 LSB
  uint8_t lcid:5;        // octet 2 MSB
  uint8_t stop_sf_LSB:8;
288
} __attribute__((__packed__))MSI_ELEMENT;
289 290
#endif
/*! \brief Values of CCCH LCID for DLSCH */ 
291
#define CCCH_LCHANID 0
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307
/*!\brief Values of BCCH logical channel */
#define BCCH 3  // SI 
/*!\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*/
308
#define UE_CONT_RES 28
309
/*!\brief LCID of timing advance for DLSCH */
310
#define TIMING_ADV_CMD 29
311
/*!\brief LCID of discontinous reception mode for DLSCH */
312
#define DRX_CMD 30
313
/*!\brief LCID of padding LCID for DLSCH */
314 315 316 317
#define SHORT_PADDING 31

#ifdef Rel10
// MCH LCHAN IDs (table6.2.1-4 TS36.321)
318
/*!\brief LCID of MCCH for DL */
319
#define MCCH_LCHANID 0
320 321 322
/*!\brief LCID of MCH scheduling info for DL */
#define MCH_SCHDL_INFO 3
/*!\brief LCID of Carrier component activation/deactivation */
323
#define CC_ACT_DEACT 27
324 325 326
#endif

// ULSCH LCHAN IDs
327
/*!\brief LCID of extended power headroom for ULSCH */
328
#define EXTENDED_POWER_HEADROOM 25
329
/*!\brief LCID of power headroom for ULSCH */
330
#define POWER_HEADROOM 26
331
/*!\brief LCID of CRNTI for ULSCH */
332
#define CRNTI 27
333
/*!\brief LCID of truncated BSR for ULSCH */
334
#define TRUNCATED_BSR 28
335
/*!\brief LCID of short BSR for ULSCH */
336
#define SHORT_BSR 29
337
/*!\brief LCID of long BSR for ULSCH */
338 339
#define LONG_BSR 30

340
/*! \brief Downlink SCH PDU Structure */
341
typedef struct {
342 343
  int8_t payload[8][SCH_PAYLOAD_SIZE_MAX];
  uint16_t Pdu_size[8];
344 345
} __attribute__ ((__packed__)) DLSCH_PDU;

346
/*! \brief MCH PDU Structure */
347
typedef struct {
348 349
  int8_t payload[SCH_PAYLOAD_SIZE_MAX];
  uint16_t Pdu_size;
350
  uint8_t mcs;
351 352 353
  uint8_t sync_area;
  uint8_t msi_active;
  uint8_t mcch_active;
354
  uint8_t mtch_active;
355 356
} __attribute__ ((__packed__)) MCH_PDU;

357
/*! \brief Uplink SCH PDU Structure */
358
typedef struct {
359 360
  int8_t payload[SCH_PAYLOAD_SIZE_MAX];         /*!< \brief SACH payload */
  uint16_t Pdu_size;
361 362 363 364
} __attribute__ ((__packed__)) ULSCH_PDU;

#include "PHY/impl_defs_top.h"

365
/*!\brief  UE ULSCH scheduling states*/
366 367 368
typedef enum {
  S_UL_NONE =0,
  S_UL_WAITING,
369 370
  S_UL_SCHEDULED,
  S_UL_BUFFERED,
371 372 373
  S_UL_NUM_STATUS
} UE_ULSCH_STATUS;

374
/*!\brief  UE DLSCH scheduling states*/
375 376 377
typedef enum {
  S_DL_NONE =0,
  S_DL_WAITING,
378 379
  S_DL_SCHEDULED,
  S_DL_BUFFERED,
380 381 382
  S_DL_NUM_STATUS
} UE_DLSCH_STATUS;

383
/*!\brief  scheduling policy for the contention-based access */
384
typedef enum {
385 386 387 388 389
  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
390 391 392
} CBA_POLICY;


393
/*! \brief temporary struct for ULSCH sched */
394
typedef struct {
395
  rnti_t rnti;
396 397
  uint16_t subframe;
  uint16_t serving_num;
398 399
  UE_ULSCH_STATUS status;
} eNB_ULSCH_INFO;
400
/*! \brief temp struct for DLSCH sched */
401
typedef struct {
402
  rnti_t rnti;
403 404 405
  uint16_t weight;
  uint16_t subframe;
  uint16_t serving_num;
406 407
  UE_DLSCH_STATUS status;
} eNB_DLSCH_INFO;
408
/*! \brief eNB overall statistics */
409
typedef struct {
410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428
  /// 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
429 430 431 432 433
  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;
434 435
  /// aggregation
  /// total avilable nccc : num control channel element
436
  uint16_t available_ncces;
437 438
  // only for a new transmission, should be extended for retransmission
  // current dlsch  bit rate for all transport channels
439 440 441 442 443
  uint32_t dlsch_bitrate;
  //
  uint32_t dlsch_bytes_tx;
  //
  uint32_t dlsch_pdus_tx;
444
  //
445 446 447 448 449
  uint32_t total_dlsch_bitrate;
  //
  uint32_t total_dlsch_bytes_tx;
  //
  uint32_t total_dlsch_pdus_tx;
450 451
  
  // here for RX
452 453 454 455 456
  //
  uint32_t ulsch_bitrate;
  //
  uint32_t ulsch_bytes_rx;
  //
457 458 459 460 461 462 463 464
  uint64_t ulsch_pdus_rx; 

  uint32_t total_ulsch_bitrate;
  //
  uint32_t total_ulsch_bytes_rx;
  //
  uint32_t total_ulsch_pdus_rx;
  
465
} eNB_STATS;
466
/*! \brief eNB statistics for the connected UEs*/
467
typedef struct {
468 469

  /// CRNTI of UE
470
  rnti_t crnti; ///user id (rnti) of connected UEs
471
  // rrc status
472 473 474
  uint8_t rrc_status;
  /// harq pid
  uint8_t harq_pid;
475
  /// harq rounf
476
  uint8_t harq_round;
477
  /// DL Wideband CQI index (2 TBs)
478 479 480 481 482
  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;
483
  /// total nccc used for a new transmission: num control channel element
484
  uint16_t ncce_used;
485
  /// total avilable nccc for a retransmission: num control channel element
486
  uint16_t ncce_used_retx;
487 488

  // mcs1 before the rate adaptaion
489
  uint8_t dlsch_mcs1;
490
  /// Target mcs2 after rate-adaptation
491
  uint8_t dlsch_mcs2;
492
  //  current TBS with mcs2
493
  uint32_t TBS;
494
  //  total TBS with mcs2
495
  //  uint32_t total_TBS;
496
  //  total rb used for a new transmission
497
  uint32_t total_rbs_used;
498
  //  total rb used for retransmission
499
  uint32_t total_rbs_used_retx;
500

501
   /// TX
502 503 504 505 506 507 508 509
  /// 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];
510 511

  /// overall
512
  //
513 514 515 516
  uint32_t  dlsch_bitrate;
  //total
  uint32_t  total_dlsch_bitrate;
  /// headers+ CE +  padding bytes for a MAC PDU
517
  uint64_t overhead_bytes;
518
  /// headers+ CE +  padding bytes for a MAC PDU
519
  uint64_t total_overhead_bytes;
520
  /// headers+ CE +  padding bytes for a MAC PDU
521
  uint64_t avg_overhead_bytes;
522
  // MAC multiplexed payload
523 524 525
  uint64_t total_sdu_bytes;
  // total MAC pdu bytes
  uint64_t total_pdu_bytes;
526

527 528 529 530
  // total num pdu
  uint32_t total_num_pdus;
  //
  //  uint32_t avg_pdu_size;
531 532

  /// RX
533 534 535 536 537 538

  /// preassigned mcs after rate adaptation
  uint8_t ulsch_mcs1;
  /// adjusted mcs
  uint8_t ulsch_mcs2;

539 540 541 542
  /// estimated average pdu inter-departure time
  uint32_t avg_pdu_idt;
  /// estimated average pdu size
  uint32_t avg_pdu_ps;
543
  ///
544 545
  uint32_t aggregated_pdu_size;
  uint32_t aggregated_pdu_arrival;
546

547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562
  ///  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;

563
  /// num rx pdu
564
  uint32_t num_pdu_rx[NB_RB_MAX];
565
  /// num bytes rx
566
  uint32_t num_bytes_rx[NB_RB_MAX];
567
  /// instantaneous rx throughput for each TTI
568
  //  uint32_t tti_goodput[NB_RB_MAX];
569 570
  /// errors
  uint32_t num_errors_rx;
571 572 573 574 575 576 577 578 579 580
  
  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;
581
  /// overall
582 583
  ///  MAC pdu bytes
  uint64_t pdu_bytes_rx;
584
  /// total MAC pdu bytes
585
  uint64_t total_pdu_bytes_rx;
586
  /// total num pdu
587
  uint32_t total_num_pdus_rx;
588
  /// num of error pdus
589
  uint32_t total_num_errors_rx;
590

591
} eNB_UE_STATS;
592
/*! \brief eNB template for UE context information  */
593
typedef struct {
594
  /// C-RNTI of UE
595
  rnti_t rnti;
596 597 598 599
  /// NDI from last scheduling
  uint8_t oldNDI[8];
  /// NDI from last UL scheduling
  uint8_t oldNDI_UL[8];
600
  /// Flag to indicate UL has been scheduled at least once
gauthier's avatar
gauthier committed
601
  boolean_t ul_active;
knopp's avatar
knopp committed
602 603
  /// Flag to indicate UE has been configured (ACK from RRCConnectionSetup received)
  boolean_t configured;
604 605 606 607

  // PHY interface info

  /// DCI format for DLSCH
608
  uint16_t DLSCH_dci_fmt;
609

610
  /// Current Aggregation Level for DCI
611
  uint8_t DCI_aggregation_min;
612

613
  /// size of DLSCH size in bit 
614
  uint8_t DLSCH_dci_size_bits;
615 616

  /// DCI buffer for DLSCH
617
  uint8_t DLSCH_DCI[8][(MAX_DCI_SIZE_BITS>>3)+1];
618 619

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

  /// Number of Allocated RBs for UL after scheduling (prior to frequency allocation)
623
  uint16_t nb_rb_ul[8]; // num_max_harq
624

625 626
  /// Number of Allocated RBs by the ulsch preprocessor
  uint8_t pre_allocated_nb_rb_ul;
627

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

631 632
  /// total allocated RBs
  int8_t total_allocated_rbs;
633

634
  /// pre-assigned MCS by the ulsch preprocessor
635
  uint8_t pre_assigned_mcs_ul;
636 637 638 639

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

640
  /// DCI buffer for ULSCH
641
  uint8_t ULSCH_DCI[8][(MAX_DCI_SIZE_BITS>>3)+1];
642 643

  /// DL DAI
644
  uint8_t DAI;
645 646

  /// UL DAI
647
  uint8_t DAI_ul[10];
648 649

  /// UL Scheduling Request Received
650
  uint8_t ul_SR;
651

652
  ///Resource Block indication for each sub-band in MU-MIMO
653
  uint8_t rballoc_subband[8][50];
654 655 656 657

  // Logical channel info for link with RLC

  /// UE BSR info for each logical channel group id
658
  uint8_t bsr_info[MAX_NUM_LCGID];
659 660

  /// phr information
661
  int8_t phr_info;
662

663 664 665
  /// phr information
  int8_t phr_info_configured;

666
  ///dl buffer info
667
  uint32_t dl_buffer_info[MAX_NUM_LCID];
668
  /// total downlink buffer info
669
  uint32_t dl_buffer_total;
670
  /// total downlink pdus
671
  uint32_t dl_pdus_total;
672
  /// downlink pdus for each LCID
673
  uint32_t dl_pdus_in_buffer[MAX_NUM_LCID];
674
  /// creation time of the downlink buffer head for each LCID
675
  uint32_t dl_buffer_head_sdu_creation_time[MAX_NUM_LCID];
676
  /// maximum creation time of the downlink buffer head across all LCID
677
  uint32_t  dl_buffer_head_sdu_creation_time_max;
678
  /// a flag indicating that the downlink head SDU is segmented  
679
  uint8_t    dl_buffer_head_sdu_is_segmented[MAX_NUM_LCID];
680
  /// size of remaining size to send for the downlink head SDU
681
  uint32_t dl_buffer_head_sdu_remaining_size_to_send[MAX_NUM_LCID];
682

683
  /// total uplink buffer size 
684
  uint32_t ul_total_buffer;
685
  /// uplink buffer creation time for each LCID
686
  uint32_t ul_buffer_creation_time[MAX_NUM_LCGID];
687
  /// maximum uplink buffer creation time across all the LCIDs
688
  uint32_t ul_buffer_creation_time_max;
689
  /// uplink buffer size per LCID
690 691
  uint32_t ul_buffer_info[MAX_NUM_LCGID];

692 693 694
  /// UE tx power
  int32_t ue_tx_power;

kaltenbe's avatar
kaltenbe committed
695
  /// stores the frame where the last TPC was transmitted
696 697 698 699
  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
700

701 702 703
#ifdef LOCALIZATION
  eNB_UE_estimated_distances distance;
#endif
704 705
} UE_TEMPLATE;

706
/*! \brief scheduling control information set through an API (not used)*/
707
typedef struct {
708
  ///UL transmission bandwidth in RBs
709
  uint8_t ul_bandwidth[MAX_NUM_LCID];
710
  ///DL transmission bandwidth in RBs
711
  uint8_t dl_bandwidth[MAX_NUM_LCID];
712

713 714
  //To do GBR bearer
  uint8_t min_ul_bandwidth[MAX_NUM_LCID];
715

716
  uint8_t min_dl_bandwidth[MAX_NUM_LCID];
717

718
  ///aggregated bit rate of non-gbr bearer per UE
719
  uint64_t  ue_AggregatedMaximumBitrateDL;
720
  ///aggregated bit rate of non-gbr bearer per UE
721
  uint64_t  ue_AggregatedMaximumBitrateUL;
722
  ///CQI scheduling interval in subframes.
723
  uint16_t cqiSchedInterval;
724
  ///Contention resolution timer used during random access
725
  uint8_t mac_ContentionResolutionTimer;
726

727
  uint16_t max_allowed_rbs[MAX_NUM_LCID];
728

729
  uint8_t max_mcs[MAX_NUM_LCID];
730

731
  uint16_t priority[MAX_NUM_LCID];
732

733 734 735 736 737 738 739
  // resource scheduling information
  uint8_t       harq_pid[MAX_NUM_CCs];
  uint8_t       round[MAX_NUM_CCs];
  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];

740
} UE_sched_ctrl;
741
/*! \brief eNB template for the Random access information */
742 743
typedef struct {
  /// Flag to indicate this process is active
gauthier's avatar
gauthier committed
744
  boolean_t RA_active;
745
  /// Size of DCI for RA-Response (bytes)
746
  uint8_t RA_dci_size_bytes1;
747
  /// Size of DCI for RA-Response (bits)
748
  uint8_t RA_dci_size_bits1;
749
  /// Actual DCI to transmit for RA-Response
750
  uint8_t RA_alloc_pdu1[(MAX_DCI_SIZE_BITS>>3)+1];
751
  /// DCI format for RA-Response (should be 1A)
752
  uint8_t RA_dci_fmt1;
753
  /// Size of DCI for Msg4/ContRes (bytes)
754
  uint8_t RA_dci_size_bytes2;
755
  /// Size of DCI for Msg4/ContRes (bits)
756
  uint8_t RA_dci_size_bits2;
757
  /// Actual DCI to transmit for Msg4/ContRes
758
  uint8_t RA_alloc_pdu2[(MAX_DCI_SIZE_BITS>>3)+1];
759
  /// DCI format for Msg4/ContRes (should be 1A)
760
  uint8_t RA_dci_fmt2;
761
  /// Flag to indicate the eNB should generate RAR.  This is triggered by detection of PRACH
762
  uint8_t generate_rar;
763
  /// Subframe where preamble was received
764
  uint8_t preamble_subframe;
765
  /// Subframe where Msg3 is to be sent
766
  uint8_t Msg3_subframe;
767
  /// 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.
768
  uint8_t generate_Msg4;
769
  /// Flag to indicate that eNB is waiting for ACK that UE has received Msg3.
770
  uint8_t wait_ack_Msg4;
771
  /// UE RNTI allocated during RAR
772
  rnti_t rnti;
773
  /// RA RNTI allocated from received PRACH
774
  uint16_t RA_rnti;
775
  /// Received preamble_index
776
  uint8_t preamble_index;
777
  /// Received UE Contention Resolution Identifier
778
  uint8_t cont_res_id[6];
779
  /// Timing offset indicated by PHY
780
  int16_t timing_offset;
781
  /// Timeout for RRC connection
782
  int16_t RRC_timer;
783 784 785
} RA_TEMPLATE;


786
/*! \brief subband bitmap confguration (for ALU icic algo purpose), in test phase */
787 788 789 790 791 792 793
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;
794
/*! \brief UE list used by eNB to order UEs/CC for scheduling*/ 
795
typedef struct {
796
  /// DLSCH pdu 
knopp's avatar
knopp committed
797 798 799 800 801
  DLSCH_PDU DLSCH_pdu[MAX_NUM_CCs][2][NUMBER_OF_UE_MAX];
  /// DCI template and MAC connection parameters for UEs
  UE_TEMPLATE UE_template[MAX_NUM_CCs][NUMBER_OF_UE_MAX];
  /// DCI template and MAC connection for RA processes
  int pCC_id[NUMBER_OF_UE_MAX];
802
  /// sorted downlink component carrier for the scheduler 
knopp's avatar
knopp committed
803
  int ordered_CCids[MAX_NUM_CCs][NUMBER_OF_UE_MAX];
804
  /// number of downlink active component carrier 
knopp's avatar
knopp committed
805
  int numactiveCCs[NUMBER_OF_UE_MAX];
806
  /// sorted uplink component carrier for the scheduler 
knopp's avatar
knopp committed
807
  int ordered_ULCCids[MAX_NUM_CCs][NUMBER_OF_UE_MAX];
808
  /// number of uplink active component carrier 
knopp's avatar
knopp committed
809
  int numactiveULCCs[NUMBER_OF_UE_MAX];
810
  /// number of downlink active component carrier 
811
  uint8_t dl_CC_bitmap[NUMBER_OF_UE_MAX];
812
  /// eNB to UE statistics
knopp's avatar
knopp committed
813
  eNB_UE_STATS eNB_UE_stats[MAX_NUM_CCs][NUMBER_OF_UE_MAX];
814
  /// scheduling control info
knopp's avatar
knopp committed
815 816 817
  UE_sched_ctrl UE_sched_ctrl[NUMBER_OF_UE_MAX];

  int next[NUMBER_OF_UE_MAX];
818
  int head;
819 820
  int next_ul[NUMBER_OF_UE_MAX];
  int head_ul;
knopp's avatar
knopp committed
821 822 823 824
  int avail;
  int num_UEs;
  boolean_t active[NUMBER_OF_UE_MAX];
} UE_list_t;
825

826
/*! \brief eNB common channels */ 
827
typedef struct {
828 829 830 831
  /// Outgoing DCI for PHY generated by eNB scheduler
  DCI_PDU DCI_pdu;
  /// Outgoing BCCH pdu for PHY
  BCCH_PDU BCCH_pdu;
832 833
  /// Outgoing BCCH DCI allocation
  uint32_t BCCH_alloc_pdu;
834 835 836
  /// Outgoing CCCH pdu for PHY
  CCCH_PDU CCCH_pdu;
  RA_TEMPLATE RA_template[NB_RA_PROC_MAX];
837 838
  /// VRB map for common channels
  uint8_t vrb_map[100];
839 840
  /// MBSFN SubframeConfig
  struct MBSFN_SubframeConfig *mbsfn_SubframeConfig[8];
841
  /// number of subframe allocation pattern available for MBSFN sync area
842
  uint8_t num_sf_allocation_pattern;
843
#ifdef Rel10
844
  /// MBMS Flag
845
  uint8_t MBMS_flag;
846 847 848
  /// Outgoing MCCH pdu for PHY
  MCCH_PDU MCCH_pdu;
  /// MCCH active flag
849
  uint8_t msi_active;
850
  /// MCCH active flag
851
  uint8_t mcch_active;
852
  /// MTCH active flag
853
  uint8_t mtch_active;
854
  /// number of active MBSFN area
855
  uint8_t num_active_mbsfn_area;
856 857 858 859 860 861 862 863 864 865
  /// 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;
#endif
#ifdef CBA
866
  /// number of CBA groups 
867
  uint8_t num_active_cba_groups;
868
  /// RNTI for each CBA group 
869
  uint16_t cba_rnti[NUM_MAX_CBA_GROUP];
870
  /// MCS for each CBA group 
871
  uint8_t group_mcs[NUM_MAX_CBA_GROUP];
872 873
#endif
} COMMON_channels_t;
874
/*! \brief top level eNB MAC structure */ 
875 876
typedef struct {
  ///
knopp's avatar
knopp committed
877 878 879 880 881 882 883 884
  uint16_t Node_id;
  /// frame counter
  frame_t frame;
  /// subframe counter
  sub_frame_t subframe;
  /// Common cell resources
  COMMON_channels_t common_channels[MAX_NUM_CCs];
  UE_list_t UE_list;
885

886 887
  ///subband bitmap configuration
  SBMAP_CONF sbmap_conf;
888 889
  /// CCE table used to build DCI scheduling information
  int CCE_table[MAX_NUM_CCs][800];
890
  ///  active flag for Other lcid
knopp's avatar
knopp committed
891
  //  uint8_t lcid_active[NB_RB_MAX];
892
  /// eNB stats
893
  eNB_STATS eNB_stats[MAX_NUM_CCs];
894
  // MAC function execution peformance profiler
895
  /// processing time of eNB scheduler 
896
  time_stats_t eNB_scheduler;
897
  /// processing time of eNB scheduler for SI 
898
  time_stats_t schedule_si;
899
  /// processing time of eNB scheduler for Random access
900
  time_stats_t schedule_ra;
901
  /// processing time of eNB ULSCH scheduler 
902
  time_stats_t schedule_ulsch;
903
  /// processing time of eNB DCI generation
904
  time_stats_t fill_DLSCH_dci;
905
  /// processing time of eNB MAC preprocessor
906
  time_stats_t schedule_dlsch_preprocessor;
907
  /// processing time of eNB DLSCH scheduler 
908
  time_stats_t schedule_dlsch; // include rlc_data_req + MAC header + preprocessor
909
  /// processing time of eNB MCH scheduler 
910
  time_stats_t schedule_mch;
911
  /// processing time of eNB ULSCH reception
912
  time_stats_t rx_ulsch_sdu; // include rlc_data_ind
913 914

} eNB_MAC_INST;
915

916 917 918 919 920 921 922 923 924 925 926 927 928
/* 
 * UE part 
 */ 

/*!\brief UE layer 2 status */
typedef enum {
  CONNECTION_OK=0,
  CONNECTION_LOST,
  PHY_RESYNCH,
  PHY_HO_PRACH
} UE_L2_STATE_t;

/*!\brief UE scheduling info */
929 930
typedef struct {
  /// buffer status for each lcgid
931
  uint8_t  BSR[MAX_NUM_LCGID]; // should be more for mesh topology
932
  /// keep the number of bytes in rlc buffer for each lcid
933
  uint16_t  BSR_bytes[MAX_NUM_LCGID];
934
  /// buffer status for each lcid
935
  uint8_t  LCID_status[MAX_NUM_LCID];
936
  /// SR pending as defined in 36.321
937
  uint8_t  SR_pending;
938
  /// SR_COUNTER as defined in 36.321
939
  uint16_t SR_COUNTER;
940
  /// logical channel group ide for each LCID
941
  uint8_t  LCGID[MAX_NUM_LCID];
942
  /// retxBSR-Timer, default value is sf2560
943
  uint16_t retxBSR_Timer;
944
  /// retxBSR_SF, number of subframe before triggering a regular BSR
945
  int16_t retxBSR_SF;
946
  /// periodicBSR-Timer, default to infinity
947
  uint16_t periodicBSR_Timer;
948
  /// periodicBSR_SF, number of subframe before triggering a periodic BSR
949
  int16_t periodicBSR_SF;
950
  /// default value is 0: not configured
951
  uint16_t sr_ProhibitTimer;
952
  /// sr ProhibitTime running
953
  uint8_t sr_ProhibitTimer_Running;
954
  ///  default value to n5
955
  uint16_t maxHARQ_Tx;
956
  /// default value is false
957
  uint16_t ttiBundling;
958
  /// default value is release
959 960 961 962
  struct DRX_Config *drx_config;
  /// default value is release
  struct MAC_MainConfig__phr_Config *phr_config;
  ///timer before triggering a periodic PHR
963
  uint16_t periodicPHR_Timer;
964
  ///timer before triggering a prohibit PHR
965
  uint16_t prohibitPHR_Timer;
966
  ///DL Pathloss change value
967
  uint16_t PathlossChange;
968
  ///number of subframe before triggering a periodic PHR
969
  int16_t periodicPHR_SF;
970
  ///number of subframe before triggering a prohibit PHR
971
  int16_t prohibitPHR_SF;
972
  ///DL Pathloss Change in db
973
  uint16_t PathlossChange_db;
974
  //Bj bucket usage per  lcid
975
  int16_t Bj[MAX_NUM_LCID];
976
  // Bucket size per lcid
977
  int16_t bucket_size[MAX_NUM_LCID];
978
} UE_SCHEDULING_INFO;
979
/*!\brief Top level UE MAC structure */
980
typedef struct {
981
  uint16_t Node_id;
982
  /// frame counter
983
  frame_t     frame;
984
  /// subframe counter
985
  sub_frame_t subframe;
986
  /// C-RNTI of UE
987
  uint16_t crnti;
988
  /// C-RNTI of UE before HO
989
  rnti_t crnti_before_ho; ///user id (rnti) of connected UEs
990 991
  /// uplink active flag
  uint8_t ul_active;
992
  /// pointer to RRC PHY configuration
993
  RadioResourceConfigCommonSIB_t *radioResourceConfigCommon;
994
  /// pointer to RACH_ConfigDedicated (NULL when not active, i.e. upon HO completion or T304 expiry)
995 996
  struct RACH_ConfigDedicated *rach_ConfigDedicated;
  /// pointer to RRC PHY configuration
997
  struct PhysicalConfigDedicated *physicalConfigDedicated;
998 999 1000 1001
#ifdef Rel10
  /// pointer to RRC PHY configuration SCEll
  struct PhysicalConfigDedicatedSCell_r10 *physicalConfigDedicatedSCell_r10;
#endif
1002 1003 1004
  /// pointer to TDD Configuration (NULL for FDD)
  TDD_Config_t *tdd_Config;
  /// Number of adjacent cells to measure
1005
  uint8_t  n_adj_cells;
1006
  /// Array of adjacent physical cell ids
1007
  uint32_t adj_cell_id[6];
1008 1009 1010 1011 1012 1013
  /// 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];
1014
  /// Scheduling Information
1015 1016 1017 1018 1019 1020
  UE_SCHEDULING_INFO scheduling_info;
  /// Outgoing CCCH pdu for PHY
  CCCH_PDU CCCH_pdu;
  /// Incoming DLSCH pdu for PHY
  //DLSCH_PDU DLSCH_pdu[NUMBER_OF_UE_MAX][2];
  /// number of attempt for rach
1021
  uint8_t RA_attempt_number;
1022
  /// Random-access procedure flag
1023
  uint8_t RA_active;
1024
  /// Random-access window counter
1025
  int8_t RA_window_cnt;
1026
  /// Random-access Msg3 size in bytes
1027
  uint8_t RA_Msg3_size;
1028
  /// Random-access prachMaskIndex
1029
  uint8_t RA_prachMaskIndex;
1030
  /// Flag indicating Preamble set (A,B) used for first Msg3 transmission
1031
  uint8_t RA_usedGroupA;
1032 1033 1034
  /// Random-access Resources
  PRACH_RESOURCES_t RA_prach_resources;
  /// Random-access PREAMBLE_TRANSMISSION_COUNTER
1035
  uint8_t RA_PREAMBLE_TRANSMISSION_COUNTER;
1036
  /// Random-access backoff counter
1037
  int16_t RA_backoff_cnt;
1038
  /// Random-access variable for window calculation (frame of last change in window counter)
1039
  uint32_t RA_tx_frame;
1040
  /// Random-access variable for window calculation (subframe of last change in window counter)
1041
  uint8_t RA_tx_subframe;
1042 1043
  /// Random-access Group B maximum path-loss
  /// Random-access variable for backoff (frame of last change in backoff counter)
1044
  uint32_t RA_backoff_frame;
1045
  /// Random-access variable for backoff (subframe of last change in backoff counter)
1046
  uint8_t RA_backoff_subframe;
1047
  /// Random-access Group B maximum path-loss
1048
  uint16_t RA_maxPL;
1049
  /// Random-access Contention Resolution Timer active flag
1050
  uint8_t RA_contention_resolution_timer_active;
1051
  /// Random-access Contention Resolution Timer count value
1052
  uint8_t RA_contention_resolution_cnt;
1053
  /// power headroom reporitng reconfigured
1054
  uint8_t PHR_reconfigured;
1055
  /// power headroom state as configured by the higher layers
1056
  uint8_t PHR_state;
1057
  /// power backoff due to power management (as allowed by P-MPRc) for this cell
1058
  uint8_t PHR_reporting_active;
1059
  /// power backoff due to power management (as allowed by P-MPRc) for this cell
1060
  uint8_t power_backoff_db[NUMBER_OF_eNB_MAX];
1061
  /// MBSFN_Subframe Configuration
1062
  struct MBSFN_SubframeConfig *mbsfn_SubframeConfig[8]; // FIXME replace 8 by MAX_MBSFN_AREA?
1063
  /// number of subframe allocation pattern available for MBSFN sync area
1064
  uint8_t num_sf_allocation_pattern;
1065
#ifdef Rel10
1066
  /// number of active MBSFN area
1067
  uint8_t num_active_mbsfn_area;
1068 1069 1070 1071 1072
  /// 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
1073
  uint8_t mcch_status;
1074
  /// MSI status
1075
  uint8_t msi_status;// could be an array if there are >1 MCH in one MBSFN area
1076
#endif
1077
  //#ifdef CBA
1078
  /// CBA RNTI for each group 
1079
  uint16_t cba_rnti[NUM_MAX_CBA_GROUP];
1080
  /// last SFN for CBA channel access 
1081
  uint8_t cba_last_access[NUM_MAX_CBA_GROUP];
1082
  //#endif
1083
  /// total UE scheduler processing time 
gauthier's avatar