[Epic-ID: ODUHIGH-405][Task-ID: ODUHIGH-423]Filled ReconfigurationWithSync IE,
[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_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 typedef struct schCellCb SchCellCb;
63 typedef struct schUeCb SchUeCb;
64
65 typedef enum
66 {
67    SCH_NUMEROLOGY_0,
68    SCH_NUMEROLOGY_1,
69    SCH_NUMEROLOGY_2,
70    SCH_NUMEROLOGY_3,
71    SCH_NUMEROLOGY_4
72 }SchNumerology;
73
74 typedef enum
75 {
76    SCH_UE_STATE_INACTIVE,
77    SCH_UE_STATE_ACTIVE,
78    SCH_UE_HANDIN_IN_PROGRESS
79 }SchUeState;
80
81 typedef enum
82 {
83    SCH_LC_STATE_INACTIVE,
84    SCH_LC_STATE_ACTIVE
85 }SchLcState;
86
87 typedef enum
88 {
89    WINDOW_YET_TO_START,
90    WITHIN_WINDOW,
91    WINDOW_EXPIRED
92 }RaRspWindowStatus;
93
94 /**
95  * @brief
96  * Structure holding LTE MAC's General Configuration information.
97  */
98 typedef struct schGenCb
99 {
100    uint8_t         tmrRes;           /*!< Timer resolution */
101    uint8_t         startCellId;      /*!< Starting Cell Id */
102 #ifdef LTE_ADV
103    bool            forceCntrlSrbBoOnPCel; /*!< value 1 means force scheduling
104                                             of RLC control BO and SRB BO on
105                                             PCell. val 0 means don't force*/
106    bool            isSCellActDeactAlgoEnable; /*!< TRUE will enable activation/deactivation algo at Schd */
107 #endif
108 }SchGenCb;
109
110 typedef struct freePrbBlock
111 {
112    uint16_t numFreePrb;
113    uint16_t startPrb;
114    uint16_t endPrb;
115 }FreePrbBlock;
116
117 /**
118  * @brief
119  * PRB allocations for a symbol within a slot
120  */
121 typedef struct schPrbAlloc
122 {
123    CmLListCp freePrbBlockList;           /*!< List of continuous blocks for available PRB */
124    uint64_t  prbBitMap[ MAX_SYMB_PER_SLOT][PRB_BITMAP_MAX_IDX];  /*!< BitMap to store the allocated PRBs */
125 }SchPrbAlloc;
126
127 /**
128  * @brief
129  * scheduler allocationsfor DL per cell.
130  */
131 typedef struct schDlSlotInfo
132 {
133    SchPrbAlloc  prbAlloc;                 /*!< PRB allocated/available in this slot */
134    bool         ssbPres;                  /*!< Flag to determine if SSB is present in this slot */
135    uint8_t      ssbIdxSupported;          /*!< Max SSB index */
136    SsbInfo      ssbInfo[MAX_SSB_IDX];     /*!< SSB info */
137    bool         sib1Pres;                 /*!< Flag to determine if SIB1 is present in this slot */
138    uint8_t      pdcchUe;                  /*!< UE for which PDCCH is scheduled in this slot */
139    uint8_t      pdschUe;                  /*!< UE for which PDSCH is scheduled in this slot */
140    RarAlloc     *rarAlloc[MAX_NUM_UE];    /*!< RAR allocation per UE*/
141    DciInfo      *ulGrant;
142    DlMsgAlloc   *dlMsgAlloc[MAX_NUM_UE];  /*!< Dl msg allocation per UE*/
143 }SchDlSlotInfo;
144
145 typedef struct schRaCb
146 {
147    bool      msg4recvd;
148    uint16_t  tcrnti;
149    uint16_t  dlMsgPduLen;
150 }SchRaCb;
151
152 /**
153  * @brief
154  * scheduler allocationsfor UL per cell.
155  */
156 typedef struct schUlSlotInfo
157 {
158    SchPrbAlloc  prbAlloc;         /*!< PRB allocated/available per symbol */
159    uint8_t      puschCurrentPrb;  /*!< Current PRB for PUSCH allocation */
160    bool         puschPres;        /*!< PUSCH presence field */
161    SchPuschInfo *schPuschInfo;    /*!< PUSCH info */
162    bool         pucchPres;        /*!< PUCCH presence field */
163    SchPucchInfo schPucchInfo;     /*!< PUCCH info */
164    uint8_t      pucchUe;          /*!< Store UE id for which PUCCH is scheduled */
165    uint8_t      puschUe;          /*!< Store UE id for which PUSCH is scheduled */
166 }SchUlSlotInfo;
167
168 /**
169 @brief
170 * BSR info per slot per UE.
171 */
172 typedef struct bsrInfo
173 {
174    uint8_t    priority;  /* CG priority */
175    uint32_t   dataVol;   /* Data volume requested in bytes */
176 }BsrInfo;
177
178 typedef struct schLcCtxt
179 {
180    uint8_t lcId;     // logical Channel ID
181    uint8_t lcp;      // logical Channel Prioritization
182    SchLcState lcState;
183    uint32_t bo;
184    uint16_t   pduSessionId; /*Pdu Session Id*/
185    Snssai  *snssai;      /*S-NSSAI assoc with LCID*/
186    bool isDedicated;     /*Flag containing Dedicated S-NSSAI or not*/
187 }SchDlLcCtxt;
188
189 typedef struct schDlCb
190 {
191    SchDlLcCtxt   dlLcCtxt[MAX_NUM_LC];
192 }SchDlCb;
193
194 typedef struct schUlLcCtxt
195 {
196    SchLcState  lcState;
197    uint8_t lcId;       
198    uint8_t priority;
199    uint8_t lcGroup;
200    uint8_t schReqId;
201    uint8_t pbr;        // prioritisedBitRate
202    uint8_t bsd;        // bucketSizeDuration
203    uint16_t   pduSessionId; /*Pdu Session Id*/
204    Snssai  *snssai;      /*S-NSSAI assoc with LCID*/
205    bool isDedicated;     /*Flag containing Dedicated S-NSSAI or not*/
206 }SchUlLcCtxt;
207
208 typedef struct schUlCb
209 {
210    SchUlLcCtxt ulLcCtxt[MAX_NUM_LC];
211 }SchUlCb;
212
213 typedef struct schUeCfgCb
214 {
215    uint16_t        cellId;
216    uint8_t         ueId;
217    uint16_t        crnti;
218    bool macCellGrpCfgPres;
219    SchMacCellGrpCfg   macCellGrpCfg;
220    bool phyCellGrpCfgPres;
221    SchPhyCellGrpCfg   phyCellGrpCfg;
222    bool spCellCfgPres;
223    SchSpCellCfg       spCellCfg;
224    SchAmbrCfg         *ambrCfg;
225    SchModulationInfo  dlModInfo;
226    SchModulationInfo  ulModInfo;
227    SchDataTransmission dataTransmissionAction;
228 }SchUeCfgCb;
229
230 /*Following structures to keep record and estimations of PRB allocated for each
231  * LC taking into consideration the RRM policies*/
232 typedef struct lcInfo
233 {
234    uint8_t  lcId;     /*LCID for which BO are getting recorded*/
235    uint32_t reqBO;    /*Size of the BO requested/to be allocated for this LC*/
236    uint32_t allocBO;  /*TBS/BO Size which is actually allocated*/
237    uint8_t  allocPRB; /*PRB count which is allocated based on RRM policy/FreePRB*/
238 }LcInfo;
239
240 typedef struct dedicatedLCInfo
241 {
242    CmLListCp dedLcList;             /*Linklist of LC assoc with RRMPolicyMemberList*/
243    uint16_t      rsvdDedicatedPRB; /*Number of PRB reserved for this Dedicated S-NSSAI*/
244 }DedicatedLCInfo;
245
246 typedef struct schLcPrbEstimate
247 {
248    /* TODO: For Multiple RRMPolicies, Make DedicatedLcInfo as array/Double Pointer 
249     * and have separate DedLCInfo for each RRMPolcyMemberList*/
250    /* Dedicated LC List will be allocated, if any available*/
251    DedicatedLCInfo *dedLcInfo;  /*Contain LCInfo per RRMPolicy*/
252
253    CmLListCp defLcList; /*Linklist of LC assoc with Default S-NSSAI(s)*/
254
255    /* SharedPRB number can be used by any LC.
256     * Need to calculate in every Slot based on PRB availability*/
257    uint16_t sharedNumPrb;  
258 }SchLcPrbEstimate;
259
260 /**
261  * @brief
262  * UE control block
263  */
264 typedef struct schUeCb
265 {
266    uint16_t   ueId;
267    uint16_t   crnti;
268    SchUeCfgCb ueCfg;
269    SchUeState state;
270    SchCellCb  *cellCb;
271    SchCfraResource cfraResource;
272    bool       srRcvd;
273    bool       bsrRcvd;
274    BsrInfo    bsrInfo[MAX_NUM_LOGICAL_CHANNEL_GROUPS];
275    SchUlCb    ulInfo;
276    SchDlCb    dlInfo;
277    SchLcPrbEstimate dlLcPrbEst; /*DL PRB Alloc Estimate among different LC*/
278    SchLcPrbEstimate ulLcPrbEst; /*UL PRB Alloc Estimate among different LC*/
279 }SchUeCb;
280
281 /**
282  * @brief
283  * RA Request Info
284  */
285 typedef struct schRaReq
286 {
287    uint32_t        raRnti;
288    RachIndInfo     *rachInd;
289    SlotTimingInfo  winStartTime;
290    SlotTimingInfo  winEndTime;
291 }SchRaReq;
292
293 typedef struct schPageInfo
294 {
295   uint8_t        pf;       /*Value of Paging Frame received from DUAPP*/
296   uint8_t        i_s;      /*Value of Paging Occ Index received from DUAPP*/
297   SlotTimingInfo TxTime;   /*Start Paging window*/
298   uint8_t        crntSsbIdx; /*Counts the slot till totalSSB is receached*/
299   uint8_t        mcs;
300   uint8_t        nPRB;
301   uint16_t       msgLen;
302   uint8_t        *pagePdu;   
303 }SchPageInfo;
304
305 typedef struct schPagingOcc
306 {
307   uint8_t frameOffset;
308   uint8_t pagingOccSlot;
309 }SchPagingOcc;
310
311 typedef struct schPageCb
312 {
313    CmLListCp    pageReqInfoRecord[MAX_SFN];   /*List of Page Records received which are stored per sfn*/
314    SchPagingOcc pagMonOcc[MAX_PO_PER_PF]; /*Paging Occasion Slot/FrameOffset are stored*/ 
315    SchPageInfo  currPageInfo;   /*Page Req which is being currently processed */
316 }SchPageCb;
317
318 /**
319  * @brief
320  * Cell Control block per cell.
321  */
322 typedef struct schCellCb
323 {
324    uint16_t      cellId;                            /*!< Cell ID */
325    Inst          instIdx;                           /*!< Index of the scheduler instance */
326    Inst          macInst;                           /*!< Index of the MAC instance */
327    uint8_t       numSlots;                          /*!< Number of slots in current frame */
328    SlotTimingInfo   slotInfo;                          /*!< SFN, Slot info being processed*/
329    SchDlSlotInfo **schDlSlotInfo;                   /*!< SCH resource allocations in DL */
330    SchUlSlotInfo **schUlSlotInfo;                   /*!< SCH resource allocations in UL */
331    SchCellCfg    cellCfg;                           /*!< Cell ocnfiguration */
332    bool          firstSsbTransmitted;
333    bool          firstSib1Transmitted;
334    uint8_t       ssbStartSymbArr[SCH_MAX_SSB_BEAM]; /*!< start symbol per SSB beam */
335    uint64_t      dedPreambleBitMap;                 /*!< Bit map to find used/free preambles index */
336    SchRaReq      *raReq[MAX_NUM_UE];                /*!< Pending RA request */
337    SchRaCb       raCb[MAX_NUM_UE];                  /*!< RA Cb */
338    uint16_t      numActvUe;                         /*!< Number of active UEs */
339    uint32_t      actvUeBitMap;                      /*!< Bit map to find active UEs */
340    uint32_t      boIndBitMap;                       /*!< Bit map to indicate UEs that have recevied BO */
341    SchUeCb       ueCb[MAX_NUM_UE];                  /*!< Pointer to UE contexts of this cell */
342    CmLListCp     ueToBeScheduled;                   /*!< Linked list to store UEs pending to be scheduled, */
343    SchPageCb     pageCb;                            /*!< Page Record at Schedular*/
344 #ifdef NR_TDD
345    uint8_t       numSlotsInPeriodicity;             /*!< number of slots in configured periodicity and SCS */
346    uint32_t      slotFrmtBitMap;                    /*!< 2 bits must be read together to determine D/U/S slots. 00-D, 01-U, 10-S */
347    uint32_t      symbFrmtBitMap;                    /*!< 2 bits must be read together to determine D/U/S symbols. 00-D, 01-U, 10-S */
348 #endif
349 }SchCellCb;
350
351
352 typedef struct schSliceCfg
353 {
354    uint8_t        numOfSliceConfigured;
355    SchRrmPolicyOfSlice **listOfConfirguration;
356 }SchSliceCfg;
357
358 /**
359  * @brief
360  * Control block for sch
361  */
362 typedef struct schCb
363 {
364    TskInit       schInit;               /*!< Task Init info */
365    SchGenCb      genCfg;                /*!< General Config info */
366    CmTqCp        tmrTqCp;               /*!< Timer Task Queue Cntrl Point */
367    CmTqType      tmrTq[SCH_TQ_SIZE];    /*!< Timer Task Queue */
368    SchCellCb     *cells[MAX_NUM_CELL];  /* Array to store cellCb ptr */ 
369    SchSliceCfg   sliceCfg;
370 }SchCb;
371
372 /* Declaration for scheduler control blocks */
373 SchCb schCb[SCH_MAX_INST];
374
375 /* function declarations */
376 short int schActvTmr(Ent ent,Inst inst);
377
378 /* Configuration related function declarations */
379 void schInitUlSlot(SchUlSlotInfo *schUlSlotInfo);
380 void schInitDlSlot(SchDlSlotInfo *schDlSlotInfo);
381 void BuildK0K1Table(SchCellCb *cell, SchK0K1TimingInfoTbl *k0K1InfoTbl, bool pdschCfgCmnPres, \
382    SchPdschCfgCmn pdschCmnCfg,SchPdschConfig pdschDedCfg, uint8_t ulAckListCount, uint8_t *UlAckTbl);
383 void BuildK2InfoTable(SchCellCb *cell, SchPuschTimeDomRsrcAlloc timeDomRsrcAllocList[], \
384    uint16_t puschSymTblSize, SchK2TimingInfoTbl *msg3K2InfoTbl, SchK2TimingInfoTbl *k2InfoTbl);
385 uint8_t SchSendCfgCfm(Pst *pst, RgMngmt *cfm);
386 SchUeCb* schGetUeCb(SchCellCb *cellCb, uint16_t crnti);
387 uint8_t addUeToBeScheduled(SchCellCb *cell, uint8_t ueId);
388
389 /* Incoming message handler function declarations */
390 uint8_t schProcessSlotInd(SlotTimingInfo *slotInd, Inst inst);
391 uint8_t schProcessRachInd(RachIndInfo *rachInd, Inst schInst);
392
393 /* DL scheduling related function declarations */
394 PduTxOccsaion schCheckSsbOcc(SchCellCb *cell, SlotTimingInfo slotTime);
395 PduTxOccsaion schCheckSib1Occ(SchCellCb *cell, SlotTimingInfo slotTime);
396 uint8_t schBroadcastSsbAlloc(SchCellCb *cell, SlotTimingInfo slotTime, DlBrdcstAlloc *dlBrdcstAlloc);
397 uint8_t schBroadcastSib1Alloc(SchCellCb *cell, SlotTimingInfo slotTime, DlBrdcstAlloc *dlBrdcstAlloc);
398 bool schProcessRaReq(Inst schInst, SchCellCb *cellCb, SlotTimingInfo currTime, uint8_t ueId);
399 bool schProcessMsg4Req(SchCellCb *cell, SlotTimingInfo currTime, uint8_t ueId);
400 uint8_t schFillRar(SchCellCb *cell, SlotTimingInfo rarTime, uint16_t ueId, RarAlloc *rarAlloc, uint8_t k0Index);
401 uint8_t schDlRsrcAllocDlMsg(SchCellCb *cell, SlotTimingInfo slotTime, uint16_t crnti,
402 uint32_t tbSize, DlMsgAlloc *dlMsgAlloc, uint16_t startPRB, uint8_t pdschStartSymbol, uint8_t pdschNumSymbols);
403 uint8_t schDlRsrcAllocMsg4(SchCellCb *cell, SlotTimingInfo msg4Time, uint8_t ueId, DlMsgAlloc *msg4Alloc,\
404 uint8_t pdschStartSymbol, uint8_t pdschNumSymbols);
405 uint8_t allocatePrbDl(SchCellCb *cell, SlotTimingInfo slotTime, uint8_t startSymbol, uint8_t symbolLength, \
406    uint16_t *startPrb, uint16_t numPrb);
407 void fillDlMsgInfo(DlMsgInfo *dlMsgInfo, uint8_t crnti);
408 bool findValidK0K1Value(SchCellCb *cell, SlotTimingInfo currTime, uint8_t ueId, bool dedMsg, uint8_t *pdschStartSymbol,\
409 uint8_t *pdschSymblLen, SlotTimingInfo *pdcchTime,  SlotTimingInfo *pdschTime, SlotTimingInfo *pucchTime);
410
411 /* UL scheduling related function declarations */
412 uint8_t schUlResAlloc(SchCellCb *cell, Inst schInst);
413 bool schCheckPrachOcc(SchCellCb *cell, SlotTimingInfo prachOccasionTimingInfo);
414 uint8_t schCalcPrachNumRb(SchCellCb *cell);
415 void schPrachResAlloc(SchCellCb *cell, UlSchedInfo *ulSchedInfo, SlotTimingInfo prachOccasionTimingInfo);
416 uint16_t schAllocPucchResource(SchCellCb *cell, SlotTimingInfo pucchTime, uint16_t crnti);
417 uint8_t schFillUlDci(SchUeCb *ueCb, SchPuschInfo *puschInfo, DciInfo *dciInfo);
418 uint8_t schFillPuschAlloc(SchUeCb *ueCb, SlotTimingInfo puschTime, uint32_t tbsSize, \
419                            uint8_t startSymb, uint8_t symbLen, uint16_t startPrb);
420 uint8_t allocatePrbUl(SchCellCb *cell, SlotTimingInfo slotTime, uint8_t startSymbol, uint8_t symbolLength, \
421    uint16_t *startPrb, uint16_t numPrb);
422 bool schProcessSrOrBsrReq(SchCellCb *cell, SlotTimingInfo currTime, uint8_t ueId);
423 bool schCalculateUlTbs(SchUeCb *ueCb, SlotTimingInfo puschTime, uint8_t symbLen,\
424                              uint16_t *startPrb, uint32_t *totTBS);
425
426 /*Generic Functions*/
427 void updateGrantSizeForBoRpt(CmLListCp *lcLL, DlMsgAlloc *dlMsgAlloc, BsrInfo *bsrInfo, uint32_t *accumalatedBOSize);
428 uint16_t searchLargestFreeBlock(SchCellCb *cell, SlotTimingInfo slotTime,uint16_t *startPrb, Direction dir);
429 LcInfo* handleLcLList(CmLListCp *lcLL, uint8_t lcId, ActionTypeLL action);
430 void prbAllocUsingRRMPolicy(CmLListCp *lcLL, bool dedicatedPRB, uint16_t mcsIdx,uint8_t numSymbols,\
431                       uint16_t *sharedPRB, uint16_t *reservedPRB, bool *isTxPayloadLenAdded, bool *srRcvd);
432 void updateBsrAndLcList(CmLListCp *lcLL, BsrInfo *bsrInfo, uint8_t status);
433
434 /*Paging Functions*/
435 void schProcPagingCfg(SchCellCb *cell);
436 void schCfgPdcchMonOccOfPO(SchCellCb *cell);
437 void schIncrSlot(SlotTimingInfo *timingInfo, uint8_t incr, uint16_t numSlotsPerRF);
438
439 /**********************************************************************
440   End of file
441  **********************************************************************/