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

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

39
40
41
42
43
44
45
/** \fn void schedule_mib(module_id_t module_idP,frame_t frameP,sub_frame_t subframe);
\brief MIB scheduling for PBCH. This function requests the MIB from RRC and provides it to L1.
@param Mod_id Instance ID of eNB
@param frame Frame index
@param subframe Subframe number on which to act

*/
46

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

/** \fn void schedule_RA(module_id_t module_idP,frame_t frameP,sub_frame_t subframe);
51
\brief First stage of Random-Access Scheduling. Loops over the ras and checks if RAR, Msg3 or its retransmission are to be scheduled in the subframe.  It returns the total number of PRB used for RA SDUs.  For Msg3 it retrieves the L3msg from RRC and fills the appropriate buffers.  For the others it just computes the number of PRBs. Each DCI uses 3 PRBs (format 1A)
52
53
54
55
56
for the message.
@param Mod_id Instance ID of eNB
@param frame Frame index
@param subframe Subframe number on which to act
*/
57
58


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

/** \brief First stage of SI Scheduling. Gets a SI SDU from RRC if available and computes the MCS required to transport it as a function of the SDU length.  It assumes a length less than or equal to 64 bytes (MCS 6, 3 PRBs).
@param Mod_id Instance ID of eNB
@param frame Frame index
@param subframe Subframe number on which to act
*/
67
68
void schedule_SI(module_id_t module_idP, frame_t frameP,
		 sub_frame_t subframeP);
69
70
71
72
73
74

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

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

/** \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
90
@param[out] index of sf pattern
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);
95
96
97
98
99
100

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

104
/** \brief ULSCH Scheduling per RNTI
105
@param Mod_id Instance ID of eNB
106
@param slice_idx Slice instance index for this eNB
107
108
109
110
@param frame Frame index
@param subframe Subframe number on which to act
@param sched_subframe Subframe number where PUSCH is transmitted (for DAI lookup)
*/
111
void schedule_ulsch_rnti(module_id_t module_idP, int slice_idx, frame_t frameP,
112
113
114
			 sub_frame_t subframe,
			 unsigned char sched_subframe,
			 uint16_t * first_rb);
115

116
/** \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.
117
118
119
120
121
@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
*/
122
void fill_DLSCH_dci(module_id_t module_idP,frame_t frameP,sub_frame_t subframe,int *mbsfn_flag);
123

124
/** \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
125
126
127
@param Mod_id Instance ID of eNB
@param frame Frame index
@param subframe Subframe on which to act
knopp's avatar
knopp committed
128

129
130
@param mbsfn_flag  Indicates that MCH/MCCH is in this subframe
*/
131
void schedule_dlsch(module_id_t module_idP, frame_t frameP,
132
		      sub_frame_t subframe, int *mbsfn_flag);
133

134
void schedule_ue_spec(module_id_t module_idP, int slice_idxP,
135
		      frame_t frameP,sub_frame_t subframe, int *mbsfn_flag);
136
137

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

140

141
142
143
144
/** \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
*/
145
int8_t get_Po_NOMINAL_PUSCH(module_id_t module_idP, uint8_t CC_id);
146

147
/** \brief Function to compute DELTA_PREAMBLE from 36.321 (for RA power ramping procedure and Msg3 PUSCH power control policy)
148
149
150
    @param Mod_id Module id of UE
    @returns DELTA_PREAMBLE
*/
151
int8_t get_DELTA_PREAMBLE(module_id_t module_idP, int CC_id);
152

153
/** \brief Function for compute deltaP_rampup from 36.321 (for RA power ramping procedure and Msg3 PUSCH power control policy)
154
    @param Mod_id Module id of UE
155
    @param CC_id carrier component id of UE
156
157
    @returns deltaP_rampup
*/
158
int8_t get_deltaP_rampup(module_id_t module_idP, uint8_t CC_id);
159

160
161
uint16_t mac_computeRIV(uint16_t N_RB_DL, uint16_t RBstart,
			uint16_t Lcrbs);
162

163
164
void add_msg3(module_id_t module_idP, int CC_id, RA_t * ra, frame_t frameP,
	      sub_frame_t subframeP);
knopp's avatar
knopp committed
165

166
//main.c
167

