proto.h 44.5 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
/*
 * 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
 * the OAI Public License, Version 1.0  (the "License"); you may not use this file
 * 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
nikaeinn's avatar
nikaeinn committed
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
nikaeinn's avatar
nikaeinn committed
27
 * \version 1.0
28 29 30
 */
#ifndef __LAYER2_MAC_PROTO_H__
#define __LAYER2_MAC_PROTO_H__
31

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

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

38 39 40 41 42 43 44
/** \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

*/
45

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

/** \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 RA_templates and checks if RAR, Msg3 or its retransmission are to be scheduled in the subframe.  It returns the total number of PRB used for RA SDUs.  For Msg3 it retrieves the L3msg from RRC and fills the appropriate buffers.  For the others it just computes the number of PRBs. Each DCI uses 3 PRBs (format 1A)
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


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

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

/** \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
*/
73
int schedule_MBMS(module_id_t module_idP,uint8_t CC_id, frame_t frameP, sub_frame_t subframe);
74 75 76 77

/** \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
78
@param[out] index of sf pattern
79
*/
80
int8_t get_mbsfn_sf_alloction (module_id_t module_idP, uint8_t CC_id, uint8_t mbsfn_sync_area);
81 82 83 84 85

/** \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
86
@param[out] index of sf pattern
87 88 89 90 91 92 93 94
*/
int8_t ue_get_mbsfn_sf_alloction (module_id_t module_idP, uint8_t mbsfn_sync_area, unsigned char eNB_index);

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

97
/** \brief ULSCH Scheduling per RNTI
98 99 100 101 102
@param Mod_id Instance ID of eNB
@param frame Frame index
@param subframe Subframe number on which to act
@param sched_subframe Subframe number where PUSCH is transmitted (for DAI lookup)
*/
103
void schedule_ulsch_rnti(module_id_t module_idP, frame_t frameP, sub_frame_t subframe, unsigned char sched_subframe, uint16_t *first_rb);
104

105
/** \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.
106 107 108 109 110
@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
*/
111
void fill_DLSCH_dci(module_id_t module_idP,frame_t frameP,sub_frame_t subframe,int *mbsfn_flag);
112

113
/** \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
114 115 116
@param Mod_id Instance ID of eNB
@param frame Frame index
@param subframe Subframe on which to act
knopp's avatar
knopp committed
117

118 119
@param mbsfn_flag  Indicates that MCH/MCCH is in this subframe
*/
120
void schedule_ue_spec(module_id_t module_idP,frame_t frameP,sub_frame_t subframe,int *mbsfn_flag);
121

122

123 124 125 126
/** \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
*/
127
int8_t get_Po_NOMINAL_PUSCH(module_id_t module_idP,uint8_t CC_id);
128

129
/** \brief Function to compute DELTA_PREAMBLE from 36.321 (for RA power ramping procedure and Msg3 PUSCH power control policy)
130 131 132
    @param Mod_id Module id of UE
    @returns DELTA_PREAMBLE
*/
knopp's avatar
 
knopp committed
133
int8_t get_DELTA_PREAMBLE(module_id_t module_idP,int CC_id);
134

135
/** \brief Function for compute deltaP_rampup from 36.321 (for RA power ramping procedure and Msg3 PUSCH power control policy)
136
    @param Mod_id Module id of UE
137
    @param CC_id carrier component id of UE
138 139
    @returns deltaP_rampup
*/
140
int8_t get_deltaP_rampup(module_id_t module_idP,uint8_t CC_id);
141

142
uint16_t mac_computeRIV(uint16_t N_RB_DL,uint16_t RBstart,uint16_t Lcrbs);
143

144
//main.c
145

knopp's avatar
 
knopp committed
146
int mac_top_init(int eMBMS_active, char *uecap_xer,uint8_t cba_group_active, uint8_t HO_active);
147 148 149 150 151 152 153 154 155 156 157 158 159

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

