mac_proto.h 57.1 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 43 44 45
/** \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

*/
46

47 48
void schedule_mib(module_id_t module_idP,
		  frame_t frameP, sub_frame_t subframeP);
49 50

/** \fn void schedule_RA(module_id_t module_idP,frame_t frameP,sub_frame_t subframe);
51
\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)
52 53 54 55 56
for the message.
@param Mod_id Instance ID of eNB
@param frame Frame index
@param subframe Subframe number on which to act
*/
57 58


59 60
void schedule_RA(module_id_t module_idP, frame_t frameP,
		 sub_frame_t subframe);
61 62 63 64 65 66

/** \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
*/
67 68
void schedule_SI(module_id_t module_idP, frame_t frameP,
		 sub_frame_t subframeP);
69

70 71 72 73 74 75 76 77 78 79 80
#if (LTE_RRC_VERSION >= MAKE_VERSION(14, 0, 0))
/** \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
*/
void schedule_SI_MBMS(module_id_t module_idP, frame_t frameP,
                sub_frame_t subframeP);
#endif


81 82 83 84 85
/** \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
*/
86 87
int schedule_MBMS(module_id_t module_idP, uint8_t CC_id, frame_t frameP,
		  sub_frame_t subframe);
88

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


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

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

/** \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
*/
121 122
void schedule_ulsch(module_id_t module_idP, frame_t frameP,
		    sub_frame_t subframe);
123

124
/** \brief ULSCH Scheduling per RNTI
125
@param Mod_id Instance ID of eNB
126
@param slice_idx Slice instance index for this eNB
127 128 129 130
@param frame Frame index
@param subframe Subframe number on which to act
@param sched_subframe Subframe number where PUSCH is transmitted (for DAI lookup)
*/
131
void schedule_ulsch_rnti(module_id_t module_idP, int slice_idx, frame_t frameP,
132 133 134
			 sub_frame_t subframe,
			 unsigned char sched_subframe,
			 uint16_t * first_rb);
135

136 137 138 139 140 141
void schedule_ulsch_rnti_emtc(module_id_t   module_idP,
			      frame_t       frameP,
			      sub_frame_t   subframeP,
			      unsigned char sched_subframeP,
			      int          *emtc_active);

142
/** \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.
143 144 145 146 147
@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
*/
148
void fill_DLSCH_dci(module_id_t module_idP,frame_t frameP,sub_frame_t subframe,int *mbsfn_flag);
149

150
/** \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
151 152 153
@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
154

155 156
@param mbsfn_flag  Indicates that MCH/MCCH is in this subframe
*/
157
void schedule_dlsch(module_id_t module_idP, frame_t frameP,
158
		      sub_frame_t subframe, int *mbsfn_flag);
159

160
void schedule_ue_spec(module_id_t module_idP, int slice_idxP,
161
		      frame_t frameP,sub_frame_t subframe, int *mbsfn_flag);
162 163 164
void schedule_ue_spec_br(module_id_t   module_idP,
			 frame_t       frameP,
			 sub_frame_t   subframeP);
165
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
166
void schedule_ulsch_phy_test(module_id_t module_idP,frame_t frameP,sub_frame_t subframeP);
167

168

169 170 171 172
/** \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
*/
173
int8_t get_Po_NOMINAL_PUSCH(module_id_t module_idP, uint8_t CC_id);
174

175
/** \brief Function to compute DELTA_PREAMBLE from 36.321 (for RA power ramping procedure and Msg3 PUSCH power control policy)
176 177 178
    @param Mod_id Module id of UE
    @returns DELTA_PREAMBLE
*/
179
int8_t get_DELTA_PREAMBLE(module_id_t module_idP, int CC_id);
180

181
/** \brief Function for compute deltaP_rampup from 36.321 (for RA power ramping procedure and Msg3 PUSCH power control policy)
182
    @param Mod_id Module id of UE
183
    @param CC_id carrier component id of UE
184 185
    @returns deltaP_rampup
*/
186
int8_t get_deltaP_rampup(module_id_t module_idP, uint8_t CC_id);
187

188 189
uint16_t mac_computeRIV(uint16_t N_RB_DL, uint16_t RBstart,
			uint16_t Lcrbs);
190

191 192
void add_msg3(module_id_t module_idP, int CC_id, RA_t * ra, frame_t frameP,
	      sub_frame_t subframeP);
193

194
//main.c
195

196 197 198 199
void init_UE_list(UE_list_t *UE_list);

void init_slice_info(slice_info_t *sli);

200 201
int mac_top_init(int eMBMS_active, char *uecap_xer,
		 uint8_t cba_group_active, uint8_t HO_active);
202

Raymond Knopp's avatar
Raymond Knopp committed
203 204
void mac_top_init_eNB(void);

205
void mac_init_cell_params(int Mod_idP, int CC_idP);
206

207 208 209 210 211 212 213 214 215 216
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);

217 218 219 220 221 222
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);

223 224 225 226