168
169
170
171
void init_UE_list(UE_list_t *UE_list);

void init_slice_info(slice_info_t *sli);

172
173
int mac_top_init(int eMBMS_active, char *uecap_xer,
		 uint8_t cba_group_active, uint8_t HO_active);
174

knopp's avatar
knopp committed
175
176
void mac_top_init_eNB(void);

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

179
180
181
182
183
184
185
186
187
188
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);

189
190
191
192
193
194
void mac_UE_out_of_sync_ind(module_id_t module_idP, frame_t frameP,
			    uint16_t eNB_index);

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

195
196
197
198

// 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
199
@param slice_idxP Slice instance index for the slice in which scheduling happens
200
201
202
203
204
205
@param frame Index of frame
@param subframe Index of current subframe
@param N_RBS Number of resource block groups
 */


206
void dlsch_scheduler_pre_processor(module_id_t module_idP,
207
                                   int slice_idxP,
208
209
                                   frame_t frameP,
                                   sub_frame_t subframe,
210
211
                                   int *mbsfn_flag,
                                   uint8_t rballoc_sub[NFAPI_CC_MAX][N_RBG_MAX]);
212
213

void dlsch_scheduler_pre_processor_reset(module_id_t module_idP,
214
                                         int slice_idx,
215
216
217
218
                                         frame_t frameP,
                                         sub_frame_t subframeP,
                                         int min_rb_unit[NFAPI_CC_MAX],
                                         uint16_t nb_rbs_required[NFAPI_CC_MAX][MAX_MOBILES_PER_ENB],
219
220
                                         uint8_t rballoc_sub[NFAPI_CC_MAX][N_RBG_MAX],
                                         uint8_t MIMO_mode_indicator[NFAPI_CC_MAX][N_RBG_MAX],
221
222
                                         int *mbsfn_flag);

223
void dlsch_scheduler_pre_processor_partitioning(module_id_t Mod_id,
224
                                                int slice_idx,
225
226
                                                const uint8_t rbs_retx[NFAPI_CC_MAX]);

227
void dlsch_scheduler_pre_processor_accounting(module_id_t Mod_id,
228
                                              int slice_idx,
229
230
231
232
                                              frame_t frameP,
                                              sub_frame_t subframeP,
                                              int min_rb_unit[NFAPI_CC_MAX],
                                              uint16_t nb_rbs_required[NFAPI_CC_MAX][MAX_MOBILES_PER_ENB],
233
                                              uint16_t nb_rbs_accounted[NFAPI_CC_MAX][MAX_MOBILES_PER_ENB]);
234
235

void dlsch_scheduler_pre_processor_positioning(module_id_t Mod_id,
236
                                               int slice_idx,
237
238
                                               int min_rb_unit[NFAPI_CC_MAX],
                                               uint16_t nb_rbs_required[NFAPI_CC_MAX][MAX_MOBILES_PER_ENB],
239
                                               uint16_t nb_rbs_accounted[NFAPI_CC_MAX][MAX_MOBILES_PER_ENB],
240
                                               uint16_t nb_rbs_remaining[NFAPI_CC_MAX][MAX_MOBILES_PER_ENB],
241
242
                                               uint8_t rballoc_sub[NFAPI_CC_MAX][N_RBG_MAX],
                                               uint8_t MIMO_mode_indicator[NFAPI_CC_MAX][N_RBG_MAX]);
243

244
void dlsch_scheduler_pre_processor_intraslice_sharing(module_id_t Mod_id,
245
                                                      int slice_idx,
246
247
248
249
250
251
252
                                                      int min_rb_unit[NFAPI_CC_MAX],
                                                      uint16_t nb_rbs_required[NFAPI_CC_MAX][MAX_MOBILES_PER_ENB],
                                                      uint16_t nb_rbs_accounted[NFAPI_CC_MAX][MAX_MOBILES_PER_ENB],
                                                      uint16_t nb_rbs_remaining[NFAPI_CC_MAX][MAX_MOBILES_PER_ENB],
                                                      uint8_t rballoc_sub[NFAPI_CC_MAX][N_RBG_MAX],
                                                      uint8_t MIMO_mode_indicator[NFAPI_CC_MAX][N_RBG_MAX]);

