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

22
/*! \file LAYER2/MAC/proto.h
23
 * \brief MAC functions prototypes for eNB and UE
24
 * \author Navid Nikaein and Raymond Knopp
25
 * \date 2010 - 2014
26
 * \email navid.nikaein@eurecom.fr
27
 * \version 1.0
28 29 30
 */
#ifndef __LAYER2_MAC_PROTO_H__
#define __LAYER2_MAC_PROTO_H__
31

32 33
#include "LAYER2/MAC/defs.h"

34 35 36
/** \addtogroup _mac
 *  @{
 */
37

38 39 40 41
/**
 * slice specific scheduler
 */
typedef void (*slice_scheduler_dl)(module_id_t mod_id,
42 43 44
				   slice_id_t  slice_id,
				   frame_t     frame,
				   sub_frame_t subframe,
45
				   int        *mbsfn_flag);
46 47

typedef void (*slice_scheduler_ul)(module_id_t mod_id,
48 49 50 51
                                   slice_id_t  slice_id,
				   frame_t       frame,
				   sub_frame_t   subframe,
				   unsigned char sched_subframe,
52
                                   uint16_t     *first_rb);
53

54 55 56 57 58 59 60
/** \fn void schedule_mib(module_id_t module_idP,frame_t frameP,sub_frame_t subframe);
\brief MIB scheduling for PBCH. This function requests the MIB from RRC and provides it to L1.
@param Mod_id Instance ID of eNB
@param frame Frame index
@param subframe Subframe number on which to act

*/
61

62 63
void schedule_mib(module_id_t module_idP,
		  frame_t frameP, sub_frame_t subframeP);
64 65

/** \fn void schedule_RA(module_id_t module_idP,frame_t frameP,sub_frame_t subframe);
66
\brief First stage of Random-Access Scheduling. Loops over the ras 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)
67 68 69 70 71
for the message.
@param Mod_id Instance ID of eNB
@param frame Frame index
@param subframe Subframe number on which to act
*/
72 73


74 75
void schedule_RA(module_id_t module_idP, frame_t frameP,
		 sub_frame_t subframe);
76 77 78 79 80 81

/** \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
*/
82 83
void schedule_SI(module_id_t module_idP, frame_t frameP,
		 sub_frame_t subframeP);
84 85 86 87 88 89

/** \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
*/
90 91
int schedule_MBMS(module_id_t module_idP, uint8_t CC_id, frame_t frameP,
		  sub_frame_t subframe);
92 93 94 95

/** \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
96
@param[out] index of sf pattern
97
*/
98 99
int8_t get_mbsfn_sf_alloction(module_id_t module_idP, uint8_t CC_id,
			      uint8_t mbsfn_sync_area);
100 101 102 103 104

/** \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
105
@param[out] index of sf pattern
106
*/
107 108 109
int8_t ue_get_mbsfn_sf_alloction(module_id_t module_idP,
				 uint8_t mbsfn_sync_area,
				 unsigned char eNB_index);
110 111 112 113 114 115

/** \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
*/
116 117
void schedule_ulsch(module_id_t module_idP, frame_t frameP,
		    sub_frame_t subframe);
118

119
/** \brief ULSCH Scheduling per RNTI
120
@param Mod_id Instance ID of eNB
121
@param slice_id Instance slice for this eNB
122 123 124 125
@param frame Frame index
@param subframe Subframe number on which to act
@param sched_subframe Subframe number where PUSCH is transmitted (for DAI lookup)
*/
126
void schedule_ulsch_rnti(module_id_t module_idP, slice_id_t slice_idP, frame_t frameP,
127 128 129
			 sub_frame_t subframe,
			 unsigned char sched_subframe,
			 uint16_t * first_rb);
130

131
/** \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.
132 133 134 135 136
@param Mod_id Instance of eNB
@param frame Frame index
@param subframe Index of subframe
@param mbsfn_flag Indicates that this subframe is for MCH/MCCH
*/
137 138
void fill_DLSCH_dci(module_id_t module_idP, frame_t frameP,
		    sub_frame_t subframe, int *mbsfn_flag);
139

140
/** \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
141 142 143
@param Mod_id Instance ID of eNB
@param frame Frame index
@param subframe Subframe on which to act
knopp's avatar
knopp committed
144

145 146
@param mbsfn_flag  Indicates that MCH/MCCH is in this subframe
*/
147
void schedule_dlsch(module_id_t module_idP, frame_t frameP,
148
		      sub_frame_t subframe, int *mbsfn_flag);
149

150 151 152
void schedule_ue_spec(module_id_t module_idP, slice_id_t slice_idP,
		      frame_t frameP,sub_frame_t subframe, int *mbsfn_flag);

153

154 155 156 157
/** \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
*/
158
int8_t get_Po_NOMINAL_PUSCH(module_id_t module_idP, uint8_t CC_id);
159

160
/** \brief Function to compute DELTA_PREAMBLE from 36.321 (for RA power ramping procedure and Msg3 PUSCH power control policy)
161 162 163
    @param Mod_id Module id of UE
    @returns DELTA_PREAMBLE
*/
164
int8_t get_DELTA_PREAMBLE(module_id_t module_idP, int CC_id);
165

166
/** \brief Function for compute deltaP_rampup from 36.321 (for RA power ramping procedure and Msg3 PUSCH power control policy)
167
    @param Mod_id Module id of UE
168
    @param CC_id carrier component id of UE
169 170
    @returns deltaP_rampup
*/
171
int8_t get_deltaP_rampup(module_id_t module_idP, uint8_t CC_id);
172

173 174
uint16_t mac_computeRIV(uint16_t N_RB_DL, uint16_t RBstart,
			uint16_t Lcrbs);
175

176 177
void add_msg3(module_id_t module_idP, int CC_id, RA_t * ra, frame_t frameP,
	      sub_frame_t subframeP);
