Memory handling fixes
[o-du/l2.git] / src / 5gnrsch / sch.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.c
22   
23      Type:     C source file
24   
25      Desc:     C source code for scheduler fucntions
26   
27      File:     sch.c
28   
29 **********************************************************************/
30
31 /** @file sch.c
32 @brief This file implements the schedulers main access to MAC layer code.
33 */
34 #include "common_def.h" 
35 #include "du_app_mac_inf.h"
36 #include "lrg.h"
37 #include "tfu.h"
38 #include "du_log.h"
39 #include "rgr.h"
40 #include "rg_sch_inf.h"
41 #include "rg_sch.h"
42
43 #include "tfu.x"           /* TFU types */
44 #include "lrg.x"           /* layer management typedefs for MAC */
45 #include "rgr.x"           /* layer management typedefs for MAC */
46 #include "rg_sch_inf.x"         /* typedefs for Scheduler */
47 #include "mac_sch_interface.h"
48 #include "sch.h"
49 #include "sch_utils.h"
50
51 SchCb schCb[SCH_MAX_INST];
52 void SchFillCfmPst(Pst *reqPst,Pst *cfmPst,RgMngmt *cfm);
53
54 /* local defines */
55 SchCellCfgCfmFunc SchCellCfgCfmOpts[] = 
56 {
57    packSchCellCfgCfm,     /* LC */
58    MacProcSchCellCfgCfm,  /* TC */
59    packSchCellCfgCfm      /* LWLC */
60 };
61
62
63 /**
64  * @brief Task Initiation function. 
65  *
66  * @details
67  *
68  *     Function : schActvInit
69  *     
70  *     This function is supplied as one of parameters during MAC's 
71  *     task registration. MAC will invoke this function once, after
72  *     it creates and attaches this TAPA Task to a system task.
73  *     
74  *  @param[in]  Ent Entity, the entity ID of this task.     
75  *  @param[in]  Inst Inst, the instance ID of this task.
76  *  @param[in]  Region Region, the region ID registered for memory 
77  *              usage of this task.
78  *  @param[in]  Reason Reason.
79  *  @return  int
80  *      -# ROK
81  **/
82 uint8_t schActvInit(Ent entity, Inst instId, Region region, Reason reason)
83 {
84    Inst inst = (instId  - SCH_INST_START);
85
86    /* Initialize the MAC TskInit structure to zero */
87    memset ((uint8_t *)&schCb[inst], 0, sizeof(schCb));
88
89    /* Initialize the MAC TskInit with received values */
90    schCb[inst].schInit.ent = entity;
91    schCb[inst].schInit.inst = inst;
92    schCb[inst].schInit.region = region;
93    schCb[inst].schInit.pool = 0;
94    schCb[inst].schInit.reason = reason;
95    schCb[inst].schInit.cfgDone = FALSE;
96    schCb[inst].schInit.acnt = FALSE;
97    schCb[inst].schInit.usta = FALSE;
98    schCb[inst].schInit.trc = FALSE;
99    schCb[inst].schInit.procId = ODU_GET_PROCID();
100
101    return ROK;
102 } /* schActvInit */
103
104 /**
105  * @brief Scheduler instance Configuration Handler. 
106  *
107  * @details
108  *
109  *     Function : SchInstCfg
110  *     
111  *     This function in called by SchProcGenCfgReq(). It handles the
112  *     general configurations of the scheduler instance. Returns
113  *     reason for success/failure of this function.
114  *     
115  *  @param[in]  RgCfg *cfg, the Configuaration information 
116  *  @return  uint16_t
117  *      -# LCM_REASON_NOT_APPL 
118  *      -# LCM_REASON_INVALID_MSGTYPE
119  *      -# LCM_REASON_MEM_NOAVAIL
120  **/
121 uint8_t SchInstCfg(RgCfg *cfg, Inst  dInst)
122 {
123    uint16_t ret = LCM_REASON_NOT_APPL;
124    Inst     inst = (dInst - SCH_INST_START);
125
126    DU_LOG("\nDEBUG  -->  SCH : Entered SchInstCfg()");
127    /* Check if Instance Configuration is done already */
128    if (schCb[inst].schInit.cfgDone == TRUE)
129    {
130       return LCM_REASON_INVALID_MSGTYPE;
131    }
132    /* Update the Pst structure for LM interface */
133    memcpy(&schCb[inst].schInit.lmPst,
134          &cfg->s.schInstCfg.genCfg.lmPst,
135          sizeof(Pst));
136
137    schCb[inst].schInit.inst = inst;
138    schCb[inst].schInit.lmPst.srcProcId = schCb[inst].schInit.procId;
139    schCb[inst].schInit.lmPst.srcEnt = schCb[inst].schInit.ent;
140    schCb[inst].schInit.lmPst.srcInst = schCb[inst].schInit.inst +
141       SCH_INST_START;
142    schCb[inst].schInit.lmPst.event = EVTNONE;
143
144    schCb[inst].schInit.region = cfg->s.schInstCfg.genCfg.mem.region;
145    schCb[inst].schInit.pool = cfg->s.schInstCfg.genCfg.mem.pool;
146    schCb[inst].genCfg.tmrRes = cfg->s.schInstCfg.genCfg.tmrRes;
147 #ifdef LTE_ADV
148    schCb[inst].genCfg.forceCntrlSrbBoOnPCel =  cfg->s.schInstCfg.genCfg.forceCntrlSrbBoOnPCel;
149    schCb[inst].genCfg.isSCellActDeactAlgoEnable =  cfg->s.schInstCfg.genCfg.isSCellActDeactAlgoEnable;
150 #endif
151    schCb[inst].genCfg.startCellId    = cfg->s.schInstCfg.genCfg.startCellId;
152
153    /* Initialzie the timer queue */   
154    memset(&schCb[inst].tmrTq, 0, sizeof(CmTqType) * SCH_TQ_SIZE);
155    /* Initialize the timer control point */
156    memset(&schCb[inst].tmrTqCp, 0, sizeof(CmTqCp));
157    schCb[inst].tmrTqCp.tmrLen = RGSCH_TQ_SIZE;
158
159    /* SS_MT_TMR needs to be enabled as schActvTmr needs instance information */
160    /* Timer Registration request to system services */
161    if (ODU_REG_TMR_MT(schCb[inst].schInit.ent, dInst,
162             (int)schCb[inst].genCfg.tmrRes, schActvTmr) != ROK)
163    {
164       DU_LOG("\nERROR  -->  SCH : SchInstCfg(): Failed to "
165             "register timer.");
166       return (LCM_REASON_MEM_NOAVAIL);
167    }   
168               
169    /* Set Config done in TskInit */
170    schCb[inst].schInit.cfgDone = TRUE;
171    DU_LOG("\nINFO  -->  SCH : Scheduler gen config done");
172
173    return ret;
174 }
175
176 /**
177  * @brief Layer Manager Configuration request handler. 
178  *
179  * @details
180  *
181  *     Function : SchProcGenCfgReq
182  *     
183  *     This function handles the configuration
184  *     request received at scheduler instance from the Layer Manager.
185  *     -# Based on the cfg->hdr.elmId.elmnt value it invokes one of the
186  *        functions rgHdlGenCfg() or rgHdlSapCfg().
187  *     -# Invokes RgMiLrgSchCfgCfm() to send back the confirmation to the LM.
188  *     
189  *  @param[in]  Pst *pst, the post structure     
190  *  @param[in]  RgMngmt *cfg, the configuration parameter's structure
191  *  @return  S16
192  *      -# ROK
193  **/
194 uint8_t SchProcGenCfgReq(Pst *pst, RgMngmt *cfg)
195 {
196    uint8_t   ret = LCM_PRIM_OK;
197    uint16_t  reason = LCM_REASON_NOT_APPL;
198    RgMngmt   cfm;
199    Pst       cfmPst;
200
201    if(pst->dstInst < SCH_INST_START)
202    {
203       DU_LOG("\nERROR  -->  SCH : Invalid inst ID");
204       DU_LOG("\nERROR  -->  SCH : SchProcGenCfgReq(): "
205             "pst->dstInst=%d SCH_INST_START=%d", pst->dstInst,SCH_INST_START); 
206       return ROK;
207    }
208    DU_LOG("\nINFO -->  SCH : Received scheduler gen config");
209    /* Fill the post structure for sending the confirmation */
210    memset(&cfmPst, 0 , sizeof(Pst));
211    SchFillCfmPst(pst, &cfmPst, cfg);
212
213    memset(&cfm, 0, sizeof(RgMngmt));
214
215 #ifdef LMINT3
216    cfm.hdr.transId =
217       cfg->hdr.transId;
218 #endif
219
220    cfm.hdr.elmId.elmnt = cfg->hdr.elmId.elmnt;
221    switch(cfg->hdr.elmId.elmnt)
222    {
223       case STSCHINST:
224          reason = SchInstCfg(&cfg->t.cfg,pst->dstInst );
225          break;
226       default:
227          ret = LCM_PRIM_NOK;
228          reason = LCM_REASON_INVALID_ELMNT;
229          DU_LOG("\nERROR  -->  SCH : Invalid Elmnt=%d", cfg->hdr.elmId.elmnt);
230          break;
231    }
232
233    if (reason != LCM_REASON_NOT_APPL)
234    {
235       ret = LCM_PRIM_NOK;
236    }
237
238    cfm.cfm.status = ret;
239    cfm.cfm.reason = reason;
240
241    SchSendCfgCfm(&cfmPst, &cfm);
242    /*   SCH_FREE(pst->region, pst->pool, (Data *)cfg, sizeof(RgMngmt)); */
243
244    return ROK;
245 }/*-- SchProcGenCfgReq --*/
246
247 /**
248  * @brief slot indication from MAC to SCH.
249  *
250  * @details
251  *
252  *     Function : MacSchSlotInd 
253  *      
254  *      This API is invoked by PHY to indicate slot indication to Scheduler for
255  *      a cell.
256  *           
257  *  @param[in]  Pst            *pst
258  *  @param[in]  SlotIndInfo    *slotInd
259  *  @return  S16
260  *      -# ROK 
261  *      -# RFAILED 
262  **/
263 uint8_t MacSchSlotInd(Pst *pst, SlotIndInfo *slotInd)
264 {
265    Inst  inst = pst->dstInst-SCH_INST_START;
266
267    schProcessSlotInd(slotInd, inst);
268
269    return ROK;
270 }  /* MacSchSlotInd */
271
272 /*******************************************************************
273  *
274  * @brief Processes Rach indication from MAC 
275  *
276  * @details
277  *
278  *    Function : MacSchRachInd
279  *
280  *    Functionality:
281  *      Processes Rach indication from MAC
282  *
283  * @params[in] 
284  * @return ROK     - success
285  *         RFAILED - failure
286  *
287  * ****************************************************************/
288 uint8_t MacSchRachInd(Pst *pst, RachIndInfo *rachInd)
289 {
290    Inst  inst = pst->dstInst-SCH_INST_START;
291    DU_LOG("\nINFO  -->  SCH : Received Rach indication");
292    schProcessRachInd(rachInd, inst);
293    return ROK;
294 }
295
296 /*******************************************************************
297  *
298  * @brief Processes CRC indication from MAC 
299  *
300  * @details
301  *
302  *    Function : MacSchCrcInd
303  *
304  *    Functionality:
305  *      Processes CRC indication from MAC
306  *
307  * @params[in] Post structure
308  *             Crc Indication
309  * @return ROK     - success
310  *         RFAILED - failure
311  *
312  * ****************************************************************/
313 uint8_t MacSchCrcInd(Pst *pst, CrcIndInfo *crcInd)
314 {
315    switch(crcInd->crcInd[0])
316    {
317       case CRC_FAILED:
318          DU_LOG("\nDEBUG  -->  SCH : Received CRC indication. CRC Status [FAILURE]");
319          break;
320       case CRC_PASSED:
321          DU_LOG("\nDEBUG  -->  SCH : Received CRC indication. CRC Status [PASS]");
322          break;
323       default:
324          DU_LOG("\nDEBUG  -->  SCH : Invalid CRC state %d", crcInd->crcInd[0]);
325          return RFAILED;
326    }
327    return ROK;
328 }
329
330 #ifdef NR_TDD
331 /**
332  *@brief Returns TDD periodicity in micro seconds
333  *
334  * @details
335  * 
336  * Function : schGetPeriodicityInMsec 
337  * 
338  * This API retunrs TDD periodicity in micro seconds
339  * 
340  * @param[in] DlUlTxPeriodicity 
341  * @return  periodicityInMsec
342  * **/
343
344 uint16_t schGetPeriodicityInMsec(DlUlTxPeriodicity tddPeriod)
345 {
346    uint16_t  periodicityInMsec = 0;
347    switch(tddPeriod)
348    {
349       case TX_PRDCTY_MS_0P5:
350       {
351          periodicityInMsec = 500;
352          break;
353       }
354       case TX_PRDCTY_MS_0P625:
355       {
356          periodicityInMsec = 625;
357          break;
358       }
359       case TX_PRDCTY_MS_1:
360       {
361          periodicityInMsec = 1000;
362          break;
363       }
364       case TX_PRDCTY_MS_1P25:
365       {
366          periodicityInMsec = 1250;
367          break;
368       }
369       case TX_PRDCTY_MS_2:
370       {
371          periodicityInMsec = 2000;
372          break;
373       }
374       case TX_PRDCTY_MS_2P5:
375       {
376          periodicityInMsec = 2500;
377          break;
378       }
379       case TX_PRDCTY_MS_5:
380       {
381          periodicityInMsec = 5000;
382          break;
383       }
384       case TX_PRDCTY_MS_10:
385       {
386          periodicityInMsec = 10000;
387          break;
388       }
389       default:
390       {
391          DU_LOG("\nERROR  -->  SCH : Invalid DlUlTxPeriodicity:%d", tddPeriod);
392       }
393    }
394
395    return periodicityInMsec;
396 }
397
398
399 /**
400  * @brief init TDD slot config 
401  *
402  * @details
403  *
404  *     Function : schInitTddSlotCfg 
405  *      
406  *      This API is invoked after receiving schCellCfg
407  *           
408  *  @param[in]  schCellCb *cell
409  *  @param[in]  SchCellCfg *schCellCfg
410  *  @return  void
411  **/
412 void schInitTddSlotCfg(SchCellCb *cell, SchCellCfg *schCellCfg)
413 {
414    uint16_t periodicityInMicroSec = 0;
415    int8_t slotIdx, symbIdx;
416
417    periodicityInMicroSec = schGetPeriodicityInMsec(schCellCfg->tddCfg.tddPeriod);
418    cell->numSlotsInPeriodicity = (periodicityInMicroSec * pow(2, schCellCfg->numerology))/1000;
419    cell->slotFrmtBitMap = 0;
420    cell->symbFrmtBitMap = 0;
421    for(slotIdx = cell->numSlotsInPeriodicity-1; slotIdx >= 0; slotIdx--)
422    {
423       symbIdx = 0;
424       /* If the first and last symbol are the same, the entire slot is the same type */
425       if((schCellCfg->tddCfg.slotCfg[slotIdx][symbIdx] == schCellCfg->tddCfg.slotCfg[slotIdx][MAX_SYMB_PER_SLOT-1]) &&
426               schCellCfg->tddCfg.slotCfg[slotIdx][symbIdx] != FLEXI_SLOT)
427       {
428          switch(schCellCfg->tddCfg.slotCfg[slotIdx][symbIdx])
429          {
430             case DL_SLOT:
431             {
432                /*BitMap to be set to 00 */
433                cell->slotFrmtBitMap = (cell->slotFrmtBitMap<<2);
434                break;
435             }
436             case UL_SLOT:
437             {
438                /*BitMap to be set to 01 */
439                cell->slotFrmtBitMap = ((cell->slotFrmtBitMap<<2) | (UL_SLOT));
440                break;
441             }
442             default:
443                DU_LOG("\nERROR  -->  SCH : Invalid slot Config in schInitTddSlotCfg");
444            }
445          continue;
446       }
447       /* slot config is flexible. First set slotBitMap to 10 */
448       cell->slotFrmtBitMap = ((cell->slotFrmtBitMap<<2) | (FLEXI_SLOT));
449
450       /* Now set symbol bitmap */ 
451       for(symbIdx = MAX_SYMB_PER_SLOT-1; symbIdx >= 0; symbIdx--)
452       {
453          switch(schCellCfg->tddCfg.slotCfg[slotIdx][symbIdx])
454          {
455             case DL_SLOT:
456             {
457                /*symbol BitMap to be set to 00 */
458                cell->symbFrmtBitMap = (cell->symbFrmtBitMap<<2);
459                break;
460             }
461             case UL_SLOT:
462             {
463                /*symbol BitMap to be set to 01 */
464                cell->symbFrmtBitMap = ((cell->symbFrmtBitMap<<2) | (UL_SLOT));
465                break;
466             }
467             case FLEXI_SLOT:
468             {
469                /*symbol BitMap to be set to 10 */
470                cell->symbFrmtBitMap = ((cell->symbFrmtBitMap<<2) | (FLEXI_SLOT));
471                break;
472             }
473             default:
474                DU_LOG("\nERROR  -->  SCH : Invalid slot Config in schInitTddSlotCfg");
475          }
476       }
477    }
478 }
479 #endif
480
481 /**
482  * @brief Fill SSB start symbol
483  *
484  * @details
485  *
486  *     Function : fillSsbStartSymb 
487  *      
488  *      This API stores SSB start index per beam
489  *           
490  *  @param[in]  SchCellCb     *cellCb
491  *  @return  int
492  *      -# ROK 
493  *      -# RFAILED 
494  **/
495 void fillSsbStartSymb(SchCellCb *cellCb)
496 {
497    uint8_t cnt, scs, symbIdx, ssbStartSymbArr[SCH_MAX_SSB_BEAM];
498
499    scs = cellCb->cellCfg.ssbSchCfg.scsCommon;
500
501    memset(ssbStartSymbArr, 0, sizeof(SCH_MAX_SSB_BEAM));
502    symbIdx = 0;
503    /* Determine value of "n" based on Section 4.1 of 3GPP TS 38.213 */
504    switch(scs)
505    {
506       case SCS_15KHZ:
507          {
508             if(cellCb->cellCfg.dlFreq <= 300000)
509                cnt = 2;/* n = 0, 1 */
510             else
511                cnt = 4; /* n = 0, 1, 2, 3 */
512             for(uint8_t idx=0; idx<cnt; idx++)
513             {
514                /* start symbol determined using {2, 8} + 14n */
515                ssbStartSymbArr[symbIdx++] = 2 + SCH_SYMBOL_PER_SLOT*idx;
516                ssbStartSymbArr[symbIdx++] = 8 + SCH_SYMBOL_PER_SLOT*idx;
517             }
518          }
519          break;
520       case SCS_30KHZ:
521          {
522             if(cellCb->cellCfg.dlFreq <= 300000)
523                cnt = 1;/* n = 0 */
524             else
525                cnt = 2; /* n = 0, 1 */
526             for(uint8_t idx=0; idx<cnt; idx++)
527             {
528                /* start symbol determined using {4, 8, 16, 20} + 28n */
529                ssbStartSymbArr[symbIdx++] = 4 + SCH_SYMBOL_PER_SLOT*idx;
530                ssbStartSymbArr[symbIdx++] = 8 + SCH_SYMBOL_PER_SLOT*idx;
531                ssbStartSymbArr[symbIdx++] = 16 + SCH_SYMBOL_PER_SLOT*idx;
532                ssbStartSymbArr[symbIdx++] = 20 + SCH_SYMBOL_PER_SLOT*idx;
533             }
534          }
535          break;
536       default:
537          DU_LOG("\nERROR  -->  SCH : SCS %d is currently not supported", scs);
538    }
539    memset(cellCb->ssbStartSymbArr, 0, sizeof(SCH_MAX_SSB_BEAM));
540    memcpy(cellCb->ssbStartSymbArr, ssbStartSymbArr, SCH_MAX_SSB_BEAM);
541
542 }
543
544
545 /**
546  * @brief init cellCb based on cellCfg
547  *
548  * @details
549  *
550  *     Function : schInitCellCb 
551  *      
552  *      This API is invoked after receiving schCellCfg
553  *           
554  *  @param[in]  schCellCb *cell
555  *  @param[in]  SchCellCfg *schCellCfg
556  *  @return  int
557  *      -# ROK 
558  *      -# RFAILED 
559  **/
560 uint8_t schInitCellCb(Inst inst, SchCellCfg *schCellCfg)
561 {
562    SchCellCb *cell= NULLP;
563    SCH_ALLOC(cell, sizeof(SchCellCb));
564    if(!cell)
565    {
566       DU_LOG("\nERROR  -->  SCH : Memory allocation failed in schInitCellCb");
567       return RFAILED;
568    }
569
570    cell->cellId = schCellCfg->cellId; 
571    cell->instIdx = inst;
572    switch(schCellCfg->numerology)
573    {
574       case SCH_NUMEROLOGY_0:
575          {
576             cell->numSlots = SCH_MU0_NUM_SLOTS;
577          }
578          break;
579       case SCH_NUMEROLOGY_1:
580          {
581             cell->numSlots = SCH_MU1_NUM_SLOTS;
582          }
583          break;
584       case SCH_NUMEROLOGY_2:
585          {
586             cell->numSlots = SCH_MU2_NUM_SLOTS;
587          }
588          break;
589       case SCH_NUMEROLOGY_3:
590          {
591             cell->numSlots = SCH_MU3_NUM_SLOTS;
592          }
593          break;
594       case SCH_NUMEROLOGY_4:
595          {
596             cell->numSlots = SCH_MU4_NUM_SLOTS;
597          }
598          break;
599       default:
600          DU_LOG("\nERROR  -->  SCH : Numerology %d not supported", schCellCfg->numerology);
601    }
602 #ifdef NR_TDD
603    schInitTddSlotCfg(cell, schCellCfg);   
604 #endif
605
606    SCH_ALLOC(cell->schDlSlotInfo, cell->numSlots * sizeof(SchDlSlotInfo*));
607    if(!cell->schDlSlotInfo)
608    {
609       DU_LOG("\nERROR  -->  SCH : Memory allocation failed in schInitCellCb for schDlSlotInfo");
610       return RFAILED;
611    }
612
613    SCH_ALLOC(cell->schUlSlotInfo, cell->numSlots * sizeof(SchUlSlotInfo*));
614    if(!cell->schUlSlotInfo)
615    {
616       DU_LOG("\nERROR  -->  SCH : Memory allocation failed in schInitCellCb for schUlSlotInfo");
617       return RFAILED;
618    }
619
620    for(uint8_t idx=0; idx<cell->numSlots; idx++)
621    {
622       SchDlSlotInfo *schDlSlotInfo;
623       SchUlSlotInfo *schUlSlotInfo;
624
625       /* DL Alloc */
626       SCH_ALLOC(schDlSlotInfo, sizeof(SchDlSlotInfo));
627       if(!schDlSlotInfo)
628       {
629          DU_LOG("\nERROR  -->  SCH : Memory allocation failed in schInitCellCb");
630          return RFAILED;
631       }
632
633       /* UL Alloc */
634       SCH_ALLOC(schUlSlotInfo, sizeof(SchUlSlotInfo));
635       if(!schUlSlotInfo)
636       {
637          DU_LOG("\nERROR  -->  SCH : Memory allocation failed in schInitCellCb");
638          return RFAILED;
639       }
640
641       schInitDlSlot(schDlSlotInfo);
642       schInitUlSlot(schUlSlotInfo);
643
644       cell->schDlSlotInfo[idx] = schDlSlotInfo;
645       cell->schUlSlotInfo[idx] = schUlSlotInfo;
646
647    }
648    cell->firstSsbTransmitted = false;
649    cell->firstSib1Transmitted = false;
650    fillSsbStartSymb(cell);
651    schCb[inst].cells[inst] = cell;
652
653    DU_LOG("\nINFO  -->  SCH : Cell init completed for cellId:%d", cell->cellId);
654
655    return ROK;   
656 }
657
658 /**
659  * @brief Fill SIB1 configuration
660  *
661  * @details
662  *
663  *     Function : fillSchSib1Cfg
664  *
665  *     Fill SIB1 configuration
666  *
667  *  @param[in]  uint8_t bandwidth : total available bandwidth
668  *              uint8_t numSlots : total slots per SFN
669  *              SchSib1Cfg *sib1SchCfg : cfg to be filled
670  *              uint16_t pci : physical cell Id
671  *              uint8_t offsetPointA : offset
672  *  @return  void
673  **/
674 void fillSchSib1Cfg(uint8_t mu, uint8_t bandwidth, uint8_t numSlots, SchSib1Cfg *sib1SchCfg, uint16_t pci, uint8_t offsetPointA)
675 {
676    uint8_t coreset0Idx = 0;
677    uint8_t searchSpace0Idx = 0;
678    //uint8_t ssbMuxPattern = 0;
679    uint8_t numRbs = 0;
680    uint8_t numSymbols = 0;
681    uint8_t offset = 0;
682    uint8_t oValue = 0;
683    //uint8_t numSearchSpacePerSlot = 0;
684    uint8_t mValue = 0;
685    uint8_t firstSymbol = 0; /* need to calculate using formula mentioned in 38.213 */
686    uint8_t slotIndex = 0;
687    /* TODO : This should be filled through freqDomRscAllocType0() */
688    uint8_t FreqDomainResource[6] = {15, 0, 0, 0, 0, 0};
689    uint16_t tbSize = 0;
690    uint8_t numPdschSymbols = 11; /* considering pdsch region from symbols 3 to 13 */
691    uint8_t ssbIdx = 0;
692
693    PdcchCfg *pdcch = &(sib1SchCfg->sib1PdcchCfg);
694    PdschCfg *pdsch = &(sib1SchCfg->sib1PdschCfg);
695    BwpCfg *bwp = &(sib1SchCfg->bwp);
696
697    coreset0Idx     = sib1SchCfg->coresetZeroIndex;
698    searchSpace0Idx = sib1SchCfg->searchSpaceZeroIndex;
699
700    /* derive the sib1 coreset0 params from table 13-1 spec 38.213 */
701    //ssbMuxPattern = coresetIdxTable[coreset0Idx][0];
702    numRbs        = coresetIdxTable[coreset0Idx][1];
703    numSymbols    = coresetIdxTable[coreset0Idx][2];
704    offset        = coresetIdxTable[coreset0Idx][3];
705
706    /* derive the search space params from table 13-11 spec 38.213 */
707    oValue                = searchSpaceIdxTable[searchSpace0Idx][0];
708    //numSearchSpacePerSlot = searchSpaceIdxTable[searchSpace0Idx][1];
709    mValue                = searchSpaceIdxTable[searchSpace0Idx][2];
710    firstSymbol           = searchSpaceIdxTable[searchSpace0Idx][3];
711
712    /* calculate the n0, need to add the formulae, as of now the value is 0 
713     * Need to add the even and odd values of i during configuration 
714     * [(O . 2^u + i . M )  ] mod numSlotsPerSubframe 
715     * assuming u = 0, i = 0, numSlotsPerSubframe = 10
716     * Also, from this configuration, coreset0 is only on even subframe */
717    slotIndex = (int)((oValue*pow(2, mu)) + floor(ssbIdx*mValue))%numSlots;
718    sib1SchCfg->n0 = slotIndex;
719
720    /* calculate the PRBs */
721    //freqDomRscAllocType0(((offsetPointA-offset)/6), (numRbs/6), FreqDomainResource);
722
723    /* fill BWP */
724    switch(bandwidth)
725    {
726       case BANDWIDTH_20MHZ:
727          {
728             bwp->freqAlloc.numPrb = TOTAL_PRB_20MHZ_MU0;
729          }
730          break;
731       case BANDWIDTH_100MHZ:
732          {
733             bwp->freqAlloc.numPrb = TOTAL_PRB_100MHZ_MU1;
734          }
735          break;
736       default:
737          DU_LOG("\nERROR  -->  SCH : Bandwidth %d not supported", bandwidth);
738
739    }
740    bwp->freqAlloc.startPrb = 0;
741    bwp->subcarrierSpacing  = 0;         /* 15Khz */
742    bwp->cyclicPrefix       = 0;              /* normal */
743
744    /* fill the PDCCH PDU */
745    pdcch->coresetCfg.coreSetSize = numRbs;
746    pdcch->coresetCfg.startSymbolIndex = firstSymbol;
747    pdcch->coresetCfg.durationSymbols = numSymbols;
748    memcpy(pdcch->coresetCfg.freqDomainResource,FreqDomainResource,6);
749    pdcch->coresetCfg.cceRegMappingType = 1; /* coreset0 is always interleaved */
750    pdcch->coresetCfg.regBundleSize = 6;    /* spec-38.211 sec 7.3.2.2 */
751    pdcch->coresetCfg.interleaverSize = 2;  /* spec-38.211 sec 7.3.2.2 */
752    pdcch->coresetCfg.coreSetType = 0;
753    pdcch->coresetCfg.shiftIndex = pci;
754    pdcch->coresetCfg.precoderGranularity = 0; /* sameAsRegBundle */
755    pdcch->numDlDci = 1;
756    pdcch->dci.rnti = SI_RNTI;
757    pdcch->dci.scramblingId = pci;
758    pdcch->dci.scramblingRnti = 0;
759    pdcch->dci.cceIndex = 0;
760    pdcch->dci.aggregLevel = 4;
761    pdcch->dci.beamPdcchInfo.numPrgs = 1;
762    pdcch->dci.beamPdcchInfo.prgSize = 1;
763    pdcch->dci.beamPdcchInfo.digBfInterfaces = 0;
764    pdcch->dci.beamPdcchInfo.prg[0].pmIdx = 0;
765    pdcch->dci.beamPdcchInfo.prg[0].beamIdx[0] = 0;
766    pdcch->dci.txPdcchPower.powerValue = 0;
767    pdcch->dci.txPdcchPower.powerControlOffsetSS = 0;
768    /* Storing pdschCfg pointer here. Required to access pdsch config while
769       fillig up pdcch pdu */
770    pdcch->dci.pdschCfg = pdsch; 
771
772    /* fill the PDSCH PDU */
773    uint8_t cwCount = 0;
774    pdsch->pduBitmap = 0; /* PTRS and CBG params are excluded */
775    pdsch->rnti = 0xFFFF; /* SI-RNTI */
776    pdsch->pduIndex = 0;
777    pdsch->numCodewords = 1;
778    for(cwCount = 0; cwCount < pdsch->numCodewords; cwCount++)
779    {
780       pdsch->codeword[cwCount].targetCodeRate = 308;
781       pdsch->codeword[cwCount].qamModOrder = 2;
782       pdsch->codeword[cwCount].mcsIndex = sib1SchCfg->sib1Mcs;
783       pdsch->codeword[cwCount].mcsTable = 0; /* notqam256 */
784       pdsch->codeword[cwCount].rvIndex = 0;
785       tbSize = schCalcTbSize(sib1SchCfg->sib1PduLen + TX_PAYLOAD_HDR_LEN);
786       pdsch->codeword[cwCount].tbSize = tbSize;
787    }
788    pdsch->dataScramblingId                   = pci;
789    pdsch->numLayers                          = 1;
790    pdsch->transmissionScheme                 = 0;
791    pdsch->refPoint                           = 0;
792    pdsch->dmrs.dlDmrsSymbPos                 = 4; /* Bitmap value 00000000000100 i.e. using 3rd symbol for PDSCH DMRS */
793    pdsch->dmrs.dmrsConfigType                = 0; /* type-1 */
794    pdsch->dmrs.dlDmrsScramblingId            = pci;
795    pdsch->dmrs.scid                          = 0;
796    pdsch->dmrs.numDmrsCdmGrpsNoData          = 1;
797    pdsch->dmrs.dmrsPorts                     = 0x0001;
798    pdsch->dmrs.mappingType                   = DMRS_MAP_TYPE_A; /* Type-A */
799    pdsch->dmrs.nrOfDmrsSymbols               = NUM_DMRS_SYMBOLS;
800    pdsch->dmrs.dmrsAddPos                    = DMRS_ADDITIONAL_POS;
801
802    pdsch->pdschFreqAlloc.resourceAllocType   = 1; /* RAT type-1 RIV format */
803    pdsch->pdschFreqAlloc.freqAlloc.startPrb  = offsetPointA + SCH_SSB_NUM_PRB + 1; /* the RB numbering starts from coreset0,
804                                                                             and PDSCH is always above SSB */
805    pdsch->pdschFreqAlloc.freqAlloc.numPrb    = schCalcNumPrb(tbSize,sib1SchCfg->sib1Mcs,numPdschSymbols);
806    pdsch->pdschFreqAlloc.vrbPrbMapping       = 0; /* non-interleaved */
807    pdsch->pdschTimeAlloc.rowIndex            = 1;
808    /* This is Intel's requirement. PDSCH should start after PDSCH DRMS symbol */
809    pdsch->pdschTimeAlloc.timeAlloc.startSymb = 3; /* spec-38.214, Table 5.1.2.1-1 */
810    pdsch->pdschTimeAlloc.timeAlloc.numSymb   = numPdschSymbols;
811    pdsch->beamPdschInfo.numPrgs              = 1;
812    pdsch->beamPdschInfo.prgSize              = 1;
813    pdsch->beamPdschInfo.digBfInterfaces      = 0;
814    pdsch->beamPdschInfo.prg[0].pmIdx         = 0;
815    pdsch->beamPdschInfo.prg[0].beamIdx[0]    = 0;
816    pdsch->txPdschPower.powerControlOffset    = 0;
817    pdsch->txPdschPower.powerControlOffsetSS  = 0;
818
819 }
820
821 /**
822  * @brief cell config from MAC to SCH.
823  *
824  * @details
825  *
826  *     Function : macSchCellCfgReq
827  *      
828  *      This API is invoked by MAC to send cell config to SCH
829  *           
830  *  @param[in]  Pst            *pst
831  *  @param[in]  SchCellCfg     *schCellCfg
832  *  @return  int
833  *      -# ROK 
834  *      -# RFAILED 
835  **/
836 uint8_t SchHdlCellCfgReq(Pst *pst, SchCellCfg *schCellCfg)
837 {
838    uint8_t ret = ROK;
839    SchCellCb *cellCb;
840    SchCellCfgCfm schCellCfgCfm;
841    Pst rspPst;
842    Inst inst = pst->dstInst-1; 
843
844    schInitCellCb(inst, schCellCfg);
845    cellCb = schCb[inst].cells[inst]; //cells is of MAX_CELLS, why inst
846    cellCb->macInst = pst->srcInst;
847
848    /* derive the SIB1 config parameters */
849    fillSchSib1Cfg(schCellCfg->numerology, schCellCfg->bandwidth, cellCb->numSlots,
850          &(schCellCfg->sib1SchCfg), schCellCfg->phyCellId,
851          schCellCfg->ssbSchCfg.ssbOffsetPointA);
852    memcpy(&cellCb->cellCfg, schCellCfg, sizeof(SchCellCfg));
853
854    /* Initializing global variables */
855    cellCb->actvUeBitMap = 0;
856    cellCb->boIndBitMap = 0;
857
858    /* Fill and send Cell config confirm */
859    memset(&rspPst, 0, sizeof(Pst));
860    FILL_PST_SCH_TO_MAC(rspPst, pst->dstInst);
861    rspPst.event = EVENT_SCH_CELL_CFG_CFM;
862
863    schCellCfgCfm.cellId = schCellCfg->cellId; 
864    schCellCfgCfm.rsp = RSP_OK;
865
866    ret = (*SchCellCfgCfmOpts[rspPst.selector])(&rspPst, &schCellCfgCfm);
867
868    return ret;
869
870 }
871
872 /*******************************************************************
873  *
874  * @brief Processes DL RLC BO info from MAC
875  *
876  * @details
877  *
878  *    Function : MacSchDlRlcBoInfo
879  *
880  *    Functionality:
881  *       Processes DL RLC BO info from MAC
882  *
883  * @params[in] 
884  * @return ROK     - success
885  *         RFAILED - failure
886  *
887  * ****************************************************************/
888 uint8_t MacSchDlRlcBoInfo(Pst *pst, DlRlcBoInfo *dlBoInfo)
889 {
890    uint8_t  lcId = 0;
891    uint16_t ueIdx = 0;
892    uint16_t slot;
893 #ifdef NR_TDD
894    uint16_t slotIdx = 0;
895 #endif
896    SchUeCb *ueCb = NULLP;
897    SchCellCb *cell = NULLP;
898    SchDlSlotInfo *schDlSlotInfo = NULLP;
899
900    Inst  inst = pst->dstInst-SCH_INST_START;
901    DU_LOG("\nDEBUG  -->  SCH : Received RLC BO Status indication");
902    cell = schCb[inst].cells[inst];
903
904    if(cell == NULLP)
905    {
906       DU_LOG("\nERROR  -->  SCH : MacSchDlRlcBoInfo(): Cell does not exists");
907       return RFAILED;
908    }
909
910    GET_UE_IDX(dlBoInfo->crnti, ueIdx);
911    ueCb = &cell->ueCb[ueIdx-1];
912    lcId  = dlBoInfo->lcId;
913
914    if(lcId == SRB1_LCID || lcId == SRB2_LCID || lcId == SRB3_LCID || \
915          (lcId >= MIN_DRB_LCID && lcId <= MAX_DRB_LCID))
916    {
917       SET_ONE_BIT(ueIdx, cell->boIndBitMap);
918       ueCb->dlInfo.dlLcCtxt[lcId].bo = dlBoInfo->dataVolume;
919    }
920    else if(lcId != SRB0_LCID)
921    {
922       DU_LOG("\nERROR  -->  SCH : Invalid LC Id %d in MacSchDlRlcBoInfo", lcId);
923       return RFAILED;
924    }
925
926    slot = (cell->slotInfo.slot + SCHED_DELTA + PHY_DELTA_DL + BO_DELTA) % cell->numSlots;
927 #ifdef NR_TDD
928    while(schGetSlotSymbFrmt(cell->slotFrmtBitMap, slot) != DL_SLOT)
929    {
930       slot = (slot + 1)%cell->numSlots;
931       slotIdx++;
932       if(slotIdx==cell->numSlots)
933       {
934          DU_LOG("\nERROR  -->  SCH : No DL Slot available");
935          return RFAILED;
936       }
937    }
938 #endif
939
940    schDlSlotInfo = cell->schDlSlotInfo[slot];
941
942    if(schDlSlotInfo == NULLP)
943    {
944       DU_LOG("\nERROR  -->  SCH : MacSchDlRlcBoInfo(): schDlSlotInfo does not exists");
945       return RFAILED;
946    }
947    SCH_ALLOC(schDlSlotInfo->dlMsgInfo, sizeof(DlMsgInfo));
948    if(schDlSlotInfo->dlMsgInfo == NULLP)
949    {
950       DU_LOG("\nERROR  -->  SCH : Memory allocation failed for dlMsgInfo");
951       schDlSlotInfo = NULL;
952       return RFAILED;
953    }
954    
955    schDlSlotInfo->dlMsgInfo->crnti = dlBoInfo->crnti;
956    schDlSlotInfo->dlMsgInfo->ndi = 1;
957    schDlSlotInfo->dlMsgInfo->harqProcNum = 0;
958    schDlSlotInfo->dlMsgInfo->dlAssignIdx = 0;
959    schDlSlotInfo->dlMsgInfo->pucchTpc = 0;
960    schDlSlotInfo->dlMsgInfo->pucchResInd = 0;
961    schDlSlotInfo->dlMsgInfo->harqFeedbackInd = 0;
962    schDlSlotInfo->dlMsgInfo->dciFormatId = 1;
963    if(lcId == SRB0_LCID)
964    {
965       schDlSlotInfo->dlMsgInfo->isMsg4Pdu = true;
966       schDlSlotInfo->dlMsgInfo->dlMsgPduLen = dlBoInfo->dataVolume;
967    }
968    return ROK;
969 }
970
971 /*******************************************************************
972  *
973  * @brief Processes BSR indiation from MAC
974  *
975  * @details
976  *
977  *    Function : MacSchBsr
978  *
979  *    Functionality:
980  *       Processes DL BSR from MAC
981  *
982  * @params[in]    Pst pst
983  *                UlBufferStatusRptInd bsrInd
984  * @return ROK     - success
985  *         RFAILED - failure
986  *
987  * ****************************************************************/
988 uint8_t MacSchBsr(Pst *pst, UlBufferStatusRptInd *bsrInd)
989 {
990    Inst           schInst       = pst->dstInst-SCH_INST_START;
991    SchCellCb      *cellCb       = NULLP;
992    SchUeCb        *ueCb         = NULLP;
993    uint8_t        lcgIdx;
994
995    DU_LOG("\nDEBUG  -->  SCH : Received BSR");
996    cellCb = schCb[schInst].cells[schInst];
997    ueCb = schGetUeCb(cellCb, bsrInd->crnti);
998
999    /* store dataVolume per lcg in uecb */
1000    for(lcgIdx = 0; lcgIdx < bsrInd->numLcg; lcgIdx++)
1001    {
1002       ueCb->bsrInfo[lcgIdx].priority = 1; //TODO: determining LCG priority?
1003       ueCb->bsrInfo[lcgIdx].dataVol = bsrInd->dataVolInfo[lcgIdx].dataVol;
1004    }
1005    return ROK;
1006 }
1007
1008 /*******************************************************************
1009  *
1010  * @brief Processes SR UCI indication from MAC 
1011  *
1012  * @details
1013  *
1014  *    Function : MacSchSrUciInd
1015  *
1016  *    Functionality:
1017  *      Processes SR UCI indication from MAC
1018  *
1019  * @params[in] Post structure
1020  *             UCI Indication
1021  * @return ROK     - success
1022  *         RFAILED - failure
1023  *
1024  * ****************************************************************/
1025 uint8_t MacSchSrUciInd(Pst *pst, SrUciIndInfo *uciInd)
1026 {
1027    Inst  inst = pst->dstInst-SCH_INST_START;
1028
1029    SchUeCb   *ueCb; 
1030    SchCellCb *cellCb = schCb[inst].cells[inst];
1031
1032    DU_LOG("\nDEBUG  -->  SCH : Received SR");
1033
1034    ueCb = schGetUeCb(cellCb, uciInd->crnti);
1035
1036    if(uciInd->numSrBits)
1037    {
1038       ueCb->srRcvd = true;
1039    }
1040    return ROK;
1041 }
1042 /**********************************************************************
1043   End of file
1044  **********************************************************************/