253
void slice_priority_sort(module_id_t Mod_id, int slice_list[MAX_NUM_SLICES]);
254

255
256
void dlsch_scheduler_interslice_multiplexing(module_id_t Mod_id,
                                             int frameP,
257
258
                                             sub_frame_t subframeP,
                                             uint8_t rballoc_sub[NFAPI_CC_MAX][N_RBG_MAX]);
259

260
261
262
263
void dlsch_scheduler_qos_multiplexing(module_id_t Mod_id,
                                      int frameP,
                                      sub_frame_t subframeP);

264
void dlsch_scheduler_pre_processor_allocate(module_id_t Mod_id,
265
266
267
268
269
270
                                            int UE_id,
                                            uint8_t CC_id,
                                            int N_RBG,
                                            int min_rb_unit,
                                            uint16_t nb_rbs_required[NFAPI_CC_MAX][MAX_MOBILES_PER_ENB],
                                            uint16_t nb_rbs_remaining[NFAPI_CC_MAX][MAX_MOBILES_PER_ENB],
271
                                            uint8_t rballoc_sub[NFAPI_CC_MAX][N_RBG_MAX],
272
                                            uint8_t slice_allocation_mask[NFAPI_CC_MAX][N_RBG_MAX],
273
                                            uint8_t MIMO_mode_indicator[NFAPI_CC_MAX][N_RBG_MAX]);
274
275

/* \brief Function to trigger the eNB scheduling procedure.  It is called by PHY at the beginning of each subframe, \f$n$\f
276
   and generates all DLSCH allocations for subframe \f$n\f$ and ULSCH allocations for subframe \f$n+k$\f. 
277
278
279
280
@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.
*/
281
void eNB_dlsch_ulsch_scheduler(module_id_t module_idP, frame_t frameP, sub_frame_t subframeP);	//, int calibration_flag);
282
283
284
285

/* \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
286
@param timing_offset Offset in samples of the received PRACH w.r.t. eNB timing. This is used to
287
288
289
@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)
*/
290
291
292
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
293
#if (RRC_VERSION >= MAKE_VERSION(14, 0, 0))
294
		      , uint8_t rach_resource_type
295
#endif
296
    );
297
298
299
300
301
302
303

/* \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
*/
304
305
306
307
308
309
310
unsigned short fill_rar(const module_id_t module_idP,
			const int CC_id,
			RA_t *ra,
			const frame_t frameP,
			uint8_t * const dlsch_buffer,
			const uint16_t N_RB_UL,
			const uint8_t input_buffer_length);
311

312
#if (RRC_VERSION >= MAKE_VERSION(14, 0, 0))
313
unsigned short fill_rar_br(eNB_MAC_INST * eNB,
314
			   int CC_id,
315
316
317
318
319
			   RA_t * ra,
			   const frame_t frameP,
			   const sub_frame_t subframeP,
			   uint8_t * const dlsch_buffer,
			   const uint8_t ce_level);
320
321
#endif

322
323
324
325
/* \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.
*/
326
327
void cancel_ra_proc(module_id_t module_idP, int CC_id, frame_t frameP,
		    uint16_t preamble_index);
328

329
330
331
332
333
334
335
336
337
338
339
/* \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
*/
340
341
342

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

343
void set_msg3_subframe(module_id_t Mod_id,
344
345
346
347
		       int CC_id,
		       int frame,
		       int subframe,
		       int rnti, int Msg3_frame, int Msg3_subframe);
348

349
350
/* \brief Function to indicate a received SDU on ULSCH.
@param Mod_id Instance ID of eNB
351
352
@param CC_id Component carrier index
@param rnti RNTI of UE transmitting the SDU
353
@param sdu Pointer to received SDU
354
355
356
@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)
357
*/
358
void rx_sdu(const module_id_t enb_mod_idP,
359
360
	    const int CC_idP,
	    const frame_t frameP,
361
	    const sub_frame_t subframeP,
362
363
364
365
	    const rnti_t rntiP,
	    uint8_t * sduP,
	    const uint16_t sdu_lenP,
	    const uint16_t timing_advance, const uint8_t ul_cqi);
366

367
368

