mac_proto.h 17 KB
Newer Older
WEI-TAI CHEN's avatar
WEI-TAI CHEN 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 pdsch_AntennaPorts,
45 46
		   NR_ServingCellConfigCommon_t *scc
		   );
47

48
int rrc_mac_config_req_gNB(module_id_t Mod_idP, 
49
			   int ssb_SubcarrierOffset,
50
                           int pdsch_AntennaPorts,
51 52
                           int pusch_tgt_snrx10,
                           int pucch_tgt_snrx10,
53 54 55 56
                           NR_ServingCellConfigCommon_t *scc,
			   int nsa_flag,
			   uint32_t rnti,
			   NR_CellGroupConfig_t *secondaryCellGroup
57
                           );
WEI-TAI CHEN's avatar
WEI-TAI CHEN committed
58

59 60 61 62
void clear_nr_nfapi_information(gNB_MAC_INST * gNB, 
                                int CC_idP,
                                frame_t frameP, 
                                sub_frame_t subframeP);
WEI-TAI CHEN's avatar
WEI-TAI CHEN committed
63

64 65
void gNB_dlsch_ulsch_scheduler(module_id_t module_idP,
			       frame_t frame_rxP, sub_frame_t slot_rxP);
66

67
int nr_generate_dlsch_pdu(module_id_t Mod_idP,
68
                          NR_UE_sched_ctrl_t *ue_sched_ctl,
69
                          unsigned char *sdus_payload,
70 71 72 73 74 75 76 77
                          unsigned char *mac_pdu,
                          unsigned char num_sdus,
                          unsigned short *sdu_lengths,
                          unsigned char *sdu_lcids,
                          unsigned char drx_cmd,
                          unsigned char *ue_cont_res_id,
                          unsigned short post_padding);

78 79 80 81
void nr_schedule_ue_spec(module_id_t module_id,
                         frame_t frame,
                         sub_frame_t slot,
                         int num_slots_per_tdd);
82

83 84 85 86 87 88 89 90
void schedule_control_sib1(module_id_t module_id,
                           int CC_id,
                           int time_domain_allocation,
                           uint8_t mcsTableIdx,
                           uint8_t mcs,
                           int num_total_bytes);

void schedule_nr_sib1(module_id_t module_idP, frame_t frameP, sub_frame_t subframeP);
rmagueta's avatar
rmagueta committed
91

92 93 94 95 96 97
/* \brief default preprocessor */
void nr_simple_dlsch_preprocessor(module_id_t module_id,
                                  frame_t frame,
                                  sub_frame_t slot,
                                  int num_slots_per_tdd);

98
void schedule_nr_mib(module_id_t module_idP, frame_t frameP, sub_frame_t subframeP, uint8_t slots_per_frame);
WEI-TAI CHEN's avatar
WEI-TAI CHEN committed
99

100 101 102 103 104 105 106 107
/// 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);

108 109 110 111 112 113
void nr_simple_ulsch_preprocessor(module_id_t module_id,
                                  frame_t frame,
                                  sub_frame_t slot,
                                  int num_slots_per_tdd,
                                  uint64_t ulsch_in_slot_bitmap);

114 115 116 117 118 119 120 121 122 123 124 125
/////// 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)
*/
126 127
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);
128 129 130 131 132

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

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

133 134 135
void nr_get_Msg3alloc(module_id_t module_id,
                      int CC_id,
                      NR_ServingCellConfigCommon_t *scc,
136
                      NR_BWP_Uplink_t *ubwp,
137
                      sub_frame_t current_subframe,
138 139
                      frame_t current_frame,
                      NR_RA_t *ra);
140

cig's avatar
cig committed
141 142 143
/* \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
144 145
@param N_RB_UL Number of UL resource blocks
*/
146 147
void nr_fill_rar(uint8_t Mod_idP,
                 NR_RA_t * ra,
cig's avatar
cig committed
148
                 uint8_t * dlsch_buffer,
149
                 nfapi_nr_pusch_pdu_t  *pusch_pdu);
150 151


152 153
void schedule_nr_prach(module_id_t module_idP, frame_t frameP, sub_frame_t slotP);

154 155 156 157
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
158 159 160 161 162 163
/* \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,
                             sub_frame_t slot,
                             int num_slots_per_tdd);
164 165 166 167 168 169 170
/* \brief UL preprocessor for phytest: schedules UE_id 0 with fixed MCS on a
 * fixed set of resources */