void mac_UE_out_of_sync_ind(module_id_t module_idP,frame_t frameP, uint16_t eNB_index);

160
void dlsch_scheduler_pre_processor_reset (int module_idP,int UE_id,
161
    uint8_t  CC_id,
162 163
    int frameP,
    int subframeP,
164 165 166 167 168
    int N_RBG,
    uint16_t nb_rbs_required[MAX_NUM_CCs][NUMBER_OF_UE_MAX],
    uint16_t  nb_rbs_required_remaining[MAX_NUM_CCs][NUMBER_OF_UE_MAX],
    unsigned char rballoc_sub[MAX_NUM_CCs][N_RBG_MAX],
    unsigned char MIMO_mode_indicator[MAX_NUM_CCs][N_RBG_MAX]);
169 170 171 172 173 174 175 176 177 178 179 180 181

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


void dlsch_scheduler_pre_processor (module_id_t module_idP,
                                    frame_t frameP,
                                    sub_frame_t subframe,
182
                                    int N_RBG[MAX_NUM_CCs],
183
                                    int *mbsfn_flag);
184

185 186

void dlsch_scheduler_pre_processor_allocate (module_id_t   Mod_id,
187 188 189 190 191 192 193 194 195 196 197 198
    int           UE_id,
    uint8_t       CC_id,
    int           N_RBG,
    int           transmission_mode,
    int           min_rb_unit,
    uint8_t       N_RB_DL,
    uint16_t      nb_rbs_required[MAX_NUM_CCs][NUMBER_OF_UE_MAX],
    uint16_t      nb_rbs_required_remaining[MAX_NUM_CCs][NUMBER_OF_UE_MAX],
    unsigned char rballoc_sub[MAX_NUM_CCs][N_RBG_MAX],
    unsigned char MIMO_mode_indicator[MAX_NUM_CCs][N_RBG_MAX]);

/* \brief Function to trigger the eNB scheduling procedure.  It is called by PHY at the beginning of each subframe, \f$n$\f
199
   and generates all DLSCH allocations for subframe \f$n\f$ and ULSCH allocations for subframe \f$n+k$\f. 
200 201 202 203
@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.
*/
204
void eNB_dlsch_ulsch_scheduler(module_id_t module_idP, frame_t frameP, sub_frame_t subframeP);//, int calibration_flag);
205 206 207 208

/* \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
209
@param timing_offset Offset in samples of the received PRACH w.r.t. eNB timing. This is used to
210 211 212 213 214 215 216 217 218
@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)
*/
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
#ifdef Rel14
		      ,
		      uint8_t rach_resource_type
#endif
		      );
219 220 221 222 223 224 225

/* \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
*/
226 227 228 229 230 231 232 233
unsigned short fill_rar(
  const module_id_t module_idP,
  const int         CC_id,
  const frame_t     frameP,
  uint8_t   * const dlsch_buffer,
  const uint16_t    N_RB_UL,
  const uint8_t input_buffer_length
);
234

235 236 237 238 239 240 241 242 243 244 245
#ifdef Rel14
unsigned short fill_rar_br(eNB_MAC_INST *eNB,
			   int CC_id,
			   RA_TEMPLATE        *RA_template,      
			   const frame_t      frameP,
			   const sub_frame_t  subframeP,
			   uint8_t*    const  dlsch_buffer,
			   const uint8_t      ce_level
			   );
#endif

246 247 248 249
/* \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.
*/
knopp's avatar
 
knopp committed
250
void cancel_ra_proc(module_id_t module_idP,int CC_id,frame_t frameP, uint16_t preamble_index);
251