/* \brief Function to indicate a scheduled schduling request (SR) was received by eNB.
369
370
371
372
@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
373
@param rnti RNTI of UE transmitting the SR
374
@param ul_cqi SNR measurement of PUCCH (SNR quantized to 8 bits, -64 ... 63.5 dB in .5dB steps)
375
*/
376
377
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);
378

379
380
381
382
383
384
385
/* \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
*/
386
387
void UL_failure_indication(module_id_t Mod_id, int CC_id, frame_t frameP,
			   rnti_t rnti, sub_frame_t subframe);
388

knopp's avatar
knopp committed
389
390
391
392
393
394
395
/* \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
*/
396
397
398
void harq_indication(module_id_t mod_idP, int CC_idP, frame_t frameP,
		     sub_frame_t subframeP,
		     nfapi_harq_indication_pdu_t * harq_pdu);
knopp's avatar
knopp committed
399
400
401
402
403
404
405
406
407

/* \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
*/
408
409
410
411
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
412

413
414
uint8_t *get_dlsch_sdu(module_id_t module_idP, int CC_id, frame_t frameP,
		       rnti_t rnti, uint8_t TBindex);
415
416
417
418
419

/* \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
420
@param mcs Pointer to mcs used by PHY (to be filled by MAC)
421
422
@returns Pointer to MCH transport block and mcs for subframe
*/
423
424
MCH_PDU *get_mch_sdu(module_id_t Mod_id, int CC_id, frame_t frame,
		     sub_frame_t subframe);
425
426


427

428
429


430
431
432
433
434
435
436
437
438
439
440
441
442
443
void ue_mac_reset(module_id_t module_idP, uint8_t eNB_index);
void ue_init_mac(module_id_t module_idP);
void init_ue_sched_info(void);
void add_ue_ulsch_info(module_id_t module_idP, int CC_id, int UE_id,
		       sub_frame_t subframe, UE_ULSCH_STATUS status);
void add_ue_dlsch_info(module_id_t module_idP, int CC_id, int UE_id,
		       sub_frame_t subframe, UE_DLSCH_STATUS status);
int find_UE_id(module_id_t module_idP, rnti_t rnti);
int find_RA_id(module_id_t mod_idP, int CC_idP, rnti_t rntiP);
rnti_t UE_RNTI(module_id_t module_idP, int UE_id);
int UE_PCCID(module_id_t module_idP, int UE_id);
uint8_t find_active_UEs(module_id_t module_idP);
boolean_t is_UE_active(module_id_t module_idP, int UE_id);
uint8_t get_aggregation(uint8_t bw_index, uint8_t cqi, uint8_t dci_fmt);
444
445
446

int8_t find_active_UEs_with_traffic(module_id_t module_idP);

447
void init_CCE_table(int module_idP, int CC_idP);
448
449

int get_nCCE_offset(int *CCE_table,
450
451
452
453
		    const unsigned char L,
		    const int nCCE,
		    const int common_dci,
		    const unsigned short rnti,
454
455
		    const unsigned char subframe);

Xu Bo's avatar
Xu Bo committed
456
int allocate_CCEs(int module_idP, int CC_idP, frame_t frameP, sub_frame_t subframeP, int test_only);
457
458

boolean_t CCE_allocation_infeasible(int module_idP,
459
460
461
462
463
464
465
466
				    int CC_idP,
				    int common_flag,
				    int subframe,
				    int aggregation, int rnti);

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

468
uint8_t frame_subframe2_dl_harq_pid(TDD_Config_t *tdd_Config, int abs_frameP, sub_frame_t subframeP);
469
470
471
472
473
474
475
/** \brief First stage of PCH Scheduling. Gets a PCH SDU from RRC if available and computes the MCS required to transport it as a function of the SDU length.  It assumes a length less than or equal to 64 bytes (MCS 6, 3 PRBs).
@param Mod_id Instance ID of eNB
@param frame Frame index
@param subframe Subframe number on which to act
@param paging_ue_index
*/
void schedule_PCH(module_id_t module_idP,frame_t frameP,sub_frame_t subframeP);
476
477
478
479
480

uint8_t find_num_active_UEs_in_cbagroup(module_id_t module_idP,
					unsigned char group_id);
uint8_t UE_is_to_be_scheduled(module_id_t module_idP, int CC_id,
			      uint8_t UE_id);
