mac_proto.h 50.5 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
#include "LAYER2/MAC/mac.h"
33
#include "PHY/defs_common.h" // for PRACH_RESOURCES_t and lte_subframe_t
34

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

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

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

55 56 57 58 59 60 61
/** \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

*/
62

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

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


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

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

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

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

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

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

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

132
/** \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.
133 134 135 136 137
@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
*/
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
Raymond Knopp's avatar
Raymond 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
void schedule_ue_spec(module_id_t module_idP, slice_id_t slice_idP,
		      frame_t frameP,sub_frame_t subframe, int *mbsfn_flag);
152 153

void schedule_ue_spec_phy_test(module_id_t module_idP,frame_t frameP,sub_frame_t subframe,int *mbsfn_flag);
Wang Tsu-Han's avatar
Wang Tsu-Han committed
154
void schedule_ulsch_phy_test(module_id_t module_idP,frame_t frameP,sub_frame_t subframeP);
155

156

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

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

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

176 177
uint16_t mac_computeRIV(uint16_t N_RB_DL, uint16_t RBstart,
			uint16_t Lcrbs);
178

179 180
void add_msg3(module_id_t module_idP, int CC_id, RA_t * ra, frame_t frameP,
	      sub_frame_t subframeP);
181

182
//main.c
183

184 185
int mac_top_init(int eMBMS_active, char *uecap_xer,
		 uint8_t cba_group_active, uint8_t HO_active);
186

Raymond Knopp's avatar
Raymond Knopp committed
187 188
void mac_top_init_eNB(void);

189
void mac_init_cell_params(int Mod_idP, int CC_idP);
190

191 192 193 194 195 196 197 198 199 200
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);

201 202 203 204 205 206 207 208 209 210 211 212
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
213 214
					 nb_rbs_required[NFAPI_CC_MAX]
					 [MAX_MOBILES_PER_ENB],
215
					 unsigned char
216
					 rballoc_sub[NFAPI_CC_MAX]
217 218
					 [N_RBG_MAX],
					 unsigned char
219
					 MIMO_mode_indicator[NFAPI_CC_MAX]
220
					 [N_RBG_MAX]);
221 222 223 224 225 226 227 228 229 230

// 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
 */


231
void dlsch_scheduler_pre_processor(module_id_t module_idP,
232
				   slice_id_t slice_idP,
233 234
				   frame_t frameP,
				   sub_frame_t subframe,
235
				   int N_RBG[NFAPI_CC_MAX],
236
				   int *mbsfn_flag);
237

238

239 240 241 242 243 244 245
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,
246 247 248 249
					    uint16_t nb_rbs_required[NFAPI_CC_MAX][MAX_MOBILES_PER_ENB],
					    uint16_t nb_rbs_required_remaining[NFAPI_CC_MAX][MAX_MOBILES_PER_ENB],
					    unsigned char rballoc_sub[NFAPI_CC_MAX][N_RBG_MAX],
					    unsigned char MIMO_mode_indicator[NFAPI_CC_MAX][N_RBG_MAX]);
250 251

/* \brief Function to trigger the eNB scheduling procedure.  It is called by PHY at the beginning of each subframe, \f$n$\f
252
   and generates all DLSCH allocations for subframe \f$n\f$ and ULSCH allocations for subframe \f$n+k$\f. 
253 254 255 256
@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.
*/
257
void eNB_dlsch_ulsch_scheduler(module_id_t module_idP, frame_t frameP, sub_frame_t subframeP);	//, int calibration_flag);
258 259 260 261

/* \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
262
@param timing_offset Offset in samples of the received PRACH w.r.t. eNB timing. This is used to
263 264 265
@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)
*/
266 267 268
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
269
#if (RRC_VERSION >= MAKE_VERSION(14, 0, 0))
270
		      , uint8_t rach_resource_type
271
#endif
272
    );
273 274 275 276 277 278 279

/* \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
*/
280 281 282 283 284 285 286
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);
287

