defs.h 28 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
/*******************************************************************************

  Eurecom OpenAirInterface
  Copyright(c) 1999 - 2010 Eurecom

  This program is free software; you can redistribute it and/or modify it
  under the terms and conditions of the GNU General Public License,
  version 2, as published by the Free Software Foundation.

  This program is distributed in the hope 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.

  You should have received a copy of the GNU General Public License along with
  this program; if not, write to the Free Software Foundation, Inc.,
  51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.

  The full GNU General Public License is included in this distribution in
  the file called "COPYING".

  Contact Information
  Openair Admin: openair_admin@eurecom.fr
  Openair Tech : openair_tech@eurecom.fr
  Forums       : http://forums.eurecom.fsr/openairinterface
  Address      : Eurecom, 2229, route des crêtes, 06560 Valbonne Sophia Antipolis, France

*******************************************************************************/
/*! \file def.h
* \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 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
* @ingroup _mac

*/

 
#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"
62
#include "MobilityControlInfo.h"
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
#ifdef Rel10
#include "MBSFN-AreaInfoList-r9.h"
#include "MBSFN-SubframeConfigList.h"
#include "PMCH-InfoList-r9.h"
#endif

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

/** @defgroup _mac_impl_ MAC Layer Reference Implementation
 * @ingroup _ref_implementation_
 * @{
 */

#define BCCH_PAYLOAD_SIZE_MAX 128  
#define CCCH_PAYLOAD_SIZE_MAX 128
 
#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)
#define BCCH 3  // SI 
#define CCCH 0  // srb0
#define DCCH 1  // srb1
#define DCCH1 2 // srb2

nikaeinn's avatar
nikaeinn committed
88
#define DTCH 3 // LCID
89 90

#define MCCH 4 // MCCH
91
#define MTCH 1 // MTCH
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111

#ifdef Rel10

// Mask for identifying subframe for MBMS 
#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

#define MCCH_PAYLOAD_SIZE_MAX 128
112
//#define MCH_PAYLOAD_SIZE_MAX 16384// this value is using in case mcs and TBS index are high
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
#endif

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

#define MAX_NUM_LCGID 4
#define MAX_NUM_LCID 11
//#define MAX_NUM_RB 8
#define MAX_NUM_CE 5

#define NB_RA_PROC_MAX 4

#define BSR_TABLE_SIZE 64
// The power headroom reporting range is from -23 ...+40 dB and beyond, with step 1
#define PHR_MAPPING_OFFSET 23  // if ( x>= -23 ) val = floor (x + 23) 

130 131
#define N_RBGS_MAX 25

132 133 134 135 136 137 138 139 140 141 142
#define LCGID0 0
#define LCGID1 1
#define LCGID2 2
#define LCGID3 3

#define LCID_EMPTY 0
#define LCID_NOT_EMPTY 1

typedef enum {
  CONNECTION_OK=0,
  CONNECTION_LOST,
143 144
  PHY_RESYNCH,
  PHY_HO_PRACH
145 146 147
} UE_L2_STATE_t;

typedef struct {
gauthier's avatar
gauthier committed
148 149 150
  uint8_t RAPID:6;
  uint8_t T:1;
  uint8_t E:1;
151 152 153
} __attribute__((__packed__))RA_HEADER_RAPID;

typedef struct {
gauthier's avatar
gauthier committed
154 155 156 157
  uint8_t BI:4;
  uint8_t R:2;
  uint8_t T:1;
  uint8_t E:1;
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189
} __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
*/

typedef struct {
gauthier's avatar
gauthier committed
190 191 192 193 194
  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
195 196 197
} __attribute__((__packed__))SCH_SUBHEADER_SHORT;

typedef struct {
gauthier's avatar
gauthier committed
198 199 200 201 202 203 204
  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;
205 206 207
} __attribute__((__packed__))SCH_SUBHEADER_LONG;
 
typedef struct {
gauthier's avatar
gauthier committed
208 209 210
  uint8_t LCID:5;
  uint8_t E:1;
  uint8_t R:2;
211 212 213
} __attribute__((__packed__))SCH_SUBHEADER_FIXED;

typedef struct {
gauthier's avatar
gauthier committed
214 215
  uint8_t Buffer_size:6;  // octet 1 LSB
  uint8_t LCGID:2;        // octet 1 MSB
216 217 218 219 220
} __attribute__((__packed__))BSR_SHORT;

typedef BSR_SHORT BSR_TRUNCATED;

