mac_proto.h 16.4 KB
Newer Older
ChenWeiTai's avatar
ChenWeiTai committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
/*
 * Licensed to the OpenAirInterface (OAI) Software Alliance under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The OpenAirInterface Software Alliance licenses this file to You under
 * the OAI Public License, Version 1.1  (the "License"); you may not use this file
 * except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.openairinterface.org/?page_id=698
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *-------------------------------------------------------------------------------
 * For more information about the OpenAirInterface (OAI) Software Alliance:
 *      contact@openairinterface.org
 */

/*! \file mac_proto.h
 * \brief MAC functions prototypes for gNB
 * \author Navid Nikaein and Raymond Knopp, WEI-TAI CHEN
 * \date 2010 - 2014, 2018
 * \email navid.nikaein@eurecom.fr, kroempa@gmail.com
 * \version 1.0
 * \company Eurecom, NTUST
 */
30
31
32
33

#ifndef __LAYER2_NR_MAC_PROTO_H__
#define __LAYER2_NR_MAC_PROTO_H__

34
#include "PHY/defs_gNB.h"
35
36

#include "LAYER2/NR_MAC_gNB/nr_mac_gNB.h"
37
#include "NR_TAG-Id.h"
38

39
40
void set_cset_offset(uint16_t);

41
42
void mac_top_init_gNB(void);

43
void config_common(int Mod_idP,
44
                   int ssb_SubcarrierOffset,
45
                   int pdsch_AntennaPorts,
46
                   int pusch_AntennaPorts,
47
48
		   NR_ServingCellConfigCommon_t *scc
		   );
49

50
51
int rrc_mac_config_req_gNB(module_id_t Mod_idP,
                           int ssb_SubcarrierOffset,
52
                           int pdsch_AntennaPorts,
53
                           int pusch_AntennaPorts,
54
55
                           int pusch_tgt_snrx10,
                           int pucch_tgt_snrx10,
56
57
58
59
                           NR_ServingCellConfigCommon_t *scc,
			   int nsa_flag,
			   uint32_t rnti,
			   NR_CellGroupConfig_t *secondaryCellGroup
60
                           );
ChenWeiTai's avatar
ChenWeiTai committed
61

62
63
64
65
void clear_nr_nfapi_information(gNB_MAC_INST * gNB, 
                                int CC_idP,
                                frame_t frameP, 
                                sub_frame_t subframeP);
ChenWeiTai's avatar
ChenWeiTai committed
66

67
68
void gNB_dlsch_ulsch_scheduler(module_id_t module_idP,
			       frame_t frame_rxP, sub_frame_t slot_rxP);
69

70
71
void nr_schedule_ue_spec(module_id_t module_id,
                         frame_t frame,
72
73
                         sub_frame_t slot,
                         uint8_t nrOfLayers);
74

75
76
void schedule_control_sib1(module_id_t module_id,
                           int CC_id,
77
                           NR_Type0_PDCCH_CSS_config_t *type0_PDCCH_CSS_config,
78
79
80
                           int time_domain_allocation,
                           uint8_t mcsTableIdx,
                           uint8_t mcs,
81
                           uint8_t candidate_idx,
82
83
84
                           int num_total_bytes);

void schedule_nr_sib1(module_id_t module_idP, frame_t frameP, sub_frame_t subframeP);
Roberto Louro Magueta's avatar
Roberto Louro Magueta committed
85

86
87
88
/* \brief default preprocessor */
void nr_simple_dlsch_preprocessor(module_id_t module_id,
                                  frame_t frame,
89
                                  sub_frame_t slot);
90

Francesco Mani's avatar
Francesco Mani committed
91
92
93
94
95
void schedule_nr_mib(module_id_t module_idP,
                     frame_t frameP,
                     sub_frame_t subframeP,
                     uint8_t slots_per_frame,
                     int nb_periods_per_frame);
ChenWeiTai's avatar
ChenWeiTai committed
96

97
98
99
100
101
102
103
104
/// uplink scheduler
void nr_schedule_ulsch(module_id_t module_id,
                       frame_t frame,
                       sub_frame_t slot,
                       int num_slots_per_tdd,
                       int ul_slots,
                       uint64_t ulsch_in_slot_bitmap);

