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 MAX_NUM_RB 106 /* value for numerology 0 15Khz */
  25 #define SCH_MIB_TRANS 80
  26 #define SCH_NUM_SC_PRB 12 /* number of SCs in a PRB */
  27 #define SCH_MAX_SSB_BEAM 4 /* since we are supporting only SCS=15KHz */
  28 #define SCH_SCS_15KHZ 0 /* numerology 0 and 15Khz */
  29 #define SCH_SYMBOL_PER_SLOT 14
  30 #define SCH_SSB_SYMB_DURATION 4
  31 #define SCH_SSB_PRB_DURATION 20
  32 #define SCH_MEM_REGION     4
  33 #define SCH_POOL           1
  34 #define SCHED_DELTA 1
  35
  36 /* allocate and zero out a static buffer */
  37 #define SCH_ALLOC(_datPtr, _size)                                \
  38 {                                                               \
  39    S16 _ret;                                                    \
  40    _ret = SGetSBuf(SCH_MEM_REGION, SCH_POOL,                  \
  41                     (Data **)&_datPtr, _size);                  \
  42    if(_ret == ROK)                                              \
  43       cmMemset((U8*)_datPtr, 0, _size);                         \
  44    else                                                         \
  45       _datPtr = NULLP;                                          \
  46 }
  47
  48 /* free a static buffer */
  49 #define SCH_FREE(_datPtr, _size)                                 \
  50    if(_datPtr)                                                  \
  51       SPutSBuf(SCH_MEM_REGION, SCH_POOL,                      \
  52          (Data *)_datPtr, _size);
  53
  54
  55 #define SCH_FILL_RSP_PST(_rspPst, _inst)\
  56 {                                  \
  57    _rspPst.srcProcId = SFndProcId(); \
  58    _rspPst.dstProcId = SFndProcId();\
  59    _rspPst.srcEnt    = ENTRG;\
  60    _rspPst.dstEnt    = ENTRG;\
  61    _rspPst.srcInst   = 1;\
  62    _rspPst.dstInst   = 0;\
  63         _rspPst.selector  = MAC_SELECTOR_TC;\
  64 }
  65
  66 /**
  67   * @brief
  68   * Structure holding LTE MAC's General Configuration information.
  69   */
  70 typedef struct schGenCb
  71 {
  72    uint8_t         tmrRes;           /*!< Timer resolution */
  73    uint8_t         startCellId;      /*!< Starting Cell Id */
  74 #ifdef LTE_ADV
  75    bool            forceCntrlSrbBoOnPCel; /*!< value 1 means force scheduling
  76                                                of RLC control BO and SRB BO on
  77                                                PCell. val 0 means don't force*/
  78    bool            isSCellActDeactAlgoEnable; /*!< TRUE will enable activation/deactivation algo at Schd */
  79 #endif
  80 }SchGenCb;
  81
  82 /**
  83   * @brief
  84   * scheduler allocationsfor DL per cell.
  85   */
  86 typedef struct schDlAlloc
  87 {
  88         uint16_t    totalPrb;  /*!< Number of RBs in the cell */
  89         uint16_t    assignedPrb[SCH_SYMBOL_PER_SLOT]; /*!< Num RBs and corresponding symbols allocated */
  90    bool        ssbPres;    /*!< Flag to determine if SSB is present in this slot */
  91    uint8_t     ssbIdxSupported;  /*!< Max SSB index */
  92         SsbInfo     ssbInfo[MAX_SSB_IDX]; /*!< SSB info */
  93 }SchDlAlloc;
  94
  95 /**
  96   * @brief
  97   * scheduler allocationsfor UL per cell.
  98   */
  99 typedef struct schUlAlloc
 100 {
 101         uint16_t    totalPrb;  /*!< Number of RBs in the cell */
 102         uint16_t    assignedPrb[SCH_SYMBOL_PER_SLOT]; /*!< Num RBs and corresponding symbols allocated */
 103         uint8_t     prachStartSymb; /*!< Start symbol for PRACH */
 104 }SchUlAlloc;
 105
 106 /**
 107   * @brief
 108   * Cell Control block per cell.
 109   */
 110 typedef struct schCellCb
 111 {
 112    uint16_t      cellId;           /*!< Cell ID */
 113    Inst          instIdx;          /*!< Index of the scheduler instance */
 114    Inst          macInst;          /*!< Index of the MAC instance */
 115         uint8_t       numSlots;         /*!< Number of slots in current frame */
 116    SlotIndInfo   slotInfo;         /*!< SFN, Slot info being processed*/
 117    SchDlAlloc    *dlAlloc[SCH_NUM_SLOTS]; /*!< SCH resource allocations in DL */
 118    SchUlAlloc    *ulAlloc[SCH_NUM_SLOTS]; /*!< SCH resource allocations in UL */
 119         SchCellCfg    cellCfg;                /*!< Cell ocnfiguration */
 120 }SchCellCb;
 121
 122 /**
 123   * @brief
 124   * Control block for sch
 125   */
 126 typedef struct schCb
 127 {
 128    TskInit       schInit;              /*!< Task Init info */
 129    SchGenCb      genCfg;                 /*!< General Config info */
 130    SchCellCb     *cells[SCH_MAX_CELLS];  /* Array to store cellCb ptr */
 131 }SchCb;
 132
 133 /* Declaration for scheduler control blocks */
 134 SchCb schCb[SCH_MAX_INST];
 135
 136 /* function declarations */
 137 uint8_t schCmnDlAlloc(SchCellCb *cell, DlBrdcstAlloc *dlBrdcstAlloc);
 138 int     schProcessSlotInd(SlotIndInfo *slotInd, Inst inst);
 139 int schUlResAlloc(SchCellCb *cell, Inst schInst);
 140
 141
 142
 143 /**********************************************************************
 144          End of file
 145 **********************************************************************/