252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
/* \brief Function used by PHY to inform MAC that an uplink is scheduled
          for Msg3 in given subframe. This is used so that the MAC
          scheduler marks as busy the RBs used by the Msg3.
@param Mod_id        Instance ID of eNB
@param CC_id         CC ID of eNB
@param frame         current frame
@param subframe      current subframe
@param rnti          UE rnti concerned
@param Msg3_frame    frame where scheduling takes place
@param Msg3_subframe subframe where scheduling takes place
*/
void set_msg3_subframe(module_id_t Mod_id,
                       int CC_id,
                       int frame,
                       int subframe,
                       int rnti,
                       int Msg3_frame,
                       int Msg3_subframe);

271 272
/* \brief Function to indicate a received SDU on ULSCH.
@param Mod_id Instance ID of eNB
273 274
@param CC_id Component carrier index
@param rnti RNTI of UE transmitting the SDU
275
@param sdu Pointer to received SDU
276 277 278
@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)
279
*/
280 281 282 283 284 285 286 287 288 289
void rx_sdu(const module_id_t enb_mod_idP,
	    const int         CC_idP,
	    const frame_t     frameP,
	    const sub_frame_t subframeP,
	    const rnti_t      rntiP,
	    uint8_t          *sduP,
	    const uint16_t    sdu_lenP,
	    const uint16_t    timing_advance,
	    const uint8_t     ul_cqi);

290 291

/* \brief Function to indicate a scheduled schduling request (SR) was received by eNB.
292 293 294 295
@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
296
@param rnti RNTI of UE transmitting the SR
297
@param ul_cqi SNR measurement of PUCCH (SNR quantized to 8 bits, -64 ... 63.5 dB in .5dB steps)
298
*/
299
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);
300

301 302 303 304 305 306 307 308 309
/* \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
*/
void UL_failure_indication(module_id_t Mod_id,int CC_id,frame_t frameP,rnti_t rnti,sub_frame_t subframe);

knopp's avatar
 
knopp committed
310
uint8_t *get_dlsch_sdu(module_id_t module_idP,int CC_id,frame_t frameP,rnti_t rnti,uint8_t TBindex);
311 312 313 314 315

/* \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
316
@param mcs Pointer to mcs used by PHY (to be filled by MAC)
317 318
@returns Pointer to MCH transport block and mcs for subframe
*/
319
MCH_PDU *get_mch_sdu( module_id_t Mod_id, int CC_id, frame_t frame, sub_frame_t subframe);
320 321


322

323 324 325 326 327


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);
knopp's avatar
 
knopp committed
328 329 330
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) ;
331
int         find_RA_id        (module_id_t mod_idP, int CC_idP, rnti_t rntiP);
knopp's avatar
 
knopp committed
332 333 334 335
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);
336
uint8_t     get_aggregation   (uint8_t bw_index, uint8_t cqi, uint8_t dci_fmt);
337 338 339

int8_t find_active_UEs_with_traffic(module_id_t module_idP);

340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360
void init_CCE_table(int module_idP,int CC_idP);

int get_nCCE_offset(int *CCE_table,
		    const unsigned char L, 
		    const int nCCE, 
		    const int common_dci, 
		    const unsigned short rnti, 
		    const unsigned char subframe);

int allocate_CCEs(int module_idP,
		  int CC_idP,
		  int subframe,
		  int test_only);

boolean_t CCE_allocation_infeasible(int module_idP,
				  int CC_idP,
				  int common_flag,
				  int subframe,
				  int aggregation,
				  int rnti);

361
void set_ue_dai(sub_frame_t   subframeP,
362 363
                int           UE_id,
                uint8_t       CC_id,
knopp's avatar
knopp committed
364
                uint8_t       tdd_config,
365
                UE_list_t     *UE_list);
366

367
uint8_t find_num_active_UEs_in_cbagroup(module_id_t module_idP, unsigned char group_id);
knopp's avatar
 
knopp committed
368
uint8_t UE_is_to_be_scheduled(module_id_t module_idP,int CC_id,uint8_t UE_id);
369 370 371 372 373
/** \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
*/
knopp's avatar
 