// 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
227
@param slice_idxP Slice instance index for the slice in which scheduling happens
228 229 230 231 232 233
@param frame Index of frame
@param subframe Index of current subframe
@param N_RBS Number of resource block groups
 */


234
void dlsch_scheduler_pre_processor(module_id_t module_idP,
235
                                   int slice_idxP,
236 237
                                   frame_t frameP,
                                   sub_frame_t subframe,
238 239
                                   int *mbsfn_flag,
                                   uint8_t rballoc_sub[NFAPI_CC_MAX][N_RBG_MAX]);
240 241

void dlsch_scheduler_pre_processor_reset(module_id_t module_idP,
242
                                         int slice_idx,
243 244 245 246
                                         frame_t frameP,
                                         sub_frame_t subframeP,
                                         int min_rb_unit[NFAPI_CC_MAX],
                                         uint16_t nb_rbs_required[NFAPI_CC_MAX][MAX_MOBILES_PER_ENB],
247 248
                                         uint8_t rballoc_sub[NFAPI_CC_MAX][N_RBG_MAX],
                                         uint8_t MIMO_mode_indicator[NFAPI_CC_MAX][N_RBG_MAX],
249 250
                                         int *mbsfn_flag);

251
void dlsch_scheduler_pre_processor_partitioning(module_id_t Mod_id,
252
                                                int slice_idx,
253 254
                                                const uint8_t rbs_retx[NFAPI_CC_MAX]);

255
void dlsch_scheduler_pre_processor_accounting(module_id_t Mod_id,
256
                                              int slice_idx,
257 258 259 260
                                              frame_t frameP,
                                              sub_frame_t subframeP,
                                              int min_rb_unit[NFAPI_CC_MAX],
                                              uint16_t nb_rbs_required[NFAPI_CC_MAX][MAX_MOBILES_PER_ENB],
261
                                              uint16_t nb_rbs_accounted[NFAPI_CC_MAX][MAX_MOBILES_PER_ENB]);
262 263

void dlsch_scheduler_pre_processor_positioning(module_id_t Mod_id,
264
                                               int slice_idx,
265 266
                                               int min_rb_unit[NFAPI_CC_MAX],
                                               uint16_t nb_rbs_required[NFAPI_CC_MAX][MAX_MOBILES_PER_ENB],
267
                                               uint16_t nb_rbs_accounted[NFAPI_CC_MAX][MAX_MOBILES_PER_ENB],
268
                                               uint16_t nb_rbs_remaining[NFAPI_CC_MAX][MAX_MOBILES_PER_ENB],
269 270
                                               uint8_t rballoc_sub[NFAPI_CC_MAX][N_RBG_MAX],
                                               uint8_t MIMO_mode_indicator[NFAPI_CC_MAX][N_RBG_MAX]);
271

272
void dlsch_scheduler_pre_processor_intraslice_sharing(module_id_t Mod_id,
273
                                                      int slice_idx,
274 275 276 277 278 279 280
                                                      int min_rb_unit[NFAPI_CC_MAX],
                                                      uint16_t nb_rbs_required[NFAPI_CC_MAX][MAX_MOBILES_PER_ENB],
                                                      uint16_t nb_rbs_accounted[NFAPI_CC_MAX][MAX_MOBILES_PER_ENB],
                                                      uint16_t nb_rbs_remaining[NFAPI_CC_MAX][MAX_MOBILES_PER_ENB],
                                                      uint8_t rballoc_sub[NFAPI_CC_MAX][N_RBG_MAX],
                                                      uint8_t MIMO_mode_indicator[NFAPI_CC_MAX][N_RBG_MAX]);

281
void slice_priority_sort(module_id_t Mod_id, int slice_list[MAX_NUM_SLICES]);
282

283 284
void dlsch_scheduler_interslice_multiplexing(module_id_t Mod_id,
                                             int frameP,
285 286
                                             sub_frame_t subframeP,
                                             uint8_t rballoc_sub[NFAPI_CC_MAX][N_RBG_MAX]);
287

288 289 290
void dlsch_scheduler_qos_multiplexing(module_id_t Mod_id,
                                      int frameP,
                                      sub_frame_t subframeP);
291 292

void dlsch_scheduler_pre_processor_allocate(module_id_t Mod_id,
293 294 295 296 297 298
                                            int UE_id,
                                            uint8_t CC_id,
                                            int N_RBG,
                                            int min_rb_unit,
                                            uint16_t nb_rbs_required[NFAPI_CC_MAX][MAX_MOBILES_PER_ENB],
                                            uint16_t nb_rbs_remaining[NFAPI_CC_MAX][MAX_MOBILES_PER_ENB],
299
                                            uint8_t rballoc_sub[NFAPI_CC_MAX][N_RBG_MAX],
300
                                            uint8_t slice_allocation_mask[NFAPI_CC_MAX][N_RBG_MAX],
301
                                            uint8_t MIMO_mode_indicator[NFAPI_CC_MAX][N_RBG_MAX]);
302 303