178

179
//main.c
180

181 182
int mac_top_init(int eMBMS_active, char *uecap_xer,
		 uint8_t cba_group_active, uint8_t HO_active);
183

knopp's avatar
knopp committed
184 185
void mac_top_init_eNB(void);

186
void mac_init_cell_params(int Mod_idP, int CC_idP);
187

188 189 190 191 192 193 194 195 196 197
char layer2_init_UE(module_id_t module_idP);

char layer2_init_eNB(module_id_t module_idP, uint8_t Free_ch_index);

void mac_switch_node_function(module_id_t module_idP);

int mac_init_global_param(void);

void mac_top_cleanup(void);

198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
void mac_UE_out_of_sync_ind(module_id_t module_idP, frame_t frameP,
			    uint16_t eNB_index);

void clear_nfapi_information(eNB_MAC_INST * eNB, int CC_idP,
			     frame_t frameP, sub_frame_t subframeP);

void dlsch_scheduler_pre_processor_reset(int module_idP, int UE_id,
					 uint8_t CC_id,
					 int frameP,
					 int subframeP,
					 int N_RBG,
					 uint16_t
					 nb_rbs_required[MAX_NUM_CCs]
					 [NUMBER_OF_UE_MAX],
					 unsigned char
					 rballoc_sub[MAX_NUM_CCs]
					 [N_RBG_MAX],
					 unsigned char
					 MIMO_mode_indicator[MAX_NUM_CCs]
					 [N_RBG_MAX]);
218 219 220 221 222 223 224 225 226 227

// eNB functions
/* \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 N_RBS Number of resource block groups
 */


228
void dlsch_scheduler_pre_processor(module_id_t module_idP,
229
				   slice_id_t slice_idP,
230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
				   frame_t frameP,
				   sub_frame_t subframe,
				   int N_RBG[MAX_NUM_CCs],
				   int *mbsfn_flag);


void dlsch_scheduler_pre_processor_allocate(module_id_t Mod_id,
					    int UE_id,
					    uint8_t CC_id,
					    int N_RBG,
					    int transmission_mode,
					    int min_rb_unit,
					    uint8_t N_RB_DL,
					    uint16_t
					    nb_rbs_required[MAX_NUM_CCs]
					    [NUMBER_OF_UE_MAX],
					    uint16_t
					    nb_rbs_required_remaining
					    [MAX_NUM_CCs]
					    [NUMBER_OF_UE_MAX],
					    unsigned char
					    rballoc_sub[MAX_NUM_CCs]
					    [N_RBG_MAX],
					    unsigned char
					    MIMO_mode_indicator
					    [MAX_NUM_CCs][N_RBG_MAX]);
256 257

/* \brief Function to trigger the eNB scheduling procedure.  It is called by PHY at the beginning of each subframe, \f$n$\f
258
   and generates all DLSCH allocations for subframe \f$n\f$ and ULSCH allocations for subframe \f$n+k$\f. 
259 260 261 262
@param Mod_id Instance ID of eNB
@param subframe Index of current subframe
@param calibration_flag Flag to indicate that eNB scheduler should schedule TDD auto-calibration PUSCH.
*/
263
void eNB_dlsch_ulsch_scheduler(module_id_t module_idP, frame_t frameP, sub_frame_t subframeP);	//, int calibration_flag);
264 265 266 267

/* \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
268
@param timing_offset Offset in samples of the received PRACH w.r.t. eNB timing. This is used to
269 270 271
@param rnti RA rnti corresponding to this PRACH preamble
@param rach_resource type (0=non BL/CE,1 CE level 0,2 CE level 1, 3 CE level 2,4 CE level 3)
*/
272 273 274
void initiate_ra_proc(module_id_t module_idP, int CC_id, frame_t frameP,
		      sub_frame_t subframeP, uint16_t preamble_index,
		      int16_t timing_offset, uint16_t rnti
275
#ifdef Rel14
276
		      , uint8_t rach_resource_type
277
#endif
278
    );
279 280 281 282 283 284 285

/* \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
*/
286 287 288 289 290 291 292
unsigned short fill_rar(const module_id_t module_idP,
			const int CC_id,
			RA_t *ra,
			const frame_t frameP,
			uint8_t * const dlsch_buffer,
			const uint16_t N_RB_UL,
			const uint8_t input_buffer_length);
293

294
#ifdef Rel14
295
unsigned short fill_rar_br(eNB_MAC_INST * eNB,
296
			   int CC_id,
297 298 299 300 301
			   RA_t * ra,
			   const frame_t frameP,
			   const sub_frame_t subframeP,
			   uint8_t * const dlsch_buffer,
			   const uint8_t ce_level);
302 303
#endif

304 305 306 307
/* \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.
*/
308 309
void cancel_ra_proc(module_id_t module_idP, int CC_id, frame_t frameP,
		    uint16_t preamble_index);
310

311 312 313 314 315 316 317 318 319 320 321 322
/* \brief Function used by PHY to inform MAC that an uplink is scheduled
          for Msg3 in given subframe. This is used so that the MAC
          scheduler marks as busy the RBs used by the Msg3.
@param Mod_id        Instance ID of eNB
@param CC_id         CC ID of eNB
@param frame         current frame
@param subframe      current subframe
@param rnti          UE rnti concerned
@param Msg3_frame    frame where scheduling takes place
@param Msg3_subframe subframe where scheduling takes place
*/
void set_msg3_subframe(module_id_t Mod_id,
323 324 325 326
		       int CC_id,
		       int frame,
		       int subframe,
		       int rnti, int Msg3_frame, int Msg3_subframe);
327