481
482
483
484
485
/** \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
*/
486
487
module_id_t schedule_next_ulue(module_id_t module_idP, int UE_id,
			       sub_frame_t subframe);
488
489
490
491
492
493

/** \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
*/
494
495
int schedule_next_dlue(module_id_t module_idP, int CC_id,
		       sub_frame_t subframe);
496
497
498
499

/* \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
500
@param N_RB_DL Number of PRBs on DL
501
502
503
@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).
*/
504
505
uint32_t allocate_prbs(int UE_id, uint8_t nb_rb, int N_RB_DL,
		       uint32_t * rballoc);
506
507

/* \fn uint32_t req_new_ulsch(module_id_t module_idP)
508
\brief check for a new transmission in any drb
509
510
511
512
513
514
515
@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
516
@param CC_id Component Carrier index
517
518
519
520
521
@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
*/
522
523
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);
524

525
uint8_t get_ue_weight(module_id_t module_idP, int CC_id, int UE_id);
526
527

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

531
532
void ue_decode_si(module_id_t module_idP, int CC_id, frame_t frame,
		  uint8_t CH_index, void *pdu, uint16_t len);
533

534
535
void ue_decode_p(module_id_t module_idP, int CC_id, frame_t frame,
		 uint8_t CH_index, void *pdu, uint16_t len);
536

537

538
539
540
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);
541

542
543
544
545
546
547
548
549
550
void ue_send_sl_sdu(module_id_t module_idP,
		    uint8_t CC_id,
		    frame_t frameP,
		    sub_frame_t subframeP,
		    uint8_t* sdu,
		    uint16_t sdu_len,
		    uint8_t eNB_index,
	       sl_discovery_flag_t sl_discovery_flag
		    );
551

552
#if (RRC_VERSION >= MAKE_VERSION(10, 0, 0))
553
554
555
556
557
558
559
560
/* \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
*/
561
562
563
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);
564
565
566
567
568
569
570
571
572

/*\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
*/
573
int ue_query_mch(module_id_t Mod_id, uint8_t CC_id, uint32_t frame,
574
575
		 sub_frame_t subframe, uint8_t eNB_index,
		 uint8_t * sync_area, uint8_t * mcch_active);
576
577
578

#endif

579
/* \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.
580
581
582
583
584
@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
*/
585
586
587
588
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);
589

590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
/* \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);

614
615
/* \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
616
@param Mod_id Component Carrier Index
617
618
619
@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 */
620
621
622
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);
623
624
625

/* \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
626
627
628
@param CC_id Index to a component carrier
@param frame Frame index
@param ra_rnti RA_RNTI value
629
630
@param dlsch_buffer  Pointer to dlsch_buffer containing RAR PDU
@param t_crnti Pointer to PHY variable containing the T_CRNTI
631
@param preamble_index Preamble Index used by PHY to transmit the PRACH.  This should match the received RAR to trigger the rest of
632
random-access procedure
633
@param selected_rar_buffer the output buffer for storing the selected RAR header and RAR payload
634
635
@returns timing advance or 0xffff if preamble doesn't match
*/
636
uint16_t
637
638
639
640
641
642
643
644
ue_process_rar(const module_id_t module_idP,
	       const int CC_id,
	       const frame_t frameP,
	       const rnti_t ra_rnti,
	       uint8_t * const dlsch_buffer,
	       rnti_t * const t_crnti,
	       const uint8_t preamble_index,
	       uint8_t * selected_rar_buffer);
645
646
647


/* \brief Generate header for UL-SCH.  This function parses the desired control elements and sdus and generates the header as described
648
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
649
650
651
652
653
654
655
656
657
658
659
660
661
662
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
*/
663
664
665
666
667
668
669
670
671
672
673
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);
674
675

/* \brief Parse header for UL-SCH.  This function parses the received UL-SCH header as described
676
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
677
678
679
680
681
682
683
684
685
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
*/
686
687
688
689
690
691
uint8_t *parse_ulsch_header(uint8_t * mac_header,
			    uint8_t * num_ce,
			    uint8_t * num_sdu,
			    uint8_t * rx_ces,
			    uint8_t * rx_lcids,
			    uint16_t * rx_lengths, uint16_t tx_lenght);
692