void nr_ul_preprocessor_phytest(module_id_t module_id,
                                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
171

Raymond Knopp's avatar
Raymond Knopp committed
172 173 174 175
void nr_schedule_css_dlsch_phytest(module_id_t   module_idP,
                                   frame_t       frameP,
                                   sub_frame_t   subframeP);

176 177
void nr_fill_nfapi_dl_pdu(int Mod_id,
                          nfapi_nr_dl_tti_request_body_t *dl_req,
178 179 180
                          rnti_t rnti,
                          NR_CellGroupConfig_t *secondaryCellGroup,
                          NR_UE_sched_ctrl_t *sched_ctrl,
181 182 183 184 185 186
                          NR_sched_pucch *pucch_sched,
                          nfapi_nr_dmrs_type_e dmrsConfigType,
                          uint16_t R,
                          uint8_t Qm,
                          uint32_t tbs,
                          int StartSymbolIndex,
187
                          int NrOfSymbols,
188 189 190
                          int harq_pid,
                          int ndi,
                          int round);
Raymond Knopp's avatar
Raymond Knopp committed
191

192 193 194 195 196 197 198 199 200
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);

201

202 203 204 205
void config_uldci(NR_BWP_Uplink_t *ubwp,
                  nfapi_nr_pusch_pdu_t *pusch_pdu,
                  nfapi_nr_dl_tti_pdcch_pdu_rel15_t *pdcch_pdu_rel15,
                  dci_pdu_rel15_t *dci_pdu_rel15,
206
                  int *dci_formats,
207
                  int time_domain_assignment, uint8_t tpc,
208
                  int n_ubwp, int bwp_id);
209

210 211 212 213 214 215
void nr_schedule_pucch(int Mod_idP,
                       int UE_id,
                       int nr_ulmix_slots,
                       frame_t frameP,
                       sub_frame_t slotP);

216 217 218
void csi_period_offset(NR_CSI_ReportConfig_t *csirep,
                       int *period, int *offset);

219 220 221 222
void nr_csi_meas_reporting(int Mod_idP,
                           int UE_id,
                           frame_t frameP,
                           sub_frame_t slotP,
223 224
                           int slots_per_tdd,
                           int ul_slots,
225 226 227 228 229 230 231
                           int n_slots_frame);

void nr_acknack_scheduling(int Mod_idP,
                           int UE_id,
                           frame_t frameP,
                           sub_frame_t slotP,
                           int slots_per_tdd,
232 233 234
                           int *pucch_id,
                           int *pucch_occ);

235
int get_pucch_resource(NR_UE_info_t *UE_info,int UE_id,int k,int l);
Francesco Mani's avatar
Francesco Mani committed
236 237 238 239 240

void get_pdsch_to_harq_feedback(int Mod_idP,
                                int UE_id,
                                NR_SearchSpace__searchSpaceType_PR ss_type,
                                uint8_t *pdsch_to_harq_feedback);
241
  
Raymond Knopp's avatar
Raymond Knopp committed
242
void nr_configure_css_dci_initial(nfapi_nr_dl_tti_pdcch_pdu_rel15_t* pdcch_pdu,
243 244 245 246 247 248 249 250 251 252
                                  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);
253
/*
254
int nr_is_dci_opportunity(nfapi_nr_search_space_t search_space,
255 256 257
                          nfapi_nr_coreset_t coreset,
                          uint16_t frame,
                          uint16_t slot,
258
                          nfapi_nr_config_request_scf_t cfg);
259
*/
Raymond Knopp's avatar
Raymond Knopp committed
260

261 262
void nr_configure_pucch(nfapi_nr_pucch_pdu_t* pucch_pdu,
			NR_ServingCellConfigCommon_t *scc,
263
			NR_BWP_Uplink_t *bwp,
264
                        uint16_t rnti,
265
                        uint8_t pucch_resource,
266
                        uint16_t O_csi,
267
                        uint16_t O_ack,
268
                        uint8_t O_sr);
Francesco Mani's avatar
Francesco Mani committed
269

270 271 272 273
void find_search_space(int ss_type,
                       NR_BWP_Downlink_t *bwp,
                       NR_SearchSpace_t *ss);

274 275 276 277 278 279 280 281 282
void nr_configure_pdcch(gNB_MAC_INST *nr_mac,
                        nfapi_nr_dl_tti_pdcch_pdu_rel15_t *pdcch_pdu,
                        uint16_t rnti,
                        NR_SearchSpace_t *ss,
                        NR_ControlResourceSet_t *coreset,
                        NR_ServingCellConfigCommon_t *scc,
                        NR_BWP_Downlink_t *bwp,
                        uint8_t aggregation_level,
                        int CCEIndex);
Raymond Knopp's avatar
Raymond Knopp committed
283

284 285
void fill_dci_pdu_rel15(NR_ServingCellConfigCommon_t *scc,
                        NR_CellGroupConfig_t *secondaryCellGroup,
286
                        nfapi_nr_dl_tti_pdcch_pdu_rel15_t *pdcch_pdu_rel15,
cig's avatar
cig committed
287 288
                        dci_pdu_rel15_t *dci_pdu_rel15,
                        int *dci_formats,
Francesco Mani's avatar
Francesco Mani committed
289
                        int *rnti_types,
290
                        int N_RB,
Francesco Mani's avatar
Francesco Mani committed
291 292 293 294 295 296
                        int bwp_id);