knopp committed
374
module_id_t schedule_next_ulue(module_id_t module_idP, int UE_id,sub_frame_t subframe);
375 376 377 378 379 380

/** \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
*/
381
int schedule_next_dlue(module_id_t module_idP, int CC_id, sub_frame_t subframe);
382 383 384 385

/* \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
knopp's avatar
knopp committed
386
@param N_RB_DL Number of PRBs on DL
387 388 389
@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).
*/
knopp's avatar
knopp committed
390
uint32_t allocate_prbs(int UE_id,uint8_t nb_rb, int N_RB_DL, uint32_t *rballoc);
391 392

/* \fn uint32_t req_new_ulsch(module_id_t module_idP)
393
\brief check for a new transmission in any drb
394 395 396 397 398 399 400
@param Mod_id Instance id of UE in machine
@returns 1 for new transmission, 0 for none
*/
uint32_t req_new_ulsch(module_id_t module_idP);

/* \brief Get SR payload (0,1) from UE MAC
@param Mod_id Instance id of UE in machine
knopp's avatar
 
knopp committed
401
@param CC_id Component Carrier index
402 403 404 405 406
@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
*/
knopp's avatar
 
knopp committed
407
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);
408

409
uint8_t get_ue_weight(module_id_t module_idP, int CC_id, int UE_id);
410 411 412 413

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

knopp's avatar
 
knopp committed
414
void ue_decode_si(module_id_t module_idP, int CC_id,frame_t frame, uint8_t CH_index, void *pdu, uint16_t len);
415

416 417
void ue_decode_p(module_id_t module_idP, int CC_id,frame_t frame, uint8_t CH_index, void *pdu, uint16_t len);

418

419
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);
420 421


Cedric Roux's avatar
Cedric Roux committed
422
#if defined(Rel10) || defined(Rel14)
423 424 425 426 427 428 429 430
/* \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
*/
431
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) ;
432 433 434 435 436 437 438 439 440

/*\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
*/
441
int ue_query_mch(uint8_t Mod_id,uint8_t CC_id, uint32_t frame,sub_frame_t subframe, uint8_t eNB_index, uint8_t *sync_area, uint8_t *mcch_active);
442 443 444

#endif

445
/* \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.
446 447 448 449 450 451
@param Mod_id Instance id of UE in machine
@param eNB_id Index of eNB that UE is attached to
@param rnti C_RNTI of UE
@param subframe subframe number
@returns 0 for no SR, 1 for SR
*/
knopp's avatar
 
knopp committed
452
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);
453 454 455

/* \brief Function called by PHY to retrieve information to be transmitted using the RA procedure.  If the UE is not in PUSCH mode for a particular eNB index, this is assumed to be an Msg3 and MAC attempts to retrieves the CCCH message from RRC. If the UE is in PUSCH mode for a particular eNB index and PUCCH format 0 (Scheduling Request) is not activated, the MAC may use this resource for random-access to transmit a BSR along with the C-RNTI control element (see 5.1.4 from 36.321)
@param Mod_id Index of UE instance
knopp's avatar
 
knopp committed
456
@param Mod_id Component Carrier Index
457 458 459
@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 */
knopp's avatar
 
knopp committed
460
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);
461 462 463

/* \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
464 465 466
@param CC_id Index to a component carrier
@param frame Frame index
@param ra_rnti RA_RNTI value
467 468
@param dlsch_buffer  Pointer to dlsch_buffer containing RAR PDU
@param t_crnti Pointer to PHY variable containing the T_CRNTI
469
@param preamble_index Preamble Index used by PHY to transmit the PRACH.  This should match the received RAR to trigger the rest of
470
random-access procedure
471
@param selected_rar_buffer the output buffer for storing the selected RAR header and RAR payload
472 473
@returns timing advance or 0xffff if preamble doesn't match
*/
474 475 476 477 478
uint16_t
ue_process_rar(
  const module_id_t module_idP,
  const int CC_id,
  const frame_t frameP,
479
  const rnti_t ra_rnti,
480 481
  uint8_t * const dlsch_buffer,
  rnti_t * const t_crnti,
482 483
  const uint8_t preamble_index,
  uint8_t* selected_rar_buffer
484
);
485 486 487