328 329
/* \brief Function to indicate a received SDU on ULSCH.
@param Mod_id Instance ID of eNB
330 331
@param CC_id Component carrier index
@param rnti RNTI of UE transmitting the SDU
332
@param sdu Pointer to received SDU
333 334 335
@param sdu_len Length of SDU
@param timing_advance timing advance adjustment after this pdu
@param ul_cqi Uplink CQI estimate after this pdu (SNR quantized to 8 bits, -64 ... 63.5 dB in .5dB steps)
336
*/
337
void rx_sdu(const module_id_t enb_mod_idP,
338 339
	    const int CC_idP,
	    const frame_t frameP,
340
	    const sub_frame_t subframeP,
341 342 343 344
	    const rnti_t rntiP,
	    uint8_t * sduP,
	    const uint16_t sdu_lenP,
	    const uint16_t timing_advance, const uint8_t ul_cqi);
345

346 347

/* \brief Function to indicate a scheduled schduling request (SR) was received by eNB.
348 349 350 351
@param Mod_idP Instance ID of eNB
@param CC_idP CC_id of received SR
@param frameP of received SR
@param subframeP Index of subframe where SR was received
352
@param rnti RNTI of UE transmitting the SR
353
@param ul_cqi SNR measurement of PUCCH (SNR quantized to 8 bits, -64 ... 63.5 dB in .5dB steps)
354
*/
355 356
void SR_indication(module_id_t module_idP, int CC_id, frame_t frameP,
		   sub_frame_t subframe, rnti_t rnti, uint8_t ul_cqi);
357

358 359 360 361 362 363 364
/* \brief Function to indicate a UL failure was detected by eNB PHY.
@param Mod_id Instance ID of eNB
@param CC_id Component carrier
@param frameP Frame index
@param rnti RNTI of UE transmitting the SR
@param subframe Index of subframe where SR was received
*/
365 366
void UL_failure_indication(module_id_t Mod_id, int CC_id, frame_t frameP,
			   rnti_t rnti, sub_frame_t subframe);
367

knopp's avatar
knopp committed
368 369 370 371 372 373 374
/* \brief Function to indicate an HARQ ACK/NAK.
@param Mod_id Instance ID of eNB
@param CC_id Component carrier
@param frameP Frame index
@param subframeP subframe index
@param harq_pdu NFAPI HARQ PDU descriptor
*/
375 376 377
void harq_indication(module_id_t mod_idP, int CC_idP, frame_t frameP,
		     sub_frame_t subframeP,
		     nfapi_harq_indication_pdu_t * harq_pdu);
knopp's avatar
knopp committed
378 379 380 381 382 383 384 385 386

/* \brief Function to indicate a received CQI pdu
@param Mod_id Instance ID of eNB
@param CC_id Component carrier
@param frameP Frame index
@param subframeP subframe index
@param rntiP RNTI of incoming CQI information
@param ul_cqi_information NFAPI UL CQI measurement
*/
387 388 389 390
void cqi_indication(module_id_t mod_idP, int CC_idP, frame_t frameP,
		    sub_frame_t subframeP, rnti_t rntiP,
		    nfapi_cqi_indication_rel9_t * rel9, uint8_t * pdu,
		    nfapi_ul_cqi_information_t * ul_cqi_information);
knopp's avatar
knopp committed
391

392 393
uint8_t *get_dlsch_sdu(module_id_t module_idP, int CC_id, frame_t frameP,
		       rnti_t rnti, uint8_t TBindex);
394 395 396 397 398

/* \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
399
@param mcs Pointer to mcs used by PHY (to be filled by MAC)
400 401
@returns Pointer to MCH transport block and mcs for subframe
*/
402 403
MCH_PDU *get_mch_sdu(module_id_t Mod_id, int CC_id, frame_t frame,
		     sub_frame_t subframe);
404 405


406

407 408


409 410 411 412 413 414 415 416 417 418 419 420 421 422
void ue_mac_reset(module_id_t module_idP, uint8_t eNB_index);
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, int CC_id, int UE_id,
		       sub_frame_t subframe, UE_ULSCH_STATUS status);
void add_ue_dlsch_info(module_id_t module_idP, int CC_id, int UE_id,
		       sub_frame_t subframe, UE_DLSCH_STATUS status);
int find_UE_id(module_id_t module_idP, rnti_t rnti);
int find_RA_id(module_id_t mod_idP, int CC_idP, rnti_t rntiP);
rnti_t UE_RNTI(module_id_t module_idP, int UE_id);
int UE_PCCID(module_id_t module_idP, int UE_id);
uint8_t find_active_UEs(module_id_t module_idP);
boolean_t is_UE_active(module_id_t module_idP, int UE_id);
uint8_t get_aggregation(uint8_t bw_index, uint8_t cqi, uint8_t dci_fmt);
423 424 425

int8_t find_active_UEs_with_traffic(module_id_t module_idP);

426
void init_CCE_table(int module_idP, int CC_idP);
427 428

int get_nCCE_offset(int *CCE_table,
429 430 431 432
		    const unsigned char L,
		    const int nCCE,
		    const int common_dci,
		    const unsigned short rnti,
433 434
		    const unsigned char subframe);

435
int allocate_CCEs(int module_idP, int CC_idP, int subframe, int test_only);
436 437

boolean_t CCE_allocation_infeasible(int module_idP,
438 439 440 441 442 443 444 445 446
				    int CC_idP,
				    int common_flag,
				    int subframe,
				    int aggregation, int rnti);

void set_ue_dai(sub_frame_t subframeP,
		int UE_id,
		uint8_t CC_id, uint8_t tdd_config, UE_list_t * UE_list);

447 448 449 450 451 452 453 454
/** \brief First stage of PCH Scheduling. Gets a PCH 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 paging_ue_index
*/
void schedule_PCH(module_id_t module_idP,frame_t frameP,sub_frame_t subframeP);

455 456 457 458
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, int CC_id,
			      uint8_t UE_id);
459 460 461 462 463
/** \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
*/
464 465
module_id_t schedule_next_ulue(module_id_t module_idP, int UE_id,
			       sub_frame_t subframe);
