src/5gnrsch/sch.h

   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 /* macros */
  20 #define SCH_INST_START 1
  21 #define SCH_MAX_CELLS 1
  22 #define SCH_MAX_INST 1
  23 #define SCH_NUM_SLOTS 10 /*forcing this to 10 */
  24 #define SCH_MAX_SFN 1024
  25 #define MAX_NUM_RB 106 /* value for numerology 0 15Khz */
  26 #define SCH_MIB_TRANS 80
  27 #define SCH_NUM_SC_PRB 12 /* number of SCs in a PRB */
  28 #define SCH_SCS_15KHZ 0 /* numerology 0 and 15Khz */
  29 #define SCH_SYMBOL_PER_SLOT 14
  30 #define SCH_SSB_NUM_SYMB 4
  31 #define SCH_SSB_NUM_PRB 20
  32 #define SCH_MAX_SSB_BEAM 4 /* since we are supporting only SCS=15KHz */
  33 #define SCH_MEM_REGION     4
  34 #define SCH_POOL           1
  35 #define SCHED_DELTA 1
  36 #define BO_DELTA 1
  37 #define RAR_DELAY   2
  38 #define MSG4_DELAY  1
  39 #define SCH_MAX_UE  1
  40 #define PUSCH_START_RB 15
  41 #define PUCCH_NUM_PRB_FORMAT_0 1  /* number of PRBs in freq domain, spec 38.213 - 9.2.1 */
  42 #define SI_RNTI 0xFFFF
  43 #define P_RNTI  0xFFFE
  44
  45 #define CRC_FAILED 0
  46 #define CRC_PASSED 1
  47
  48 /* allocate and zero out a static buffer */
  49 #define SCH_ALLOC(_datPtr, _size)                                \
  50 {                                                               \
  51    S16 _ret;                                                    \
  52    _ret = SGetSBuf(SCH_MEM_REGION, SCH_POOL,                  \
  53                     (Data **)&_datPtr, _size);                  \
  54    if(_ret == ROK)                                              \
  55       cmMemset((U8*)_datPtr, 0, _size);                         \
  56    else                                                         \
  57       _datPtr = NULLP;                                          \
  58 }
  59
  60 /* free a static buffer */
  61 #define SCH_FREE(_datPtr, _size)                                 \
  62    if(_datPtr)                                                  \
  63       SPutSBuf(SCH_MEM_REGION, SCH_POOL,                      \
  64          (Data *)_datPtr, _size);
  65
  66 #define SCH_FILL_RSP_PST(_rspPst, _inst)\
  67 {                                  \
  68    _rspPst.srcProcId = SFndProcId(); \
  69    _rspPst.dstProcId = SFndProcId();\
  70    _rspPst.srcEnt    = ENTRG;\
  71    _rspPst.dstEnt    = ENTRG;\
  72    _rspPst.srcInst   = 1;\
  73    _rspPst.dstInst   = 0;\
  74         _rspPst.selector  = ODU_SELECTOR_TC;\
  75 }
  76 extern uint8_t schProcessRachInd(RachIndInfo *rachInd, Inst schInst);
  77 /**
  78   * @brief
  79   * Structure holding LTE MAC's General Configuration information.
  80   */
  81 typedef struct schGenCb
  82 {
  83    uint8_t         tmrRes;           /*!< Timer resolution */
  84    uint8_t         startCellId;      /*!< Starting Cell Id */
  85 #ifdef LTE_ADV
  86    bool            forceCntrlSrbBoOnPCel; /*!< value 1 means force scheduling
  87                                                of RLC control BO and SRB BO on
  88                                                PCell. val 0 means don't force*/
  89    bool            isSCellActDeactAlgoEnable; /*!< TRUE will enable activation/deactivation algo at Schd */
  90 #endif
  91 }SchGenCb;
  92
  93 /**
  94   * @brief
  95   * scheduler allocationsfor DL per cell.
  96   */
  97 typedef struct schDlSlotInfo
  98 {
  99         uint16_t  totalPrb;                          /*!< Number of RBs in the cell */
 100         uint16_t  assignedPrb[SCH_SYMBOL_PER_SLOT];  /*!< Num RBs and corresponding symbols allocated */
 101    bool      ssbPres;                           /*!< Flag to determine if SSB is present in this slot */
 102    uint8_t   ssbIdxSupported;                   /*!< Max SSB index */
 103         SsbInfo   ssbInfo[MAX_SSB_IDX];              /*!< SSB info */
 104         bool      sib1Pres;                          /*!< Flag to determine if SIB1 is present in this slot */
 105         RarInfo   *rarInfo;                          /*!< RAR info */
 106    Msg4Info  *msg4Info;                         /*!< msg4 info */
 107 }SchDlSlotInfo;
 108
 109 typedef struct schRaCb
 110 {
 111    uint16_t tcrnti;
 112 }SchRaCb;
 113
 114 /**
 115   * @brief
 116   * scheduler allocationsfor UL per cell.
 117   */
 118 typedef struct schUlSlotInfo
 119 {
 120         uint16_t     totalPrb;  /*!< Number of RBs in the cell */
 121         uint16_t     assignedPrb[SCH_SYMBOL_PER_SLOT]; /*!< Num RBs and corresponding symbols allocated */
 122         bool         puschPres; /*!< PUSCH presence field */
 123         SchPuschInfo *schPuschInfo; /*!< PUSCH info */
 124         bool         pucchPres; /*!< PUCCH presence field */
 125         SchPucchInfo schPucchInfo; /*!< PUCCH info */
 126 }SchUlSlotInfo;
 127
 128 /**
 129   * @brief
 130   * Cell Control block per cell.
 131   */
 132 typedef struct schCellCb
 133 {
 134    uint16_t      cellId;                            /*!< Cell ID */
 135    Inst          instIdx;                           /*!< Index of the scheduler instance */
 136    Inst          macInst;                           /*!< Index of the MAC instance */
 137         uint8_t       numSlots;                          /*!< Number of slots in current frame */
 138    SlotIndInfo   slotInfo;                          /*!< SFN, Slot info being processed*/
 139    SchDlSlotInfo *schDlSlotInfo[SCH_NUM_SLOTS];     /*!< SCH resource allocations in DL */
 140    SchUlSlotInfo *schUlSlotInfo[SCH_NUM_SLOTS];     /*!< SCH resource allocations in UL */
 141         SchCellCfg    cellCfg;                           /*!< Cell ocnfiguration */
 142         uint8_t       ssbStartSymbArr[SCH_MAX_SSB_BEAM]; /*!<start symbol per SSB beam */
 143         SchRaCb       raCb[SCH_MAX_UE];                  /*!< Rach Cb */
 144 }SchCellCb;
 145
 146 /**
 147   * @brief
 148   * Control block for sch
 149   */
 150 typedef struct schCb
 151 {
 152    TskInit       schInit;              /*!< Task Init info */
 153    SchGenCb      genCfg;                 /*!< General Config info */
 154    SchCellCb     *cells[SCH_MAX_CELLS];  /* Array to store cellCb ptr */
 155 }SchCb;
 156
 157 /* Declaration for scheduler control blocks */
 158 SchCb schCb[SCH_MAX_INST];
 159
 160 /* function declarations */
 161 uint8_t schBroadcastAlloc(SchCellCb *cell, DlBrdcstAlloc *dlBrdcstAlloc,uint16_t slot);
 162 uint8_t schProcessSlotInd(SlotIndInfo *slotInd, Inst inst);
 163 uint8_t schUlResAlloc(SchCellCb *cell, Inst schInst);
 164 uint8_t schDlRsrcAllocMsg4(Msg4Alloc *msg4Alloc, SchCellCb *cell, uint16_t slot);
 165 uint16_t schCalcTbSize(uint16_t payLoadSize);
 166 uint16_t schCalcNumPrb(uint16_t tbSize, uint16_t mcs, uint8_t numSymbols);
 167 uint16_t schAllocPucchResource(SchCellCb *cell, uint16_t crnti, uint16_t slot);
 168 /**********************************************************************
 169          End of file
 170 **********************************************************************/