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
  72 #ifdef NR_DRX
  73 /* As per 38.331 the largest offset which can be used in of size 10240.
  74  * But using this much size of array can cause memory related issue so thats why
  75  * taking this size which are a multiple of the larger size */
  76 #define MAX_DRX_SIZE 512
  77 #endif
  78
  79 typedef struct schDlHqProcCb SchDlHqProcCb;
  80 typedef struct schUlHqEnt SchUlHqEnt;
  81 typedef struct schRaReq SchRaReq;
  82 typedef struct schDlHqEnt SchDlHqEnt;
  83 typedef struct schCellCb SchCellCb;
  84 typedef struct schUeCb SchUeCb;
  85
  86 typedef enum
  87 {
  88    SCH_NUMEROLOGY_0,
  89    SCH_NUMEROLOGY_1,
  90    SCH_NUMEROLOGY_2,
  91    SCH_NUMEROLOGY_3,
  92    SCH_NUMEROLOGY_4
  93 }SchNumerology;
  94
  95 typedef enum
  96 {
  97    SCH_UE_STATE_INACTIVE,
  98    SCH_UE_STATE_ACTIVE,
  99    SCH_UE_HANDIN_IN_PROGRESS
 100 }SchUeState;
 101
 102 typedef enum
 103 {
 104    SCH_RA_STATE_MSG2_HANDLE,
 105    SCH_RA_STATE_MSG3_PENDING,
 106    SCH_RA_STATE_MSG4_PENDING,
 107    SCH_RA_STATE_MSG4_DONE
 108 }SchRaState;
 109
 110 typedef enum
 111 {
 112    SCH_LC_STATE_INACTIVE,
 113    SCH_LC_STATE_ACTIVE
 114 }SchLcState;
 115
 116 typedef enum
 117 {
 118    WINDOW_YET_TO_START,
 119    WITHIN_WINDOW,
 120    WINDOW_EXPIRED
 121 }RaRspWindowStatus;
 122
 123 typedef enum
 124 {
 125    HQ_TB_ACKED=0,
 126    HQ_TB_NACKED,
 127    HQ_TB_WAITING
 128 }SchHqTbState;
 129
 130 /*Following structures to keep record and estimations of PRB allocated for each
 131  * LC taking into consideration the RRM policies*/
 132 typedef struct lcInfo
 133 {
 134    uint8_t  lcId;     /*LCID for which BO are getting recorded*/
 135    uint32_t reqBO;    /*Size of the BO requested/to be allocated for this LC*/
 136    uint32_t allocBO;  /*TBS/BO Size which is actually allocated*/
 137    uint8_t  allocPRB; /*PRB count which is allocated based on RRM policy/FreePRB*/
 138 }LcInfo;
 139
 140 typedef struct schLcPrbEstimate
 141 {
 142    /* TODO: For Multiple RRMPolicies, Make DedicatedLcInfo as array/Double Pointer
 143     * and have separate DedLCInfo for each RRMPolcyMemberList*/
 144    /* Dedicated LC List will be allocated, if any available*/
 145    CmLListCp dedLcList; /*Contain LCInfo per RRMPolicy*/
 146    CmLListCp defLcList; /*Linklist of LC assoc with Default S-NSSAI(s)*/
 147    /* SharedPRB number can be used by any LC.
 148     * Need to calculate in every Slot based on PRB availability*/
 149    uint16_t sharedNumPrb;
 150 }SchLcPrbEstimate;
 151 typedef struct schUlHqTbCb
 152 {
 153    uint32_t               tbSzReq;
 154    uint32_t               tbSzAllc;
 155    uint8_t                ndi;
 156    uint8_t                rv;
 157    uint8_t                rvIdx;
 158    uint8_t                qamOrder;
 159    SchMcsTable            mcsTable;
 160    uint8_t                iMcs;
 161    uint8_t                iMcsInDci;
 162    uint8_t                numLyrs;
 163    uint8_t                txCntr;
 164    SchHqTbState           state;
 165    uint8_t                cntrRetxAllocFail;
 166    uint8_t                statsBitmap;
 167 }SchUlHqTbCb;
 168
 169 typedef struct schDlHqTbCb
 170 {
 171    uint8_t                tbIdx;
 172    Bool                   isEnabled;
 173    uint32_t               tbSzReq;
 174    uint8_t                txCntr;
 175    uint8_t                ndi;
 176    uint8_t                rv;
 177    uint8_t                rvIdx;
 178    uint8_t                iMcs;
 179    uint8_t                iMcsInDci;
 180    uint8_t                numLyrs;
 181    SchHqTbState           state;
 182    uint8_t                isAckNackDtx;
 183    uint8_t                cntrRetxAllocFail;
 184    //InfUeTbInfo          tbCompInfo;
 185    uint8_t                statsBitmap;
 186 }SchDlHqTbCb;
 187
 188 #ifdef NR_DRX
 189 typedef struct schDrxHarqCb
 190 {
 191    uint32_t     retxStrtIndex;
 192    uint32_t     rttIndex;
 193    uint32_t     retxIndex;
 194    int16_t      retxExpDistance;
 195    uint8_t      retxTmrReduction;
 196 }SchDrxHarqCb;
 197 #endif
 198
 199 typedef struct schUlHqProcCb
 200 {
 201    uint8_t           procId;       /*!< HARQ Process ID */
 202    SchUlHqEnt        *hqEnt;
 203    uint8_t           maxHqTxPerHqP;
 204    SchUlHqTbCb       tbInfo;
 205    CmLList           ulHqEntLnk;
 206    CmLList           ulSlotLnk;
 207    uint8_t           strtSymbl;
 208    uint8_t           numSymbl;
 209    SchLcPrbEstimate  ulLcPrbEst; /*UL PRB Alloc Estimate among different LC*/
 210    CmLList           ulHqProcLink;
 211    uint8_t           puschResType; /* Resource allocation type */
 212    uint16_t          puschStartPrb;
 213    uint16_t          puschNumPrb;
 214    uint8_t           dmrsMappingType;
 215    uint8_t           nrOfDmrsSymbols;
 216    uint8_t           dmrsAddPos;
 217 #ifdef NR_DRX
 218    SchDrxHarqCb      ulDrxHarqCb;
 219 #endif
 220 }SchUlHqProcCb;
 221
 222 struct schDlHqProcCb
 223 {
 224    uint8_t           procId;       /*!< HARQ Process ID */
 225    SchDlHqEnt        *hqEnt;
 226    uint8_t           maxHqTxPerHqP;
 227    CmLList           dlHqEntLnk;
 228    CmLList           ulSlotLnk;
 229    SchDlHqTbCb       tbInfo[2];
 230    uint8_t           k1;
 231    SchLcPrbEstimate  dlLcPrbEst; /*DL PRB Alloc Estimate among different LC*/
 232    CmLList           dlHqProcLink;
 233 #ifdef NR_DRX
 234    SchDrxHarqCb      dlDrxHarqCb;
 235 #endif
 236 };
 237 struct schUlHqEnt
 238 {
 239    SchCellCb      *cell;     /*!< Contains the pointer to cell*/
 240    SchUeCb        *ue;       /*!< Contains the pointer to ue*/
 241    CmLListCp      free;      /*!< List of free HARQ processes */
 242    CmLListCp      inUse;     /*!< List of in-use HARQ processes */
 243    uint8_t        maxHqTx;   /*!< Maximum number of harq re-transmissions */
 244    uint8_t        numHqPrcs; /*!< Number of HARQ Processes */
 245    SchUlHqProcCb  procs[SCH_MAX_NUM_UL_HQ_PROC]; /*!< Uplink harq process info */
 246 };
 247 struct schDlHqEnt
 248 {
 249    SchCellCb      *cell;     /*!< Contains the pointer to cell */
 250    SchUeCb        *ue;       /*!< Contains the pointer to UE */
 251    CmLListCp      free;      /*!< List of free HARQ processes */
 252    CmLListCp      inUse;     /*!< List of in-use HARQ processes */
 253    uint8_t        maxHqTx;   /*!< Maximum number of harq transmissions */
 254    uint8_t        numHqPrcs; /*!< Number of HARQ Processes */
 255    SchDlHqProcCb  procs[SCH_MAX_NUM_DL_HQ_PROC];/*!< Downlink harq processes */
 256 };
 257
 258 /**
 259  * @brief
 260  * Structure holding LTE MAC's General Configuration information.
 261  */
 262 typedef struct schGenCb
 263 {
 264    uint8_t         tmrRes;           /*!< Timer resolution */
 265    uint8_t         startCellId;      /*!< Starting Cell Id */
 266 #ifdef LTE_ADV
 267    bool            forceCntrlSrbBoOnPCel; /*!< value 1 means force scheduling
 268                                             of RLC control BO and SRB BO on
 269                                             PCell. val 0 means don't force*/
 270    bool            isSCellActDeactAlgoEnable; /*!< TRUE will enable activation/deactivation algo at Schd */
 271 #endif
 272 }SchGenCb;
 273
 274 typedef struct freePrbBlock
 275 {
 276    uint16_t numFreePrb;
 277    uint16_t startPrb;
 278    uint16_t endPrb;
 279 }FreePrbBlock;
 280
 281 /**
 282  * @brief
 283  * PRB allocations for a symbol within a slot
 284  */
 285 typedef struct schPrbAlloc
 286 {
 287    CmLListCp freePrbBlockList;           /*!< List of continuous blocks for available PRB */
 288    uint64_t  prbBitMap[ MAX_SYMB_PER_SLOT][PRB_BITMAP_MAX_IDX];  /*!< BitMap to store the allocated PRBs */
 289 }SchPrbAlloc;
 290
 291 /**
 292  * @brief
 293  * scheduler allocationsfor DL per cell.
 294  */
 295 typedef struct schDlSlotInfo
 296 {
 297    SchPrbAlloc  prbAlloc;                 /*!< PRB allocated/available in this slot */
 298    bool         ssbPres;                  /*!< Flag to determine if SSB is present in this slot */
 299    uint8_t      ssbIdxSupported;          /*!< Max SSB index */
 300    SsbInfo      ssbInfo[MAX_SSB_IDX];     /*!< SSB info */
 301    bool         sib1Pres;                 /*!< Flag to determine if SIB1 is present in this slot */
 302    uint8_t      pdcchUe;                  /*!< UE for which PDCCH is scheduled in this slot */
 303    uint8_t      pdschUe;                  /*!< UE for which PDSCH is scheduled in this slot */
 304    RarAlloc     *rarAlloc[MAX_NUM_UE];    /*!< RAR allocation per UE*/
 305    DciInfo      *ulGrant;
 306    DlMsgAlloc   *dlMsgAlloc[MAX_NUM_UE];  /*!< Dl msg allocation per UE*/
 307 }SchDlSlotInfo;
 308
 309 typedef struct schRaCb
 310 {
 311    uint8_t   ueId;
 312    bool      msg4recvd;
 313    uint16_t  tcrnti;
 314    uint16_t  dlMsgPduLen;
 315    SchUlHqProcCb msg3HqProc;
 316    SchUlHqProcCb *retxMsg3HqProc;
 317    SchRaState raState;
 318    SchCellCb *cell;
 319    SchRaReq  *raReq;
 320 }SchRaCb;
 321
 322 /**
 323  * @brief
 324  * scheduler allocationsfor UL per cell.
 325  */
 326 typedef struct schUlSlotInfo
 327 {
 328    SchPrbAlloc  prbAlloc;         /*!< PRB allocated/available per symbol */
 329    uint8_t      puschCurrentPrb;  /*!< Current PRB for PUSCH allocation */
 330    bool         puschPres;        /*!< PUSCH presence field */
 331    SchPuschInfo *schPuschInfo;    /*!< PUSCH info */
 332    bool         pucchPres;        /*!< PUCCH presence field */
 333    SchPucchInfo schPucchInfo;     /*!< PUCCH info */
 334    uint8_t      pucchUe;          /*!< Store UE id for which PUCCH is scheduled */
 335    uint8_t      puschUe;          /*!< Store UE id for which PUSCH is scheduled */
 336 }SchUlSlotInfo;
 337
 338 /**
 339 @brief
 340 * BSR info per slot per UE.
 341 */
 342 typedef struct bsrInfo
 343 {
 344    uint8_t    priority;  /* CG priority */
 345    uint32_t   dataVol;   /* Data volume requested in bytes */
 346 }BsrInfo;
 347
 348 typedef struct schLcCtxt
 349 {
 350    uint8_t lcId;     // logical Channel ID
 351    uint8_t lcp;      // logical Channel Prioritization
 352    SchLcState lcState;
 353    uint32_t bo;
 354    uint16_t   pduSessionId; /*Pdu Session Id*/
 355    Snssai  *snssai;      /*S-NSSAI assoc with LCID*/
 356    bool isDedicated;     /*Flag containing Dedicated S-NSSAI or not*/
 357    uint16_t rsvdDedicatedPRB;
 358 }SchDlLcCtxt;
 359
 360 typedef struct schDlCb
 361 {
 362    SchDlLcCtxt   dlLcCtxt[MAX_NUM_LC];
 363 }SchDlCb;
 364
 365 typedef struct schUlLcCtxt
 366 {
 367    SchLcState  lcState;
 368    uint8_t lcId;
 369    uint8_t priority;
 370    uint8_t lcGroup;
 371    uint8_t schReqId;
 372    uint8_t pbr;        // prioritisedBitRate
 373    uint8_t bsd;        // bucketSizeDuration
 374    uint16_t   pduSessionId; /*Pdu Session Id*/
 375    Snssai  *snssai;      /*S-NSSAI assoc with LCID*/
 376    bool isDedicated;     /*Flag containing Dedicated S-NSSAI or not*/
 377    uint16_t rsvdDedicatedPRB;
 378 }SchUlLcCtxt;
 379
 380 typedef struct schUlCb
 381 {
 382    SchUlLcCtxt ulLcCtxt[MAX_NUM_LC];
 383 }SchUlCb;
 384
 385 typedef struct schUeCfgCb
 386 {
 387    uint16_t        cellId;
 388    uint8_t         ueId;
 389    uint16_t        crnti;
 390    bool macCellGrpCfgPres;
 391    SchMacCellGrpCfg   macCellGrpCfg;
 392    bool phyCellGrpCfgPres;
 393    SchPhyCellGrpCfg   phyCellGrpCfg;
 394    bool spCellCfgPres;
 395    SchSpCellCfg       spCellCfg;
 396    SchAmbrCfg         *ambrCfg;
 397    SchModulationInfo  dlModInfo;
 398    SchModulationInfo  ulModInfo;
 399    SchDataTransmission dataTransmissionAction;
 400 }SchUeCfgCb;
 401
 402 typedef struct schHqDlMap
 403 {
 404    CmLListCp hqList;
 405 }SchHqDlMap;
 406
 407 typedef struct schHqUlMap
 408 {
 409    CmLListCp hqList;
 410 }SchHqUlMap;
 411
 412 #ifdef NR_DRX
 413 typedef struct  schDrxUeCb
 414 {
 415    uint32_t  drxDlUeActiveStatus;    /* variable is used to store the status about downlink active status */
 416    uint32_t  drxUlUeActiveStatus;    /* variable is used to store the status about uplink active status */
 417    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 */
 418    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 */
 419    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 */
 420    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*/
 421    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*/
 422    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*/
 423    uint32_t  longCycleLen;           /* length of long Cycle value received from ue cfg/recfg in form of ms*/
 424    bool      longCycleToBeUsed;      /* long cycle should be used once the short cycle gets expires */
 425    uint32_t  drxStartOffset;         /* length of drxStartOffset value received from ue cfg/recfg in form of ms, which helps in getting on duration start point*/
 426    bool      shortCyclePresent;      /* set this value if shortCycle is Present */
 427    uint32_t  shortCycleLen;          /* length of short Cycle value received from ue cfg/recfg in form of ms*/
 428    uint32_t  shortCycleTmrLen;       /* value shortCycleTmr is the multiple of shortCycle which is received from ue cfg/recfg in form of integer*/
 429    uint32_t  drxSlotOffset;          /* drxSlotOffset value received from ue cfg/recfg which is used to delay before starting the drx-onDuration*/
 430    uint32_t  onDurationStartIndex;   /* Index at which UE is stored in onDuration starts list */
 431    uint32_t  onDurationExpiryIndex;  /* Index at which UE is stored in onDuration expires in the list */
 432    uint32_t  inActvExpiryIndex;      /* Index at which UE is stored in inActvTimer expires in the list */
 433    uint32_t  shortCycleExpiryIndex;  /* Index at which UE is stored in shortCycle expires in the list */
 434    int32_t   shortCycleDistance;     /* Distance after how many slot short cycle tmr gets expire */
 435    int32_t   onDurationStartDistance;/* Distance after how many slot on Duration Start tmr gets expire */
 436    int32_t   onDurationExpiryDistance;/* Distance after how many slot on Duration tmr gets expire */
 437    int32_t   inActiveTmrExpiryDistance;/* Distance after how many slot inActive tmr gets expire */
 438    CmLList   *onDurationStartNodeInfo; /* Node present in on duration start list*/
 439    CmLList   *onDurationExpiryNodeInfo;/* Node present in on duration exp list*/
 440    CmLList   *inActvTimerExpiryNodeInfo; /* Node present in in active exp list*/
 441    CmLList   *shortCycleTmrExpiryNodeInfo; /* Node present in short cycle exp list*/
 442 }SchDrxUeCb;
 443 #endif
 444 /**
 445  * @brief
 446  * UE control block
 447  */
 448 typedef struct schUeCb
 449 {
 450    uint16_t   ueId;
 451    uint16_t   crnti;
 452    SchUeCfgCb ueCfg;
 453    SchUeState state;
 454    SchCellCb  *cellCb;
 455    SchCfraResource cfraResource;
 456    bool       srRcvd;
 457    bool       bsrRcvd;
 458    BsrInfo    bsrInfo[MAX_NUM_LOGICAL_CHANNEL_GROUPS];
 459    SchUlCb    ulInfo;
 460    SchDlCb    dlInfo;
 461    SchUlHqEnt ulHqEnt;
 462    SchDlHqEnt dlHqEnt;
 463    SchDlHqProcCb *msg4Proc;
 464    SchDlHqProcCb *retxMsg4HqProc;
 465    SchHqDlMap   **hqDlmap;
 466    SchHqUlMap   **hqUlmap;
 467    CmLListCp  ulRetxHqList;
 468    CmLListCp  dlRetxHqList;
 469 #ifdef NR_DRX
 470    bool           ueDrxInfoPres;
 471    SchDrxUeCb     drxUeCb;
 472 #endif
 473 }SchUeCb;
 474
 475 /**
 476  * @brief
 477  * RA Request Info
 478  */
 479 typedef struct schRaReq
 480 {
 481    uint32_t        raRnti;
 482    RachIndInfo     *rachInd;
 483    bool            isCFRA;
 484    SchUeCb         *ueCb;          /* Filled only if isCFRA = true */
 485    SlotTimingInfo  winStartTime;
 486    SlotTimingInfo  winEndTime;
 487 }SchRaReq;
 488
 489 typedef struct schPageInfo
 490 {
 491   uint16_t       pf;          /*Value of Paging Frame received from DUAPP*/
 492   uint8_t        i_s;         /*Value of Paging Occ Index received from DUAPP*/
 493   SlotTimingInfo pageTxTime;  /*Start Paging window*/
 494   uint8_t        mcs;         /*MCS index*/
 495   uint16_t       msgLen;      /*Pdu length */
 496   uint8_t       *pagePdu;     /*RRC Page PDU bit string*/
 497 }SchPageInfo;
 498
 499 typedef struct schPagingOcc
 500 {
 501   uint8_t frameOffset;
 502   uint8_t pagingOccSlot;
 503 }SchPagingOcc;
 504
 505 typedef struct schPageCb
 506 {
 507    CmLListCp    pageIndInfoRecord[MAX_SFN]; /*List of Page Records received which are stored per sfn*/
 508    SchPagingOcc pagMonOcc[MAX_PO_PER_PF];   /*Paging Occasion Slot/FrameOffset are stored*/
 509 }SchPageCb;
 510
 511 #ifdef NR_DRX
 512 typedef struct schDrxCb
 513 {
 514    CmLListCp   onDurationStartList;   /*!< Tracks the start of onDuration Timer. */
 515    CmLListCp   onDurationExpiryList;   /*!< Tracks the Expiry of onDuration Timer. */
 516    CmLListCp   inActvTmrExpiryList;   /*!< Tracks the Expiry of drx-InactivityTimer. */
 517    CmLListCp   shortCycleExpiryList;   /*!< Tracks the Expiry of DRX Short Cycle. */
 518    CmLListCp   dlHarqRttExpiryList;   /*!< Tracks the Expiry of DL HARQ RTT timer. */
 519    CmLListCp   dlRetransExpiryList;   /*!< Tracks the Expiry of DL Re-Transmission timer. */
 520    CmLListCp   ulHarqRttExpiryList;   /*!< Tracks the Expiry of UL HARQ RTT timer. */
 521    CmLListCp   ulRetransExpiryList;   /*!< Tracks the Expiry of UL Re-Transmission timer. */
 522    CmLListCp   dlRetransTmrStartList; /*!< It has list of DL harq procs for */
 523    CmLListCp   ulRetransTmrStartList; /*!< It has list of UL harq procs for */
 524 }SchDrxCb;
 525 #endif
 526
 527 /**
 528  * @brief
 529  * Cell Control block per cell.
 530  */
 531 typedef struct schCellCb
 532 {
 533    uint16_t      cellId;                            /*!< Cell ID */
 534    Inst          instIdx;                           /*!< Index of the scheduler instance */
 535    Inst          macInst;                           /*!< Index of the MAC instance */
 536    uint16_t       numSlots;                          /*!< Number of slots in current frame */
 537    SlotTimingInfo   slotInfo;                          /*!< SFN, Slot info being processed*/
 538    SchDlSlotInfo **schDlSlotInfo;                   /*!< SCH resource allocations in DL */
 539    SchUlSlotInfo **schUlSlotInfo;                   /*!< SCH resource allocations in UL */
 540    SchCellCfg    cellCfg;                           /*!< Cell ocnfiguration */
 541    bool          firstSsbTransmitted;
 542    bool          firstSib1Transmitted;
 543    uint8_t       ssbStartSymbArr[SCH_MAX_SSB_BEAM]; /*!< start symbol per SSB beam */
 544    uint64_t      dedPreambleBitMap;                 /*!< Bit map to find used/free preambles index */
 545    SchRaReq      *raReq[MAX_NUM_UE];                /*!< Pending RA request */
 546    SchRaCb       raCb[MAX_NUM_UE];                  /*!< RA Cb */
 547    uint16_t      numActvUe;                         /*!< Number of active UEs */
 548    uint32_t      actvUeBitMap;                      /*!< Bit map to find active UEs */
 549    uint32_t      boIndBitMap;                       /*!< Bit map to indicate UEs that have recevied BO */
 550    SchUeCb       ueCb[MAX_NUM_UE];                  /*!< Pointer to UE contexts of this cell */
 551    CmLListCp     ueToBeScheduled;                   /*!< Linked list to store UEs pending to be scheduled, */
 552    SchPageCb     pageCb;                            /*!< Page Record at Schedular*/
 553 #ifdef NR_TDD
 554    uint8_t       numSlotsInPeriodicity;             /*!< number of slots in configured periodicity and SCS */
 555    uint32_t      slotFrmtBitMap;                    /*!< 2 bits must be read together to determine D/U/S slots. 00-D, 01-U, 10-S */
 556    uint32_t      symbFrmtBitMap;                    /*!< 2 bits must be read together to determine D/U/S symbols. 00-D, 01-U, 10-S */
 557 #endif
 558 #ifdef NR_DRX
 559    SchDrxCb      drxCb[MAX_DRX_SIZE];                           /*!< Drx cb*/
 560 #endif
 561 }SchCellCb;
 562
 563
 564 typedef struct schSliceCfg
 565 {
 566    uint8_t        numOfSliceConfigured;
 567    SchRrmPolicyOfSlice **listOfConfirguration;
 568 }SchSliceCfg;
 569
 570 /**
 571  * @brief
 572  * Control block for sch
 573  */
 574 typedef struct schCb
 575 {
 576    TskInit       schInit;               /*!< Task Init info */
 577    SchGenCb      genCfg;                /*!< General Config info */
 578    CmTqCp        tmrTqCp;               /*!< Timer Task Queue Cntrl Point */
 579    CmTqType      tmrTq[SCH_TQ_SIZE];    /*!< Timer Task Queue */
 580    SchCellCb     *cells[MAX_NUM_CELL];  /* Array to store cellCb ptr */
 581    SchSliceCfg   sliceCfg;
 582 }SchCb;
 583
 584 /* Declaration for scheduler control blocks */
 585 SchCb schCb[SCH_MAX_INST];
 586
 587 /* function declarations */
 588 short int schActvTmr(Ent ent,Inst inst);
 589
 590 /* Configuration related function declarations */
 591 void schInitUlSlot(SchUlSlotInfo *schUlSlotInfo);
 592 void schInitDlSlot(SchDlSlotInfo *schDlSlotInfo);
 593 void BuildK0K1Table(SchCellCb *cell, SchK0K1TimingInfoTbl *k0K1InfoTbl, bool pdschCfgCmnPres, \
 594    SchPdschCfgCmn pdschCmnCfg,SchPdschConfig pdschDedCfg, uint8_t ulAckListCount, uint8_t *UlAckTbl);
 595 void BuildK2InfoTable(SchCellCb *cell, SchPuschTimeDomRsrcAlloc timeDomRsrcAllocList[], \
 596    uint16_t puschSymTblSize, SchK2TimingInfoTbl *msg3K2InfoTbl, SchK2TimingInfoTbl *k2InfoTbl);
 597 uint8_t SchSendCfgCfm(Pst *pst, RgMngmt *cfm);
 598 SchUeCb* schGetUeCb(SchCellCb *cellCb, uint16_t crnti);
 599 uint8_t addUeToBeScheduled(SchCellCb *cell, uint8_t ueId);
 600
 601 /* Incoming message handler function declarations */
 602 uint8_t schProcessSlotInd(SlotTimingInfo *slotInd, Inst inst);
 603 uint8_t schProcessRachInd(RachIndInfo *rachInd, Inst schInst);
 604 uint8_t schProcessCrcInd(CrcIndInfo *crcInd, Inst schInst);
 605
 606 /* DL scheduling related function declarations */
 607 PduTxOccsaion schCheckSsbOcc(SchCellCb *cell, SlotTimingInfo slotTime);
 608 PduTxOccsaion schCheckSib1Occ(SchCellCb *cell, SlotTimingInfo slotTime);
 609 uint8_t schBroadcastSsbAlloc(SchCellCb *cell, SlotTimingInfo slotTime, DlBrdcstAlloc *dlBrdcstAlloc);
 610 uint8_t schBroadcastSib1Alloc(SchCellCb *cell, SlotTimingInfo slotTime, DlBrdcstAlloc *dlBrdcstAlloc);
 611 bool schProcessRaReq(Inst schInst, SchCellCb *cellCb, SlotTimingInfo currTime, uint8_t ueId);
 612 uint8_t schProcessMsg4Req(SchCellCb *cell, SlotTimingInfo currTime, uint8_t ueId,bool isRetxMsg4, SchDlHqProcCb **hqP);
 613 uint8_t schFillRar(SchCellCb *cell, SlotTimingInfo rarTime, uint16_t ueId, RarAlloc *rarAlloc, uint8_t k0Index);
 614 uint8_t schDlRsrcAllocDlMsg(SchCellCb *cell, SlotTimingInfo slotTime, uint16_t crnti,
 615 uint32_t tbSize, DlMsgAlloc *dlMsgAlloc, uint16_t startPRB, uint8_t pdschStartSymbol, uint8_t pdschNumSymbols,bool isRetx, SchDlHqProcCb* hqP);
 616 uint8_t schDlRsrcAllocMsg4(SchCellCb *cell, SlotTimingInfo msg4Time, uint8_t ueId, DlMsgAlloc *msg4Alloc,\
 617 uint8_t pdschStartSymbol, uint8_t pdschNumSymbols, bool isRetx, SchDlHqProcCb *hqP);
 618 uint8_t allocatePrbDl(SchCellCb *cell, SlotTimingInfo slotTime, uint8_t startSymbol, uint8_t symbolLength, \
 619    uint16_t *startPrb, uint16_t numPrb);
 620 void fillDlMsgInfo(DlMsgInfo *dlMsgInfo, uint8_t crnti, bool isRetx, SchDlHqProcCb* hqP);
 621 bool findValidK0K1Value(SchCellCb *cell, SlotTimingInfo currTime, uint8_t ueId, bool dedMsg, uint8_t *pdschStartSymbol,\
 622 uint8_t *pdschSymblLen, SlotTimingInfo *pdcchTime,  SlotTimingInfo *pdschTime, SlotTimingInfo *pucchTime, bool isRetx, SchDlHqProcCb *hqP);
 623 RaRspWindowStatus isInRaRspWindow(SchRaReq *raReq, SlotTimingInfo frameToCheck, uint16_t numSlotsPerSystemFrame);
 624 /* UL scheduling related function declarations */
 625 uint8_t schUlResAlloc(SchCellCb *cell, Inst schInst);
 626 bool schCheckPrachOcc(SchCellCb *cell, SlotTimingInfo prachOccasionTimingInfo);
 627 uint8_t schCalcPrachNumRb(SchCellCb *cell);
 628 void schPrachResAlloc(SchCellCb *cell, UlSchedInfo *ulSchedInfo, SlotTimingInfo prachOccasionTimingInfo);
 629 uint16_t schAllocPucchResource(SchCellCb *cell, SlotTimingInfo pucchTime, uint16_t crnti,SchUeCb *ueCb, bool isRetx, SchDlHqProcCb *hqP);
 630 uint8_t schFillUlDci(SchUeCb *ueCb, SchPuschInfo *puschInfo, DciInfo *dciInfo, bool isRetx, SchUlHqProcCb *hqP);
 631 uint8_t schFillPuschAlloc(SchUeCb *ueCb, SlotTimingInfo puschTime, uint32_t tbSize,
 632                             uint8_t startSymb, uint8_t symbLen, uint16_t startPrb, bool isRetx, SchUlHqProcCb *hqP);
 633 uint8_t allocatePrbUl(SchCellCb *cell, SlotTimingInfo slotTime, uint8_t startSymbol, uint8_t symbolLength, \
 634    uint16_t *startPrb, uint16_t numPrb);
 635 bool schProcessSrOrBsrReq(SchCellCb *cell, SlotTimingInfo currTime, uint8_t ueId, bool isRetx, SchUlHqProcCb **hqP);
 636 uint8_t schCalculateUlTbs(SchUeCb *ueCb, SlotTimingInfo puschTime, uint8_t symbLen,\
 637                              uint16_t *startPrb, uint32_t *totTBS, bool isRetx, SchUlHqProcCb *hqP);
 638
 639 /*Generic Functions*/
 640 void updateGrantSizeForBoRpt(CmLListCp *lcLL, DlMsgAlloc *dlMsgAlloc, BsrInfo *bsrInfo, uint32_t *accumalatedBOSize);
 641 uint16_t searchLargestFreeBlock(SchCellCb *cell, SlotTimingInfo slotTime,uint16_t *startPrb, Direction dir);
 642 LcInfo* handleLcLList(CmLListCp *lcLL, uint8_t lcId, ActionTypeLL action);
 643 void prbAllocUsingRRMPolicy(CmLListCp *lcLL, bool dedicatedPRB, uint16_t mcsIdx,uint8_t numSymbols,\
 644                       uint16_t *sharedPRB, uint16_t *reservedPRB, bool *isTxPayloadLenAdded, bool *srRcvd);
 645 void updateBsrAndLcList(CmLListCp *lcLL, BsrInfo *bsrInfo, uint8_t status);
 646
 647 /*Paging Functions*/
 648 void schProcPagingCfg(SchCellCb *cell);
 649 void schCfgPdcchMonOccOfPO(SchCellCb *cell);
 650 void schIncrSlot(SlotTimingInfo *timingInfo, uint8_t incr, uint16_t numSlotsPerRF);
 651 uint8_t schFillPagePdschCfg(SchCellCb *cell, PdschCfg *pagePdschCfg, SlotTimingInfo slotTime, \
 652                              uint16_t tbSize, uint8_t mcs, uint16_t startPrb);
 653 /*DL HARQ Functions*/
 654 void schDlHqEntInit(SchCellCb *cellCb, SchUeCb *ueCb);
 655 void schMsg4FeedbackUpdate(SchDlHqProcCb *hqP, uint8_t fdbk);
 656 void schDlHqFeedbackUpdate(SchDlHqProcCb *hqP, uint8_t fdbk1, uint8_t fdbk2);
 657 uint8_t schDlGetAvlHqProcess(SchCellCb *cellCb, SchUeCb *ueCb, SchDlHqProcCb **hqP);
 658 void schDlReleaseHqProcess(SchDlHqProcCb *hqP);
 659
 660 /*UL HARQ Functions*/
 661 void schUlHqEntInit(SchCellCb *cellCb, SchUeCb *ueCb);
 662 uint8_t schMsg3RetxSchedulingForUe(SchRaCb *raCb);
 663 void schUlHqProcessNack(SchUlHqProcCb *hqP);
 664 void schUlHqProcessAck(SchUlHqProcCb *hqP);
 665 uint8_t schUlGetAvlHqProcess(SchCellCb *cellCb, SchUeCb *ueCb, SchUlHqProcCb **hqP);
 666 void schUlReleaseHqProcess(SchUlHqProcCb *hqP, Bool togNdi);
 667
 668 /* UE Manager HARQ Fun*/
 669 void schUpdateHarqFdbk(SchUeCb *ueCb, uint8_t numHarq, uint8_t *harqPayload,SlotTimingInfo *slotInd);
 670
 671 /* Round Robbin Scheduler funtions*/
 672 uint8_t schFillUlDciForMsg3Retx(SchRaCb *raCb, SchPuschInfo *puschInfo, DciInfo *dciInfo);
 673 bool schGetMsg3K2(SchCellCb *cell, SchUlHqProcCb* msg3HqProc, uint16_t dlTime, SlotTimingInfo *msg3Time, bool isRetx);
 674 void schMsg4Complete(SchUeCb *ueCb);
 675 /**********************************************************************
 676   End of file
 677  **********************************************************************/