/* \brief Generate header for UL-SCH.  This function parses the desired control elements and sdus and generates the header as described
488
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
489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515
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
*/
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);

/* \brief Parse header for UL-SCH.  This function parses the received UL-SCH header as described
516
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
517 518 519 520 521 522 523 524 525 526
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
*/
uint8_t *parse_ulsch_header(uint8_t *mac_header,
527 528 529 530 531 532
                            uint8_t *num_ce,
                            uint8_t *num_sdu,
                            uint8_t *rx_ces,
                            uint8_t *rx_lcids,
                            uint16_t *rx_lengths,
                            uint16_t tx_lenght);
533

knopp's avatar
knopp committed
534 535
int to_prb(int);
int to_rbg(int);
knopp's avatar
 
knopp committed
536
int l2_init(LTE_DL_FRAME_PARMS *frame_parms,int eMBMS_active, char *uecap_xer, uint8_t cba_group_active, uint8_t HO_active);
537
int mac_init(void);
538 539 540 541 542
int add_new_ue(module_id_t Mod_id, int CC_id, rnti_t rnti,int harq_pid
               #ifdef Rel14
                 ,uint8_t rach_resource_type
               #endif
               );
543
int rrc_mac_remove_ue(module_id_t Mod_id, rnti_t rntiP);
544

545 546 547 548 549

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);
550 551 552 553
int UE_num_active_CC(UE_list_t *listP,int ue_idP);
int UE_PCCID(module_id_t mod_idP,int ue_idP);
rnti_t UE_RNTI(module_id_t mod_idP, int ue_idP);

554

555
void ulsch_scheduler_pre_processor(module_id_t module_idP, int frameP, sub_frame_t subframeP, uint16_t *first_rb);
556 557 558 559
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);
void assign_max_mcs_min_rb(module_id_t module_idP,int frameP, sub_frame_t subframeP,uint16_t *first_rb);
void adjust_bsr_info(int buffer_occupancy, uint16_t TBS, UE_TEMPLATE *UE_template);
560
int phy_stats_exist(module_id_t Mod_id, int rnti);
561

562
/*! \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)
563
   \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.
564
\param[in] module_idP instance of the UE
565 566 567 568
\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
569 570 571 572
\param[in] direction  subframe direction
\param[in] eNB_index  instance of eNB
@returns L2 state (CONNETION_OK or CONNECTION_LOST or PHY_RESYNCH)
*/
573 574
UE_L2_STATE_t ue_scheduler(
  const module_id_t module_idP,
575 576 577 578
  const frame_t rxFrameP,
  const sub_frame_t rxSubframe,
  const frame_t txFrameP,
  const sub_frame_t txSubframe,
579 580 581
  const lte_subframe_t direction,
  const uint8_t eNB_index,
  const int CC_id);
582

583
/*! \fn  int cba_access(module_id_t module_idP,frame_t frameP,sub_frame_t subframe, uint8_t eNB_index,uint16_t buflen);
584 585 586 587 588
\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
589
\param[out] access(1) or postpone (0)
590
*/
591
int cba_access(module_id_t module_idP,frame_t frameP,sub_frame_t subframe, uint8_t eNB_index,uint16_t buflen);
592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608

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

fnabet's avatar
fnabet committed
609
/*! \fn  boolean_t update_bsr(module_id_t module_idP, frame_t frameP,sub_frame_t subframeP)
610
   \brief get the rlc stats and update the bsr level for each lcid
611 612 613
\param[in] Mod_id instance of the UE
\param[in] frame Frame index
*/
fnabet's avatar
fnabet committed
614
boolean_t update_bsr(module_id_t module_idP, frame_t frameP, sub_frame_t subframeP,eNB_index_t eNB_index);
615