105
bool nr_simple_ulsch_preprocessor(module_id_t module_id,
106
107
108
109
110
                                  frame_t frame,
                                  sub_frame_t slot,
                                  int num_slots_per_tdd,
                                  uint64_t ulsch_in_slot_bitmap);

111
112
113
114
115
116
117
118
119
120
121
122
/////// Random Access MAC-PHY interface functions and primitives ///////

void nr_schedule_RA(module_id_t module_idP, frame_t frameP, sub_frame_t slotP);

/* \brief Function to indicate a received preamble on PRACH.  It initiates the RA procedure.
@param module_idP Instance ID of gNB
@param preamble_index index of the received RA request
@param slotP Slot number on which to act
@param timing_offset Offset in samples of the received PRACH w.r.t. eNB timing. This is used to
@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)
*/
123
124
void nr_initiate_ra_proc(module_id_t module_idP, int CC_id, frame_t frameP, sub_frame_t slotP,
                         uint16_t preamble_index, uint8_t freq_index, uint8_t symbol, int16_t timing_offset);
125

126
void nr_clear_ra_proc(module_id_t module_idP, int CC_id, frame_t frameP, NR_RA_t *ra);
127
128
129

int nr_allocate_CCEs(int module_idP, int CC_idP, frame_t frameP, sub_frame_t slotP, int test_only);

130
131
132
void nr_get_Msg3alloc(module_id_t module_id,
                      int CC_id,
                      NR_ServingCellConfigCommon_t *scc,
Francesco Mani's avatar
Francesco Mani committed
133
                      NR_BWP_Uplink_t *ubwp,
134
                      sub_frame_t current_subframe,
135
                      frame_t current_frame,
136
137
                      NR_RA_t *ra,
                      int16_t *tdd_beam_association);
138

Guido Casati's avatar
Guido Casati committed
139
140
141
/* \brief Function in gNB to fill RAR pdu when requested by PHY.
@param ra Instance of RA resources of gNB
@param dlsch_buffer Pointer to RAR input buffer
142
143
@param N_RB_UL Number of UL resource blocks
*/
144
145
void nr_fill_rar(uint8_t Mod_idP,
                 NR_RA_t * ra,
Guido Casati's avatar
Guido Casati committed
146
                 uint8_t * dlsch_buffer,
Francesco Mani's avatar
Francesco Mani committed
147
                 nfapi_nr_pusch_pdu_t  *pusch_pdu);
148
149


150
151
void schedule_nr_prach(module_id_t module_idP, frame_t frameP, sub_frame_t slotP);

152
153
154
155
uint16_t nr_mac_compute_RIV(uint16_t N_RB_DL, uint16_t RBstart, uint16_t Lcrbs);

/////// Phy test scheduler ///////

Robert Schmidt's avatar
Robert Schmidt committed
156
157
158
159
/* \brief preprocessor for phytest: schedules UE_id 0 with fixed MCS on all
 * freq resources */
void nr_preprocessor_phytest(module_id_t module_id,
                             frame_t frame,
160
                             sub_frame_t slot);
161
162
/* \brief UL preprocessor for phytest: schedules UE_id 0 with fixed MCS on a
 * fixed set of resources */
163
bool nr_ul_preprocessor_phytest(module_id_t module_id,
164
165
166
167
                                frame_t frame,
                                sub_frame_t slot,
                                int num_slots_per_tdd,
                                uint64_t ulsch_in_slot_bitmap);
Robert Schmidt's avatar
Robert Schmidt committed
168

knopp's avatar
knopp committed
169
170
171
172
void nr_schedule_css_dlsch_phytest(module_id_t   module_idP,
                                   frame_t       frameP,
                                   sub_frame_t   subframeP);

173
174
175
176
177
178
179
180
181
void handle_nr_uci_pucch_0_1(module_id_t mod_id,
                             frame_t frame,
                             sub_frame_t slot,
                             const nfapi_nr_uci_pucch_pdu_format_0_1_t *uci_01);
