proto.h 48.4 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
Cedric Roux's avatar
Cedric Roux committed
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
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

knopp's avatar
knopp committed
144
145
void add_msg3(module_id_t module_idP,int CC_id, RA_TEMPLATE *RA_template, frame_t frameP, sub_frame_t subframeP);

146
//main.c
147

knopp's avatar
   
knopp committed
148
int mac_top_init(int eMBMS_active, char *uecap_xer,uint8_t cba_group_active, uint8_t HO_active);
149

knopp's avatar
knopp committed
150
151
152
void mac_top_init_eNB(void);

void mac_init_cell_params(int Mod_idP,int CC_idP);
knopp's avatar
knopp committed
153

154
155
156
157
158
159
160
161
162
163
164
165
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);

knopp's avatar
knopp committed
166
167
void clear_nfapi_information(eNB_MAC_INST *eNB,int CC_idP,frame_t frameP,sub_frame_t subframeP);

168
void dlsch_scheduler_pre_processor_reset (int module_idP,int UE_id,
169
    uint8_t  CC_id,
170
171
    int frameP,
    int subframeP,
172
173
174
175
176
    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]);
177
178
179
180
181
182
183
184
185
186
187
188
189

// 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,
190
                                    int N_RBG[MAX_NUM_CCs],
191
                                    int *mbsfn_flag);
192

193
194

void dlsch_scheduler_pre_processor_allocate (module_id_t   Mod_id,
195
196
197
198
199
200
201
202
203
204
205
206
    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
207
   and generates all DLSCH allocations for subframe \f$n\f$ and ULSCH allocations for subframe \f$n+k$\f. 
208
209
210
211
@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.
*/
212
void eNB_dlsch_ulsch_scheduler(module_id_t module_idP, frame_t frameP, sub_frame_t subframeP);//, int calibration_flag);
213
214
215
216

/* \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
217
@param timing_offset Offset in samples of the received PRACH w.r.t. eNB timing. This is used to
218
219
220
221
222
223
224
225
226
@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
		      );
227
228
229
230
231
232
233

/* \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
*/
234
235
236
237
238
239
240
241
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
);
242

243
244
245
246
247
248
249
250
251
252
253
#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

254
255
256
257
/* \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
258
void cancel_ra_proc(module_id_t module_idP,int CC_id,frame_t frameP, uint16_t preamble_index);
259

260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
/* \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);

279
280
/* \brief Function to indicate a received SDU on ULSCH.
@param Mod_id Instance ID of eNB
281
282
@param CC_id Component carrier index
@param rnti RNTI of UE transmitting the SDU
283
@param sdu Pointer to received SDU
284
285
286
@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)
287
*/
288
289
290
291
292
293
294
295
296
297
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);

298
299

/* \brief Function to indicate a scheduled schduling request (SR) was received by eNB.
300
301
302
303
@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
304
@param rnti RNTI of UE transmitting the SR
305
@param ul_cqi SNR measurement of PUCCH (SNR quantized to 8 bits, -64 ... 63.5 dB in .5dB steps)
306
*/
307
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);
308

309
310
311
312
313
314
315
316
317
/* \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
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
/* \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
*/
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);

/* \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
*/
void cqi_indication(module_id_t mod_idP, int CC_idP, frame_t frameP, sub_frame_t subframeP, rnti_t rntiP, 
		    nfapi_cqi_indication_rel9_t *rel9,uint8_t *pdu,
		    nfapi_ul_cqi_information_t *ul_cqi_information);

knopp's avatar
   
knopp committed
339
uint8_t *get_dlsch_sdu(module_id_t module_idP,int CC_id,frame_t frameP,rnti_t rnti,uint8_t TBindex);
340
341
342
343
344

/* \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
345
@param mcs Pointer to mcs used by PHY (to be filled by MAC)
346
347
@returns Pointer to MCH transport block and mcs for subframe
*/
348
MCH_PDU *get_mch_sdu( module_id_t Mod_id, int CC_id, frame_t frame, sub_frame_t subframe);
349
350


351

352
353
354
355
356


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
357
358
359
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) ;
360
int         find_RA_id        (module_id_t mod_idP, int CC_idP, rnti_t rntiP);
knopp's avatar
   
knopp committed
361
362
363
364
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);
365
uint8_t     get_aggregation   (uint8_t bw_index, uint8_t cqi, uint8_t dci_fmt);
366
367
368

int8_t find_active_UEs_with_traffic(module_id_t module_idP);

369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
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);

390
void set_ue_dai(sub_frame_t   subframeP,
391
392
                int           UE_id,
                uint8_t       CC_id,
knopp's avatar
knopp committed
393
                uint8_t       tdd_config,
394
                UE_list_t     *UE_list);
395