fnabet's avatar
fnabet committed
616
/*! \fn  locate_BsrIndexByBufferSize (int *table, int size, int value)
617
   \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.
618 619
\param[in] *table Pointer to BSR table
\param[in] size Size of the table
620
\param[in] value Value of the buffer
621 622
\return the index in the BSR_LEVEL table
*/
fnabet's avatar
fnabet committed
623
uint8_t locate_BsrIndexByBufferSize (const uint32_t *table, int size, int value);
624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667


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

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

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

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

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

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

knopp's avatar
 
knopp committed
668
/*! \fn  uint8_t get_phr_mapping (module_id_t module_idP, int CC_id,uint8_t eNB_index)
669 670
   \brief get phr mapping as described in 36.313
\param[in]  Mod_id index of eNB
knopp's avatar
 
knopp committed
671
\param[in] CC_id Component Carrier Index
672 673
\return phr mapping
*/
knopp's avatar
 
knopp committed
674
uint8_t get_phr_mapping (module_id_t module_idP, int CC_id, uint8_t eNB_index);
675 676 677 678

/*! \fn  void update_phr (module_id_t module_idP)
   \brief update/reset the phr timers
\param[in]  Mod_id index of eNB
knopp's avatar
 
knopp committed
679
\param[in] CC_id Component carrier index
680 681
\return void
*/
knopp's avatar
 
knopp committed
682
void update_phr (module_id_t module_idP,int CC_id);
683 684 685 686 687

/*! \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
*/
688
void Msg3_tx(module_id_t module_idP,uint8_t CC_id,frame_t frameP,uint8_t eNB_id);
689 690 691 692 693 694 695


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

696
void Msg1_tx(module_id_t module_idP,uint8_t CC_id,frame_t frameP, uint8_t eNB_id);
697 698 699 700 701 702 703 704 705 706

void dl_phy_sync_success(module_id_t   module_idP,
                         frame_t       frameP,
                         unsigned char eNB_index,
                         uint8_t first_sync);

int dump_eNB_l2_stats(char *buffer, int length);

double uniform_rngen(int min, int max);

707
/*
708
void add_common_dci(DCI_PDU *DCI_pdu,
709 710 711 712 713 714 715
                    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);
716
*/
717

knopp's avatar
knopp committed
718
uint32_t allocate_prbs_sub(int nb_rb, int N_RB_DL, int N_RBG, uint8_t *rballoc);
719

720 721
void update_ul_dci(module_id_t module_idP,uint8_t CC_id,rnti_t rnti,uint8_t dai);

722 723
int get_bw_index(module_id_t module_id, uint8_t CC_id);

724 725
int get_min_rb_unit(module_id_t module_idP, uint8_t CC_id);

726
/* \brief Generate header for DL-SCH.  This function parses the desired control elements and sdus and generates the header as described
727
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
728 729 730 731 732
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)
733
@param drx_cmd dicontinous reception command
734 735 736
@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)
737
@param post_padding number of bytes for padding at the end of MAC PDU
738 739 740
@returns Number of bytes used for header
*/
unsigned char generate_dlsch_header(unsigned char *mac_header,
741 742 743 744
                                    unsigned char num_sdus,
                                    unsigned short *sdu_lengths,
                                    unsigned char *sdu_lcids,
                                    unsigned char drx_cmd,
745
                                    unsigned short timing_advance_cmd,
746 747 748
                                    unsigned char *ue_cont_res_id,
                                    unsigned char short_padding,
                                    unsigned short post_padding);
749

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