void prepare_dci(NR_CellGroupConfig_t *secondaryCellGroup,
                 dci_pdu_rel15_t *dci_pdu_rel15,
                 nr_dci_format_t format,
                 int bwp_id);
297

298 299 300 301 302 303 304 305 306 307
/* 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);

308

309 310
long get_K2(NR_BWP_Uplink_t *ubwp, int time_domain_assignment, int mu);

311 312 313 314 315 316 317
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);

318 319
uint8_t nr_get_tpc(int target, uint8_t cqi, int incr);

320
int get_spf(nfapi_nr_config_request_scf_t *cfg);
321

322
int to_absslot(nfapi_nr_config_request_scf_t *cfg,int frame,int slot);
323

Raymond Knopp's avatar
Raymond Knopp committed
324
void nr_get_tbs_dl(nfapi_nr_dl_tti_pdsch_pdu *pdsch_pdu,
325
		   int x_overhead,
326
                   uint8_t numdmrscdmgroupnodata,
327
                   uint8_t tb_scaling);
Raymond Knopp's avatar
Raymond Knopp committed
328 329 330 331 332 333 334
/** \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);
335 336 337 338 339

int NRRIV2BW(int locationAndBandwidth,int N_RB);

int NRRIV2PRBOFFSET(int locationAndBandwidth,int N_RB);

Robert Schmidt's avatar
Robert Schmidt committed
340
void dump_nr_ue_list(NR_UE_list_t *listP);
Robert Schmidt's avatar
Robert Schmidt committed
341
void add_nr_ue_list(NR_UE_list_t *listP, int UE_id);
342

cig's avatar
cig committed
343
int find_nr_UE_id(module_id_t mod_idP, rnti_t rntiP);
344

kn.raju's avatar
kn.raju committed
345 346
int find_nr_RA_id(module_id_t mod_idP, int CC_idP, rnti_t rntiP);

cig's avatar
cig committed
347
int add_new_nr_ue(module_id_t mod_idP, rnti_t rntiP);
348

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

351
int allocate_nr_CCEs(gNB_MAC_INST *nr_mac,
352 353
                     NR_BWP_Downlink_t *bwp,
                     NR_ControlResourceSet_t *coreset,
cig's avatar
cig committed
354
                     int aggregation,
355 356 357
                     uint16_t Y,
                     int m,
                     int nr_of_candidates);
358

359 360 361 362 363 364 365 366 367
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);

368
void compute_csi_bitlen (NR_CellGroupConfig_t *secondaryCellGroup, NR_UE_info_t *UE_info, int UE_id);
369

cig's avatar
cig committed
370 371 372 373 374 375
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);

376
void config_nr_mib(int Mod_idP, 
377 378 379 380 381 382 383 384
                   int CC_idP,
                   int p_gNBP,
                   int subCarrierSpacingCommon,
                   uint32_t ssb_SubcarrierOffset,
                   int dmrs_TypeA_Position,
                   uint32_t pdcch_ConfigSIB1,
                   int cellBarred,
                   int intraFreqReselection);
385

386

387 388 389 390 391
void nr_generate_Msg2(module_id_t module_idP,
                      int CC_id,
                      frame_t frameP,
                      sub_frame_t slotP);

392 393
void nr_process_mac_pdu(
    module_id_t module_idP,
394
    rnti_t rnti,
395 396 397 398
    uint8_t CC_id,
    frame_t frameP,
    uint8_t *pduP,
    uint16_t mac_pdu_len);
399

400 401
int binomial(int n, int k);

402 403
bool is_xlsch_in_slot(uint64_t bitmap, sub_frame_t slot);

404 405
void fill_ssb_vrb_map (NR_COMMON_channels_t *cc, int rbStart, int CC_id);

406

407 408 409 410 411 412 413 414 415 416
/* \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,
cig's avatar
cig committed
417 418 419 420 421 422
               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,
423 424 425
               const uint16_t timing_advance,
               const uint8_t ul_cqi,
               const uint16_t rssi);
426

427 428 429 430
void handle_nr_ul_harq(module_id_t mod_id,
                       frame_t frame,
                       sub_frame_t slot,
                       const nfapi_nr_crc_t *crc_pdu);
431

432 433
int16_t ssb_index_from_prach(module_id_t module_idP,
                             frame_t frameP,
434
			     sub_frame_t slotP,
435 436 437 438 439 440
                             uint16_t preamble_index,
                             uint8_t freq_index,
                             uint8_t symbol);

void find_SSB_and_RO_available(module_id_t module_idP);

441
#endif /*__LAYER2_NR_MAC_PROTO_H__*/