defs.h 54.4 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 31 32 33
/*******************************************************************************

  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
* \author Raymond Knopp, Navid Nikaein
* \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

88 89 90 91 92
#ifdef EXMIMO_IOT 
#define DTCH  5 // DTCH + lcid < 11
#else
#define DTCH 3 
#endif
93 94

#define MCCH 4 // MCCH
95
#define MTCH 1 // MTCH
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115

#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
116
//#define MCH_PAYLOAD_SIZE_MAX 16384// this value is using in case mcs and TBS index are high
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133
#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) 

134 135
#define N_RBGS_MAX 25

136 137 138 139 140 141 142 143 144 145 146
#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,
147 148
  PHY_RESYNCH,
  PHY_HO_PRACH
149 150 151
} UE_L2_STATE_t;

typedef struct {
152 153 154
  uint8_t RAPID:6;
  uint8_t T:1;
  uint8_t E:1;
155 156 157
} __attribute__((__packed__))RA_HEADER_RAPID;

typedef struct {
158 159 160 161
  uint8_t BI:4;
  uint8_t R:2;
  uint8_t T:1;
  uint8_t E:1;
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 190 191 192 193
} __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 {
194 195 196 197 198
  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
199 200 201
} __attribute__((__packed__))SCH_SUBHEADER_SHORT;

typedef struct {
202 203 204 205 206 207 208
  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;
209 210 211
} __attribute__((__packed__))SCH_SUBHEADER_LONG;
 
typedef struct {
212 213 214
  uint8_t LCID:5;
  uint8_t E:1;
  uint8_t R:2;
215 216 217
} __attribute__((__packed__))SCH_SUBHEADER_FIXED;

typedef struct {
218 219
  uint8_t Buffer_size:6;  // octet 1 LSB
  uint8_t LCGID:2;        // octet 1 MSB
220 221 222 223 224
} __attribute__((__packed__))BSR_SHORT;

typedef BSR_SHORT BSR_TRUNCATED;

typedef struct {
225 226 227 228 229
  uint32_t Buffer_size3:6;
  uint32_t Buffer_size2:6;
  uint32_t Buffer_size1:6;
  uint32_t Buffer_size0:6;
  uint32_t padding:8;
230 231 232 233 234
} __attribute__((__packed__))BSR_LONG;

#define BSR_LONG_SIZE  (sizeof(BSR_LONG))

typedef struct {
235 236
  uint8_t TA:6;
  uint8_t R:2;
237 238 239
} __attribute__((__packed__))TIMING_ADVANCE_CMD;

typedef struct {
240 241
  uint8_t PH:6;
  uint8_t R:2;
242 243 244
} __attribute__((__packed__))POWER_HEADROOM_CMD;

typedef struct {
245 246
  uint8_t Num_ue_spec_dci ;
  uint8_t Num_common_dci  ;
247 248 249 250 251
  unsigned int nCCE;
  DCI_ALLOC_t dci_alloc[NUM_DCI_MAX] ;
} DCI_PDU;

typedef struct {
252
  uint8_t payload[CCCH_PAYLOAD_SIZE_MAX] ;/*!< \brief CCCH payload */
253 254 255
} __attribute__((__packed__))CCCH_PDU;

typedef struct {
256
  uint8_t payload[BCCH_PAYLOAD_SIZE_MAX] ;/*!< \brief CCCH payload */
257 258 259 260
} __attribute__((__packed__))BCCH_PDU;

#ifdef Rel10
typedef struct {
261
  uint8_t payload[MCCH_PAYLOAD_SIZE_MAX] ;/*!< \brief MCCH payload */
262 263 264 265
} __attribute__((__packed__))MCCH_PDU;
#endif

typedef struct{
266 267 268
  uint8_t stop_sf_MSB:3; // octet 1 LSB
  uint8_t lcid:5;        // octet 2 MSB
  uint8_t stop_sf_LSB:8;
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295
} __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 {
296 297
  int8_t payload[8][SCH_PAYLOAD_SIZE_MAX];
  uint16_t Pdu_size[8];
298 299 300 301 302
} __attribute__ ((__packed__)) DLSCH_PDU;

/*! \brief MCH PDU Structure
 */
typedef struct {
303 304
  int8_t payload[SCH_PAYLOAD_SIZE_MAX];
  uint16_t Pdu_size;
305
  uint8_t mcs;
306 307 308 309
  uint8_t sync_area;
  uint8_t msi_active;
  uint8_t mcch_active;
  uint8_t mtch_active;  
310 311 312 313 314
} __attribute__ ((__packed__)) MCH_PDU;

/*! \brief Uplink SCH PDU Structure
 */
typedef struct {
315 316
  int8_t payload[SCH_PAYLOAD_SIZE_MAX];         /*!< \brief SACH payload */
  uint16_t Pdu_size;
317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339
} __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 {
  
340
  rnti_t rnti;
341 342
  uint16_t subframe;
  uint16_t serving_num;
343 344 345 346 347
  UE_ULSCH_STATUS status;
} eNB_ULSCH_INFO;
// temp struct for sched
typedef struct {
  
348
  rnti_t rnti;
349 350 351
  uint16_t weight;
  uint16_t subframe;
  uint16_t serving_num;
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 386 387 388 389
  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
390
  rnti_t crnti; ///user id (rnti) of connected UEs
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 469 470 471 472
  // 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
473
  rnti_t rnti;
474 475 476 477
  /// NDI from last scheduling
  uint8_t oldNDI[8];
  /// NDI from last UL scheduling
  uint8_t oldNDI_UL[8];
478
  /// Flag to indicate UL has been scheduled at least once
Lionel Gauthier's avatar
Lionel Gauthier committed
479
  boolean_t ul_active;
480 481 482 483

  // PHY interface info

  /// DCI format for DLSCH
484
  uint16_t DLSCH_dci_fmt;
485 486
  
  /// Current Aggregation Level for DCI
487
  uint8_t DCI_aggregation_min;
488 489

  /// 
490
  uint8_t DLSCH_dci_size_bits;
491 492

  /// DCI buffer for DLSCH
493
  uint8_t DLSCH_DCI[8][(MAX_DCI_SIZE_BITS>>3)+1];
494 495

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

  /// Number of Allocated RBs for UL after scheduling (prior to frequency allocation)
499
  uint16_t nb_rb_ul[8];
500 501

  /// DCI buffer for ULSCH
502
  uint8_t ULSCH_DCI[8][(MAX_DCI_SIZE_BITS>>3)+1];
503 504

  /// DL DAI
505
  uint8_t DAI;
506 507

  /// UL DAI
508
  uint8_t DAI_ul[10];
509 510

  /// UL Scheduling Request Received
511
  uint8_t ul_SR;
512 513

  //Resource Block indication for each sub-band in MU-MIMO 
514
  uint8_t rballoc_subband[8][50];
515 516 517 518

  // Logical channel info for link with RLC

  /// UE BSR info for each logical channel group id
519
  uint8_t bsr_info[MAX_NUM_LCGID];
520 521

  /// phr information
522
  uint8_t phr_info;
523 524

  //dl buffer info
525
  uint32_t dl_buffer_info[MAX_NUM_LCID];
526

527
  uint32_t dl_buffer_total;
528

529
  uint32_t dl_pdus_total;
530

531
  uint32_t dl_pdus_in_buffer[MAX_NUM_LCID];
532
  
533
  uint32_t dl_buffer_head_sdu_creation_time[MAX_NUM_LCID];
534

535
  uint8_t    dl_buffer_head_sdu_is_segmented[MAX_NUM_LCID];
536

537
  uint32_t dl_buffer_head_sdu_remaining_size_to_send[MAX_NUM_LCID];
538

539 540 541 542
} UE_TEMPLATE;

