main_ue_nr.c 13.2 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
/*
 * Licensed to the OpenAirInterface (OAI) Software Alliance under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The OpenAirInterface Software Alliance licenses this file to You under
 * the OAI Public License, Version 1.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
 */

22
/* \file main_ue_nr.c
23
 * \brief top init of Layer 2
24 25 26 27 28 29 30
 * \author R. Knopp, K.H. HSU
 * \date 2018
 * \version 0.1
 * \company Eurecom / NTUST
 * \email: knopp@eurecom.fr, kai-hsiang.hsu@eurecom.fr
 * \note
 * \warning
31 32
 */

33 34
//#include "defs.h"
#include "mac_proto.h"
francescomani's avatar
francescomani committed
35
#include "radio/COMMON/common_lib.h"
36 37
//#undef MALLOC
#include "assertions.h"
38
#include "executables/nr-uesoftmodem.h"
39
#include "nr_rlc/nr_rlc_oai_api.h"
francescomani's avatar
francescomani committed
40
#include "RRC/NR_UE/rrc_proto.h"
41
#include <pthread.h>
42
#include "openair2/LAYER2/RLC/rlc.h"
43
static NR_UE_MAC_INST_t *nr_ue_mac_inst; 
44

45
void send_srb0_rrc(int ue_id, const uint8_t *sdu, sdu_size_t sdu_len, void *data)
francescomani's avatar
francescomani committed
46 47 48 49 50 51 52
{
  AssertFatal(sdu_len > 0 && sdu_len < CCCH_SDU_SIZE, "invalid CCCH SDU size %d\n", sdu_len);

  MessageDef *message_p = itti_alloc_new_message(TASK_MAC_UE, 0, NR_RRC_MAC_CCCH_DATA_IND);
  memset(NR_RRC_MAC_CCCH_DATA_IND(message_p).sdu, 0, sdu_len);
  memcpy(NR_RRC_MAC_CCCH_DATA_IND(message_p).sdu, sdu, sdu_len);
  NR_RRC_MAC_CCCH_DATA_IND(message_p).sdu_size = sdu_len;
53
  itti_send_msg_to_task(TASK_RRC_NRUE, ue_id, message_p);
francescomani's avatar
francescomani committed
54 55
}

56
void nr_ue_init_mac(NR_UE_MAC_INST_t *mac)
57
{
58
  LOG_I(NR_MAC, "[UE%d] Initializing MAC\n", mac->ue_id);
francescomani's avatar
francescomani committed
59
  nr_ue_reset_sync_state(mac);
francescomani's avatar
francescomani committed
60 61 62 63 64 65
  mac->get_sib1 = false;
  mac->get_otherSI = false;
  mac->phy_config_request_sent = false;
  memset(&mac->phy_config, 0, sizeof(mac->phy_config));
  mac->si_window_start = -1;
  mac->servCellIndex = 0;
66 67
  mac->harq_ACK_SpatialBundlingPUCCH = false;
  mac->harq_ACK_SpatialBundlingPUSCH = false;
68
  mac->uecap_maxMIMO_PDSCH_layers = 0;
69 70
  mac->uecap_maxMIMO_PUSCH_layers_cb = 0;
  mac->uecap_maxMIMO_PUSCH_layers_nocb = 0;
francescomani's avatar
francescomani committed
71 72 73
  mac->p_Max = INT_MIN;
  mac->p_Max_alt = INT_MIN;
  reset_mac_inst(mac);
74

75 76 77
  // need to inizialize because might not been setup (optional timer)
  nr_timer_stop(&mac->scheduling_info.sr_DelayTimer);

78 79
  memset(&mac->ssb_measurements, 0, sizeof(mac->ssb_measurements));
  memset(&mac->ul_time_alignment, 0, sizeof(mac->ul_time_alignment));
80 81
  memset(mac->ssb_list, 0, sizeof(mac->ssb_list));
  memset(mac->prach_assoc_pattern, 0, sizeof(mac->prach_assoc_pattern));
82 83 84

  for (int i = 0; i < NR_MAX_SR_ID; i++)
    memset(&mac->scheduling_info.sr_info[i], 0, sizeof(mac->scheduling_info.sr_info[i]));
85 86

  mac->pucch_power_control_initialized = false;
87
  mac->pusch_power_control_initialized = false;
88 89 90

  // Fake SIB19 reception for NTN
  // TODO: remove this and implement the actual SIB19 reception instead!
91
  if (get_nrUE_params()->ntn_koffset || get_nrUE_params()->ntn_ta_common) {
92 93 94 95 96 97 98 99
    NR_SIB19_r17_t *sib19_r17 = calloc(1, sizeof(*sib19_r17));
    sib19_r17->ntn_Config_r17 = calloc(1, sizeof(*sib19_r17->ntn_Config_r17));

    // NTN cellSpecificKoffset-r17
    if (get_nrUE_params()->ntn_koffset) {
      asn1cCallocOne(sib19_r17->ntn_Config_r17->cellSpecificKoffset_r17, get_nrUE_params()->ntn_koffset);
    }

100 101 102 103 104 105
    // NTN ta-Common-r17
    if (get_nrUE_params()->ntn_ta_common) {
      sib19_r17->ntn_Config_r17->ta_Info_r17 = calloc(1, sizeof(*sib19_r17->ntn_Config_r17->ta_Info_r17));
      sib19_r17->ntn_Config_r17->ta_Info_r17->ta_Common_r17 = get_nrUE_params()->ntn_ta_common / 4.072e-6; // ta-Common-r17 is in units of 4.072e-3 µs, ntn_ta_common is in ms
    }

106 107 108
    nr_rrc_mac_config_req_sib19_r17(mac->ue_id, sib19_r17);
    asn1cFreeStruc(asn_DEF_NR_SIB19_r17, sib19_r17);
  }
francescomani's avatar
francescomani committed
109
}
110