288
#if (RRC_VERSION >= MAKE_VERSION(14, 0, 0))
289
unsigned short fill_rar_br(eNB_MAC_INST * eNB,
290
			   int CC_id,
291 292 293 294 295
			   RA_t * ra,
			   const frame_t frameP,
			   const sub_frame_t subframeP,
			   uint8_t * const dlsch_buffer,
			   const uint8_t ce_level);
296 297
#endif

298 299 300 301
/* \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.
*/
302 303
void cancel_ra_proc(module_id_t module_idP, int CC_id, frame_t frameP,
		    uint16_t preamble_index);
304

305 306 307 308 309 310 311 312 313 314 315
/* \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
*/
316 317 318

void clear_ra_proc(module_id_t module_idP, int CC_id, frame_t frameP);

319
void set_msg3_subframe(module_id_t Mod_id,
320 321 322 323
		       int CC_id,
		       int frame,
		       int subframe,
		       int rnti, int Msg3_frame, int Msg3_subframe);
324

325 326
/* \brief Function to indicate a received SDU on ULSCH.
@param Mod_id Instance ID of eNB
327 328
@param CC_id Component carrier index
@param rnti RNTI of UE transmitting the SDU
329
@param sdu Pointer to received SDU
330 331 332
@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)
333
*/
334
void rx_sdu(const module_id_t enb_mod_idP,
335 336
	    const int CC_idP,
	    const frame_t frameP,
337
	    const sub_frame_t subframeP,
338 339 340 341
	    const rnti_t rntiP,
	    uint8_t * sduP,
	    const uint16_t sdu_lenP,
	    const uint16_t timing_advance, const uint8_t ul_cqi);
342

343 344

/* \brief Function to indicate a scheduled schduling request (SR) was received by eNB.
345 346 347 348
@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
349
@param rnti RNTI of UE transmitting the SR
350
@param ul_cqi SNR measurement of PUCCH (SNR quantized to 8 bits, -64 ... 63.5 dB in .5dB steps)
351
*/
352 353
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);
354

355 356 357 358 359 360 361
/* \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
*/
362 363
void UL_failure_indication(module_id_t Mod_id, int CC_id, frame_t frameP,
			   rnti_t rnti, sub_frame_t subframe);
364

Raymond Knopp's avatar
Raymond Knopp committed
365 366 367 368 369 370 371
/* \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
*/
372 373 374
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);
Raymond Knopp's avatar
Raymond Knopp committed
375 376 377 378 379 380 381 382 383

/* \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
*/
384 385 386 387
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);
Raymond Knopp's avatar
Raymond Knopp committed
388

389 390
uint8_t *get_dlsch_sdu(module_id_t module_idP, int CC_id, frame_t frameP,
		       rnti_t rnti, uint8_t TBindex);
391 392 393 394 395

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


403

404 405


406 407 408 409 410 411 412 413 414 415 416 417 418 419
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);
420 421 422

int8_t find_active_UEs_with_traffic(module_id_t module_idP);

423
void init_CCE_table(int module_idP, int CC_idP);
424 425

int get_nCCE_offset(int *CCE_table,
426 427 428 429
		    const unsigned char L,
		    const int nCCE,
		    const int common_dci,
		    const unsigned short rnti,
430 431
		    const unsigned char subframe);

Xu Bo's avatar
Xu Bo committed
432
int allocate_CCEs(int module_idP, int CC_idP, frame_t frameP, sub_frame_t subframeP, int test_only);
433 434

boolean_t CCE_allocation_infeasible(int module_idP,
435 436 437 438 439 440 441 442
				    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);
443

444
uint8_t frame_subframe2_dl_harq_pid(TDD_Config_t *tdd_Config, int abs_frameP, sub_frame_t subframeP);
445 446 447 448 449 450 451
/** \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);
452 453 454 455 456

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

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

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

/* \fn uint32_t req_new_ulsch(module_id_t module_idP)
484
\brief check for a new transmission in any drb
485 486 487 488 489 490 491
@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
Raymond Knopp's avatar
 
Raymond Knopp committed
492
@param CC_id Component Carrier index
493 494 495 496 497
@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
*/
498 499
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);
500

501
uint8_t get_ue_weight(module_id_t module_idP, int CC_id, int UE_id);
502 503

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

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

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