typedef struct {
  /// Flag to indicate this process is active
Lionel Gauthier's avatar
Lionel Gauthier committed
543
  boolean_t RA_active;
544
  /// Size of DCI for RA-Response (bytes)
545
  uint8_t RA_dci_size_bytes1;
546
  /// Size of DCI for RA-Response (bits)
547
  uint8_t RA_dci_size_bits1;
548
  /// Actual DCI to transmit for RA-Response
549
  uint8_t RA_alloc_pdu1[(MAX_DCI_SIZE_BITS>>3)+1];
550
  /// DCI format for RA-Response (should be 1A)
551
  uint8_t RA_dci_fmt1;
552
  /// Size of DCI for Msg4/ContRes (bytes)  
553
  uint8_t RA_dci_size_bytes2;
554
  /// Size of DCI for Msg4/ContRes (bits)  
555
  uint8_t RA_dci_size_bits2;
556
  /// Actual DCI to transmit for Msg4/ContRes
557
  uint8_t RA_alloc_pdu2[(MAX_DCI_SIZE_BITS>>3)+1];
558
  /// DCI format for Msg4/ContRes (should be 1A)
559
  uint8_t RA_dci_fmt2;
560
  /// Flag to indicate the eNB should generate RAR.  This is triggered by detection of PRACH
561
  uint8_t generate_rar;
562
  /// Subframe where preamble was received
563
  uint8_t preamble_subframe;
564
  /// Subframe where Msg3 is to be sent
565
  uint8_t Msg3_subframe;
566
  /// 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.
567
    uint8_t generate_Msg4;
568
  /// Flag to indicate the eNB should generate the DCI for Msg4, after getting the SDU from RRC.
569
  uint8_t generate_Msg4_dci;
570
  /// Flag to indicate that eNB is waiting for ACK that UE has received Msg3.
571
  uint8_t wait_ack_Msg4;
572
  /// UE RNTI allocated during RAR
573
  rnti_t rnti;
574
  /// RA RNTI allocated from received PRACH
575
  uint16_t RA_rnti;
576
  /// Received preamble_index
577
  uint8_t preamble_index;
578
  /// Received UE Contention Resolution Identifier 
579
  uint8_t cont_res_id[6];
580
  /// Timing offset indicated by PHY
581
  int16_t timing_offset;
582
  /// Timeout for RRC connection 
583
  int16_t RRC_timer;
584 585 586 587 588 589
} RA_TEMPLATE;


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

typedef struct{
590 591 592 593 594
	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;
595 596 597 598 599 600 601

}SBMAP_CONF;

//end ALU's algo

typedef struct{
  /// 
602
  uint16_t Node_id;
603
  /// frame counter
604
  frame_t frame;
605
  /// subframe counter
606
  sub_frame_t subframe;
607 608 609 610
  /// Outgoing DCI for PHY generated by eNB scheduler
  DCI_PDU DCI_pdu;
  /// Outgoing BCCH pdu for PHY
  BCCH_PDU BCCH_pdu;
611 612
  /// Outgoing BCCH DCI allocation
  uint32_t BCCH_alloc_pdu;
613 614 615 616 617 618 619 620 621
  /// 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
622
  uint8_t bcch_active;
623 624
  /// MBSFN SubframeConfig
  struct MBSFN_SubframeConfig *mbsfn_SubframeConfig[8];
625
  /// number of subframe allocation pattern available for MBSFN sync area 
626
  uint8_t num_sf_allocation_pattern;
627 628
#ifdef Rel10 
  /// MBMS Flag
629
  uint8_t MBMS_flag;
630 631 632
  /// Outgoing MCCH pdu for PHY
  MCCH_PDU MCCH_pdu;
  /// MCCH active flag
633
  uint8_t msi_active;
634
  /// MCCH active flag
635
  uint8_t mcch_active;
636
  /// MTCH active flag
637
  uint8_t mtch_active;
638
  /// number of active MBSFN area 
639
  uint8_t num_active_mbsfn_area;
640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656
  /// 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 
657
  uint8_t lcid_active[NB_RB_MAX];
658 659 660 661
  // eNB stats 
  eNB_STATS eNB_stats;
  /// eNB to UE statistics 
  eNB_UE_STATS eNB_UE_stats[NUMBER_OF_UE_MAX];
662 663 664 665 666 667 668 669 670 671 672 673
  
  // 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
  
674 675 676 677
}eNB_MAC_INST;

typedef struct {
  /// buffer status for each lcgid
678
  uint8_t  BSR[MAX_NUM_LCGID]; // should be more for mesh topology
679
  /// keep the number of bytes in rlc buffer for each lcid
680
  uint16_t  BSR_bytes[MAX_NUM_LCGID];
681
  /// buffer status for each lcid
682
  uint8_t  LCID_status[MAX_NUM_LCID];
683
  /// SR pending as defined in 36.321
684
  uint8_t  SR_pending;
685
  /// SR_COUNTER as defined in 36.321
686
  uint16_t SR_COUNTER;
687
  /// logical channel group ide for each LCID
688
  uint8_t  LCGID[MAX_NUM_LCID];
689
  /// retxBSR-Timer, default value is sf2560
690
  uint16_t retxBSR_Timer;
691
  /// retxBSR_SF, number of subframe before triggering a regular BSR 
692
  int16_t retxBSR_SF;
693
  /// periodicBSR-Timer, default to infinity
694
  uint16_t periodicBSR_Timer;
695
  /// periodicBSR_SF, number of subframe before triggering a periodic BSR 
696
  int16_t periodicBSR_SF;
697
  /// default value is 0: not configured
698
  uint16_t sr_ProhibitTimer;
699
  /// sr ProhibitTime running
700
  uint8_t sr_ProhibitTimer_Running;
701
  ///  default value to n5
702
  uint16_t maxHARQ_Tx;
703
  /// default value is false
704
  uint16_t ttiBundling;
705 706 707 708 709
  /// 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
710
  uint16_t periodicPHR_Timer;
711
  ///timer before triggering a prohibit PHR
712
  uint16_t prohibitPHR_Timer;
713
  ///DL Pathloss change value 
714
  uint16_t PathlossChange;
715
  ///number of subframe before triggering a periodic PHR
716
  int16_t periodicPHR_SF;
717
  ///number of subframe before triggering a prohibit PHR
718
  int16_t prohibitPHR_SF;
719
  ///DL Pathloss Change in db 
720
  uint16_t PathlossChange_db;
721
  //Bj bucket usage per  lcid
722
  int16_t Bj[MAX_NUM_LCID];
723
  // Bucket size per lcid
724
  int16_t bucket_size[MAX_NUM_LCID];
725 726 727
} UE_SCHEDULING_INFO;