void handle_nr_uci_pucch_2_3_4(module_id_t mod_id,
                               frame_t frame,
                               sub_frame_t slot,
                               const nfapi_nr_uci_pucch_pdu_format_2_3_4_t *uci_234);

182

183
184
void config_uldci(const NR_BWP_Uplink_t *ubwp,
                  const nfapi_nr_pusch_pdu_t *pusch_pdu,
185
                  dci_pdu_rel15_t *dci_pdu_rel15,
186
187
188
189
190
                  int dci_format,
                  int time_domain_assignment,
                  uint8_t tpc,
                  int n_ubwp,
                  int bwp_id);
191

192
193
194
195
void nr_schedule_pucch(int Mod_idP,
                       frame_t frameP,
                       sub_frame_t slotP);

196
void csi_period_offset(const NR_CSI_ReportConfig_t *csirep,
197
198
                       int *period, int *offset);

199
200
void nr_csi_meas_reporting(int Mod_idP,
                           frame_t frameP,
201
                           sub_frame_t slotP);
202

203
bool nr_acknack_scheduling(int Mod_idP,
204
205
                           int UE_id,
                           frame_t frameP,
206
                           sub_frame_t slotP);
Francesco Mani's avatar
Francesco Mani committed
207
208
209
210
211

void get_pdsch_to_harq_feedback(int Mod_idP,
                                int UE_id,
                                NR_SearchSpace__searchSpaceType_PR ss_type,
                                uint8_t *pdsch_to_harq_feedback);
212
  
knopp's avatar
knopp committed
213
void nr_configure_css_dci_initial(nfapi_nr_dl_tti_pdcch_pdu_rel15_t* pdcch_pdu,
214
215
216
217
218
219
220
221
222
223
                                  nr_scs_e scs_common,
                                  nr_scs_e pdcch_scs,
                                  nr_frequency_range_e freq_range,
                                  uint8_t rmsi_pdcch_config,
                                  uint8_t ssb_idx,
                                  uint8_t k_ssb,
                                  uint16_t sfn_ssb,
                                  uint8_t n_ssb,
                                  uint16_t nb_slots_per_frame,
                                  uint16_t N_RB);
224
/*
225
int nr_is_dci_opportunity(nfapi_nr_search_space_t search_space,
226
227
228
                          nfapi_nr_coreset_t coreset,
                          uint16_t frame,
                          uint16_t slot,
229
                          nfapi_nr_config_request_scf_t cfg);
230
*/
knopp's avatar
knopp committed
231

232
233
void nr_configure_pucch(nfapi_nr_pucch_pdu_t* pucch_pdu,
			NR_ServingCellConfigCommon_t *scc,
234
			NR_BWP_Uplink_t *bwp,
235
                        uint16_t rnti,
236
                        uint8_t pucch_resource,
237
                        uint16_t O_csi,
238
                        uint16_t O_ack,
239
                        uint8_t O_sr);
Francesco Mani's avatar
Francesco Mani committed
240

241
242
243
244
void find_search_space(int ss_type,
                       NR_BWP_Downlink_t *bwp,
                       NR_SearchSpace_t *ss);

245
void nr_configure_pdcch(nfapi_nr_dl_tti_pdcch_pdu_rel15_t *pdcch_pdu,
246
247
248
                        NR_SearchSpace_t *ss,
                        NR_ControlResourceSet_t *coreset,
                        NR_ServingCellConfigCommon_t *scc,
249
                        NR_BWP_Downlink_t *bwp);
knopp's avatar
knopp committed
250

251
252
253
void fill_dci_pdu_rel15(const NR_ServingCellConfigCommon_t *scc,
                        const NR_CellGroupConfig_t *secondaryCellGroup,
                        nfapi_nr_dl_dci_pdu_t *pdcch_dci_pdu,
254
                        dci_pdu_rel15_t *dci_pdu_rel15,
255
256
                        int dci_formats,
                        int rnti_types,
257
                        int N_RB,
Francesco Mani's avatar
Francesco Mani committed
258
259
                        int bwp_id);