513

514 515 516
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);
517

518 519 520 521 522 523 524 525 526
void ue_send_sl_sdu(module_id_t module_idP,
		    uint8_t CC_id,
		    frame_t frameP,
		    sub_frame_t subframeP,
		    uint8_t* sdu,
		    uint16_t sdu_len,
		    uint8_t eNB_index,
	       sl_discovery_flag_t sl_discovery_flag
		    );
527

528
#if (RRC_VERSION >= MAKE_VERSION(10, 0, 0))
529 530 531 532 533 534 535 536
/* \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
*/
537 538 539
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);
540 541 542 543 544 545 546 547 548

/*\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
*/
549
int ue_query_mch(module_id_t Mod_id, uint8_t CC_id, uint32_t frame,
550 551
		 sub_frame_t subframe, uint8_t eNB_index,
		 uint8_t * sync_area, uint8_t * mcch_active);
552 553 554

#endif

555
/* \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.
556 557 558 559 560
@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
*/
561 562 563 564
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);
565

566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589
/* \brief Called by PHY to get sdu for PSBCH/SSS/PSS transmission.
@param Mod_id Instance id of UE in machine
@param frame_tx TX frame index
@param subframe_tx TX subframe index
@returns pointer to SLSS_t descriptor
*/
SLSS_t *ue_get_slss(module_id_t module_idP, int CC_id,frame_t frameP, sub_frame_t subframe);

/* \brief Called by PHY to get sdu for PSDCH transmission.
@param Mod_id Instance id of UE in machine
@param frame_tx TX frame index
@param subframe_tx TX subframe index
@returns pointer to SLDCH_t descriptor
*/
SLDCH_t *ue_get_sldch(module_id_t module_idP, int CC_id,frame_t frameP, sub_frame_t subframe);

/* \brief Called by PHY to get sdu for PSSCH transmission.
@param Mod_id Instance id of UE in machine
@param frame_tx TX frame index
@param subframe_tx TX subframe index
@returns pointer to SLSCH_t descriptor
*/
SLSCH_t *ue_get_slsch(module_id_t module_idP, int CC_id,frame_t frameP, sub_frame_t subframe);

590 591
/* \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
Raymond Knopp's avatar
 
Raymond Knopp committed
592
@param Mod_id Component Carrier Index
593 594 595
@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 */
596 597 598
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);
599 600 601

/* \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
602 603 604
@param CC_id Index to a component carrier
@param frame Frame index
@param ra_rnti RA_RNTI value
605 606
@param dlsch_buffer  Pointer to dlsch_buffer containing RAR PDU
@param t_crnti Pointer to PHY variable containing the T_CRNTI
607
@param preamble_index Preamble Index used by PHY to transmit the PRACH.  This should match the received RAR to trigger the rest of
608
random-access procedure
609
@param selected_rar_buffer the output buffer for storing the selected RAR header and RAR payload
610 611
@returns timing advance or 0xffff if preamble doesn't match
*/
612
uint16_t
613 614 615 616 617 618 619 620
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);
621 622 623


/* \brief Generate header for UL-SCH.  This function parses the desired control elements and sdus and generates the header as described
624
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
625 626 627 628 629 630 631 632 633 634 635 636 637 638
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
*/
639 640 641 642 643 644 645 646 647 648 649
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);
650 651

/* \brief Parse header for UL-SCH.  This function parses the received UL-SCH header as described
652
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
653 654 655 656 657 658 659 660 661
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
*/
662 663 664 665 666 667
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);
668

669 670
int to_prb(int);
int to_rbg(int);
671
int mac_init(void);
672
int add_new_ue(module_id_t Mod_id, int CC_id, rnti_t rnti, int harq_pid
673
#if (RRC_VERSION >= MAKE_VERSION(14, 0, 0))
674 675 676
	       , uint8_t rach_resource_type
#endif
    );
677
int rrc_mac_remove_ue(module_id_t Mod_id, rnti_t rntiP);
678