typedef struct{
728
  uint16_t Node_id;
729
  /// frame counter
730
  frame_t     frame;
731
  /// subframe counter
732
  sub_frame_t subframe;
733
  /// C-RNTI of UE
734
  uint16_t crnti;
735
  /// C-RNTI of UE before HO
736
  rnti_t crnti_before_ho; ///user id (rnti) of connected UEs
737 738 739 740
  /// uplink active flag
  uint8_t ul_active;
  /// pointer to RRC PHY configuration 
  RadioResourceConfigCommonSIB_t *radioResourceConfigCommon;
741 742
  /// pointer to RACH_ConfigDedicated (NULL when not active, i.e. upon HO completion or T304 expiry)
  struct RACH_ConfigDedicated	*rach_ConfigDedicated;
743 744 745 746 747
  /// 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
748
  uint8_t  n_adj_cells;
749
  /// Array of adjacent physical cell ids
750
  uint32_t adj_cell_id[6];
751 752 753 754 755 756 757 758 759 760 761 762 763
  /// 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
764
  uint8_t RA_attempt_number;
765
  /// Random-access procedure flag
766
  uint8_t RA_active;
767
  /// Random-access window counter
768
  int8_t RA_window_cnt;
769
  /// Random-access Msg3 size in bytes
770
  uint8_t RA_Msg3_size;
771
  /// Random-access prachMaskIndex
772
  uint8_t RA_prachMaskIndex;
773
  /// Flag indicating Preamble set (A,B) used for first Msg3 transmission
774
  uint8_t RA_usedGroupA;
775 776 777
  /// Random-access Resources
  PRACH_RESOURCES_t RA_prach_resources;
  /// Random-access PREAMBLE_TRANSMISSION_COUNTER
778
  uint8_t RA_PREAMBLE_TRANSMISSION_COUNTER;
779
  /// Random-access backoff counter
780
  int16_t RA_backoff_cnt;
781
  /// Random-access variable for window calculation (frame of last change in window counter)
782
  uint32_t RA_tx_frame;
783
  /// Random-access variable for window calculation (subframe of last change in window counter)
784
  uint8_t RA_tx_subframe;
785 786
  /// Random-access Group B maximum path-loss
  /// Random-access variable for backoff (frame of last change in backoff counter)
787
  uint32_t RA_backoff_frame;
788
  /// Random-access variable for backoff (subframe of last change in backoff counter)
789
  uint8_t RA_backoff_subframe;
790
  /// Random-access Group B maximum path-loss
791
  uint16_t RA_maxPL;
792
  /// Random-access Contention Resolution Timer active flag
793
  uint8_t RA_contention_resolution_timer_active;
794
  /// Random-access Contention Resolution Timer count value
795
  uint8_t RA_contention_resolution_cnt;
796
  /// power headroom reporitng reconfigured 
797
  uint8_t PHR_reconfigured;
798
  /// power headroom state as configured by the higher layers
799
  uint8_t PHR_state;
800
  /// power backoff due to power management (as allowed by P-MPRc) for this cell
801
  uint8_t PHR_reporting_active;
802
  /// power backoff due to power management (as allowed by P-MPRc) for this cell
803
  uint8_t power_backoff_db[NUMBER_OF_eNB_MAX];
804 805
  /// MBSFN_Subframe Configuration
  struct MBSFN_SubframeConfig *mbsfn_SubframeConfig[8];
806
  /// number of subframe allocation pattern available for MBSFN sync area 
807
  uint8_t num_sf_allocation_pattern;
808
#ifdef Rel10
809
 /// number of active MBSFN area 
810
  uint8_t num_active_mbsfn_area;
811 812 813 814 815
  /// 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
816
  uint8_t mcch_status;
817
  /// MSI status
818
  uint8_t msi_status;// could be an array if there are >1 MCH in one MBSFN area
819 820 821 822 823
#endif
//#ifdef CBA
  uint16_t cba_rnti[NUM_MAX_CBA_GROUP];
  uint8_t cba_last_access[NUM_MAX_CBA_GROUP];
//#endif
824 825 826 827 828 829 830 831
  
  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
    
832 833 834
}UE_MAC_INST;

typedef struct {
835 836
  uint16_t cell_ids[6];
  uint8_t n_adj_cells;
837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876
} 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)
877
@param mobilityControlInfo mobility control info received for Handover
878 879 880 881 882 883 884
@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)
*/
885 886
int rrc_mac_config_req(module_id_t     module_idP,
                       eNB_flag_t eNB_flag,
887 888
                       uint8_t         UE_id,
                       uint8_t         eNB_index,
889 890 891 892 893 894 895 896 897
                       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,
898 899
                       uint8_t *SIwindowsize,
                       uint16_t *SIperiod,
900 901 902 903
                       ARFCN_ValueEUTRA_t *ul_CarrierFreq,
                       long *ul_Bandwidth,
                       AdditionalSpectrumEmission_t *additionalSpectrumEmission,
                       struct MBSFN_SubframeConfigList *mbsfn_SubframeConfigList
904
#ifdef Rel10
905
                       ,
906
                       uint8_t MBMS_Flag,
907 908
                       MBSFN_AreaInfoList_r9_t *mbsfn_AreaInfoList,
                       PMCH_InfoList_r9_t *pmch_InfoList
909 910 911

#endif
#ifdef CBA
912
                       ,
913 914
                       uint8_t num_active_cba_groups,
                       uint16_t cba_rnti
915 916 917 918 919 920 921 922 923 924 925 926
#endif
		       );