260
void prepare_dci(const NR_CellGroupConfig_t *secondaryCellGroup,
Francesco Mani's avatar
Francesco Mani committed
261
262
263
                 dci_pdu_rel15_t *dci_pdu_rel15,
                 nr_dci_format_t format,
                 int bwp_id);
264

265
266
267
268
269
270
271
272
273
274
/* find coreset within the search space */
NR_ControlResourceSet_t *get_coreset(NR_BWP_Downlink_t *bwp,
                                     NR_SearchSpace_t *ss,
                                     int ss_type);

/* find a search space within a BWP */
NR_SearchSpace_t *get_searchspace(
    NR_BWP_Downlink_t *bwp,
    NR_SearchSpace__searchSpaceType_PR target_ss);

275
276
long get_K2(NR_BWP_Uplink_t *ubwp, int time_domain_assignment, int mu);

277
278
279
280
281
282
283
void nr_save_pusch_fields(const NR_ServingCellConfigCommon_t *scc,
                          const NR_BWP_Uplink_t *ubwp,
                          long dci_format,
                          int tda,
                          uint8_t num_dmrs_cdm_grps_no_data,
                          NR_sched_pusch_save_t *ps);

284
285
uint8_t nr_get_tpc(int target, uint8_t cqi, int incr);

286
int get_spf(nfapi_nr_config_request_scf_t *cfg);
287

288
int to_absslot(nfapi_nr_config_request_scf_t *cfg,int frame,int slot);
289

knopp's avatar
knopp committed
290
void nr_get_tbs_dl(nfapi_nr_dl_tti_pdsch_pdu *pdsch_pdu,
291
		   int x_overhead,
292
                   uint8_t numdmrscdmgroupnodata,
293
                   uint8_t tb_scaling);
knopp's avatar
knopp committed
294
295
296
297
298
299
300
/** \brief Computes Q based on I_MCS PDSCH and table_idx for downlink. Implements MCS Tables from 38.214. */
uint8_t nr_get_Qm_dl(uint8_t Imcs, uint8_t table_idx);
uint32_t nr_get_code_rate_dl(uint8_t Imcs, uint8_t table_idx);

/** \brief Computes Q based on I_MCS PDSCH and table_idx for uplink. Implements MCS Tables from 38.214. */
uint8_t nr_get_Qm_ul(uint8_t Imcs, uint8_t table_idx);
uint32_t nr_get_code_rate_ul(uint8_t Imcs, uint8_t table_idx);
301
302
303
304
305

int NRRIV2BW(int locationAndBandwidth,int N_RB);

int NRRIV2PRBOFFSET(int locationAndBandwidth,int N_RB);

306
307
308
309
310
311
312
313
314
/* Functions to manage an NR_list_t */
void dump_nr_list(NR_list_t *listP);
void create_nr_list(NR_list_t *listP, int len);
void destroy_nr_list(NR_list_t *list);
void add_nr_list(NR_list_t *listP, int id);
void remove_nr_list(NR_list_t *listP, int id);
void add_tail_nr_list(NR_list_t *listP, int id);
void add_front_nr_list(NR_list_t *listP, int id);
void remove_front_nr_list(NR_list_t *listP);
315

316
int find_nr_UE_id(module_id_t mod_idP, rnti_t rntiP);
317

RAJU K N's avatar
RAJU K N committed
318
319
int find_nr_RA_id(module_id_t mod_idP, int CC_idP, rnti_t rntiP);

320
int add_new_nr_ue(module_id_t mod_idP, rnti_t rntiP, NR_CellGroupConfig_t *secondaryCellGroup);
321

Cedric Roux's avatar
Cedric Roux committed
322
323
void mac_remove_nr_ue(module_id_t mod_id, rnti_t rnti);

324
void nr_mac_remove_ra_rnti(module_id_t mod_id, rnti_t rnti);
325

326
int allocate_nr_CCEs(gNB_MAC_INST *nr_mac,
327
328
                     NR_BWP_Downlink_t *bwp,
                     NR_ControlResourceSet_t *coreset,
329
                     int aggregation,
330
331
332
                     uint16_t Y,
                     int m,
                     int nr_of_candidates);