466 467 468 469 470 471

/** \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
*/
472 473
int schedule_next_dlue(module_id_t module_idP, int CC_id,
		       sub_frame_t subframe);
474 475 476 477

/* \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
478
@param N_RB_DL Number of PRBs on DL
479 480 481
@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).
*/
482 483
uint32_t allocate_prbs(int UE_id, uint8_t nb_rb, int N_RB_DL,
		       uint32_t * rballoc);
484 485

/* \fn uint32_t req_new_ulsch(module_id_t module_idP)
486
\brief check for a new transmission in any drb
487 488 489 490 491 492 493
@param Mod_id Instance id of UE in machine
@returns 1 for new transmission, 0 for none
*/
uint32_t req_new_ulsch(module_id_t module_idP);

/* \brief Get SR payload (0,1) from UE MAC
@param Mod_id Instance id of UE in machine
knopp's avatar
knopp committed
494
@param CC_id Component Carrier index
495 496 497 498 499
@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
*/
500 501
uint32_t ue_get_SR(module_id_t module_idP, int CC_id, frame_t frameP,
		   uint8_t eNB_id, rnti_t rnti, sub_frame_t subframe);
502

503
uint8_t get_ue_weight(module_id_t module_idP, int CC_id, int UE_id);
504 505

// UE functions
506 507
void mac_out_of_sync_ind(module_id_t module_idP, frame_t frameP,
			 uint16_t CH_index);
508

509 510
void ue_decode_si(module_id_t module_idP, int CC_id, frame_t frame,
		  uint8_t CH_index, void *pdu, uint16_t len);
511

512 513
void ue_decode_p(module_id_t module_idP, int CC_id, frame_t frame,
		 uint8_t CH_index, void *pdu, uint16_t len);
514

515

516 517 518
void ue_send_sdu(module_id_t module_idP, uint8_t CC_id, frame_t frame,
		 sub_frame_t subframe, uint8_t * sdu, uint16_t sdu_len,
		 uint8_t CH_index);
519 520


Cedric Roux's avatar
Cedric Roux committed
521
#if defined(Rel10) || defined(Rel14)
522 523 524 525 526 527 528 529
/* \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
@param sync_area the index of MBSFN sync area
*/
530 531 532
void ue_send_mch_sdu(module_id_t module_idP, uint8_t CC_id, frame_t frameP,
		     uint8_t * sdu, uint16_t sdu_len, uint8_t eNB_index,
		     uint8_t sync_area);
533 534 535 536 537 538 539 540 541

/*\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
@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
*/
542 543 544
int ue_query_mch(uint8_t Mod_id, uint8_t CC_id, uint32_t frame,
		 sub_frame_t subframe, uint8_t eNB_index,
		 uint8_t * sync_area, uint8_t * mcch_active);
545 546 547

#endif

548
/* \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.
549 550 551 552 553 554
@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
*/
555 556 557 558
void ue_get_sdu(module_id_t module_idP, int CC_id, frame_t frameP,
		sub_frame_t subframe, uint8_t eNB_index,
		uint8_t * ulsch_buffer, uint16_t buflen,
		uint8_t * access_mode);
559 560 561

/* \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
knopp's avatar
knopp committed
562
@param Mod_id Component Carrier Index
563 564 565
@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 */
566 567 568
PRACH_RESOURCES_t *ue_get_rach(module_id_t module_idP, int CC_id,
			       frame_t frameP, uint8_t new_Msg3,
			       sub_frame_t subframe);
569 570 571

/* \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
572 573 574
@param CC_id Index to a component carrier
@param frame Frame index
@param ra_rnti RA_RNTI value
575 576
@param dlsch_buffer  Pointer to dlsch_buffer containing RAR PDU
@param t_crnti Pointer to PHY variable containing the T_CRNTI
577
@param preamble_index Preamble Index used by PHY to transmit the PRACH.  This should match the received RAR to trigger the rest of
578
random-access procedure
579
@param selected_rar_buffer the output buffer for storing the selected RAR header and RAR payload
580 581
@returns timing advance or 0xffff if preamble doesn't match
*/
582
uint16_t
583 584 585 586 587 588 589 590
ue_process_rar(const module_id_t module_idP,
	       const int CC_id,
	       const frame_t frameP,
	       const rnti_t ra_rnti,
	       uint8_t * const dlsch_buffer,
	       rnti_t * const t_crnti,
	       const uint8_t preamble_index,
	       uint8_t * selected_rar_buffer);
591 592 593


/* \brief Generate header for UL-SCH.  This function parses the desired control elements and sdus and generates the header as described
594
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
595 596 597 598 599 600 601 602 603 604 605 606 607 608
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
*/
609 610 611 612 613 614 615 616 617 618 619
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,
				    POWER_HEADROOM_CMD * power_headroom,
				    uint16_t * crnti,
				    BSR_SHORT * truncated_bsr,
				    BSR_SHORT * short_bsr,
				    BSR_LONG * long_bsr,
				    unsigned short post_padding);
620 621

/* \brief Parse header for UL-SCH.  This function parses the received UL-SCH header as described
622
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
623 624 625 626 627 628 629 630 631
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
*/
632 633 634 635 636 637
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);
638

639 640
int to_prb(int);
int to_rbg(int);
641 642
int l2_init(LTE_DL_FRAME_PARMS * frame_parms, int eMBMS_active,
	    char *uecap_xer, uint8_t cba_group_active, uint8_t HO_active);
643
int mac_init(void);
644 645 646 647 648
int add_new_ue(module_id_t Mod_id, int CC_id, rnti_t rnti, int harq_pid
#ifdef Rel14
	       , uint8_t rach_resource_type
#endif
    );
649
int rrc_mac_remove_ue(module_id_t Mod_id, rnti_t rntiP);
650

651