/* \brief Function to trigger the eNB scheduling procedure.  It is called by PHY at the beginning of each subframe, \f$n$\f
304
   and generates all DLSCH allocations for subframe \f$n\f$ and ULSCH allocations for subframe \f$n+k$\f. 
305 306 307 308
@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.
*/
309
void eNB_dlsch_ulsch_scheduler(module_id_t module_idP, frame_t frameP, sub_frame_t subframeP);	//, int calibration_flag);
310 311 312 313

/* \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
314
@param timing_offset Offset in samples of the received PRACH w.r.t. eNB timing. This is used to
315 316 317
@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)
*/
318 319 320
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
321
#if (LTE_RRC_VERSION >= MAKE_VERSION(14, 0, 0))
322
		      , uint8_t rach_resource_type
323
#endif
324
    );
325 326 327 328 329 330 331

/* \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
*/
332 333 334 335 336 337 338
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);
339

340
#if (LTE_RRC_VERSION >= MAKE_VERSION(14, 0, 0))
341
unsigned short fill_rar_br(eNB_MAC_INST * eNB,
342
			   int CC_id,
343 344 345 346 347
			   RA_t * ra,
			   const frame_t frameP,
			   const sub_frame_t subframeP,
			   uint8_t * const dlsch_buffer,
			   const uint8_t ce_level);
348 349
#endif

350 351 352 353
/* \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.
*/
354 355
void cancel_ra_proc(module_id_t module_idP, int CC_id, frame_t frameP,
		    uint16_t preamble_index);
356

357 358 359 360 361 362 363 364 365 366 367
/* \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
*/
368 369 370

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

371
void set_msg3_subframe(module_id_t Mod_id,
372 373 374 375
		       int CC_id,
		       int frame,
		       int subframe,
		       int rnti, int Msg3_frame, int Msg3_subframe);
376

377 378
/* \brief Function to indicate a received SDU on ULSCH.
@param Mod_id Instance ID of eNB
379 380
@param CC_id Component carrier index
@param rnti RNTI of UE transmitting the SDU
381
@param sdu Pointer to received SDU
382 383 384
@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)
385
*/
386
void rx_sdu(const module_id_t enb_mod_idP,
387 388
	    const int CC_idP,
	    const frame_t frameP,
389
	    const sub_frame_t subframeP,
390 391 392 393
	    const rnti_t rntiP,
	    uint8_t * sduP,
	    const uint16_t sdu_lenP,
	    const uint16_t timing_advance, const uint8_t ul_cqi);
394

395 396

/* \brief Function to indicate a scheduled schduling request (SR) was received by eNB.
397 398 399 400
@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
401
@param rnti RNTI of UE transmitting the SR
402
@param ul_cqi SNR measurement of PUCCH (SNR quantized to 8 bits, -64 ... 63.5 dB in .5dB steps)
403
*/
404 405
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);
406

407 408 409 410 411 412 413
/* \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
*/
414 415
void UL_failure_indication(module_id_t Mod_id, int CC_id, frame_t frameP,
			   rnti_t rnti, sub_frame_t subframe);
416

Raymond Knopp's avatar
Raymond Knopp committed
417 418 419 420 421 422 423
/* \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
*/
424 425 426
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
427 428 429 430 431 432 433 434 435

/* \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
*/
436 437 438 439
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
440

441 442
uint8_t *get_dlsch_sdu(module_id_t module_idP, int CC_id, frame_t frameP,
		       rnti_t rnti, uint8_t TBindex);
443 444 445 446 447

/* \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
448
@param mcs Pointer to mcs used by PHY (to be filled by MAC)
449 450
@returns Pointer to MCH transport block and mcs for subframe
*/
451 452
MCH_PDU *get_mch_sdu(module_id_t Mod_id, int CC_id, frame_t frame,
		     sub_frame_t subframe);
453 454


455

456 457


458 459 460 461 462 463
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,
Stefan's avatar
Stefan committed
464
		                   sub_frame_t subframe, UE_DLSCH_STATUS status, rnti_t rnti);
465 466 467 468 469 470 471
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);
472 473 474

int8_t find_active_UEs_with_traffic(module_id_t module_idP);

Stefan's avatar
Stefan committed
475
void init_CCE_table(int *CCE_table);
476 477

int get_nCCE_offset(int *CCE_table,
478 479 480 481
		    const unsigned char L,
		    const int nCCE,
		    const int common_dci,
		    const unsigned short rnti,
482 483
		    const unsigned char subframe);

Xu Bo's avatar
Xu Bo committed
484
int allocate_CCEs(int module_idP, int CC_idP, frame_t frameP, sub_frame_t subframeP, int test_only);
485 486

boolean_t CCE_allocation_infeasible(int module_idP,
487 488 489 490 491 492 493 494 495
				    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);

496
uint8_t frame_subframe2_dl_harq_pid(LTE_TDD_Config_t *tdd_Config, int abs_frameP, sub_frame_t subframeP);
497 498 499 500 501 502 503 504
/** \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);

505 506 507 508
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);
509 510 511 512 513
/** \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
*/
514 515
module_id_t schedule_next_ulue(module_id_t module_idP, int UE_id,
			       sub_frame_t subframe);
