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_INST 1
  22 #define SCH_MU0_NUM_SLOTS 10
  23 #define SCH_MU1_NUM_SLOTS 20
  24 #define SCH_MU2_NUM_SLOTS 30
  25 #define SCH_MU3_NUM_SLOTS 40
  26 #define SCH_MU4_NUM_SLOTS 50
  27 #define SCH_MAX_SFN 1024
  28 #ifdef NR_TDD
  29 #define MAX_NUM_RB 275 /* value for numerology 1, 100 MHz */
  30 #else
  31 #define MAX_NUM_RB 106 /* value for numerology 0, 20 MHz */
  32 #endif
  33 #define SCH_MIB_TRANS 8  /* MIB transmission as per 38.331 is every 80 ms */
  34 #define SCH_SIB1_TRANS 16 /* SIB1 transmission as per 38.331 is every 160 ms */
  35 #define SCH_NUM_SC_PRB 12 /* number of SCs in a PRB */
  36 #define SCH_MAX_SSB_BEAM 8 /* since we are supporting only SCS=15KHz and 30KHz */
  37 #define SCH_SYMBOL_PER_SLOT 14
  38 #define SCH_SSB_NUM_SYMB 4
  39 #define SCH_SSB_NUM_PRB 20
  40 #define SCHED_DELTA 1
  41 #define BO_DELTA 1
  42 #define RAR_DELAY   2
  43 #define MSG4_DELAY  1
  44 #define PDSCH_START_RB 10
  45 #define PUSCH_START_RB 15
  46 #define PUCCH_NUM_PRB_FORMAT_0_1_4 1  /* number of PRBs in freq domain, spec 38.213 - 9.2.1 */
  47 #define SI_RNTI 0xFFFF
  48 #define P_RNTI  0xFFFE
  49 #define DMRS_MAP_TYPE_A 1
  50 #define NUM_DMRS_SYMBOLS 1
  51 #define DMRS_ADDITIONAL_POS 0
  52 #define SCH_DEFAULT_K1 1
  53 #define SCH_TQ_SIZE 10
  54 #define SSB_IDX_SUPPORTED 1
  55
  56 #define CRC_FAILED 0
  57 #define CRC_PASSED 1
  58
  59 #define MAC_HDR_SIZE  3   /* 3 bytes of MAC Header */
  60 #define UL_GRANT_SIZE 224
  61
  62 typedef struct schCellCb SchCellCb;
  63 typedef struct schUeCb SchUeCb;
  64
  65 typedef enum
  66 {
  67    SCH_NUMEROLOGY_0,
  68    SCH_NUMEROLOGY_1,
  69    SCH_NUMEROLOGY_2,
  70    SCH_NUMEROLOGY_3,
  71    SCH_NUMEROLOGY_4
  72 }SchNumerology;
  73
  74 typedef enum
  75 {
  76    SCH_UE_STATE_INACTIVE,
  77    SCH_UE_STATE_ACTIVE
  78 }SchUeState;
  79
  80 typedef enum
  81 {
  82    SCH_LC_STATE_INACTIVE,
  83    SCH_LC_STATE_ACTIVE
  84 }SchLcState;
  85
  86 typedef enum
  87 {
  88    WINDOW_YET_TO_START,
  89    WITHIN_WINDOW,
  90    WINDOW_EXPIRED
  91 }RaRspWindowStatus;
  92
  93 /**
  94  * @brief
  95  * Structure holding LTE MAC's General Configuration information.
  96  */
  97 typedef struct schGenCb
  98 {
  99    uint8_t         tmrRes;           /*!< Timer resolution */
 100    uint8_t         startCellId;      /*!< Starting Cell Id */
 101 #ifdef LTE_ADV
 102    bool            forceCntrlSrbBoOnPCel; /*!< value 1 means force scheduling
 103                                             of RLC control BO and SRB BO on
 104                                             PCell. val 0 means don't force*/
 105    bool            isSCellActDeactAlgoEnable; /*!< TRUE will enable activation/deactivation algo at Schd */
 106 #endif
 107 }SchGenCb;
 108
 109 /**
 110  * @brief
 111  * scheduler allocationsfor DL per cell.
 112  */
 113 typedef struct schDlSlotInfo
 114 {
 115    uint16_t  totalPrb;                          /*!< Number of RBs in the cell */
 116    uint16_t  assignedPrb[SCH_SYMBOL_PER_SLOT];  /*!< Num RBs and corresponding symbols allocated */
 117    uint16_t  resAllocBitMap;                    /*!< Resource allocation bitmap */
 118    bool      ssbPres;                           /*!< Flag to determine if SSB is present in this slot */
 119    uint8_t   ssbIdxSupported;                   /*!< Max SSB index */
 120    SsbInfo   ssbInfo[MAX_SSB_IDX];              /*!< SSB info */
 121    bool      sib1Pres;                          /*!< Flag to determine if SIB1 is present in this slot */
 122    RarAlloc  *rarAlloc;                         /*!< RAR allocation */
 123    DlMsgInfo *dlMsgInfo;                        /*!< DL dedicated Msg info */
 124 }SchDlSlotInfo;
 125
 126 typedef struct schRaCb
 127 {
 128    uint16_t tcrnti;
 129 }SchRaCb;
 130
 131 /**
 132  * @brief
 133  * scheduler allocationsfor UL per cell.
 134  */
 135 typedef struct schUlSlotInfo
 136 {
 137    uint16_t     totalPrb;  /*!< Number of RBs in the cell */
 138    uint16_t     assignedPrb[SCH_SYMBOL_PER_SLOT]; /*!< Num RBs and corresponding symbols allocated */
 139    uint16_t     resAllocBitMap;                    /*!< Resource allocation bitmap */
 140    uint8_t      puschCurrentPrb; /* Current PRB for PUSCH allocation */
 141    bool         puschPres; /*!< PUSCH presence field */
 142    SchPuschInfo *schPuschInfo; /*!< PUSCH info */
 143    bool         pucchPres; /*!< PUCCH presence field */
 144    SchPucchInfo schPucchInfo; /*!< PUCCH info */
 145 }SchUlSlotInfo;
 146
 147 /**
 148 @brief
 149 * BSR info per slot per UE.
 150 */
 151 typedef struct bsrInfo
 152 {
 153    uint8_t    priority;  /* CG priority */
 154    uint32_t   dataVol;   /* Data volume requested in bytes */
 155 }BsrInfo;
 156
 157 typedef struct schLcCtxt
 158 {
 159    uint8_t lcId;     // logical Channel ID
 160    uint8_t lcp;      // logical Channel Prioritization
 161    SchLcState lcState;
 162    uint32_t bo;
 163 }SchDlLcCtxt;
 164
 165 typedef struct schDlCb
 166 {
 167    uint8_t       numDlLc;
 168    SchDlLcCtxt   dlLcCtxt[MAX_NUM_LC];
 169 }SchDlCb;
 170
 171 typedef struct schUlLcCtxt
 172 {
 173    SchLcState  lcState;
 174    uint8_t lcId;
 175    uint8_t priority;
 176    uint8_t lcGroup;
 177    uint8_t schReqId;
 178    uint8_t pbr;        // prioritisedBitRate
 179    uint8_t bsd;        // bucketSizeDuration
 180 }SchUlLcCtxt;
 181
 182 typedef struct schUlCb
 183 {
 184    uint8_t     numUlLc;
 185    SchUlLcCtxt ulLcCtxt[MAX_NUM_LC];
 186 }SchUlCb;
 187
 188 typedef struct schUeCfgCb
 189 {
 190    uint16_t        cellId;
 191    uint16_t        crnti;
 192    bool macCellGrpCfgPres;
 193    SchMacCellGrpCfg   macCellGrpCfg;
 194    bool phyCellGrpCfgPres;
 195    SchPhyCellGrpCfg   phyCellGrpCfg;
 196    bool spCellCfgPres;
 197    SchSpCellCfg       spCellCfg;
 198    SchAmbrCfg         *ambrCfg;
 199    SchModulationInfo  dlModInfo;
 200    SchModulationInfo  ulModInfo;
 201 }SchUeCfgCb;
 202
 203 /**
 204  * @brief
 205  * UE control block
 206  */
 207 typedef struct schUeCb
 208 {
 209    uint16_t   ueIdx;
 210    uint16_t   crnti;
 211    SchUeCfgCb ueCfg;
 212    SchUeState state;
 213    SchCellCb  *cellCb;
 214    bool       srRcvd;
 215    BsrInfo    bsrInfo[MAX_NUM_LOGICAL_CHANNEL_GROUPS];
 216    SchUlCb    ulInfo;
 217    SchDlCb    dlInfo;
 218 }SchUeCb;
 219
 220 /**
 221  * @brief
 222  * RA Request Info
 223  */
 224 typedef struct schRaReq
 225 {
 226    uint32_t        raRnti;
 227    RachIndInfo     *rachInd;
 228    SlotTimingInfo  winStartTime;
 229    SlotTimingInfo  winEndTime;
 230 }SchRaReq;
 231
 232 /**
 233  * @brief
 234  * Cell Control block per cell.
 235  */
 236 typedef struct schCellCb
 237 {
 238    uint16_t      cellId;                            /*!< Cell ID */
 239    Inst          instIdx;                           /*!< Index of the scheduler instance */
 240    Inst          macInst;                           /*!< Index of the MAC instance */
 241    uint8_t       numSlots;                          /*!< Number of slots in current frame */
 242    SlotTimingInfo   slotInfo;                          /*!< SFN, Slot info being processed*/
 243    SchDlSlotInfo **schDlSlotInfo;                   /*!< SCH resource allocations in DL */
 244    SchUlSlotInfo **schUlSlotInfo;                   /*!< SCH resource allocations in UL */
 245    SchCellCfg    cellCfg;                           /*!< Cell ocnfiguration */
 246    bool          firstSsbTransmitted;
 247    bool          firstSib1Transmitted;
 248    uint8_t       ssbStartSymbArr[SCH_MAX_SSB_BEAM]; /*!<start symbol per SSB beam */
 249    SchRaReq      *raReq[MAX_NUM_UE];                /*!< Pending RA request */
 250    SchRaCb       raCb[MAX_NUM_UE];                  /*!< RA Cb */
 251    uint16_t      numActvUe;                         /*!<Number of active UEs */
 252    uint32_t      actvUeBitMap;                      /*!<Bit map to find active UEs */
 253    uint32_t      boIndBitMap;                       /*!<Bit map to indicate UEs that have recevied BO */
 254    SchUeCb       ueCb[MAX_NUM_UE];                  /*!<Pointer to UE contexts of this cell */
 255 #ifdef NR_TDD
 256    uint8_t       numSlotsInPeriodicity;             /*!< number of slots in configured periodicity and SCS */
 257    uint32_t      slotFrmtBitMap;                    /*!< 2 bits must be read together to determine D/U/S slots. 00-D, 01-U, 10-S */
 258    uint32_t      symbFrmtBitMap;                    /*!< 2 bits must be read together to determine D/U/S symbols. 00-D, 01-U, 10-S */
 259 #endif
 260 }SchCellCb;
 261
 262 /**
 263  * @brief
 264  * Control block for sch
 265  */
 266 typedef struct schCb
 267 {
 268    TskInit       schInit;               /*!< Task Init info */
 269    SchGenCb      genCfg;                /*!< General Config info */
 270    CmTqCp        tmrTqCp;               /*!< Timer Task Queue Cntrl Point */
 271    CmTqType      tmrTq[SCH_TQ_SIZE];    /*!< Timer Task Queue */
 272    SchCellCb     *cells[MAX_NUM_CELL];  /* Array to store cellCb ptr */
 273 }SchCb;
 274
 275 /* Declaration for scheduler control blocks */
 276 SchCb schCb[SCH_MAX_INST];
 277
 278 /* function declarations */
 279 SchUeCb* schGetUeCb(SchCellCb *cellCb, uint16_t crnti);
 280 void schInitUlSlot(SchUlSlotInfo *schUlSlotInfo);
 281 void schInitDlSlot(SchDlSlotInfo *schDlSlotInfo);
 282 uint8_t SchSendCfgCfm(Pst *pst, RgMngmt *cfm);
 283 short int schActvTmr(Ent ent,Inst inst);
 284 uint8_t schBroadcastAlloc(SchCellCb *cell, DlBrdcstAlloc *dlBrdcstAlloc,uint16_t slot);
 285 uint8_t schProcessSlotInd(SlotTimingInfo *slotInd, Inst inst);
 286 uint8_t schUlResAlloc(SchCellCb *cell, Inst schInst);
 287 uint8_t schDlRsrcAllocMsg4(DlMsgAlloc *msg4Alloc, SchCellCb *cell, uint16_t slot, bool ssbPresent, bool sib1Present);
 288 uint16_t schCalcTbSize(uint32_t payLoadSize);
 289 uint16_t schCalcNumPrb(uint16_t tbSize, uint16_t mcs, uint8_t numSymbols);
 290 uint16_t schAllocPucchResource(SchCellCb *cell, uint16_t crnti, uint16_t slot);
 291 uint8_t schProcessRachInd(RachIndInfo *rachInd, Inst schInst);
 292 uint8_t schFillUlDci(SchUeCb *ueCb, SchPuschInfo puschInfo, DciInfo *dciInfo);
 293 uint8_t schFillPuschAlloc(SchUeCb *ueCb, uint16_t pdcchSlot, uint32_t dataVol, SchPuschInfo *puschInfo);
 294 uint8_t schDlRsrcAllocDlMsg(DlMsgAlloc *dlMsgAlloc, SchCellCb *cell, uint16_t crnti,
 295    uint32_t *accumalatedSize, uint16_t slot);
 296 uint16_t schAccumalateLcBoSize(SchCellCb *cell, uint16_t ueIdx);
 297 uint8_t schFillRar(RarAlloc *rarAlloc, uint16_t raRnti, uint16_t pci, uint8_t offsetPointA, \
 298     uint8_t k0Index, bool ssbPresent, bool sib1Present);
 299 void schProcessRaReq(SlotTimingInfo currTime, SchCellCb *cellCb);
 300
 301 void BuildK0K1Table(SchCellCb *cell, SchK0K1TimingInfoTbl *k0K1InfoTbl, bool pdschCfgCmnPres, \
 302 SchPdschCfgCmn pdschCmnCfg,SchPdschConfig pdschDedCfg, uint8_t ulAckListCount, uint8_t *UlAckTbl);
 303 void BuildK2InfoTable(SchCellCb *cell, SchPuschTimeDomRsrcAlloc timeDomRsrcAllocList[], \
 304 uint16_t puschSymTblSize, SchK2TimingInfoTbl *msg3K2InfoTbl, SchK2TimingInfoTbl *k2InfoTbl);
 305
 306 PduTxOccsaion schCheckSsbOcc(SlotTimingInfo slotTime, SchCellCb *cell);
 307 PduTxOccsaion schCheckSib1Occ(SlotTimingInfo slotTime, SchCellCb *cell);
 308
 309 /**********************************************************************
 310   End of file
 311  **********************************************************************/