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