typedef struct {
gauthier's avatar
gauthier committed
221 222 223 224 225
  uint32_t Buffer_size3:6;
  uint32_t Buffer_size2:6;
  uint32_t Buffer_size1:6;
  uint32_t Buffer_size0:6;
  uint32_t padding:8;
226 227 228 229 230
} __attribute__((__packed__))BSR_LONG;

#define BSR_LONG_SIZE  (sizeof(BSR_LONG))

typedef struct {
gauthier's avatar
gauthier committed
231 232
  uint8_t TA:6;
  uint8_t R:2;
233 234 235
} __attribute__((__packed__))TIMING_ADVANCE_CMD;

typedef struct {
gauthier's avatar
gauthier committed
236 237
  uint8_t PH:6;
  uint8_t R:2;
238 239 240
} __attribute__((__packed__))POWER_HEADROOM_CMD;

typedef struct {
gauthier's avatar
gauthier committed
241 242
  uint8_t Num_ue_spec_dci ;
  uint8_t Num_common_dci  ;
243 244 245 246 247
  unsigned int nCCE;
  DCI_ALLOC_t dci_alloc[NUM_DCI_MAX] ;
} DCI_PDU;

typedef struct {
gauthier's avatar
gauthier committed
248
  uint8_t payload[CCCH_PAYLOAD_SIZE_MAX] ;/*!< \brief CCCH payload */
249 250 251
} __attribute__((__packed__))CCCH_PDU;

typedef struct {
gauthier's avatar
gauthier committed
252
  uint8_t payload[BCCH_PAYLOAD_SIZE_MAX] ;/*!< \brief CCCH payload */
253 254 255 256
} __attribute__((__packed__))BCCH_PDU;

#ifdef Rel10
typedef struct {
gauthier's avatar
gauthier committed
257
  uint8_t payload[MCCH_PAYLOAD_SIZE_MAX] ;/*!< \brief MCCH payload */
258 259 260 261
} __attribute__((__packed__))MCCH_PDU;
#endif

typedef struct{
gauthier's avatar
gauthier committed
262 263 264
  uint8_t stop_sf_MSB:3; // octet 1 LSB
  uint8_t lcid:5;        // octet 2 MSB
  uint8_t stop_sf_LSB:8;
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
} __attribute__((__packed__))MSI_ELEMENT;

// DLSCH LCHAN IDs
#define CCCH_LCHANID 0
#define UE_CONT_RES 28
#define TIMING_ADV_CMD 29
#define DRX_CMD 30
#define SHORT_PADDING 31

#ifdef Rel10
// MCH LCHAN IDs (table6.2.1-4 TS36.321)
#define MCCH_LCHANID 0
#define MCH_SCHDL_INFO 30

#endif

// ULSCH LCHAN IDs
#define EXTENDED_POWER_HEADROOM 25
#define POWER_HEADROOM 26
#define CRNTI 27
#define TRUNCATED_BSR 28
#define SHORT_BSR 29
#define LONG_BSR 30

/*! \brief Downlink SCH PDU Structure
 */
typedef struct {
gauthier's avatar
gauthier committed
292 293
  int8_t payload[8][SCH_PAYLOAD_SIZE_MAX];
  uint16_t Pdu_size[8];
294 295 296 297 298
} __attribute__ ((__packed__)) DLSCH_PDU;

/*! \brief MCH PDU Structure
 */
typedef struct {
gauthier's avatar
gauthier committed
299 300
  int8_t payload[SCH_PAYLOAD_SIZE_MAX];
  uint16_t Pdu_size;
301
  uint8_t mcs;
302 303 304 305
  uint8_t sync_area;
  uint8_t msi_active;
  uint8_t mcch_active;
  uint8_t mtch_active;  
306 307 308 309 310
} __attribute__ ((__packed__)) MCH_PDU;

/*! \brief Uplink SCH PDU Structure
 */
typedef struct {
gauthier's avatar
gauthier committed
311 312
  int8_t payload[SCH_PAYLOAD_SIZE_MAX];         /*!< \brief SACH payload */
  uint16_t Pdu_size;
313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335
} __attribute__ ((__packed__)) ULSCH_PDU;

#include "PHY/impl_defs_top.h"

typedef enum {
  S_UL_NONE =0,
  S_UL_WAITING,
  S_UL_SCHEDULED, 
  S_UL_BUFFERED,  
  S_UL_NUM_STATUS
} UE_ULSCH_STATUS;

typedef enum {
  S_DL_NONE =0,
  S_DL_WAITING,
  S_DL_SCHEDULED, 
  S_DL_BUFFERED,  
  S_DL_NUM_STATUS
} UE_DLSCH_STATUS;