396
uint8_t find_num_active_UEs_in_cbagroup(module_id_t module_idP, unsigned char group_id);
knopp's avatar
   
knopp committed
397
uint8_t UE_is_to_be_scheduled(module_id_t module_idP,int CC_id,uint8_t UE_id);
398
399
400
401
402
/** \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
403
module_id_t schedule_next_ulue(module_id_t module_idP, int UE_id,sub_frame_t subframe);
404
405
406
407
408
409

/** \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
*/
410
int schedule_next_dlue(module_id_t module_idP, int CC_id, sub_frame_t subframe);
411
412
413
414

/* \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
415
@param N_RB_DL Number of PRBs on DL
416
417
418
@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
419
uint32_t allocate_prbs(int UE_id,uint8_t nb_rb, int N_RB_DL, uint32_t *rballoc);
420
421

/* \fn uint32_t req_new_ulsch(module_id_t module_idP)
422
\brief check for a new transmission in any drb
423
424
425
426
427
428
429
@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
430
@param CC_id Component Carrier index
431
432
433
434
435
@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
436
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);
437

438
uint8_t get_ue_weight(module_id_t module_idP, int CC_id, int UE_id);
439
440
441
442

// 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
443
void ue_decode_si(module_id_t module_idP, int CC_id,frame_t frame, uint8_t CH_index, void *pdu, uint16_t len);
444

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

447

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

knopp's avatar
knopp committed
450
451
452
453
454
455
456
457
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
		    );
458

Cedric Roux's avatar
Cedric Roux committed
459
#if defined(Rel10) || defined(Rel14)
460
461
462
463
464
465
466
467
/* \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
*/
468
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) ;
469
470
471
472
473
474
475
476
477

/*\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
*/
478
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);
479
480
481

#endif

482
/* \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.
483
484
485
486
487
@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
*/
knopp's avatar
   
knopp committed
488
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);
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
/* \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);

514
515
/* \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
516
@param Mod_id Component Carrier Index
517
518
519
@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
520
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);
521
522
523

/* \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
524
525
526
@param CC_id Index to a component carrier
@param frame Frame index
@param ra_rnti RA_RNTI value
527
528
@param dlsch_buffer  Pointer to dlsch_buffer containing RAR PDU
@param t_crnti Pointer to PHY variable containing the T_CRNTI
529
@param preamble_index Preamble Index used by PHY to transmit the PRACH.  This should match the received RAR to trigger the rest of
530
random-access procedure
531
@param selected_rar_buffer the output buffer for storing the selected RAR header and RAR payload
532
533
@returns timing advance or 0xffff if preamble doesn't match
*/
534
535
536
537
538
uint16_t
ue_process_rar(
  const module_id_t module_idP,
  const int CC_id,
  const frame_t frameP,
539
  const rnti_t ra_rnti,
540
541
  uint8_t * const dlsch_buffer,
  rnti_t * const t_crnti,
542
543
  const uint8_t preamble_index,
  uint8_t* selected_rar_buffer
544
);
545
546
547


/* \brief Generate header for UL-SCH.  This function parses the desired control elements and sdus and generates the header as described
548
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
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
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
576
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
577
578
579
580
581
582
583
584
585
586
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,
587
588
589
590
591
592
                            uint8_t *num_ce,
                            uint8_t *num_sdu,
                            uint8_t *rx_ces,
                            uint8_t *rx_lcids,
                            uint16_t *rx_lengths,
                            uint16_t tx_lenght);
593

knopp's avatar
knopp committed
594
595
int to_prb(int);
int to_rbg(int);
knopp's avatar
   
knopp committed
596
int l2_init(LTE_DL_FRAME_PARMS *frame_parms,int eMBMS_active, char *uecap_xer, uint8_t cba_group_active, uint8_t HO_active);
597
int mac_init(void);
598
599
600
601
602
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
               );
603
int rrc_mac_remove_ue(module_id_t Mod_id, rnti_t rntiP);
604

605
606
607
608
609

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);
610
611
612
613
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);

614

615
void ulsch_scheduler_pre_processor(module_id_t module_idP, int frameP, sub_frame_t subframeP, uint16_t *first_rb);
616
617
618
619
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);
620
int phy_stats_exist(module_id_t Mod_id, int rnti);
621

622
/*! \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)
623
   \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.
624
\param[in] module_idP instance of the UE
625
626
627
628
\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
629
630
631
632
\param[in] direction  subframe direction
\param[in] eNB_index  instance of eNB
@returns L2 state (CONNETION_OK or CONNECTION_LOST or PHY_RESYNCH)
*/
633
634
UE_L2_STATE_t ue_scheduler(
  const module_id_t module_idP,
635
636
637
638
  const frame_t rxFrameP,
  const sub_frame_t rxSubframe,
  const frame_t txFrameP,
  const sub_frame_t txSubframe,
639
640
641
  const lte_subframe_t direction,
  const uint8_t eNB_index,
  const int CC_id);