516 517 518 519 520 521

/** \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
*/
522 523
int schedule_next_dlue(module_id_t module_idP, int CC_id,
		       sub_frame_t subframe);
524 525 526 527

/* \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
528
@param N_RB_DL Number of PRBs on DL
529 530 531
@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).
*/
532 533
uint32_t allocate_prbs(int UE_id, uint8_t nb_rb, int N_RB_DL,
		       uint32_t * rballoc);
534 535

/* \fn uint32_t req_new_ulsch(module_id_t module_idP)
536
\brief check for a new transmission in any drb
537 538 539 540 541 542 543
@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
544
@param CC_id Component Carrier index
545 546 547 548 549
@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
*/
550 551
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);
552

553
uint8_t get_ue_weight(module_id_t module_idP, int CC_id, int UE_id);
554 555

// UE functions
556 557
void mac_out_of_sync_ind(module_id_t module_idP, frame_t frameP,
			 uint16_t CH_index);
558

559 560
void ue_decode_si(module_id_t module_idP, int CC_id, frame_t frame,
		  uint8_t CH_index, void *pdu, uint16_t len);
561

562 563 564 565 566
#if (LTE_RRC_VERSION >= MAKE_VERSION(14, 0, 0))
void ue_decode_si_mbms(module_id_t module_idP, int CC_id, frame_t frame,
                 uint8_t CH_index, void *pdu, uint16_t len);
#endif

567 568
void ue_decode_p(module_id_t module_idP, int CC_id, frame_t frame,
		 uint8_t CH_index, void *pdu, uint16_t len);
569

570

571 572 573
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);
574

575 576 577 578 579 580 581 582 583
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
		    );
584

585
#if (LTE_RRC_VERSION >= MAKE_VERSION(10, 0, 0))
586 587 588 589 590 591 592 593
/* \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
*/
594 595 596
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);
597 598 599 600 601 602 603 604 605

/*\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
*/
606
int ue_query_mch(module_id_t Mod_id, uint8_t CC_id, uint32_t frame,
607 608
		 sub_frame_t subframe, uint8_t eNB_index,
		 uint8_t * sync_area, uint8_t * mcch_active);
609 610 611

#endif

612
/* \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.
613 614 615 616 617
@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
*/
618 619 620 621
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);
622

623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646
/* \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);

647 648
/* \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
649
@param Mod_id Component Carrier Index
650 651 652
@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 */
653 654 655
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);
656 657 658

/* \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
659 660 661
@param CC_id Index to a component carrier
@param frame Frame index
@param ra_rnti RA_RNTI value
662 663
@param dlsch_buffer  Pointer to dlsch_buffer containing RAR PDU
@param t_crnti Pointer to PHY variable containing the T_CRNTI
664
@param preamble_index Preamble Index used by PHY to transmit the PRACH.  This should match the received RAR to trigger the rest of
665
random-access procedure
666
@param selected_rar_buffer the output buffer for storing the selected RAR header and RAR payload
667 668
@returns timing advance or 0xffff if preamble doesn't match
*/
669
uint16_t
670 671 672 673 674 675 676 677
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);
678 679 680


/* \brief Generate header for UL-SCH.  This function parses the desired control elements and sdus and generates the header as described
681
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
682 683 684 685 686 687 688 689 690 691 692 693 694 695
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
*/
696 697 698 699 700 701 702 703 704 705 706
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);
707 708

/* \brief Parse header for UL-SCH.  This function parses the received UL-SCH header as described
709
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
710 711 712 713 714 715 716 717 718
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
*/
719 720 721 722 723 724
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);
725

726 727
int to_prb(int);
int to_rbg(int);
728
int mac_init(void);
729
int add_new_ue(module_id_t Mod_id, int CC_id, rnti_t rnti, int harq_pid
730
#if (LTE_RRC_VERSION >= MAKE_VERSION(14, 0, 0))
731 732 733
	       , uint8_t rach_resource_type
#endif
    );
734
int rrc_mac_remove_ue(module_id_t Mod_id, rnti_t rntiP);
735

736 737
void store_dlsch_buffer(module_id_t Mod_id, int slice_idx, frame_t frameP, sub_frame_t subframeP);
void assign_rbs_required(module_id_t Mod_id, int slice_idx, 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]);
738

739 740 741 742 743
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);
744 745
rnti_t UE_RNTI(module_id_t mod_idP, int ue_idP);

Xu Bo's avatar
Xu Bo committed
746
uint8_t find_rb_table_index(uint8_t average_rbs);
747

748 749 750 751 752
void set_ul_DAI(int module_idP,
                int UE_idP,
                int CC_idP,
                int frameP,
                int subframeP);
753

754
void ulsch_scheduler_pre_processor(module_id_t module_idP, int slice_idx, int frameP,
755
				   sub_frame_t subframeP,
Cedric Roux's avatar
Cedric Roux committed
756
                                   int sched_frameP,
757
                                   unsigned char sched_subframeP,
758 759 760
				   uint16_t * first_rb);