// temp struct for sched
typedef struct {
  
gauthier's avatar
gauthier committed
336
  rnti_t rnti;
gauthier's avatar
gauthier committed
337 338
  uint16_t subframe;
  uint16_t serving_num;
339 340 341 342 343
  UE_ULSCH_STATUS status;
} eNB_ULSCH_INFO;
// temp struct for sched
typedef struct {
  
gauthier's avatar
gauthier committed
344
  rnti_t rnti;
gauthier's avatar
gauthier committed
345 346 347
  uint16_t weight;
  uint16_t subframe;
  uint16_t serving_num;
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385
  UE_DLSCH_STATUS status;
} eNB_DLSCH_INFO;
typedef struct{
  /// BW
  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;

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

typedef struct{

  /// CRNTI of UE
gauthier's avatar
gauthier committed
386
  rnti_t crnti; ///user id (rnti) of connected UEs
387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468
  // rrc status 
  uint8_t rrc_status;
  /// harq pid
  uint8_t harq_pid;
  /// harq rounf 
  uint8_t harq_round;
  /// DL Wideband CQI index (2 TBs) 
  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;
  /// 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];
 
  /// 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 
  /// 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; 
  /// overall 

  // total MAC pdu bytes
  uint64_t total_pdu_bytes_rx;
  // total num pdu
  uint32_t total_num_pdus_rx;

}eNB_UE_STATS;
 
typedef struct{
  /// C-RNTI of UE
gauthier's avatar
gauthier committed
469
  rnti_t rnti;
470 471 472 473
  /// NDI from last scheduling
  uint8_t oldNDI[8];
  /// NDI from last UL scheduling
  uint8_t oldNDI_UL[8];
474
  /// Flag to indicate UL has been scheduled at least once
gauthier's avatar
gauthier committed
475
  boolean_t ul_active;
476 477 478 479

  // PHY interface info

  /// DCI format for DLSCH
gauthier's avatar
gauthier committed
480
  uint16_t DLSCH_dci_fmt;
481 482
  
  /// Current Aggregation Level for DCI
gauthier's avatar
gauthier committed
483
  uint8_t DCI_aggregation_min;
484 485

  /// 
gauthier's avatar
gauthier committed
486
  uint8_t DLSCH_dci_size_bits;
487 488

  /// DCI buffer for DLSCH
gauthier's avatar
gauthier committed
489
  uint8_t DLSCH_DCI[8][(MAX_DCI_SIZE_BITS>>3)+1];
490 491

  /// Number of Allocated RBs for DL after scheduling (prior to frequency allocation)
gauthier's avatar
gauthier committed
492
  uint16_t nb_rb[8];
493 494

  /// Number of Allocated RBs for UL after scheduling (prior to frequency allocation)
gauthier's avatar
gauthier committed
495
  uint16_t nb_rb_ul[8];
496 497

  /// DCI buffer for ULSCH
gauthier's avatar
gauthier committed
498
  uint8_t ULSCH_DCI[8][(MAX_DCI_SIZE_BITS>>3)+1];
499 500

  /// DL DAI
gauthier's avatar
gauthier committed
501
  uint8_t DAI;
502 503

  /// UL DAI
gauthier's avatar
gauthier committed
504
  uint8_t DAI_ul[10];
505 506

  /// UL Scheduling Request Received
gauthier's avatar
gauthier committed
507
  uint8_t ul_SR;
508 509

  //Resource Block indication for each sub-band in MU-MIMO 
gauthier's avatar
gauthier committed
510
  uint8_t rballoc_subband[8][50];
511 512 513 514

  // Logical channel info for link with RLC

  /// UE BSR info for each logical channel group id
gauthier's avatar
gauthier committed
515
  uint8_t bsr_info[MAX_NUM_LCGID];
516 517

  /// phr information
gauthier's avatar
gauthier committed
518
  uint8_t phr_info;
519 520

  //dl buffer info
gauthier's avatar
gauthier committed
521
  uint32_t dl_buffer_info[MAX_NUM_LCID];
522

gauthier's avatar
gauthier committed
523
  uint32_t dl_buffer_total;
524

gauthier's avatar
gauthier committed
525
  uint32_t dl_pdus_total;
526

gauthier's avatar
gauthier committed
527
  uint32_t dl_pdus_in_buffer[MAX_NUM_LCID];
528
  
gauthier's avatar
gauthier committed
529
  uint32_t dl_buffer_head_sdu_creation_time[MAX_NUM_LCID];
530

gauthier's avatar
gauthier committed
531
  uint8_t    dl_buffer_head_sdu_is_segmented[MAX_NUM_LCID];
532

gauthier's avatar
gauthier committed
533
  uint32_t dl_buffer_head_sdu_remaining_size_to_send[MAX_NUM_LCID];
534

535 536
} UE_TEMPLATE;

537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564
typedef struct{
		//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;
		
		uint16_t max_allowed_rbs[MAX_NUM_LCID];

		uint8_t max_mcs[MAX_NUM_LCID];

		uint16_t priority[MAX_NUM_LCID];
	
} UE_sched_ctrl;

565 566
typedef struct {
  /// Flag to indicate this process is active
gauthier's avatar
gauthier committed
567
  boolean_t RA_active;
568
  /// Size of DCI for RA-Response (bytes)
gauthier's avatar
gauthier committed
569
  uint8_t RA_dci_size_bytes1;
570
  /// Size of DCI for RA-Response (bits)
gauthier's avatar
gauthier committed
571
  uint8_t RA_dci_size_bits1;
572
  /// Actual DCI to transmit for RA-Response
gauthier's avatar
gauthier committed
573
  uint8_t RA_alloc_pdu1[(MAX_DCI_SIZE_BITS>>3)+1];
574
  /// DCI format for RA-Response (should be 1A)
gauthier's avatar
gauthier committed
575
  uint8_t RA_dci_fmt1;
576
  /// Size of DCI for Msg4/ContRes (bytes)  
gauthier's avatar
gauthier committed
577
  uint8_t RA_dci_size_bytes2;
578
  /// Size of DCI for Msg4/ContRes (bits)  
gauthier's avatar
gauthier committed
579
  uint8_t RA_dci_size_bits2;
580
  /// Actual DCI to transmit for Msg4/ContRes
gauthier's avatar
gauthier committed
581
  uint8_t RA_alloc_pdu2[(MAX_DCI_SIZE_BITS>>3)+1];
582
  /// DCI format for Msg4/ContRes (should be 1A)
gauthier's avatar
gauthier committed
583
  uint8_t RA_dci_fmt2;
584
  /// Flag to indicate the eNB should generate RAR.  This is triggered by detection of PRACH
gauthier's avatar
gauthier committed
585
  uint8_t generate_rar;
586
  /// Subframe where preamble was received
gauthier's avatar
gauthier committed
587
  uint8_t preamble_subframe;
588
  /// Subframe where Msg3 is to be sent
gauthier's avatar
gauthier committed
589
  uint8_t Msg3_subframe;
590
  /// 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.
gauthier's avatar
gauthier committed
591
    uint8_t generate_Msg4;
592
  /// Flag to indicate the eNB should generate the DCI for Msg4, after getting the SDU from RRC.
gauthier's avatar
gauthier committed
593
  uint8_t generate_Msg4_dci;
594
  /// Flag to indicate that eNB is waiting for ACK that UE has received Msg3.
gauthier's avatar
gauthier committed
595
  uint8_t wait_ack_Msg4;
596
  /// UE RNTI allocated during RAR
gauthier's avatar
gauthier committed
597
  rnti_t rnti;
598
  /// RA RNTI allocated from received PRACH
gauthier's avatar
gauthier committed
599
  uint16_t RA_rnti;
600
  /// Received preamble_index
gauthier's avatar
gauthier committed
601
  uint8_t preamble_index;
602
  /// Received UE Contention Resolution Identifier 
gauthier's avatar
gauthier committed
603
  uint8_t cont_res_id[6];
604
  /// Timing offset indicated by PHY
gauthier's avatar
gauthier committed
605
  int16_t timing_offset;
606
  /// Timeout for RRC connection 
gauthier's avatar
gauthier committed
607
  int16_t RRC_timer;
608 609 610 611 612 613
} RA_TEMPLATE;


///subband bitmap coniguration (for ALU icic algo purpose), in test phase

typedef struct{
gauthier's avatar
gauthier committed
614 615 616 617 618
	uint8_t sbmap[NUMBER_OF_SUBBANDS]; //13 = number of SB MAX for 100 PRB
	uint8_t periodicity;
	uint8_t first_subframe;
	uint8_t sb_size;
	uint8_t nb_active_sb;
619 620 621 622 623 624 625

}SBMAP_CONF;

//end ALU's algo

typedef struct{
  /// 
gauthier's avatar
gauthier committed
626
  uint16_t Node_id;
627
  /// frame counter
gauthier's avatar
gauthier committed
628
  frame_t frame;
629
  /// subframe counter
gauthier's avatar
gauthier committed
630
  sub_frame_t subframe;
631 632 633 634
  /// Outgoing DCI for PHY generated by eNB scheduler
  DCI_PDU DCI_pdu;
  /// Outgoing BCCH pdu for PHY
  BCCH_PDU BCCH_pdu;
635 636
  /// Outgoing BCCH DCI allocation
  uint32_t BCCH_alloc_pdu;
637 638 639 640 641 642 643 644 645
  /// Outgoing CCCH pdu for PHY
  CCCH_PDU CCCH_pdu;
  /// Outgoing DLSCH pdu for PHY
  DLSCH_PDU DLSCH_pdu[NUMBER_OF_UE_MAX+1][2];
  /// DCI template and MAC connection parameters for UEs
  UE_TEMPLATE UE_template[NUMBER_OF_UE_MAX];
  /// DCI template and MAC connection for RA processes
  RA_TEMPLATE RA_template[NB_RA_PROC_MAX];
  /// BCCH active flag
gauthier's avatar
gauthier committed
646
  uint8_t bcch_active;
647 648
  /// MBSFN SubframeConfig
  struct MBSFN_SubframeConfig *mbsfn_SubframeConfig[8];
649
  /// number of subframe allocation pattern available for MBSFN sync area 
gauthier's avatar
gauthier committed
650
  uint8_t num_sf_allocation_pattern;
651 652
#ifdef Rel10 
  /// MBMS Flag
gauthier's avatar
gauthier committed
653
  uint8_t MBMS_flag;
654 655 656
  /// Outgoing MCCH pdu for PHY
  MCCH_PDU MCCH_pdu;
  /// MCCH active flag
gauthier's avatar
gauthier committed
657
  uint8_t msi_active;
658
  /// MCCH active flag
gauthier's avatar
gauthier committed
659
  uint8_t mcch_active;
660
  /// MTCH active flag
gauthier's avatar
gauthier committed
661
  uint8_t mtch_active;
662
  /// number of active MBSFN area 
gauthier's avatar
gauthier committed
663
  uint8_t num_active_mbsfn_area;
664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680
  /// 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
  uint8_t num_active_cba_groups; 
  uint16_t cba_rnti[NUM_MAX_CBA_GROUP];
#endif 
  ///subband bitmap configuration
  SBMAP_CONF sbmap_conf;
  
  ///  active flag for Other lcid 
gauthier's avatar
gauthier committed
681
  uint8_t lcid_active[NB_RB_MAX];
682 683 684 685
  // eNB stats 
  eNB_STATS eNB_stats;
  /// eNB to UE statistics 
  eNB_UE_STATS eNB_UE_stats[NUMBER_OF_UE_MAX];
686
  UE_sched_ctrl UE_sched_ctrl[NUMBER_OF_UE_MAX];
687 688 689 690 691 692 693 694 695 696 697
  // MAC function execution peformance profiler
  time_stats_t eNB_scheduler;
  time_stats_t schedule_si;
  time_stats_t schedule_ra;
  time_stats_t schedule_ulsch;
  time_stats_t fill_DLSCH_dci;
  time_stats_t schedule_dlsch_preprocessor; 
  time_stats_t schedule_dlsch; // include rlc_data_req + MAC header + preprocessor
  time_stats_t schedule_mch;
  time_stats_t rx_ulsch_sdu; // include rlc_data_ind
  
698 699 700 701
}eNB_MAC_INST;

typedef struct {
  /// buffer status for each lcgid
gauthier's avatar
gauthier committed
702
  uint8_t  BSR[MAX_NUM_LCGID]; // should be more for mesh topology
703
  /// keep the number of bytes in rlc buffer for each lcid
gauthier's avatar
gauthier committed
704
  uint16_t  BSR_bytes[MAX_NUM_LCGID];
705
  /// buffer status for each lcid
gauthier's avatar
gauthier committed
706
  uint8_t  LCID_status[MAX_NUM_LCID];
707
  /// SR pending as defined in 36.321
gauthier's avatar
gauthier committed
708
  uint8_t  SR_pending;
709
  /// SR_COUNTER as defined in 36.321
gauthier's avatar
gauthier committed
710
  uint16_t SR_COUNTER;
711
  /// logical channel group ide for each LCID
gauthier's avatar
gauthier committed
712
  uint8_t  LCGID[MAX_NUM_LCID];
713
  /// retxBSR-Timer, default value is sf2560
gauthier's avatar
gauthier committed
714
  uint16_t retxBSR_Timer;
715
  /// retxBSR_SF, number of subframe before triggering a regular BSR 
gauthier's avatar
gauthier committed
716
  int16_t retxBSR_SF;
717
  /// periodicBSR-Timer, default to infinity
gauthier's avatar
gauthier committed
718
  uint16_t periodicBSR_Timer;
719
  /// periodicBSR_SF, number of subframe before triggering a periodic BSR 
gauthier's avatar
gauthier committed
720
  int16_t periodicBSR_SF;
721
  /// default value is 0: not configured
gauthier's avatar
gauthier committed
722
  uint16_t sr_ProhibitTimer;
723
  /// sr ProhibitTime running
gauthier's avatar
gauthier committed
724
  uint8_t sr_ProhibitTimer_Running;
725
  ///  default value to n5
gauthier's avatar
gauthier committed
726
  uint16_t maxHARQ_Tx;
727
  /// default value is false
gauthier's avatar
gauthier committed
728
  uint16_t ttiBundling;
729 730 731 732 733
  /// 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
gauthier's avatar
gauthier committed
734
  uint16_t periodicPHR_Timer;
735
  ///timer before triggering a prohibit PHR
gauthier's avatar
gauthier committed
736
  uint16_t prohibitPHR_Timer;
737
  ///DL Pathloss change value 
gauthier's avatar
gauthier committed
738
  uint16_t PathlossChange;
739
  ///number of subframe before triggering a periodic PHR
gauthier's avatar
gauthier committed
740
  int16_t periodicPHR_SF;
741
  ///number of subframe before triggering a prohibit PHR
gauthier's avatar
gauthier committed
742
  int16_t prohibitPHR_SF;
743
  ///DL Pathloss Change in db 
gauthier's avatar
gauthier committed
744
  uint16_t PathlossChange_db;
745
  //Bj bucket usage per  lcid
gauthier's avatar
gauthier committed
746
  int16_t Bj[MAX_NUM_LCID];
747
  // Bucket size per lcid
gauthier's avatar
gauthier committed
748
  int16_t bucket_size[MAX_NUM_LCID];
749 750 751
} UE_SCHEDULING_INFO;

typedef struct{
gauthier's avatar
gauthier committed
752
  uint16_t Node_id;
753
  /// frame counter
gauthier's avatar
gauthier committed
754
  frame_t     frame;
755
  /// subframe counter
gauthier's avatar
gauthier committed
756
  sub_frame_t subframe;
757
  /// C-RNTI of UE
gauthier's avatar
gauthier committed
758
  uint16_t crnti;
759
  /// C-RNTI of UE before HO
gauthier's avatar
gauthier committed
760
  rnti_t crnti_before_ho; ///user id (rnti) of connected UEs
761 762 763 764
  /// uplink active flag
  uint8_t ul_active;
  /// pointer to RRC PHY configuration 
  RadioResourceConfigCommonSIB_t *radioResourceConfigCommon;
765 766
  /// pointer to RACH_ConfigDedicated (NULL when not active, i.e. upon HO completion or T304 expiry)
  struct RACH_ConfigDedicated	*rach_ConfigDedicated;
767 768 769 770 771
  /// pointer to RRC PHY configuration 
  struct PhysicalConfigDedicated *physicalConfigDedicated;
  /// pointer to TDD Configuration (NULL for FDD)
  TDD_Config_t *tdd_Config;
  /// Number of adjacent cells to measure
gauthier's avatar
gauthier committed
772
  uint8_t  n_adj_cells;
773
  /// Array of adjacent physical cell ids
gauthier's avatar
gauthier committed
774
  uint32_t adj_cell_id[6];
775 776 777 778 779 780 781 782 783 784 785 786 787
  /// 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;
  /// Incoming DLSCH pdu for PHY
  //DLSCH_PDU DLSCH_pdu[NUMBER_OF_UE_MAX][2];
  /// number of attempt for rach
gauthier's avatar
gauthier committed
788
  uint8_t RA_attempt_number;
789
  /// Random-access procedure flag
gauthier's avatar
gauthier committed
790
  uint8_t RA_active;
791
  /// Random-access window counter
gauthier's avatar
gauthier committed
792
  int8_t RA_window_cnt;
793
  /// Random-access Msg3 size in bytes
gauthier's avatar
gauthier committed
794
  uint8_t RA_Msg3_size;
795
  /// Random-access prachMaskIndex
gauthier's avatar
gauthier committed
796
  uint8_t RA_prachMaskIndex;
797
  /// Flag indicating Preamble set (A,B) used for first Msg3 transmission
gauthier's avatar
gauthier committed
798
  uint8_t RA_usedGroupA;
799 800 801
  /// Random-access Resources
  PRACH_RESOURCES_t RA_prach_resources;
  /// Random-access PREAMBLE_TRANSMISSION_COUNTER
gauthier's avatar
gauthier committed
802
  uint8_t RA_PREAMBLE_TRANSMISSION_COUNTER;
803
  /// Random-access backoff counter
gauthier's avatar
gauthier committed
804
  int16_t RA_backoff_cnt;
805
  /// Random-access variable for window calculation (frame of last change in window counter)
gauthier's avatar
gauthier committed
806
  uint32_t RA_tx_frame;
807
  /// Random-access variable for window calculation (subframe of last change in window counter)
gauthier's avatar
gauthier committed
808
  uint8_t RA_tx_subframe;
809 810
  /// Random-access Group B maximum path-loss
  /// Random-access variable for backoff (frame of last change in backoff counter)
gauthier's avatar
gauthier committed
811
  uint32_t RA_backoff_frame;
812
  /// Random-access variable for backoff (subframe of last change in backoff counter)
gauthier's avatar
gauthier committed
813
  uint8_t RA_backoff_subframe;
814
  /// Random-access Group B maximum path-loss
gauthier's avatar
gauthier committed
815
  uint16_t RA_maxPL;
816
  /// Random-access Contention Resolution Timer active flag
gauthier's avatar
gauthier committed
817
  uint8_t RA_contention_resolution_timer_active;
818
  /// Random-access Contention Resolution Timer count value
gauthier's avatar
gauthier committed
819
  uint8_t RA_contention_resolution_cnt;
820
  /// power headroom reporitng reconfigured 
gauthier's avatar
gauthier committed
821
  uint8_t PHR_reconfigured;
822
  /// power headroom state as configured by the higher layers
gauthier's avatar
gauthier committed
823
  uint8_t PHR_state;
824
  /// power backoff due to power management (as allowed by P-MPRc) for this cell
gauthier's avatar
gauthier committed
825
  uint8_t PHR_reporting_active;
826
  /// power backoff due to power management (as allowed by P-MPRc) for this cell
gauthier's avatar
gauthier committed
827
  uint8_t power_backoff_db[NUMBER_OF_eNB_MAX];
828 829
  /// MBSFN_Subframe Configuration
  struct MBSFN_SubframeConfig *mbsfn_SubframeConfig[8];
830
  /// number of subframe allocation pattern available for MBSFN sync area 
gauthier's avatar
gauthier committed
831
  uint8_t num_sf_allocation_pattern;
832
#ifdef Rel10
833
 /// number of active MBSFN area 
gauthier's avatar
gauthier committed
834
  uint8_t num_active_mbsfn_area;
835 836 837 838 839
  /// 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
gauthier's avatar
gauthier committed
840
  uint8_t mcch_status;
841
  /// MSI status
gauthier's avatar
gauthier committed
842
  uint8_t msi_status;// could be an array if there are >1 MCH in one MBSFN area
843 844 845 846 847
#endif
//#ifdef CBA
  uint16_t cba_rnti[NUM_MAX_CBA_GROUP];
  uint8_t cba_last_access[NUM_MAX_CBA_GROUP];
//#endif
848 849 850 851 852 853 854 855
  
  time_stats_t ue_scheduler; // total 
  time_stats_t tx_ulsch_sdu;  // inlcude rlc_data_req + mac header gen
  time_stats_t rx_dlsch_sdu ; // include mac_rrc_data_ind or mac_rlc_status_ind+mac_rlc_data_ind and  mac header parser
  time_stats_t ue_query_mch; 
  time_stats_t rx_mch_sdu; 
  time_stats_t rx_si; // include mac_rrc_data_ind
    
856 857 858
}UE_MAC_INST;

typedef struct {
gauthier's avatar
gauthier committed
859 860
  uint16_t cell_ids[6];
  uint8_t n_adj_cells;
861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900
} neigh_cell_id_t;


/* \brief Generate header for DL-SCH.  This function parses the desired control elements and sdus and generates the header as described
in 36-321 MAC layer specifications.  It returns the number of bytes used for the header to be used as an offset for the payload 
in the DLSCH buffer.
@param mac_header Pointer to the first byte of the MAC header (DL-SCH buffer)
@param num_sdus Number of SDUs in the payload
@param sdu_lengths Pointer to array of SDU lengths
@param sdu_lcids Pointer to array of LCIDs (the order must be the same as the SDU length array)
@param drx_cmd dicontinous reception command 
@param timing_advancd_cmd timing advanced command
@param ue_cont_res_id Pointer to contention resolution identifier (NULL means not present in payload)
@param short_padding Number of bytes for short padding (0,1,2)
@param post_padding number of bytes for padding at the end of MAC PDU 
@returns Number of bytes used for header
*/
unsigned char generate_dlsch_header(unsigned char *mac_header,
				    unsigned char num_sdus,
				    unsigned short *sdu_lengths,
				    unsigned char *sdu_lcids,
				    unsigned char drx_cmd,
				    short timing_advance_cmd,
				    unsigned char *ue_cont_res_id,
				    unsigned char short_padding,
				    unsigned short post_padding);

/** \brief RRC Configuration primitive for PHY/MAC.  Allows configuration of PHY/MAC resources based on System Information (SI), RRCConnectionSetup and RRCConnectionReconfiguration messages.
@param Mod_id Instance ID of eNB
@param eNB_flag Indicates if this is a eNB or UE configuration
@param UE_id Index of UE if this is an eNB configuration
@param eNB_id Index of eNB if this is a UE configuration
@param radioResourceConfigCommon Structure from SIB2 for common radio parameters (if NULL keep existing configuration)
@param physcialConfigDedicated Structure from RRCConnectionSetup or RRCConnectionReconfiguration for dedicated PHY parameters (if NULL keep existing configuration)
@param measObj Structure from RRCConnectionReconfiguration for UE measurement procedures
@param mac_MainConfig Structure from RRCConnectionSetup or RRCConnectionReconfiguration for dedicated MAC parameters (if NULL keep existing configuration)
@param logicalChannelIdentity Logical channel identity index of corresponding logical channel config 
@param logicalChannelConfig Pointer to logical channel configuration
@param measGapConfig Measurement Gap configuration for MAC (if NULL keep existing configuration)
@param tdd_Config TDD Configuration from SIB1 (if NULL keep existing configuration)
901
@param mobilityControlInfo mobility control info received for Handover
902 903 904 905 906 907 908
@param SIwindowsize SI Windowsize from SIB1 (if NULL keep existing configuration)
@param SIperiod SI Period from SIB1 (if NULL keep existing configuration)
@param MBMS_Flag indicates MBMS transmission
@param mbsfn_SubframeConfigList pointer to mbsfn subframe configuration list from SIB2
@param mbsfn_AreaInfoList pointer to MBSFN Area Info list from SIB13
@param pmch_InfoList pointer to PMCH_InfoList from MBSFNAreaConfiguration Message (MCCH Message)
*/
gauthier's avatar
gauthier committed
909 910
int rrc_mac_config_req(module_id_t     module_idP,
                       eNB_flag_t eNB_flag,
gauthier's avatar
gauthier committed
911 912
                       uint8_t         UE_id,
                       uint8_t         eNB_index,
gauthier's avatar
gauthier committed
913 914 915 916 917 918 919 920 921
                       RadioResourceConfigCommonSIB_t *radioResourceConfigCommon,
                       struct PhysicalConfigDedicated *physicalConfigDedicated,
                       MeasObjectToAddMod_t **measObj,
                       MAC_MainConfig_t *mac_MainConfig,
                       long logicalChannelIdentity,
                       LogicalChannelConfig_t *logicalChannelConfig,
                       MeasGapConfig_t *measGapConfig,
                       TDD_Config_t *tdd_Config,
                       MobilityControlInfo_t *mobilityControlInfo,
gauthier's avatar
gauthier committed
922 923
                       uint8_t *SIwindowsize,
                       uint16_t *SIperiod,
gauthier's avatar
gauthier committed
924 925 926 927
                       ARFCN_ValueEUTRA_t *ul_CarrierFreq,
                       long *ul_Bandwidth,
                       AdditionalSpectrumEmission_t *additionalSpectrumEmission,
                       struct MBSFN_SubframeConfigList *mbsfn_SubframeConfigList
928
#ifdef Rel10
gauthier's avatar
gauthier committed
929
                       ,
gauthier's avatar
gauthier committed
930
                       uint8_t MBMS_Flag,
gauthier's avatar
gauthier committed
931 932
                       MBSFN_AreaInfoList_r9_t *mbsfn_AreaInfoList,
                       PMCH_InfoList_r9_t *pmch_InfoList
933 934 935

#endif
#ifdef CBA
gauthier's avatar
gauthier committed
936
                       ,
gauthier's avatar
gauthier committed
937 938
                       uint8_t num_active_cba_groups,
                       uint16_t cba_rnti
939 940 941 942 943 944 945 946 947 948
#endif
		       );



/*@}*/
#endif /*__LAYER2_MAC_DEFS_H__ */