knopp's avatar
knopp committed
693
694
int to_prb(int);
int to_rbg(int);
695
int mac_init(void);
696
int add_new_ue(module_id_t Mod_id, int CC_id, rnti_t rnti, int harq_pid
697
#if (RRC_VERSION >= MAKE_VERSION(14, 0, 0))
698
699
700
	       , uint8_t rach_resource_type
#endif
    );
701
int rrc_mac_remove_ue(module_id_t Mod_id, rnti_t rntiP);
702

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

706
707
708
709
710
711
712
int maxround(module_id_t Mod_id, uint16_t rnti, int frame,
	     sub_frame_t subframe, uint8_t ul_flag);
void swap_UEs(UE_list_t * listP, int nodeiP, int nodejP, int ul_flag);
int prev(UE_list_t * listP, int nodeP, int ul_flag);
void dump_ue_list(UE_list_t * listP, int ul_flag);
int UE_num_active_CC(UE_list_t * listP, int ue_idP);
int UE_PCCID(module_id_t mod_idP, int ue_idP);
713
714
rnti_t UE_RNTI(module_id_t mod_idP, int ue_idP);

Xu Bo's avatar
Xu Bo committed
715
uint8_t find_rb_table_index(uint8_t average_rbs);
716

717
718
719
720
721
void set_ul_DAI(int module_idP,
                int UE_idP,
                int CC_idP,
                int frameP,
                int subframeP);
722

723
void ulsch_scheduler_pre_processor(module_id_t module_idP, int slice_idx, int frameP,
724
				   sub_frame_t subframeP,
725
                                   unsigned char sched_subframeP,
726
727
728
729
				   uint16_t * first_rb);
void store_ulsch_buffer(module_id_t module_idP, int frameP,
			sub_frame_t subframeP);
void sort_ue_ul(module_id_t module_idP, int frameP, sub_frame_t subframeP);
730
void assign_max_mcs_min_rb(module_id_t module_idP, int slice_idx, int frameP,
731
732
733
			   sub_frame_t subframeP, uint16_t * first_rb);
void adjust_bsr_info(int buffer_occupancy, uint16_t TBS,
		     UE_TEMPLATE * UE_template);
734

735
int phy_stats_exist(module_id_t Mod_id, int rnti);
736
void sort_UEs(module_id_t Mod_idP, int slice_idx, int frameP, sub_frame_t subframeP);
737

738
/*! \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)
739
   \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.
740
\param[in] module_idP instance of the UE
741
742
743
744
\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
745
746
747
748
\param[in] direction  subframe direction
\param[in] eNB_index  instance of eNB
@returns L2 state (CONNETION_OK or CONNECTION_LOST or PHY_RESYNCH)
*/
749
750
751
752
753
754
755
UE_L2_STATE_t ue_scheduler(const module_id_t module_idP,
			   const frame_t rxFrameP,
			   const sub_frame_t rxSubframe,
			   const frame_t txFrameP,
			   const sub_frame_t txSubframe,
			   const lte_subframe_t direction,
			   const uint8_t eNB_index, const int CC_id);
756

757
/*! \fn  int cba_access(module_id_t module_idP,frame_t frameP,sub_frame_t subframe, uint8_t eNB_index,uint16_t buflen);
758
759
760
761
762
\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
763
\param[out] access(1) or postpone (0)
764
*/
765
766
int cba_access(module_id_t module_idP, frame_t frameP,
	       sub_frame_t subframe, uint8_t eNB_index, uint16_t buflen);
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781

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

fnabet's avatar
fnabet committed
784
/*! \fn  boolean_t update_bsr(module_id_t module_idP, frame_t frameP,sub_frame_t subframeP)
785
   \brief get the rlc stats and update the bsr level for each lcid
786
787
788
\param[in] Mod_id instance of the UE
\param[in] frame Frame index
*/
789
790
boolean_t update_bsr(module_id_t module_idP, frame_t frameP,
		     sub_frame_t subframeP, eNB_index_t eNB_index);
791

fnabet's avatar
fnabet committed
792
/*! \fn  locate_BsrIndexByBufferSize (int *table, int size, int value)
793
   \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.
794
795
\param[in] *table Pointer to BSR table
\param[in] size Size of the table
796
\param[in] value Value of the buffer
797
798
\return the index in the BSR_LEVEL table
*/
799
800
uint8_t locate_BsrIndexByBufferSize(const uint32_t * table, int size,
				    int value);
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
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
843
844