755
@param radioResourceConfigCommon Structure from SIB2 for common radio parameters (if NULL keep existing configuration)
756
@param physicalConfigDedicated Structure from RRCConnectionSetup or RRCConnectionReconfiguration for dedicated PHY parameters (if NULL keep existing configuration)
757 758
@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)
759
@param logicalChannelIdentity Logical channel identity index of corresponding logical channel config
760 761 762 763
@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
764
@param SchedInfoList SI Scheduling information
765 766 767 768
@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)
769
@param sib1_ext_r13 SI Scheduling information for SI-BR UEs         
770
*/
771

772 773 774 775 776 777 778
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,
779
#ifdef Rel14
780
                           int                                     pbch_repetition,
781
#endif
782 783 784
			   rnti_t                                  rntiP,
			   BCCH_BCH_Message_t                      *mib,
 			   RadioResourceConfigCommonSIB_t          *radioResourceConfigCommon,
785
#ifdef Rel14
786
 			   RadioResourceConfigCommonSIB_t          *radioResourceConfigCommon_BR,
787
#endif
788
			   struct PhysicalConfigDedicated          *physicalConfigDedicated,
Cedric Roux's avatar
Cedric Roux committed
789
#if defined(Rel10) || defined(Rel14)
790
			   SCellToAddMod_r10_t                     *sCellToAddMod_r10,
791
			   //struct PhysicalConfigDedicatedSCell_r10 *physicalConfigDedicatedSCell_r10,
792
#endif
793 794 795 796 797 798 799 800 801 802 803 804
			   MeasObjectToAddMod_t                    **measObj,
			   MAC_MainConfig_t                        *mac_MainConfig,
			   long                                    logicalChannelIdentity,
			   LogicalChannelConfig_t                  *logicalChannelConfig,
			   MeasGapConfig_t                         *measGapConfig,
			   TDD_Config_t                            *tdd_Config,
			   MobilityControlInfo_t                   *mobilityControlInfo,
			   SchedulingInfoList_t                    *schedulingInfoList,
			   uint32_t                                ul_CarrierFreq,
			   long                                    *ul_Bandwidth,
			   AdditionalSpectrumEmission_t            *additionalSpectrumEmission,
			   struct MBSFN_SubframeConfigList         *mbsfn_SubframeConfigList
Cedric Roux's avatar
Cedric Roux committed
805
#if defined(Rel10) || defined(Rel14)
806 807 808 809 810
			   ,
			   uint8_t                                 MBMS_Flag,
			   MBSFN_AreaInfoList_r9_t                 *mbsfn_AreaInfoList,
			   PMCH_InfoList_r9_t                      *pmch_InfoList
			   
811
#endif
812 813 814
#ifdef Rel14
			   ,
			   SystemInformationBlockType1_v1310_IEs_t *sib1_ext_r13          
815
#endif
816
			   );
817

818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842
/** \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)
*/
int rrc_mac_config_req_ue(module_id_t     module_idP,
			  int             CC_id,
			  uint8_t         eNB_index,
			  RadioResourceConfigCommonSIB_t *radioResourceConfigCommon,
			  struct PhysicalConfigDedicated *physicalConfigDedicated,
843
#if defined(Rel10) || defined(Rel14)
844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859
			  SCellToAddMod_r10_t *sCellToAddMod_r10,
			  //struct PhysicalConfigDedicatedSCell_r10 *physicalConfigDedicatedSCell_r10,
#endif
			  MeasObjectToAddMod_t **measObj,
			  MAC_MainConfig_t *mac_MainConfig,
			  long logicalChannelIdentity,
			  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,
			  long *ul_Bandwidth,
			  AdditionalSpectrumEmission_t *additionalSpectrumEmission,
			  struct MBSFN_SubframeConfigList *mbsfn_SubframeConfigList
860
#if defined(Rel10) || defined(Rel14)
861 862 863 864 865 866 867 868 869 870 871 872 873
			  ,
			  uint8_t MBMS_Flag,
			  MBSFN_AreaInfoList_r9_t *mbsfn_AreaInfoList,
			  PMCH_InfoList_r9_t *pmch_InfoList
			  
#endif
#ifdef CBA
			  ,
			  uint8_t num_active_cba_groups,
			  uint16_t cba_rnti
#endif
			  );

