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 "envopt.h"        /* environment options */
  20 #include "envdep.h"        /* environment dependent */
  21 #include "envind.h"        /* environment independent */
  22 #include "gen.h"           /* general */
  23 #include "ssi.h"           /* system services */
  24 #include "cm_tkns.h"       /* Common Token Defines */
  25 #include "cm_llist.h"      /* Common Link List Defines */
  26 #include "cm_hash.h"       /* Common Hash List Defines */
  27 #include "cm_mblk.h"       /* common memory link list library */
  28 #include "cm_lte.h"        /* Common LTE Defines */
  29 #include "rgu.h"
  30 #include "tfu.h"           /* RGU Interface includes */
  31 #include "lrg.h"
  32 #include "crg.h"           /* layer management defines for LTE-MAC */
  33 #include "rg_sch_inf.h"           /* layer management defines for LTE-MAC */
  34 #include "rg_env.h"
  35 #include "rg.h"
  36
  37 #include "gen.x"           /* general */
  38 #include "ssi.x"           /* system services */
  39 #include "cm5.x"           /* system services */
  40 #include "cm_tkns.x"       /* Common Token Definitions */
  41 #include "cm_llist.x"      /* Common Link List Definitions */
  42 #include "cm_lib.x"        /* Common Library Definitions */
  43 #include "cm_hash.x"       /* Common Hash List Definitions */
  44 #include "cm_mblk.x"       /* common memory link list library */
  45 #include "cm_lte.x"        /* Common LTE Defines */
  46 #include "rgu.x"
  47 #include "tfu.x"           /* RGU Interface includes */
  48 #include "lrg.x"
  49 #include "crg.x"           /* layer management typedefs for MAC */
  50 #include "rg_sch_inf.x"    /* SCH interface typedefs */
  51 #include "rg_prg.x"
  52 #include "du_app_mac_inf.h"
  53 #include "mac.h"
  54 #include "du_log.h"
  55 #include "rg.x"
  56 #include "mac_upr_inf_api.h"
  57
  58 /* function pointers for packing slot ind from mac to sch */
  59 MacSchSlotIndFunc macSchSlotIndOpts[] =
  60 {
  61    packMacSchSlotInd,
  62    macSchSlotInd,
  63    packMacSchSlotInd
  64 };
  65
  66 /**
  67  * @brief process DL allocation from scheduler
  68  *
  69  * @details
  70  *
  71  *     Function : MacProcDlAlloc
  72  *
  73  *      This function copied dl sch info in the mac slot info
  74  *
  75  *  @param[in]  Pst            *pst
  76  *  @param[in]  DL allocation from scheduler
  77  *  @return  S16
  78  *      -# ROK
  79  *      -# RFAILED
  80  **/
  81 int MacProcDlAlloc(Pst *pst, DlAlloc *dlAlloc)
  82 {
  83    if(dlAlloc != NULLP)
  84    {
  85                 MacDlSlot *currDlSlot =
  86                 &macCb.macCell->dlSlot[dlAlloc->slotIndInfo.slot % MAX_SLOT_SUPPORTED];
  87       memcpy(&currDlSlot->dlInfo, dlAlloc, sizeof(DlAlloc));
  88    }
  89    return ROK;
  90 }
  91
  92 /**
  93  * @brief Transmission time interval indication from PHY.
  94  *
  95  * @details
  96  *
  97  *     Function : sendSlotIndMacToSch
  98  *
  99  *      This API is invoked by MAC to send slot ind to scheduler.
 100  *
 101  *  @param[in]  SlotIndInfo    *slotInd
 102  *  @return  S16
 103  *      -# ROK
 104  *      -# RFAILED
 105  **/
 106 int sendSlotIndMacToSch(SlotIndInfo *slotInd)
 107 {
 108    /* fill Pst structure to send to lwr_mac to MAC */
 109    Pst pst;
 110
 111    fillMacToSchPst(&pst);
 112    pst.event = EVENT_SLOT_IND_TO_SCH;
 113
 114    return(*macSchSlotIndOpts[pst.selector])(&pst,slotInd);
 115 }
 116
 117 /*******************************************************************
 118  *
 119  * @brief Send slot indication to DU APP
 120  *
 121  * @details
 122  *
 123  *    Function : sendSlotIndMacToDuApp
 124  *
 125  *    Functionality:
 126  *       Send slot indication to DU APP
 127  *
 128  * @params[in] Slot indication info
 129  * @return ROK     - success
 130  *         RFAILED - failure
 131  *
 132  * ****************************************************************/
 133 int sendSlotIndMacToDuApp(SlotIndInfo *slotInd)
 134 {
 135    Pst pst;
 136    uint16_t ret;
 137    SlotInfo  *slotInfo;
 138
 139    /*  Allocate sharable memory */
 140    MAC_ALLOC_SHRABL_BUF(slotInfo, sizeof(SlotInfo));
 141    if(!slotInfo)
 142    {
 143       DU_LOG("\nMAC : Slot Indication memory allocation failed");
 144       return RFAILED;
 145   }
 146
 147   slotInfo->cellId = macCb.macCell->cellId;
 148   slotInfo->sfn = slotInd->sfn;
 149   slotInfo->slot = slotInd->slot;
 150
 151   /* Fill Pst */
 152   pst.selector  = DU_MAC_LWLC;
 153   pst.srcEnt    = ENTRG;
 154   pst.dstEnt    = ENTDUAPP;
 155   pst.dstInst   = 0;
 156   pst.srcInst   = macCb.macInst;
 157   pst.dstProcId = rgCb[pst.srcInst].rgInit.procId;
 158   pst.srcProcId = rgCb[pst.srcInst].rgInit.procId;
 159   pst.region = MAC_MEM_REGION;
 160   pst.pool = MAC_POOL;
 161   pst.event = EVENT_MAC_SLOT_IND;
 162   pst.route = 0;
 163   pst.prior = 0;
 164   pst.intfVer = 0;
 165
 166   ret = MacDuAppSlotInd(&pst, slotInfo);
 167   if(ret != ROK)
 168   {
 169      DU_LOG("\nMAC: Failed to send slot indication to DU APP");
 170      MAC_FREE_SHRABL_BUF(MAC_MEM_REGION, MAC_POOL, slotInfo, sizeof(SlotInfo));
 171   }
 172
 173   return ret;
 174 } /* sendSlotIndMacToDuApp */
 175
 176
 177 /**
 178  * @brief Transmission time interval indication from PHY.
 179  *
 180  * @details
 181  *
 182  *     Function : fapiMacSlotInd
 183  *
 184  *      This API is invoked by PHY to indicate TTI indication to MAC for a cell.
 185  *
 186  *  @param[in]  Pst            *pst
 187  *  @param[in]  SuId           suId
 188  *  @param[in]  SlotIndInfo    *slotInd
 189  *  @return  S16
 190  *      -# ROK
 191  *      -# RFAILED
 192  **/
 193 PUBLIC S16 fapiMacSlotInd
 194 (
 195 Pst                 *pst,
 196 SlotIndInfo         *slotInd
 197 )
 198 {
 199    S16              ret;
 200    VOLATILE U32     startTime=0;
 201    Inst             inst;
 202
 203    DU_LOG("\nMAC : Slot Indication received");
 204
 205    inst = pst->dstInst;
 206    /*starting Task*/
 207    SStartTask(&startTime, PID_MAC_TTI_IND);
 208
 209    /* send slot indication to scheduler */
 210    ret = sendSlotIndMacToSch(slotInd);
 211    if(ret != ROK)
 212    {
 213       DU_LOG("\nMAC : Sending of slot ind msg from MAC to SCH failed");
 214       RETVALUE(ret);
 215    }
 216
 217    ret = macProcessSlotInd(inst,*slotInd);
 218    if(ret != ROK)
 219    {
 220       DU_LOG("\nMAC : macProcessSlotInd failed");
 221       RETVALUE(ret);
 222    }
 223
 224    /* send slot indication to du app */
 225    ret = sendSlotIndMacToDuApp(slotInd);
 226    if(ret != ROK)
 227    {
 228       DU_LOG("\nMAC :Sending of slot ind msg from MAC to DU APP failed");
 229       RETVALUE(ret);
 230    }
 231
 232    /*stoping Task*/
 233    SStopTask(startTime, PID_MAC_TTI_IND);
 234
 235    RETVALUE(ret);
 236 }  /* fapiMacSlotInd */
 237
 238 /**********************************************************************
 239   End of file
 240  **********************************************************************/
 241