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 #define SCH_MIB_TRANS 8  /* MIB transmission as per 38.331 is every 80 ms */
  29 #define SCH_SIB1_TRANS 16 /* SIB1 transmission as per 38.331 is every 160 ms */
  30 #define SCH_NUM_SC_PRB 12 /* number of SCs in a PRB */
  31 #define SCH_MAX_SSB_BEAM 8 /* since we are supporting only SCS=15KHz and 30KHz */
  32 #define SCH_SSB_NUM_SYMB 4
  33 #define SCH_SSB_NUM_PRB 21 /* One extra PRB as buffer */
  34 #define SCHED_DELTA 1
  35 #define BO_DELTA 1
  36 #define RAR_DELAY   2
  37 #define MSG4_DELAY  1
  38 #define PDSCH_START_RB 10
  39 /* Considering pdsch region from 3 to 13, DMRS exclued.
  40  * Overlapping of PDSCH DRMS and PDSCH not supported by Intel L1 */
  41 #define NUM_PDSCH_SYMBOL 11
  42 #define PUSCH_START_RB 15
  43 #define PUCCH_NUM_PRB_FORMAT_0_1_4 1  /* number of PRBs in freq domain, spec 38.213 - 9.2.1 */
  44 #define SI_RNTI 0xFFFF
  45 #define P_RNTI  0xFFFE
  46 #define DMRS_MAP_TYPE_A 1
  47 #define NUM_DMRS_SYMBOLS 1
  48 #define DMRS_ADDITIONAL_POS 0
  49 #define SCH_DEFAULT_K1 1
  50 #define SCH_TQ_SIZE 10
  51 #define SSB_IDX_SUPPORTED 1
  52
  53 #define CRC_FAILED 0
  54 #define CRC_PASSED 1
  55
  56 #define MAC_HDR_SIZE  3   /* 3 bytes of MAC Header */
  57 #define UL_GRANT_SIZE 224
  58
  59 #define PRB_BITMAP_IDX_LEN 64
  60 #define PRB_BITMAP_MAX_IDX ((MAX_NUM_RB + PRB_BITMAP_IDX_LEN-1) / PRB_BITMAP_IDX_LEN)
  61
  62 #define SCH_MAX_NUM_UL_HQ_PROC 16
  63 #define SCH_MAX_NUM_DL_HQ_PROC 16
  64 #define SCH_MAX_NUM_MSG3_TX 2
  65 #define SCH_MAX_NUM_DL_HQ_TX 3
  66 #define SCH_MAX_NUM_UL_HQ_TX 3
  67 #define SCH_MAX_NUM_MSG4_TX 2
  68 #define HQ_ACK 0
  69 #define HQ_NACK 1
  70 #define HQ_DTX 2
  71 #define ROOT_SEQ_LEN_1 139
  72 #define ROOT_SEQ_LEN_2 839
  73
  74 #ifdef NR_DRX
  75 /* As per 38.331 the largest offset which can be used in of size 10240.
  76  * But using this much size of array can cause memory related issue so thats why
  77  * taking this size which are a multiple of the larger size */
  78 #define MAX_DRX_SIZE 512
  79 #endif
  80
  81 #define NUM_SCH_TYPE 2  /*Supported number of Scheduler Algorithm types*/
  82
  83 typedef struct schDlHqProcCb SchDlHqProcCb;
  84 typedef struct schUlHqEnt SchUlHqEnt;
  85 typedef struct schRaReq SchRaReq;
  86 typedef struct schDlHqEnt SchDlHqEnt;
  87 typedef struct schCellCb SchCellCb;
  88 typedef struct schUeCb SchUeCb;
  89
  90 typedef enum
  91 {
  92    SCH_FCFS,
  93    SCH_SLICE_BASED
  94 }SchType;
  95
  96 typedef enum
  97 {
  98    SCH_NUMEROLOGY_0,
  99    SCH_NUMEROLOGY_1,
 100    SCH_NUMEROLOGY_2,
 101    SCH_NUMEROLOGY_3,
 102    SCH_NUMEROLOGY_4
 103 }SchNumerology;
 104
 105 typedef enum
 106 {
 107    SCH_UE_STATE_INACTIVE,
 108    SCH_UE_STATE_ACTIVE,
 109    SCH_UE_HANDIN_IN_PROGRESS
 110 }SchUeState;
 111
 112 typedef enum
 113 {
 114    SCH_RA_STATE_MSG2_HANDLE,
 115    SCH_RA_STATE_MSG3_PENDING,
 116    SCH_RA_STATE_MSG4_PENDING,
 117    SCH_RA_STATE_MSG4_DONE
 118 }SchRaState;
 119
 120 typedef enum
 121 {
 122    SCH_LC_STATE_INACTIVE,
 123    SCH_LC_STATE_ACTIVE
 124 }SchLcState;
 125
 126 typedef enum
 127 {
 128    WINDOW_YET_TO_START,
 129    WITHIN_WINDOW,
 130    WINDOW_EXPIRED
 131 }RaRspWindowStatus;
 132
 133 typedef enum
 134 {
 135    HQ_TB_ACKED=0,
 136    HQ_TB_NACKED,
 137    HQ_TB_WAITING
 138 }SchHqTbState;
 139
 140 #ifdef NR_TDD
 141 typedef enum
 142 {
 143    DL_SLOT,
 144    UL_SLOT,
 145    FLEXI_SLOT
 146 }SlotConfig;
 147
 148 typedef enum
 149 {
 150    DL_SYMBOL,
 151    UL_SYMBOL,
 152    FLEXI_SYMBOL
 153 }SchSymbolConfig;
 154 #endif
 155
 156 /*Following structures to keep record and estimations of PRB allocated for each
 157  * LC taking into consideration the RRM policies*/
 158 typedef struct lcInfo
 159 {
 160    uint8_t  lcId;     /*LCID for which BO are getting recorded*/
 161    uint32_t reqBO;    /*Size of the BO requested/to be allocated for this LC*/
 162    uint32_t allocBO;  /*TBS/BO Size which is actually allocated*/
 163    uint8_t  allocPRB; /*PRB count which is allocated based on RRM policy/FreePRB*/
 164 }LcInfo;
 165
 166 typedef struct schUlHqTbCb
 167 {
 168    uint32_t               tbSzReq;
 169    uint32_t               tbSzAllc;
 170    uint8_t                ndi;
 171    uint8_t                rv;
 172    uint8_t                rvIdx;
 173    uint8_t                qamOrder;
 174    SchMcsTable            mcsTable;
 175    uint8_t                iMcs;
 176    uint8_t                iMcsInDci;
 177    uint8_t                numLyrs;
 178    uint8_t                txCntr;
 179    SchHqTbState           state;
 180    uint8_t                cntrRetxAllocFail;
 181    uint8_t                statsBitmap;
 182 }SchUlHqTbCb;
 183
 184 typedef struct schDlHqTbCb
 185 {
 186    uint8_t                tbIdx;
 187    Bool                   isEnabled;
 188    uint32_t               tbSzReq;
 189    uint8_t                txCntr;
 190    uint8_t                ndi;
 191    uint8_t                rv;
 192    uint8_t                rvIdx;
 193    uint8_t                iMcs;
 194    uint8_t                iMcsInDci;
 195    uint8_t                numLyrs;
 196    SchHqTbState           state;
 197    uint8_t                isAckNackDtx;
 198    uint8_t                cntrRetxAllocFail;
 199    //InfUeTbInfo          tbCompInfo;
 200    uint8_t                statsBitmap;
 201 }SchDlHqTbCb;
 202
 203 #ifdef NR_DRX
 204 typedef struct schDrxHarqCb
 205 {
 206    uint32_t     rttExpIndex;
 207    CmLList      *rttExpNode;
 208    uint32_t     retxStrtIndex;
 209    CmLList      *retxStrtNode;
 210    uint32_t     retxExpIndex;
 211    CmLList      *retxExpNode;
 212 }SchDrxHarqCb;
 213 #endif
 214
 215 typedef struct schUlHqProcCb
 216 {
 217    uint8_t           procId;       /*!< HARQ Process ID */
 218    SchUlHqEnt        *hqEnt;
 219    uint8_t           maxHqTxPerHqP;
 220    SchUlHqTbCb       tbInfo;
 221    CmLList           ulHqEntLnk;
 222    CmLList           ulSlotLnk;
 223    uint8_t           strtSymbl;
 224    uint8_t           numSymbl;
 225    void              *schSpcUlHqProcCb;  /*!< Scheduler specific HARQ Proc CB */
 226    CmLList           ulHqProcLink;
 227    uint8_t           puschResType;       /*!< Resource allocation type */
 228    uint16_t          puschStartPrb;
 229    uint16_t          puschNumPrb;
 230    uint8_t           dmrsMappingType;
 231    uint8_t           nrOfDmrsSymbols;
 232    uint8_t           dmrsAddPos;
 233    SlotTimingInfo    puschTime;
 234 #ifdef NR_DRX
 235    SchDrxHarqCb      ulDrxHarqCb;
 236 #endif
 237 }SchUlHqProcCb;
 238
 239 struct schDlHqProcCb
 240 {
 241    uint8_t           procId;       /*!< HARQ Process ID */
 242    SchDlHqEnt        *hqEnt;
 243    uint8_t           maxHqTxPerHqP;
 244    CmLList           dlHqEntLnk;
 245    CmLList           ulSlotLnk;
 246    SchDlHqTbCb       tbInfo[2];
 247    uint8_t           k1;
 248    void              *schSpcDlHqProcCb;  /*!< Scheduler specific HARQ Proc CB */
 249    CmLList           dlHqProcLink;
 250    SlotTimingInfo    pucchTime;
 251 #ifdef NR_DRX
 252    SchDrxHarqCb      dlDrxHarqCb;
 253 #endif
 254 };
 255 struct schUlHqEnt
 256 {
 257    SchCellCb      *cell;     /*!< Contains the pointer to cell*/
 258    SchUeCb        *ue;       /*!< Contains the pointer to ue*/
 259    CmLListCp      free;      /*!< List of free HARQ processes */
 260    CmLListCp      inUse;     /*!< List of in-use HARQ processes */
 261    uint8_t        maxHqTx;   /*!< Maximum number of harq re-transmissions */
 262    uint8_t        numHqPrcs; /*!< Number of HARQ Processes */
 263    SchUlHqProcCb  procs[SCH_MAX_NUM_UL_HQ_PROC]; /*!< Uplink harq process info */
 264 };
 265 struct schDlHqEnt
 266 {
 267    SchCellCb      *cell;     /*!< Contains the pointer to cell */
 268    SchUeCb        *ue;       /*!< Contains the pointer to UE */
 269    CmLListCp      free;      /*!< List of free HARQ processes */
 270    CmLListCp      inUse;     /*!< List of in-use HARQ processes */
 271    uint8_t        maxHqTx;   /*!< Maximum number of harq transmissions */
 272    uint8_t        numHqPrcs; /*!< Number of HARQ Processes */
 273    SchDlHqProcCb  procs[SCH_MAX_NUM_DL_HQ_PROC];/*!< Downlink harq processes */
 274 };
 275
 276 /**
 277  * @brief
 278  * Structure holding LTE MAC's General Configuration information.
 279  */
 280 typedef struct schGenCb
 281 {
 282    uint8_t         tmrRes;           /*!< Timer resolution */
 283    uint8_t         startCellId;      /*!< Starting Cell Id */
 284 #ifdef LTE_ADV
 285    bool            forceCntrlSrbBoOnPCel; /*!< value 1 means force scheduling
 286                                             of RLC control BO and SRB BO on
 287                                             PCell. val 0 means don't force*/
 288    bool            isSCellActDeactAlgoEnable; /*!< TRUE will enable activation/deactivation algo at Schd */
 289 #endif
 290 }SchGenCb;
 291
 292 typedef struct freePrbBlock
 293 {
 294    uint16_t numFreePrb;
 295    uint16_t startPrb;
 296    uint16_t endPrb;
 297 }FreePrbBlock;
 298
 299 /**
 300  * @brief
 301  * PRB allocations for a symbol within a slot
 302  */
 303 typedef struct schPrbAlloc
 304 {
 305    CmLListCp freePrbBlockList;           /*!< List of continuous blocks for available PRB */
 306    uint64_t  prbBitMap[ MAX_SYMB_PER_SLOT][PRB_BITMAP_MAX_IDX];  /*!< BitMap to store the allocated PRBs */
 307 }SchPrbAlloc;
 308
 309 /**
 310  * @brief
 311  * scheduler allocationsfor DL per cell.
 312  */
 313 typedef struct schDlSlotInfo
 314 {
 315    SchPrbAlloc  prbAlloc;                 /*!< PRB allocated/available in this slot */
 316    bool         ssbPres;                  /*!< Flag to determine if SSB is present in this slot */
 317    uint8_t      ssbIdxSupported;          /*!< Max SSB index */
 318    SsbInfo      ssbInfo[MAX_SSB_IDX];     /*!< SSB info */
 319    bool         sib1Pres;                 /*!< Flag to determine if SIB1 is present in this slot */
 320    uint8_t      pdcchUe;                  /*!< UE for which PDCCH is scheduled in this slot */
 321    uint8_t      pdschUe;                  /*!< UE for which PDSCH is scheduled in this slot */
 322    RarAlloc     *rarAlloc[MAX_NUM_UE];    /*!< RAR allocation per UE*/
 323    DciInfo      *ulGrant;
 324    DlMsgSchInfo *dlMsgAlloc[MAX_NUM_UE];  /*!< Dl msg allocation per UE*/
 325 }SchDlSlotInfo;
 326
 327 typedef struct schRaCb
 328 {
 329    uint8_t   ueId;
 330    bool      msg4recvd;
 331    uint16_t  tcrnti;
 332    uint16_t  dlMsgPduLen;
 333    SchUlHqProcCb msg3HqProc;
 334    SchUlHqProcCb *retxMsg3HqProc;
 335    SchRaState raState;
 336    SchCellCb *cell;
 337    SchRaReq  *raReq;
 338 }SchRaCb;
 339
 340 /**
 341  * @brief
 342  * scheduler allocationsfor UL per cell.
 343  */
 344 typedef struct schUlSlotInfo
 345 {
 346    SchPrbAlloc  prbAlloc;         /*!< PRB allocated/available per symbol */
 347    uint8_t      puschCurrentPrb;  /*!< Current PRB for PUSCH allocation */
 348    bool         puschPres;        /*!< PUSCH presence field */
 349    SchPuschInfo *schPuschInfo;    /*!< PUSCH info */
 350    bool         pucchPres;        /*!< PUCCH presence field */
 351    SchPucchInfo schPucchInfo;     /*!< PUCCH info */
 352    uint8_t      pucchUe;          /*!< Store UE id for which PUCCH is scheduled */
 353    uint8_t      puschUe;          /*!< Store UE id for which PUSCH is scheduled */
 354 }SchUlSlotInfo;
 355
 356 /**
 357 @brief
 358 * BSR info per slot per UE.
 359 */
 360 typedef struct bsrInfo
 361 {
 362    uint8_t    priority;  /* CG priority */
 363    uint32_t   dataVol;   /* Data volume requested in bytes */
 364 }BsrInfo;
 365
 366 typedef struct schLcCtxt
 367 {
 368    uint8_t lcId;     // logical Channel ID
 369    uint8_t lcp;      // logical Channel Prioritization
 370    SchLcState lcState;
 371    uint32_t bo;
 372    uint16_t   pduSessionId; /*Pdu Session Id*/
 373    Snssai  *snssai;      /*S-NSSAI assoc with LCID*/
 374    bool isDedicated;     /*Flag containing Dedicated S-NSSAI or not*/
 375    uint16_t rsvdDedicatedPRB;
 376 }SchDlLcCtxt;
 377
 378 typedef struct schDlCb
 379 {
 380    SchDlLcCtxt   dlLcCtxt[MAX_NUM_LC];
 381 }SchDlCb;
 382
 383 typedef struct schUlLcCtxt
 384 {
 385    SchLcState  lcState;
 386    uint8_t lcId;
 387    uint8_t priority;
 388    uint8_t lcGroup;
 389    uint8_t schReqId;
 390    uint8_t pbr;        // prioritisedBitRate
 391    uint8_t bsd;        // bucketSizeDuration
 392    uint16_t   pduSessionId; /*Pdu Session Id*/
 393    Snssai  *snssai;      /*S-NSSAI assoc with LCID*/
 394    bool isDedicated;     /*Flag containing Dedicated S-NSSAI or not*/
 395    uint16_t rsvdDedicatedPRB;
 396 }SchUlLcCtxt;
 397
 398 typedef struct schUlCb
 399 {
 400    SchUlLcCtxt ulLcCtxt[MAX_NUM_LC];
 401 }SchUlCb;
 402
 403 typedef struct schUeCfgCb
 404 {
 405    uint16_t        cellId;
 406    uint8_t         ueId;
 407    uint16_t        crnti;
 408    bool macCellGrpCfgPres;
 409    SchMacCellGrpCfg   macCellGrpCfg;
 410    bool phyCellGrpCfgPres;
 411    SchPhyCellGrpCfg   phyCellGrpCfg;
 412    bool spCellCfgPres;
 413    SchSpCellRecfg       spCellCfg;
 414    SchAmbrCfg         *ambrCfg;
 415    SchModulationInfo  dlModInfo;
 416    SchModulationInfo  ulModInfo;
 417    SchDataTransmission dataTransmissionAction;
 418 }SchUeCfgCb;
 419
 420 typedef struct schHqDlMap
 421 {
 422    CmLListCp hqList;
 423 }SchHqDlMap;
 424
 425 typedef struct schHqUlMap
 426 {
 427    CmLListCp hqList;
 428 }SchHqUlMap;
 429
 430 #ifdef NR_DRX
 431 typedef struct  schDrxUeCb
 432 {
 433    bool      drxDlUeActiveStatus;       /* Final Dl Ue status which is marked as true if drxDlUeActiveMask or drxDlUeActiveMaskForHarq is present */
 434    bool      drxUlUeActiveStatus;       /* Final Ul Ue status which is marked as true if drxUlUeActiveMask or drxUlUeActiveMaskForHarq is present */
 435    uint32_t  drxDlUeActiveMask;          /* variable is used to store the status about downlink active status of Ue for On-duration, inactive timer*/
 436    uint32_t  drxUlUeActiveMask;          /* variable is used to store the status about uplink active status for on-duration inactive timer*/
 437    uint32_t  drxDlUeActiveMaskForHarq;   /* variable is used to store the status about downlink active status for harq*/
 438    uint32_t  drxUlUeActiveMaskForHarq;   /* variable is used to store the status about uplink active status for harq */
 439    uint32_t  onDurationLen;          /* length of on duration which is received from ue cfg/recfg in form of ms and subms, informs about after how many slots on duration gets expire */
 440    uint32_t  inActvTimerLen;         /* length of inActvTimer value received from ue cfg/recfg in form of ms, informs about after how many slots in active gets expire */
 441    uint8_t   harqRttDlTimerLen;      /* length of harqRttDlTimer received from ue cfg/recfg in form of symbols, inform about after how many slots on the harq drx-HARQ-RTT-TimerDL expire */
 442    uint8_t   harqRttUlTimerLen;      /* length of harqRttUlTimer received from ue cfg/recfg in form of symbols,informs about after how many slots on harq drx-HARQ-RTT-TimerUL expire*/
 443    uint32_t  retransDlTimerLen;      /* length of retransDlTimer received from ue cfg/recfg in form of slot, informs about after how many slots on harq RetransmissionTimer dl timer expire*/
 444    uint32_t  retransUlTimerLen;      /* length of retransUlTimer received from ue cfg/recfg in form of slot, informs about after how many slots on harq RetransmissionTimer ul timer expire*/
 445    uint32_t  longCycleLen;           /* length of long Cycle value received from ue cfg/recfg in form of ms*/
 446    bool      longCycleToBeUsed;      /* long cycle should be used once the short cycle gets expires */
 447    uint32_t  drxStartOffset;         /* length of drxStartOffset value received from ue cfg/recfg in form of ms, which helps in getting on duration start point*/
 448    bool      shortCyclePresent;      /* set this value if shortCycle is Present */
 449    uint32_t  shortCycleLen;          /* length of short Cycle value received from ue cfg/recfg in form of ms*/
 450    uint32_t  shortCycleTmrLen;       /* value shortCycleTmr is the multiple of shortCycle which is received from ue cfg/recfg in form of integer*/
 451    uint32_t  drxSlotOffset;          /* drxSlotOffset value received from ue cfg/recfg which is used to delay before starting the drx-onDuration*/
 452    uint32_t  onDurationStartIndex;   /* Index at which UE is stored in onDuration starts list */
 453    uint32_t  onDurationExpiryIndex;  /* Index at which UE is stored in onDuration expires in the list */
 454    uint32_t  inActvExpiryIndex;      /* Index at which UE is stored in inActvTimer expires in the list */
 455    uint32_t  shortCycleExpiryIndex;  /* Index at which UE is stored in shortCycle expires in the list */
 456    int32_t   shortCycleDistance;     /* Distance after how many slot short cycle tmr gets expire */
 457    int32_t   onDurationStartDistance;/* Distance after how many slot on Duration Start tmr gets expire */
 458    int32_t   onDurationExpiryDistance;/* Distance after how many slot on Duration tmr gets expire */
 459    int32_t   inActiveTmrExpiryDistance;/* Distance after how many slot inActive tmr gets expire */
 460    CmLList   *onDurationStartNodeInfo; /* Node present in on duration start list*/
 461    CmLList   *onDurationExpiryNodeInfo;/* Node present in on duration exp list*/
 462    CmLList   *inActvTimerExpiryNodeInfo; /* Node present in in active exp list*/
 463    CmLList   *shortCycleTmrExpiryNodeInfo; /* Node present in short cycle exp list*/
 464 }SchDrxUeCb;
 465 #endif
 466 /**
 467  * @brief
 468  * UE control block
 469  */
 470 typedef struct schUeCb
 471 {
 472    uint16_t   ueId;
 473    uint16_t   crnti;
 474    SchUeCfgCb ueCfg;
 475    SchUeState state;
 476    SchCellCb  *cellCb;
 477    SchCfraResource cfraResource;
 478    bool       srRcvd;
 479    bool       bsrRcvd;
 480    BsrInfo    bsrInfo[MAX_NUM_LOGICAL_CHANNEL_GROUPS];
 481    SchUlCb    ulInfo;
 482    SchDlCb    dlInfo;
 483    SchUlHqEnt ulHqEnt;
 484    SchDlHqEnt dlHqEnt;
 485    SchDlHqProcCb *msg4HqProc;
 486    SchDlHqProcCb *retxMsg4HqProc;
 487    SchHqDlMap    **hqDlmap;
 488    SchHqUlMap    **hqUlmap;
 489    void          *schSpcUeCb;
 490 #ifdef NR_DRX
 491    bool          ueDrxInfoPres;
 492    SchDrxUeCb    drxUeCb;
 493 #endif
 494 }SchUeCb;
 495
 496 /**
 497  * @brief
 498  * RA Request Info
 499  */
 500 typedef struct schRaReq
 501 {
 502    uint32_t        raRnti;
 503    RachIndInfo     *rachInd;
 504    bool            isCFRA;
 505    SchUeCb         *ueCb;          /* Filled only if isCFRA = true */
 506    SlotTimingInfo  winStartTime;
 507    SlotTimingInfo  winEndTime;
 508 }SchRaReq;
 509
 510 typedef struct schPageInfo
 511 {
 512   uint16_t       pf;          /*Value of Paging Frame received from DUAPP*/
 513   uint8_t        i_s;         /*Value of Paging Occ Index received from DUAPP*/
 514   SlotTimingInfo pageTxTime;  /*Start Paging window*/
 515   uint8_t        mcs;         /*MCS index*/
 516   uint16_t       msgLen;      /*Pdu length */
 517   uint8_t       *pagePdu;     /*RRC Page PDU bit string*/
 518 }SchPageInfo;
 519
 520 typedef struct schPagingOcc
 521 {
 522   uint8_t frameOffset;
 523   uint8_t pagingOccSlot;
 524 }SchPagingOcc;
 525
 526 typedef struct schPageCb
 527 {
 528    CmLListCp    pageIndInfoRecord[MAX_SFN]; /*List of Page Records received which are stored per sfn*/
 529    SchPagingOcc pagMonOcc[MAX_PO_PER_PF];   /*Paging Occasion Slot/FrameOffset are stored*/
 530 }SchPageCb;
 531
 532 #ifdef NR_DRX
 533 typedef struct schDrxCb
 534 {
 535    CmLListCp   onDurationStartList;   /*!< Tracks the start of onDuration Timer. */
 536    CmLListCp   onDurationExpiryList;   /*!< Tracks the Expiry of onDuration Timer. */
 537    CmLListCp   inActvTmrExpiryList;   /*!< Tracks the Expiry of drx-InactivityTimer. */
 538    CmLListCp   shortCycleExpiryList;   /*!< Tracks the Expiry of DRX Short Cycle. */
 539    CmLListCp   dlHarqRttExpiryList;   /*!< Tracks the Expiry of DL HARQ RTT timer. */
 540    CmLListCp   dlRetransExpiryList;   /*!< Tracks the Expiry of DL Re-Transmission timer. */
 541    CmLListCp   ulHarqRttExpiryList;   /*!< Tracks the Expiry of UL HARQ RTT timer. */
 542    CmLListCp   ulRetransExpiryList;   /*!< Tracks the Expiry of UL Re-Transmission timer. */
 543    CmLListCp   dlRetransTmrStartList; /*!< It has list of DL harq procs for */
 544    CmLListCp   ulRetransTmrStartList; /*!< It has list of UL harq procs for */
 545 }SchDrxCb;
 546 #endif
 547
 548 typedef struct schAllApis
 549 {
 550    uint8_t (* SchCellCfgReq)(SchCellCb *cellCb);
 551    void (* SchCellDeleteReq)(SchCellCb *cellCb);
 552    uint8_t (* SchAddUeConfigReq)(SchUeCb  *ueCb);
 553    void (* SchModUeConfigReq)(SchUeCb  *ueCb);
 554    void (* SchUeDeleteReq)(SchUeCb  *ueCb);
 555    void (* SchDlHarqInd)();
 556    void (* SchPagingInd)();
 557    void (* SchRachRsrcReq)();
 558    void (* SchRachRsrcRel)();
 559    void (* SchCrcInd)(SchCellCb *cellCb, uint16_t ueId);
 560    void (* SchRachInd)(SchCellCb *cellCb, uint16_t ueId);
 561    void (* SchDlRlcBoInfo)(SchCellCb *cellCb, uint16_t ueId);
 562    void (* SchSrUciInd)(SchCellCb *cellCb, uint16_t ueId);
 563    void (* SchBsr)(SchCellCb *cellCb, uint16_t ueId);
 564    void (* SchHandleLcList)(void *ptr, CmLList *node, ActionTypeLL action);
 565    void (* SchAddToDlHqRetxList)(SchDlHqProcCb *hqP);
 566    void (* SchAddToUlHqRetxList)(SchUlHqProcCb *hqP);
 567    void (* SchRemoveFrmDlHqRetxList)(SchUeCb *ueCb, CmLList *node);
 568    void (* SchRemoveFrmUlHqRetxList)(SchUeCb *ueCb, CmLList *node);
 569    uint8_t (* SchAddUeToSchedule)(SchCellCb *cellCb, uint16_t ueId);
 570    void (* SchRemoveUeFrmScheduleLst)(SchCellCb *cell, CmLList *node);
 571    uint8_t (* SchInitDlHqProcCb)(SchDlHqProcCb *hqP);
 572    uint8_t (* SchInitUlHqProcCb)(SchUlHqProcCb *hqP);
 573    void (* SchFreeDlHqProcCb)(SchDlHqProcCb *hqP);
 574    void (* SchFreeUlHqProcCb)(SchUlHqProcCb *hqP);
 575    void (* SchDeleteDlHqProcCb)(SchDlHqProcCb *hqP);
 576    void (* SchDeleteUlHqProcCb)(SchUlHqProcCb *hqP);
 577    void (* SchScheduleSlot)(SchCellCb *cell, SlotTimingInfo *slotInd, Inst schInst);
 578    uint32_t (* SchScheduleDlLc)(SlotTimingInfo pdcchTime, SlotTimingInfo pdschTime, uint8_t pdschNumSymbols, \
 579       uint16_t *startPrb, bool isRetx, SchDlHqProcCb **hqP);
 580    uint8_t (* SchScheduleUlLc)(SlotTimingInfo dciTime, SlotTimingInfo puschTime, uint8_t startStmb, \
 581       uint8_t symbLen, bool isRetx, SchUlHqProcCb **hqP);
 582 }SchAllApis;
 583
 584 typedef struct schHqCfgParam
 585 {
 586    uint8_t maxDlDataHqTx;
 587    uint8_t maxMsg4HqTx;
 588    uint8_t maxUlDataHqTx;
 589 }SchHqCfg;
 590
 591 typedef struct
 592 {
 593    /* parameters derived in scheduler */
 594    uint8_t   n0;
 595    BwpCfg    bwp;
 596    PdcchCfg  sib1PdcchCfg;
 597    PdschCfg  sib1PdschCfg;
 598 }SchSib1Cfg;
 599
 600 /**
 601  * @brief
 602  * Cell Control block per cell.
 603  */
 604 typedef struct schCellCb
 605 {
 606    uint16_t      cellId;                            /*!< Cell ID */
 607    Inst          instIdx;                           /*!< Index of the scheduler instance */
 608    Inst          macInst;                           /*!< Index of the MAC instance */
 609    uint16_t       numSlots;                          /*!< Number of slots in current frame */
 610    SlotTimingInfo   slotInfo;                          /*!< SFN, Slot info being processed*/
 611    SchDlSlotInfo **schDlSlotInfo;                   /*!< SCH resource allocations in DL */
 612    SchUlSlotInfo **schUlSlotInfo;                   /*!< SCH resource allocations in UL */
 613    SchCellCfg    cellCfg;                           /*!< Cell ocnfiguration */
 614    bool          firstSsbTransmitted;
 615    bool          firstSib1Transmitted;
 616    uint8_t       ssbStartSymbArr[SCH_MAX_SSB_BEAM]; /*!< start symbol per SSB beam */
 617    uint64_t      dedPreambleBitMap;                 /*!< Bit map to find used/free preambles index */
 618    SchRaReq      *raReq[MAX_NUM_UE];                /*!< Pending RA request */
 619    SchRaCb       raCb[MAX_NUM_UE];                  /*!< RA Cb */
 620    uint16_t      numActvUe;                         /*!< Number of active UEs */
 621    uint32_t      actvUeBitMap;                      /*!< Bit map to find active UEs */
 622    uint32_t      boIndBitMap;                       /*!< Bit map to indicate UEs that have recevied BO */
 623    SchUeCb       ueCb[MAX_NUM_UE];                  /*!< Pointer to UE contexts of this cell */
 624    SchPageCb     pageCb;                            /*!< Page Record at Schedular*/
 625 #ifdef NR_TDD
 626    uint8_t       numSlotsInPeriodicity;             /*!< number of slots in configured periodicity and SCS */
 627    uint32_t      slotFrmtBitMap;                    /*!< 2 bits must be read together to determine D/U/S slots. 00-D, 01-U, 10-S */
 628    SchSymbolConfig       slotCfg[MAX_TDD_PERIODICITY_SLOTS][MAX_SYMB_PER_SLOT];
 629 #endif
 630 #ifdef NR_DRX
 631    SchDrxCb      drxCb[MAX_DRX_SIZE];                           /*!< Drx cb*/
 632 #endif
 633    SchType       schAlgoType;                       /*!< The scheduler type which the cell is configured with.*/
 634    SchAllApis    *api;                             /*!< Reference of sch APIs for this cell based on the SchType*/
 635    void          *schSpcCell;                       /*Ref of Scheduler specific structure*/
 636    SchHqCfg             schHqCfg;
 637    SchK0K1TimingInfoTbl k0K1InfoTbl;
 638    SchK2TimingInfoTbl   msg3K2InfoTbl;
 639    SchK2TimingInfoTbl   k2InfoTbl;
 640    SchSib1Cfg           sib1SchCfg;       /* SIB1 config */
 641    uint8_t              maxMsg3Tx;         /* MAximum num of msg3 tx*/
 642 }SchCellCb;
 643
 644
 645 typedef struct schSliceCfg
 646 {
 647    uint8_t        numOfSliceConfigured;
 648    SchRrmPolicyOfSlice **listOfSlices;
 649 }SchSliceCfg;
 650
 651 /**
 652  * @brief
 653  * Control block for sch
 654  */
 655 typedef struct schCb
 656 {
 657    TskInit                schInit;               /*!< Task Init info */
 658    SchGenCb               genCfg;                /*!< General Config info */
 659    CmTqCp                 tmrTqCp;               /*!< Timer Task Queue Cntrl Point */
 660    CmTqType               tmrTq[SCH_TQ_SIZE];    /*!< Timer Task Queue */
 661    SchAllApis             allApis[NUM_SCH_TYPE]; /*!<List of All Scheduler Type dependent Function pointers*/
 662    SchCellCb              *cells[MAX_NUM_CELL];  /* Array to store cellCb ptr */
 663    SchSliceCfg            sliceCfg;
 664 }SchCb;
 665
 666 /* Declaration for scheduler control blocks */
 667 SchCb schCb[SCH_MAX_INST];
 668
 669 /* function declarations */
 670 short int schActvTmr(Ent ent,Inst inst);
 671 void SchFillCfmPst(Pst *reqPst,Pst *cfmPst,RgMngmt *cfm);
 672
 673 /* Configuration related function declarations */
 674 void schInitUlSlot(SchUlSlotInfo *schUlSlotInfo);
 675 void schInitDlSlot(SchDlSlotInfo *schDlSlotInfo);
 676 void BuildK0K1Table(SchCellCb *cell, SchK0K1TimingInfoTbl *k0K1InfoTbl, bool pdschCfgCmnPres, \
 677    SchPdschCfgCmn pdschCmnCfg,SchPdschConfig pdschDedCfg, uint8_t ulAckListCount, uint8_t *UlAckTbl);
 678 void BuildK2InfoTable(SchCellCb *cell, SchPuschTimeDomRsrcAlloc timeDomRsrcAllocList[], \
 679    uint16_t puschSymTblSize, SchK2TimingInfoTbl *msg3K2InfoTbl, SchK2TimingInfoTbl *k2InfoTbl);
 680 uint8_t SchSendCfgCfm(Pst *pst, RgMngmt *cfm);
 681 SchUeCb* schGetUeCb(SchCellCb *cellCb, uint16_t crnti);
 682 uint8_t addUeToBeScheduled(SchCellCb *cell, uint8_t ueId);
 683
 684 /* Incoming message handler function declarations */
 685 uint8_t SchProcCellCfgReq(Pst *pst, SchCellCfg *schCellCfg);
 686 uint8_t SchProcSlotInd(Pst *pst, SlotTimingInfo *slotInd);
 687 uint8_t SchProcRachInd(Pst *pst, RachIndInfo *rachInd);
 688 uint8_t SchProcCrcInd(Pst *pst, CrcIndInfo *crcInd);
 689 uint8_t SchProcDlRlcBoInfo(Pst *pst, DlRlcBoInfo *dlBoInfo);
 690 uint8_t SchAddUeConfigReq(Pst *pst, SchUeCfgReq *ueCfgToSch);
 691 uint8_t SchProcBsr(Pst *pst, UlBufferStatusRptInd *bsrInd);
 692 uint8_t SchProcSrUciInd(Pst *pst, SrUciIndInfo *uciInd);
 693 uint8_t SchModUeConfigReq(Pst *pst, SchUeRecfgReq *ueRecfgToSch);
 694 uint8_t SchProcUeDeleteReq(Pst *pst, SchUeDelete  *ueDelete);
 695 uint8_t SchProcCellDeleteReq(Pst *pst, SchCellDeleteReq  *schCellDelete);
 696 uint8_t SchProcSliceCfgReq(Pst *pst, SchSliceCfgReq *schSliceCfgReq);
 697 uint8_t SchProcSliceRecfgReq(Pst *pst, SchSliceRecfgReq *schSliceRecfgReq);
 698 uint8_t SchProcRachRsrcReq(Pst *pst, SchRachRsrcReq *schRachRsrcReq);
 699 uint8_t SchProcRachRsrcRel(Pst *pst, SchRachRsrcRel *schRachRsrcRel);
 700 uint8_t SchProcPagingInd(Pst *pst,  SchPageInd *pageInd);
 701 uint8_t SchProcDlHarqInd(Pst *pst, DlHarqInd *dlHarqInd);
 702
 703 /* DL scheduling related function declarations */
 704 PduTxOccsaion schCheckSsbOcc(SchCellCb *cell, SlotTimingInfo slotTime);
 705 PduTxOccsaion schCheckSib1Occ(SchCellCb *cell, SlotTimingInfo slotTime);
 706 uint8_t schBroadcastSsbAlloc(SchCellCb *cell, SlotTimingInfo slotTime, DlBrdcstAlloc *dlBrdcstAlloc);
 707 uint8_t schBroadcastSib1Alloc(SchCellCb *cell, SlotTimingInfo slotTime, DlBrdcstAlloc *dlBrdcstAlloc);
 708 bool schProcessRaReq(Inst schInst, SchCellCb *cellCb, SlotTimingInfo currTime, uint8_t ueId);
 709 uint8_t schProcessMsg4Req(SchCellCb *cell, SlotTimingInfo currTime, uint8_t ueId,bool isRetxMsg4, SchDlHqProcCb **hqP);
 710 uint8_t schFillRar(SchCellCb *cell, SlotTimingInfo rarTime, uint16_t ueId, RarAlloc *rarAlloc, uint8_t k0Index);
 711 bool schFillBoGrantDlSchedInfo(SchCellCb *cell, SlotTimingInfo currTime, uint8_t ueId, bool isRetx, SchDlHqProcCb **hqP);
 712 uint8_t schDlRsrcAllocDlMsg(SchCellCb *cell, SlotTimingInfo slotTime, uint16_t crnti,
 713 uint32_t tbSize, DlMsgSchInfo *dlMsgAlloc, uint16_t startPRB, uint8_t pdschStartSymbol, uint8_t pdschNumSymbols,bool isRetx, SchDlHqProcCb* hqP);
 714 uint8_t schDlRsrcAllocMsg4(SchCellCb *cell, SlotTimingInfo msg4Time, uint8_t ueId, DlMsgSchInfo *msg4Alloc,\
 715 uint8_t pdschStartSymbol, uint8_t pdschNumSymbols, bool isRetx, SchDlHqProcCb *hqP);
 716 uint8_t allocatePrbDl(SchCellCb *cell, SlotTimingInfo slotTime, uint8_t startSymbol, uint8_t symbolLength, \
 717    uint16_t *startPrb, uint16_t numPrb);
 718 void fillDlMsgInfo(DlMsgSchInfo *dlMsgInfo, uint8_t crnti, bool isRetx, SchDlHqProcCb* hqP);
 719 bool findValidK0K1Value(SchCellCb *cell, SlotTimingInfo currTime, uint8_t ueId, bool dedMsg, uint8_t *pdschStartSymbol,\
 720 uint8_t *pdschSymblLen, SlotTimingInfo *pdcchTime,  SlotTimingInfo *pdschTime, SlotTimingInfo *pucchTime, bool isRetx, SchDlHqProcCb *hqP);
 721 RaRspWindowStatus isInRaRspWindow(SchRaReq *raReq, SlotTimingInfo frameToCheck, uint16_t numSlotsPerSystemFrame);
 722
 723 /* UL scheduling related function declarations */
 724 uint8_t schUlResAlloc(SchCellCb *cell, Inst schInst);
 725 bool schCheckPrachOcc(SchCellCb *cell, SlotTimingInfo prachOccasionTimingInfo);
 726 uint8_t schCalcPrachNumRb(SchCellCb *cell);
 727 void schPrachResAlloc(SchCellCb *cell, UlSchedInfo *ulSchedInfo, SlotTimingInfo prachOccasionTimingInfo);
 728 uint16_t schAllocPucchResource(SchCellCb *cell, SlotTimingInfo pucchTime, uint16_t crnti,SchUeCb *ueCb, bool isRetx, SchDlHqProcCb *hqP);
 729 uint8_t schFillUlDci(SchUeCb *ueCb, SchPuschInfo *puschInfo, DciInfo *dciInfo, bool isRetx, SchUlHqProcCb *hqP);
 730 uint8_t schFillPuschAlloc(SchUeCb *ueCb, SlotTimingInfo puschTime, uint32_t tbSize,
 731                             uint8_t startSymb, uint8_t symbLen, uint16_t startPrb, bool isRetx, SchUlHqProcCb *hqP);
 732 uint8_t allocatePrbUl(SchCellCb *cell, SlotTimingInfo slotTime, uint8_t startSymbol, uint8_t symbolLength, \
 733    uint16_t *startPrb, uint16_t numPrb);
 734 bool schProcessSrOrBsrReq(SchCellCb *cell, SlotTimingInfo currTime, uint8_t ueId, bool isRetx, SchUlHqProcCb **hqP);
 735
 736 /*Generic Functions*/
 737 void updateGrantSizeForBoRpt(CmLListCp *lcLL, DlMsgSchInfo *dlMsgAlloc, BsrInfo *bsrInfo, uint32_t *accumalatedBOSize);
 738 uint16_t searchLargestFreeBlock(SchCellCb *cell, SlotTimingInfo slotTime,uint16_t *startPrb, Direction dir);
 739 LcInfo* handleLcLList(CmLListCp *lcLL, uint8_t lcId, ActionTypeLL action);
 740 void prbAllocUsingRRMPolicy(CmLListCp *lcLL, bool dedicatedPRB, uint16_t mcsIdx,uint8_t numSymbols,\
 741                       uint16_t *sharedPRB, uint16_t *reservedPRB, bool *isTxPayloadLenAdded, bool *srRcvd);
 742 void updateBsrAndLcList(CmLListCp *lcLL, BsrInfo *bsrInfo, uint8_t status);
 743
 744 /*Paging Functions*/
 745 void schProcPagingCfg(SchCellCb *cell);
 746 void schCfgPdcchMonOccOfPO(SchCellCb *cell);
 747 void schIncrSlot(SlotTimingInfo *timingInfo, uint8_t incr, uint16_t numSlotsPerRF);
 748 uint8_t schFillPagePdschCfg(SchCellCb *cell, PageDlSch *pageDlSch, SlotTimingInfo slotTime, \
 749                              uint16_t tbSize, uint8_t mcs, uint16_t startPrb);
 750 /*DL HARQ Functions*/
 751 void schDlHqEntInit(SchCellCb *cellCb, SchUeCb *ueCb);
 752 void schMsg4FeedbackUpdate(SchDlHqProcCb *hqP, uint8_t fdbk);
 753 void schDlHqFeedbackUpdate(SchDlHqProcCb *hqP, uint8_t fdbk1, uint8_t fdbk2);
 754 uint8_t schDlGetAvlHqProcess(SchCellCb *cellCb, SchUeCb *ueCb, SchDlHqProcCb **hqP);
 755 void schDlReleaseHqProcess(SchDlHqProcCb *hqP);
 756 void schDlHqEntDelete(SchUeCb *ueCb);
 757
 758 /*UL HARQ Functions*/
 759 void schUlHqEntInit(SchCellCb *cellCb, SchUeCb *ueCb);
 760 uint8_t schMsg3RetxSchedulingForUe(SchRaCb *raCb);
 761 void schUlHqProcessNack(SchUlHqProcCb *hqP);
 762 void schUlHqProcessAck(SchUlHqProcCb *hqP);
 763 uint8_t schUlGetAvlHqProcess(SchCellCb *cellCb, SchUeCb *ueCb, SchUlHqProcCb **hqP);
 764 void schUlReleaseHqProcess(SchUlHqProcCb *hqP, Bool togNdi);
 765 void schUlHqEntDelete(SchUeCb *ueCb);
 766
 767 /* UE Manager HARQ Fun*/
 768 void schUpdateHarqFdbk(SchUeCb *ueCb, uint8_t numHarq, uint8_t *harqPayload,SlotTimingInfo *slotInd);
 769
 770 /* Round Robbin Scheduler funtions*/
 771 uint8_t schFillUlDciForMsg3Retx(SchRaCb *raCb, SchPuschInfo *puschInfo, DciInfo *dciInfo);
 772 bool schGetMsg3K2(SchCellCb *cell, SchUlHqProcCb* msg3HqProc, uint16_t dlTime, SlotTimingInfo *msg3Time, bool isRetx);
 773 void schMsg4Complete(SchUeCb *ueCb);
 774 /**********************************************************************
 775   End of file
 776  **********************************************************************/