333

334
335
336
337
338
339
340
341
342
uint16_t compute_pucch_prb_size(uint8_t format,
                                uint8_t nr_prbs,
                                uint16_t O_tot,
                                uint16_t O_csi,
                                NR_PUCCH_MaxCodeRate_t *maxCodeRate,
                                uint8_t Qm,
                                uint8_t n_symb,
                                uint8_t n_re_ctrl);

Karey Rangaswami's avatar
Karey Rangaswami committed
343
void compute_csi_bitlen(NR_CSI_MeasConfig_t *csi_MeasConfig, NR_UE_info_t *UE_info, int UE_id, module_id_t Mod_idP);
344

345
346
347
348
349
350
int get_dlscs(nfapi_nr_config_request_t *cfg);

int get_ulscs(nfapi_nr_config_request_t *cfg);

int get_symbolsperslot(nfapi_nr_config_request_t *cfg);

351
void config_nr_mib(int Mod_idP, 
352
353
354
355
356
357
358
359
                   int CC_idP,
                   int p_gNBP,
                   int subCarrierSpacingCommon,
                   uint32_t ssb_SubcarrierOffset,
                   int dmrs_TypeA_Position,
                   uint32_t pdcch_ConfigSIB1,
                   int cellBarred,
                   int intraFreqReselection);
360

361
362
363
364
365
int nr_write_ce_dlsch_pdu(module_id_t module_idP,
                          const NR_UE_sched_ctrl_t *ue_sched_ctl,
                          unsigned char *mac_pdu,
                          unsigned char drx_cmd,
                          unsigned char *ue_cont_res_id);
366

367
void nr_generate_Msg2(module_id_t module_idP, int CC_id, frame_t frameP, sub_frame_t slotP, NR_RA_t *ra);
368

369
void nr_generate_Msg4(module_id_t module_idP, int CC_id, frame_t frameP, sub_frame_t slotP, NR_RA_t *ra);
370

371
void nr_check_Msg4_Ack(module_id_t module_id, int CC_id, frame_t frame, sub_frame_t slot, NR_RA_t *ra);
372

373
374
void nr_process_mac_pdu(
    module_id_t module_idP,
375
    rnti_t rnti,
376
377
378
379
    uint8_t CC_id,
    frame_t frameP,
    uint8_t *pduP,
    uint16_t mac_pdu_len);
380

381
382
int binomial(int n, int k);

383
384
bool is_xlsch_in_slot(uint64_t bitmap, sub_frame_t slot);

385
void fill_ssb_vrb_map (NR_COMMON_channels_t *cc, int rbStart, uint16_t symStart, int CC_id);
386

387

388
389
390
391
392
393
394
395
396
397
/* \brief Function to indicate a received SDU on ULSCH.
@param Mod_id Instance ID of gNB
@param CC_id Component carrier index
@param rnti RNTI of UE transmitting the SDU
@param sdu Pointer to received SDU
@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)
*/
void nr_rx_sdu(const module_id_t gnb_mod_idP,
398
399
400
401
402
403
               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,
404
405
406
               const uint16_t timing_advance,
               const uint8_t ul_cqi,
               const uint16_t rssi);
407

408
409
410
411
void handle_nr_ul_harq(module_id_t mod_id,
                       frame_t frame,
                       sub_frame_t slot,
                       const nfapi_nr_crc_t *crc_pdu);
412

RAJU K N's avatar
RAJU K N committed
413
414
int16_t ssb_index_from_prach(module_id_t module_idP,
                             frame_t frameP,
415
			     sub_frame_t slotP,
RAJU K N's avatar
RAJU K N committed
416
417
418
419
420
421
                             uint16_t preamble_index,
                             uint8_t freq_index,
                             uint8_t symbol);

void find_SSB_and_RO_available(module_id_t module_idP);

ChiehChun's avatar
ChiehChun committed
422
bool find_free_CCE(module_id_t module_id, sub_frame_t slot, int UE_id);
423
#endif /*__LAYER2_NR_MAC_PROTO_H__*/