/** \brief First stage of Random-Access Scheduling. Loops over the RA_templates and checks if RAR, Msg3 or its retransmission are to be scheduled in the subframe.  It returns the total number of PRB used for RA SDUs.  For Msg3 it retrieves the L3msg from RRC and fills the appropriate buffers.  For the others it just computes the number of PRBs. Each DCI uses 3 PRBs (format 1A) 
for the message.
@param Mod_id Instance ID of eNB
@param frame Frame index
@param subframe Subframe number on which to act
@param nprb Pointer to current PRB count
@param nCCE Pointer to current nCCE count
*/
927
void schedule_RA(module_id_t module_idP,frame_t frameP,sub_frame_t subframe,uint8_t Msg3_subframe,uint8_t *nprb,unsigned int *nCCE);
928 929 930 931 932 933 934 935 936

/** \brief First stage of SI Scheduling. Gets a SI SDU from RRC if available and computes the MCS required to transport it as a function of the SDU length.  It assumes a length less than or equal to 64 bytes (MCS 6, 3 PRBs).
@param Mod_id Instance ID of eNB
@param frame Frame index
@param subframe Subframe number on which to act
@param Msg3_subframe Subframe where Msg3 will be transmitted
@param nprb Pointer to current PRB count
@param nCCE Pointer to current nCCE count
*/
937
void schedule_SI(module_id_t module_idP,frame_t frameP,uint8_t *nprb,unsigned int *nCCE);
938 939 940 941 942 943

/** \brief MBMS scheduling: Checking the position for MBSFN subframes. Create MSI, transfer MCCH from RRC to MAC, transfer MTCHs from RLC to MAC. Multiplexing MSI,MCCH&MTCHs. Return 1 if there are MBSFN data being allocated, otherwise return 0;
@param Mod_id Instance ID of eNB
@param frame Frame index
@param subframe Subframe number on which to act
*/
944
int schedule_MBMS(module_id_t module_idP,frame_t frameP, sub_frame_t subframe);
945

946 947 948 949 950
/** \brief check the mapping between sf allocation and sync area, Currently only supports 1:1 mapping
@param Mod_id Instance ID of eNB
@param mbsfn_sync_area index of mbsfn sync area
@param[out] index of sf pattern 
*/
951
int8_t get_mbsfn_sf_alloction (module_id_t module_idP, uint8_t mbsfn_sync_area);
952 953 954 955 956 957 958

/** \brief check the mapping between sf allocation and sync area, Currently only supports 1:1 mapping
@param Mod_id Instance ID of eNB
@param mbsfn_sync_area index of mbsfn sync area
@param eNB_index index of eNB
@param[out] index of sf pattern 
*/
959
int8_t ue_get_mbsfn_sf_alloction (module_id_t module_idP, uint8_t mbsfn_sync_area, unsigned char eNB_index);
960 961 962 963 964 965 966 967

/** \brief top ULSCH Scheduling for TDD (config 1-6).
@param Mod_id Instance ID of eNB
@param frame Frame index
@param subframe Subframe number on which to act
@param sched_subframe Subframe number where PUSCH is transmitted (for DAI lookup)
@param nCCE Pointer to current nCCE count
*/
968
void schedule_ulsch(module_id_t module_idP,frame_t frameP,unsigned char cooperation_flag,sub_frame_t subframe,unsigned char sched_subframe,unsigned int *nCCE);
969 970 971 972 973 974 975 976

/** \brief ULSCH Scheduling per RNTI TDD config (config 1-6).
@param Mod_id Instance ID of eNB
@param frame Frame index
@param subframe Subframe number on which to act
@param sched_subframe Subframe number where PUSCH is transmitted (for DAI lookup)
@param nCCE Pointer to current nCCE count
*/
977
void schedule_ulsch_rnti(module_id_t module_idP, unsigned char cooperation_flag, frame_t frameP, sub_frame_t subframe, unsigned char sched_subframe, uint8_t granted_UEs, unsigned int *nCCE, unsigned int *nCCE_available, uint16_t *first_rb);
978 979 980 981 982 983 984 985

/** \brief ULSCH Scheduling for CBA  RNTI TDD config (config 1-6).
@param Mod_id Instance ID of eNB
@param frame Frame index
@param subframe Subframe number on which to act
@param sched_subframe Subframe number where PUSCH is transmitted (for DAI lookup)
@param nCCE Pointer to current nCCE count
*/
986
void schedule_ulsch_cba_rnti(module_id_t module_idP, unsigned char cooperation_flag, frame_t frameP, sub_frame_t subframe, unsigned char sched_subframe, uint8_t granted_UEs, unsigned int *nCCE, unsigned int *nCCE_available, uint16_t *first_rb);
987 988 989 990 991 992 993 994 995

/** \brief Second stage of DLSCH scheduling, after schedule_SI, schedule_RA and schedule_dlsch have been called.  This routine first allocates random frequency assignments for SI and RA SDUs using distributed VRB allocations and adds the corresponding DCI SDU to the DCI buffer for PHY.  It then loops over the UE specific DCIs previously allocated and fills in the remaining DCI fields related to frequency allocation.  It assumes localized allocation of type 0 (DCI.rah=0).  The allocation is done for tranmission modes 1,2,4. 
@param Mod_id Instance of eNB
@param frame Frame index
@param subframe Index of subframe
@param rballoc Bitmask for allowable subband allocations
@param RA_scheduled RA was scheduled in this subframe
@param mbsfn_flag Indicates that this subframe is for MCH/MCCH
*/
996
void fill_DLSCH_dci(module_id_t module_idP,frame_t frameP,sub_frame_t subframe,uint32_t rballoc,uint8_t RA_scheduled,int mbsfn_flag);
997 998 999 1000 1001 1002 1003 1004 1005

/** \brief UE specific DLSCH scheduling. Retrieves next ue to be schduled from round-robin scheduler and gets the appropriate harq_pid for the subframe from PHY. If the process is active and requires a retransmission, it schedules the retransmission with the same PRB count and MCS as the first transmission. Otherwise it consults RLC for DCCH/DTCH SDUs (status with maximum number of available PRBS), builds the MAC header (timing advance sent by default) and copies 
@param Mod_id Instance ID of eNB
@param frame Frame index
@param subframe Subframe on which to act
@param nb_rb_used0 Number of PRB used by SI/RA
@param nCCE_used Number of CCE used by SI/RA
@param mbsfn_flag  Indicates that MCH/MCCH is in this subframe
*/
1006
void schedule_ue_spec(module_id_t module_idP,frame_t frameP,sub_frame_t subframe,uint16_t nb_rb_used0,unsigned int *nCCE_used,int mbsfn_flag);
1007 1008 1009 1010 1011