679 680
void store_dlsch_buffer(module_id_t Mod_id, slice_id_t slice_id, frame_t frameP, sub_frame_t subframeP);
void assign_rbs_required(module_id_t Mod_id, slice_id_t slice_id, frame_t frameP, sub_frame_t subframe, uint16_t nb_rbs_required[NFAPI_CC_MAX][MAX_MOBILES_PER_ENB], int min_rb_unit[NFAPI_CC_MAX]);
681

682 683 684 685 686 687 688
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);
689 690
rnti_t UE_RNTI(module_id_t mod_idP, int ue_idP);

Xu Bo's avatar
Xu Bo committed
691
uint8_t find_rb_table_index(uint8_t average_rbs);
692

693 694 695 696 697
void set_ul_DAI(int module_idP,
                int UE_idP,
                int CC_idP,
                int frameP,
                int subframeP);
698

699
void ulsch_scheduler_pre_processor(module_id_t module_idP, slice_id_t slice_id, int frameP,
700
				   sub_frame_t subframeP,
701
                                   unsigned char sched_subframeP,
702 703 704 705
				   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);
706
void assign_max_mcs_min_rb(module_id_t module_idP, int slice_id, int frameP,
707 708 709
			   sub_frame_t subframeP, uint16_t * first_rb);
void adjust_bsr_info(int buffer_occupancy, uint16_t TBS,
		     UE_TEMPLATE * UE_template);
710

711
int phy_stats_exist(module_id_t Mod_id, int rnti);
712
void sort_UEs(module_id_t Mod_idP, slice_id_t slice_id, int frameP, sub_frame_t subframeP);
713

714
/*! \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)
715
   \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.
716
\param[in] module_idP instance of the UE
717 718 719 720
\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
721 722 723 724
\param[in] direction  subframe direction
\param[in] eNB_index  instance of eNB
@returns L2 state (CONNETION_OK or CONNECTION_LOST or PHY_RESYNCH)
*/
725 726 727 728 729 730 731
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);
732

733
/*! \fn  int cba_access(module_id_t module_idP,frame_t frameP,sub_frame_t subframe, uint8_t eNB_index,uint16_t buflen);
734 735 736 737 738
\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
739
\param[out] access(1) or postpone (0)
740
*/
741 742
int cba_access(module_id_t module_idP, frame_t frameP,
	       sub_frame_t subframe, uint8_t eNB_index, uint16_t buflen);
743 744 745 746 747 748 749 750 751 752 753 754 755 756 757

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

760
/*! \fn  boolean_t update_bsr(module_id_t module_idP, frame_t frameP,sub_frame_t subframeP)
761
   \brief get the rlc stats and update the bsr level for each lcid
762 763 764
\param[in] Mod_id instance of the UE
\param[in] frame Frame index
*/
765 766
boolean_t update_bsr(module_id_t module_idP, frame_t frameP,
		     sub_frame_t subframeP, eNB_index_t eNB_index);
767

fnabet's avatar
fnabet committed
768
/*! \fn  locate_BsrIndexByBufferSize (int *table, int size, int value)
769
   \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.
770 771
\param[in] *table Pointer to BSR table
\param[in] size Size of the table
772
\param[in] value Value of the buffer
773 774
\return the index in the BSR_LEVEL table
*/
775 776
uint8_t locate_BsrIndexByBufferSize(const uint32_t * table, int size,
				    int value);
777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820


/*! \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);

Raymond Knopp's avatar
 
Raymond Knopp committed
821
/*! \fn  uint8_t get_phr_mapping (module_id_t module_idP, int CC_id,uint8_t eNB_index)
822 823
   \brief get phr mapping as described in 36.313
\param[in]  Mod_id index of eNB
Raymond Knopp's avatar
 
Raymond Knopp committed
824
\param[in] CC_id Component Carrier Index
825 826
\return phr mapping
*/
827 828
uint8_t get_phr_mapping(module_id_t module_idP, int CC_id,
			uint8_t eNB_index);
829 830 831 832

/*! \fn  void update_phr (module_id_t module_idP)
   \brief update/reset the phr timers
\param[in]  Mod_id index of eNB
Raymond Knopp's avatar
 
Raymond Knopp committed
833
\param[in] CC_id Component carrier index
834 835
\return void
*/
836
void update_phr(module_id_t module_idP, int CC_id);
837 838 839 840 841

