1 /*******************************************************************************
2 ################################################################################
3 # Copyright (c) [2017-2019] [Radisys] #
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 #
9 # http://www.apache.org/licenses/LICENSE-2.0 #
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 *******************************************************************************/
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 */
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
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
56 #define MAC_HDR_SIZE 3 /* 3 bytes of MAC Header */
57 #define UL_GRANT_SIZE 224
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)
62 typedef struct schCellCb SchCellCb;
63 typedef struct schUeCb SchUeCb;
76 SCH_UE_STATE_INACTIVE,
82 SCH_LC_STATE_INACTIVE,
101 * Structure holding LTE MAC's General Configuration information.
103 typedef struct schGenCb
105 uint8_t tmrRes; /*!< Timer resolution */
106 uint8_t startCellId; /*!< Starting Cell Id */
108 bool forceCntrlSrbBoOnPCel; /*!< value 1 means force scheduling
109 of RLC control BO and SRB BO on
110 PCell. val 0 means don't force*/
111 bool isSCellActDeactAlgoEnable; /*!< TRUE will enable activation/deactivation algo at Schd */
115 typedef struct freePrbBlock
124 * PRB allocations for a symbol within a slot
126 typedef struct schPrbAlloc
128 CmLListCp freePrbBlockList; /*!< List of continuous blocks for available PRB */
129 uint64_t prbBitMap[ MAX_SYMB_PER_SLOT][PRB_BITMAP_MAX_IDX]; /*!< BitMap to store the allocated PRBs */
134 * scheduler allocationsfor DL per cell.
136 typedef struct schDlSlotInfo
138 SchPrbAlloc prbAlloc; /*!< PRB allocated/available in this slot */
139 bool ssbPres; /*!< Flag to determine if SSB is present in this slot */
140 uint8_t ssbIdxSupported; /*!< Max SSB index */
141 SsbInfo ssbInfo[MAX_SSB_IDX]; /*!< SSB info */
142 bool sib1Pres; /*!< Flag to determine if SIB1 is present in this slot */
143 uint8_t pdcchUe; /*!< UE for which PDCCH is scheduled in this slot */
144 uint8_t pdschUe; /*!< UE for which PDSCH is scheduled in this slot */
145 RarAlloc *rarAlloc[MAX_NUM_UE]; /*!< RAR allocation per UE*/
147 DlMsgAlloc *dlMsgAlloc[MAX_NUM_UE]; /*!< Dl msg allocation per UE*/
150 typedef struct schRaCb
154 uint16_t dlMsgPduLen;
159 * scheduler allocationsfor UL per cell.
161 typedef struct schUlSlotInfo
163 SchPrbAlloc prbAlloc; /*!< PRB allocated/available per symbol */
164 uint8_t puschCurrentPrb; /*!< Current PRB for PUSCH allocation */
165 bool puschPres; /*!< PUSCH presence field */
166 SchPuschInfo *schPuschInfo; /*!< PUSCH info */
167 bool pucchPres; /*!< PUCCH presence field */
168 SchPucchInfo schPucchInfo; /*!< PUCCH info */
169 uint8_t pucchUe; /*!< Store UE id for which PUCCH is scheduled */
170 uint8_t puschUe; /*!< Store UE id for which PUSCH is scheduled */
175 * BSR info per slot per UE.
177 typedef struct bsrInfo
179 uint8_t priority; /* CG priority */
180 uint32_t dataVol; /* Data volume requested in bytes */
183 typedef struct schLcCtxt
185 uint8_t lcId; // logical Channel ID
186 uint8_t lcp; // logical Channel Prioritization
189 uint16_t pduSessionId; /*Pdu Session Id*/
190 Snssai *snssai; /*S-NSSAI assoc with LCID*/
191 bool isDedicated; /*Flag containing Dedicated S-NSSAI or not*/
194 typedef struct schDlCb
196 SchDlLcCtxt dlLcCtxt[MAX_NUM_LC];
199 typedef struct schUlLcCtxt
206 uint8_t pbr; // prioritisedBitRate
207 uint8_t bsd; // bucketSizeDuration
208 uint16_t pduSessionId; /*Pdu Session Id*/
209 Snssai *snssai; /*S-NSSAI assoc with LCID*/
210 bool isDedicated; /*Flag containing Dedicated S-NSSAI or not*/
213 typedef struct schUlCb
215 SchUlLcCtxt ulLcCtxt[MAX_NUM_LC];
218 typedef struct schUeCfgCb
222 bool macCellGrpCfgPres;
223 SchMacCellGrpCfg macCellGrpCfg;
224 bool phyCellGrpCfgPres;
225 SchPhyCellGrpCfg phyCellGrpCfg;
227 SchSpCellCfg spCellCfg;
229 SchModulationInfo dlModInfo;
230 SchModulationInfo ulModInfo;
233 /*Following structures to keep record and estimations of PRB allocated for each
234 * LC taking into consideration the RRM policies*/
235 typedef struct lcInfo
237 uint8_t lcId; /*LCID for which BO are getting recorded*/
238 uint32_t reqBO; /*Size of the BO requested/to be allocated for this LC*/
239 uint32_t allocBO; /*TBS/BO Size which is actually allocated*/
240 uint8_t allocPRB; /*PRB count which is allocated based on RRM policy/FreePRB*/
243 typedef struct dedicatedLCInfo
245 CmLListCp dedLcList; /*Linklist of LC assoc with RRMPolicyMemberList*/
246 uint16_t rsvdDedicatedPRB; /*Number of PRB reserved for this Dedicated S-NSSAI*/
249 typedef struct schLcPrbEstimate
251 /* TODO: For Multiple RRMPolicies, Make DedicatedLcInfo as array/Double Pointer
252 * and have separate DedLCInfo for each RRMPolcyMemberList*/
253 /* Dedicated LC List will be allocated, if any available*/
254 DedicatedLCInfo *dedLcInfo; /*Contain LCInfo per RRMPolicy*/
256 CmLListCp defLcList; /*Linklist of LC assoc with Default S-NSSAI(s)*/
258 /* SharedPRB number can be used by any LC.
259 * Need to calculate in every Slot based on PRB availability*/
260 uint16_t sharedNumPrb;
267 typedef struct schUeCb
276 BsrInfo bsrInfo[MAX_NUM_LOGICAL_CHANNEL_GROUPS];
279 SchLcPrbEstimate dlLcPrbEst; /*DL PRB Alloc Estimate among different LC*/
280 SchLcPrbEstimate ulLcPrbEst; /*UL PRB Alloc Estimate among different LC*/
287 typedef struct schRaReq
290 RachIndInfo *rachInd;
291 SlotTimingInfo winStartTime;
292 SlotTimingInfo winEndTime;
297 * Cell Control block per cell.
299 typedef struct schCellCb
301 uint16_t cellId; /*!< Cell ID */
302 Inst instIdx; /*!< Index of the scheduler instance */
303 Inst macInst; /*!< Index of the MAC instance */
304 uint8_t numSlots; /*!< Number of slots in current frame */
305 SlotTimingInfo slotInfo; /*!< SFN, Slot info being processed*/
306 SchDlSlotInfo **schDlSlotInfo; /*!< SCH resource allocations in DL */
307 SchUlSlotInfo **schUlSlotInfo; /*!< SCH resource allocations in UL */
308 SchCellCfg cellCfg; /*!< Cell ocnfiguration */
309 bool firstSsbTransmitted;
310 bool firstSib1Transmitted;
311 uint8_t ssbStartSymbArr[SCH_MAX_SSB_BEAM]; /*!<start symbol per SSB beam */
312 SchRaReq *raReq[MAX_NUM_UE]; /*!< Pending RA request */
313 SchRaCb raCb[MAX_NUM_UE]; /*!< RA Cb */
314 uint16_t numActvUe; /*!<Number of active UEs */
315 uint32_t actvUeBitMap; /*!<Bit map to find active UEs */
316 uint32_t boIndBitMap; /*!<Bit map to indicate UEs that have recevied BO */
317 SchUeCb ueCb[MAX_NUM_UE]; /*!<Pointer to UE contexts of this cell */
318 CmLListCp ueToBeScheduled; /*!<Linked list to store UEs pending to be scheduled, */
320 uint8_t numSlotsInPeriodicity; /*!< number of slots in configured periodicity and SCS */
321 uint32_t slotFrmtBitMap; /*!< 2 bits must be read together to determine D/U/S slots. 00-D, 01-U, 10-S */
322 uint32_t symbFrmtBitMap; /*!< 2 bits must be read together to determine D/U/S symbols. 00-D, 01-U, 10-S */
328 * Control block for sch
332 TskInit schInit; /*!< Task Init info */
333 SchGenCb genCfg; /*!< General Config info */
334 CmTqCp tmrTqCp; /*!< Timer Task Queue Cntrl Point */
335 CmTqType tmrTq[SCH_TQ_SIZE]; /*!< Timer Task Queue */
336 SchCellCb *cells[MAX_NUM_CELL]; /* Array to store cellCb ptr */
339 /* Declaration for scheduler control blocks */
340 SchCb schCb[SCH_MAX_INST];
342 /* function declarations */
343 short int schActvTmr(Ent ent,Inst inst);
345 /* Configuration related function declarations */
346 void schInitUlSlot(SchUlSlotInfo *schUlSlotInfo);
347 void schInitDlSlot(SchDlSlotInfo *schDlSlotInfo);
348 void BuildK0K1Table(SchCellCb *cell, SchK0K1TimingInfoTbl *k0K1InfoTbl, bool pdschCfgCmnPres, \
349 SchPdschCfgCmn pdschCmnCfg,SchPdschConfig pdschDedCfg, uint8_t ulAckListCount, uint8_t *UlAckTbl);
350 void BuildK2InfoTable(SchCellCb *cell, SchPuschTimeDomRsrcAlloc timeDomRsrcAllocList[], \
351 uint16_t puschSymTblSize, SchK2TimingInfoTbl *msg3K2InfoTbl, SchK2TimingInfoTbl *k2InfoTbl);
352 uint8_t SchSendCfgCfm(Pst *pst, RgMngmt *cfm);
353 SchUeCb* schGetUeCb(SchCellCb *cellCb, uint16_t crnti);
354 uint8_t addUeToBeScheduled(SchCellCb *cell, uint8_t ueId);
356 /* Incoming message handler function declarations */
357 uint8_t schProcessSlotInd(SlotTimingInfo *slotInd, Inst inst);
358 uint8_t schProcessRachInd(RachIndInfo *rachInd, Inst schInst);
360 /* DL scheduling related function declarations */
361 PduTxOccsaion schCheckSsbOcc(SchCellCb *cell, SlotTimingInfo slotTime);
362 PduTxOccsaion schCheckSib1Occ(SchCellCb *cell, SlotTimingInfo slotTime);
363 uint8_t schBroadcastSsbAlloc(SchCellCb *cell, SlotTimingInfo slotTime, DlBrdcstAlloc *dlBrdcstAlloc);
364 uint8_t schBroadcastSib1Alloc(SchCellCb *cell, SlotTimingInfo slotTime, DlBrdcstAlloc *dlBrdcstAlloc);
365 bool schProcessRaReq(SchCellCb *cellCb, SlotTimingInfo currTime, uint8_t ueId);
366 bool schProcessMsg4Req(SchCellCb *cell, SlotTimingInfo currTime, uint8_t ueId);
367 uint8_t schFillRar(SchCellCb *cell, SlotTimingInfo rarTime, uint16_t ueIdx, RarAlloc *rarAlloc, uint8_t k0Index);
368 uint8_t schDlRsrcAllocDlMsg(SchCellCb *cell, SlotTimingInfo slotTime, uint16_t crnti,
369 uint32_t tbSize, DlMsgAlloc *dlMsgAlloc, uint16_t startPRB, uint8_t pdschStartSymbol, uint8_t pdschNumSymbols);
370 uint8_t schDlRsrcAllocMsg4(SchCellCb *cell, SlotTimingInfo msg4Time, uint8_t ueId, DlMsgAlloc *msg4Alloc,\
371 uint8_t pdschStartSymbol, uint8_t pdschNumSymbols);
372 uint16_t schAccumalateLcBoSize(SchCellCb *cell, uint16_t ueIdx);
373 uint8_t allocatePrbDl(SchCellCb *cell, SlotTimingInfo slotTime, uint8_t startSymbol, uint8_t symbolLength, \
374 uint16_t *startPrb, uint16_t numPrb);
375 uint16_t searchLargestFreeBlockDL(SchCellCb *cell, SlotTimingInfo slotTime,uint16_t *startPrb);
376 void updateGrantSizeForBoRpt(CmLListCp *lcLL, DlMsgAlloc *dlMsgAlloc, uint32_t *accumalatedBOSize);
377 void fillDlMsgInfo(DlMsgInfo *dlMsgInfo, uint8_t crnti);
378 bool findValidK0K1Value(SchCellCb *cell, SlotTimingInfo currTime, uint8_t ueId, bool dedMsg, uint8_t *pdschStartSymbol,\
379 uint8_t *pdschSymblLen, SlotTimingInfo *pdcchTime, SlotTimingInfo *pdschTime, SlotTimingInfo *pucchTime);
381 /* UL scheduling related function declarations */
382 uint8_t schUlResAlloc(SchCellCb *cell, Inst schInst);
383 bool schCheckPrachOcc(SchCellCb *cell, SlotTimingInfo prachOccasionTimingInfo);
384 uint8_t schCalcPrachNumRb(SchCellCb *cell);
385 void schPrachResAlloc(SchCellCb *cell, UlSchedInfo *ulSchedInfo, SlotTimingInfo prachOccasionTimingInfo);
386 uint16_t schAllocPucchResource(SchCellCb *cell, SlotTimingInfo pucchTime, uint16_t crnti);
387 uint8_t schFillUlDci(SchUeCb *ueCb, SchPuschInfo *puschInfo, DciInfo *dciInfo);
388 uint8_t schFillPuschAlloc(SchUeCb *ueCb, SlotTimingInfo puschTime, uint32_t dataVol, uint8_t k2, uint8_t startSymb, uint8_t symbLen);
389 uint8_t allocatePrbUl(SchCellCb *cell, SlotTimingInfo slotTime, uint8_t startSymbol, uint8_t symbolLength, \
390 uint16_t *startPrb, uint16_t numPrb);
391 bool schProcessSrOrBsrReq(SchCellCb *cell, SlotTimingInfo currTime, uint8_t ueId);
393 /*Generic Functions*/
394 LcInfo* handleLcLList(CmLListCp *lcLL, uint8_t lcId, ActionTypeLcLL action);
395 void prbAllocUsingRRMPolicy(CmLListCp *lcLL, bool dedicatedPRB, uint16_t mcsIdx,uint8_t numSymbols,\
396 uint16_t *sharedPRB, uint16_t *reservedPRB, bool *isTxPayloadLenAdded);
398 /**********************************************************************
400 **********************************************************************/