francescomani's avatar
francescomani committed
111 112 113
void nr_ue_mac_default_configs(NR_UE_MAC_INST_t *mac)
{
  // default values as defined in 38.331 sec 9.2.2
114

115
  // sf80 default for retxBSR_Timer sf10 for periodicBSR_Timer
116 117 118
  int mu = mac->current_UL_BWP ? mac->current_UL_BWP->scs : get_softmodem_params()->numerology;
  int subframes_per_slot = nr_slots_per_frame[mu] / 10;
  nr_timer_setup(&mac->scheduling_info.retxBSR_Timer, 80 * subframes_per_slot, 1); // 1 slot update rate
119
  nr_timer_setup(&mac->scheduling_info.periodicBSR_Timer, 10 * subframes_per_slot, 1); // 1 slot update rate
120

francescomani's avatar
francescomani committed
121 122 123
  mac->scheduling_info.periodicPHR_Timer = NR_PHR_Config__phr_PeriodicTimer_sf10;
  mac->scheduling_info.prohibitPHR_Timer = NR_PHR_Config__phr_ProhibitTimer_sf10;
}
francescomani's avatar
francescomani committed
124

125
void nr_ue_send_synch_request(NR_UE_MAC_INST_t *mac, module_id_t module_id, int cc_id, const fapi_nr_synch_request_t *sync_req)
francescomani's avatar
francescomani committed
126 127 128 129
{
  // Sending to PHY a request to resync
  mac->synch_request.Mod_id = module_id;
  mac->synch_request.CC_id = cc_id;
130
  mac->synch_request.synch_req = *sync_req;
francescomani's avatar
francescomani committed
131 132 133 134 135 136 137 138
  mac->if_module->synch_request(&mac->synch_request);
}

void nr_ue_reset_sync_state(NR_UE_MAC_INST_t *mac)
{
  // reset synchornization status
  mac->first_sync_frame = -1;
  mac->state = UE_NOT_SYNC;
139
  mac->ra.ra_state = nrRA_UE_IDLE;
francescomani's avatar
francescomani committed
140
}
141

142 143 144 145 146 147
NR_UE_L2_STATE_t nr_ue_get_sync_state(module_id_t mod_id)
{
  NR_UE_MAC_INST_t *mac = get_mac_inst(mod_id);
  return mac->state;
}

