src/du_app/du_cell_mgr.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 /* This file contains message handling functionality for DU cell management */
  20 #include "common_def.h"
  21 #include "lrg.h"
  22 #include "legtp.h"
  23 #include "lrg.x"
  24 #include "lkw.x"
  25 #include "rgr.h"
  26 #include "rgr.x"
  27 #include "du_app_mac_inf.h"
  28 #include "du_app_rlc_inf.h"
  29 #include "du_cfg.h"
  30 #include "du_mgr.h"
  31 #include "du_utils.h"
  32 #include "du_cell_mgr.h"
  33 #include "PCCH-Config.h"
  34 #include "PagingUE-Identity.h"
  35 #include "PagingRecord.h"
  36 #include "PagingRecordList.h"
  37 #include "PagingRrc.h"
  38 #include "PCCH-MessageType.h"
  39 #include "PCCH-Message.h"
  40 #include "odu_common_codec.h"
  41
  42 #ifdef O1_ENABLE
  43
  44 #include "AlarmInterface.h"
  45 #include "CmInterface.h"
  46
  47 #endif
  48
  49 DuMacCellDeleteReq packMacCellDeleteReqOpts[] =
  50 {
  51    packDuMacCellDeleteReq,       /* Loose coupling */
  52    MacProcCellDeleteReq,         /* TIght coupling */
  53    packDuMacCellDeleteReq        /* Light weight-loose coupling */
  54 };
  55
  56 DuMacDlPcchInd packMacDlPcchIndOpts[] =
  57 {
  58    packDuMacDlPcchInd,       /* Loose coupling */
  59    MacProcDlPcchInd,         /* TIght coupling */
  60    packDuMacDlPcchInd        /* Light weight-loose coupling */
  61 };
  62
  63 /*******************************************************************
  64  *
  65  * @brief Processes cells to be activated
  66  *
  67  * @details
  68  *
  69  *    Function : duProcCellsToBeActivated
  70  *
  71  *    Functionality:
  72  *      - Processes cells to be activated list received in F1SetupRsp
  73  *
  74  * @params[in] void
  75  * @return ROK     - success
  76  *         RFAILED - failure
  77  *
  78  * ****************************************************************/
  79 uint8_t duProcCellsToBeActivated(uint8_t *plmnStr, uint16_t nci, uint16_t nRPci)
  80 {
  81    uint8_t ret = ROK;
  82    DuCellCb *cellCb = NULLP;
  83    uint8_t cfgIdx, tmpPlmn[4];
  84
  85    for(cfgIdx=0; cfgIdx<duCb.numCfgCells; cfgIdx++)
  86    {
  87       memset(tmpPlmn, 0, 4);
  88       buildPlmnId(duCb.cfgCellLst[cfgIdx]->cellInfo.nrEcgi.plmn, tmpPlmn);
  89       if(duCb.cfgCellLst[cfgIdx]->cellInfo.nrEcgi.cellId == nci &&
  90             (strcmp((const char*)tmpPlmn, (const char*)plmnStr) == 0))
  91       {
  92          cellCb = duCb.cfgCellLst[cfgIdx];
  93          break;
  94       }
  95       else
  96       {
  97          DU_LOG("\nERROR  -->  DU APP : No Cell found for NCI %d", nci);
  98          return RFAILED;
  99       }
 100    }
 101
 102    cellCb->cellStatus = ACTIVATION_IN_PROGRESS;
 103    cellCb->cellInfo.nrPci = nRPci;
 104
 105    if((cmHashListInit(&(cellCb->pagingInfoMap), MAX_SFN, sizeof(DuPagInfoList),\
 106                 FALSE, CM_HASH_KEYTYPE_CONID, DU_APP_MEM_REGION, DU_POOL)) != ROK)
 107    {
 108       DU_LOG("ERROR  --> DU APP: Failed to Initialize the Paging Hash Map");
 109       return RFAILED;
 110    }
 111    duCb.actvCellLst[cellCb->cellId -1] = cellCb;
 112    duCb.numActvCells++;
 113
 114    if(duBuildAndSendMacCellCfg(cellCb->cellId) != ROK)
 115    {
 116       DU_LOG("\nERROR  -->  DU APP : macCellCfg build and send failed");
 117       /* Delete cell from actvCellList */
 118       duCb.actvCellLst[cellCb->cellId -1] = NULLP;
 119       --(duCb.numActvCells);
 120       ret = RFAILED;
 121    }
 122    return ret;
 123 }
 124
 125 /*******************************************************************
 126  *
 127  * @brief Handles DU F1Setup Rsp received in F1AP
 128  *
 129  * @details
 130  *
 131  *    Function : duProcF1SetupRsp
 132  *
 133  *    Functionality:
 134  *      - Handles DU F1Setup Rsp received in F1AP
 135  *
 136  * @params[in] Pointer to F1SetupRsp
 137  * @return void
 138  *
 139  ******************************************************************/
 140 void duProcF1SetupRsp()
 141 {
 142    DU_LOG("\nINFO   -->  DU_APP : F1 Setup Response received");
 143    duCb.f1Status = TRUE; //Set F1 status as true
 144 }
 145
 146 /*******************************************************************
 147 *
 148 * @brief Returns cellCb based on cell ID
 149 *
 150 * @details
 151 *
 152 *    Function : duGetCellCb
 153 *
 154 *    Functionality: Returns DU APP CellCb based on cell ID
 155 *
 156 * @params[in] F1AP_PDU_t ASN decoded F1AP message
 157 * @return ROK     - success
 158 *         RFAILED - failure
 159 *
 160 * ****************************************************************/
 161 uint8_t duGetCellCb(uint16_t cellId, DuCellCb **cellCb)
 162 {
 163    uint8_t cellIdx = 0;
 164
 165    for(cellIdx=0; cellIdx < MAX_NUM_CELL; cellIdx++)
 166    {
 167       if(duCb.actvCellLst[cellIdx] && (duCb.actvCellLst[cellIdx]->cellId == cellId))
 168       {
 169          *cellCb = duCb.actvCellLst[cellIdx];
 170               break;
 171       }
 172    }
 173
 174    if(!*cellCb)
 175    {
 176       DU_LOG("\nERROR  -->  DU APP : Cell Id %d not found in DU APP", cellId);
 177       return RFAILED;
 178    }
 179
 180    return ROK;
 181 }
 182
 183 /******************************************************************************
 184 * @brief Check Paging Record for a Particular Paging Frame
 185 *
 186 * @details
 187 *
 188 *   Function : checkPagingRecord
 189 *
 190 *   Functionality:
 191 *           Check Paging Record for a Particular Paging Frame
 192 *
 193 *  @params[in] DuCellCb *cellCb
 194 *
 195 *  @return ROK/RFAILURE (uint8_t return)
 196 *
 197 *
 198 ******************************************************************************/
 199 uint8_t checkPagingRecord(DuCellCb *cellCb)
 200 {
 201    uint16_t pf = 0;
 202    DuPagInfoList *pagInfoLLFromPF = NULLP;
 203    DuPagUeList *pagInfo = NULLP;
 204
 205    /*DUAPP may send PagingReq to MAC for future SFN so that Schedular can
 206     * schedule Paging on the exact occurence of the Slot.*/
 207    pf = (cellCb->currSlotInfo.sfn + PAGING_SCHED_DELTA) % MAX_SFN;
 208
 209    pagInfoLLFromPF = findPagingInfoFromMap(pf, &(cellCb->pagingInfoMap));
 210    if(pagInfoLLFromPF == NULLP)
 211    {
 212       /*No Page is present for pf thus exiting*/
 213       return ROK;
 214    }
 215
 216    do
 217    {
 218       pagInfo = handlePageInfoLL(pf, NULLD, &(pagInfoLLFromPF->pagInfoList), TRAVERSE_ALL);
 219       if(pagInfo != NULLP)
 220       {
 221          if(BuildAndSendDlPcchIndToMac(cellCb->cellId, pf, pagInfo->i_s, &(pagInfo->pagUeList)) != ROK)
 222          {
 223             DU_LOG("\nERROR  -->  DU APP: Issue in Building Page RRC PDU i_s:%d",pagInfo->i_s);
 224             return RFAILED;
 225          }
 226          handlePageInfoLL(pf, pagInfo->i_s, &(pagInfoLLFromPF->pagInfoList), DELETE);
 227       }
 228       if(pagInfoLLFromPF->pagInfoList.first == NULLP)
 229       {
 230          break;
 231       }
 232    }while(pagInfo != NULLP);
 233
 234    cmHashListDelete(&(cellCb->pagingInfoMap), (PTR)pagInfoLLFromPF);
 235    DU_FREE(pagInfoLLFromPF, sizeof(DuPagInfoList));
 236    return ROK;
 237 }
 238
 239 /******************************************************************
 240  *
 241  * @brief Send pcch indication to MAC
 242  *
 243  * @details
 244  *
 245  *    Function : sendDlPcchIndToMac
 246  *
 247  *    Functionality: Send pcch indication to MAC
 248  *
 249  * @Params[in] MacPcchInd *pcchInd
 250  * @return ROK     - success
 251  *         RFAILED - failure
 252  *
 253  * ****************************************************************/
 254
 255 uint8_t sendDlPcchIndToMac(MacPcchInd *pcchInd)
 256 {
 257    uint8_t ret = ROK;
 258    Pst pst;
 259
 260    if(pcchInd)
 261    {
 262       /* Fill Pst */
 263       FILL_PST_DUAPP_TO_MAC(pst, EVENT_MAC_DL_PCCH_IND);
 264
 265       ret = (*packMacDlPcchIndOpts[pst.selector])(&pst, pcchInd);
 266       if(ret == RFAILED)
 267       {
 268          DU_LOG("\nERROR  -->  DU APP : sendDlPcchIndToMac(): Failed to DL PCCH indication to MAC");
 269       }
 270    }
 271    else
 272    {
 273       DU_LOG("\nERROR  -->  DU APP: sendDlPcchIndToMac(): Received pcchInd is NULLP");
 274       ret = RFAILED;
 275    }
 276    return ret;
 277 }
 278
 279
 280 /*****************************************************************
 281 * @brief Handles slot indication from MAC
 282 *
 283 * @details
 284 *
 285 *   Function : duHandleSlotInd
 286 *
 287 *   Functionality:
 288 *       Handles  slot indication from MAC
 289 *
 290 *  @params[in] Post structure pointer
 291 *              SlotTimingInfo *slotIndInfo
 292 *  @return ROK     - success
 293 *          RFAILED - failure
 294 *
 295 *
 296 *****************************************************************/
 297 uint8_t duHandleSlotInd(Pst *pst, SlotTimingInfo *slotIndInfo)
 298 {
 299    uint8_t cellIdx = 0, ret = ROK;
 300    DuCellCb *duCellCb = NULLP;
 301
 302    if(slotIndInfo)
 303    {
 304       GET_CELL_IDX(slotIndInfo->cellId, cellIdx);
 305       duCellCb = duCb.actvCellLst[cellIdx];
 306
 307       if(duCellCb)
 308       {
 309          duCellCb->currSlotInfo.sfn = slotIndInfo->sfn;
 310          duCellCb->currSlotInfo.slot = slotIndInfo->slot;
 311          checkPagingRecord(duCellCb);
 312       }
 313       else
 314       {
 315          DU_LOG("\nERROR  -->  DU APP : CellId[%d] doesnot exist", slotIndInfo->cellId);
 316          ret = RFAILED;
 317       }
 318       DU_FREE_SHRABL_BUF(pst->region, pst->pool, slotIndInfo, sizeof(SlotTimingInfo));
 319    }
 320    else
 321    {
 322       DU_LOG("\nERROR  -->  DU APP : Recevied null pointer from MAC");
 323       ret = RFAILED;
 324    }
 325    return(ret);
 326 }
 327 /*******************************************************************
 328  *
 329  * @brief Handles cell up indication from MAC
 330  *
 331  * @details
 332  *
 333  *    Function : duHandleCellUpInd
 334  *
 335  *    Functionality:
 336  *      Handles cell up indication from MAC
 337  *
 338  * @params[in] Post structure pointer
 339  *             cell Up info
 340  * @return ROK     - success
 341  *         RFAILED - failure
 342  *
 343  * ****************************************************************/
 344 uint8_t duHandleCellUpInd(Pst *pst, OduCellId *cellId)
 345 {
 346    DuCellCb *cellCb = NULLP;
 347
 348    if(cellId->cellId <=0 || cellId->cellId > MAX_NUM_CELL)
 349    {
 350       DU_LOG("\nERROR  -->  DU APP : Invalid Cell Id %d in duHandleCellUpInd()", cellId->cellId);
 351       return RFAILED;
 352    }
 353
 354    if(duGetCellCb(cellId->cellId, &cellCb) != ROK)
 355       return RFAILED;
 356
 357    if((cellCb != NULL) && (cellCb->cellStatus == ACTIVATION_IN_PROGRESS))
 358    {
 359       DU_LOG("\nINFO   -->  DU APP : 5G-NR Cell %d is UP", cellId->cellId);
 360       cellCb->cellStatus = ACTIVATED;
 361       gCellStatus = CELL_UP;
 362
 363       if(duCfgParam.tempSliceCfg.rrmPolicy)
 364          BuildAndSendSliceConfigReq(duCfgParam.tempSliceCfg.rrmPolicy, duCfgParam.tempSliceCfg.totalRrmPolicy, duCfgParam.tempSliceCfg.totalSliceCount);
 365 #ifdef O1_ENABLE
 366       DU_LOG("\nINFO   -->  DU APP : Raise cell UP alarm for cell id=%d", cellId->cellId);
 367       raiseCellAlrm(CELL_UP_ALARM_ID, cellId->cellId);
 368       setCellOpState(cellId->cellId, ENABLED, ACTIVE);
 369 #endif
 370
 371    }
 372
 373    if((pst->selector == ODU_SELECTOR_LWLC) || (pst->selector == ODU_SELECTOR_TC))
 374       DU_FREE_SHRABL_BUF(pst->region, pst->pool, cellId, sizeof(OduCellId));
 375    return ROK;
 376 }
 377
 378 /*******************************************************************
 379  *
 380  * @brief Handle Cell delete response from MAC
 381  *
 382  * @details
 383  *
 384  *    Function : DuProcMacCellDeleteRsp
 385  *
 386  *    Functionality: Handle Cell delete response from MAC
 387  *
 388  * @params[in] Pointer to MacCellDeleteRsp and Pst
 389  * @return ROK     - success
 390  *         RFAILED - failure
 391  *
 392  * ****************************************************************/
 393
 394 uint8_t DuProcMacCellDeleteRsp(Pst *pst, MacCellDeleteRsp *deleteRsp)
 395 {
 396    uint8_t ret = ROK;
 397    uint16_t cellIdx=0, pfIdx=0;
 398    DuPagInfoList *pagInfoLLFromPF=NULLP;
 399
 400    if(deleteRsp)
 401    {
 402       if(deleteRsp->result == SUCCESSFUL_RSP)
 403       {
 404          GET_CELL_IDX(deleteRsp->cellId, cellIdx);
 405          DU_LOG("\nINFO   -->  DU APP : MAC CELL Delete Response : SUCCESS [CELL IDX : %d]", deleteRsp->cellId);
 406          if(duCb.actvCellLst[cellIdx] && (duCb.actvCellLst[cellIdx]->cellId == deleteRsp->cellId))
 407          {
 408             for(pfIdx =0; pfIdx < MAX_SFN; pfIdx++)
 409             {
 410                pagInfoLLFromPF = findPagingInfoFromMap(pfIdx, &(duCb.actvCellLst[cellIdx]->pagingInfoMap));
 411                if(pagInfoLLFromPF)
 412                {
 413                   cmHashListDelete(&(duCb.actvCellLst[cellIdx]->pagingInfoMap), (PTR)pagInfoLLFromPF);
 414                   DU_FREE(pagInfoLLFromPF, sizeof(DuPagInfoList));
 415                }
 416             }
 417
 418             memset(duCb.actvCellLst[cellIdx], 0, sizeof(DuCellCb));
 419             gCellStatus = CELL_DOWN;
 420
 421 #ifdef O1_ENABLE
 422             DU_LOG("\nINFO   -->  DU APP : Raise cell down alarm for cell id=%d", deleteRsp->cellId);
 423             raiseCellAlrm(CELL_DOWN_ALARM_ID, deleteRsp->cellId);
 424             setCellOpState(deleteRsp->cellId, DISABLED, INACTIVE);
 425 #endif
 426
 427             duCb.numActvCells--;
 428             duCb.numCfgCells--;
 429             DU_FREE(duCb.actvCellLst[cellIdx], sizeof(DuCellCb));
 430
 431          }
 432          else
 433          {
 434             DU_LOG("\nERROR  -->  DU APP : DuProcMacCellDeleteRsp(): CellId [%d] doesnot exist", deleteRsp->cellId);
 435             ret = RFAILED;
 436          }
 437       }
 438       else
 439       {
 440          DU_LOG("\nERROR  -->  DU APP : DuProcMacCellDeleteRsp(): MAC CELL Delete Response : FAILED\
 441          [CELL IDX : %d]", deleteRsp->cellId);
 442          ret = RFAILED;
 443       }
 444       DU_FREE_SHRABL_BUF(pst->region, pst->pool, deleteRsp, sizeof(MacCellDeleteRsp));
 445    }
 446    else
 447    {
 448       DU_LOG("\nERROR  -->  DU APP : DuProcMacCellDeleteRsp(): Received MAC cell delete response is NULL");
 449       ret = RFAILED;
 450    }
 451    return ret;
 452 }
 453
 454 /*******************************************************************
 455  *
 456  * @brief Sending Cell Delete Req To Mac
 457  *
 458  * @details
 459  *
 460  *    Function : sendCellDeleteReqToMac
 461  *
 462  *    Functionality:
 463  *     sending Cell Delete Req To Mac
 464  *
 465  *  @params[in]    uint16_t cellId
 466  *  @return ROK     - success
 467  *          RFAILED - failure
 468  *
 469  *
 470  *****************************************************************/
 471
 472 uint8_t sendCellDeleteReqToMac(uint16_t cellId)
 473 {
 474    Pst pst;
 475    uint8_t ret=ROK;
 476    MacCellDelete *cellDelete = NULLP;
 477
 478    DU_ALLOC_SHRABL_BUF(cellDelete, sizeof(MacCellDelete));
 479    if(cellDelete)
 480    {
 481       cellDelete->cellId = cellId;
 482       FILL_PST_DUAPP_TO_MAC(pst, EVENT_MAC_CELL_DELETE_REQ);
 483
 484       DU_LOG("\nINFO   -->  DU APP : Sending Cell Delete Request to MAC");
 485       /* Processing one Cell at a time to MAC */
 486       ret = (*packMacCellDeleteReqOpts[pst.selector])(&pst, cellDelete);
 487       if(ret == RFAILED)
 488       {
 489          DU_LOG("\nERROR  -->  DU APP : sendCellDeleteReqToMac(): Failed to send Cell delete Req to MAC");
 490          DU_FREE_SHRABL_BUF(DU_APP_MEM_REGION, DU_POOL, cellDelete, sizeof(MacCellDelete));
 491       }
 492    }
 493    else
 494    {
 495       DU_LOG("\nERROR  -->   DU APP : sendCellDeleteReqToMac(): Failed to allocate memory");
 496       ret = RFAILED;
 497    }
 498    return ret;
 499 }
 500
 501 /*******************************************************************
 502  *
 503  * @brief DU preocess Cell Delete Req to MAC
 504  *
 505  * @details
 506  *
 507  *    Function : duSendCellDeletReq
 508  *
 509  *    Functionality: DU process Cell Delete Req to MAC
 510  *
 511  * @params[in] uint16_t cellId
 512  * @return ROK     - success
 513  *         RFAILED - failure
 514  *
 515  * ****************************************************************/
 516
 517 uint8_t duSendCellDeletReq(uint16_t cellId)
 518 {
 519    uint16_t cellIdx = 0;
 520    DU_LOG("\nINFO   -->  DU APP : Processing Cell Delete Request ");
 521    GET_CELL_IDX(cellId, cellIdx);
 522
 523    if(duCb.actvCellLst[cellIdx] == NULLP)
 524    {
 525       DU_LOG("\nERROR  -->  DU APP : duSendCellDeletReq(): CellId[%d] is not found", cellId);
 526       return RFAILED;
 527    }
 528
 529    if(duCb.actvCellLst[cellIdx]->cellId != cellId)
 530    {
 531       DU_LOG("\nERROR  -->  DU APP : duSendCellDeletReq(): CellId[%d] is not found", cellId);
 532       return RFAILED;
 533
 534    }
 535
 536    if(duCb.actvCellLst[cellIdx]->cellStatus != DELETION_IN_PROGRESS)
 537    {
 538       DU_LOG("\nERROR  -->  DU APP : duSendCellDeletReq(): CellStatus[%d] of cellId[%d] is not correct.\
 539       Expected CellStatus is DELETION_IN_PROGRESS",duCb.actvCellLst[cellIdx]->cellStatus, cellId);
 540       return RFAILED;
 541    }
 542
 543    if(duBuildAndSendMacCellStop(cellId) == RFAILED)
 544    {
 545       DU_LOG("\nERROR  -->  DU APP : duSendCellDeletReq(): Failed to build and send cell stop request to MAC for\
 546             cellId[%d]",cellId);
 547       return RFAILED;
 548    }
 549
 550    return ROK;
 551 }
 552
 553 /*******************************************************************
 554  * @brief Free PCCH PDU structure
 555  *
 556  * @details
 557  *
 558  *    Function : freePcchPdu
 559  *
 560  *    Functionality:  Free PCCH PDU structure
 561  *
 562  * @params[in] PCCH_Message_t *pcchMsg
 563  *
 564  * @return void
 565  *
 566  * ****************************************************************/
 567 void freePcchPdu(PCCH_Message_t *pcchMsg)
 568 {
 569    PagingRrc_t *pagingMsg = NULLP;
 570    uint8_t recordIdx = 0;
 571
 572    if(pcchMsg != NULLP)
 573    {
 574       if(pcchMsg->message.choice.c1  != NULLP)
 575       {
 576          pagingMsg = pcchMsg->message.choice.c1->choice.paging;
 577          if(pagingMsg != NULLP)
 578          {
 579             if(pagingMsg->pagingRecordList)
 580             {
 581                if(pagingMsg->pagingRecordList->list.array != NULLP)
 582                {
 583                   for(recordIdx = 0; recordIdx <  pagingMsg->pagingRecordList->list.count; recordIdx++)
 584                   {
 585                      if(pagingMsg->pagingRecordList->list.array[recordIdx] != NULLP)
 586                      {
 587                         DU_FREE(pagingMsg->pagingRecordList->list.array[recordIdx]->ue_Identity.choice.ng_5G_S_TMSI.buf,\
 588                                  pagingMsg->pagingRecordList->list.array[recordIdx]->ue_Identity.choice.ng_5G_S_TMSI.size);
 589                         DU_FREE(pagingMsg->pagingRecordList->list.array[recordIdx], sizeof(PagingRecord_t));
 590                      }
 591                   }
 592                   DU_FREE(pagingMsg->pagingRecordList->list.array, pagingMsg->pagingRecordList->list.size);
 593                }
 594                DU_FREE(pagingMsg->pagingRecordList, sizeof(PagingRecordList_t));
 595             }
 596             DU_FREE(pcchMsg->message.choice.c1->choice.paging, sizeof(PagingRrc_t));
 597          }
 598          DU_FREE(pcchMsg->message.choice.c1 , sizeof(PCCH_MessageType_t));
 599       }
 600       DU_FREE(pcchMsg , sizeof(PCCH_Message_t));
 601    }
 602 }
 603
 604 /*******************************************************************
 605  * @brief Builds the Pcch RRC PDU and forwards it to MAC
 606  *
 607  * @details
 608  *
 609  *    Function : BuildAndSendDlPcchIndToMac
 610  *
 611  *    Functionality: Builds the Pcch RRC PDU[As per Spec 38.331, Annexure A]
 612  *                   and forwards it to MAC as Buffer along with PF and i_s
 613  *
 614  * @params[in] uint16_t cellId, uint16_t pf, uint8_t i_s,CmLListCp *pageUeLL
 615  *
 616  * @return ROK     - success
 617  *         RFAILED - failure
 618  *
 619  * ****************************************************************/
 620 uint8_t BuildAndSendDlPcchIndToMac(uint16_t cellId, uint16_t pf, uint8_t i_s, CmLListCp *pageUeLL)
 621 {
 622    CmLList        *node = NULLP, *next = NULLP;
 623    DuPagUeRecord  *ueRecord = NULLP;
 624    PCCH_Message_t *pcchMsg = NULLP;
 625    asn_enc_rval_t encRetVal;
 626    PagingRrc_t    *pagingMsg = NULLP;
 627    MacPcchInd     *macPcchInd = NULLP;
 628    uint8_t        recordIdx = 0, ret = RFAILED;
 629
 630    /*As per 38.473 Sec 9.3.1.39,5G-S-TMSI :48 Bits >>  Bytes and 0 UnusedBits */
 631    uint8_t         totalByteInTmsi = 6, unusedBitsInTmsi = 0;
 632
 633    if(pageUeLL == NULLP || pageUeLL->count == 0)
 634    {
 635       DU_LOG("\nERROR  -->  DU APP: UE Page Record LL is empty");
 636       return RFAILED;
 637    }
 638
 639    while(true)
 640    {
 641       memset(&encRetVal, 0, sizeof(asn_enc_rval_t));
 642       DU_ALLOC(pcchMsg , sizeof(PCCH_Message_t));
 643       if(pcchMsg == NULLP)
 644       {
 645          DU_LOG("\nERROR  -->  DU APP: BuildAndSendDlPcchIndToMac(): (pccchMsg) Memory Alloction failed!");
 646          break;
 647       }
 648       pcchMsg->message.present = PCCH_MessageType_PR_c1;
 649       DU_ALLOC(pcchMsg->message.choice.c1 , sizeof(PCCH_MessageType_t));
 650       if(pcchMsg->message.choice.c1 == NULLP)
 651       {
 652          DU_LOG("\nERROR  -->  DU APP: BuildAndSendDlPcchIndToMac(); (C1) Memory Alloction failed!");
 653          break;
 654       }
 655       pcchMsg->message.choice.c1->present = PCCH_MessageType__c1_PR_paging;
 656       DU_ALLOC(pcchMsg->message.choice.c1->choice.paging, sizeof(PagingRrc_t));
 657
 658       pagingMsg = pcchMsg->message.choice.c1->choice.paging;
 659       if(pagingMsg == NULLP)
 660       {
 661          DU_LOG("\nERROR  -->  DU APP: BuildAndSendDlPcchIndToMac(); (Paging) Memory Alloction failed!");
 662          break;
 663       }
 664       DU_ALLOC(pagingMsg->pagingRecordList, sizeof(PagingRecordList_t));
 665       if(pagingMsg->pagingRecordList == NULLP)
 666       {
 667          DU_LOG("\nERROR  -->  DU APP: BuildAndSendDlPcchIndToMac(); (Paging Record List) Memory Alloction failed!");
 668          break;
 669       }
 670
 671       pagingMsg->pagingRecordList->list.count = pageUeLL->count;
 672
 673        /*As per Spec 38.331, maxNrofPageRec : 32 [Maximum number of page records]*/
 674       if(pageUeLL->count > MAX_PAGING_UE_RECORDS)
 675       {
 676          pagingMsg->pagingRecordList->list.count = MAX_PAGING_UE_RECORDS;
 677       }
 678
 679       pagingMsg->pagingRecordList->list.size = pageUeLL->count * (sizeof(PagingRecord_t *));
 680       DU_ALLOC(pagingMsg->pagingRecordList->list.array, pagingMsg->pagingRecordList->list.size);
 681       if(pagingMsg->pagingRecordList->list.array == NULLP)
 682       {
 683          DU_LOG("\nERROR  -->  DU APP: BuildAndSendDlPcchIndToMac(); (Array) Memory Alloction failed!");
 684          break;
 685       }
 686       for(recordIdx = 0; recordIdx < pageUeLL->count; recordIdx++)
 687       {
 688          DU_ALLOC(pagingMsg->pagingRecordList->list.array[recordIdx], sizeof(PagingRecord_t));
 689          if(pagingMsg->pagingRecordList->list.array[recordIdx] == NULLP)
 690          {
 691             DU_LOG("\nERROR  -->  DU APP: BuildAndSendDlPcchIndToMac(); (Record) Memory Alloction failed!");
 692             break;
 693          }
 694       }
 695       recordIdx = 0;
 696       node = pageUeLL->first;
 697       while(node && (recordIdx < MAX_PAGING_UE_RECORDS))
 698       {
 699          next = node->next;
 700          ueRecord = (DuPagUeRecord *)node->node;
 701          if(ueRecord)
 702          {
 703             /*TODO : When Connected Mode Paging will be supported then I_RNTI will be introduced*/
 704             pagingMsg->pagingRecordList->list.array[recordIdx]->ue_Identity.present = PagingUE_Identity_PR_ng_5G_S_TMSI;
 705             pagingMsg->pagingRecordList->list.array[recordIdx]->ue_Identity.choice.ng_5G_S_TMSI.size = totalByteInTmsi*sizeof(uint8_t);
 706             DU_ALLOC(pagingMsg->pagingRecordList->list.array[recordIdx]->ue_Identity.choice.ng_5G_S_TMSI.buf,\
 707                   pagingMsg->pagingRecordList->list.array[recordIdx]->ue_Identity.choice.ng_5G_S_TMSI.size);
 708             if(pagingMsg->pagingRecordList->list.array[recordIdx]->ue_Identity.choice.ng_5G_S_TMSI.buf == NULLP)
 709             {
 710                DU_LOG("\nERROR  -->  DU APP: BuildAndSendDlPcchIndToMac(); (5gsTmsi buffer) Memory Allocation failed!");
 711                break;
 712             }
 713             fillBitString(&pagingMsg->pagingRecordList->list.array[recordIdx]->ue_Identity.choice.ng_5G_S_TMSI,\
 714                   unusedBitsInTmsi, totalByteInTmsi, ueRecord->sTmsi);
 715             recordIdx++;
 716          }
 717
 718          if(duDelNodeFromLList(pageUeLL, node) == ROK)
 719              DU_FREE(ueRecord, sizeof(DuPagUeRecord));
 720          node = next;
 721       }
 722       if(node != NULLP && (recordIdx < MAX_PAGING_UE_RECORDS))
 723       {
 724          /*This leg is hit because Whole UE REcord List was not traversed as
 725           * some issue happened thus exiting the main while*/
 726          break;
 727       }
 728       xer_fprint(stdout, &asn_DEF_PCCH_Message, pcchMsg);
 729       memset(encBuf, 0, ENC_BUF_MAX_LEN);
 730       encBufSize = 0;
 731        /* Encode the PCCH RRC PDU as APER */
 732       encRetVal = aper_encode(&asn_DEF_PCCH_Message, 0, pcchMsg, PrepFinalEncBuf,\
 733             encBuf);
 734
 735       if(encRetVal.encoded == ENCODE_FAIL)
 736       {
 737          DU_LOG("\nERROR  -->  F1AP : Could not encode Paging structure (at %s)\n",\
 738                encRetVal.failed_type ? encRetVal.failed_type->name : "unknown");
 739          break;
 740       }
 741       else
 742       {
 743          DU_LOG("\nDEBUG  -->  F1AP : Created APER encoded buffer for RRC PDU for Pcch indication \n");
 744
 745          DU_ALLOC_SHRABL_BUF(macPcchInd, sizeof(MacPcchInd));
 746          if(macPcchInd == NULLP)
 747          {
 748             DU_LOG("\nERROR  -->  DU APP: BuildAndSendDlPcchIndToMac(); (macPcchInd) Memory Alloction failed!");
 749             break;
 750          }
 751
 752          macPcchInd->cellId = cellId;
 753          macPcchInd->pf = pf;
 754          macPcchInd->i_s = i_s;
 755          macPcchInd->pduLen = encBufSize;
 756          DU_ALLOC_SHRABL_BUF(macPcchInd->pcchPdu, macPcchInd->pduLen);
 757          if(macPcchInd->pcchPdu == NULLP)
 758          {
 759             DU_LOG("\nERROR  -->  DU APP: BuildAndSendDlPcchIndToMac(); (PcchPDU) Memory Alloction failed!");
 760             break;
 761          }
 762          memcpy(macPcchInd->pcchPdu, encBuf, macPcchInd->pduLen);
 763          ret = sendDlPcchIndToMac(macPcchInd);
 764          if(ret != ROK)
 765          {
 766             DU_FREE_SHRABL_BUF(DU_APP_MEM_REGION, DU_POOL, macPcchInd->pcchPdu, macPcchInd->pduLen);
 767             DU_FREE_SHRABL_BUF(DU_APP_MEM_REGION, DU_POOL, macPcchInd, sizeof(MacPcchInd));
 768             break;
 769          }
 770       }
 771       ret = ROK;
 772       break;
 773    }
 774    freePcchPdu(pcchMsg);
 775    return ret;
 776 }
 777
 778 /*******************************************************************
 779  * @brief Keeping the record of Paging having a particular SFN and index associated
 780  *
 781  * @details
 782  *
 783  *    Function : insertPagingRecord
 784  *
 785  *    Functionality:  Insert record of Paging assoc with particular SFN and index associated
 786  *
 787  * @params[in] DuCellCb* cellCb, uint16_t iterations
 788  *             DuPagingMsg  rcvdF1apPagingParam
 789  *
 790  * @return ROK     - success
 791  *         RFAILED - failure
 792  *
 793  * ****************************************************************/
 794 uint8_t insertPagingRecord(DuCellCb* cellCb, DuPagingMsg *rcvdF1apPagingParam, uint16_t iterations)
 795 {
 796    uint16_t maxIterations = 0;
 797    DuPagInfoList *pagInfoLLFromPF = NULLP;
 798    DuPagUeList  *pageUeLL = NULLP;
 799    DuPagUeRecord *ueRecord = NULLP;
 800
 801 #if 0
 802    printPageList(&(cellCb->pagingInfoMap));
 803 #endif
 804
 805    /*MAX Iteration : A UE can be paged at every T frames thus MAX determines
 806     *how many Paging Frame(s) can be considered for Paging this UE*/
 807    maxIterations = MAX_SFN/rcvdF1apPagingParam->T;
 808    if(iterations >= maxIterations)
 809    {
 810       DU_LOG("\nERROR  --> DU APP: MAX Iterations reached for UEID:%d, thus Paging is dropped!", rcvdF1apPagingParam->pagUeId);
 811       return RFAILED;
 812    }
 813
 814    /*[Step1]: Extracting the PF from the HasMap between PF and PagingInfoList*/
 815    pagInfoLLFromPF = findPagingInfoFromMap(rcvdF1apPagingParam->pagingFrame, &(cellCb->pagingInfoMap));
 816    if(pagInfoLLFromPF != NULLP)
 817    {
 818       /*[Step2]: Extracting the PageInfo List for the Paging Indices(i_s)*/
 819       pageUeLL = handlePageInfoLL(rcvdF1apPagingParam->pagingFrame, rcvdF1apPagingParam->i_s, \
 820             &(pagInfoLLFromPF->pagInfoList), CREATE);
 821
 822       if(pageUeLL != NULLP)
 823       {
 824          /*[Step3]: Check whether MAX UE Record against this PF and i_s has reached(Spec 38.331, Annexure A)*/
 825          if(pageUeLL->pagUeList.count < MAX_PAGING_UE_RECORDS)
 826          {
 827             /*[Step4]: Insert the Paging Record to the end of the UE record List*/
 828             ueRecord = handlePageUeLL(rcvdF1apPagingParam->pagUeId, rcvdF1apPagingParam->sTmsi,\
 829                   &(pageUeLL->pagUeList), CREATE);
 830
 831             if(ueRecord == NULLP)
 832             {
 833                DU_LOG("\nERROR  --> DU APP: Unable to create UE Record in PagingList");
 834                return RFAILED;
 835             }
 836             DU_LOG("\nDEBUG  --> DU APP: UE Record created successfully in PagingList");
 837             return ROK;
 838          }
 839          else
 840          {
 841             /*Since MAX Page record has reached for this PF thus calculating and
 842              *moving this UE to next Paging Cycle*/
 843             DU_LOG("\nINFO   --> DU APP: Max Page Record reached for PagingFrame:%d",rcvdF1apPagingParam->pagingFrame);
 844             rcvdF1apPagingParam->pagingFrame = ((rcvdF1apPagingParam->pagingFrame + rcvdF1apPagingParam->T) % MAX_SFN);
 845             iterations++;
 846
 847             return insertPagingRecord(cellCb, rcvdF1apPagingParam, iterations);
 848          }
 849       }
 850    }
 851    /*Reaching here means that PF has no entry in the PageLists,
 852     *Thus creating, Updating and inseritng the Paging Map, List and UE record.*/
 853
 854    DU_ALLOC(pagInfoLLFromPF, sizeof(DuPagInfoList));
 855
 856    if(pagInfoLLFromPF == NULLP)
 857    {
 858       DU_LOG("\nERROR  --> DU APP: PageInfo Map allocation failed.");
 859       return RFAILED;
 860    }
 861    pagInfoLLFromPF->pf = rcvdF1apPagingParam->pagingFrame;
 862    pageUeLL = handlePageInfoLL(rcvdF1apPagingParam->pagingFrame, rcvdF1apPagingParam->i_s, &(pagInfoLLFromPF->pagInfoList), CREATE);
 863    ueRecord = handlePageUeLL(rcvdF1apPagingParam->pagUeId, rcvdF1apPagingParam->sTmsi, &(pageUeLL->pagUeList), CREATE);
 864    if(cmHashListInsert(&(cellCb->pagingInfoMap), (PTR)pagInfoLLFromPF, (uint8_t *)&(pagInfoLLFromPF->pf), sizeof(uint16_t)) == RFAILED)
 865    {
 866       DU_LOG("\nERROR  --> DU APP: Hash Map Insertion Failed for PF:%d.",rcvdF1apPagingParam->pagingFrame);
 867    }
 868
 869 #if 0
 870    printPageList(&(cellCb->pagingInfoMap));
 871 #endif
 872
 873    return ROK;
 874
 875
 876 }
 877
 878 /*******************************************************************
 879  * @brief Calculate and fill paging information of a UE belongs to a particular cell
 880  *
 881  * @details
 882  *
 883  *    Function : calcAndFillPagingInfoInCellCb
 884  *
 885  *    Functionality: Calculate PO and i_s and
 886  *                   fill paging information of a UE in DuCellCb
 887  *
 888  * @params[in] DuCellCb* cellCb, uint8_t pagUeId,
 889  *             DuPagingMsg  rcvdF1apPagingParam
 890  *
 891  * @return ROK     - success
 892  *         RFAILED - failure
 893  *
 894  * ****************************************************************/
 895 uint8_t calcAndFillPagingInfoInCellCb(DuCellCb* cellCb, DuPagingMsg *rcvdF1apPagingParam)
 896 {
 897    uint8_t ns = 0;
 898    uint16_t T=0, N=0, pagingFrame = 0, n = 0;
 899    uint16_t currentSfn = 0, sfn = 0, newSfn = 0;
 900    PcchCfg   duPcchCfg;
 901
 902    if(cellCb)
 903    {
 904       /* calculate paging frame and paging offset */
 905       duPcchCfg = duCfgParam.sib1Params.srvCellCfgCommSib.dlCfg.pcchCfg;
 906       rcvdF1apPagingParam->pagingFrameOffset = duPcchCfg.pageFrameOffset;
 907       ns = duPcchCfg.ns;
 908
 909       /*
 910        * Fill the Value of T (DRX cycle of the UE)
 911        * T = min(UE Specific DRX value allocated by upper layers, default DRX
 912        * broadcast in System Information) */
 913       if((rcvdF1apPagingParam->pagingDrxPres) && (duPcchCfg.dfltPagingCycle > rcvdF1apPagingParam->pagingDrx))
 914       {
 915          T = rcvdF1apPagingParam->pagingDrx;
 916       }
 917       else
 918       {
 919          T = duPcchCfg.dfltPagingCycle;
 920       }
 921       rcvdF1apPagingParam->T = T;
 922
 923        /* N= number of total paging frames in T */
 924
 925       switch(duPcchCfg.nAndPagingFrmOffsetType)
 926       {
 927          case PCCH_Config__nAndPagingFrameOffset_PR_oneT:
 928             N = T;
 929             break;
 930          case PCCH_Config__nAndPagingFrameOffset_PR_halfT:
 931             N = T/2;
 932             break;
 933          case PCCH_Config__nAndPagingFrameOffset_PR_quarterT:
 934             N = T/4;
 935             break;
 936          case PCCH_Config__nAndPagingFrameOffset_PR_oneEighthT:
 937             N = T/8;
 938             break;
 939          case PCCH_Config__nAndPagingFrameOffset_PR_oneSixteenthT:
 940             N = T/16;
 941             break;
 942          default:
 943             N = T;
 944             break;
 945       }
 946
 947        /* calculate the Value of pagingFrame */
 948       /*Refer: 38.304 Sec 7.1: (SFN + PF_offset) mod T = (T div N)*(UE_ID mod N)*/
 949       //RHS of above formula
 950       pagingFrame = (T / N) * ((rcvdF1apPagingParam->pagUeId) % N);
 951
 952       //LHS of above formula
 953       if(pagingFrame)
 954       {
 955          pagingFrame = (pagingFrame - rcvdF1apPagingParam->pagingFrameOffset)%T;
 956       }
 957       else /*Paging Frame = 0 so thus PF will be calculated on Paging Cycle*/
 958       {
 959          pagingFrame = (T - rcvdF1apPagingParam->pagingFrameOffset)%T;
 960       }
 961
 962       /*Paging Frame(SFN for Paging) has to be determined from current SFN. */
 963       /*For eg: If T =128, PF(Calculated above) = 20; SFN can be 20,148,276,...
 964        * If currSFN is running as 200 then (newSFN % T) == (T/N)*(UE_ID%N)
 965        *Thus SFN at which paging has to be sent needs to be delayed and newSFN = 276*/
 966
 967       currentSfn = cellCb->currSlotInfo.sfn;
 968
 969       /*Multiplication Factor(x) to find the next best SFN to process paging*/
 970
 971       /*Below calculation will determine in which nth cycle of T (DRX cycle),new PF
 972        * may fall(Delayed one)*/
 973       if(currentSfn > pagingFrame)
 974       {
 975          n  = ((currentSfn - pagingFrame) / T) + 1;
 976       }
 977       else
 978       {
 979          n  = ((pagingFrame - currentSfn) / T) + 1;
 980       }
 981
 982       newSfn = pagingFrame + T * n;
 983
 984       /*When pagingFrame is future from currSFN then pagingFrame will be used
 985        * else pagingFrame is delayed thus newSFN will be used.*/
 986       if(currentSfn <= pagingFrame)
 987       {
 988          if(pagingFrame > currentSfn + PAGING_SCHED_DELTA)
 989          {
 990             sfn = pagingFrame;
 991          }
 992          else
 993          {
 994             sfn = newSfn;
 995          }
 996       }
 997       else
 998       {
 999
1000          if(newSfn > currentSfn + PAGING_SCHED_DELTA)
1001          {
1002             sfn = newSfn;
1003          }
1004          else /*If newSFN is near to currSFN then delay it more by T*/
1005          {
1006             newSfn = newSfn + T;
1007             sfn = newSfn;
1008          }
1009       }
1010       rcvdF1apPagingParam->pagingFrame =  (sfn % MAX_SFN);
1011       rcvdF1apPagingParam->i_s = ((uint32_t)(floor(rcvdF1apPagingParam->pagUeId / N)) % ns);
1012
1013       memcpy(&cellCb->tmpPagingInfoOfUe, rcvdF1apPagingParam, sizeof(DuPagingMsg));
1014    }
1015    else
1016    {
1017       DU_LOG("\nINFO  --> DU APP : calcAndFillPagingInfoInCellCb(): Received null pointer");
1018       return RFAILED;
1019    }
1020    return ROK;
1021 }
1022
1023 /*******************************************************************
1024  * @brief Paging Processing on a particular cell
1025  *
1026  * @details
1027  *
1028  *    Function : processPagingMsg
1029  *
1030  *    Functionality: Process Paging on a particular cell
1031  *
1032  * @params[in] uint16_t cellId
1033  *             DuPagingMsg  rcvdF1apPagingParam
1034  *
1035  * @return ROK     - success
1036  *         RFAILED - failure
1037  *
1038  * ****************************************************************/
1039 uint8_t processPagingMsg(uint16_t cellId, DuPagingMsg *rcvdF1apPagingParam)
1040 {
1041    uint16_t cellIdx = 0, iteration = 0;
1042
1043    GET_CELL_IDX(cellId, cellIdx);
1044
1045    if(duCb.actvCellLst[cellIdx] == NULLP || duCb.actvCellLst[cellIdx]->cellId != cellId)
1046    {
1047       DU_LOG("\nERROR  -->  DU APP : processPagingMsg(): CellId[%d] is not found", cellId);
1048       return RFAILED;
1049    }
1050
1051    if(calcAndFillPagingInfoInCellCb(duCb.actvCellLst[cellIdx], rcvdF1apPagingParam) != ROK)
1052    {
1053       DU_LOG("\nERROR  --> DU APP : CellCb:%d not present to fill UE Paging Information",cellId);
1054       return RFAILED;
1055    }
1056    if(insertPagingRecord(duCb.actvCellLst[cellIdx], rcvdF1apPagingParam, iteration) != ROK)
1057    {
1058       DU_LOG("\nERROR  --> DU APP : Insertion Failed ofUE Paging Information");
1059       return RFAILED;
1060    }
1061    return ROK;
1062
1063 }
1064 /**********************************************************************
1065   End of file
1066  **********************************************************************/