/*! \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
*/
842 843
void Msg3_tx(module_id_t module_idP, uint8_t CC_id, frame_t frameP,
	     uint8_t eNB_id);
844 845 846 847 848 849 850


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

851 852
void Msg1_tx(module_id_t module_idP, uint8_t CC_id, frame_t frameP,
	     uint8_t eNB_id);
853

854 855 856
void dl_phy_sync_success(module_id_t module_idP,
			 frame_t frameP,
			 unsigned char eNB_index, uint8_t first_sync);
857 858 859 860 861

int dump_eNB_l2_stats(char *buffer, int length);

double uniform_rngen(int min, int max);

862
/*
863
void add_common_dci(DCI_PDU *DCI_pdu,
864 865 866 867 868 869 870
                    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);
871
*/
872

873 874
uint32_t allocate_prbs_sub(int nb_rb, int N_RB_DL, int N_RBG,
			   uint8_t * rballoc);
875

876
void update_ul_dci(module_id_t module_idP, uint8_t CC_id, rnti_t rnti,
877
		   uint8_t dai, sub_frame_t subframe);
878

879 880
int get_bw_index(module_id_t module_id, uint8_t CC_id);

881 882
int get_min_rb_unit(module_id_t module_idP, uint8_t CC_id);

883
/* \brief Generate header for DL-SCH.  This function parses the desired control elements and sdus and generates the header as described
884
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
885 886 887 888 889
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)
890
@param drx_cmd dicontinous reception command
891 892 893
@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)
894
@param post_padding number of bytes for padding at the end of MAC PDU
895 896
@returns Number of bytes used for header
*/
897 898 899 900 901 902 903 904 905
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);
906

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

912
@param radioResourceConfigCommon Structure from SIB2 for common radio parameters (if NULL keep existing configuration)
913
@param physicalConfigDedicated Structure from RRCConnectionSetup or RRCConnectionReconfiguration for dedicated PHY parameters (if NULL keep existing configuration)
914 915
@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)
916
@param logicalChannelIdentity Logical channel identity index of corresponding logical channel config
917 918 919 920
@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
921
@param SchedInfoList SI Scheduling information
922 923 924 925
@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)
926
@param sib1_ext_r13 SI Scheduling information for SI-BR UEs         
927
*/
928

929 930 931 932 933 934
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,
935
#if (RRC_VERSION >= MAKE_VERSION(14, 0, 0))
936
			   int pbch_repetition,
937
#endif
938 939 940 941
			   rnti_t rntiP,
			   BCCH_BCH_Message_t * mib,
			   RadioResourceConfigCommonSIB_t *
			   radioResourceConfigCommon,
942
#if (RRC_VERSION >= MAKE_VERSION(14, 0, 0))
943 944
			   RadioResourceConfigCommonSIB_t *
			   radioResourceConfigCommon_BR,
945
#endif
946 947
			   struct PhysicalConfigDedicated
			   *physicalConfigDedicated,
948
#if (RRC_VERSION >= MAKE_VERSION(10, 0, 0))
949
			   SCellToAddMod_r10_t * sCellToAddMod_r10,
950
			   //struct PhysicalConfigDedicatedSCell_r10 *physicalConfigDedicatedSCell_r10,
951
#endif
952 953 954 955 956 957 958 959 960 961 962 963 964 965
			   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
966
#if (RRC_VERSION >= MAKE_VERSION(9, 0, 0))
967
			   ,
968 969 970
			   uint8_t MBMS_Flag,
			   MBSFN_AreaInfoList_r9_t * mbsfn_AreaInfoList,
			   PMCH_InfoList_r9_t * pmch_InfoList
971
#endif
972
#if (RRC_VERSION >= MAKE_VERSION(13, 0, 0))
973
			   ,
974 975
			   SystemInformationBlockType1_v1310_IEs_t *
			   sib1_ext_r13
976
#endif
977
    );
978