/** \brief Function for UE/PHY to compute PUSCH transmit power in power-control procedure.
    @param Mod_id Module id of UE
    @returns Po_NOMINAL_PUSCH (PREAMBLE_RECEIVED_TARGET_POWER+DELTA_PREAMBLE
*/
1012
int8_t get_Po_NOMINAL_PUSCH(module_id_t module_idP);
1013 1014 1015 1016 1017

/** \brief Function to compute DELTA_PREAMBLE from 36.321 (for RA power ramping procedure and Msg3 PUSCH power control policy) 
    @param Mod_id Module id of UE
    @returns DELTA_PREAMBLE
*/
1018
int8_t get_DELTA_PREAMBLE(module_id_t module_idP);
1019 1020 1021 1022 1023

/** \brief Function for compute deltaP_rampup from 36.321 (for RA power ramping procedure and Msg3 PUSCH power control policy) 
    @param Mod_id Module id of UE
    @returns deltaP_rampup
*/
1024
int8_t get_deltaP_rampup(module_id_t module_idP);
1025 1026 1027

//main.c

1028
void chbch_phy_sync_success(module_id_t module_idP,frame_t frameP,uint8_t eNB_index);
1029

1030
void mrbch_phy_sync_failure(module_id_t module_idP, frame_t frameP,uint8_t free_eNB_index);
1031

1032
int mac_top_init(int eMBMS_active, uint8_t cba_group_active, uint8_t HO_active);
1033

1034
char layer2_init_UE(module_id_t module_idP);
1035

1036
char layer2_init_eNB(module_id_t module_idP, uint8_t Free_ch_index);
1037

1038
void mac_switch_node_function(module_id_t module_idP);
1039 1040 1041 1042 1043

int mac_init_global_param(void);

void mac_top_cleanup(void);

1044
void mac_UE_out_of_sync_ind(module_id_t module_idP,frame_t frameP, uint16_t eNB_index);
1045 1046 1047


// eNB functions
1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058
/* \brief This function assigns pre-available RBS to each UE in specified sub-bands before scheduling is done
@param Mod_id Instance ID of eNB
@param frame Index of frame
@param subframe Index of current subframe
@param dl_pow_off Pointer to store resulting power offset for DCI
@param pre_nb_available_rbs Pointer to store number of remaining rbs after scheduling
@param N_RBS Number of resource block groups
@param rb_alloc_sub Table of resource block groups allocated to each UE
 */


1059 1060 1061
void dlsch_scheduler_pre_processor (module_id_t module_idP,
                                    frame_t frameP,
                                    sub_frame_t subframe,
1062 1063
                                    uint8_t *dl_pow_off,
                                    uint16_t *pre_nb_available_rbs,
1064 1065
                                    int N_RBGS,
                                    unsigned char rballoc_sub_UE[NUMBER_OF_UE_MAX][N_RBGS_MAX]);
1066

1067 1068 1069 1070 1071 1072 1073 1074 1075
/* \brief Function to trigger the eNB scheduling procedure.  It is called by PHY at the beginning of each subframe, \f$n$\f 
   and generates all DLSCH allocations for subframe \f$n\f$ and ULSCH allocations for subframe \f$n+k$\f. The resultant DCI_PDU is
   ready after returning from this call.
@param Mod_id Instance ID of eNB
@param cooperation_flag Flag to indicated that this cell has cooperating nodes (i.e. that there are collaborative transport channels that
can be scheduled.
@param subframe Index of current subframe
@param calibration_flag Flag to indicate that eNB scheduler should schedule TDD auto-calibration PUSCH.
*/
1076
void eNB_dlsch_ulsch_scheduler(module_id_t module_idP, uint8_t cooperation_flag, frame_t frameP, sub_frame_t subframe);//, int calibration_flag);
1077 1078 1079 1080 1081 1082 1083

/* \brief Function to retrieve result of scheduling (DCI) in current subframe.  Can be called an arbitrary numeber of times after eNB_dlsch_ulsch_scheduler
in a given subframe.
@param Mod_id Instance ID of eNB
@param subframe Index of current subframe
@returns Pointer to generated DCI for subframe
*/
1084
DCI_PDU *get_dci_sdu(module_id_t module_idP,frame_t frameP,sub_frame_t subframe);
1085 1086 1087 1088 1089 1090

/* \brief Function to indicate a received preamble on PRACH.  It initiates the RA procedure.
@param Mod_id Instance ID of eNB
@param preamble_index index of the received RA request
@param timing_offset Offset in samples of the received PRACH w.r.t. eNB timing. This is used to 
*/
1091
void initiate_ra_proc(module_id_t module_idP,frame_t frameP, uint16_t preamble_index,int16_t timing_offset,uint8_t sect_id,sub_frame_t subframe,uint8_t f_id);
1092 1093 1094 1095 1096 1097 1098

/* \brief Function in eNB to fill RAR pdu when requested by PHY.  This provides a single RAR SDU for the moment and returns the t-CRNTI.
@param Mod_id Instance ID of eNB
@param dlsch_buffer Pointer to DLSCH input buffer
@param N_RB_UL Number of UL resource blocks
@returns t_CRNTI
*/
1099
uint16_t  fill_rar(module_id_t module_idP,
1100
              frame_t frameP,
1101 1102 1103
              uint8_t *dlsch_buffer,
              uint16_t N_RB_UL,
              uint8_t input_buffer_length);
1104 1105 1106 1107 1108 1109

/* \brief This function indicates the end of RA procedure and provides the l3msg received on ULSCH.
@param Mod_id Instance ID of eNB
@param rnti RNTI of UE transmitting l3msg
@param l3msg Pointer to received l3msg
*/
1110
void terminate_ra_proc(module_id_t module_idP,frame_t frameP, rnti_t rnti, uint8_t *l3msg, uint16_t l3msg_len);
1111 1112 1113 1114 1115

/* \brief Function to indicate a failed RA response.  It removes all temporary variables related to the initial connection of a UE
@param Mod_id Instance ID of eNB
@param preamble_index index of the received RA request.
*/
1116
void cancel_ra_proc(module_id_t module_idP,frame_t frameP, uint16_t preamble_index);
1117 1118 1119 1120 1121 1122

/* \brief Function to indicate a received SDU on ULSCH.
@param Mod_id Instance ID of eNB
@param rnti RNTI of UE transmitting the SR
@param sdu Pointer to received SDU
*/
1123
void rx_sdu(module_id_t module_idP, frame_t frameP, rnti_t rnti, uint8_t *sdu, uint16_t sdu_len);
1124 1125 1126 1127 1128 1129

/* \brief Function to indicate a scheduled schduling request (SR) was received by eNB.
@param Mod_id Instance ID of eNB
@param rnti RNTI of UE transmitting the SR
@param subframe Index of subframe where SR was received
*/
1130
void SR_indication(module_id_t module_idP,frame_t frameP,rnti_t rnti, sub_frame_t subframe);
1131