/*! \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
845
/*! \fn  uint8_t get_phr_mapping (module_id_t module_idP, int CC_id,uint8_t eNB_index)
846
847
   \brief get phr mapping as described in 36.313
\param[in]  Mod_id index of eNB
knopp's avatar
   
knopp committed
848
\param[in] CC_id Component Carrier Index
849
850
\return phr mapping
*/
851
852
uint8_t get_phr_mapping(module_id_t module_idP, int CC_id,
			uint8_t eNB_index);
853
854
855
856

/*! \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
857
\param[in] CC_id Component carrier index
858
859
\return void
*/
860
void update_phr(module_id_t module_idP, int CC_id);
861
862
863
864
865

/*! \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
*/
866
867
void Msg3_tx(module_id_t module_idP, uint8_t CC_id, frame_t frameP,
	     uint8_t eNB_id);
868
869
870
871
872
873
874


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

875
876
void Msg1_tx(module_id_t module_idP, uint8_t CC_id, frame_t frameP,
	     uint8_t eNB_id);
877

878
879
880
void dl_phy_sync_success(module_id_t module_idP,
			 frame_t frameP,
			 unsigned char eNB_index, uint8_t first_sync);
881
882
883
884
885

int dump_eNB_l2_stats(char *buffer, int length);

double uniform_rngen(int min, int max);

886
/*
887
void add_common_dci(DCI_PDU *DCI_pdu,
888
889
890
891
892
893
894
                    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);
895
*/
896

897
898
uint32_t allocate_prbs_sub(int nb_rb, int N_RB_DL, int N_RBG,
			   uint8_t * rballoc);
899

900
void update_ul_dci(module_id_t module_idP, uint8_t CC_id, rnti_t rnti,
jftt_wangshanshan's avatar
jftt_wangshanshan committed
901
		   uint8_t dai, sub_frame_t subframe);
902

903
904
int get_bw_index(module_id_t module_id, uint8_t CC_id);

905
906
int get_min_rb_unit(module_id_t module_idP, uint8_t CC_id);

907
/* \brief Generate header for DL-SCH.  This function parses the desired control elements and sdus and generates the header as described
908
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
909
910
911
912
913
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)
914
@param drx_cmd dicontinous reception command
915
916
917
@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)
918
@param post_padding number of bytes for padding at the end of MAC PDU
919
920
@returns Number of bytes used for header
*/
921
922
923
924
925
926
927
928
929
int generate_dlsch_header(unsigned char *mac_header,
                          unsigned char num_sdus,
                          unsigned short *sdu_lengths,
                          unsigned char *sdu_lcids,
                          unsigned char drx_cmd,
                          unsigned short timing_advance_cmd,
                          unsigned char *ue_cont_res_id,
                          unsigned char short_padding,
                          unsigned short post_padding);
930

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

936
@param radioResourceConfigCommon Structure from SIB2 for common radio parameters (if NULL keep existing configuration)
937
@param physicalConfigDedicated Structure from RRCConnectionSetup or RRCConnectionReconfiguration for dedicated PHY parameters (if NULL keep existing configuration)
938
939
@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)
940
@param logicalChannelIdentity Logical channel identity index of corresponding logical channel config
941
942
943
944
@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
945
@param SchedInfoList SI Scheduling information
946
947
948
949
@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)
950
@param sib1_ext_r13 SI Scheduling information for SI-BR UEs         
951
*/
952

953
954
955
956
957
958
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,
959
#if (RRC_VERSION >= MAKE_VERSION(14, 0, 0))
960
			   int pbch_repetition,
961
#endif
962
963
964
965
			   rnti_t rntiP,
			   BCCH_BCH_Message_t * mib,
			   RadioResourceConfigCommonSIB_t *
			   radioResourceConfigCommon,
966
#if (RRC_VERSION >= MAKE_VERSION(14, 0, 0))
967
968
			   RadioResourceConfigCommonSIB_t *
			   radioResourceConfigCommon_BR,