void store_ulsch_buffer(module_id_t module_idP, int frameP,
			sub_frame_t subframeP);
761
void assign_max_mcs_min_rb(module_id_t module_idP, int slice_idx, int frameP,
762 763 764
			   sub_frame_t subframeP, uint16_t * first_rb);
void adjust_bsr_info(int buffer_occupancy, uint16_t TBS,
		     UE_TEMPLATE * UE_template);
765

766
int phy_stats_exist(module_id_t Mod_id, int rnti);
767
void sort_UEs(module_id_t Mod_idP, int slice_idx, int frameP, sub_frame_t subframeP);
768

769
/*! \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)
770
   \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.
771
\param[in] module_idP instance of the UE
772 773 774 775
\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
776 777 778 779
\param[in] direction  subframe direction
\param[in] eNB_index  instance of eNB
@returns L2 state (CONNETION_OK or CONNECTION_LOST or PHY_RESYNCH)
*/
780 781 782 783 784 785 786
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);
787

788
/*! \fn  int cba_access(module_id_t module_idP,frame_t frameP,sub_frame_t subframe, uint8_t eNB_index,uint16_t buflen);
789 790 791 792 793
\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
794
\param[out] access(1) or postpone (0)
795
*/
796 797
int cba_access(module_id_t module_idP, frame_t frameP,
	       sub_frame_t subframe, uint8_t eNB_index, uint16_t buflen);
798 799 800 801 802 803 804 805 806 807 808 809 810 811 812

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

815
/*! \fn  boolean_t update_bsr(module_id_t module_idP, frame_t frameP,sub_frame_t subframeP)
816
   \brief get the rlc stats and update the bsr level for each lcid
817 818 819
\param[in] Mod_id instance of the UE
\param[in] frame Frame index
*/
820 821
boolean_t update_bsr(module_id_t module_idP, frame_t frameP,
		     sub_frame_t subframeP, eNB_index_t eNB_index);
822

fnabet's avatar
fnabet committed
823
/*! \fn  locate_BsrIndexByBufferSize (int *table, int size, int value)
824
   \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.
825 826
\param[in] *table Pointer to BSR table
\param[in] size Size of the table
827
\param[in] value Value of the buffer
828 829
\return the index in the BSR_LEVEL table
*/
830 831
uint8_t locate_BsrIndexByBufferSize(const uint32_t * table, int size,
				    int value);
832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875


/*! \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
876
/*! \fn  uint8_t get_phr_mapping (module_id_t module_idP, int CC_id,uint8_t eNB_index)
877 878
   \brief get phr mapping as described in 36.313
\param[in]  Mod_id index of eNB
Raymond Knopp's avatar
 
Raymond Knopp committed
879
\param[in] CC_id Component Carrier Index
880 881
\return phr mapping
*/
882 883
uint8_t get_phr_mapping(module_id_t module_idP, int CC_id,
			uint8_t eNB_index);
884 885 886 887

/*! \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
888
\param[in] CC_id Component carrier index
889 890
\return void
*/
891
void update_phr(module_id_t module_idP, int CC_id);
892 893 894 895 896

/*! \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
*/
897 898
void Msg3_tx(module_id_t module_idP, uint8_t CC_id, frame_t frameP,
	     uint8_t eNB_id);
899 900 901 902 903 904 905


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

906 907
void Msg1_tx(module_id_t module_idP, uint8_t CC_id, frame_t frameP,
	     uint8_t eNB_id);
908

909 910 911
void dl_phy_sync_success(module_id_t module_idP,
			 frame_t frameP,
			 unsigned char eNB_index, uint8_t first_sync);
912 913 914 915 916

int dump_eNB_l2_stats(char *buffer, int length);

double uniform_rngen(int min, int max);

917
/*
918
void add_common_dci(DCI_PDU *DCI_pdu,
919 920 921 922 923 924 925
                    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);
926
*/
927

928 929
uint32_t allocate_prbs_sub(int nb_rb, int N_RB_DL, int N_RBG,
			   uint8_t * rballoc);
930

931
void update_ul_dci(module_id_t module_idP, uint8_t CC_id, rnti_t rnti,
932
		   uint8_t dai, sub_frame_t subframe);
933

934 935
int get_bw_index(module_id_t module_id, uint8_t CC_id);

936 937
int get_min_rb_unit(module_id_t module_idP, uint8_t CC_id);

938
/* \brief Generate header for DL-SCH.  This function parses the desired control elements and sdus and generates the header as described
939
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
940 941 942 943 944
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)
945
@param drx_cmd dicontinous reception command
946 947 948
@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)
949
@param post_padding number of bytes for padding at the end of MAC PDU
950 951
@returns Number of bytes used for header
*/
952 953 954 955 956 957 958 959 960
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);
961

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