652 653 654 655 656 657 658
int maxround(module_id_t Mod_id, uint16_t rnti, int frame,
	     sub_frame_t subframe, uint8_t ul_flag);
void swap_UEs(UE_list_t * listP, int nodeiP, int nodejP, int ul_flag);
int prev(UE_list_t * listP, int nodeP, int ul_flag);
void dump_ue_list(UE_list_t * listP, int ul_flag);
int UE_num_active_CC(UE_list_t * listP, int ue_idP);
int UE_PCCID(module_id_t mod_idP, int ue_idP);
659 660
rnti_t UE_RNTI(module_id_t mod_idP, int ue_idP);

661

662
void ulsch_scheduler_pre_processor(module_id_t module_idP, slice_id_t slice_id, int frameP,
663 664 665 666 667
				   sub_frame_t subframeP,
				   uint16_t * first_rb);
void store_ulsch_buffer(module_id_t module_idP, int frameP,
			sub_frame_t subframeP);
void sort_ue_ul(module_id_t module_idP, int frameP, sub_frame_t subframeP);
668
void assign_max_mcs_min_rb(module_id_t module_idP, int slice_id, int frameP,
669 670 671
			   sub_frame_t subframeP, uint16_t * first_rb);
void adjust_bsr_info(int buffer_occupancy, uint16_t TBS,
		     UE_TEMPLATE * UE_template);
672
int phy_stats_exist(module_id_t Mod_id, int rnti);
673
void sort_UEs(module_id_t Mod_idP, slice_id_t slice_id, int frameP, sub_frame_t subframeP);
674

675
/*! \fn  UE_L2_state_t ue_scheduler(const module_id_t module_idP,const frame_t frameP, const sub_frame_t subframe, const lte_subframe_t direction,const uint8_t eNB_index)
676
   \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.
677
\param[in] module_idP instance of the UE
678 679 680 681
\param[in] rxFrame the RX frame number
\param[in] rxSubframe the RX subframe number
\param[in] txFrame the TX frame number
\param[in] txSubframe the TX subframe number
682 683 684 685
\param[in] direction  subframe direction
\param[in] eNB_index  instance of eNB
@returns L2 state (CONNETION_OK or CONNECTION_LOST or PHY_RESYNCH)
*/
686 687 688 689 690 691 692
UE_L2_STATE_t ue_scheduler(const module_id_t module_idP,
			   const frame_t rxFrameP,
			   const sub_frame_t rxSubframe,
			   const frame_t txFrameP,
			   const sub_frame_t txSubframe,
			   const lte_subframe_t direction,
			   const uint8_t eNB_index, const int CC_id);
693

694
/*! \fn  int cba_access(module_id_t module_idP,frame_t frameP,sub_frame_t subframe, uint8_t eNB_index,uint16_t buflen);
695 696 697 698 699
\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
700
\param[out] access(1) or postpone (0)
701
*/
702 703
int cba_access(module_id_t module_idP, frame_t frameP,
	       sub_frame_t subframe, uint8_t eNB_index, uint16_t buflen);
704 705 706 707 708 709 710 711 712 713 714 715 716 717 718

/*! \fn  BSR_SHORT *  get_bsr_short(module_id_t module_idP, uint8_t bsr_len)
\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
*/
BSR_SHORT *get_bsr_short(module_id_t module_idP, uint8_t bsr_len);

/*! \fn  BSR_LONG * get_bsr_long(module_id_t module_idP, uint8_t bsr_len)
\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
*/
719
BSR_LONG *get_bsr_long(module_id_t module_idP, uint8_t bsr_len);
720

721
/*! \fn  boolean_t update_bsr(module_id_t module_idP, frame_t frameP,sub_frame_t subframeP)
722
   \brief get the rlc stats and update the bsr level for each lcid
723 724 725
\param[in] Mod_id instance of the UE
\param[in] frame Frame index
*/
726 727
boolean_t update_bsr(module_id_t module_idP, frame_t frameP,
		     sub_frame_t subframeP, eNB_index_t eNB_index);
728

fnabet's avatar
fnabet committed
729
/*! \fn  locate_BsrIndexByBufferSize (int *table, int size, int value)
730
   \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.
731 732
\param[in] *table Pointer to BSR table
\param[in] size Size of the table
733
\param[in] value Value of the buffer
734 735
\return the index in the BSR_LEVEL table
*/
736 737
uint8_t locate_BsrIndexByBufferSize(const uint32_t * table, int size,
				    int value);
738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781


/*! \fn  int get_sf_periodicBSRTimer(uint8_t periodicBSR_Timer)
   \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
*/
int get_sf_periodicBSRTimer(uint8_t bucketSize);

/*! \fn  int get_ms_bucketsizeduration(uint8_t bucketSize)
   \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
*/
int get_ms_bucketsizeduration(uint8_t bucketsizeduration);

/*! \fn  int get_sf_retxBSRTimer(uint8_t retxBSR_Timer)
   \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
*/
int get_sf_retxBSRTimer(uint8_t retxBSR_Timer);

/*! \fn  int get_sf_perioidicPHR_Timer(uint8_t perioidicPHR_Timer){
   \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
*/
int get_sf_perioidicPHR_Timer(uint8_t perioidicPHR_Timer);

/*! \fn  int get_sf_prohibitPHR_Timer(uint8_t prohibitPHR_Timer)
   \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
*/
int get_sf_prohibitPHR_Timer(uint8_t prohibitPHR_Timer);

/*! \fn  int get_db_dl_PathlossChange(uint8_t dl_PathlossChange)
   \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
*/
int get_db_dl_PathlossChange(uint8_t dl_PathlossChange);

knopp's avatar
knopp committed
782
/*! \fn  uint8_t get_phr_mapping (module_id_t module_idP, int CC_id,uint8_t eNB_index)
783 784
   \brief get phr mapping as described in 36.313
\param[in]  Mod_id index of eNB
knopp's avatar
knopp committed
785
\param[in] CC_id Component Carrier Index
786 787
\return phr mapping
*/
788 789
uint8_t get_phr_mapping(module_id_t module_idP, int CC_id,
			uint8_t eNB_index);