874
uint16_t getRIV(uint16_t N_RB_DL,uint16_t RBstart,uint16_t Lcrbs);
875

876
int get_subbandsize(uint8_t dl_bandwidth);
877

878 879

void get_Msg3allocret(COMMON_channels_t *cc,
880 881 882 883
		      sub_frame_t current_subframe,
		      frame_t current_frame,
		      frame_t *frame,
		      sub_frame_t *subframe);
884 885

void get_Msg3alloc(COMMON_channels_t *cc,
886 887 888 889
		   sub_frame_t current_subframe,
		   frame_t current_frame,
		   frame_t *frame,
		   sub_frame_t *subframe);
890 891 892 893 894 895 896 897 898 899

uint16_t mac_computeRIV(uint16_t N_RB_DL,uint16_t RBstart,uint16_t Lcrbs);

int get_phich_resource_times6(COMMON_channels_t *cc);

int to_rbg(int dl_Bandwidth);

int to_prb(int dl_Bandwidth);

uint8_t get_Msg3harqpid(COMMON_channels_t *cc,
900 901
			frame_t frame,
			sub_frame_t current_subframe);
902 903 904 905 906

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

uint8_t pdcchalloc2ulsubframe(COMMON_channels_t *ccP,uint8_t n);

907 908
int is_UL_sf(COMMON_channels_t *ccP,sub_frame_t subframeP);

909
uint8_t getQm(uint8_t mcs);
910

911
uint8_t subframe2harqpid(COMMON_channels_t *cc,frame_t frame,sub_frame_t subframe);
912

913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987
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(UE_sched_ctrl *sched_ctl,COMMON_channels_t *cc,uint8_t tmode, uint8_t ri, CQI_ReportModeAperiodic_t *cqi_ReportModeAperiodic);
void extract_pucch_csi(module_id_t mod_idP,int CC_idP,int UE_id, frame_t frameP,sub_frame_t subframeP, uint8_t *pdu, uint8_t length);

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

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

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

void fill_nfapi_dlsch_config(eNB_MAC_INST *eNB, nfapi_dl_config_request_body_t *dl_req,
			     uint16_t length,
			     uint16_t pdu_index,
			     uint16_t rnti,
			     uint8_t resource_allocation_type,
			     uint8_t virtual_resource_block_assignment_flag,
			     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,
			     //			     uint8_t codebook_index,
			     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,
			     uint8_t num_bf_vector
			     );

void fill_nfapi_harq_information(module_id_t module_idP,
				 int CC_idP,
				 uint16_t rntiP,
				 uint16_t absSFP,
				 nfapi_ul_config_harq_information *harq_information,
				 uint8_t cce_idxP);

void fill_nfapi_ulsch_harq_information(module_id_t module_idP,
				       int CC_idP,
				       uint16_t rntiP,
				       nfapi_ul_config_ulsch_harq_information *harq_information);

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

void fill_nfapi_dl_dci_1A(nfapi_dl_config_request_pdu_t   *dl_config_pdu,
			  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,
			  uint8_t ndi,
			  uint8_t rv,
			  uint8_t vrb_flag);

nfapi_ul_config_request_pdu_t* has_ul_grant(module_id_t module_idP,int CC_idP,uint16_t subframeP,uint16_t rnti);

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

uint8_t get_ul_req_index(module_id_t module_idP, int CC_idP, sub_frame_t subframeP);
988 989 990 991

#ifdef Rel14
int get_numnarrowbandbits(long dl_Bandwidth);

992
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);
993 994

int get_numnarrowbands(long dl_Bandwidth);
995 996 997

int narrowband_to_first_rb(COMMON_channels_t *cc, int nb_index);

998 999 1000
#endif


1001

1002
#endif
1003
/** @}*/