1132
uint8_t *get_dlsch_sdu(module_id_t module_idP,frame_t frameP,rnti_t rnti,uint8_t TBindex);
1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144

/* \brief Function to retrieve MCH transport block and MCS used for MCH in this MBSFN subframe.  Returns null if no MCH is to be transmitted
@param Mod_id Instance ID of eNB
@param frame Index of frame
@param subframe Index of current subframe
@param mcs Pointer to mcs used by PHY (to be filled by MAC) 
@returns Pointer to MCH transport block and mcs for subframe
*/
MCH_PDU *get_mch_sdu(uint8_t Mod_id,uint32_t frame,uint32_t subframe);


//added for ALU icic purpose
1145
uint32_t  Get_Cell_SBMap(module_id_t module_idP);
1146
void UpdateSBnumber(module_id_t module_idP);
1147 1148 1149
//end ALU's algo


1150
void        ue_mac_reset      (module_id_t module_idP,uint8_t eNB_index);
1151 1152 1153 1154 1155
void        ue_init_mac       (module_id_t module_idP);
void        init_ue_sched_info(void);
void        add_ue_ulsch_info (module_id_t module_idP,  module_id_t ue_mod_idP, sub_frame_t subframe,UE_ULSCH_STATUS status);
void        add_ue_dlsch_info (module_id_t module_idP, module_id_t ue_mod_idP, sub_frame_t subframe,UE_DLSCH_STATUS status);
module_id_t find_UE_id        (module_id_t module_idP, rnti_t rnti) ;
Lionel Gauthier's avatar
Lionel Gauthier committed
1156
rnti_t      find_UE_RNTI      (module_id_t module_idP, module_id_t ue_mod_idP);
1157
uint8_t          find_active_UEs   (module_id_t module_idP);
Lionel Gauthier's avatar
Lionel Gauthier committed
1158
boolean_t   is_UE_active      (module_id_t module_idP, module_id_t ue_mod_idP );
1159 1160 1161
uint8_t          find_ulgranted_UEs(module_id_t module_idP);
uint8_t          find_dlgranted_UEs(module_id_t module_idP);
uint8_t          process_ue_cqi    (module_id_t module_idP, module_id_t ue_mod_idP);
1162

1163
int8_t find_active_UEs_with_traffic(module_id_t module_idP);
1164

1165 1166
uint8_t find_num_active_UEs_in_cbagroup(module_id_t module_idP, unsigned char group_id);
uint8_t UE_is_to_be_scheduled(module_id_t module_idP,uint8_t UE_id);
1167 1168 1169 1170 1171
/** \brief Round-robin scheduler for ULSCH traffic.
@param Mod_id Instance ID for eNB
@param subframe Subframe number on which to act
@returns UE index that is to be scheduled if needed/room
*/
1172
module_id_t schedule_next_ulue(module_id_t module_idP, module_id_t ue_mod_idP,sub_frame_t subframe);
1173 1174 1175 1176 1177 1178

/** \brief Round-robin scheduler for DLSCH traffic.
@param Mod_id Instance ID for eNB
@param subframe Subframe number on which to act
@returns UE index that is to be scheduled if needed/room
*/
1179
module_id_t schedule_next_dlue(module_id_t module_idP, sub_frame_t subframe);
1180 1181 1182 1183 1184 1185 1186

/* \brief Allocates a set of PRBS for a particular UE.  This is a simple function for the moment, later it should process frequency-domain CQI information and/or PMI information.  Currently it just returns the first PRBS that are available in the subframe based on the number requested.
@param UE_id Index of UE on which to act
@param nb_rb Number of PRBs allocated to UE by scheduler
@param rballoc Pointer to bit-map of current PRB allocation given to previous users/control channels.  This is updated for subsequent calls to the routine.
@returns an rballoc bitmap for resource type 0 allocation (DCI).
*/
1187
uint32_t allocate_prbs(module_id_t ue_mod_idP,uint8_t nb_rb, uint32_t *rballoc);
1188

1189
/* \fn uint32_t req_new_ulsch(module_id_t module_idP)
1190 1191 1192 1193
\brief check for a new transmission in any drb 
@param Mod_id Instance id of UE in machine
@returns 1 for new transmission, 0 for none
*/
1194
uint32_t req_new_ulsch(module_id_t module_idP);
1195 1196 1197 1198 1199 1200 1201 1202

/* \brief Get SR payload (0,1) from UE MAC
@param Mod_id Instance id of UE in machine
@param eNB_id Index of eNB that UE is attached to
@param rnti C_RNTI of UE
@param subframe subframe number
@returns 0 for no SR, 1 for SR
*/
1203
uint32_t ue_get_SR(module_id_t module_idP, frame_t frameP, uint8_t eNB_id,rnti_t rnti,sub_frame_t subframe);
1204

1205
uint8_t get_ue_weight(module_id_t module_idP, module_id_t ue_mod_idP);
1206 1207

// UE functions
1208
void mac_out_of_sync_ind(module_id_t module_idP, frame_t frameP, uint16_t CH_index);
1209

1210
void ue_decode_si(module_id_t module_idP, frame_t frame, uint8_t CH_index, void *pdu, uint16_t len);
1211 1212


1213
void ue_send_sdu(module_id_t module_idP, frame_t frame, uint8_t *sdu,uint16_t sdu_len,uint8_t CH_index);
1214 1215 1216 1217 1218 1219 1220 1221 1222


#ifdef Rel10
/* \brief Called by PHY to transfer MCH transport block to ue MAC.
@param Mod_id Index of module instance
@param frame Frame index
@param sdu Pointer to transport block
@param sdu_len Length of transport block
@param eNB_index Index of attached eNB
1223
@param sync_area the index of MBSFN sync area
1224
*/
1225
void ue_send_mch_sdu(module_id_t module_idP,frame_t frameP,uint8_t *sdu,uint16_t sdu_len,uint8_t eNB_index,uint8_t sync_area) ;
1226 1227 1228 1229 1230

/*\brief Function to check if UE PHY needs to decode MCH for MAC.
@param Mod_id Index of protocol instance
@param frame Index of frame
@param subframe Index of subframe
1231 1232 1233
@param eNB_index index of eNB for this MCH
@param[out] sync_area return the sync area
@param[out] mcch_active flag indicating whether this MCCH is active in this SF
1234
*/
1235
int ue_query_mch(uint8_t Mod_id,uint32_t frame,sub_frame_t subframe, uint8_t eNB_index, uint8_t *sync_area, uint8_t *mcch_active);
1236 1237 1238 1239 1240 1241 1242 1243 1244 1245

