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 #define NUM_SCH_TYPE 2  /*Supported number of Scheduler Algorithm types*/
  80
  81 typedef struct schDlHqProcCb SchDlHqProcCb;
  82 typedef struct schUlHqEnt SchUlHqEnt;
  83 typedef struct schRaReq SchRaReq;
  84 typedef struct schDlHqEnt SchDlHqEnt;
  85 typedef struct schCellCb SchCellCb;
  86 typedef struct schUeCb SchUeCb;
  87
  88 typedef enum
  89 {
  90    SCH_FCFS,
  91    SCH_SLICE_BASED
  92 }SchType;
  93
  94 typedef enum
  95 {
  96    SCH_NUMEROLOGY_0,
  97    SCH_NUMEROLOGY_1,
  98    SCH_NUMEROLOGY_2,
  99    SCH_NUMEROLOGY_3,
 100    SCH_NUMEROLOGY_4
 101 }SchNumerology;
 102
 103 typedef enum
 104 {
 105    SCH_UE_STATE_INACTIVE,
 106    SCH_UE_STATE_ACTIVE,
 107    SCH_UE_HANDIN_IN_PROGRESS
 108 }SchUeState;
 109
 110 typedef enum
 111 {
 112    SCH_RA_STATE_MSG2_HANDLE,
 113    SCH_RA_STATE_MSG3_PENDING,
 114    SCH_RA_STATE_MSG4_PENDING,
 115    SCH_RA_STATE_MSG4_DONE
 116 }SchRaState;
 117
 118 typedef enum
 119 {
 120    SCH_LC_STATE_INACTIVE,
 121    SCH_LC_STATE_ACTIVE
 122 }SchLcState;
 123
 124 typedef enum
 125 {
 126    WINDOW_YET_TO_START,
 127    WITHIN_WINDOW,
 128    WINDOW_EXPIRED
 129 }RaRspWindowStatus;
 130
 131 typedef enum
 132 {
 133    HQ_TB_ACKED=0,
 134    HQ_TB_NACKED,
 135    HQ_TB_WAITING
 136 }SchHqTbState;
 137
 138 /*Following structures to keep record and estimations of PRB allocated for each
 139  * LC taking into consideration the RRM policies*/
 140 typedef struct lcInfo
 141 {
 142    uint8_t  lcId;     /*LCID for which BO are getting recorded*/
 143    uint32_t reqBO;    /*Size of the BO requested/to be allocated for this LC*/
 144    uint32_t allocBO;  /*TBS/BO Size which is actually allocated*/
 145    uint8_t  allocPRB; /*PRB count which is allocated based on RRM policy/FreePRB*/
 146 }LcInfo;
 147
 148 typedef struct schUlHqTbCb
 149 {
 150    uint32_t               tbSzReq;
 151    uint32_t               tbSzAllc;
 152    uint8_t                ndi;
 153    uint8_t                rv;
 154    uint8_t                rvIdx;
 155    uint8_t                qamOrder;
 156    SchMcsTable            mcsTable;
 157    uint8_t                iMcs;
 158    uint8_t                iMcsInDci;
 159    uint8_t                numLyrs;
 160    uint8_t                txCntr;
 161    SchHqTbState           state;
 162    uint8_t                cntrRetxAllocFail;
 163    uint8_t                statsBitmap;
 164 }SchUlHqTbCb;
 165
 166 typedef struct schDlHqTbCb
 167 {
 168    uint8_t                tbIdx;
 169    Bool                   isEnabled;
 170    uint32_t               tbSzReq;
 171    uint8_t                txCntr;
 172    uint8_t                ndi;
 173    uint8_t                rv;
 174    uint8_t                rvIdx;
 175    uint8_t                iMcs;
 176    uint8_t                iMcsInDci;
 177    uint8_t                numLyrs;
 178    SchHqTbState           state;
 179    uint8_t                isAckNackDtx;
 180    uint8_t                cntrRetxAllocFail;
 181    //InfUeTbInfo          tbCompInfo;
 182    uint8_t                statsBitmap;
 183 }SchDlHqTbCb;
 184
 185 #ifdef NR_DRX
 186 typedef struct schDrxHarqCb
 187 {
 188    uint32_t     rttExpIndex;
 189    CmLList      *rttExpNode;
 190    uint32_t     retxStrtIndex;
 191    CmLList      *retxStrtNode;
 192    uint32_t     retxExpIndex;
 193    CmLList      *retxExpNode;
 194 }SchDrxHarqCb;
 195 #endif
 196
 197 typedef struct schUlHqProcCb
 198 {
 199    uint8_t           procId;       /*!< HARQ Process ID */
 200    SchUlHqEnt        *hqEnt;
 201    uint8_t           maxHqTxPerHqP;
 202    SchUlHqTbCb       tbInfo;
 203    CmLList           ulHqEntLnk;
 204    CmLList           ulSlotLnk;
 205    uint8_t           strtSymbl;
 206    uint8_t           numSymbl;
 207    void              *schSpcUlHqProcCb;  /*!< Scheduler specific HARQ Proc CB */
 208    CmLList           ulHqProcLink;
 209    uint8_t           puschResType;       /*!< Resource allocation type */
 210    uint16_t          puschStartPrb;
 211    uint16_t          puschNumPrb;
 212    uint8_t           dmrsMappingType;
 213    uint8_t           nrOfDmrsSymbols;
 214    uint8_t           dmrsAddPos;
 215    SlotTimingInfo    puschTime;
 216 #ifdef NR_DRX
 217    SchDrxHarqCb      ulDrxHarqCb;
 218 #endif
 219 }SchUlHqProcCb;
 220
 221 struct schDlHqProcCb
 222 {
 223    uint8_t           procId;       /*!< HARQ Process ID */
 224    SchDlHqEnt        *hqEnt;
 225    uint8_t           maxHqTxPerHqP;
 226    CmLList           dlHqEntLnk;
 227    CmLList           ulSlotLnk;
 228    SchDlHqTbCb       tbInfo[2];
 229    uint8_t           k1;
 230    void              *schSpcDlHqProcCb;  /*!< Scheduler specific HARQ Proc CB */
 231    CmLList           dlHqProcLink;
 232    SlotTimingInfo    pucchTime;
 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    SchSpCellRecfg       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    bool      drxDlUeActiveStatus;       /* Final Dl Ue status which is marked as true if drxDlUeActiveMask or drxDlUeActiveMaskForHarq is present */
 416    bool      drxUlUeActiveStatus;       /* Final Ul Ue status which is marked as true if drxUlUeActiveMask or drxUlUeActiveMaskForHarq is present */
 417    uint32_t  drxDlUeActiveMask;          /* variable is used to store the status about downlink active status of Ue for On-duration, inactive timer*/
 418    uint32_t  drxUlUeActiveMask;          /* variable is used to store the status about uplink active status for on-duration inactive timer*/
 419    uint32_t  drxDlUeActiveMaskForHarq;   /* variable is used to store the status about downlink active status for harq*/
 420    uint32_t  drxUlUeActiveMaskForHarq;   /* variable is used to store the status about uplink active status for harq */
 421    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 */
 422    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 */
 423    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 */
 424    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*/
 425    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*/
 426    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*/
 427    uint32_t  longCycleLen;           /* length of long Cycle value received from ue cfg/recfg in form of ms*/
 428    bool      longCycleToBeUsed;      /* long cycle should be used once the short cycle gets expires */
 429    uint32_t  drxStartOffset;         /* length of drxStartOffset value received from ue cfg/recfg in form of ms, which helps in getting on duration start point*/
 430    bool      shortCyclePresent;      /* set this value if shortCycle is Present */
 431    uint32_t  shortCycleLen;          /* length of short Cycle value received from ue cfg/recfg in form of ms*/
 432    uint32_t  shortCycleTmrLen;       /* value shortCycleTmr is the multiple of shortCycle which is received from ue cfg/recfg in form of integer*/
 433    uint32_t  drxSlotOffset;          /* drxSlotOffset value received from ue cfg/recfg which is used to delay before starting the drx-onDuration*/
 434    uint32_t  onDurationStartIndex;   /* Index at which UE is stored in onDuration starts list */
 435    uint32_t  onDurationExpiryIndex;  /* Index at which UE is stored in onDuration expires in the list */
 436    uint32_t  inActvExpiryIndex;      /* Index at which UE is stored in inActvTimer expires in the list */
 437    uint32_t  shortCycleExpiryIndex;  /* Index at which UE is stored in shortCycle expires in the list */
 438    int32_t   shortCycleDistance;     /* Distance after how many slot short cycle tmr gets expire */
 439    int32_t   onDurationStartDistance;/* Distance after how many slot on Duration Start tmr gets expire */
 440    int32_t   onDurationExpiryDistance;/* Distance after how many slot on Duration tmr gets expire */
 441    int32_t   inActiveTmrExpiryDistance;/* Distance after how many slot inActive tmr gets expire */
 442    CmLList   *onDurationStartNodeInfo; /* Node present in on duration start list*/
 443    CmLList   *onDurationExpiryNodeInfo;/* Node present in on duration exp list*/
 444    CmLList   *inActvTimerExpiryNodeInfo; /* Node present in in active exp list*/
 445    CmLList   *shortCycleTmrExpiryNodeInfo; /* Node present in short cycle exp list*/
 446 }SchDrxUeCb;
 447 #endif
 448 /**
 449  * @brief
 450  * UE control block
 451  */
 452 typedef struct schUeCb
 453 {
 454    uint16_t   ueId;
 455    uint16_t   crnti;
 456    SchUeCfgCb ueCfg;
 457    SchUeState state;
 458    SchCellCb  *cellCb;
 459    SchCfraResource cfraResource;
 460    bool       srRcvd;
 461    bool       bsrRcvd;
 462    BsrInfo    bsrInfo[MAX_NUM_LOGICAL_CHANNEL_GROUPS];
 463    SchUlCb    ulInfo;
 464    SchDlCb    dlInfo;
 465    SchUlHqEnt ulHqEnt;
 466    SchDlHqEnt dlHqEnt;
 467    SchDlHqProcCb *msg4HqProc;
 468    SchDlHqProcCb *retxMsg4HqProc;
 469    SchHqDlMap    **hqDlmap;
 470    SchHqUlMap    **hqUlmap;
 471    void          *schSpcUeCb;
 472 #ifdef NR_DRX
 473    bool          ueDrxInfoPres;
 474    SchDrxUeCb    drxUeCb;
 475 #endif
 476 }SchUeCb;
 477
 478 /**
 479  * @brief
 480  * RA Request Info
 481  */
 482 typedef struct schRaReq
 483 {
 484    uint32_t        raRnti;
 485    RachIndInfo     *rachInd;
 486    bool            isCFRA;
 487    SchUeCb         *ueCb;          /* Filled only if isCFRA = true */
 488    SlotTimingInfo  winStartTime;
 489    SlotTimingInfo  winEndTime;
 490 }SchRaReq;
 491
 492 typedef struct schPageInfo
 493 {
 494   uint16_t       pf;          /*Value of Paging Frame received from DUAPP*/
 495   uint8_t        i_s;         /*Value of Paging Occ Index received from DUAPP*/
 496   SlotTimingInfo pageTxTime;  /*Start Paging window*/
 497   uint8_t        mcs;         /*MCS index*/
 498   uint16_t       msgLen;      /*Pdu length */
 499   uint8_t       *pagePdu;     /*RRC Page PDU bit string*/
 500 }SchPageInfo;
 501
 502 typedef struct schPagingOcc
 503 {
 504   uint8_t frameOffset;
 505   uint8_t pagingOccSlot;
 506 }SchPagingOcc;
 507
 508 typedef struct schPageCb
 509 {
 510    CmLListCp    pageIndInfoRecord[MAX_SFN]; /*List of Page Records received which are stored per sfn*/
 511    SchPagingOcc pagMonOcc[MAX_PO_PER_PF];   /*Paging Occasion Slot/FrameOffset are stored*/
 512 }SchPageCb;
 513
 514 #ifdef NR_DRX
 515 typedef struct schDrxCb
 516 {
 517    CmLListCp   onDurationStartList;   /*!< Tracks the start of onDuration Timer. */
 518    CmLListCp   onDurationExpiryList;   /*!< Tracks the Expiry of onDuration Timer. */
 519    CmLListCp   inActvTmrExpiryList;   /*!< Tracks the Expiry of drx-InactivityTimer. */
 520    CmLListCp   shortCycleExpiryList;   /*!< Tracks the Expiry of DRX Short Cycle. */
 521    CmLListCp   dlHarqRttExpiryList;   /*!< Tracks the Expiry of DL HARQ RTT timer. */
 522    CmLListCp   dlRetransExpiryList;   /*!< Tracks the Expiry of DL Re-Transmission timer. */
 523    CmLListCp   ulHarqRttExpiryList;   /*!< Tracks the Expiry of UL HARQ RTT timer. */
 524    CmLListCp   ulRetransExpiryList;   /*!< Tracks the Expiry of UL Re-Transmission timer. */
 525    CmLListCp   dlRetransTmrStartList; /*!< It has list of DL harq procs for */
 526    CmLListCp   ulRetransTmrStartList; /*!< It has list of UL harq procs for */
 527 }SchDrxCb;
 528 #endif
 529
 530 typedef struct schAllApis
 531 {
 532    uint8_t (* SchCellCfgReq)(SchCellCb *cellCb);
 533    void (* SchCellDeleteReq)(SchCellCb *cellCb);
 534    uint8_t (* SchAddUeConfigReq)(SchUeCb  *ueCb);
 535    void (* SchModUeConfigReq)(SchUeCb  *ueCb);
 536    void (* SchUeDeleteReq)(SchUeCb  *ueCb);
 537    void (* SchDlHarqInd)();
 538    void (* SchPagingInd)();
 539    void (* SchRachRsrcReq)();
 540    void (* SchRachRsrcRel)();
 541    void (* SchCrcInd)(SchCellCb *cellCb, uint16_t ueId);
 542    void (* SchRachInd)(SchCellCb *cellCb, uint16_t ueId);
 543    void (* SchDlRlcBoInfo)(SchCellCb *cellCb, uint16_t ueId);
 544    void (* SchSrUciInd)(SchCellCb *cellCb, uint16_t ueId);
 545    void (* SchBsr)(SchCellCb *cellCb, uint16_t ueId);
 546    void (* SchHandleLcList)(void *ptr, CmLList *node, ActionTypeLL action);
 547    void (* SchAddToDlHqRetxList)(SchDlHqProcCb *hqP);
 548    void (* SchAddToUlHqRetxList)(SchUlHqProcCb *hqP);
 549    void (* SchRemoveFrmDlHqRetxList)(SchUeCb *ueCb, CmLList *node);
 550    void (* SchRemoveFrmUlHqRetxList)(SchUeCb *ueCb, CmLList *node);
 551    uint8_t (* SchAddUeToSchedule)(SchCellCb *cellCb, uint16_t ueId);
 552    void (* SchRemoveUeFrmScheduleLst)(SchCellCb *cell, CmLList *node);
 553    uint8_t (* SchInitDlHqProcCb)(SchDlHqProcCb *hqP);
 554    uint8_t (* SchInitUlHqProcCb)(SchUlHqProcCb *hqP);
 555    void (* SchFreeDlHqProcCb)(SchDlHqProcCb *hqP);
 556    void (* SchFreeUlHqProcCb)(SchUlHqProcCb *hqP);
 557    void (* SchDeleteDlHqProcCb)(SchDlHqProcCb *hqP);
 558    void (* SchDeleteUlHqProcCb)(SchUlHqProcCb *hqP);
 559    void (* SchScheduleSlot)(SchCellCb *cell, SlotTimingInfo *slotInd, Inst schInst);
 560    uint32_t (* SchScheduleDlLc)(SlotTimingInfo pdcchTime, SlotTimingInfo pdschTime, uint8_t pdschNumSymbols, \
 561       bool isRetx, SchDlHqProcCb **hqP);
 562    uint8_t (* SchScheduleUlLc)(SlotTimingInfo dciTime, SlotTimingInfo puschTime, uint8_t startStmb, \
 563       uint8_t symbLen, bool isRetx, SchUlHqProcCb **hqP);
 564 }SchAllApis;
 565 /**
 566  * @brief
 567  * Cell Control block per cell.
 568  */
 569 typedef struct schCellCb
 570 {
 571    uint16_t      cellId;                            /*!< Cell ID */
 572    Inst          instIdx;                           /*!< Index of the scheduler instance */
 573    Inst          macInst;                           /*!< Index of the MAC instance */
 574    uint16_t       numSlots;                          /*!< Number of slots in current frame */
 575    SlotTimingInfo   slotInfo;                          /*!< SFN, Slot info being processed*/
 576    SchDlSlotInfo **schDlSlotInfo;                   /*!< SCH resource allocations in DL */
 577    SchUlSlotInfo **schUlSlotInfo;                   /*!< SCH resource allocations in UL */
 578    SchCellCfg    cellCfg;                           /*!< Cell ocnfiguration */
 579    bool          firstSsbTransmitted;
 580    bool          firstSib1Transmitted;
 581    uint8_t       ssbStartSymbArr[SCH_MAX_SSB_BEAM]; /*!< start symbol per SSB beam */
 582    uint64_t      dedPreambleBitMap;                 /*!< Bit map to find used/free preambles index */
 583    SchRaReq      *raReq[MAX_NUM_UE];                /*!< Pending RA request */
 584    SchRaCb       raCb[MAX_NUM_UE];                  /*!< RA Cb */
 585    uint16_t      numActvUe;                         /*!< Number of active UEs */
 586    uint32_t      actvUeBitMap;                      /*!< Bit map to find active UEs */
 587    uint32_t      boIndBitMap;                       /*!< Bit map to indicate UEs that have recevied BO */
 588    SchUeCb       ueCb[MAX_NUM_UE];                  /*!< Pointer to UE contexts of this cell */
 589    SchPageCb     pageCb;                            /*!< Page Record at Schedular*/
 590 #ifdef NR_TDD
 591    uint8_t       numSlotsInPeriodicity;             /*!< number of slots in configured periodicity and SCS */
 592    uint32_t      slotFrmtBitMap;                    /*!< 2 bits must be read together to determine D/U/S slots. 00-D, 01-U, 10-S */
 593    uint32_t      symbFrmtBitMap;                    /*!< 2 bits must be read together to determine D/U/S symbols. 00-D, 01-U, 10-S */
 594 #endif
 595 #ifdef NR_DRX
 596    SchDrxCb      drxCb[MAX_DRX_SIZE];                           /*!< Drx cb*/
 597 #endif
 598    SchType       schAlgoType;                       /*!< The scheduler type which the cell is configured with.*/
 599    SchAllApis    *api;                             /*!< Reference of sch APIs for this cell based on the SchType*/
 600    void          *schSpcCell;                       /*Ref of Scheduler specific structure*/
 601 }SchCellCb;
 602
 603
 604 typedef struct schSliceCfg
 605 {
 606    uint8_t        numOfSliceConfigured;
 607    SchRrmPolicyOfSlice **listOfSlices;
 608 }SchSliceCfg;
 609
 610 /**
 611  * @brief
 612  * Control block for sch
 613  */
 614 typedef struct schCb
 615 {
 616    TskInit                schInit;               /*!< Task Init info */
 617    SchGenCb               genCfg;                /*!< General Config info */
 618    CmTqCp                 tmrTqCp;               /*!< Timer Task Queue Cntrl Point */
 619    CmTqType               tmrTq[SCH_TQ_SIZE];    /*!< Timer Task Queue */
 620    SchAllApis             allApis[NUM_SCH_TYPE]; /*!<List of All Scheduler Type dependent Function pointers*/
 621    SchCellCb              *cells[MAX_NUM_CELL];  /* Array to store cellCb ptr */
 622    SchSliceCfg            sliceCfg;
 623 }SchCb;
 624
 625 /* Declaration for scheduler control blocks */
 626 SchCb schCb[SCH_MAX_INST];
 627
 628 /* function declarations */
 629 short int schActvTmr(Ent ent,Inst inst);
 630 void SchFillCfmPst(Pst *reqPst,Pst *cfmPst,RgMngmt *cfm);
 631
 632 /* Configuration related function declarations */
 633 void schInitUlSlot(SchUlSlotInfo *schUlSlotInfo);
 634 void schInitDlSlot(SchDlSlotInfo *schDlSlotInfo);
 635 void BuildK0K1Table(SchCellCb *cell, SchK0K1TimingInfoTbl *k0K1InfoTbl, bool pdschCfgCmnPres, \
 636    SchPdschCfgCmn pdschCmnCfg,SchPdschConfig pdschDedCfg, uint8_t ulAckListCount, uint8_t *UlAckTbl);
 637 void BuildK2InfoTable(SchCellCb *cell, SchPuschTimeDomRsrcAlloc timeDomRsrcAllocList[], \
 638    uint16_t puschSymTblSize, SchK2TimingInfoTbl *msg3K2InfoTbl, SchK2TimingInfoTbl *k2InfoTbl);
 639 uint8_t SchSendCfgCfm(Pst *pst, RgMngmt *cfm);
 640 SchUeCb* schGetUeCb(SchCellCb *cellCb, uint16_t crnti);
 641 uint8_t addUeToBeScheduled(SchCellCb *cell, uint8_t ueId);
 642
 643 /* Incoming message handler function declarations */
 644 uint8_t SchProcCellCfgReq(Pst *pst, SchCellCfg *schCellCfg);
 645 uint8_t SchProcSlotInd(Pst *pst, SlotTimingInfo *slotInd);
 646 uint8_t SchProcRachInd(Pst *pst, RachIndInfo *rachInd);
 647 uint8_t SchProcCrcInd(Pst *pst, CrcIndInfo *crcInd);
 648 uint8_t SchProcDlRlcBoInfo(Pst *pst, DlRlcBoInfo *dlBoInfo);
 649 uint8_t SchAddUeConfigReq(Pst *pst, SchUeCfgReq *ueCfgToSch);
 650 uint8_t SchProcBsr(Pst *pst, UlBufferStatusRptInd *bsrInd);
 651 uint8_t SchProcSrUciInd(Pst *pst, SrUciIndInfo *uciInd);
 652 uint8_t SchModUeConfigReq(Pst *pst, SchUeRecfgReq *ueRecfgToSch);
 653 uint8_t SchProcUeDeleteReq(Pst *pst, SchUeDelete  *ueDelete);
 654 uint8_t SchProcCellDeleteReq(Pst *pst, SchCellDeleteReq  *schCellDelete);
 655 uint8_t SchProcSliceCfgReq(Pst *pst, SchSliceCfgReq *schSliceCfgReq);
 656 uint8_t SchProcSliceRecfgReq(Pst *pst, SchSliceRecfgReq *schSliceRecfgReq);
 657 uint8_t SchProcRachRsrcReq(Pst *pst, SchRachRsrcReq *schRachRsrcReq);
 658 uint8_t SchProcRachRsrcRel(Pst *pst, SchRachRsrcRel *schRachRsrcRel);
 659 uint8_t SchProcPagingInd(Pst *pst,  SchPageInd *pageInd);
 660 uint8_t SchProcDlHarqInd(Pst *pst, DlHarqInd *dlHarqInd);
 661
 662 /* DL scheduling related function declarations */
 663 PduTxOccsaion schCheckSsbOcc(SchCellCb *cell, SlotTimingInfo slotTime);
 664 PduTxOccsaion schCheckSib1Occ(SchCellCb *cell, SlotTimingInfo slotTime);
 665 uint8_t schBroadcastSsbAlloc(SchCellCb *cell, SlotTimingInfo slotTime, DlBrdcstAlloc *dlBrdcstAlloc);
 666 uint8_t schBroadcastSib1Alloc(SchCellCb *cell, SlotTimingInfo slotTime, DlBrdcstAlloc *dlBrdcstAlloc);
 667 bool schProcessRaReq(Inst schInst, SchCellCb *cellCb, SlotTimingInfo currTime, uint8_t ueId);
 668 uint8_t schProcessMsg4Req(SchCellCb *cell, SlotTimingInfo currTime, uint8_t ueId,bool isRetxMsg4, SchDlHqProcCb **hqP);
 669 uint8_t schFillRar(SchCellCb *cell, SlotTimingInfo rarTime, uint16_t ueId, RarAlloc *rarAlloc, uint8_t k0Index);
 670 bool schFillBoGrantDlSchedInfo(SchCellCb *cell, SlotTimingInfo currTime, uint8_t ueId, bool isRetx, SchDlHqProcCb **hqP);
 671 uint8_t schDlRsrcAllocDlMsg(SchCellCb *cell, SlotTimingInfo slotTime, uint16_t crnti,
 672 uint32_t tbSize, DlMsgAlloc *dlMsgAlloc, uint16_t startPRB, uint8_t pdschStartSymbol, uint8_t pdschNumSymbols,bool isRetx, SchDlHqProcCb* hqP);
 673 uint8_t schDlRsrcAllocMsg4(SchCellCb *cell, SlotTimingInfo msg4Time, uint8_t ueId, DlMsgAlloc *msg4Alloc,\
 674 uint8_t pdschStartSymbol, uint8_t pdschNumSymbols, bool isRetx, SchDlHqProcCb *hqP);
 675 uint8_t allocatePrbDl(SchCellCb *cell, SlotTimingInfo slotTime, uint8_t startSymbol, uint8_t symbolLength, \
 676    uint16_t *startPrb, uint16_t numPrb);
 677 void fillDlMsgInfo(DlMsgInfo *dlMsgInfo, uint8_t crnti, bool isRetx, SchDlHqProcCb* hqP);
 678 bool findValidK0K1Value(SchCellCb *cell, SlotTimingInfo currTime, uint8_t ueId, bool dedMsg, uint8_t *pdschStartSymbol,\
 679 uint8_t *pdschSymblLen, SlotTimingInfo *pdcchTime,  SlotTimingInfo *pdschTime, SlotTimingInfo *pucchTime, bool isRetx, SchDlHqProcCb *hqP);
 680 RaRspWindowStatus isInRaRspWindow(SchRaReq *raReq, SlotTimingInfo frameToCheck, uint16_t numSlotsPerSystemFrame);
 681
 682 /* UL scheduling related function declarations */
 683 uint8_t schUlResAlloc(SchCellCb *cell, Inst schInst);
 684 bool schCheckPrachOcc(SchCellCb *cell, SlotTimingInfo prachOccasionTimingInfo);
 685 uint8_t schCalcPrachNumRb(SchCellCb *cell);
 686 void schPrachResAlloc(SchCellCb *cell, UlSchedInfo *ulSchedInfo, SlotTimingInfo prachOccasionTimingInfo);
 687 uint16_t schAllocPucchResource(SchCellCb *cell, SlotTimingInfo pucchTime, uint16_t crnti,SchUeCb *ueCb, bool isRetx, SchDlHqProcCb *hqP);
 688 uint8_t schFillUlDci(SchUeCb *ueCb, SchPuschInfo *puschInfo, DciInfo *dciInfo, bool isRetx, SchUlHqProcCb *hqP);
 689 uint8_t schFillPuschAlloc(SchUeCb *ueCb, SlotTimingInfo puschTime, uint32_t tbSize,
 690                             uint8_t startSymb, uint8_t symbLen, uint16_t startPrb, bool isRetx, SchUlHqProcCb *hqP);
 691 uint8_t allocatePrbUl(SchCellCb *cell, SlotTimingInfo slotTime, uint8_t startSymbol, uint8_t symbolLength, \
 692    uint16_t *startPrb, uint16_t numPrb);
 693 bool schProcessSrOrBsrReq(SchCellCb *cell, SlotTimingInfo currTime, uint8_t ueId, bool isRetx, SchUlHqProcCb **hqP);
 694
 695 /*Generic Functions*/
 696 void updateGrantSizeForBoRpt(CmLListCp *lcLL, DlMsgAlloc *dlMsgAlloc, BsrInfo *bsrInfo, uint32_t *accumalatedBOSize);
 697 uint16_t searchLargestFreeBlock(SchCellCb *cell, SlotTimingInfo slotTime,uint16_t *startPrb, Direction dir);
 698 LcInfo* handleLcLList(CmLListCp *lcLL, uint8_t lcId, ActionTypeLL action);
 699 void prbAllocUsingRRMPolicy(CmLListCp *lcLL, bool dedicatedPRB, uint16_t mcsIdx,uint8_t numSymbols,\
 700                       uint16_t *sharedPRB, uint16_t *reservedPRB, bool *isTxPayloadLenAdded, bool *srRcvd);
 701 void updateBsrAndLcList(CmLListCp *lcLL, BsrInfo *bsrInfo, uint8_t status);
 702
 703 /*Paging Functions*/
 704 void schProcPagingCfg(SchCellCb *cell);
 705 void schCfgPdcchMonOccOfPO(SchCellCb *cell);
 706 void schIncrSlot(SlotTimingInfo *timingInfo, uint8_t incr, uint16_t numSlotsPerRF);
 707 uint8_t schFillPagePdschCfg(SchCellCb *cell, PdschCfg *pagePdschCfg, SlotTimingInfo slotTime, \
 708                              uint16_t tbSize, uint8_t mcs, uint16_t startPrb);
 709 /*DL HARQ Functions*/
 710 void schDlHqEntInit(SchCellCb *cellCb, SchUeCb *ueCb);
 711 void schMsg4FeedbackUpdate(SchDlHqProcCb *hqP, uint8_t fdbk);
 712 void schDlHqFeedbackUpdate(SchDlHqProcCb *hqP, uint8_t fdbk1, uint8_t fdbk2);
 713 uint8_t schDlGetAvlHqProcess(SchCellCb *cellCb, SchUeCb *ueCb, SchDlHqProcCb **hqP);
 714 void schDlReleaseHqProcess(SchDlHqProcCb *hqP);
 715 void schDlHqEntDelete(SchUeCb *ueCb);
 716
 717 /*UL HARQ Functions*/
 718 void schUlHqEntInit(SchCellCb *cellCb, SchUeCb *ueCb);
 719 uint8_t schMsg3RetxSchedulingForUe(SchRaCb *raCb);
 720 void schUlHqProcessNack(SchUlHqProcCb *hqP);
 721 void schUlHqProcessAck(SchUlHqProcCb *hqP);
 722 uint8_t schUlGetAvlHqProcess(SchCellCb *cellCb, SchUeCb *ueCb, SchUlHqProcCb **hqP);
 723 void schUlReleaseHqProcess(SchUlHqProcCb *hqP, Bool togNdi);
 724 void schUlHqEntDelete(SchUeCb *ueCb);
 725
 726 /* UE Manager HARQ Fun*/
 727 void schUpdateHarqFdbk(SchUeCb *ueCb, uint8_t numHarq, uint8_t *harqPayload,SlotTimingInfo *slotInd);
 728
 729 /* Round Robbin Scheduler funtions*/
 730 uint8_t schFillUlDciForMsg3Retx(SchRaCb *raCb, SchPuschInfo *puschInfo, DciInfo *dciInfo);
 731 bool schGetMsg3K2(SchCellCb *cell, SchUlHqProcCb* msg3HqProc, uint16_t dlTime, SlotTimingInfo *msg3Time, bool isRetx);
 732 void schMsg4Complete(SchUeCb *ueCb);
 733 /**********************************************************************
 734   End of file
 735  **********************************************************************/