642

643
/*! \fn  int cba_access(module_id_t module_idP,frame_t frameP,sub_frame_t subframe, uint8_t eNB_index,uint16_t buflen);
644
645
646
647
648
\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
649
\param[out] access(1) or postpone (0)
650
*/
651
int cba_access(module_id_t module_idP,frame_t frameP,sub_frame_t subframe, uint8_t eNB_index,uint16_t buflen);
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668

/*! \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
669
/*! \fn  boolean_t update_bsr(module_id_t module_idP, frame_t frameP,sub_frame_t subframeP)
670
   \brief get the rlc stats and update the bsr level for each lcid
671
672
673
\param[in] Mod_id instance of the UE
\param[in] frame Frame index
*/
fnabet's avatar
fnabet committed
674
boolean_t update_bsr(module_id_t module_idP, frame_t frameP, sub_frame_t subframeP,eNB_index_t eNB_index);
675

fnabet's avatar
fnabet committed
676
/*! \fn  locate_BsrIndexByBufferSize (int *table, int size, int value)
677
   \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.
678
679
\param[in] *table Pointer to BSR table
\param[in] size Size of the table
680
\param[in] value Value of the buffer
681
682
\return the index in the BSR_LEVEL table
*/
fnabet's avatar
fnabet committed
683
uint8_t locate_BsrIndexByBufferSize (const uint32_t *table, int size, int value);
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727


/*! \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
728
/*! \fn  uint8_t get_phr_mapping (module_id_t module_idP, int CC_id,uint8_t eNB_index)
729
730
   \brief get phr mapping as described in 36.313
\param[in]  Mod_id index of eNB
knopp's avatar
   
knopp committed
731
\param[in] CC_id Component Carrier Index
732
733
\return phr mapping
*/
knopp's avatar
   
knopp committed
734
uint8_t get_phr_mapping (module_id_t module_idP, int CC_id, uint8_t eNB_index);
735
736
737
738

/*! \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
739
\param[in] CC_id Component carrier index
740
741
\return void
*/
knopp's avatar
   
knopp committed
742
void update_phr (module_id_t module_idP,int CC_id);
743
744
745
746
747

/*! \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
*/
748
void Msg3_tx(module_id_t module_idP,uint8_t CC_id,frame_t frameP,uint8_t eNB_id);
749
750
751
752
753
754
755


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

756
void Msg1_tx(module_id_t module_idP,uint8_t CC_id,frame_t frameP, uint8_t eNB_id);
757
758
759
760
761
762
763
764
765
766

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

767
/*
768
void add_common_dci(DCI_PDU *DCI_pdu,
769
770
771
772
773
774
775
                    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);
776
*/
777

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

780
781
void update_ul_dci(module_id_t module_idP,uint8_t CC_id,rnti_t rnti,uint8_t dai);

782
783
int get_bw_index(module_id_t module_id, uint8_t CC_id);

784
785
int get_min_rb_unit(module_id_t module_idP, uint8_t CC_id);

786
/* \brief Generate header for DL-SCH.  This function parses the desired control elements and sdus and generates the header as described
787
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
788
789
790
791
792
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)
793
@param drx_cmd dicontinous reception command
794
795
796
@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)
797
@param post_padding number of bytes for padding at the end of MAC PDU
798
799
800
@returns Number of bytes used for header
*/
unsigned char generate_dlsch_header(unsigned char *mac_header,
801
802
803
804
                                    unsigned char num_sdus,
                                    unsigned short *sdu_lengths,
                                    unsigned char *sdu_lcids,
                                    unsigned char drx_cmd,
805
                                    unsigned short timing_advance_cmd,
806
807
808
                                    unsigned char *ue_cont_res_id,
                                    unsigned char short_padding,
                                    unsigned short post_padding);
809

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

815
@param radioResourceConfigCommon Structure from SIB2 for common radio parameters (if NULL keep existing configuration)
816
@param physicalConfigDedicated Structure from RRCConnectionSetup or RRCConnectionReconfiguration for dedicated PHY parameters (if NULL keep existing configuration)
817
818
@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)
819
@param logicalChannelIdentity Logical channel identity index of corresponding logical channel config
820
821
822
823
@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
824
@param SchedInfoList SI Scheduling information
825
826
827
828
@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)
829
@param sib1_ext_r13 SI Scheduling information for SI-BR UEs         
830
*/
831

832
833
834
835
836
837
838
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,
839
#ifdef Rel14
840
                           int                                     pbch_repetition,
841
#endif
842
843
844
			   rnti_t                                  rntiP,
			   BCCH_BCH_Message_t                      *mib,
 			   RadioResourceConfigCommonSIB_t          *radioResourceConfigCommon,