790 791 792 793

/*! \fn  void update_phr (module_id_t module_idP)
   \brief update/reset the phr timers
\param[in]  Mod_id index of eNB
knopp's avatar
knopp committed
794
\param[in] CC_id Component carrier index
795 796
\return void
*/
797
void update_phr(module_id_t module_idP, int CC_id);
798 799 800 801 802

/*! \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
*/
803 804
void Msg3_tx(module_id_t module_idP, uint8_t CC_id, frame_t frameP,
	     uint8_t eNB_id);
805 806 807 808 809 810 811


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

812 813
void Msg1_tx(module_id_t module_idP, uint8_t CC_id, frame_t frameP,
	     uint8_t eNB_id);
814

815 816 817
void dl_phy_sync_success(module_id_t module_idP,
			 frame_t frameP,
			 unsigned char eNB_index, uint8_t first_sync);
818 819 820 821 822

int dump_eNB_l2_stats(char *buffer, int length);

double uniform_rngen(int min, int max);

823
/*
824
void add_common_dci(DCI_PDU *DCI_pdu,
825 826 827 828 829 830 831
                    void *pdu,
                    rnti_t rnti,
                    unsigned char dci_size_bytes,
                    unsigned char aggregation,
                    unsigned char dci_size_bits,
                    unsigned char dci_fmt,
                    uint8_t ra_flag);
832
*/
833

834 835
uint32_t allocate_prbs_sub(int nb_rb, int N_RB_DL, int N_RBG,
			   uint8_t * rballoc);
836

837 838
void update_ul_dci(module_id_t module_idP, uint8_t CC_id, rnti_t rnti,
		   uint8_t dai);
839

840 841
int get_bw_index(module_id_t module_id, uint8_t CC_id);

842 843
int get_min_rb_unit(module_id_t module_idP, uint8_t CC_id);

844
/* \brief Generate header for DL-SCH.  This function parses the desired control elements and sdus and generates the header as described
845
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
846 847 848 849 850
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)
851
@param drx_cmd dicontinous reception command
852 853 854
@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)
855
@param post_padding number of bytes for padding at the end of MAC PDU
856 857
@returns Number of bytes used for header
*/
858 859 860 861 862 863 864 865 866
int generate_dlsch_header(unsigned char *mac_header,
                          unsigned char num_sdus,
                          unsigned short *sdu_lengths,
                          unsigned char *sdu_lcids,
                          unsigned char drx_cmd,
                          unsigned short timing_advance_cmd,
                          unsigned char *ue_cont_res_id,
                          unsigned char short_padding,
                          unsigned short post_padding);
867

868
/** \brief RRC eNB Configuration primitive for PHY/MAC.  Allows configuration of PHY/MAC resources based on System Information (SI), RRCConnectionSetup and RRCConnectionReconfiguration messages.
869
@param Mod_id Instance ID of eNB
870
@param CC_id Component Carrier of the eNB
871
@param mib Pointer to MIB
872

873
@param radioResourceConfigCommon Structure from SIB2 for common radio parameters (if NULL keep existing configuration)
874
@param physicalConfigDedicated Structure from RRCConnectionSetup or RRCConnectionReconfiguration for dedicated PHY parameters (if NULL keep existing configuration)
875 876
@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)
877
@param logicalChannelIdentity Logical channel identity index of corresponding logical channel config
878 879 880 881
@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)
@param mobilityControlInfo mobility control info received for Handover
882
@param SchedInfoList SI Scheduling information
883 884 885 886
@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)
887
@param sib1_ext_r13 SI Scheduling information for SI-BR UEs         
888
*/
889

890 891 892 893 894 895
int rrc_mac_config_req_eNB(module_id_t module_idP,
			   int CC_id,
			   int physCellId,
			   int p_eNB,
			   int Ncp,
			   int eutra_band, uint32_t dl_CarrierFreq,
896
#ifdef Rel14
897
			   int pbch_repetition,
898
#endif
899 900 901 902
			   rnti_t rntiP,
			   BCCH_BCH_Message_t * mib,
			   RadioResourceConfigCommonSIB_t *
			   radioResourceConfigCommon,
903
#ifdef Rel14
904 905
			   RadioResourceConfigCommonSIB_t *
			   radioResourceConfigCommon_BR,
906
#endif
907 908
			   struct PhysicalConfigDedicated
			   *physicalConfigDedicated,
Cedric Roux's avatar
Cedric Roux committed
909
#if defined(Rel10) || defined(Rel14)
910
			   SCellToAddMod_r10_t * sCellToAddMod_r10,
911
			   //struct PhysicalConfigDedicatedSCell_r10 *physicalConfigDedicatedSCell_r10,
912
#endif
913 914 915 916 917 918 919 920 921 922 923 924 925 926
			   MeasObjectToAddMod_t ** measObj,
			   MAC_MainConfig_t * mac_MainConfig,
			   long logicalChannelIdentity,
			   LogicalChannelConfig_t * logicalChannelConfig,
			   MeasGapConfig_t * measGapConfig,
			   TDD_Config_t * tdd_Config,
			   MobilityControlInfo_t * mobilityControlInfo,
			   SchedulingInfoList_t * schedulingInfoList,
			   uint32_t ul_CarrierFreq,
			   long *ul_Bandwidth,
			   AdditionalSpectrumEmission_t *
			   additionalSpectrumEmission,
			   struct MBSFN_SubframeConfigList
			   *mbsfn_SubframeConfigList
Cedric Roux's avatar
Cedric Roux committed
927
#if defined(Rel10) || defined(Rel14)
928
			   ,
929 930 931
			   uint8_t MBMS_Flag,
			   MBSFN_AreaInfoList_r9_t * mbsfn_AreaInfoList,
			   PMCH_InfoList_r9_t * pmch_InfoList
932
#endif
933 934
#ifdef Rel14
			   ,
935 936
			   SystemInformationBlockType1_v1310_IEs_t *
			   sib1_ext_r13
937
#endif
938
    );
