src/5gnrmac/mac_slot_ind.c

   1 /*******************************************************************************
   2 ################################################################################
   3 #   Copyright (c) [2017-2019] [Radisys]                                        #
   4 #                                                                              #
   5 #   Licensed under the Apache License, Version 2.0 (the "License");            #
   6 #   you may not use this file except in compliance with the License.           #
   7 #   You may obtain a copy of the License at                                    #
   8 #                                                                              #
   9 #       http://www.apache.org/licenses/LICENSE-2.0                             #
  10 #                                                                              #
  11 #   Unless required by applicable law or agreed to in writing, software        #
  12 #   distributed under the License is distributed on an "AS IS" BASIS,          #
  13 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.   #
  14 #   See the License for the specific language governing permissions and        #
  15 #   limitations under the License.                                             #
  16 ################################################################################
  17  *******************************************************************************/
  18 /* header include files (.h) */
  19 #include "common_def.h"
  20 #include "lrg.h"
  21 #include "lrg.x"
  22 #include "du_app_mac_inf.h"
  23 #include "mac_sch_interface.h"
  24 #include "lwr_mac_upr_inf.h"
  25 #include "rlc_mac_inf.h"
  26 #include "mac.h"
  27 #include "mac_upr_inf_api.h"
  28 #include "lwr_mac.h"
  29 #include "lwr_mac_fsm.h"
  30 #include "mac_utils.h"
  31
  32 /* function pointers for packing slot ind from mac to sch */
  33 MacSchSlotIndFunc macSchSlotIndOpts[] =
  34 {
  35    packMacSchSlotInd,
  36    MacSchSlotInd,
  37    packMacSchSlotInd
  38 };
  39
  40 /**
  41  * @brief process DL allocation from scheduler
  42  *
  43  * @details
  44  *
  45  *     Function : MacProcDlAlloc
  46  *
  47  *      This function copied dl sch info in the mac slot info
  48  *
  49  *  @param[in]  Pst            *pst
  50  *  @param[in]  DL allocation from scheduler
  51  *  @return
  52  *      -# ROK
  53  *      -# RFAILED
  54  **/
  55 uint8_t MacProcDlAlloc(Pst *pst, DlSchedInfo *dlSchedInfo)
  56 {
  57    uint8_t   ueIdx;
  58    uint16_t  cellIdx;
  59    MacDlSlot *currDlSlot = NULLP;
  60
  61 #ifdef CALL_FLOW_DEBUG_LOG
  62    DU_LOG("\nCall Flow: ENTSCH -> ENTMAC : EVENT_DL_SCH_INFO\n");
  63 #endif
  64    if(dlSchedInfo != NULLP)
  65    {
  66       GET_CELL_IDX(dlSchedInfo->cellId, cellIdx);
  67       if(dlSchedInfo->isBroadcastPres)
  68       {
  69          currDlSlot = &macCb.macCell[cellIdx]->\
  70                       dlSlot[dlSchedInfo->schSlotValue.broadcastTime.slot];
  71          currDlSlot->dlInfo.isBroadcastPres = true;
  72          memcpy(&currDlSlot->dlInfo.brdcstAlloc, &dlSchedInfo->brdcstAlloc, sizeof(DlBrdcstAlloc));
  73          currDlSlot->dlInfo.brdcstAlloc.sib1Alloc.sib1PdcchCfg.dci.pdschCfg = \
  74                                             &currDlSlot->dlInfo.brdcstAlloc.sib1Alloc.sib1PdschCfg;
  75       }
  76
  77       for(ueIdx=0; ueIdx<MAX_NUM_UE; ueIdx++)
  78       {
  79          if(dlSchedInfo->rarAlloc[ueIdx] != NULLP)
  80          {
  81             currDlSlot = &macCb.macCell[cellIdx]->dlSlot[dlSchedInfo->schSlotValue.rarTime.slot];
  82             currDlSlot->dlInfo.rarAlloc[ueIdx] = dlSchedInfo->rarAlloc[ueIdx];
  83
  84             /* MUXing of RAR */
  85             fillRarPdu(&currDlSlot->dlInfo.rarAlloc[ueIdx]->rarInfo);
  86          }
  87       }
  88
  89       if(dlSchedInfo->dlMsgAlloc != NULLP)
  90       {
  91          currDlSlot = &macCb.macCell[cellIdx]->\
  92                       dlSlot[dlSchedInfo->schSlotValue.dlMsgTime.slot];
  93          currDlSlot->dlInfo.dlMsgAlloc = dlSchedInfo->dlMsgAlloc; /* copy msg4 alloc pointer in MAC slot info */
  94          currDlSlot->dlInfo.cellId = dlSchedInfo->cellId;
  95
  96          /* Check if the downlink pdu is msg4 */
  97          if(dlSchedInfo->dlMsgAlloc->dlMsgInfo.isMsg4Pdu)
  98          {
  99             GET_UE_IDX(dlSchedInfo->dlMsgAlloc->dlMsgInfo.crnti, ueIdx);
 100             ueIdx = ueIdx -1;
 101             macCb.macCell[cellIdx]->macRaCb[ueIdx].msg4TbSize = \
 102                dlSchedInfo->dlMsgAlloc->dlMsgPdschCfg.codeword[0].tbSize;
 103          }
 104          else
 105          {
 106             memcpy(&currDlSlot->dlInfo.schSlotValue, &dlSchedInfo->schSlotValue, sizeof(SchSlotValue));
 107             /* Send LC schedule result to RLC */
 108             sendSchedRptToRlc(currDlSlot->dlInfo, dlSchedInfo->schSlotValue.dlMsgTime);
 109          }
 110       }
 111
 112       if(dlSchedInfo->ulGrant != NULLP)
 113       {
 114          currDlSlot = &macCb.macCell[cellIdx]->\
 115                       dlSlot[dlSchedInfo->schSlotValue.ulDciTime.slot];
 116          currDlSlot->dlInfo.ulGrant = dlSchedInfo->ulGrant;
 117       }
 118    }
 119    return ROK;
 120 }
 121
 122 /**
 123  * @brief Forming anf filling the MUX Pdu
 124  * @details
 125  *
 126  *     Function : fillMsg4Pdu
 127  *
 128  *      Forming and filling of Msg4Pdu
 129  *
 130  *  @param[in]  DlMsgAlloc  *msg4Alloc
 131  *  @return  void
 132  **/
 133 void fillMsg4Pdu(uint16_t cellId, DlMsgAlloc *msg4Alloc)
 134 {
 135    uint8_t   ueIdx;
 136    uint16_t  cellIdx;
 137    uint16_t  msg4TxPduLen;
 138    MacDlData msg4DlData;
 139    MacCeInfo  macCeData;
 140
 141    GET_CELL_IDX(cellId, cellIdx);
 142
 143    memset(&msg4DlData, 0, sizeof(MacDlData));
 144    memset(&macCeData, 0, sizeof(MacCeInfo));
 145
 146    GET_UE_IDX(msg4Alloc->dlMsgInfo.crnti, ueIdx);
 147    ueIdx = ueIdx -1;
 148
 149    if(macCb.macCell[cellIdx] == NULLP)
 150    {
 151       DU_LOG("\nERROR -->  MAC: Cell Id[%d] not found", cellId);
 152       return;
 153    }
 154
 155    if(macCb.macCell[cellIdx]->macRaCb[ueIdx].msg4Pdu != NULLP)
 156    {
 157       MAC_ALLOC(msg4DlData.pduInfo[msg4DlData.numPdu].dlPdu, macCb.macCell[cellIdx]->macRaCb[ueIdx].msg4PduLen);
 158       if(msg4DlData.pduInfo[msg4DlData.numPdu].dlPdu != NULLP)
 159       {
 160          msg4TxPduLen = macCb.macCell[cellIdx]->macRaCb[ueIdx].msg4TbSize - TX_PAYLOAD_HDR_LEN;
 161
 162          fillMsg4DlData(&msg4DlData, macCb.macCell[cellIdx]->macRaCb[ueIdx].msg4PduLen, \
 163             macCb.macCell[cellIdx]->macRaCb[ueIdx].msg4Pdu);
 164          fillMacCe(&macCeData, macCb.macCell[cellIdx]->macRaCb[ueIdx].msg3Pdu);
 165          /* Forming Mux Pdu */
 166          macCb.macCell[cellIdx]->macRaCb[ueIdx].msg4TxPdu = NULLP;
 167          MAC_ALLOC(macCb.macCell[cellIdx]->macRaCb[ueIdx].msg4TxPdu, msg4TxPduLen);
 168          if(macCb.macCell[cellIdx]->macRaCb[ueIdx].msg4TxPdu != NULLP)
 169          {
 170             memset(macCb.macCell[cellIdx]->macRaCb[ueIdx].msg4TxPdu, 0, msg4TxPduLen);
 171             macMuxPdu(&msg4DlData, &macCeData, macCb.macCell[cellIdx]->macRaCb[ueIdx].msg4TxPdu, msg4TxPduLen);
 172          }
 173          else
 174          {
 175             DU_LOG("\nERROR  -->  MAC: Failed allocating memory for msg4TxPdu");
 176          }
 177          /* Free memory allocated */
 178          MAC_FREE(msg4DlData.pduInfo[msg4DlData.numPdu-1].dlPdu, macCb.macCell[cellIdx]->macRaCb[ueIdx].msg4PduLen);
 179          msg4DlData.numPdu--;
 180       }
 181    }
 182
 183    /* storing msg4 Pdu in macDlSlot */
 184    if(macCb.macCell[cellIdx]->macRaCb[ueIdx].msg4TxPdu)
 185    {
 186       msg4Alloc->dlMsgInfo.dlMsgPduLen = msg4TxPduLen;
 187       MAC_ALLOC(msg4Alloc->dlMsgInfo.dlMsgPdu, msg4Alloc->dlMsgInfo.dlMsgPduLen);
 188       if(msg4Alloc->dlMsgInfo.dlMsgPdu != NULLP)
 189       {
 190          memcpy(msg4Alloc->dlMsgInfo.dlMsgPdu, macCb.macCell[cellIdx]->macRaCb[ueIdx].msg4TxPdu, \
 191                msg4Alloc->dlMsgInfo.dlMsgPduLen);
 192       }
 193    }
 194    else
 195    {
 196       DU_LOG("\nERROR  -->  MAC: Failed at macMuxPdu()");
 197    }
 198 }
 199
 200 /**
 201  * @brief Builds and Send the Muxed Pdu to Lower MAC
 202  *
 203  * @details
 204  *
 205  *     Function : buildAndSendMuxPdu
 206  *
 207  *      Build and Sends the Muxed Pdu to Lower MAC.
 208  *
 209  *  @param[in]  SlotTimingInfo    *slotInd
 210  *  @return  void
 211  **/
 212
 213 void buildAndSendMuxPdu(SlotTimingInfo currTimingInfo)
 214 {
 215    uint16_t  cellIdx;
 216    MacDlSlot *currDlSlot = NULLP;
 217    SlotTimingInfo muxTimingInfo;
 218    memset(&muxTimingInfo, 0, sizeof(SlotTimingInfo));
 219
 220    GET_CELL_IDX(currTimingInfo.cellId, cellIdx);
 221
 222    ADD_DELTA_TO_TIME(currTimingInfo, muxTimingInfo, PHY_DELTA_DL);
 223    currDlSlot = &macCb.macCell[cellIdx]->dlSlot[muxTimingInfo.slot];
 224    if(currDlSlot->dlInfo.dlMsgAlloc)
 225    {
 226       if(currDlSlot->dlInfo.dlMsgAlloc->dlMsgInfo.isMsg4Pdu)
 227       {
 228          fillMsg4Pdu(currTimingInfo.cellId, currDlSlot->dlInfo.dlMsgAlloc);
 229          currDlSlot = NULLP;
 230       }
 231    }
 232 }
 233
 234 /**
 235  * @brief Transmission time interval indication from PHY.
 236  *
 237  * @details
 238  *
 239  *     Function : sendSlotIndMacToSch
 240  *
 241  *      This API is invoked by MAC to send slot ind to scheduler.
 242  *
 243  *  @param[in]  SlotTimingInfo    *slotInd
 244  *  @return
 245  *      -# ROK
 246  *      -# RFAILED
 247  **/
 248 int sendSlotIndMacToSch(SlotTimingInfo *slotInd)
 249 {
 250    /* fill Pst structure to send to lwr_mac to MAC */
 251    Pst pst;
 252
 253    FILL_PST_MAC_TO_SCH(pst, EVENT_SLOT_IND_TO_SCH);
 254    return(*macSchSlotIndOpts[pst.selector])(&pst,slotInd);
 255 }
 256
 257 /*******************************************************************
 258  *
 259  * @brief Send cell up indication to DU APP
 260  *
 261  * @details
 262  *
 263  *    Function : sendCellUpIndMacToDuApp
 264  *
 265  *    Functionality:
 266  *       Send cell up indication to DU APP
 267  *
 268  * @params[in] Cell Up indication info
 269  * @return ROK     - success
 270  *         RFAILED - failure
 271  *
 272  * ****************************************************************/
 273 int sendCellUpIndMacToDuApp(uint16_t cellId)
 274 {
 275    Pst pst;
 276    uint16_t ret;
 277    OduCellId *oduCellId;
 278
 279    /*  Allocate sharable memory */
 280    MAC_ALLOC_SHRABL_BUF(oduCellId, sizeof(OduCellId));
 281    if(!oduCellId)
 282    {
 283       DU_LOG("\nERROR  -->  MAC : Memory allocation failed for cell up indication");
 284       return RFAILED;
 285    }
 286    oduCellId->cellId = cellId;
 287
 288    /* Fill Pst */
 289    FILL_PST_MAC_TO_DUAPP(pst, EVENT_MAC_CELL_UP_IND);
 290
 291    ret = MacDuAppCellUpInd(&pst, oduCellId);
 292    if(ret != ROK)
 293    {
 294       DU_LOG("\nERROR  -->  MAC: Failed to send cell up indication to DU APP");
 295       MAC_FREE_SHRABL_BUF(MAC_MEM_REGION, MAC_POOL, oduCellId, sizeof(OduCellId));
 296    }
 297
 298    return ret;
 299 } /* sendCellUpIndMacToDuApp */
 300
 301 /*******************************************************************
 302  *
 303  * @brief Process slot indication at MAC
 304  *
 305  * @details
 306  *
 307  *    Function : macProcSlotInd
 308  *
 309  *    Functionality: Process slot indication at MAC
 310  *
 311  * @params[in] Slot indication info
 312  * @return ROK     - success
 313  *         RFAILED - failure
 314  *
 315  * ****************************************************************/
 316 uint8_t macProcSlotInd(SlotTimingInfo slotInd)
 317 {
 318    uint16_t  cellIdx = 0;
 319
 320    GET_CELL_IDX(slotInd.cellId, cellIdx);
 321
 322    if(macCb.macCell[cellIdx] == NULLP)
 323    {
 324       DU_LOG("ERROR  --> MAC : macProcSlotInd(): CellId[%d] does not exist. Error occurred at SFN [%d] Slot [%d]",\
 325       slotInd.cellId, slotInd.sfn, slotInd.slot);
 326       return RFAILED;
 327    }
 328    /* Store current time info */
 329    macCb.macCell[cellIdx]->currTime.cellId = slotInd.cellId;
 330    macCb.macCell[cellIdx]->currTime.slot = slotInd.slot;
 331    macCb.macCell[cellIdx]->currTime.sfn = slotInd.sfn;
 332
 333    /* Mux Pdu for Msg4 */
 334    buildAndSendMuxPdu(slotInd);
 335
 336    /* Trigger for DL TTI REQ */
 337    fillDlTtiReq(slotInd);
 338
 339    return ROK;
 340 }  /* macProcSlotInd */
 341
 342 /**
 343  * @brief Transmission time interval indication from PHY.
 344  *
 345  * @details
 346  *
 347  *     Function : fapiMacSlotInd
 348  *
 349  *      This API is invoked by PHY to indicate TTI indication to MAC for a cell.
 350  *
 351  *  @param[in]  Pst            *pst
 352  *  @param[in]  SuId           suId
 353  *  @param[in]  SlotTimingInfo    *slotInd
 354  *  @return
 355  *      -# ROK
 356  *      -# RFAILED
 357  **/
 358 uint8_t fapiMacSlotInd(Pst *pst, SlotTimingInfo *slotInd)
 359 {
 360    uint8_t               ret = ROK;
 361    uint16_t              cellIdx;
 362    volatile uint32_t     startTime=0;
 363
 364 #ifdef ODU_SLOT_IND_DEBUG_LOG
 365    DU_LOG("\nDEBUG  -->  MAC : Slot Indication received. [%d : %d]", slotInd->sfn, slotInd->slot);
 366 #endif
 367    /*starting Task*/
 368    ODU_START_TASK(&startTime, PID_MAC_TTI_IND);
 369    gSlotCount++;
 370
 371    if(gSlotCount == 1)
 372    {
 373            GET_CELL_IDX(slotInd->cellId, cellIdx);
 374            macCb.macCell[cellIdx]->state = CELL_STATE_UP;
 375    }
 376
 377 /* When testing L2 with Intel-L1, any changes specific to
 378  * timer mode testing must be guarded under INTEL_TIMER_MODE*/
 379 #ifndef INTEL_TIMER_MODE
 380    /* send slot indication to scheduler */
 381    ret = sendSlotIndMacToSch(slotInd);
 382    if(ret != ROK)
 383    {
 384       DU_LOG("\nERROR  -->  MAC : Sending of slot ind msg from MAC to SCH failed");
 385       MAC_FREE_SHRABL_BUF(pst->region, pst->pool, slotInd, sizeof(SlotTimingInfo));
 386       return ret;
 387    }
 388
 389    ret = macProcSlotInd(*slotInd);
 390    if(ret != ROK)
 391    {
 392       DU_LOG("\nERROR  -->  MAC : macProcSlotInd failed");
 393       MAC_FREE_SHRABL_BUF(pst->region, pst->pool, slotInd, sizeof(SlotTimingInfo));
 394       return ret;
 395    }
 396 #endif
 397
 398    /* send slot indication to du app */
 399    if(gSlotCount == 1)
 400    {
 401       ret = sendCellUpIndMacToDuApp(slotInd->cellId);
 402       if(ret != ROK)
 403       {
 404          DU_LOG("\nERROR  -->  MAC :Sending of slot ind msg from MAC to DU APP failed");
 405          MAC_FREE_SHRABL_BUF(pst->region, pst->pool, slotInd, sizeof(SlotTimingInfo));
 406          return ret;
 407       }
 408    }
 409
 410    /*stoping Task*/
 411    ODU_STOP_TASK(startTime, PID_MAC_TTI_IND);
 412    MAC_FREE_SHRABL_BUF(pst->region, pst->pool, slotInd, sizeof(SlotTimingInfo));
 413
 414 #ifdef INTEL_WLS_MEM
 415    lwrMacCb.phySlotIndCntr++;
 416    if(lwrMacCb.phySlotIndCntr > WLS_MEM_FREE_PRD)
 417    {
 418       lwrMacCb.phySlotIndCntr = 1;
 419    }
 420    freeWlsBlockList(lwrMacCb.phySlotIndCntr - 1);
 421 #endif
 422
 423    return ret;
 424 }  /* fapiMacSlotInd */
 425
 426 /**********************************************************************
 427   End of file
 428  **********************************************************************/
 429