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