967
@param radioResourceConfigCommon Structure from SIB2 for common radio parameters (if NULL keep existing configuration)
968
@param physicalConfigDedicated Structure from RRCConnectionSetup or RRCConnectionReconfiguration for dedicated PHY parameters (if NULL keep existing configuration)
969 970
@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)
971
@param logicalChannelIdentity Logical channel identity index of corresponding logical channel config
972 973 974 975
@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
976
@param SchedInfoList SI Scheduling information
977 978 979 980
@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)
981
@param sib1_ext_r13 SI Scheduling information for SI-BR UEs         
982 983 984 985 986 987
@param mib_fembms pointer to FeMBMS MIB
@param FeMBMS_Flag indicates FeMBMS transmission
@param schedulingInfo_fembms pointer to FeMBMS SI Scheduling Information
@param non_MBSFN_SubframeConfig pointer to FeMBMS Non MBSFN Subframe Config 
@param sib1_mbms_r14_fembms pointer SI Scheduling infomration for SI-MBMS
@param mbsfn_AreaInfoList_fembms pointer to FeMBMS MBSFN Area Info list from SIB1-MBMS
988
*/
989

990 991 992 993 994 995
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,
996
#if (LTE_RRC_VERSION >= MAKE_VERSION(14, 0, 0))
997
			   int pbch_repetition,
998
#endif
999
			   rnti_t rntiP,
1000 1001
			   LTE_BCCH_BCH_Message_t * mib,
			   LTE_RadioResourceConfigCommonSIB_t *
1002
			   radioResourceConfigCommon,
1003 1004 1005
#if (LTE_RRC_VERSION >= MAKE_VERSION(14, 0, 0))
			   LTE_RadioResourceConfigCommonSIB_t *
			   LTE_radioResourceConfigCommon_BR,
1006
#endif
1007
			   struct LTE_PhysicalConfigDedicated
1008
			   *physicalConfigDedicated,
1009 1010
#if (LTE_RRC_VERSION >= MAKE_VERSION(10, 0, 0))
			   LTE_SCellToAddMod_r10_t * sCellToAddMod_r10,
1011
			   //struct PhysicalConfigDedicatedSCell_r10 *physicalConfigDedicatedSCell_r10,
1012
#endif
1013 1014
			   LTE_MeasObjectToAddMod_t ** measObj,
			   LTE_MAC_MainConfig_t * mac_MainConfig,
1015
			   long logicalChannelIdentity,
1016 1017 1018 1019 1020
			   LTE_LogicalChannelConfig_t * logicalChannelConfig,
			   LTE_MeasGapConfig_t * measGapConfig,
			   LTE_TDD_Config_t * tdd_Config,
			   LTE_MobilityControlInfo_t * mobilityControlInfo,
			   LTE_SchedulingInfoList_t * schedulingInfoList,
1021 1022
			   uint32_t ul_CarrierFreq,
			   long *ul_Bandwidth,
1023
			   LTE_AdditionalSpectrumEmission_t *
1024
			   additionalSpectrumEmission,
1025
			   struct LTE_MBSFN_SubframeConfigList
1026
			   *mbsfn_SubframeConfigList
1027
#if (LTE_RRC_VERSION >= MAKE_VERSION(9, 0, 0))
1028
			   ,
1029
			   uint8_t MBMS_Flag,
1030 1031
			   LTE_MBSFN_AreaInfoList_r9_t * mbsfn_AreaInfoList,
			   LTE_PMCH_InfoList_r9_t * pmch_InfoList
1032
#endif
1033
#if (LTE_RRC_VERSION >= MAKE_VERSION(13, 0, 0))
1034
			   ,
1035
			   LTE_SystemInformationBlockType1_v1310_IEs_t *
1036
			   sib1_ext_r13
1037 1038 1039 1040 1041 1042 1043 1044 1045
#endif
#if (LTE_RRC_VERSION >= MAKE_VERSION(14, 0, 0))
                           ,
                           uint8_t FeMBMS_Flag,
                           LTE_BCCH_DL_SCH_Message_MBMS_t * mib_fembms,
                           LTE_SchedulingInfo_MBMS_r14_t * schedulingInfo_fembms,
                           struct LTE_NonMBSFN_SubframeConfig_r14 * nonMBSFN_SubframeConfig,
                           LTE_SystemInformationBlockType1_MBMS_r14_t *  sib1_mbms_r14_fembms,
                           LTE_MBSFN_AreaInfoList_r9_t * mbsfn_AreaInfoList_fembms
1046
#endif
1047
    );
1048