148
NR_UE_MAC_INST_t *nr_l2_init_ue(int nb_inst)
francescomani's avatar
francescomani committed
149 150
{
  //init mac here
151 152
  nr_ue_mac_inst = (NR_UE_MAC_INST_t *)calloc(nb_inst, sizeof(NR_UE_MAC_INST_t));
  AssertFatal(nr_ue_mac_inst, "Couldn't allocate %d instances of MAC module\n", nb_inst);
francescomani's avatar
francescomani committed
153

154
  for (int j = 0; j < nb_inst; j++) {
155
    NR_UE_MAC_INST_t *mac = &nr_ue_mac_inst[j];
156
    mac->ue_id = j;
157
    nr_ue_init_mac(mac);
158 159 160 161
    nr_ue_mac_default_configs(mac);
    if (get_softmodem_params()->sa)
      ue_init_config_request(mac, get_softmodem_params()->numerology);
  }
162

francescomani's avatar
francescomani committed
163
  int rc = rlc_module_init(0);
164
  AssertFatal(rc == 0, "Could not initialize RLC layer\n");
francescomani's avatar
francescomani committed
165

166 167 168 169
  for (int j = 0; j < nb_inst; j++) {
    nr_rlc_activate_srb0(j, NULL, send_srb0_rrc);
  }

francescomani's avatar
francescomani committed
170
  return (nr_ue_mac_inst);
171 172
}

173 174 175 176
NR_UE_MAC_INST_t *get_mac_inst(module_id_t module_id)
{
  NR_UE_MAC_INST_t *mac = &nr_ue_mac_inst[(int)module_id];
  AssertFatal(mac, "Couldn't get MAC inst %d\n", module_id);
177
  AssertFatal(mac->ue_id == module_id, "MAC ID %d doesn't match with input %d\n", mac->ue_id, module_id);
178
  return mac;
179
}
francescomani's avatar
francescomani committed
180 181 182 183 184 185

void reset_mac_inst(NR_UE_MAC_INST_t *nr_mac)
{
  // MAC reset according to 38.321 Section 5.12

  // initialize Bj for each logical channel to zero
francescomani's avatar
francescomani committed
186 187
  // TODO reset also other status variables of LC, is this ok?
  for (int i = 0; i < NR_MAX_NUM_LCID; i++) {
188
    LOG_D(NR_MAC, "Applying default logical channel config for LCID %d\n", i);
189
    nr_mac->scheduling_info.lc_sched_info[i].Bj = 0;
francescomani's avatar
francescomani committed
190 191 192
    nr_mac->scheduling_info.lc_sched_info[i].LCID_buffer_with_data = false;
    nr_mac->scheduling_info.lc_sched_info[i].LCID_buffer_remain = 0;
  }
francescomani's avatar
francescomani committed
193

francescomani's avatar
francescomani committed
194
  // TODO stop all running timers
195 196 197 198
  for (int i = 0; i < NR_MAX_NUM_LCID; i++) {
    nr_mac->scheduling_info.lc_sched_info[i].Bj = 0;
    nr_timer_stop(&nr_mac->scheduling_info.lc_sched_info[i].Bj_timer);
  }
199 200
  if (nr_mac->data_inactivity_timer)
    nr_timer_stop(nr_mac->data_inactivity_timer);
francescomani's avatar
francescomani committed
201
  nr_timer_stop(&nr_mac->ra.contention_resolution_timer);
202
  nr_timer_stop(&nr_mac->scheduling_info.sr_DelayTimer);
203
  nr_timer_stop(&nr_mac->scheduling_info.retxBSR_Timer);
204 205
  for (int i = 0; i < NR_MAX_SR_ID; i++)
    nr_timer_stop(&nr_mac->scheduling_info.sr_info[i].prohibitTimer);
francescomani's avatar
francescomani committed
206 207 208 209 210 211

  // consider all timeAlignmentTimers as expired and perform the corresponding actions in clause 5.2
  // TODO

  // set the NDIs for all uplink HARQ processes to the value 0
  for (int k = 0; k < NR_MAX_HARQ_PROCESSES; k++)
212
    nr_mac->ul_harq_info[k].last_ndi = -1; // initialize to invalid value
francescomani's avatar
francescomani committed
213 214

  // stop any ongoing RACH procedure
215 216
  if (nr_mac->ra.ra_state < nrRA_SUCCEEDED)
    nr_mac->ra.ra_state = nrRA_UE_IDLE;
francescomani's avatar
francescomani committed
217 218 219 220 221

  // discard explicitly signalled contention-free Random Access Resources
  // TODO not sure what needs to be done here

  // flush Msg3 buffer
222
  free_and_zero(nr_mac->ra.Msg3_buffer);
francescomani's avatar
francescomani committed
223 224

  // cancel any triggered Scheduling Request procedure
225 226 227 228
  for (int i = 0; i < NR_MAX_SR_ID; i++) {
    nr_mac->scheduling_info.sr_info[i].pending = false;
    nr_mac->scheduling_info.sr_info[i].counter = 0;
  }
francescomani's avatar
francescomani committed
229 230

  // cancel any triggered Buffer Status Reporting procedure
231
  nr_mac->scheduling_info.BSR_reporting_active = NR_BSR_TRIGGER_NONE;
francescomani's avatar
francescomani committed
232 233 234 235 236 237 238 239 240

  // cancel any triggered Power Headroom Reporting procedure
  // TODO PHR not implemented yet

  // flush the soft buffers for all DL HARQ processes
  for (int k = 0; k < NR_MAX_HARQ_PROCESSES; k++)
    memset(&nr_mac->dl_harq_info[k], 0, sizeof(NR_UE_HARQ_STATUS_t));

  // for each DL HARQ process, consider the next received transmission for a TB as the very first transmission
241 242
  for (int k = 0; k < NR_MAX_HARQ_PROCESSES; k++)
    nr_mac->dl_harq_info[k].last_ndi = -1; // initialize to invalid value
francescomani's avatar
francescomani committed
243 244 245 246 247 248 249

  // release, if any, Temporary C-RNTI
  nr_mac->ra.t_crnti = 0;

  // reset BFI_COUNTER
  // TODO beam failure procedure not implemented
}
francescomani's avatar
francescomani committed
250

