[Epic-ID: ODUHIGH-405][Task-ID: ODUHIGH-443] Contention Free RA by UE in handover
[o-du/l2.git] / src / 5gnrsch / sch_rach.c
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 /************************************************************************
20  
21      Name:     sch_rach.c
22   
23      Type:     C source file
24   
25      Desc:     C source code for rach handling functions
26   
27      File:     sch_rach.c
28   
29 **********************************************************************/
30
31 /** @file sch_rach.c
32 @brief This file implements the rach handling.
33 */
34 #include "common_def.h"
35 #include "tfu.h"
36 #include "lrg.h"
37 #include "tfu.x"
38 #include "lrg.x"
39 #include "du_log.h"
40 #include "du_app_mac_inf.h"
41 #include "mac_sch_interface.h"
42 #include "sch.h"
43 #include "sch_utils.h"
44
45 SchRachRsrcRspFunc SchRachRsrcRspOpts[] =
46 {
47    packSchRachRsrcRsp,      /* LC */
48    MacProcSchRachRsrcRsp,   /* TC */
49    packSchRachRsrcRsp       /* LWLC */
50 };
51
52 /**
53  * @brief Checks if PRACH can be scheduled in current slot
54  *
55  * @details
56  *
57  *     Function : schCheckPrachOcc
58  *
59  *     This function checks if PRACH can be scheduled in 
60  *     current slot
61  *
62  *  @param[in]  Cell Cb
63  *              Slot timing
64  *  @return  TRUE
65  *           FALSE
66  **/
67 bool schCheckPrachOcc(SchCellCb *cell, SlotTimingInfo prachOccasionTimingInfo)
68 {
69    uint8_t  prachCfgIdx = 0;
70    uint8_t  x = 0;
71    uint8_t  y = 0;
72    uint8_t  subFrame = 0;
73    uint16_t prachSubframe = 0;
74
75    prachCfgIdx      = cell->cellCfg.schRachCfg.prachCfgIdx;
76
77    /* derive the prachCfgIdx table paramters */
78    x                = prachCfgIdxTable[prachCfgIdx][1];
79    y                = prachCfgIdxTable[prachCfgIdx][2];
80    prachSubframe    = prachCfgIdxTable[prachCfgIdx][3];
81
82    if((prachOccasionTimingInfo.sfn%x) == y)
83    {
84       subFrame = prachOccasionTimingInfo.slot/pow(2, cell->cellCfg.numerology);
85
86       /* check for subFrame number */
87       if ((1 << subFrame) & prachSubframe)
88       {
89          /* prach ocassion present in this subframe */
90 #ifdef NR_TDD
91          if(UL_SLOT != schGetSlotSymbFrmt(prachOccasionTimingInfo.slot % cell->numSlotsInPeriodicity,\
92          cell->slotFrmtBitMap))
93          {
94             DU_LOG("\nERROR  --> SCH : PrachCfgIdx %d doesn't support UL slot", prachCfgIdx);
95             return FALSE;
96          }
97 #endif
98          return TRUE;
99       }
100    }
101    return FALSE;
102 }
103
104 /**
105  * @brief Calculate number of PRBs to be allocated for PRACH 
106  *
107  * @details
108  *
109  *     Function : schCalcPrachNumRb
110  *
111  *     Calculate number of PRBs to be allocated for PRACH
112  *
113  *  @param[in]  SchCellCb *cell, cell cb
114  *  @return  Number of PRBs
115  **/
116 uint8_t schCalcPrachNumRb(SchCellCb *cell)
117 {
118    uint8_t tableIdx = 0;
119    uint16_t puschScs = convertScsEnumValToScsVal(cell->cellCfg.schInitialUlBwp.bwp.scs);
120
121    for(tableIdx=0; tableIdx < MAX_RACH_NUM_RB_IDX; tableIdx++)
122    {
123       if((numRbForPrachTable[tableIdx][0] == cell->cellCfg.schRachCfg.rootSeqLen) &&
124             (numRbForPrachTable[tableIdx][1] == cell->cellCfg.schRachCfg.prachSubcSpacing) &&
125             (numRbForPrachTable[tableIdx][2] == puschScs))
126       {
127          return numRbForPrachTable[tableIdx][3];
128       }
129    }
130    return 0;
131 }
132
133 /**
134  * @brief resource allocation for PRACH
135  *
136  * @details
137  *
138  *     Function : schPrachResAlloc
139  *
140  *     This function handles PRACH allocation
141  *
142  *  @param[in]  SchCellCb *cell, cell cb
143  *  @param[in]  UlSchedInfo *ulSchedInfo, UL scheduling info
144  *  @return  void
145  **/
146 void schPrachResAlloc(SchCellCb *cell, UlSchedInfo *ulSchedInfo, SlotTimingInfo prachOccasionTimingInfo)
147 {
148    uint8_t  numPrachRb = 0;
149    uint8_t  numRa = 0;
150    uint8_t  prachCfgIdx = 0;
151    uint8_t  prachFormat = 0;
152    uint8_t  prachStartSymbol = 0;
153    uint8_t  prachDuration = 0;
154    uint8_t  prachOcas = 0;
155    uint8_t  dataType = 0;
156    uint16_t freqStart = 0;
157
158    if(cell == NULLP)
159    {
160       DU_LOG("\nERROR  --> SCH : schPrachResAlloc(): Received cellCb is null");
161       return;
162    }
163
164    /* If this slot is not a PRACH occassion, return */
165    if(!schCheckPrachOcc(cell, prachOccasionTimingInfo))
166       return;
167
168    prachCfgIdx      = cell->cellCfg.schRachCfg.prachCfgIdx;
169    prachFormat      = prachCfgIdxTable[prachCfgIdx][0];
170    prachStartSymbol = prachCfgIdxTable[prachCfgIdx][4];
171    prachOcas        = prachCfgIdxTable[prachCfgIdx][6];
172    prachDuration    = prachCfgIdxTable[prachCfgIdx][7];
173
174    /* numRa determined as 𝑛 belonging {0,1,.., M − 1},
175     * where M is given by msg1Fdm */
176    numRa = (cell->cellCfg.schRachCfg.msg1Fdm - 1);
177
178    /* freq domain resource determination for RACH*/
179    freqStart = cell->cellCfg.schRachCfg.msg1FreqStart;
180    numPrachRb = schCalcPrachNumRb(cell);
181    /* Allocate PRACH resources from the UL resource bitmap */
182    allocatePrbUl(cell, prachOccasionTimingInfo, prachStartSymbol, prachDuration, &freqStart, numPrachRb);
183
184    /* prach info */
185    dataType |= SCH_DATATYPE_PRACH;
186    ulSchedInfo->dataType = dataType;
187    ulSchedInfo->prachSchInfo.numPrachOcas   = prachOcas;
188    ulSchedInfo->prachSchInfo.prachFormat    = prachFormat;
189    ulSchedInfo->prachSchInfo.numRa          = numRa;
190    ulSchedInfo->prachSchInfo.prachStartSymb = prachStartSymbol;
191    DU_LOG("\nINFO  --> SCH : RACH occassion set for slot %d", prachOccasionTimingInfo.slot);
192 }
193
194 /**
195  * @brief Process RACH resource request for CFRA
196  *
197  * @details
198  *
199  *     Function : MacSchRachRsrcReq
200  *     
201  *     This function processes RACH resorce request 
202  *     from MAC for CFRA. It assigns a dedicated preamble
203  *     to the UE and sends the same in RACH resource
204  *     response
205  *     
206  *  @param[in]  Post structure
207  *  @param[in]  RACH resource request
208  *  @return     ROK
209  *              RFAILED
210  **/
211 uint8_t MacSchRachRsrcReq(Pst *pst, SchRachRsrcReq *schRachRsrcReq)
212 {
213    uint8_t      ssbIdx = 0, cfraSsbIdx = 0;
214    uint8_t      firstCFPreambleIndex = 0, lastCFPreambleIndex = 0;
215    uint16_t     cellIdx = 0;
216    uint64_t     mask = 0;
217    Pst          rspPst;
218    Inst         inst = pst->dstInst - SCH_INST_START;
219    SchCellCb    *cellCb = NULLP;
220    SchUeCb      *ueCb = NULLP;
221    SchRachRsrcRsp *rachRsrcRsp = NULLP;
222
223    DU_LOG("\nINFO  -->  SCH : Received RACH resource request for Cell ID [%d] CRNTI [%d]", \
224          schRachRsrcReq->cellId, schRachRsrcReq->crnti);
225
226  /* Fill RACH resource response to MAC */
227    SCH_ALLOC(rachRsrcRsp, sizeof(SchRachRsrcRsp));
228    if(!rachRsrcRsp)
229    {   
230       DU_LOG("\nERROR  -->  SCH : Memory allocation failed for RACH resource response");
231       return RFAILED;
232    }   
233    rachRsrcRsp->cellId = schRachRsrcReq->cellId;
234    rachRsrcRsp->crnti = schRachRsrcReq->crnti;
235    rachRsrcRsp->result = RSP_OK;
236
237    /* Fill SCH to MAC Pst structure */
238    memset(&rspPst, 0, sizeof(Pst));
239    FILL_PST_SCH_TO_MAC(rspPst, inst);
240    rspPst.event = EVENT_RACH_RESOURCE_RESPONSE_TO_MAC;
241
242    /* Fetch Cell CB */
243    for(cellIdx = 0; cellIdx < MAX_NUM_CELL; cellIdx++)
244    {
245       if((schCb[inst].cells[cellIdx]) && (schCb[inst].cells[cellIdx]->cellId == schRachRsrcReq->cellId))
246       {
247          cellCb = schCb[inst].cells[cellIdx];
248          break;
249       }
250    }
251    
252    if(cellCb)
253    {
254       /* Fetch UE CB */
255       ueCb = schGetUeCb(cellCb, schRachRsrcReq->crnti);
256       if(ueCb->crnti != schRachRsrcReq->crnti)
257       {
258          DU_LOG("\nERROR  -->  SCH : CRNTI [%d] not found" ,schRachRsrcReq->crnti);
259          rachRsrcRsp->result = RSP_NOK;
260       }
261    }
262    else
263    {
264       DU_LOG("\nERROR  -->  SCH : Cell ID [%d] not found" ,schRachRsrcReq->cellId);
265       rachRsrcRsp->result = RSP_NOK;
266    }
267
268    /* Allocate SSB resource if no failure has occurred until this step */
269    if(rachRsrcRsp->result == RSP_OK)
270    {
271       /* Find first free preamble index from the pool CF preambles 
272        * Preamble index from 0 to (numCbPreamblePerSsb-1) is used for CBRA 
273        * Preamble index from numCbPreamblePerSsb to totalNumOfRAPreamble
274        * is used for CFRA */
275       firstCFPreambleIndex = cellCb->cellCfg.schRachCfg.numCbPreamblePerSsb;
276       lastCFPreambleIndex = cellCb->cellCfg.schRachCfg.totalNumRaPreamble;
277
278       /* Allocate resource for each SSB index requested */
279       for(ssbIdx = 0; ssbIdx < schRachRsrcReq->numSsb; ssbIdx++)
280       {
281          /* Find the first CF Preamble index not dedicated to any UE currently */
282          while(firstCFPreambleIndex <= lastCFPreambleIndex)
283          {
284             mask = 1 << firstCFPreambleIndex;
285             if(cellCb->dedPreambleBitMap & mask)
286             {
287                firstCFPreambleIndex++;
288                continue;
289             }
290             else
291                break;
292          }
293
294          /* If firstCFPreambleIndex > lastCFPreambleIndex, it means all
295           * dedicated preambles are in use currently. In such a case, CBRA
296           * should be initiated. 
297           * If a dedicated preamble is found, use this for CFRA and mark it as
298           * IN-USE in the bitmap.
299           * Considering only CFRA scenario for now. */
300          if(firstCFPreambleIndex <= lastCFPreambleIndex)
301          {
302             ueCb->cfraResource.ssbResource[cfraSsbIdx].ssbIdx = schRachRsrcReq->ssbIdx[ssbIdx]; 
303             ueCb->cfraResource.ssbResource[cfraSsbIdx].raPreambleIdx = firstCFPreambleIndex;
304             SET_ONE_BIT(firstCFPreambleIndex, cellCb->dedPreambleBitMap);
305             cfraSsbIdx++;
306             firstCFPreambleIndex++;
307          }
308          else
309          {
310             DU_LOG("\nINFO : SCH : No dedicated preameble availble to assign to ssbIdx[%d]", schRachRsrcReq->ssbIdx[ssbIdx]);
311             /* Breaking out of for loop since no dedicated preambles are available
312              * for remaining ssbIdx too */
313             break;
314          }
315       } /* End of for */
316
317       ueCb->cfraResource.numSsb = cfraSsbIdx;
318
319       if(ueCb->cfraResource.numSsb == 0)
320       {
321          /* If numSsb is 0, it means no CFRA resource was alloacted for any of the
322           * SSB Idx, hence send a negative response */
323          rachRsrcRsp->result = RSP_NOK;
324       }
325       else
326       {   
327          /* Send ssb resource information to MAC in RACH resource response */
328          rachRsrcRsp->cfraResource.numSsb = ueCb->cfraResource.numSsb;
329          memcpy(rachRsrcRsp->cfraResource.ssbResource, ueCb->cfraResource.ssbResource, \
330             ueCb->cfraResource.numSsb * sizeof(SchCfraSsbResource));
331       }
332    } /* End of if */
333
334    /* Free RACH resource request memory allocated by MAC */
335    SCH_FREE(schRachRsrcReq, sizeof(SchRachRsrcReq));
336
337    /* Send RACH resource response to MAC */
338    return (SchRachRsrcRspOpts[rspPst.selector](&rspPst, rachRsrcRsp));
339 }
340
341 /**
342  * @brief calculate ra-rnti function. 
343  *
344  * @details
345  *
346  *     Function : calculateRaRnti
347  *     
348  *     This function calculates ra-rnti
349  *     
350  *  @param[in]  symbol index
351  *  @param[in]  slot index
352  *  @param[in]  frequency index
353  *  @return  ra-rnti
354  **/
355 uint16_t calculateRaRnti(uint8_t symbolIdx, uint8_t slotIdx, uint8_t freqIdx)
356 {
357    uint16_t raRnti = 0;
358    uint8_t  ulCarrierIdx = 0; /* Uplink carrier used for MSG1 transmission. 0:NUL carrier; 1:SUL carrier */
359    
360    /* Refer to spec 38.321, section 5.1.3 */
361    raRnti = (1 + symbolIdx + (14*slotIdx) + (14*80*freqIdx) + (14*80*8*ulCarrierIdx));
362    return raRnti;
363 }
364
365 /**
366  * @brief create raCb function. 
367  *
368  * @details
369  *
370  *     Function : createSchRaCb
371  *     
372  *     This function create raCb
373  *     
374  *  @param[in]  crnti
375  *  @param[in]  shed instance
376  *  @return  void
377  **/
378 void createSchRaCb(SchRaReq *raReq, Inst schInst)
379 {
380    uint8_t ueId = 0;
381
382    if(raReq->isCFRA)
383    {
384       /* If a UE in handover has triggered CFRA, its UE CB context is already present in SCH, 
385        * Hence, no need to create raCb */
386       if(raReq->ueCb && (raReq->ueCb->state == SCH_UE_HANDIN_IN_PROGRESS))
387       {
388          schCb[schInst].cells[schInst]->numActvUe++;
389          SET_ONE_BIT(raReq->ueCb->ueId, schCb[schInst].cells[schInst]->actvUeBitMap);
390          raReq->ueCb->state = SCH_UE_STATE_ACTIVE;
391       }
392    }
393    else
394    {
395       /* Create RA CB only for CB-RA to use for msg3 and msg4 processing */
396       GET_UE_ID(raReq->rachInd->crnti, ueId);
397       schCb[schInst].cells[schInst]->raCb[ueId -1].tcrnti = raReq->rachInd->crnti;
398       schCb[schInst].cells[schInst]->raCb[ueId -1].msg4recvd = FALSE;
399    }
400 }
401
402 /**
403  * @brief resource allocation for msg3 PUSCH
404  *
405  * @details
406  *
407  *     Function : schAllocMsg3Pusch 
408  *     
409  *     This function handles msg3 PUSCH allocation
410  *     
411  *  @param[in]  Inst schInst, SCH instance
412  *  @param[in]  slot, current slot
413  *  @param[out]  msg3StartRb
414  *  @param[out]  msg3NumRb
415  *  @return  void
416  **/
417 SchPuschInfo* schAllocMsg3Pusch(Inst schInst, uint16_t crnti, uint8_t k2Index, SlotTimingInfo msg3SlotTime)
418 {
419    SchCellCb      *cell          = NULLP;
420    SchUlSlotInfo  *schUlSlotInfo = NULLP;
421    uint8_t    mcs       = DEFAULT_MCS;
422    uint8_t    startSymb = 0;
423    uint8_t    symbLen   = 0; 
424    uint16_t   startRb   = 0;
425    uint16_t   numRb     = 0;
426    uint16_t   tbSize    = 0;
427
428    cell = schCb[schInst].cells[schInst];
429    if(cell == NULL)
430    {
431       DU_LOG("\n\nERROR  -->  SCH :  Failed to find cell in schAllocMsg3Pusch");
432       return NULLP;
433    }
434
435    /* Allocate time-domain and frequency-domain resource for MSG3 PUSCH */
436    startSymb = cell->cellCfg.schInitialUlBwp.puschCommon.timeDomRsrcAllocList[k2Index].startSymbol;
437    symbLen = cell->cellCfg.schInitialUlBwp.puschCommon.timeDomRsrcAllocList[k2Index].symbolLength;
438
439    startRb = MAX_NUM_RB;
440    tbSize = schCalcTbSize(8); /* 6 bytes msg3 and 2 bytes header */
441    numRb = schCalcNumPrb(tbSize, mcs, symbLen);
442    numRb++; /* allocating 1 extra RB for now */
443    allocatePrbUl(cell, msg3SlotTime, startSymb, symbLen, &startRb, numRb);
444
445    /* Fill PUSCH scheduling details in Slot structure */
446    schUlSlotInfo = cell->schUlSlotInfo[msg3SlotTime.slot];
447    SCH_ALLOC(schUlSlotInfo->schPuschInfo, sizeof(SchPuschInfo));
448    if(!schUlSlotInfo->schPuschInfo)
449    {
450       DU_LOG("\nERROR  -->  SCH :  Memory allocation failed in schAllocMsg3Pusch");
451       return NULLP;
452    }
453
454    tbSize = 0;  /* since nPrb has been incremented, recalculating tbSize */
455    tbSize = schCalcTbSizeFromNPrb(numRb, mcs, NUM_PDSCH_SYMBOL);
456    tbSize = tbSize / 8 ; /*bits to byte conversion*/
457
458    schUlSlotInfo->schPuschInfo->crnti             = crnti;
459    schUlSlotInfo->schPuschInfo->harqProcId        = SCH_HARQ_PROC_ID;
460    schUlSlotInfo->schPuschInfo->resAllocType      = SCH_ALLOC_TYPE_1;
461    schUlSlotInfo->schPuschInfo->fdAlloc.startPrb  = startRb;
462    schUlSlotInfo->schPuschInfo->fdAlloc.numPrb    = numRb;
463    schUlSlotInfo->schPuschInfo->tdAlloc.startSymb = startSymb;
464    schUlSlotInfo->schPuschInfo->tdAlloc.numSymb   = symbLen;
465    schUlSlotInfo->schPuschInfo->tbInfo.qamOrder   = QPSK_MODULATION;  /* QPSK modulation */
466    schUlSlotInfo->schPuschInfo->tbInfo.mcs           = mcs;
467    schUlSlotInfo->schPuschInfo->tbInfo.mcsTable   = SCH_MCS_TABLE_QAM_64;
468    schUlSlotInfo->schPuschInfo->tbInfo.ndi        = NEW_TRANSMISSION; /* new transmission */
469    schUlSlotInfo->schPuschInfo->tbInfo.rv               = 0;
470    schUlSlotInfo->schPuschInfo->tbInfo.tbSize     = tbSize;
471    schUlSlotInfo->schPuschInfo->dmrsMappingType   = DMRS_MAP_TYPE_A;  /* Setting Type-A */
472    schUlSlotInfo->schPuschInfo->nrOfDmrsSymbols   = NUM_DMRS_SYMBOLS;
473    schUlSlotInfo->schPuschInfo->dmrsAddPos        = DMRS_ADDITIONAL_POS;
474
475    return schUlSlotInfo->schPuschInfo;
476 }
477
478 /**
479  * @brief Check if a time frame is in RA Response window
480  *
481  * @details
482  *
483  *     Function : isInRaRspWindow
484  *
485  *     Check if a time frame is in RA Response window
486  *
487  *  @param[in]  RA request
488  *  @param[in]  Time frame to check
489  *  @param[in]  Total number of slot per radio frame
490  *  @return  true 
491  *  @return  false
492  **/
493 RaRspWindowStatus isInRaRspWindow(SchRaReq *raReq, SlotTimingInfo frameToCheck, uint16_t numSlotsPerSystemFrame)
494 {
495    uint32_t winStartTime, winEndTime, timeToCheck;
496    
497    winStartTime = (raReq->winStartTime.sfn * numSlotsPerSystemFrame) + raReq->winStartTime.slot;
498    winEndTime = (raReq->winEndTime.sfn * numSlotsPerSystemFrame) + raReq->winEndTime.slot;
499    timeToCheck = (frameToCheck.sfn * numSlotsPerSystemFrame) + frameToCheck.slot;
500
501    /* TODO : check how to handle the wrap around scenario of MAX_SFN */
502    if((timeToCheck >= winStartTime) && (timeToCheck <= winEndTime))
503       return WITHIN_WINDOW;
504    else if(timeToCheck < winStartTime)
505       return WINDOW_YET_TO_START;
506       
507    return WINDOW_EXPIRED;
508 }
509
510 /**
511  * @brief Processes any pending RA request
512  *
513  * @details
514  *
515  *     Function : schProcessRaReq
516  *
517  *     This function process pending RA request
518  *
519  *  @param[in]  Current timing of the cell
520  *  @return  ROK
521  **/
522 bool schProcessRaReq(Inst schInst, SchCellCb *cell, SlotTimingInfo currTime, uint8_t ueId)
523 {
524    bool      k1Found = false, k2Found = false;
525    uint8_t   k0TblIdx = 0, k1TblIdx = 0, k2TblIdx = 0;
526    uint8_t   k0Index = 0, k1Index = 0, k2Index = 0;
527    uint8_t   k0 = 0, k1 = 0, k2 = 0;
528    uint8_t   numK1 = 0;
529    uint8_t   puschMu = 0;
530    uint8_t   msg3Delta = 0, msg3MinSchTime = 0;
531 #ifdef NR_TDD
532    uint8_t   totalCfgSlot = 0;
533 #endif
534    uint16_t             dciSlot = 0, rarSlot = 0;
535    SlotTimingInfo       dciTime, rarTime, msg3Time, pucchTime;
536    RarAlloc             *dciSlotAlloc = NULLP;    /* Stores info for transmission of PDCCH for RAR */
537    RarAlloc             *rarSlotAlloc = NULLP;    /* Stores info for transmission of RAR PDSCH */
538    SchPuschInfo         *msg3PuschInfo = NULLP;   /* Stores MSG3 PUSCH scheduling information */
539    SchK0K1TimingInfoTbl *k0K1InfoTbl=NULLP;    
540    SchK2TimingInfoTbl   *msg3K2InfoTbl=NULLP;
541    RaRspWindowStatus    windowStatus=0;
542
543 #ifdef NR_TDD
544    totalCfgSlot = calculateSlotPatternLength(cell->cellCfg.ssbSchCfg.scsCommon, cell->cellCfg.tddCfg.tddPeriod);
545 #endif
546    k0K1InfoTbl    = &cell->cellCfg.schInitialDlBwp.k0K1InfoTbl;
547    if(cell->raReq[ueId-1]->isCFRA == false)
548    {
549       msg3K2InfoTbl  = &cell->cellCfg.schInitialUlBwp.msg3K2InfoTbl;
550       puschMu        = cell->cellCfg.numerology;
551       msg3Delta      = puschDeltaTable[puschMu];
552       msg3MinSchTime = minMsg3SchTime[cell->cellCfg.numerology];
553    }
554
555    /* Calculating time frame to send DCI for RAR */
556    ADD_DELTA_TO_TIME(currTime, dciTime, PHY_DELTA_DL + SCHED_DELTA);
557    dciSlot = dciTime.slot;
558 #ifdef NR_TDD
559    /* Consider this slot for sending DCI, only if it is a DL slot */
560    if(schGetSlotSymbFrmt(dciSlot, cell->slotFrmtBitMap) == DL_SLOT)
561 #endif
562    {
563       /* If PDCCH is already scheduled on this slot, cannot schedule PDSCH for another UE here. */
564       if(cell->schDlSlotInfo[dciSlot]->pdcchUe != 0)
565          return false;
566
567       /* Check if this slot is within RA response window */
568       windowStatus = isInRaRspWindow(cell->raReq[ueId-1], dciTime, cell->numSlots);
569       if(windowStatus == WITHIN_WINDOW)
570       {
571          /* For all k0 values, search for a suitable k2 value to schedule MSG3.
572           * RAR DCI, RAR PDSCH and MSG3 is scheduled only if one such k0-k2 combination
573           * is found. Else no scheduling happens. 
574           */
575          for(k0TblIdx = 0; k0TblIdx < k0K1InfoTbl->k0k1TimingInfo[dciSlot].numK0; k0TblIdx++)
576          {
577             k0Index = k0K1InfoTbl->k0k1TimingInfo[dciSlot].k0Indexes[k0TblIdx].k0Index;
578             k0 = cell->cellCfg.schInitialDlBwp.pdschCommon.timeDomRsrcAllocList[k0Index].k0;
579
580             /* Calculating time frame to send RAR PDSCH */
581             ADD_DELTA_TO_TIME(dciTime, rarTime, k0);
582             rarSlot = rarTime.slot;
583             
584             /* If PDSCH is already scheduled on this slot, cannot schedule PDSCH for another UE here. */
585             if(cell->schDlSlotInfo[rarSlot]->pdschUe != 0)
586                continue;
587
588             /* If Contention-FREE RA is in progress, allocate resources for
589              * PUCCH for next UL message */
590             if(cell->raReq[ueId-1]->isCFRA)
591             {
592                numK1 = k0K1InfoTbl->k0k1TimingInfo[dciTime.slot].k0Indexes[k0TblIdx].k1TimingInfo.numK1;
593                for(k1TblIdx = 0; k1TblIdx < numK1; k1TblIdx++)
594                {   
595                   k1Index = k0K1InfoTbl->k0k1TimingInfo[dciTime.slot].k0Indexes[k0TblIdx].k1TimingInfo.k1Indexes[k1TblIdx];
596                   if(cell->raReq[ueId-1]->ueCb->ueCfg.spCellCfg.servCellCfg.initUlBwp.pucchCfg.dlDataToUlAck)
597                   {
598                      k1 = cell->raReq[ueId-1]->ueCb->ueCfg.spCellCfg.servCellCfg.initUlBwp.pucchCfg.dlDataToUlAck->\
599                         dlDataToUlAckList[k1Index];
600                   }
601                   else
602                   {
603                      k1 = defaultUlAckTbl[k1Index];
604                   }
605
606                   ADD_DELTA_TO_TIME(rarTime, pucchTime, k1);
607 #ifdef NR_TDD
608                   if(schGetSlotSymbFrmt(pucchTime.slot, cell->slotFrmtBitMap) == DL_SLOT)
609                      continue;
610 #endif
611                   if(cell->schUlSlotInfo[pucchTime.slot]->pucchUe != 0)
612                      continue;
613                   k1Found = true;
614                   break;
615                }
616             }
617             else
618             {
619                /* Else if contention-based RA is in progress, allocate resources for MSG3 */
620                for(k2TblIdx = 0; k2TblIdx < msg3K2InfoTbl->k2TimingInfo[rarSlot].numK2; k2TblIdx++)
621                {
622                   k2Index = msg3K2InfoTbl->k2TimingInfo[rarSlot].k2Indexes[k2TblIdx];
623                   k2 = cell->cellCfg.schInitialUlBwp.puschCommon.timeDomRsrcAllocList[k2Index].k2;
624
625                   /* Delta is added to the slot allocation for msg3 based on 38.214 section 6.1.2.1 */
626                   k2 = k2 + msg3Delta;
627                   if(k2 >= msg3MinSchTime)
628                   {
629                      ADD_DELTA_TO_TIME(rarTime, msg3Time, k2);
630 #ifdef NR_TDD
631                      if(schGetSlotSymbFrmt(msg3Time.slot % totalCfgSlot, cell->slotFrmtBitMap) == DL_SLOT)
632                         continue;
633 #endif
634                      /* If PUSCH is already scheduled on this slot, another PUSCH
635                       * pdu cannot be scheduled here */
636                      if(cell->schUlSlotInfo[msg3Time.slot]->puschUe != 0)
637                         continue;
638
639                      k2Found = true;
640                      break;
641                   }
642                }
643             }
644             if(k1Found || k2Found)
645                break;
646          }
647       }
648       else if(windowStatus == WINDOW_EXPIRED)
649       {
650          SCH_FREE(cell->raReq[ueId-1]->rachInd, sizeof(RachIndInfo));
651          SCH_FREE(cell->raReq[ueId-1], sizeof(SchRaReq));
652          return false;
653       }
654
655       /* If K0-K2 and K0-K1 combination not found, no scheduling happens */
656       if(!k1Found && !k2Found)
657          return false;
658
659       /* Allocate memory for RAR PDCCH slot, pointer will be checked at schProcessSlotInd() */
660       SCH_ALLOC(dciSlotAlloc, sizeof(RarAlloc));
661       if(dciSlotAlloc == NULLP)
662       {
663          DU_LOG("\nERROR  -->  SCH : Memory Allocation failed for dciSlotAlloc");
664          return false;
665       }
666       cell->schDlSlotInfo[dciSlot]->rarAlloc[ueId-1] = dciSlotAlloc;
667
668       /* Fill PDCCH and PDSCH scheduling information for RAR */
669       if((schFillRar(cell, rarTime, ueId, dciSlotAlloc, k0Index)) != ROK)
670       {
671          DU_LOG("\nERROR  -->  SCH: Scheduling of RAR failed in slot [%d]", rarSlot);
672          SCH_FREE(dciSlotAlloc, sizeof(RarAlloc));
673          cell->schDlSlotInfo[dciSlot]->rarAlloc[ueId-1] = NULLP;
674          return false;
675       }
676
677       /* Fill RAR info */
678       dciSlotAlloc->rarInfo.raRnti = cell->raReq[ueId-1]->raRnti;
679       dciSlotAlloc->rarInfo.tcrnti = cell->raReq[ueId-1]->rachInd->crnti;
680       dciSlotAlloc->rarInfo.RAPID = cell->raReq[ueId-1]->rachInd->preambleIdx;
681       dciSlotAlloc->rarInfo.ta = cell->raReq[ueId-1]->rachInd->timingAdv;
682
683       if(cell->raReq[ueId-1]->isCFRA)
684       {
685          /* Allocate resources for PUCCH */
686          schAllocPucchResource(cell, pucchTime, cell->raReq[ueId-1]->rachInd->crnti);
687       }
688       else
689       {
690          /* Allocate resources for msg3 */
691          msg3PuschInfo = schAllocMsg3Pusch(schInst, cell->raReq[ueId-1]->rachInd->crnti, k2Index, msg3Time);
692          if(msg3PuschInfo)
693          {
694             dciSlotAlloc->rarInfo.ulGrant.bwpSize = cell->cellCfg.schInitialUlBwp.bwp.freqAlloc.numPrb;
695             /* Spec 38.213, section 8.2, 0 : MSG3 PUSCH will be transmitted without frequency hopping */
696             dciSlotAlloc->rarInfo.ulGrant.freqHopFlag = 0;
697             dciSlotAlloc->rarInfo.ulGrant.msg3FreqAlloc.startPrb = msg3PuschInfo->fdAlloc.startPrb;
698             dciSlotAlloc->rarInfo.ulGrant.msg3FreqAlloc.numPrb = msg3PuschInfo->fdAlloc.numPrb;
699             dciSlotAlloc->rarInfo.ulGrant.k2Index = k2Index;
700             dciSlotAlloc->rarInfo.ulGrant.mcs = msg3PuschInfo->tbInfo.mcs;
701             dciSlotAlloc->rarInfo.ulGrant.tpc = 3;  /* TODO : Check appropriate value to be filled */
702             /* Spec 38.213, section 8.2 : In a contention based random access
703              * procedure, the CSI request field is reserved. */
704             dciSlotAlloc->rarInfo.ulGrant.csiReq = 0;
705          }
706       }
707
708       /* Check if both DCI and RAR are sent in the same slot.
709        * If not, allocate memory RAR PDSCH slot to store RAR info
710        */
711       if(dciSlot == rarSlot)
712          dciSlotAlloc->pduPres = BOTH;
713       else
714       {
715          /* Allocate memory to schedule rarSlot to send RAR, pointer will be checked at schProcessSlotInd() */
716          SCH_ALLOC(rarSlotAlloc, sizeof(RarAlloc));
717          if(rarSlotAlloc == NULLP)
718          {
719             DU_LOG("\nERROR  -->  SCH : Memory Allocation failed for rarSlotAlloc");
720             SCH_FREE(dciSlotAlloc, sizeof(RarAlloc));
721             cell->schDlSlotInfo[dciSlot]->rarAlloc[ueId-1] = NULLP;
722             return false;
723          }
724          cell->schDlSlotInfo[rarSlot]->rarAlloc[ueId-1] = rarSlotAlloc;
725
726          /* Copy all RAR info */
727          memcpy(rarSlotAlloc, dciSlotAlloc, sizeof(RarAlloc));
728          rarSlotAlloc->rarPdcchCfg.dci.pdschCfg = &rarSlotAlloc->rarPdschCfg;
729
730          /* Assign correct PDU types in corresponding slots */
731          rarSlotAlloc->pduPres = PDSCH_PDU;
732          dciSlotAlloc->pduPres = PDCCH_PDU;
733          dciSlotAlloc->pdschSlot = rarSlot;  
734       }
735
736       cell->schDlSlotInfo[dciSlot]->pdcchUe = ueId;
737       cell->schDlSlotInfo[rarSlot]->pdschUe = ueId;
738       if(cell->raReq[ueId-1]->isCFRA)
739          cell->schUlSlotInfo[pucchTime.slot]->pucchUe = ueId;
740       else
741          cell->schUlSlotInfo[msg3Time.slot]->puschUe = ueId;
742
743       /* Create raCb at SCH */
744       createSchRaCb(cell->raReq[ueId-1], schInst);
745
746       /* Remove RachInd from pending RA request list */
747       SCH_FREE(cell->raReq[ueId-1]->rachInd, sizeof(RachIndInfo));
748       SCH_FREE(cell->raReq[ueId-1], sizeof(SchRaReq));
749       
750       return true;
751    }
752    return false;
753 }
754
755 /**
756  * @brief process rach indication function. 
757  *
758  * @details
759  *
760  *     Function : schProcessRachInd
761  *     
762  *     This function process rach indication
763  *     
764  *  @param[in]  rachInd parameters
765  *  @param[in]  shed instance
766  *  @return  ROK
767  **/
768 uint8_t schProcessRachInd(RachIndInfo *rachInd, Inst schInst)
769 {
770    SchCellCb *cell = schCb[schInst].cells[schInst];
771    SchRaReq  *raReq = NULLP;
772    float    slotDuration;
773    uint8_t  winNumSlots;
774    uint8_t  ueId;
775
776    if(cell == NULLP)
777    {
778       DU_LOG("\nERROR  -->  SCH: Failed to find cell in schProcessRachInd");
779       return RFAILED;
780    }
781
782    /* Storing RA request in cellCb */
783    GET_UE_ID(rachInd->crnti, ueId);
784    if(ueId <= 0)
785    {
786       DU_LOG("\nERROR  -->  SCH: Invalid CRNTI [%d]", rachInd->crnti);
787       return RFAILED;
788    }
789
790    SCH_ALLOC(raReq, sizeof(SchRaReq));
791    if(!raReq)
792    {
793       DU_LOG("\nERROR  -->  SCH : Memory allocation failure in schProcessRachInd");
794       SCH_FREE(rachInd, sizeof(RachIndInfo));
795       return RFAILED;
796    }
797
798    /* calculate the ra-rnti value */
799    raReq->raRnti = calculateRaRnti(rachInd->symbolIdx, rachInd->slotIdx, rachInd->freqIdx);
800    raReq->rachInd = rachInd;
801    if((cell->ueCb[ueId-1].crnti == rachInd->crnti) && (cell->ueCb[ueId-1].state == SCH_UE_HANDIN_IN_PROGRESS))
802    {
803       raReq->isCFRA = true;
804       raReq->ueCb = &cell->ueCb[ueId-1];
805    }
806    else
807       raReq->isCFRA = false;
808    raReq->winStartTime.sfn = rachInd->timingInfo.sfn;
809    raReq->winStartTime.slot = rachInd->timingInfo.slot;
810   
811    /* Converting window size from ms to number of slots */
812    slotDuration = (1 / pow(2, cell->cellCfg.numerology));
813    winNumSlots = (float)cell->cellCfg.schRachCfg.raRspWindow / slotDuration;
814    
815    /* Adding window size to window start time to get window end time */
816    ADD_DELTA_TO_TIME(raReq->winStartTime, raReq->winEndTime, winNumSlots);
817    cell->raReq[ueId -1] = raReq;
818
819    /* Adding UE Id to list of pending UEs to be scheduled */
820    addUeToBeScheduled(cell, ueId);
821
822    return ROK;
823 }
824
825 /**
826  * @brief fill RAR info function. 
827  *
828  * @details
829  *
830  *     Function : calculateRaRnti
831  *     
832  *     This function fills pdcch and pdsch info for RAR
833  *     
834  *  @param[in]  rar Allocation info
835  *  @param[in]  ra-rnti
836  *  @param[in]  PCI
837  *  @param[in]  offset to pointA to determine freq alloc
838  *  @return  ROK
839  **/
840 uint8_t schFillRar(SchCellCb *cell, SlotTimingInfo rarTime, uint16_t ueId, RarAlloc *rarAlloc, uint8_t k0Index)
841 {
842    uint8_t  coreset0Idx = 0;
843    uint8_t  firstSymbol = 0, numSymbols = 0;
844    uint8_t  mcs = DEFAULT_MCS;  /* MCS fixed to 4 */
845    uint8_t  dmrsStartSymbol, startSymbol, numSymbol ;
846    uint16_t numRbs = 0;
847    uint16_t tbSize = 0;
848
849    SchBwpDlCfg *initialBwp = &cell->cellCfg.schInitialDlBwp;
850    PdcchCfg *pdcch = &rarAlloc->rarPdcchCfg;
851    PdschCfg *pdsch = &rarAlloc->rarPdschCfg;
852    BwpCfg *bwp = &rarAlloc->bwp;
853
854    /* derive the sib1 coreset0 params from table 13-1 spec 38.213 */
855    coreset0Idx     = initialBwp->pdcchCommon.commonSearchSpace.coresetId;
856    numRbs     = coresetIdxTable[coreset0Idx][1]; 
857    numSymbols = coresetIdxTable[coreset0Idx][2];
858
859    /* calculate time domain parameters */
860    // note: since slot value is made sl1, RAR can be sent at all slots
861    uint16_t mask = 0x2000;
862    for(firstSymbol=0; firstSymbol<MAX_SYMB_PER_SLOT; firstSymbol++)
863    {
864       if(initialBwp->pdcchCommon.commonSearchSpace.monitoringSymbol & mask)
865          break;
866       else
867          mask = mask>>1;
868    }
869
870    /* fill BWP */
871    bwp->freqAlloc.numPrb   = initialBwp->bwp.freqAlloc.numPrb;
872    bwp->freqAlloc.startPrb = initialBwp->bwp.freqAlloc.startPrb;
873    bwp->subcarrierSpacing  = initialBwp->bwp.scs;
874    bwp->cyclicPrefix       = initialBwp->bwp.cyclicPrefix;
875
876    /* fill the PDCCH PDU */
877    pdcch->coresetCfg.startSymbolIndex = firstSymbol;
878    pdcch->coresetCfg.durationSymbols = numSymbols;
879    memcpy(pdcch->coresetCfg.freqDomainResource, \
880       cell->cellCfg.schInitialDlBwp.pdcchCommon.commonSearchSpace.freqDomainRsrc, FREQ_DOM_RSRC_SIZE);
881
882    pdcch->coresetCfg.cceRegMappingType = 1; /* coreset0 is always interleaved */
883    pdcch->coresetCfg.regBundleSize = 6;    /* spec-38.211 sec 7.3.2.2 */
884    pdcch->coresetCfg.interleaverSize = 2;  /* spec-38.211 sec 7.3.2.2 */
885    pdcch->coresetCfg.coreSetType = 0;
886    pdcch->coresetCfg.coreSetSize = numRbs;
887    pdcch->coresetCfg.shiftIndex = cell->cellCfg.phyCellId;
888    pdcch->coresetCfg.precoderGranularity = 0; /* sameAsRegBundle */
889    pdcch->numDlDci = 1;
890    pdcch->dci.rnti = cell->raReq[ueId-1]->raRnti; /* RA-RNTI */
891    pdcch->dci.scramblingId = cell->cellCfg.phyCellId;
892    pdcch->dci.scramblingRnti = 0;
893    pdcch->dci.cceIndex = 4; /* considering SIB1 is sent at cce 0-1-2-3 */
894    pdcch->dci.aggregLevel = 4;
895    pdcch->dci.beamPdcchInfo.numPrgs = 1;
896    pdcch->dci.beamPdcchInfo.prgSize = 1;
897    pdcch->dci.beamPdcchInfo.digBfInterfaces = 0;
898    pdcch->dci.beamPdcchInfo.prg[0].pmIdx = 0;
899    pdcch->dci.beamPdcchInfo.prg[0].beamIdx[0] = 0;
900    pdcch->dci.txPdcchPower.powerValue = 0;
901    pdcch->dci.txPdcchPower.powerControlOffsetSS = 0;
902    pdcch->dci.pdschCfg = pdsch;
903
904    /* fill the PDSCH PDU */
905    uint8_t cwCount = 0;
906    pdsch->pduBitmap = 0; /* PTRS and CBG params are excluded */
907    pdsch->rnti = cell->raReq[ueId-1]->raRnti; /* RA-RNTI */
908    pdsch->pduIndex = 0;
909    pdsch->numCodewords = 1;
910    for(cwCount = 0; cwCount < pdsch->numCodewords; cwCount++)
911    {
912       pdsch->codeword[cwCount].targetCodeRate = 308;
913       pdsch->codeword[cwCount].qamModOrder = 2;
914       pdsch->codeword[cwCount].mcsIndex = mcs; /* mcs configured to 4 */
915       pdsch->codeword[cwCount].mcsTable = 0;   /* notqam256 */
916       pdsch->codeword[cwCount].rvIndex = 0;
917       /* RAR PDU length and FAPI payload header length */
918       tbSize = schCalcTbSize(RAR_PAYLOAD_SIZE + TX_PAYLOAD_HDR_LEN);
919       pdsch->codeword[cwCount].tbSize = tbSize;
920    }
921    pdsch->dataScramblingId = cell->cellCfg.phyCellId;
922    pdsch->numLayers = 1;
923    pdsch->transmissionScheme = 0;
924    pdsch->refPoint = 0;
925    pdsch->dmrs.dlDmrsSymbPos = 4;  /* Bitmap value 00000000000100 i.e. using 3rd symbol for PDSCH DMRS */
926    pdsch->dmrs.dmrsConfigType = 0; /* type-1 */
927    pdsch->dmrs.dlDmrsScramblingId = cell->cellCfg.phyCellId;
928    pdsch->dmrs.scid = 0;
929    pdsch->dmrs.numDmrsCdmGrpsNoData = 1;
930    pdsch->dmrs.dmrsPorts = 0;
931    pdsch->dmrs.mappingType      = DMRS_MAP_TYPE_A;  /* Type-A */
932    pdsch->dmrs.nrOfDmrsSymbols  = NUM_DMRS_SYMBOLS;
933    pdsch->dmrs.dmrsAddPos       = DMRS_ADDITIONAL_POS;
934
935    pdsch->pdschTimeAlloc.rowIndex = k0Index;
936    pdsch->pdschTimeAlloc.timeAlloc.startSymb = initialBwp->pdschCommon.timeDomRsrcAllocList[k0Index].startSymbol;
937    pdsch->pdschTimeAlloc.timeAlloc.numSymb = initialBwp->pdschCommon.timeDomRsrcAllocList[k0Index].lengthSymbol;
938
939    pdsch->pdschFreqAlloc.vrbPrbMapping = 0; /* non-interleaved */
940    pdsch->pdschFreqAlloc.resourceAllocType = 1; /* RAT type-1 RIV format */
941    pdsch->pdschFreqAlloc.freqAlloc.startPrb = MAX_NUM_RB;
942    pdsch->pdschFreqAlloc.freqAlloc.numPrb = \
943       schCalcNumPrb(tbSize, mcs, initialBwp->pdschCommon.timeDomRsrcAllocList[k0Index].lengthSymbol);
944
945    /* Find total symbols occupied including DMRS */
946    dmrsStartSymbol = findDmrsStartSymbol(pdsch->dmrs.dlDmrsSymbPos);
947    /* If there are no DRMS symbols, findDmrsStartSymbol() returns MAX_SYMB_PER_SLOT, 
948     * in that case only PDSCH symbols are marked as occupied */
949    if(dmrsStartSymbol == MAX_SYMB_PER_SLOT)
950    {
951       startSymbol = pdsch->pdschTimeAlloc.timeAlloc.startSymb;
952       numSymbol = pdsch->pdschTimeAlloc.timeAlloc.numSymb;
953    }
954    /* If DMRS symbol is found, mark DMRS and PDSCH symbols as occupied */
955    else
956    {
957       startSymbol = dmrsStartSymbol;
958       numSymbol = pdsch->dmrs.nrOfDmrsSymbols + pdsch->pdschTimeAlloc.timeAlloc.numSymb;
959    }
960
961    /* Allocate the number of PRBs required for RAR PDSCH */
962    if((allocatePrbDl(cell, rarTime, startSymbol, numSymbol,\
963       &pdsch->pdschFreqAlloc.freqAlloc.startPrb, pdsch->pdschFreqAlloc.freqAlloc.numPrb)) != ROK)
964    {
965       DU_LOG("\nERROR  --> SCH : allocatePrbDl() failed for RAR");
966       return RFAILED;
967    }
968
969    pdsch->beamPdschInfo.numPrgs = 1;
970    pdsch->beamPdschInfo.prgSize = 1;
971    pdsch->beamPdschInfo.digBfInterfaces = 0;
972    pdsch->beamPdschInfo.prg[0].pmIdx = 0;
973    pdsch->beamPdschInfo.prg[0].beamIdx[0] = 0;
974    pdsch->txPdschPower.powerControlOffset = 0;
975    pdsch->txPdschPower.powerControlOffsetSS = 0;
976
977    return ROK;
978 }
979
980 /**********************************************************************
981          End of file
982 **********************************************************************/