939

940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959
/** \brief RRC eNB 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 ue
@param CC_id Component Carrier of the ue
@param eNB_id Index of eNB
@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)
@param mobilityControlInfo mobility control info received for Handover
@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)
*/
960 961 962 963 964 965 966
int rrc_mac_config_req_ue(module_id_t module_idP,
			  int CC_id,
			  uint8_t eNB_index,
			  RadioResourceConfigCommonSIB_t *
			  radioResourceConfigCommon,
			  struct PhysicalConfigDedicated
			  *physicalConfigDedicated,
967
#if defined(Rel10) || defined(Rel14)
968
			  SCellToAddMod_r10_t * sCellToAddMod_r10,
969 970
			  //struct PhysicalConfigDedicatedSCell_r10 *physicalConfigDedicatedSCell_r10,
#endif
971 972
			  MeasObjectToAddMod_t ** measObj,
			  MAC_MainConfig_t * mac_MainConfig,
973
			  long logicalChannelIdentity,
974 975 976 977 978 979 980
			  LogicalChannelConfig_t * logicalChannelConfig,
			  MeasGapConfig_t * measGapConfig,
			  TDD_Config_t * tdd_Config,
			  MobilityControlInfo_t * mobilityControlInfo,
			  uint8_t * SIwindowsize,
			  uint16_t * SIperiod,
			  ARFCN_ValueEUTRA_t * ul_CarrierFreq,
981
			  long *ul_Bandwidth,
982 983 984 985
			  AdditionalSpectrumEmission_t *
			  additionalSpectrumEmission,
			  struct MBSFN_SubframeConfigList
			  *mbsfn_SubframeConfigList
986
#if defined(Rel10) || defined(Rel14)
987 988
			  ,
			  uint8_t MBMS_Flag,
989 990
			  MBSFN_AreaInfoList_r9_t * mbsfn_AreaInfoList,
			  PMCH_InfoList_r9_t * pmch_InfoList
991 992 993
#endif
#ifdef CBA
			  ,
994
			  uint8_t num_active_cba_groups, uint16_t cba_rnti
995
#endif
996
    );
997

998
uint16_t getRIV(uint16_t N_RB_DL, uint16_t RBstart, uint16_t Lcrbs);
999

1000
int get_subbandsize(uint8_t dl_bandwidth);
1001

1002

1003
void get_Msg3allocret(COMMON_channels_t * cc,
1004 1005
		      sub_frame_t current_subframe,
		      frame_t current_frame,
1006
		      frame_t * frame, sub_frame_t * subframe);
1007

1008
void get_Msg3alloc(COMMON_channels_t * cc,
1009 1010
		   sub_frame_t current_subframe,
		   frame_t current_frame,
1011
		   frame_t * frame, sub_frame_t * subframe);
1012

1013 1014
uint16_t mac_computeRIV(uint16_t N_RB_DL, uint16_t RBstart,
			uint16_t Lcrbs);
1015

1016
int get_phich_resource_times6(COMMON_channels_t * cc);
1017 1018 1019 1020 1021

int to_rbg(int dl_Bandwidth);

int to_prb(int dl_Bandwidth);

1022 1023
uint8_t get_Msg3harqpid(COMMON_channels_t * cc,
			frame_t frame, sub_frame_t current_subframe);
1024

1025 1026
uint32_t pdcchalloc2ulframe(COMMON_channels_t * ccP, uint32_t frame,
			    uint8_t n);
1027

1028
uint8_t pdcchalloc2ulsubframe(COMMON_channels_t * ccP, uint8_t n);
1029

1030
int is_UL_sf(COMMON_channels_t * ccP, sub_frame_t subframeP);
1031

1032
uint8_t getQm(uint8_t mcs);
1033

1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085
uint8_t subframe2harqpid(COMMON_channels_t * cc, frame_t frame,
			 sub_frame_t subframe);

void get_srs_pos(COMMON_channels_t * cc, uint16_t isrs,
		 uint16_t * psrsPeriodicity, uint16_t * psrsOffset);

void get_csi_params(COMMON_channels_t * cc,
		    struct CQI_ReportPeriodic *cqi_PMI_ConfigIndex,
		    uint16_t * Npd, uint16_t * N_OFFSET_CQI, int *H);

uint8_t get_rel8_dl_cqi_pmi_size(UE_sched_ctrl * sched_ctl, int CC_idP,
				 COMMON_channels_t * cc, uint8_t tmode,
				 struct CQI_ReportPeriodic
				 *cqi_ReportPeriodic);

uint8_t get_dl_cqi_pmi_size_pusch(COMMON_channels_t * cc, uint8_t tmode,
				  uint8_t ri,
				  CQI_ReportModeAperiodic_t *
				  cqi_ReportModeAperiodic);
void extract_pucch_csi(module_id_t mod_idP, int CC_idP, int UE_id,
		       frame_t frameP, sub_frame_t subframeP,
		       uint8_t * pdu, uint8_t length);

void extract_pusch_csi(module_id_t mod_idP, int CC_idP, int UE_id,
		       frame_t frameP, sub_frame_t subframeP,
		       uint8_t * pdu, uint8_t length);

uint16_t fill_nfapi_tx_req(nfapi_tx_request_body_t * tx_req_body,
			   uint16_t absSF, uint16_t pdu_length,
			   uint16_t pdu_index, uint8_t * pdu);