francescomani's avatar
francescomani committed
251 252
void release_mac_configuration(NR_UE_MAC_INST_t *mac,
                               NR_UE_MAC_reset_cause_t cause)
francescomani's avatar
francescomani committed
253
{
254
  NR_UE_ServingCell_Info_t *sc = &mac->sc_info;
francescomani's avatar
francescomani committed
255 256 257 258 259 260 261
  // if cause is Re-establishment, release spCellConfig only
  if (cause == GO_TO_IDLE) {
    asn1cFreeStruc(asn_DEF_NR_MIB, mac->mib);
    asn1cFreeStruc(asn_DEF_NR_SearchSpace, mac->search_space_zero);
    asn1cFreeStruc(asn_DEF_NR_ControlResourceSet, mac->coreset0);
    asn1cFreeStruc(asn_DEF_NR_SI_SchedulingInfo, mac->si_SchedulingInfo);
    asn1cFreeStruc(asn_DEF_NR_TDD_UL_DL_ConfigCommon, mac->tdd_UL_DL_ConfigurationCommon);
262 263
    for (int i = mac->lc_ordered_list.count; i > 0 ; i--)
      asn_sequence_del(&mac->lc_ordered_list, i - 1, 1);
francescomani's avatar
francescomani committed
264 265
  }

266 267 268 269 270 271 272
  asn1cFreeStruc(asn_DEF_NR_CrossCarrierSchedulingConfig, sc->crossCarrierSchedulingConfig);
  asn1cFreeStruc(asn_DEF_NR_SRS_CarrierSwitching, sc->carrierSwitching);
  asn1cFreeStruc(asn_DEF_NR_UplinkConfig, sc->supplementaryUplink);
  asn1cFreeStruc(asn_DEF_NR_PDSCH_CodeBlockGroupTransmission, sc->pdsch_CGB_Transmission);
  asn1cFreeStruc(asn_DEF_NR_PUSCH_CodeBlockGroupTransmission, sc->pusch_CGB_Transmission);
  asn1cFreeStruc(asn_DEF_NR_CSI_MeasConfig, sc->csi_MeasConfig);
  asn1cFreeStruc(asn_DEF_NR_CSI_AperiodicTriggerStateList, sc->aperiodicTriggerStateList);
273
  asn1cFreeStruc(asn_DEF_NR_NTN_Config_r17, sc->ntn_Config_r17);
274
  asn1cFreeStruc(asn_DEF_NR_DownlinkHARQ_FeedbackDisabled_r17, sc->downlinkHARQ_FeedbackDisabled_r17);
275 276 277 278
  free(sc->xOverhead_PDSCH);
  free(sc->nrofHARQ_ProcessesForPDSCH);
  free(sc->rateMatching_PUSCH);
  free(sc->xOverhead_PUSCH);
279
  free(sc->maxMIMO_Layers_PDSCH);
280 281 282
  free(sc->maxMIMO_Layers_PUSCH);
  memset(&mac->sc_info, 0, sizeof(mac->sc_info));

283 284 285
  mac->current_DL_BWP = NULL;
  mac->current_UL_BWP = NULL;

francescomani's avatar
francescomani committed
286 287 288 289 290 291 292
  // in case of re-establishment we don't need to release initial BWP config common
  int first_bwp_rel = 0; // first BWP to release
  if (cause == RE_ESTABLISHMENT) {
    first_bwp_rel = 1;
    // release dedicated BWP0 config
    NR_UE_DL_BWP_t *bwp = mac->dl_BWPs.array[0];
    NR_BWP_PDCCH_t *pdcch = &mac->config_BWP_PDCCH[0];
293 294 295 296
    for (int i = pdcch->list_Coreset.count; i > 0 ; i--)
      asn_sequence_del(&pdcch->list_Coreset, i - 1, 1);
    for (int i = pdcch->list_SS.count; i > 0 ; i--)
      asn_sequence_del(&pdcch->list_SS, i - 1, 1);
francescomani's avatar
francescomani committed
297 298 299 300 301 302 303 304 305 306 307 308 309 310
    asn1cFreeStruc(asn_DEF_NR_PDSCH_Config, bwp->pdsch_Config);
    NR_UE_UL_BWP_t *ubwp = mac->ul_BWPs.array[0];
    asn1cFreeStruc(asn_DEF_NR_PUCCH_Config, ubwp->pucch_Config);
    asn1cFreeStruc(asn_DEF_NR_SRS_Config, ubwp->srs_Config);
    asn1cFreeStruc(asn_DEF_NR_PUSCH_Config, ubwp->pusch_Config);
    mac->current_DL_BWP = bwp;
    mac->current_UL_BWP = ubwp;
    mac->sc_info.initial_dl_BWPSize = bwp->BWPSize;
    mac->sc_info.initial_dl_BWPStart = bwp->BWPStart;
    mac->sc_info.initial_ul_BWPSize = ubwp->BWPSize;
    mac->sc_info.initial_ul_BWPStart = ubwp->BWPStart;
  }

  for (int i = first_bwp_rel; i < mac->dl_BWPs.count; i++)
311
    release_dl_BWP(mac, i);
francescomani's avatar
francescomani committed
312
  for (int i = first_bwp_rel; i < mac->ul_BWPs.count; i++)
313 314
    release_ul_BWP(mac, i);

francescomani's avatar
francescomani committed
315 316 317 318 319
  memset(&mac->ssb_measurements, 0, sizeof(mac->ssb_measurements));
  memset(&mac->csirs_measurements, 0, sizeof(mac->csirs_measurements));
  memset(&mac->ul_time_alignment, 0, sizeof(mac->ul_time_alignment));
}