845
#ifdef Rel14
846
 			   RadioResourceConfigCommonSIB_t          *radioResourceConfigCommon_BR,
847
#endif
848
			   struct PhysicalConfigDedicated          *physicalConfigDedicated,
Cedric Roux's avatar
Cedric Roux committed
849
#if defined(Rel10) || defined(Rel14)
850
			   SCellToAddMod_r10_t                     *sCellToAddMod_r10,
851
			   //struct PhysicalConfigDedicatedSCell_r10 *physicalConfigDedicatedSCell_r10,
852
#endif
853
854
855
856
857
858
859
860
861
862
863
864
			   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
865
#if defined(Rel10) || defined(Rel14)
866
867
868
869
870
			   ,
			   uint8_t                                 MBMS_Flag,
			   MBSFN_AreaInfoList_r9_t                 *mbsfn_AreaInfoList,
			   PMCH_InfoList_r9_t                      *pmch_InfoList
			   
871
#endif
872
873
874
#ifdef Rel14
			   ,
			   SystemInformationBlockType1_v1310_IEs_t *sib1_ext_r13          
875
#endif
876
			   );
877

878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
/** \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,
903
#if defined(Rel10) || defined(Rel14)
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
			  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
920
#if defined(Rel10) || defined(Rel14)
921
922
923
924
925
926
927
928
929
930
931
932
933
			  ,
			  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
			  );

934
uint16_t getRIV(uint16_t N_RB_DL,uint16_t RBstart,uint16_t Lcrbs);
935

936
int get_subbandsize(uint8_t dl_bandwidth);
937

938
939

void get_Msg3allocret(COMMON_channels_t *cc,
940
941
942
943
		      sub_frame_t current_subframe,
		      frame_t current_frame,
		      frame_t *frame,
		      sub_frame_t *subframe);
944
945

void get_Msg3alloc(COMMON_channels_t *cc,
946
947
948
949
		   sub_frame_t current_subframe,
		   frame_t current_frame,
		   frame_t *frame,
		   sub_frame_t *subframe);
950
951
952
953
954
955
956
957
958
959

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,
960
961
			frame_t frame,
			sub_frame_t current_subframe);
962
963
964
965
966

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

uint8_t pdcchalloc2ulsubframe(COMMON_channels_t *ccP,uint8_t n);

967
968
int is_UL_sf(COMMON_channels_t *ccP,sub_frame_t subframeP);

969
uint8_t getQm(uint8_t mcs);
970

971
uint8_t subframe2harqpid(COMMON_channels_t *cc,frame_t frame,sub_frame_t subframe);
972

973
974
975
976
977
978
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);

979
uint8_t get_dl_cqi_pmi_size_pusch(COMMON_channels_t *cc,uint8_t tmode, uint8_t ri, CQI_ReportModeAperiodic_t *cqi_ReportModeAperiodic);
980
981
982
983
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);

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

986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
void fill_nfapi_ulsch_config_request_rel8(nfapi_ul_config_request_pdu_t  *ul_config_pdu,
					  uint8_t                        cqi_req,
					  COMMON_channels_t              *cc,
					  struct PhysicalConfigDedicated *physicalConfigDedicated,
					  uint8_t                        tmode,
					  uint32_t                       handle,
					  uint16_t                       rnti,
					  uint8_t                        resource_block_start,
					  uint8_t                        number_of_resource_blocks,
					  uint8_t                        mcs,
					  uint8_t                        cyclic_shift_2_for_drms,
					  uint8_t                        frequency_hopping_enabled_flag,
					  uint8_t                        frequency_hopping_bits,
					  uint8_t                        new_data_indication,
					  uint8_t                        redundancy_version,
					  uint8_t                        harq_process_number,
					  uint8_t                        ul_tx_mode,
					  uint8_t                        current_tx_nb,
					  uint8_t                        n_srs,
					  uint16_t                       size
					  );

#ifdef Rel14
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,
					  uint16_t repetition_number,
					  uint16_t initial_transmission_sf_io);
#endif

1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
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);
1078
1079
1080
1081

#ifdef Rel14
int get_numnarrowbandbits(long dl_Bandwidth);

1082
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);
1083
1084

int get_numnarrowbands(long dl_Bandwidth);
1085
1086
1087

int narrowband_to_first_rb(COMMON_channels_t *cc, int nb_index);

1088
1089
#endif

knopp's avatar
knopp committed
1090
1091
int l2_init_eNB(void);

Cedric Roux's avatar
Cedric Roux committed
1092
1093
1094
1095
1096
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);
int32_t get_uldl_offset(int eutra_bandP);
int l2_init_ue(int eMBMS_active, char *uecap_xer,uint8_t cba_group_active, uint8_t HO_active);
1097

1098
#endif
1099
/** @}*/