1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068
/** \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)
*/
1069 1070 1071
int rrc_mac_config_req_ue(module_id_t module_idP,
			  int CC_id,
			  uint8_t eNB_index,
1072
			  LTE_RadioResourceConfigCommonSIB_t *
1073
			  radioResourceConfigCommon,
1074
			  struct LTE_PhysicalConfigDedicated
1075
			  *physicalConfigDedicated,
1076 1077
#if (LTE_RRC_VERSION >= MAKE_VERSION(10, 0, 0))
			  LTE_SCellToAddMod_r10_t * sCellToAddMod_r10,
1078 1079
			  //struct PhysicalConfigDedicatedSCell_r10 *physicalConfigDedicatedSCell_r10,
#endif
1080 1081
			  LTE_MeasObjectToAddMod_t ** measObj,
			  LTE_MAC_MainConfig_t * mac_MainConfig,
1082
			  long logicalChannelIdentity,
1083 1084 1085 1086
			  LTE_LogicalChannelConfig_t * logicalChannelConfig,
			  LTE_MeasGapConfig_t * measGapConfig,
			  LTE_TDD_Config_t * tdd_Config,
			  LTE_MobilityControlInfo_t * mobilityControlInfo,
1087 1088
			  uint8_t * SIwindowsize,
			  uint16_t * SIperiod,
1089
			  LTE_ARFCN_ValueEUTRA_t * ul_CarrierFreq,
1090
			  long *ul_Bandwidth,
1091
			  LTE_AdditionalSpectrumEmission_t *
1092
			  additionalSpectrumEmission,
1093
			  struct LTE_MBSFN_SubframeConfigList
1094
			  *mbsfn_SubframeConfigList
1095
#if (LTE_RRC_VERSION >= MAKE_VERSION(10, 0, 0))
1096 1097
			  ,
			  uint8_t MBMS_Flag,
1098 1099
			  LTE_MBSFN_AreaInfoList_r9_t * mbsfn_AreaInfoList,
			  LTE_PMCH_InfoList_r9_t * pmch_InfoList
1100 1101 1102
#endif
#ifdef CBA
			  ,
1103
			  uint8_t num_active_cba_groups, uint16_t cba_rnti
1104
#endif
1105
#if (LTE_RRC_VERSION >= MAKE_VERSION(14, 0, 0))
1106 1107 1108
			  ,config_action_t config_action
			  ,const uint32_t * const sourceL2Id
			  ,const uint32_t * const destinationL2Id
1109 1110 1111 1112 1113 1114
#endif
#if (LTE_RRC_VERSION >= MAKE_VERSION(14, 0, 0))
                           ,
                           uint8_t FeMBMS_Flag,
                           struct LTE_NonMBSFN_SubframeConfig_r14 * nonMBSFN_SubframeConfig,
                           LTE_MBSFN_AreaInfoList_r9_t * mbsfn_AreaInfoList_fembms
1115 1116 1117
#endif
			  );

1118

1119
uint16_t getRIV(uint16_t N_RB_DL, uint16_t RBstart, uint16_t Lcrbs);
1120

1121
int get_subbandsize(uint8_t dl_bandwidth);
1122

1123

1124
void get_Msg3allocret(COMMON_channels_t * cc,
1125 1126
		      sub_frame_t current_subframe,
		      frame_t current_frame,
1127
		      frame_t * frame, sub_frame_t * subframe);
1128

1129
void get_Msg3alloc(COMMON_channels_t * cc,
1130 1131
		   sub_frame_t current_subframe,
		   frame_t current_frame,
1132
		   frame_t * frame, sub_frame_t * subframe);
1133

1134 1135
uint16_t mac_computeRIV(uint16_t N_RB_DL, uint16_t RBstart,
			uint16_t Lcrbs);
1136

1137
int get_phich_resource_times6(COMMON_channels_t * cc);
1138

1139
uint8_t frame_subframe2_dl_harq_pid(LTE_TDD_Config_t *tdd_Config, int abs_frameP, sub_frame_t subframeP);
1140 1141 1142

uint8_t ul_subframe2_k_phich(COMMON_channels_t * cc, sub_frame_t ul_subframe);

1143
unsigned char ul_ACK_subframe2M(LTE_TDD_Config_t *tdd_Config,unsigned char subframe);
1144

1145 1146 1147 1148
int to_rbg(int dl_Bandwidth);

int to_prb(int dl_Bandwidth);

1149 1150
uint8_t get_Msg3harqpid(COMMON_channels_t * cc,
			frame_t frame, sub_frame_t current_subframe);
1151

1152 1153
uint32_t pdcchalloc2ulframe(COMMON_channels_t * ccP, uint32_t frame,
			    uint8_t n);
1154

1155
uint8_t pdcchalloc2ulsubframe(COMMON_channels_t * ccP, uint8_t n);
1156

1157
int is_UL_sf(COMMON_channels_t * ccP, sub_frame_t subframeP);
1158

1159
uint8_t getQm(uint8_t mcs);
1160

1161 1162 1163
uint8_t subframe2harqpid(COMMON_channels_t * cc, frame_t frame,
			 sub_frame_t subframe);

Raymond Knopp's avatar
Raymond Knopp committed
1164

1165 1166 1167 1168
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,
1169
		    struct LTE_CQI_ReportPeriodic *cqi_PMI_ConfigIndex,
1170 1171
		    uint16_t * Npd, uint16_t * N_OFFSET_CQI, int *H);

1172
uint8_t get_rel8_dl_cqi_pmi_size(UE_sched_ctrl_t * sched_ctl, int CC_idP,
1173
				 COMMON_channels_t * cc, uint8_t tmode,
1174
				 struct LTE_CQI_ReportPeriodic
1175 1176 1177 1178
				 *cqi_ReportPeriodic);