void fill_nfapi_ulsch_config_request_rel8(nfapi_ul_config_request_pdu_t *
					  ul_config_pdu, uint8_t cqi_req,
					  COMMON_channels_t * cc,
					  struct PhysicalConfigDedicated
					  *physicalConfigDedicated,
					  uint8_t tmode, uint32_t handle,
					  uint16_t rnti,
					  uint8_t resource_block_start,
					  uint8_t
					  number_of_resource_blocks,
					  uint8_t mcs,
					  uint8_t cyclic_shift_2_for_drms,
					  uint8_t
					  frequency_hopping_enabled_flag,
					  uint8_t frequency_hopping_bits,
					  uint8_t new_data_indication,
					  uint8_t redundancy_version,
					  uint8_t harq_process_number,
					  uint8_t ul_tx_mode,
					  uint8_t current_tx_nb,
					  uint8_t n_srs, uint16_t size);
1086 1087

#ifdef Rel14
1088 1089 1090 1091
void fill_nfapi_ulsch_config_request_emtc(nfapi_ul_config_request_pdu_t *
					  ul_config_pdu, uint8_t ue_type,
					  uint16_t
					  total_number_of_repetitions,
1092
					  uint16_t repetition_number,
1093 1094
					  uint16_t
					  initial_transmission_sf_io);
1095 1096
#endif

1097 1098 1099
void program_dlsch_acknak(module_id_t module_idP, int CC_idP, int UE_idP,
			  frame_t frameP, sub_frame_t subframeP,
			  uint8_t cce_idx);
1100

1101 1102 1103
void fill_nfapi_dlsch_config(eNB_MAC_INST * eNB,
			     nfapi_dl_config_request_body_t * dl_req,
			     uint16_t length, uint16_t pdu_index,
1104 1105
			     uint16_t rnti,
			     uint8_t resource_allocation_type,
1106 1107
			     uint8_t
			     virtual_resource_block_assignment_flag,
1108 1109 1110 1111 1112 1113 1114 1115
			     uint16_t resource_block_coding,
			     uint8_t modulation,
			     uint8_t redundancy_version,
			     uint8_t transport_blocks,
			     uint8_t transport_block_to_codeword_swap_flag,
			     uint8_t transmission_scheme,
			     uint8_t number_of_layers,
			     uint8_t number_of_subbands,
1116
			     //                      uint8_t codebook_index,
1117 1118 1119 1120 1121 1122 1123
			     uint8_t ue_category_capacity,
			     uint8_t pa,
			     uint8_t delta_power_offset_index,
			     uint8_t ngap,
			     uint8_t nprb,
			     uint8_t transmission_mode,
			     uint8_t num_bf_prb_per_subband,
1124
			     uint8_t num_bf_vector);
1125 1126 1127 1128 1129

void fill_nfapi_harq_information(module_id_t module_idP,
				 int CC_idP,
				 uint16_t rntiP,
				 uint16_t absSFP,
1130 1131
				 nfapi_ul_config_harq_information *
				 harq_information, uint8_t cce_idxP);
1132 1133 1134 1135

void fill_nfapi_ulsch_harq_information(module_id_t module_idP,
				       int CC_idP,
				       uint16_t rntiP,
1136 1137
				       nfapi_ul_config_ulsch_harq_information
				       * harq_information);
1138 1139 1140 1141

uint16_t fill_nfapi_uci_acknak(module_id_t module_idP,
			       int CC_idP,
			       uint16_t rntiP,
1142
			       uint16_t absSFP, uint8_t cce_idxP);
1143

1144
void fill_nfapi_dl_dci_1A(nfapi_dl_config_request_pdu_t * dl_config_pdu,
1145 1146 1147 1148 1149 1150 1151
			  uint8_t aggregation_level,
			  uint16_t rnti,
			  uint8_t rnti_type,
			  uint8_t harq_process,
			  uint8_t tpc,
			  uint16_t resource_block_coding,
			  uint8_t mcs,
1152
			  uint8_t ndi, uint8_t rv, uint8_t vrb_flag);
1153

1154 1155 1156
nfapi_ul_config_request_pdu_t *has_ul_grant(module_id_t module_idP,
					    int CC_idP, uint16_t subframeP,
					    uint16_t rnti);
1157

1158
uint8_t get_tmode(module_id_t module_idP, int CC_idP, int UE_idP);
1159

1160 1161
uint8_t get_ul_req_index(module_id_t module_idP, int CC_idP,
			 sub_frame_t subframeP);
1162 1163 1164 1165

#ifdef Rel14
int get_numnarrowbandbits(long dl_Bandwidth);

1166 1167 1168
int mpdcch_sf_condition(eNB_MAC_INST * eNB, int CC_id, frame_t frameP,
			sub_frame_t subframeP, int rmax,
			MPDCCH_TYPES_t mpdcch_type, int UE_id);
1169 1170

int get_numnarrowbands(long dl_Bandwidth);
1171

1172
int narrowband_to_first_rb(COMMON_channels_t * cc, int nb_index);
1173

1174 1175
#endif

1176 1177
int l2_init_eNB(void);

1178 1179 1180 1181 1182
void Msg1_transmitted(module_id_t module_idP, uint8_t CC_id,
		      frame_t frameP, uint8_t eNB_id);
void Msg3_transmitted(module_id_t module_idP, uint8_t CC_id,
		      frame_t frameP, uint8_t eNB_id);
uint32_t from_earfcn(int eutra_bandP, uint32_t dl_earfcn);
Cedric Roux's avatar
Cedric Roux committed
1183
int32_t get_uldl_offset(int eutra_bandP);
1184 1185
int l2_init_ue(int eMBMS_active, char *uecap_xer, uint8_t cba_group_active,
	       uint8_t HO_active);
1186

1187 1188 1189
/*Slice related functions */
uint16_t flexran_nb_rbs_allowed_slice(float rb_percentage, int total_rbs);

1190
int ue_slice_membership(int UE_id, int slice_id);
1191

1192
#endif
1193
/** @}*/