320
void free_rach_structures(NR_UE_MAC_INST_t *nr_mac, int bwp_id)
francescomani's avatar
francescomani committed
321
{
322 323 324 325 326 327 328 329
  for (int j = 0; j < MAX_NB_PRACH_CONF_PERIOD_IN_ASSOCIATION_PATTERN_PERIOD; j++)
    for (int k = 0; k < MAX_NB_FRAME_IN_PRACH_CONF_PERIOD; k++)
      for (int l = 0; l < MAX_NB_SLOT_IN_FRAME; l++)
        free(nr_mac->prach_assoc_pattern[bwp_id].prach_conf_period_list[j].prach_occasion_slot_map[k][l].prach_occasion);

  free(nr_mac->ssb_list[bwp_id].tx_ssb);
}

330
void reset_ra(NR_UE_MAC_INST_t *nr_mac, bool free_prach)
331 332
{
  RA_config_t *ra = &nr_mac->ra;
francescomani's avatar
francescomani committed
333
  if(ra->rach_ConfigDedicated)
334
    asn1cFreeStruc(asn_DEF_NR_RACH_ConfigDedicated, ra->rach_ConfigDedicated);
francescomani's avatar
francescomani committed
335
  memset(ra, 0, sizeof(RA_config_t));
336

337
  if (!free_prach)
338 339 340 341
    return;

  for (int i = 0; i < MAX_NUM_BWP_UE; i++)
    free_rach_structures(nr_mac, i);
francescomani's avatar
francescomani committed
342
}