979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998
/** \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)
*/
999 1000 1001 1002 1003 1004 1005
int rrc_mac_config_req_ue(module_id_t module_idP,
			  int CC_id,
			  uint8_t eNB_index,
			  RadioResourceConfigCommonSIB_t *
			  radioResourceConfigCommon,
			  struct PhysicalConfigDedicated
			  *physicalConfigDedicated,
1006
#if (RRC_VERSION >= MAKE_VERSION(10, 0, 0))
1007
			  SCellToAddMod_r10_t * sCellToAddMod_r10,
1008 1009
			  //struct PhysicalConfigDedicatedSCell_r10 *physicalConfigDedicatedSCell_r10,
#endif
1010 1011
			  MeasObjectToAddMod_t ** measObj,
			  MAC_MainConfig_t * mac_MainConfig,
1012
			  long logicalChannelIdentity,
1013 1014 1015 1016 1017 1018 1019
			  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,
1020
			  long *ul_Bandwidth,
1021 1022 1023 1024
			  AdditionalSpectrumEmission_t *
			  additionalSpectrumEmission,
			  struct MBSFN_SubframeConfigList
			  *mbsfn_SubframeConfigList
1025
#if (RRC_VERSION >= MAKE_VERSION(10, 0, 0))
1026 1027
			  ,
			  uint8_t MBMS_Flag,
1028 1029
			  MBSFN_AreaInfoList_r9_t * mbsfn_AreaInfoList,
			  PMCH_InfoList_r9_t * pmch_InfoList
1030 1031 1032
#endif
#ifdef CBA
			  ,
1033
			  uint8_t num_active_cba_groups, uint16_t cba_rnti
1034
#endif
1035 1036 1037 1038
#if (RRC_VERSION >= MAKE_VERSION(14, 0, 0))
			  ,config_action_t config_action
			  ,const uint32_t * const sourceL2Id
			  ,const uint32_t * const destinationL2Id
1039 1040 1041
#endif
			  );

1042

1043
uint16_t getRIV(uint16_t N_RB_DL, uint16_t RBstart, uint16_t Lcrbs);
1044

1045
int get_subbandsize(uint8_t dl_bandwidth);
1046

1047

1048
void get_Msg3allocret(COMMON_channels_t * cc,
1049 1050
		      sub_frame_t current_subframe,
		      frame_t current_frame,
1051
		      frame_t * frame, sub_frame_t * subframe);
1052

1053
void get_Msg3alloc(COMMON_channels_t * cc,
1054 1055
		   sub_frame_t current_subframe,
		   frame_t current_frame,
1056
		   frame_t * frame, sub_frame_t * subframe);
1057

1058 1059
uint16_t mac_computeRIV(uint16_t N_RB_DL, uint16_t RBstart,
			uint16_t Lcrbs);
1060

1061
int get_phich_resource_times6(COMMON_channels_t * cc);
1062

1063 1064 1065 1066 1067 1068
uint8_t frame_subframe2_dl_harq_pid(TDD_Config_t *tdd_Config, int abs_frameP, sub_frame_t subframeP);

uint8_t ul_subframe2_k_phich(COMMON_channels_t * cc, sub_frame_t ul_subframe);

unsigned char ul_ACK_subframe2M(TDD_Config_t *tdd_Config,unsigned char subframe);

1069 1070 1071 1072
int to_rbg(int dl_Bandwidth);

int to_prb(int dl_Bandwidth);

1073 1074
uint8_t get_Msg3harqpid(COMMON_channels_t * cc,
			frame_t frame, sub_frame_t current_subframe);
1075

1076 1077
uint32_t pdcchalloc2ulframe(COMMON_channels_t * ccP, uint32_t frame,
			    uint8_t n);
1078

1079
uint8_t pdcchalloc2ulsubframe(COMMON_channels_t * ccP, uint8_t n);
1080

1081
int is_UL_sf(COMMON_channels_t * ccP, sub_frame_t subframeP);
1082

1083
uint8_t getQm(uint8_t mcs);
1084

1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113
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,
1114
			   int16_t pdu_index, uint8_t * pdu);
1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136

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);
1137

