JIRA ID: ODUHIGH-314 : Time domain allocation for SSB in TDD mode
[o-du/l2.git] / src / 5gnrmac / mac_cfg_hdl.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 /* This file stores handler for MAC and SCH configuration requests */
19 /* header include files (.h) */
20 #include "common_def.h"
21 #include "lrg.h"
22 #include "lrg.x"
23 #include "du_app_mac_inf.h"
24 #include "mac_sch_interface.h"
25 #include "lwr_mac_upr_inf.h"
26 #include "mac.h"
27 #include "rlc_mac_inf.h"
28 #include "mac_upr_inf_api.h"
29 #include "lwr_mac.h"
30 #include "lwr_mac_fsm.h"
31 #include "mac_utils.h"
32 #include "lwr_mac_phy.h"
33
34 uint8_t ssbPeriodicity[6] = {5, 10, 20, 40, 80, 160};
35
36 uint8_t MacSchCellCfgReq(Pst *pst, MacCellCfg  *macCellCfg);
37
38 packMacCellCfgConfirm packMacCellCfmOpts[] =
39 {
40    packMacCellCfgCfm,      /* packing for loosely coupled */
41    duHandleMacCellCfgCfm,      /* packing for tightly coupled */
42    packMacCellCfgCfm,    /* packing for light weight loosly coupled */
43 };
44
45 SchCellCfgFunc SchCellCfgOpts[] =
46 {
47    packSchCellCfg,   /* packing for loosely coupled */
48    SchHdlCellCfgReq, /* packing for tightly coupled */
49    packSchCellCfg    /* packing for light weight loosly coupled */
50 };
51
52
53 /**
54  * @brief Layer Manager  Configuration request handler for Scheduler
55  *
56  * @details
57  *
58  *     Function : MacSchGenCfgReq
59  *
60  *     This function receives general configurations for Scheduler
61  *     from DU APP and forwards to Scheduler.
62  *
63  *  @param[in]  Pst *pst, the post structure
64  *  @param[in]  RgMngmt *cfg, the configuration parameter's structure
65  *  @return 
66  *      -# ROK
67  **/
68 uint8_t MacSchGenCfgReq(Pst *pst, RgMngmt *cfg)
69 {
70    printf("\nReceived Scheduler gen config at MAC");
71    pst->dstInst = DEFAULT_CELLS + 1;
72    SchProcGenCfgReq(pst, cfg);
73
74    return ROK;
75 }
76
77 /**
78  * @brief Layer Manager Configuration response from Scheduler
79  *
80  * @details
81  *
82  *     Function : SchSendCfgCfm
83  *
84  *     This function sends general configurations response from
85  *     Scheduler to DU APP.
86  *
87  *  @param[in]  Pst *pst, the post structure
88  *  @param[in]  RgMngmt *cfm, the configuration confirm structure
89  *  @return 
90  *      -# ROK
91  **/
92 uint8_t SchSendCfgCfm(Pst *pst, RgMngmt  *cfm)
93 {
94    DU_LOG("\nDEBUG  -->  Sending Scheduler config confirm to DU APP");
95    pst->dstEnt = ENTDUAPP;
96    pst->dstInst = 0;
97    pst->srcInst = 0;
98    pst->selector = ODU_SELECTOR_LC;
99    RgMiLrgSchCfgCfm(pst, cfm);
100
101    return ROK;
102 }
103
104 /**
105  * @brief Layer Manager Configuration request handler.
106  *
107  * @details
108  *
109  *     Function : MacProcCellCfgReq
110  *
111  *     This function handles the gNB and cell configuration
112  *     request received from DU APP.
113  *     This API unapcks and forwards the config towards SCH
114  *
115  *  @param[in]  Pst           *pst
116  *  @param[in]  MacCellCfg    *macCellCfg
117  *  @return  
118  *      -# ROK
119  **/
120 uint8_t MacProcCellCfgReq(Pst *pst, MacCellCfg *macCellCfg)
121 {
122    Pst cfmPst;
123    uint16_t cellIdx;
124    uint8_t ret = ROK;
125    MacCellCb     *macCellCb;
126
127    memset((uint8_t *)&cfmPst, 0, sizeof(Pst));
128
129    MAC_ALLOC(macCellCb, sizeof(MacCellCb));
130    if(macCellCb == NULLP)
131    {
132       DU_LOG("\nERROR  -->  MAC : macCellCb is NULL at handling of macCellCfg\n");
133       return RFAILED;
134    }
135    memset(macCellCb, 0, sizeof(MacCellCb));
136
137    GET_CELL_IDX(macCellCfg->cellId, cellIdx);
138    macCb.macCell[cellIdx] = macCellCb;
139    macCb.macCell[cellIdx]->cellId = macCellCfg->cellId;
140    memcpy(&macCb.macCell[cellIdx]->macCellCfg, macCellCfg, sizeof(MacCellCfg));
141
142    MAC_ALLOC(macCb.macCell[cellIdx]->macCellCfg.sib1Cfg.sib1Pdu, \
143          macCb.macCell[cellIdx]->macCellCfg.sib1Cfg.sib1PduLen);
144    if(macCb.macCell[cellIdx]->macCellCfg.sib1Cfg.sib1Pdu == NULLP)
145    {
146       DU_LOG("\nERROR  -->  MAC : macCellCb is NULL at handling of sib1Pdu of macCellCfg\n");
147       return RFAILED;
148    }
149    memcpy(macCb.macCell[cellIdx]->macCellCfg.sib1Cfg.sib1Pdu, macCellCfg->sib1Cfg.sib1Pdu, \
150          macCb.macCell[cellIdx]->macCellCfg.sib1Cfg.sib1PduLen);
151
152    /* Send cell cfg to scheduler */
153    ret = MacSchCellCfgReq(pst, macCellCfg);
154    if(ret != ROK)
155    {
156       MacCellCfgCfm macCellCfgCfm;
157       macCellCfgCfm.rsp = RSP_NOK;
158       macCellCfgCfm.cellId = macCellCfg->cellId;
159       /* Fill Pst */
160       FILL_PST_MAC_TO_DUAPP(cfmPst, EVENT_MAC_CELL_CONFIG_CFM);
161       cfmPst.selector  = ODU_SELECTOR_LC;
162
163       ret = (*packMacCellCfmOpts[cfmPst.selector])(&cfmPst,&macCellCfgCfm);
164    }
165    else
166    {
167       if(macCellCfg->prachCfg.fdm[0].numUnusedRootSeq != 0)
168       {
169          MAC_FREE_SHRABL_BUF(pst->region, pst->pool, macCellCfg->prachCfg.fdm[0].unsuedRootSeq,
170                macCellCfg->prachCfg.fdm[0].numUnusedRootSeq* sizeof(uint8_t));
171       }
172       MAC_FREE_SHRABL_BUF(pst->region, pst->pool, macCellCfg->sib1Cfg.sib1Pdu, macCellCfg->sib1Cfg.sib1PduLen);
173       MAC_FREE_SHRABL_BUF(pst->region, pst->pool, macCellCfg ,sizeof(MacCellCfg));
174    }
175    return ret;
176 } /* end of MacProcCellCfgReq */
177
178 /**
179  * @brief Layer Manager Configuration request handler.
180  *
181  * @details
182  *
183  *     Function : MacSchCellCfgReq
184  *
185  *     This function sends cell configuration to SCH
186  *
187  *  @param[in]  Pst           *pst
188  *  @param[in]  MacCellCfg    *macCellCfg
189  *  @return  
190  *      -# ROK
191  **/
192 uint8_t MacSchCellCfgReq(Pst *pst, MacCellCfg *macCellCfg)
193 {
194    SchCellCfg schCellCfg;
195    Pst        cfgPst;
196    uint8_t    ret =0;
197
198    memset(&cfgPst, 0, sizeof(Pst));
199    memset(&schCellCfg, 0, sizeof(SchCellCfg));
200    schCellCfg.cellId = macCellCfg->cellId;
201    schCellCfg.phyCellId = macCellCfg->phyCellId;
202    schCellCfg.numerology = macCellCfg->numerology;
203    schCellCfg.dupMode = macCellCfg->dupType;
204    schCellCfg.bandwidth = macCellCfg->dlCarrCfg.bw;
205    schCellCfg.dlFreq = macCellCfg->dlCarrCfg.freq;
206    schCellCfg.ulFreq = macCellCfg->ulCarrCfg.freq;
207
208    /* fill ssb scheduler parameters */
209    schCellCfg.ssbSchCfg.ssbPbchPwr = macCellCfg->ssbCfg.ssbPbchPwr;
210    schCellCfg.ssbSchCfg.scsCommon = macCellCfg->ssbCfg.scsCmn;
211    schCellCfg.ssbSchCfg.ssbOffsetPointA = macCellCfg->ssbCfg.ssbOffsetPointA;
212    schCellCfg.ssbSchCfg.ssbPeriod = ssbPeriodicity[macCellCfg->ssbCfg.ssbPeriod];
213    schCellCfg.ssbSchCfg.ssbSubcOffset = macCellCfg->ssbCfg.ssbScOffset;
214    for(uint8_t idx=0; idx<SSB_MASK_SIZE; idx++)
215    {
216       schCellCfg.ssbSchCfg.nSSBMask[idx] = macCellCfg->ssbCfg.ssbMask[idx];
217    }
218
219    /* fill SIB1 scheduler parameters */
220    schCellCfg.sib1SchCfg.sib1PduLen = macCellCfg->sib1Cfg.sib1PduLen;
221    schCellCfg.sib1SchCfg.sib1RepetitionPeriod = macCellCfg->sib1Cfg.sib1RepetitionPeriod;
222    schCellCfg.sib1SchCfg.coresetZeroIndex = macCellCfg->sib1Cfg.coresetZeroIndex;
223    schCellCfg.sib1SchCfg.searchSpaceZeroIndex = macCellCfg->sib1Cfg.searchSpaceZeroIndex;
224    schCellCfg.sib1SchCfg.sib1Mcs = macCellCfg->sib1Cfg.sib1Mcs;
225
226    /* fill RACH config params */
227    schCellCfg.schRachCfg.prachCfgIdx = macCellCfg->prachCfg.prachCfgIdx;
228    schCellCfg.schRachCfg.prachSubcSpacing = \
229                                             macCellCfg->prachCfg.prachSubcSpacing;
230    schCellCfg.schRachCfg.msg1FreqStart = macCellCfg->prachCfg.msg1FreqStart;
231    schCellCfg.schRachCfg.msg1Fdm       = macCellCfg->prachCfg.msg1Fdm;
232    schCellCfg.schRachCfg.rootSeqLen    = macCellCfg->prachCfg.rootSeqLen;
233    schCellCfg.schRachCfg.rootSeqIdx    = macCellCfg->prachCfg.fdm[0].rootSeqIdx;
234    schCellCfg.schRachCfg.numRootSeq    = macCellCfg->prachCfg.fdm[0].numRootSeq;
235    schCellCfg.schRachCfg.k1            = macCellCfg->prachCfg.fdm[0].k1;
236    schCellCfg.schRachCfg.ssbPerRach    = macCellCfg->prachCfg.ssbPerRach;
237    schCellCfg.schRachCfg.prachMultCarrBand = \
238                                              macCellCfg->prachCfg.prachMultCarrBand;
239    schCellCfg.schRachCfg.raContResTmr  = macCellCfg->prachCfg.raContResTmr;
240    schCellCfg.schRachCfg.rsrpThreshSsb = macCellCfg->prachCfg.rsrpThreshSsb;
241    schCellCfg.schRachCfg.raRspWindow   = macCellCfg->prachCfg.raRspWindow;
242
243    /* fill initial DL BWP */
244    schCellCfg.schInitialDlBwp.bwp.freqAlloc.startPrb = macCellCfg->initialDlBwp.bwp.firstPrb;
245    schCellCfg.schInitialDlBwp.bwp.freqAlloc.numPrb = macCellCfg->initialDlBwp.bwp.numPrb;
246    schCellCfg.schInitialDlBwp.bwp.scs = macCellCfg->initialDlBwp.bwp.scs;
247    schCellCfg.schInitialDlBwp.bwp.cyclicPrefix = macCellCfg->initialDlBwp.bwp.cyclicPrefix;
248    schCellCfg.schInitialDlBwp.pdcchCommon.commonSearchSpace.searchSpaceId =
249       macCellCfg->initialDlBwp.pdcchCommon.commonSearchSpace.searchSpaceId;
250    schCellCfg.schInitialDlBwp.pdcchCommon.commonSearchSpace.coresetId =
251       macCellCfg->initialDlBwp.pdcchCommon.commonSearchSpace.coresetId;
252    schCellCfg.schInitialDlBwp.pdcchCommon.commonSearchSpace.monitoringSlot =
253       macCellCfg->initialDlBwp.pdcchCommon.commonSearchSpace.monitoringSlot;
254    schCellCfg.schInitialDlBwp.pdcchCommon.commonSearchSpace.duration =
255       macCellCfg->initialDlBwp.pdcchCommon.commonSearchSpace.duration;
256    schCellCfg.schInitialDlBwp.pdcchCommon.commonSearchSpace.monitoringSymbol =
257       macCellCfg->initialDlBwp.pdcchCommon.commonSearchSpace.monitoringSymbol;
258    schCellCfg.schInitialDlBwp.pdcchCommon.commonSearchSpace.candidate.aggLevel1 =
259       macCellCfg->initialDlBwp.pdcchCommon.commonSearchSpace.candidate.aggLevel1;
260    schCellCfg.schInitialDlBwp.pdcchCommon.commonSearchSpace.candidate.aggLevel2 =
261       macCellCfg->initialDlBwp.pdcchCommon.commonSearchSpace.candidate.aggLevel2;
262    schCellCfg.schInitialDlBwp.pdcchCommon.commonSearchSpace.candidate.aggLevel4 =
263       macCellCfg->initialDlBwp.pdcchCommon.commonSearchSpace.candidate.aggLevel4;
264    schCellCfg.schInitialDlBwp.pdcchCommon.commonSearchSpace.candidate.aggLevel8 =
265       macCellCfg->initialDlBwp.pdcchCommon.commonSearchSpace.candidate.aggLevel8;
266    schCellCfg.schInitialDlBwp.pdcchCommon.commonSearchSpace.candidate.aggLevel16 =
267       macCellCfg->initialDlBwp.pdcchCommon.commonSearchSpace.candidate.aggLevel16;
268    schCellCfg.schInitialDlBwp.pdschCommon.k0 = macCellCfg->initialDlBwp.pdschCommon.k0;
269    schCellCfg.schInitialDlBwp.pdschCommon.mappingType =
270       macCellCfg->initialDlBwp.pdschCommon.mappingType;
271    schCellCfg.schInitialDlBwp.pdschCommon.startSymbol =
272       macCellCfg->initialDlBwp.pdschCommon.startSymbol;
273    schCellCfg.schInitialDlBwp.pdschCommon.lengthSymbol =
274       macCellCfg->initialDlBwp.pdschCommon.lengthSymbol;
275
276    /* fill initial UL BWP */
277    schCellCfg.schInitialUlBwp.bwp.freqAlloc.startPrb = macCellCfg->initialUlBwp.bwp.firstPrb;
278    schCellCfg.schInitialUlBwp.bwp.freqAlloc.numPrb = macCellCfg->initialUlBwp.bwp.numPrb;
279    schCellCfg.schInitialUlBwp.bwp.scs = macCellCfg->initialUlBwp.bwp.scs;
280    schCellCfg.schInitialUlBwp.bwp.cyclicPrefix = macCellCfg->initialUlBwp.bwp.cyclicPrefix;
281    schCellCfg.schInitialUlBwp.puschCommon.k2 = macCellCfg->initialUlBwp.puschCommon.k2;
282    schCellCfg.schInitialUlBwp.puschCommon.mappingType =
283       macCellCfg->initialUlBwp.puschCommon.mappingType;
284    schCellCfg.schInitialUlBwp.puschCommon.startSymbol =
285       macCellCfg->initialUlBwp.puschCommon.startSymbol;
286    schCellCfg.schInitialUlBwp.puschCommon.lengthSymbol =
287       macCellCfg->initialUlBwp.puschCommon.lengthSymbol;
288 #ifdef NR_TDD
289    memcpy(&schCellCfg.tddCfg, &macCellCfg->tddCfg, sizeof(TDDCfg));
290 #endif
291
292    FILL_PST_MAC_TO_SCH(cfgPst, EVENT_SCH_CELL_CFG);
293
294    ret = (*SchCellCfgOpts[cfgPst.selector])(&cfgPst, &schCellCfg);
295    return ret;
296 } /* end of MacSchCellCfgReq */
297
298
299 /*******************************************************************
300  *
301  * @brief Sends Cell config confirm to DU APP
302  *
303  * @details
304  *
305  *    Function : MacSendCellCfgCfm
306  *
307  *    Functionality:
308  *      Sends Cell config confirm to DU APP
309  *
310  * @params[in] Response status
311  * @return void
312  *
313  * ****************************************************************/
314 void MacSendCellCfgCfm(uint16_t cellId, uint8_t response)
315 {
316    Pst pst;
317    uint16_t   cellIdx;
318    MacCellCfgCfm macCellCfgCfm;
319
320    memset(&pst, 0, sizeof(Pst));
321
322    GET_CELL_IDX(cellId, cellIdx);
323    macCellCfgCfm.cellId = macCb.macCell[cellIdx]->macCellCfg.cellId;
324    macCellCfgCfm.rsp = response;
325
326    /* Fill Pst */
327    FILL_PST_MAC_TO_DUAPP(pst, EVENT_MAC_CELL_CONFIG_CFM);
328    pst.selector  = ODU_SELECTOR_LC;
329
330    (*packMacCellCfmOpts[pst.selector])(&pst,&macCellCfgCfm);
331 }
332
333
334 /**
335  * @brief Layer Manager Configuration response handler.
336  *
337  * @details
338  *
339  *     Function : MacProcSchCellCfgCfm
340  *
341  *     This function processes cell configuration to SCH
342  *
343  *  @param[in]  Pst           *pst
344  *  @param[in]  SchCellCfgCfm *schCellCfgCfm
345  *  @return  int
346  *      -# ROK
347  **/
348 uint8_t MacProcSchCellCfgCfm(Pst *pst, SchCellCfgCfm *schCellCfgCfm)
349 {
350    uint16_t *cellId = NULLP;
351
352    if(schCellCfgCfm->rsp == RSP_OK)
353    {
354       cellId = &schCellCfgCfm->cellId;
355 #ifdef INTEL_TIMER_MODE
356       sendToLowerMac(UL_IQ_SAMPLE, 0, (void *)cellId);
357 #else
358       sendToLowerMac(CONFIG_REQUEST, 0, (void *)cellId);
359 #endif
360    }
361    else
362    {
363       MacSendCellCfgCfm(schCellCfgCfm->cellId, RSP_NOK);
364    }
365    return ROK;
366 }
367
368 /*******************************************************************
369  *
370  * @brief MAC handler for config response from PHY
371  *
372  * @details
373  *
374  *    Function : fapiMacConfigRsp
375  *
376  *    Functionality:
377  *     Processes config response from PHY and sends cell config
378  *     confirm to DU APP
379  *
380  * @params[in]
381  * @return void
382  *
383  * ****************************************************************/
384 void fapiMacConfigRsp(uint16_t cellId)
385 {
386    /* TODO : Processing of config response from PHY */
387
388    /* Send cell config cfm to DU APP */
389    MacSendCellCfgCfm(cellId, RSP_OK);
390 }
391
392 /**********************************************************************
393   End of file
394  **********************************************************************/