#endif

/* \brief Called by PHY to get sdu for PUSCH transmission.  It performs the following operations: Checks BSR for DCCH, DCCH1 and DTCH corresponding to previous values computed either in SR or BSR procedures.  It gets rlc status indications on DCCH,DCCH1 and DTCH and forms BSR elements and PHR in MAC header.  CRNTI element is not supported yet.  It computes transport block for up to 3 SDUs and generates header and forms the complete MAC SDU.  
@param Mod_id Instance id of UE in machine
@param eNB_id Index of eNB that UE is attached to
@param rnti C_RNTI of UE
@param subframe subframe number
@returns 0 for no SR, 1 for SR
*/
1246
void ue_get_sdu(module_id_t module_idP, frame_t frameP, sub_frame_t subframe, uint8_t eNB_index,uint8_t *ulsch_buffer,uint16_t buflen,uint8_t *access_mode);
1247 1248 1249 1250 1251 1252

/* \brief Function called by PHY to retrieve information to be transmitted using the RA procedure.  If the UE is not in PUSCH mode for a particular eNB index, this is assumed to be an Msg3 and MAC attempts to retrieves the CCCH message from RRC. If the UE is in PUSCH mode for a particular eNB index and PUCCH format 0 (Scheduling Request) is not activated, the MAC may use this resource for random-access to transmit a BSR along with the C-RNTI control element (see 5.1.4 from 36.321)
@param Mod_id Index of UE instance
@param New_Msg3 Flag to indicate this call is for a new Msg3
@param subframe Index of subframe for PRACH transmission (0 ... 9)
@returns A pointer to a PRACH_RESOURCES_t */
1253
PRACH_RESOURCES_t *ue_get_rach(module_id_t module_idP,frame_t frameP,uint8_t new_Msg3,sub_frame_t subframe);
1254 1255 1256 1257 1258 1259 1260 1261 1262

/* \brief Function called by PHY to process the received RAR.  It checks that the preamble matches what was sent by the eNB and provides the timing advance and t-CRNTI.
@param Mod_id Index of UE instance
@param dlsch_buffer  Pointer to dlsch_buffer containing RAR PDU
@param t_crnti Pointer to PHY variable containing the T_CRNTI
@param preamble_index Preamble Index used by PHY to transmit the PRACH.  This should match the received RAR to trigger the rest of 
random-access procedure
@returns timing advance or 0xffff if preamble doesn't match
*/
1263
uint16_t ue_process_rar(module_id_t module_idP, frame_t frameP,uint8_t *dlsch_buffer,uint16_t *t_crnti,uint8_t preamble_index);
1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281


/* \brief Generate header for UL-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 ULSCH buffer.
@param mac_header Pointer to the first byte of the MAC header (UL-SCH buffer)
@param num_sdus Number of SDUs in the payload
@param short_padding Number of bytes for short padding (0,1,2)
@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 power_headroom Pointer to power headroom command (NULL means not present in payload)
@param crnti Pointer to CRNTI command (NULL means not present in payload)
@param truncated_bsr Pointer to Truncated BSR command (NULL means not present in payload)
@param short_bsr Pointer to Short BSR command (NULL means not present in payload)
@param long_bsr Pointer to Long BSR command (NULL means not present in payload)
@param post_padding Number of bytes for padding at the end of MAC PDU
@returns Number of bytes used for header
*/
1282 1283 1284 1285 1286
unsigned char generate_ulsch_header(uint8_t *mac_header,
                                    uint8_t num_sdus,
                                    uint8_t short_padding,
                                    uint16_t *sdu_lengths,
                                    uint8_t *sdu_lcids,
1287
                                    POWER_HEADROOM_CMD *power_headroom,
1288
                                    uint16_t *crnti,
1289 1290 1291 1292
                                    BSR_SHORT *truncated_bsr,
                                    BSR_SHORT *short_bsr,
                                    BSR_LONG *long_bsr,
                                    unsigned short post_padding);
1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304

/* \brief Parse header for UL-SCH.  This function parses the received UL-SCH 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 ULSCH buffer.
@param mac_header Pointer to the first byte of the MAC header (UL-SCH buffer)
@param num_ces Number of SDUs in the payload
@param num_sdu Number of SDUs in the payload
@param rx_ces Pointer to received CEs in the header
@param rx_lcids Pointer to array of LCIDs (the order must be the same as the SDU length array)
@param rx_lengths Pointer to array of SDU lengths
@returns Pointer to payload following header
*/
1305 1306 1307 1308 1309 1310 1311
uint8_t *parse_ulsch_header(uint8_t *mac_header,
                       uint8_t *num_ce,
                       uint8_t *num_sdu,
                       uint8_t *rx_ces,
                       uint8_t *rx_lcids,
                       uint16_t *rx_lengths,
                       uint16_t tx_lenght);
1312 1313


1314
int l2_init(LTE_DL_FRAME_PARMS *frame_parms,int eMBMS_active, uint8_t cba_group_active, uint8_t HO_active);
1315
int mac_init(void);
1316 1317
int8_t add_new_ue(module_id_t module_idP, rnti_t rnti);
int8_t mac_remove_ue(module_id_t enb_mod_idP, module_id_t ue_mod_idP);
1318

1319
/*! \fn  UE_L2_state_t ue_scheduler(module_id_t module_idP,frame_t frameP, sub_frame_t subframe, lte_subframe_t direction,uint8_t eNB_index)
1320
   \brief UE scheduler where all the ue background tasks are done.  This function performs the following:  1) Trigger PDCP every 5ms 2) Call RRC for link status return to PHY3) Perform SR/BSR procedures for scheduling feedback 4) Perform PHR procedures.  
1321 1322 1323 1324
\param[in] module_idP instance of the UE
\param[in] subframe t the subframe number
\param[in] direction  subframe direction
\param[in] eNB_index  instance of eNB
1325 1326
@returns L2 state (CONNETION_OK or CONNECTION_LOST or PHY_RESYNCH)
*/
1327
UE_L2_STATE_t ue_scheduler(module_id_t module_idP,frame_t frameP, sub_frame_t subframe, lte_subframe_t direction,uint8_t eNB_index);
1328

1329
/*! \fn  int use_cba_access(module_id_t module_idP,frame_t frameP,sub_frame_t subframe, uint8_t eNB_index);
1330 1331 1332 1333 1334 1335 1336
\brief determine whether to use cba resource to transmit or not
\param[in] Mod_id instance of the UE
\param[in] frame the frame number
\param[in] subframe the subframe number
\param[in] eNB_index instance of eNB
\param[out] access(1) or postpone (0) 
*/
1337
int use_cba_access(module_id_t module_idP,frame_t frameP,sub_frame_t subframe, uint8_t eNB_index);
1338

