src/5gnrsch/sch_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
  19 /************************************************************************
  20
  21 Name:     5G NR SCH layer
  22
  23 Type:     C source file
  24
  25 Desc:     C source code for Entry point fucntions for slot indications
  26
  27 File:     sch_slot_ind.c
  28
  29  **********************************************************************/
  30
  31 /** @file sch_slot_ind.c
  32   @brief This module processes slot indications
  33  */
  34 #include "common_def.h"
  35 #include "tfu.h"
  36 #include "lrg.h"
  37 #include "tfu.x"
  38 #include "lrg.x"
  39 #include "du_log.h"
  40 #include "du_app_mac_inf.h"
  41 #include "mac_sch_interface.h"
  42 #include "sch.h"
  43 #include "sch_utils.h"
  44
  45 SchMacDlAllocFunc schMacDlAllocOpts[] =
  46 {
  47    packSchMacDlAlloc,
  48    MacProcDlAlloc,
  49    packSchMacDlAlloc
  50 };
  51
  52 SchCb schCb[SCH_MAX_INST];
  53
  54 /*******************************************************************
  55  *
  56  * @brief Handles sending DL broadcast alloc to MAC
  57  *
  58  * @details
  59  *
  60  *    Function : sendDlAllocToMac
  61  *
  62  *    Functionality:
  63  *     Sends DL Broadcast Resource Allocation to MAC from SCH
  64  *
  65  * @params[in]
  66  * @return ROK     - success
  67  *         RFAILED - failure
  68  *
  69  * ****************************************************************/
  70 uint8_t sendDlAllocToMac(DlSchedInfo *dlSchedInfo, Inst inst)
  71 {
  72    Pst pst;
  73
  74    memset(&pst, 0, sizeof(Pst));
  75    FILL_PST_SCH_TO_MAC(pst, inst);
  76    pst.event = EVENT_DL_ALLOC;
  77
  78    return(*schMacDlAllocOpts[pst.selector])(&pst, dlSchedInfo);
  79
  80 }
  81
  82
  83 /*******************************************************************
  84  *
  85  * @brief Handles slot indication at SCH
  86  *
  87  * @details
  88  *
  89  *    Function : schCalcSlotValues
  90  *
  91  *    Functionality:
  92  *     Handles TTI indication received from PHY
  93  *
  94  * @params[in]
  95  * @return ROK     - success
  96  *         RFAILED - failure
  97  *
  98  * ****************************************************************/
  99 void schCalcSlotValues(SlotIndInfo slotInd, SchSlotValue *schSlotValue)
 100 {
 101    /****************************************************************
 102     * PHY_DELTA - the physical layer delta                         *
 103     * SCHED_DELTA - scheduler schedules one slot ahead             *
 104     * BO_DELTA - this delay is considered for BO response and      *
 105     *            RLC buffer packet to received at MAC              *
 106     * lower-mac (FAPI filling) will be working on PHY_DELTA        *
 107     * brdcast scheduler will working on PHY_DELTA + SCHED_DELTA    *
 108     * RAR scheduler will working on PHY_DELTA + SCHED_DELTA        *
 109     * msg4 scheduler will working on PHY_DELTA + SCHED_DELTA       *
 110     * dedicated DL msg scheduler will working                      *
 111     *        on PHY_DELTA + SCHED_DELTA + BO_DELTA                 *
 112     ****************************************************************/
 113
 114    ADD_DELTA_TO_TIME(slotInd, schSlotValue->currentTime, PHY_DELTA_DL);
 115    ADD_DELTA_TO_TIME(slotInd, schSlotValue->broadcastTime, PHY_DELTA_DL + SCHED_DELTA);
 116    ADD_DELTA_TO_TIME(slotInd, schSlotValue->rarTime, PHY_DELTA_DL + SCHED_DELTA);
 117    ADD_DELTA_TO_TIME(slotInd, schSlotValue->dlMsgTime, PHY_DELTA_DL + SCHED_DELTA);
 118 }
 119
 120 /*******************************************************************
 121  *
 122  * @brief
 123  *
 124  * @details
 125  *
 126  *    Function :
 127  *
 128  *    Functionality:
 129
 130  *
 131  * @params[in]
 132  * @return ROK     - success
 133  *         RFAILED - failure
 134  *
 135  * ****************************************************************/
 136 uint8_t schFillBoGrantDlSchedInfo(SchCellCb *cell, DlSchedInfo *dlSchedInfo, DlMsgAlloc *dlMsgAlloc)
 137 {
 138    uint8_t ueIdx, lcIdx;
 139    uint16_t slot;
 140    uint16_t crnti = 0;
 141    uint32_t accumalatedSize = 0;
 142    SchUeCb *ueCb = NULLP;
 143
 144    while(cell->boIndBitMap)
 145    {
 146       slot = dlSchedInfo->schSlotValue.dlMsgTime.slot;
 147
 148       GET_RIGHT_MOST_SET_BIT(cell->boIndBitMap, ueIdx);
 149       GET_CRNTI(crnti,ueIdx);
 150       ueCb = &cell->ueCb[ueIdx-1];
 151
 152       /* allocate PDCCH and PDSCH resources for the ue */
 153       SCH_ALLOC(dlMsgAlloc, sizeof(DlMsgAlloc));
 154       if(!dlMsgAlloc)
 155       {
 156          DU_LOG("\nERROR  -->  SCH : Memory Allocation failed for ded DL msg alloc");
 157          return RFAILED;
 158       }
 159       memset(dlMsgAlloc, 0, sizeof(DlMsgAlloc));
 160       dlSchedInfo->dlMsgAlloc = dlMsgAlloc;
 161       dlMsgAlloc->crnti = crnti;
 162
 163       /* Dl ded Msg info is copied, this was earlier filled in macSchDlRlcBoInfo */
 164       memcpy(&dlMsgAlloc->dlMsgInfo, cell->schDlSlotInfo[slot]->dlMsgInfo, \
 165             sizeof(DlMsgInfo));
 166
 167       /* scheduled LC data fill */
 168       dlMsgAlloc->numLc = 0;
 169       for(lcIdx = 0; lcIdx < MAX_NUM_LC; lcIdx++)
 170       {
 171          if(ueCb->dlInfo.dlLcCtxt[lcIdx].bo)
 172          {
 173             dlMsgAlloc->lcSchInfo[dlMsgAlloc->numLc].lcId = lcIdx;
 174
 175             /* calculation for BO includse RLC and MAC header size */
 176             dlMsgAlloc->lcSchInfo[dlMsgAlloc->numLc].schBytes = \
 177                                                                 ueCb->dlInfo.dlLcCtxt[lcIdx].bo + MAC_HDR_SIZE;
 178             accumalatedSize += dlMsgAlloc->lcSchInfo[dlMsgAlloc->numLc].schBytes;
 179             dlMsgAlloc->numLc++;
 180          }
 181          ueCb->dlInfo.dlLcCtxt[lcIdx].bo = 0;
 182       }
 183
 184       /* pdcch and pdsch data is filled */
 185       schDlRsrcAllocDlMsg(dlMsgAlloc, cell, crnti, &accumalatedSize, slot);
 186       /* Calculated TB size could be less than the total size requested.
 187        * Hence, updated the scheduled bytes report. Following is valid only for
 188        * one LC.
 189        * TODO : Update the scheduling byte report for multiple LC based on QCI
 190        * and Priority */
 191       dlMsgAlloc->lcSchInfo[dlMsgAlloc->numLc -1].schBytes = accumalatedSize;
 192
 193       /* PUCCH resource */
 194       schAllocPucchResource(cell, dlMsgAlloc->crnti, slot);
 195
 196       /* Free the dl ded msg info allocated in macSchDlRlcBoInfo */
 197       SCH_FREE(cell->schDlSlotInfo[dlSchedInfo->schSlotValue.dlMsgTime.slot]->dlMsgInfo, \
 198             sizeof(DlMsgInfo));
 199       cell->schDlSlotInfo[dlSchedInfo->schSlotValue.dlMsgTime.slot]->dlMsgInfo = NULL;
 200
 201       /* after allocation is done, unset the bo bit for that ue */
 202       UNSET_ONE_BIT(ueIdx, cell->boIndBitMap);
 203    }
 204
 205    return ROK;
 206 }
 207
 208 /*******************************************************************
 209  *
 210  * @brief Handles slot indication at SCH
 211  *
 212  * @details
 213  *
 214  *    Function : schProcessSlotInd
 215  *
 216  *    Functionality:
 217  *     Handles TTI indication received from PHY
 218  *
 219  * @params[in]
 220  * @return ROK     - success
 221  *         RFAILED - failure
 222  *
 223  * ****************************************************************/
 224 uint8_t schProcessSlotInd(SlotIndInfo *slotInd, Inst schInst)
 225 {
 226    uint8_t  ssb_rep, ueIdx, lcgIdx, ret = ROK;
 227    uint16_t slot;
 228    DlSchedInfo dlSchedInfo;
 229    DlBrdcstAlloc *dlBrdcstAlloc = NULLP;
 230    RarAlloc   *rarAlloc = NULLP;
 231    DlMsgAlloc  *msg4Alloc = NULLP;
 232    DlMsgAlloc *dlMsgAlloc = NULLP;
 233    SchCellCb  *cell = NULLP;
 234
 235
 236    memset(&dlSchedInfo,0,sizeof(DlSchedInfo));
 237    dlSchedInfo.dlMsgAlloc = NULLP;
 238    schCalcSlotValues(*slotInd, &dlSchedInfo.schSlotValue);
 239    dlBrdcstAlloc = &dlSchedInfo.brdcstAlloc;
 240    dlBrdcstAlloc->ssbTrans = NO_SSB;
 241    dlBrdcstAlloc->sib1Trans = NO_SIB1;
 242
 243    cell = schCb[schInst].cells[schInst];
 244    if(cell == NULLP)
 245    {
 246       DU_LOG("\nERROR  -->  SCH : Cell Does not exist");
 247       return RFAILED;
 248    }
 249    ssb_rep = cell->cellCfg.ssbSchCfg.ssbPeriod;
 250    memcpy(&cell->slotInfo, slotInd, sizeof(SlotIndInfo));
 251    dlBrdcstAlloc->ssbIdxSupported = 1;
 252
 253    slot = dlSchedInfo.schSlotValue.currentTime.slot;
 254
 255    dlSchedInfo.cellId = cell->cellId;
 256
 257    /* Identify SSB ocassion*/
 258    if ((dlSchedInfo.schSlotValue.broadcastTime.sfn % SCH_MIB_TRANS == 0) && (dlSchedInfo.schSlotValue.broadcastTime.slot ==0))
 259    {
 260       dlBrdcstAlloc->ssbTrans = SSB_TRANSMISSION;
 261       if(!cell->firstSsbTransmitted)
 262          cell->firstSsbTransmitted = true;
 263    }
 264    else if (cell->firstSsbTransmitted)
 265    {
 266       if((ssb_rep == 5) && ((dlSchedInfo.schSlotValue.broadcastTime.slot == 0 || dlSchedInfo.schSlotValue.broadcastTime.slot == 10)))
 267          dlBrdcstAlloc->ssbTrans = SSB_REPEAT;
 268       else if((dlSchedInfo.schSlotValue.broadcastTime.sfn % (ssb_rep/10) == 0) && dlSchedInfo.schSlotValue.broadcastTime.slot == 0)
 269          dlBrdcstAlloc->ssbTrans = SSB_REPEAT;
 270    }
 271    else
 272    {
 273       /* not SSB occassion */
 274    }
 275
 276    /* Identify SIB1 occasions */
 277    if((dlSchedInfo.schSlotValue.broadcastTime.sfn % SCH_SIB1_TRANS == 0) && (dlSchedInfo.schSlotValue.broadcastTime.slot ==0))
 278    {
 279       dlBrdcstAlloc->sib1Trans = SIB1_TRANSMISSION;
 280       if(!cell->firstSib1Transmitted)
 281          cell->firstSib1Transmitted = true;
 282    }
 283    else if (cell->firstSib1Transmitted)
 284    {
 285       if((dlSchedInfo.schSlotValue.broadcastTime.sfn % (cell->cellCfg.sib1SchCfg.sib1RepetitionPeriod/10) == 0) &&
 286             (dlSchedInfo.schSlotValue.broadcastTime.slot == 0))
 287       {
 288          dlBrdcstAlloc->sib1Trans = SIB1_REPITITION;
 289       }
 290    }
 291    else
 292    {
 293       /* not SIB1 occassion */
 294    }
 295
 296
 297    if(dlBrdcstAlloc->ssbTrans || dlBrdcstAlloc->sib1Trans)
 298    {
 299       dlSchedInfo.isBroadcastPres = true;
 300       slot = dlSchedInfo.schSlotValue.broadcastTime.slot;
 301       ret = schBroadcastAlloc(cell,dlBrdcstAlloc,slot);
 302       if(ret != ROK)
 303       {
 304          DU_LOG("\nERROR  -->  SCH : schBroadcastAlloc failed");
 305          return ret;
 306       }
 307    }
 308
 309    /* check for RAR */
 310    if(cell->schDlSlotInfo[dlSchedInfo.schSlotValue.rarTime.slot]->rarInfo != NULLP)
 311    {
 312       slot = dlSchedInfo.schSlotValue.rarTime.slot;
 313       SCH_ALLOC(rarAlloc, sizeof(RarAlloc));
 314       if(!rarAlloc)
 315       {
 316          DU_LOG("\nERROR  -->  SCH : Memory Allocation failed for RAR alloc");
 317          return RFAILED;
 318       }
 319
 320       dlSchedInfo.rarAlloc = rarAlloc;
 321
 322       /* RAR info is copied, this was earlier filled in schProcessRachInd */
 323       memcpy(&rarAlloc->rarInfo,cell->schDlSlotInfo[slot]->rarInfo, sizeof(RarInfo));
 324
 325       /* pdcch and pdsch data is filled */
 326       schFillRar(rarAlloc,
 327             cell->schDlSlotInfo[slot]->rarInfo->raRnti,
 328             cell->cellCfg.phyCellId,
 329             cell->cellCfg.ssbSchCfg.ssbOffsetPointA,
 330        dlBrdcstAlloc->ssbTrans,
 331        dlBrdcstAlloc->sib1Trans);
 332
 333       SCH_FREE(cell->schDlSlotInfo[slot]->rarInfo,sizeof(RarAlloc));
 334       cell->schDlSlotInfo[slot]->rarInfo = NULLP;
 335    }
 336
 337    /* check for MSG4 */
 338    if((cell->schDlSlotInfo[dlSchedInfo.schSlotValue.dlMsgTime.slot]->dlMsgInfo != NULLP) &&
 339       (cell->schDlSlotInfo[dlSchedInfo.schSlotValue.dlMsgTime.slot]->dlMsgInfo->isMsg4Pdu))
 340    {
 341       slot = dlSchedInfo.schSlotValue.dlMsgTime.slot;
 342
 343       SCH_ALLOC(msg4Alloc, sizeof(DlMsgAlloc));
 344       if(!msg4Alloc)
 345       {
 346          DU_LOG("\nERROR  -->  SCH : Memory Allocation failed for msg4 alloc");
 347          return RFAILED;
 348       }
 349
 350       dlSchedInfo.dlMsgAlloc = msg4Alloc;
 351
 352       /* Msg4 info is copied, this was earlier filled in macSchDlRlcBoInfo */
 353       memcpy(&msg4Alloc->dlMsgInfo, cell->schDlSlotInfo[slot]->dlMsgInfo, \
 354             sizeof(DlMsgInfo));
 355
 356       /* pdcch and pdsch data is filled */
 357       schDlRsrcAllocMsg4(msg4Alloc, cell, dlSchedInfo.schSlotValue.dlMsgTime.slot, dlBrdcstAlloc->ssbTrans, dlBrdcstAlloc->sib1Trans);
 358
 359       /* PUCCH resource */
 360       schAllocPucchResource(cell, msg4Alloc->dlMsgInfo.crnti, dlSchedInfo.schSlotValue.dlMsgTime.slot);
 361
 362       SCH_FREE(cell->schDlSlotInfo[dlSchedInfo.schSlotValue.dlMsgTime.slot]->dlMsgInfo, sizeof(DlMsgInfo));
 363       cell->schDlSlotInfo[dlSchedInfo.schSlotValue.dlMsgTime.slot]->dlMsgInfo = NULL;
 364    }
 365    /* check if UL grant must be sent in this slot for a SR/BSR that had been received */
 366    for(ueIdx=0; ueIdx<cell->numActvUe; ueIdx++)
 367    {
 368       uint32_t totDataReq = 0; /* in bytes */
 369       DciInfo  *dciInfo = NULLP;
 370       SchUeCb *ueCb = NULLP;
 371
 372       ueCb = &cell->ueCb[ueIdx];
 373       /* check for SR */
 374       if(ueCb->srRcvd)
 375       {
 376          totDataReq = UL_GRANT_SIZE; /*fixing so that all control msgs can be handled in SR */
 377          ueCb->srRcvd = false;
 378       }
 379       /* check for BSR */
 380       for(lcgIdx=0; lcgIdx<MAX_NUM_LOGICAL_CHANNEL_GROUPS; lcgIdx++)
 381       {
 382         totDataReq+= ueCb->bsrInfo[lcgIdx].dataVol;
 383         ueCb->bsrInfo[lcgIdx].dataVol = 0;
 384       }
 385       if(totDataReq > 0) /* UL grant must be provided for this UE in this slot */
 386       {
 387          SchPuschInfo schPuschInfo;
 388          memset(&schPuschInfo, 0, sizeof(SchPuschInfo));
 389
 390          SCH_ALLOC(dciInfo, sizeof(DciInfo));
 391          if(!dciInfo)
 392          {
 393             DU_LOG("\nERROR  -->  SCH : Memory Allocation failed for dciInfo alloc");
 394             return RFAILED;
 395          }
 396          memset(dciInfo,0,sizeof(DciInfo));
 397          /* update the SFN and SLOT */
 398          memcpy(&dlSchedInfo.schSlotValue.ulDciTime, slotInd, sizeof(SlotIndInfo));
 399          slot = dlSchedInfo.schSlotValue.ulDciTime.slot;
 400          /* Update PUSCH allocation */
 401          schFillPuschAlloc(ueCb, slot, totDataReq, &schPuschInfo);
 402          /* Fill DCI for UL grant */
 403          schFillUlDci(ueCb, schPuschInfo, dciInfo);
 404          memcpy(&dciInfo->slotIndInfo, &dlSchedInfo.schSlotValue.ulDciTime, sizeof(SlotIndInfo));
 405          dlSchedInfo.ulGrant = dciInfo;
 406       }
 407    }
 408
 409    /* Check for pending BO grant for LC */
 410    if((cell->schDlSlotInfo[dlSchedInfo.schSlotValue.dlMsgTime.slot]->dlMsgInfo != NULLP) &&
 411       (!cell->schDlSlotInfo[dlSchedInfo.schSlotValue.dlMsgTime.slot]->dlMsgInfo->isMsg4Pdu))
 412    {
 413       schFillBoGrantDlSchedInfo(cell, &dlSchedInfo, dlMsgAlloc);
 414    }
 415
 416    /* send msg to MAC */
 417    ret = sendDlAllocToMac(&dlSchedInfo, schInst);
 418    if(ret != ROK)
 419    {
 420       DU_LOG("\nERROR  -->  SCH : Sending DL Broadcast allocation from SCH to MAC failed");
 421       return (ret);
 422    }
 423
 424    schInitDlSlot(cell->schDlSlotInfo[slot]);
 425    schUlResAlloc(cell, schInst);
 426
 427
 428    return ret;
 429 }
 430
 431 /**********************************************************************
 432   End of file
 433  **********************************************************************/
 434
 435