1138
#if (RRC_VERSION >= MAKE_VERSION(14, 0, 0))
1139 1140 1141 1142
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,
1143
					  uint16_t repetition_number,
1144 1145
					  uint16_t
					  initial_transmission_sf_io);
1146 1147
#endif

1148 1149 1150
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);
1151

1152 1153
void fill_nfapi_dlsch_config(eNB_MAC_INST * eNB,
			     nfapi_dl_config_request_body_t * dl_req,
1154
			     uint16_t length, int16_t pdu_index,
1155 1156
			     uint16_t rnti,
			     uint8_t resource_allocation_type,
1157 1158
			     uint8_t
			     virtual_resource_block_assignment_flag,
1159 1160 1161 1162 1163 1164 1165 1166
			     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,
1167
			     //                      uint8_t codebook_index,
1168 1169 1170 1171 1172 1173 1174
			     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,
1175
			     uint8_t num_bf_vector);
1176 1177 1178 1179 1180

void fill_nfapi_harq_information(module_id_t module_idP,
				 int CC_idP,
				 uint16_t rntiP,
				 uint16_t absSFP,
1181 1182
				 nfapi_ul_config_harq_information *
				 harq_information, uint8_t cce_idxP);
1183 1184 1185 1186

void fill_nfapi_ulsch_harq_information(module_id_t module_idP,
				       int CC_idP,
				       uint16_t rntiP,
1187
				       nfapi_ul_config_ulsch_harq_information
1188 1189
				       * harq_information,
				       sub_frame_t subframeP);
1190 1191 1192 1193

uint16_t fill_nfapi_uci_acknak(module_id_t module_idP,
			       int CC_idP,
			       uint16_t rntiP,
1194
			       uint16_t absSFP, uint8_t cce_idxP);
1195

1196
void fill_nfapi_dl_dci_1A(nfapi_dl_config_request_pdu_t * dl_config_pdu,
1197 1198 1199 1200 1201 1202 1203
			  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,
1204
			  uint8_t ndi, uint8_t rv, uint8_t vrb_flag);
1205

1206 1207 1208
nfapi_ul_config_request_pdu_t *has_ul_grant(module_id_t module_idP,
					    int CC_idP, uint16_t subframeP,
					    uint16_t rnti);
1209

1210
uint8_t get_tmode(module_id_t module_idP, int CC_idP, int UE_idP);
1211

1212 1213
uint8_t get_ul_req_index(module_id_t module_idP, int CC_idP,
			 sub_frame_t subframeP);
1214

1215
#if (RRC_VERSION >= MAKE_VERSION(14, 0, 0))
1216 1217
int get_numnarrowbandbits(long dl_Bandwidth);

1218 1219 1220
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);
1221 1222

int get_numnarrowbands(long dl_Bandwidth);
1223

1224
int narrowband_to_first_rb(COMMON_channels_t * cc, int nb_index);
1225

1226 1227
#endif

1228 1229
int l2_init_eNB(void);

1230 1231 1232 1233 1234
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
1235
int32_t get_uldl_offset(int eutra_bandP);
1236 1237
int l2_init_ue(int eMBMS_active, char *uecap_xer, uint8_t cba_group_active,
	       uint8_t HO_active);
1238 1239 1240 1241 1242 1243 1244
#if defined(PRE_SCD_THREAD)
void pre_scd_nb_rbs_required(    module_id_t     module_idP,
                                 frame_t         frameP,
                                 sub_frame_t     subframeP,
                                 int             min_rb_unit[MAX_NUM_CCs],
                                 uint16_t        nb_rbs_required[MAX_NUM_CCs][NUMBER_OF_UE_MAX]);
#endif
1245

1246 1247
/*Slice related functions */
uint16_t flexran_nb_rbs_allowed_slice(float rb_percentage, int total_rbs);
1248

1249
int ue_slice_membership(int UE_id, int slice_id);
1250

1251 1252
/* from here: prototypes to get rid of compilation warnings: doc to be written by function author */
uint8_t ul_subframe2_k_phich(COMMON_channels_t * cc, sub_frame_t ul_subframe);
1253
#endif
1254
/** @}*/