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