Merge "Replaced old SSI function with new macros jira id - ODUHIGH-212"
[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 extern SchCb schCb[SCH_MAX_INST];
46 extern uint8_t puschDeltaTable[MAX_MU_PUSCH];
47
48 /**
49  * @brief calculate ra-rnti function. 
50  *
51  * @details
52  *
53  *     Function : calculateRaRnti
54  *     
55  *     This function calculates ra-rnti
56  *     
57  *  @param[in]  symbol index
58  *  @param[in]  slot index
59  *  @param[in]  frequency index
60  *  @return  ra-rnti
61  **/
62 uint16_t calculateRaRnti(uint8_t symbolIdx, uint8_t slotIdx, uint8_t freqIdx)
63 {
64    uint16_t raRnti = 0;
65         uint8_t ulCarrierIdx = 0; /* configured to 0 */
66    raRnti = (1+symbolIdx+(14*slotIdx)+(14*80*freqIdx)+(14*80*8*ulCarrierIdx));
67         return raRnti;
68 }
69
70 /**
71  * @brief create raCb function. 
72  *
73  * @details
74  *
75  *     Function : createSchRaCb
76  *     
77  *     This function create raCb
78  *     
79  *  @param[in]  tcrnti
80  *  @param[in]  shed instance
81  *  @return  void
82  **/
83 void createSchRaCb(uint16_t tcrnti, Inst schInst)
84 {
85    schCb[schInst].cells[schInst]->raCb[0].tcrnti = tcrnti;
86 }
87
88 /**
89  * @brief resource allocation for msg3 PUSCH
90  *
91  * @details
92  *
93  *     Function : schAllocMsg3Pusch 
94  *     
95  *     This function handles msg3 PUSCH allocation
96  *     
97  *  @param[in]  Inst schInst, SCH instance
98  *  @param[in]  slot, current slot
99  *  @param[out]  msg3StartRb
100  *  @param[out]  msg3NumRb
101  *  @return  void
102  **/
103 uint8_t schAllocMsg3Pusch(Inst schInst, uint16_t slot, uint16_t *msg3StartRb,
104 uint8_t *msg3NumRb)
105 {
106    SchCellCb      *cell         = NULLP;
107    SchUlSlotInfo  *schUlSlotInfo    = NULLP;
108    uint8_t    puschMu       = 0;
109    uint8_t    msg3SlotAlloc = 0;
110    uint8_t    delta         = 0;
111    uint8_t    k2            = 0; 
112    uint8_t    startSymb     = 0;
113    uint8_t    symbLen       = 0; 
114    uint8_t    startRb       = 0;
115    uint8_t    numRb         = 0;
116    uint8_t    idx           = 0;
117    uint8_t    mcs            = 4;
118    uint8_t    numPdschSymbols= 14;
119    uint16_t   tbSize         = 0;
120
121
122    cell = schCb[schInst].cells[schInst];
123    //   puschMu = cell->cellCfg.puschMu;
124    delta = puschDeltaTable[puschMu];
125    k2 = cell->cellCfg.schInitialUlBwp.puschCommon.k2;
126    startSymb = cell->cellCfg.schInitialUlBwp.puschCommon.startSymbol;
127    symbLen = cell->cellCfg.schInitialUlBwp.puschCommon.lengthSymbol;
128
129    /* Slot allocation for msg3 based on 38.214 section 6.1.2.1 */
130    msg3SlotAlloc = slot + k2 + delta;
131    msg3SlotAlloc = msg3SlotAlloc % SCH_NUM_SLOTS; 
132
133    startRb = cell->schUlSlotInfo[msg3SlotAlloc]->puschCurrentPrb;
134    tbSize = schCalcTbSize(8); /* 6 bytes msg3  and 2 bytes header */
135    numRb = schCalcNumPrb(tbSize, mcs, numPdschSymbols);
136
137    /* allocating 1 extra RB for now */
138    numRb++;
139    /* increment PUSCH PRB */
140    cell->schUlSlotInfo[msg3SlotAlloc]->puschCurrentPrb += numRb;
141
142    for(idx=startSymb; idx<symbLen; idx++)
143    {
144       cell->schUlSlotInfo[msg3SlotAlloc]->assignedPrb[idx] = startRb + numRb;
145    }
146    schUlSlotInfo = cell->schUlSlotInfo[msg3SlotAlloc];
147
148    SCH_ALLOC(schUlSlotInfo->schPuschInfo, sizeof(SchPuschInfo));
149    if(!schUlSlotInfo->schPuschInfo)
150    {
151       DU_LOG("SCH: Memory allocation failed in schAllocMsg3Pusch");
152       return RFAILED;
153    }
154    schUlSlotInfo->schPuschInfo->harqProcId        = SCH_HARQ_PROC_ID;
155    schUlSlotInfo->schPuschInfo->resAllocType      = SCH_ALLOC_TYPE_1;
156    schUlSlotInfo->schPuschInfo->fdAlloc.startPrb  = startRb;
157    schUlSlotInfo->schPuschInfo->fdAlloc.numPrb    = numRb;
158    schUlSlotInfo->schPuschInfo->tdAlloc.startSymb = startSymb;
159    schUlSlotInfo->schPuschInfo->tdAlloc.numSymb   = symbLen;
160    schUlSlotInfo->schPuschInfo->tbInfo.mcs             = mcs;
161    schUlSlotInfo->schPuschInfo->tbInfo.ndi        = 1; /* new transmission */
162    schUlSlotInfo->schPuschInfo->tbInfo.rv               = 0;
163    schUlSlotInfo->schPuschInfo->tbInfo.tbSize     = 24; /*Considering 2 PRBs */
164    schUlSlotInfo->schPuschInfo->dmrsMappingType   = DMRS_MAP_TYPE_A;  /* Setting Type-A */
165    schUlSlotInfo->schPuschInfo->nrOfDmrsSymbols   = NUM_DMRS_SYMBOLS;
166    schUlSlotInfo->schPuschInfo->dmrsAddPos        = DMRS_ADDITIONAL_POS;
167
168    *msg3StartRb = startRb;
169    *msg3NumRb   = numRb;
170
171    return ROK;
172 }
173
174
175
176 /**
177  * @brief process rach indication function. 
178  *
179  * @details
180  *
181  *     Function : schProcessRachInd
182  *     
183  *     This function process rach indication
184  *     
185  *  @param[in]  rachInd parameters
186  *  @param[in]  shed instance
187  *  @return  ROK
188  **/
189 uint8_t schProcessRachInd(RachIndInfo *rachInd, Inst schInst)
190 {
191    SchCellCb *cell = schCb[schInst].cells[schInst];
192    RarInfo *rarInfo = NULLP;
193    uint16_t raRnti = 0;
194    uint16_t rarSlot = 0;
195    uint16_t msg3StartRb;
196    uint8_t  msg3NumRb;
197    uint8_t  ret = ROK;
198
199    /* RAR will sent with a delay of RAR_DELAY */
200    rarSlot = (rachInd->timingInfo.slot+RAR_DELAY+PHY_DELTA)%SCH_NUM_SLOTS;
201
202    SchDlSlotInfo *schDlSlotInfo = cell->schDlSlotInfo[rarSlot]; /* RAR will sent in the next slot */
203
204    /* Allocate the rarInfo, this pointer will be checked at schProcessSlotInd function */
205    SCH_ALLOC(rarInfo, sizeof(RarInfo));
206    if(rarInfo == NULLP)
207    {
208       DU_LOG("\nMAC: Memory Allocation failed for rarInfo");
209       return RFAILED;
210    }
211
212    schDlSlotInfo->rarInfo = rarInfo;
213
214    /* calculate the ra-rnti value */
215    raRnti = calculateRaRnti(rachInd->symbolIdx,rachInd->slotIdx,rachInd->freqIdx);
216
217    /* create raCb at SCH */
218    createSchRaCb(rachInd->crnti,schInst);
219
220    /* allocate resources for msg3 */
221    ret = schAllocMsg3Pusch(schInst, rarSlot, &msg3StartRb, &msg3NumRb);
222    if(ret == ROK)
223    {
224       /* fill RAR info */
225       rarInfo->raRnti                 = raRnti;
226       rarInfo->tcrnti                 = rachInd->crnti;
227       rarInfo->RAPID                  = rachInd->preambleIdx;
228       rarInfo->ta                     = rachInd->timingAdv;
229       rarInfo->msg3FreqAlloc.startPrb = msg3StartRb;
230       rarInfo->msg3FreqAlloc.numPrb   = msg3NumRb;
231    }
232    return ret;
233 }
234
235 /**
236  * @brief fill RAR info function. 
237  *
238  * @details
239  *
240  *     Function : calculateRaRnti
241  *     
242  *     This function fills pdcch and pdsch info for RAR
243  *     
244  *  @param[in]  rar Allocation info
245  *  @param[in]  ra-rnti
246  *  @param[in]  PCI
247  *  @param[in]  offset to pointA to determine freq alloc
248  *  @return  ROK
249  **/
250 uint8_t schFillRar(RarAlloc *rarAlloc, uint16_t raRnti, uint16_t pci, uint8_t offsetPointA)
251 {
252    Inst inst = 0;
253    uint8_t coreset0Idx = 0;
254    uint8_t numRbs = 0;
255    uint8_t firstSymbol = 0;
256    uint8_t numSymbols = 0;
257    uint8_t offset = 0;
258    uint8_t FreqDomainResource[6] = {0};
259    uint16_t tbSize = 0;
260    uint8_t numPdschSymbols = 12; /* considering pdsch region from 2 to 13 */
261    uint8_t mcs = 4;  /* MCS fixed to 4 */
262
263    SchBwpDlCfg *initialBwp = &schCb[inst].cells[inst]->cellCfg.schInitialDlBwp;
264
265    PdcchCfg *pdcch = &rarAlloc->rarPdcchCfg;
266    PdschCfg *pdsch = &rarAlloc->rarPdschCfg;
267    BwpCfg *bwp = &rarAlloc->bwp;
268
269    coreset0Idx     = initialBwp->pdcchCommon.commonSearchSpace.coresetId;
270
271    /* derive the sib1 coreset0 params from table 13-1 spec 38.213 */
272    numRbs        = coresetIdxTable[coreset0Idx][1];
273    numSymbols    = coresetIdxTable[coreset0Idx][2];
274    offset        = coresetIdxTable[coreset0Idx][3];
275
276    /* calculate time domain parameters */
277    // note: since slot value is made sl1, RAR can be sent at all slots
278    uint16_t mask = 0x2000;
279    for(firstSymbol=0; firstSymbol<14;firstSymbol++)
280    {
281       if(initialBwp->pdcchCommon.commonSearchSpace.monitoringSymbol & mask)
282          break;
283       else
284          mask = mask>>1;
285    }
286
287    /* calculate the PRBs */
288    schAllocFreqDomRscType0(((offsetPointA-offset)/6), (numRbs/6), FreqDomainResource);
289
290    /* fill BWP */
291    bwp->freqAlloc.numPrb   = initialBwp->bwp.freqAlloc.numPrb;
292    bwp->freqAlloc.startPrb = initialBwp->bwp.freqAlloc.startPrb;
293    bwp->subcarrierSpacing  = initialBwp->bwp.scs;
294    bwp->cyclicPrefix       = initialBwp->bwp.cyclicPrefix;
295
296    /* fill the PDCCH PDU */
297    pdcch->coreset0Cfg.startSymbolIndex = firstSymbol;
298    pdcch->coreset0Cfg.durationSymbols = numSymbols;
299    memcpy(pdcch->coreset0Cfg.freqDomainResource,FreqDomainResource,6);
300    pdcch->coreset0Cfg.cceRegMappingType = 1; /* coreset0 is always interleaved */
301    pdcch->coreset0Cfg.regBundleSize = 6;    /* spec-38.211 sec 7.3.2.2 */
302    pdcch->coreset0Cfg.interleaverSize = 2;  /* spec-38.211 sec 7.3.2.2 */
303    pdcch->coreset0Cfg.coreSetType = 0;
304    pdcch->coreset0Cfg.shiftIndex = pci;
305    pdcch->coreset0Cfg.precoderGranularity = 0; /* sameAsRegBundle */
306    pdcch->numDlDci = 1;
307    pdcch->dci.rnti = raRnti; /* RA-RNTI */
308    pdcch->dci.scramblingId = pci;
309    pdcch->dci.scramblingRnti = 0;
310    pdcch->dci.cceIndex = 4; /* considering SIB1 is sent at cce 0-1-2-3 */
311    pdcch->dci.aggregLevel = 4;
312    pdcch->dci.beamPdcchInfo.numPrgs = 1;
313    pdcch->dci.beamPdcchInfo.prgSize = 1;
314    pdcch->dci.beamPdcchInfo.digBfInterfaces = 0;
315    pdcch->dci.beamPdcchInfo.prg[0].pmIdx = 0;
316    pdcch->dci.beamPdcchInfo.prg[0].beamIdx[0] = 0;
317    pdcch->dci.txPdcchPower.powerValue = 0;
318    pdcch->dci.txPdcchPower.powerControlOffsetSS = 0;
319    pdcch->dci.pdschCfg = pdsch;
320
321    /* fill the PDSCH PDU */
322    uint8_t cwCount = 0;
323    pdsch->pduBitmap = 0; /* PTRS and CBG params are excluded */
324    pdsch->rnti = raRnti; /* RA-RNTI */
325    pdsch->pduIndex = 0;
326    pdsch->numCodewords = 1;
327    for(cwCount = 0; cwCount < pdsch->numCodewords; cwCount++)
328    {
329       pdsch->codeword[cwCount].targetCodeRate = 308;
330       pdsch->codeword[cwCount].qamModOrder = 2;
331       pdsch->codeword[cwCount].mcsIndex = mcs; /* mcs configured to 4 */
332       pdsch->codeword[cwCount].mcsTable = 0;   /* notqam256 */
333       pdsch->codeword[cwCount].rvIndex = 0;
334       tbSize = schCalcTbSize(10); /* 8 bytes RAR and 2 bytes padding */
335       pdsch->codeword[cwCount].tbSize = tbSize;
336    }
337    pdsch->dataScramblingId = pci;
338    pdsch->numLayers = 1;
339    pdsch->transmissionScheme = 0;
340    pdsch->refPoint = 0;
341    pdsch->dmrs.dlDmrsSymbPos = 2;
342    pdsch->dmrs.dmrsConfigType = 0; /* type-1 */
343    pdsch->dmrs.dlDmrsScramblingId = pci;
344    pdsch->dmrs.scid = 0;
345    pdsch->dmrs.numDmrsCdmGrpsNoData = 1;
346    pdsch->dmrs.dmrsPorts = 0;
347    pdsch->dmrs.mappingType      = DMRS_MAP_TYPE_A;  /* Type-A */
348    pdsch->dmrs.nrOfDmrsSymbols  = NUM_DMRS_SYMBOLS;
349    pdsch->dmrs.dmrsAddPos       = DMRS_ADDITIONAL_POS;
350    pdsch->pdschFreqAlloc.resourceAllocType = 1; /* RAT type-1 RIV format */
351    pdsch->pdschFreqAlloc.freqAlloc.startPrb = offset + SCH_SSB_NUM_PRB; /* the RB numbering starts from coreset0, and PDSCH is always above SSB */ 
352    pdsch->pdschFreqAlloc.freqAlloc.numPrb = schCalcNumPrb(tbSize,mcs,numPdschSymbols);
353    pdsch->pdschFreqAlloc.vrbPrbMapping = 0; /* non-interleaved */
354    pdsch->pdschTimeAlloc.timeAlloc.startSymb = initialBwp->pdschCommon.startSymbol;
355    pdsch->pdschTimeAlloc.timeAlloc.numSymb = initialBwp->pdschCommon.lengthSymbol;
356    pdsch->beamPdschInfo.numPrgs = 1;
357    pdsch->beamPdschInfo.prgSize = 1;
358    pdsch->beamPdschInfo.digBfInterfaces = 0;
359    pdsch->beamPdschInfo.prg[0].pmIdx = 0;
360    pdsch->beamPdschInfo.prg[0].beamIdx[0] = 0;
361    pdsch->txPdschPower.powerControlOffset = 0;
362    pdsch->txPdschPower.powerControlOffsetSS = 0;
363
364    return ROK;
365 }
366
367 /**********************************************************************
368          End of file
369 **********************************************************************/