src/5gnrmac/mac_msg_hdl.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 /* header include files -- defines (.h)  */
  20 #include "envopt.h"        /* environment options */
  21 #include "envdep.h"        /* environment dependent */
  22 #include "envind.h"        /* environment independent */
  23 #include "gen.h"           /* general layer */
  24 #include "ssi.h"           /* system services */
  25 #include "cm5.h"           /* common timers defines */
  26 #include "cm_hash.h"       /* common hash list defines */
  27 #include "cm_llist.h"      /* common linked list defines */
  28 #include "cm_mblk.h"       /* memory management */
  29 #include "cm_tkns.h"       /* common tokens */
  30 #include "cm_lte.h"        /* common tokens */
  31 #include "rgu.h"
  32 #include "tfu.h"
  33 #include "rg_sch_inf.h"
  34 #include "rg_env.h"
  35 #include "lrg.h"
  36 #include "crg.h"
  37 #include "rg.h"
  38 #include "du_log.h"
  39 #include "lwr_mac.h"
  40
  41 /* header/extern include files (.x) */
  42 #include "gen.x"           /* general layer typedefs */
  43 #include "ssi.x"           /* system services typedefs */
  44 #include "cm5.x"           /* common timers */
  45 #include "cm_hash.x"       /* common hash list */
  46 #include "cm_lib.x"        /* common library */
  47 #include "cm_llist.x"      /* common linked list */
  48 #include "cm_mblk.x"       /* memory management */
  49 #include "cm_tkns.x"       /* common tokens */
  50 #include "cm_lte.x"        /* common tokens */
  51 #include "rgu.x"
  52 #include "tfu.x"
  53 #include "rg_sch_inf.x"
  54 #include "lrg.x"
  55 #include "crg.x"
  56 #include "rg_prg.x"
  57 #include "du_app_mac_inf.h"
  58 #include "mac_upr_inf_api.h"
  59 #include "rg.x"
  60 #include "lwr_mac_fsm.h"
  61 #include "mac.h"
  62
  63 /* This file contains message handling functionality for MAC */
  64
  65 extern MacCb  macCb;
  66
  67 extern void sendToLowerMac(uint16_t msgType, uint32_t msgLen, void *msg);
  68 uint16_t buildMacPdu(RlcMacData *dlData);
  69
  70 /* Function pointer for sending crc ind from MAC to SCH */
  71 MacSchCrcIndFunc macSchCrcIndOpts[]=
  72 {
  73    packMacSchCrcInd,
  74    macSchCrcInd,
  75    packMacSchCrcInd
  76 };
  77
  78 /* Function pointer for sending DL RLC BO Info from MAC to SCH */
  79 MacSchDlRlcBoInfoFunc macSchDlRlcBoInfoOpts[]=
  80 {
  81    packMacSchDlRlcBoInfo,
  82    macSchDlRlcBoInfo,
  83    packMacSchDlRlcBoInfo
  84 };
  85
  86 /*******************************************************************
  87  *
  88  * @brief Sends DL BO Info to SCH
  89  *
  90  * @details
  91  *
  92  *    Function : sendDlRlcBoInfoMacToSch
  93  *
  94  *    Functionality:
  95  *       Sends DL BO Info to SCH
  96  *
  97  * @params[in]
  98  * @return ROK     - success
  99  *         RFAILED - failure
 100  *
 101  ****************************************************************/
 102 int sendDlRlcBoInfoMacToSch(DlRlcBOInfo *dlBoInfo)
 103 {
 104    Pst pst;
 105
 106    fillMacToSchPst(&pst);
 107    pst.event = EVENT_DL_RLC_BO_INFO_TO_SCH;
 108
 109    return(*macSchDlRlcBoInfoOpts[pst.selector])(&pst, dlBoInfo);
 110 }
 111
 112 /*******************************************************************
 113  *
 114  * @brief Sends CRC Indication to SCH
 115  *
 116  * @details
 117  *
 118  *    Function : sendCrcIndMacToSch
 119  *
 120  *    Functionality:
 121  *       Sends CRC Indication to SCH
 122  *
 123  * @params[in]
 124  * @return ROK     - success
 125  *         RFAILED - failure
 126  *
 127   ****************************************************************/
 128 int sendCrcIndMacToSch(CrcIndInfo *crcInd)
 129 {
 130    Pst pst;
 131
 132    fillMacToSchPst(&pst);
 133    pst.event = EVENT_CRC_IND_TO_SCH;
 134
 135    return(*macSchCrcIndOpts[pst.selector])(&pst, crcInd);
 136 }
 137
 138 /*******************************************************************
 139  *
 140  * @brief Processes CRC Indication from PHY
 141  *
 142  * @details
 143  *
 144  *    Function : fapiMacCrcInd
 145  *
 146  *    Functionality:
 147  *       Processes CRC Indication from PHY
 148  *
 149  * @params[in] Post Structure Pointer
 150  *             Crc Indication Pointer
 151  * @return ROK     - success
 152  *         RFAILED - failure
 153  *
 154  * ****************************************************************/
 155 uint16_t fapiMacCrcInd(Pst *pst, CrcInd *crcInd)
 156 {
 157    CrcIndInfo   crcIndInfo;
 158
 159    DU_LOG("\nMAC : Received CRC indication");
 160
 161    /* Considering one pdu and one preamble */
 162    crcIndInfo.cellId = macCb.macCell->cellId;;
 163    crcIndInfo.crnti = crcInd->crcInfo[0].rnti;
 164    crcIndInfo.timingInfo.sfn = crcInd->timingInfo.sfn;
 165    crcIndInfo.timingInfo.slot = crcInd->timingInfo.slot;
 166    crcIndInfo.numCrcInd = crcInd->crcInfo[0].numCb;
 167    crcIndInfo.crcInd[0] = crcInd->crcInfo[0].cbCrcStatus[0];
 168
 169    return(sendCrcIndMacToSch(&crcIndInfo));
 170 }
 171
 172 /*******************************************************************
 173  *
 174  * @brief Process Rx Data Ind at MAC
 175  *
 176  * @details
 177  *
 178  *    Function : fapiMacRxDataInd
 179  *
 180  *    Functionality:
 181  *       Process Rx Data Ind at MAC
 182  *
 183  * @params[in] Post structure
 184  *             Rx Data Indication
 185  * @return ROK     - success
 186  *         RFAILED - failure
 187  *
 188  * ****************************************************************/
 189 uint16_t fapiMacRxDataInd(Pst *pst, RxDataInd *rxDataInd)
 190 {
 191    uint16_t pduIdx;
 192
 193    DU_LOG("\nMAC : Received Rx Data indication");
 194    for(pduIdx = 0; pduIdx < rxDataInd->numPdus; pduIdx++)
 195    {
 196       unpackRxData(rxDataInd->timingInfo, &rxDataInd->pdus[pduIdx]);
 197    }
 198    return ROK;
 199 }
 200
 201 /*******************************************************************
 202  *
 203  * @brief Processes DL data from RLC
 204  *
 205  * @details
 206  *
 207  *    Function : MacRlcProcDlData
 208  *
 209  *    Functionality:
 210  *      Processes DL data from RLC
 211  *
 212  * @params[in] Post structure
 213  *             DL data
 214  * @return ROK     - success
 215  *         RFAILED - failure
 216  *
 217  * ****************************************************************/
 218 uint16_t MacRlcProcDlData(Pst* pst, SpId spId, RlcMacData *dlData)
 219 {
 220    return ROK;
 221 }
 222
 223 /*******************************************************************
 224  *
 225  * @brief Processes BO status from RLC
 226  *
 227  * @details
 228  *
 229  *    Function : MacRlcProcBOStatus
 230  *
 231  *    Functionality:
 232  *      Processes BO status from RLC
 233  *
 234  * @params[in] Post structure
 235  *             BO status
 236  * @return ROK     - success
 237  *         RFAILED - failure
 238  *
 239  * ****************************************************************/
 240 uint16_t MacRlcProcBOStatus(Pst* pst, SpId spId, RlcMacBOStatus*      boStatus)
 241 {
 242    return ROK;
 243 }
 244
 245
 246 /*******************************************************************
 247  *
 248  * @brief Handles cell start reuqest from DU APP
 249  *
 250  * @details
 251  *
 252  *    Function : MacHdlCellStartReq
 253  *
 254  *    Functionality:
 255  *      Handles cell start reuqest from DU APP
 256  *
 257  * @params[in] Post structure pointer
 258  *             Cell Start Request info pointer
 259  * @return ROK     - success
 260  *         RFAILED - failure
 261  *
 262  * ****************************************************************/
 263 uint16_t MacHdlCellStartReq(Pst *pst, MacCellStartInfo  *cellStartInfo)
 264 {
 265    DU_LOG("\nMAC : Handling cell start request");
 266    sendToLowerMac(START_REQUEST, 0, cellStartInfo);
 267
 268    MAC_FREE_SHRABL_BUF(pst->region, pst->pool, cellStartInfo, \
 269            sizeof(MacCellStartInfo));
 270
 271    return ROK;
 272 }
 273
 274 /*******************************************************************
 275  *
 276  * @brief Handles cell stop request from DU APP
 277  *
 278  * @details
 279  *
 280  *    Function : MacHdlCellStartReq
 281  *
 282  *    Functionality:
 283  *        Handles cell stop request from DU APP
 284  *
 285  * @params[in] Post structure pointer
 286  *             Mac Cell stop information
 287  * @return ROK     - success
 288  *         RFAILED - failure
 289  *
 290  * ****************************************************************/
 291 uint16_t MacHdlCellStopReq(Pst *pst, MacCellStopInfo  *cellStopInfo)
 292 {
 293    #ifdef FAPI
 294    DU_LOG("\nMAC : Sending cell stop request to Lower Mac");
 295    sendToLowerMac(FAPI_STOP_REQUEST, 0, cellStopInfo);
 296    #endif
 297
 298    MAC_FREE_SHRABL_BUF(pst->region, pst->pool, cellStopInfo, \
 299            sizeof(MacCellStopInfo));
 300
 301    return ROK;
 302 }
 303
 304 /*******************************************************************
 305  *
 306  * @brief Handles DL CCCH Ind from DU APP
 307  *
 308  * @details
 309  *
 310  *    Function : MacHdlDlCcchInd
 311  *
 312  *    Functionality:
 313  *      Handles DL CCCH Ind from DU APP
 314  *
 315  * @params[in] Post structure pointer
 316  *             DL CCCH Ind pointer
 317  * @return ROK     - success
 318  *         RFAILED - failure
 319  *
 320  * ****************************************************************/
 321 uint16_t MacHdlDlCcchInd(Pst *pst, DlCcchIndInfo *dlCcchIndInfo)
 322 {
 323    DlRlcBOInfo  dlBoInfo;
 324
 325    DU_LOG("\nMAC : Handling DL CCCH IND");
 326
 327    /* TODO : Fill DL RLC Buffer status info */
 328    dlBoInfo.cellId = dlCcchIndInfo->cellId;
 329    dlBoInfo.crnti = dlCcchIndInfo->crnti;
 330    dlBoInfo.numLc = 0;
 331
 332    if(dlCcchIndInfo->msgType == RRC_SETUP)
 333    {
 334       dlBoInfo.numLc++;
 335       dlBoInfo.boInfo[dlBoInfo.numLc].lcId = 0;    // SRB 0 for msg4
 336       dlBoInfo.boInfo[dlBoInfo.numLc].dataVolume = \
 337       strlen((const char*)dlCcchIndInfo->dlCcchMsg);
 338
 339       /* storing Msg4 Pdu in raCb */
 340       if(macCb.macCell->macRaCb[0].crnti == dlCcchIndInfo->crnti)
 341       {
 342          macCb.macCell->macRaCb[0].msg4PduLen = strlen((const char*)dlCcchIndInfo\
 343          ->dlCcchMsg);
 344          MAC_ALLOC(macCb.macCell->macRaCb[0].msg4Pdu, macCb.macCell->macRaCb[0]\
 345          .msg4PduLen);
 346          if(macCb.macCell->macRaCb[0].msg4Pdu)
 347          {
 348             memcpy(macCb.macCell->macRaCb[0].msg4Pdu, dlCcchIndInfo->dlCcchMsg,\
 349             macCb.macCell->macRaCb[0].msg4PduLen);
 350          }
 351       }
 352    }
 353    sendDlRlcBoInfoMacToSch(&dlBoInfo);
 354
 355    MAC_FREE_SHRABL_BUF(pst->region, pst->pool, dlCcchIndInfo->dlCcchMsg, \
 356       strlen((const char*)dlCcchIndInfo->dlCcchMsg));
 357    MAC_FREE_SHRABL_BUF(pst->region, pst->pool, dlCcchIndInfo, sizeof(DlCcchIndInfo));
 358    return ROK;
 359
 360 }
 361
 362 /*******************************************************************
 363  *
 364  * @brief Sends UL CCCH Ind to DU APP
 365  *
 366  * @details
 367  *
 368  *    Function : macSendUlCcchInd
 369  *
 370  *    Functionality:
 371  *        MAC sends UL CCCH Ind to DU APP
 372  *
 373  * @params[in] Post structure pointer
 374  *
 375  * @return ROK     - success
 376  *         RFAILED - failure
 377  *
 378  * ****************************************************************/
 379 uint16_t macSendUlCcchInd(uint8_t *rrcContainer, uint16_t cellId, uint16_t crnti)
 380 {
 381    Pst pst;
 382         uint8_t ret = ROK;
 383    UlCcchIndInfo *ulCcchIndInfo = NULLP;
 384
 385    MAC_ALLOC_SHRABL_BUF(ulCcchIndInfo, sizeof(UlCcchIndInfo));
 386    if(!ulCcchIndInfo)
 387    {
 388                 DU_LOG("\nMAC: Memory failed in macSendUlCcchInd");
 389                 return RFAILED;
 390         }
 391
 392         ulCcchIndInfo->cellId = cellId;
 393         ulCcchIndInfo->crnti  = crnti;
 394         ulCcchIndInfo->ulCcchMsg = rrcContainer;
 395
 396         /* Fill Pst */
 397         pst.selector  = DU_MAC_LWLC;
 398         pst.srcEnt    = ENTRG;
 399         pst.dstEnt    = ENTDUAPP;
 400         pst.dstInst   = 0;
 401         pst.srcInst   = macCb.macInst;
 402         pst.dstProcId = rgCb[pst.srcInst].rgInit.procId;
 403         pst.srcProcId = rgCb[pst.srcInst].rgInit.procId;
 404         pst.region    = MAC_MEM_REGION;
 405         pst.pool      = MAC_POOL;
 406         pst.event     = EVENT_MAC_UL_CCCH_IND;
 407         pst.route     = 0;
 408         pst.prior     = 0;
 409         pst.intfVer   = 0;
 410
 411         if(MacDuAppUlCcchInd(&pst, ulCcchIndInfo) != ROK)
 412         {
 413                 DU_LOG("\nMAC: Failed to send UL CCCH Ind to DU APP");
 414                 MAC_FREE_SHRABL_BUF(MAC_MEM_REGION, MAC_POOL, ulCcchIndInfo->ulCcchMsg,
 415                                 strlen((const char*)ulCcchIndInfo->ulCcchMsg));
 416                 MAC_FREE_SHRABL_BUF(MAC_MEM_REGION, MAC_POOL, ulCcchIndInfo, sizeof(UlCcchIndInfo));
 417                 ret = RFAILED;
 418         }
 419         return ret;
 420 }
 421
 422 /**********************************************************************
 423          End of file
 424 **********************************************************************/
 425