969
#endif
970
971
			   struct PhysicalConfigDedicated
			   *physicalConfigDedicated,
972
#if (RRC_VERSION >= MAKE_VERSION(10, 0, 0))
973
			   SCellToAddMod_r10_t * sCellToAddMod_r10,
974
			   //struct PhysicalConfigDedicatedSCell_r10 *physicalConfigDedicatedSCell_r10,
975
#endif
976
977
978
979
980
981
982
983
984
985
986
987
988
989
			   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
990
#if (RRC_VERSION >= MAKE_VERSION(9, 0, 0))
991
			   ,
992
993
994
			   uint8_t MBMS_Flag,
			   MBSFN_AreaInfoList_r9_t * mbsfn_AreaInfoList,
			   PMCH_InfoList_r9_t * pmch_InfoList
995
#endif
996
#if (RRC_VERSION >= MAKE_VERSION(13, 0, 0))
997
			   ,
998
999
			   SystemInformationBlockType1_v1310_IEs_t *
			   sib1_ext_r13
1000
#endif
1001
    );
1002

1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
/** \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)
*/
1023
1024
1025
1026
1027
1028
1029
int rrc_mac_config_req_ue(module_id_t module_idP,
			  int CC_id,
			  uint8_t eNB_index,
			  RadioResourceConfigCommonSIB_t *
			  radioResourceConfigCommon,
			  struct PhysicalConfigDedicated
			  *physicalConfigDedicated,
1030
#if (RRC_VERSION >= MAKE_VERSION(10, 0, 0))
1031
			  SCellToAddMod_r10_t * sCellToAddMod_r10,
1032
1033
			  //struct PhysicalConfigDedicatedSCell_r10 *physicalConfigDedicatedSCell_r10,
#endif
1034
1035
			  MeasObjectToAddMod_t ** measObj,
			  MAC_MainConfig_t * mac_MainConfig,
1036
			  long logicalChannelIdentity,
1037
1038
1039
1040
1041
1042
1043
			  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,
1044
			  long *ul_Bandwidth,
1045
1046
1047
1048
			  AdditionalSpectrumEmission_t *
			  additionalSpectrumEmission,
			  struct MBSFN_SubframeConfigList
			  *mbsfn_SubframeConfigList
1049
#if (RRC_VERSION >= MAKE_VERSION(10, 0, 0))
1050
1051
			  ,
			  uint8_t MBMS_Flag,
1052
1053
			  MBSFN_AreaInfoList_r9_t * mbsfn_AreaInfoList,
			  PMCH_InfoList_r9_t * pmch_InfoList
1054
1055
1056
#endif
#ifdef CBA
			  ,
1057
			  uint8_t num_active_cba_groups, uint16_t cba_rnti
1058
#endif
1059
1060
1061
1062
#if (RRC_VERSION >= MAKE_VERSION(14, 0, 0))
			  ,config_action_t config_action
			  ,const uint32_t * const sourceL2Id
			  ,const uint32_t * const destinationL2Id
1063
1064
1065
#endif
			  );

1066

1067
uint16_t getRIV(uint16_t N_RB_DL, uint16_t RBstart, uint16_t Lcrbs);
1068

1069
int get_subbandsize(uint8_t dl_bandwidth);
1070

1071

1072
void get_Msg3allocret(COMMON_channels_t * cc,
1073
1074
		      sub_frame_t current_subframe,
		      frame_t current_frame,
1075
		      frame_t * frame, sub_frame_t * subframe);
1076

1077
void get_Msg3alloc(COMMON_channels_t * cc,
1078
1079
		   sub_frame_t current_subframe,
		   frame_t current_frame,
1080
		   frame_t * frame, sub_frame_t * subframe);
1081

1082
1083
uint16_t mac_computeRIV(uint16_t N_RB_DL, uint16_t RBstart,
			uint16_t Lcrbs);
1084

1085
int get_phich_resource_times6(COMMON_channels_t * cc);
1086

1087
1088
1089
1090
1091
1092
uint8_t frame_subframe2_dl_harq_pid(TDD_Config_t *tdd_Config, int abs_frameP, sub_frame_t subframeP);

uint8_t ul_subframe2_k_phich(COMMON_channels_t * cc, sub_frame_t ul_subframe);

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

1093
1094