1339
/*! \fn  int get_bsr_lcgid (module_id_t module_idP);
1340 1341 1342 1343
\brief determine the lcgid for the bsr
\param[in] Mod_id instance of the UE
\param[out] lcgid
*/
1344
int get_bsr_lcgid (module_id_t module_idP);
1345

1346
/*! \fn  uint8_t get_bsr_len (module_id_t module_idP, uint16_t bufflen);
1347 1348 1349 1350 1351
\brief determine whether the bsr is short or long assuming that the MAC pdu is built 
\param[in] Mod_id instance of the UE
\param[in] bufflen size of phy transport block
\param[out] bsr_len size of bsr control element 
*/
1352
uint8_t get_bsr_len (module_id_t module_idP, uint16_t buflen);
1353

1354
/*! \fn  BSR_SHORT *  get_bsr_short(module_id_t module_idP, uint8_t bsr_len)
1355 1356 1357 1358 1359
\brief get short bsr level
\param[in] Mod_id instance of the UE
\param[in] bsr_len indicator for no, short, or long bsr
\param[out] bsr_s pointer to short bsr
*/
1360
BSR_SHORT *get_bsr_short(module_id_t module_idP, uint8_t bsr_len);
1361

1362
/*! \fn  BSR_LONG * get_bsr_long(module_id_t module_idP, uint8_t bsr_len)
1363 1364 1365 1366 1367
\brief get long bsr level
\param[in] Mod_id instance of the UE
\param[in] bsr_len indicator for no, short, or long bsr
\param[out] bsr_l pointer to long bsr
*/
1368
BSR_LONG * get_bsr_long(module_id_t module_idP, uint8_t bsr_len);
1369

1370
/*! \fn  boolean_t update_bsr(module_id_t module_idP, frame_t frameP, uint8_t lcid)
1371 1372 1373 1374 1375
   \brief get the rlc stats and update the bsr level for each lcid 
\param[in] Mod_id instance of the UE
\param[in] frame Frame index
\param[in] lcid logical channel identifier
*/
1376
boolean_t update_bsr(module_id_t module_idP, frame_t frameP, uint8_t lcid, uint8_t lcgid);
1377 1378 1379 1380 1381 1382 1383 1384

/*! \fn  locate (int *table, int size, int value)
   \brief locate the BSR level in the table as defined in 36.321. This function requires that he values in table to be monotonic, either increasing or decreasing. The returned value is not less than 0, nor greater than n-1, where n is the size of table. 
\param[in] *table Pointer to BSR table
\param[in] size Size of the table
\param[in] value Value of the buffer 
\return the index in the BSR_LEVEL table
*/
1385
uint8_t locate (const uint32_t *table, int size, int value);
1386 1387


1388
/*! \fn  int get_sf_periodicBSRTimer(uint8_t periodicBSR_Timer)
1389 1390 1391 1392
   \brief get the number of subframe from the periodic BSR timer configured by the higher layers
\param[in] periodicBSR_Timer timer for periodic BSR
\return the number of subframe
*/
1393
int get_sf_periodicBSRTimer(uint8_t bucketSize);
1394

1395
/*! \fn  int get_ms_bucketsizeduration(uint8_t bucketSize)
1396 1397 1398 1399
   \brief get the time in ms form the bucket size duration configured by the higher layer
\param[in]  bucketSize the bucket size duration
\return the time in ms
*/
1400
int get_ms_bucketsizeduration(uint8_t bucketsizeduration);
1401

1402
/*! \fn  int get_sf_retxBSRTimer(uint8_t retxBSR_Timer)
1403 1404 1405 1406
   \brief get the number of subframe form the bucket size duration configured by the higher layer
\param[in]  retxBSR_Timer timer for regular BSR
\return the time in sf
*/
1407
int get_sf_retxBSRTimer(uint8_t retxBSR_Timer);
1408

1409
/*! \fn  int get_sf_perioidicPHR_Timer(uint8_t perioidicPHR_Timer){
1410 1411 1412 1413
   \brief get the number of subframe form the periodic PHR timer configured by the higher layer
\param[in]  perioidicPHR_Timer timer for reguluar PHR
\return the time in sf
*/
1414
int get_sf_perioidicPHR_Timer(uint8_t perioidicPHR_Timer);
1415

1416
/*! \fn  int get_sf_prohibitPHR_Timer(uint8_t prohibitPHR_Timer)
1417 1418 1419 1420
   \brief get the number of subframe form the prohibit PHR duration configured by the higher layer
\param[in]  prohibitPHR_Timer timer for  PHR
\return the time in sf
*/
1421
int get_sf_prohibitPHR_Timer(uint8_t prohibitPHR_Timer);
1422

1423
/*! \fn  int get_db_dl_PathlossChange(uint8_t dl_PathlossChange)
1424 1425 1426 1427
   \brief get the db form the path loss change configured by the higher layer
\param[in]  dl_PathlossChange path loss for PHR
\return the pathloss in db
*/
1428
int get_db_dl_PathlossChange(uint8_t dl_PathlossChange);
1429

1430
/*! \fn  uint8_t get_phr_mapping (module_id_t module_idP, uint8_t eNB_index)
1431 1432 1433 1434
   \brief get phr mapping as described in 36.313
\param[in]  Mod_id index of eNB
\return phr mapping
*/
1435
uint8_t get_phr_mapping (module_id_t module_idP, uint8_t eNB_index);
1436

1437
/*! \fn  void update_phr (module_id_t module_idP)
1438 1439 1440 1441
   \brief update/reset the phr timers
\param[in]  Mod_id index of eNB
\return void
*/
1442
void update_phr (module_id_t module_idP);
1443 1444 1445 1446 1447

/*! \brief Function to indicate Msg3 transmission/retransmission which initiates/reset Contention Resolution Timer
\param[in] Mod_id Instance index of UE
\param[in] eNB_id Index of eNB
*/
1448
void Msg3_tx(module_id_t module_idP,frame_t frameP,uint8_t eNB_id);
1449 1450 1451 1452 1453 1454 1455


/*! \brief Function to indicate the transmission of msg1/rach
\param[in] Mod_id Instance index of UE
\param[in] eNB_id Index of eNB
*/

1456
void Msg1_tx(module_id_t module_idP,frame_t frameP, uint8_t eNB_id);
1457

1458 1459 1460
void dl_phy_sync_success(module_id_t   module_idP,
                         frame_t       frameP,
                         unsigned char eNB_index,
1461
                         uint8_t first_sync);
1462 1463 1464 1465 1466 1467 1468 1469 1470 1471

int dump_eNB_l2_stats(char *buffer, int length);

double uniform_rngen(int min, int max);

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