uint8_t get_dl_cqi_pmi_size_pusch(COMMON_channels_t * cc, uint8_t tmode,
				  uint8_t ri,
1179
				  LTE_CQI_ReportModeAperiodic_t *
1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190
				  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,
1191
			   int16_t pdu_index, uint8_t * pdu);
1192 1193 1194 1195

void fill_nfapi_ulsch_config_request_rel8(nfapi_ul_config_request_pdu_t *
					  ul_config_pdu, uint8_t cqi_req,
					  COMMON_channels_t * cc,
1196
					  struct LTE_PhysicalConfigDedicated
1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213
					  *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);
1214

1215
#if (LTE_RRC_VERSION >= MAKE_VERSION(14, 0, 0))
1216 1217 1218 1219
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,
1220
					  uint16_t repetition_number,
1221 1222
					  uint16_t
					  initial_transmission_sf_io);
1223 1224
#endif

1225 1226 1227
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);
1228

1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239
void
fill_nfapi_mch_config(nfapi_dl_config_request_body_t *dl_req,
                  uint16_t length,
                  uint16_t pdu_index,
                  uint16_t rnti,
                  uint8_t resource_allocation_type,
                  uint16_t resource_block_coding,
                  uint8_t modulation,
                  uint16_t transmission_power,
                  uint8_t mbsfn_area_id);

1240 1241
void fill_nfapi_dlsch_config(eNB_MAC_INST * eNB,
			     nfapi_dl_config_request_body_t * dl_req,
1242
			     uint16_t length, int16_t pdu_index,
1243 1244
			     uint16_t rnti,
			     uint8_t resource_allocation_type,
1245 1246
			     uint8_t
			     virtual_resource_block_assignment_flag,
1247 1248 1249 1250 1251 1252 1253 1254
			     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,
1255
			     //                      uint8_t codebook_index,
1256 1257 1258 1259 1260 1261 1262
			     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,
1263
			     uint8_t num_bf_vector);
1264 1265 1266 1267

void fill_nfapi_harq_information(module_id_t module_idP,
				 int CC_idP,
				 uint16_t rntiP,
1268 1269
				 nfapi_ul_config_harq_information *
				 harq_information, uint8_t cce_idxP);
1270 1271 1272 1273

void fill_nfapi_ulsch_harq_information(module_id_t module_idP,
				       int CC_idP,
				       uint16_t rntiP,
1274
				       nfapi_ul_config_ulsch_harq_information
1275 1276
				       * harq_information,
				       sub_frame_t subframeP);
1277 1278

uint16_t fill_nfapi_uci_acknak(module_id_t module_idP,
1279 1280
							int CC_idP,
							uint16_t rntiP,
1281
							uint16_t absSFP,
1282
							uint8_t cce_idxP);
1283

1284
void fill_nfapi_dl_dci_1A(nfapi_dl_config_request_pdu_t * dl_config_pdu,
1285 1286 1287 1288 1289 1290 1291
			  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,
1292
			  uint8_t ndi, uint8_t rv, uint8_t vrb_flag);
1293

1294 1295 1296
nfapi_ul_config_request_pdu_t *has_ul_grant(module_id_t module_idP,
					    int CC_idP, uint16_t subframeP,
					    uint16_t rnti);
1297

1298
uint8_t get_tmode(module_id_t module_idP, int CC_idP, int UE_idP);
1299

1300 1301
uint8_t get_ul_req_index(module_id_t module_idP, int CC_idP,
			 sub_frame_t subframeP);
1302

1303
#if (LTE_RRC_VERSION >= MAKE_VERSION(14, 0, 0))
1304 1305
int get_numnarrowbandbits(long dl_Bandwidth);

1306 1307 1308
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);
1309 1310

int get_numnarrowbands(long dl_Bandwidth);
1311

1312
int narrowband_to_first_rb(COMMON_channels_t * cc, int nb_index);
1313

1314 1315
#endif

1316 1317
int l2_init_eNB(void);

1318 1319 1320 1321 1322
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
1323
int32_t get_uldl_offset(int eutra_bandP);
1324 1325
int l2_init_ue(int eMBMS_active, char *uecap_xer, uint8_t cba_group_active,
	       uint8_t HO_active);
1326 1327 1328 1329 1330 1331 1332
#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
1333

1334
/* Slice related functions */
1335
uint16_t nb_rbs_allowed_slice(float rb_percentage, int total_rbs);
1336 1337
int ue_dl_slice_membership(module_id_t mod_id, int UE_id, int slice_idx);
int ue_ul_slice_membership(module_id_t mod_id, int UE_id, int slice_idx);
1338

1339
/* DRX Configuration */
1340
/* Configure local DRX timers and thresholds in UE context, following the drx_configuration input */
1341 1342
void eNB_Config_Local_DRX(module_id_t Mod_id, rnti_t rnti, LTE_DRX_Config_t *drx_Configuration);

1343 1344
/* 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);
1345
#endif
1346
/** @}*/