[Epic-ID: ODUHIGH-402][Task-ID: ODUHIGH-418] Harq feature changes
[o-du/l2.git] / src / 5gnrsch / sch_utils.h
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 #include <stdint.h>
20 #include <math.h>
21
22 /* Memory info */
23 #define SCH_MEM_REGION     4
24 #define SCH_POOL           1
25
26 /* macros */
27 #define MAX_CORESET_INDEX      16
28 #define MAX_SEARCH_SPACE_INDEX 16
29 #define MAX_RACH_NUM_RB_IDX    16
30 #define MAX_PUCCH_RES_SET_IDX  16
31 #define MAX_PRACH_CONFIG_IDX   256
32 #define MAX_MU_PUSCH           4
33 #define TOTAL_TBSIZE_VALUES    93
34 #define DEFAULT_UL_ACK_LIST_COUNT 8 /* Max number of pusch time domain uplink allocation */
35 #define MASK_BIT64_ON 0xFFFFFFFFFFFFFFFF
36 #define MIN_PRB 1
37
38 #define SET_BITS_MSB(_startBit, _numBits, _byte) \
39 {                                                \
40    _byte = (~((0xFF) >> _numBits));              \
41    _byte >>= _startBit;                          \
42 }
43
44 #define SET_BITS_LSB(_startBit, _numBits, _byte) \
45 {                                                \
46    _byte = (~((0xFF) << _numBits));              \
47    _byte <<= _startBit;                          \
48 }
49
50 /* allocate and zero out a static buffer */
51 #ifdef ODU_MEMORY_DEBUG_LOG
52 #define SCH_MEM_LOG(_macro, _file, _line, _func, _size, _datPtr)\
53 {\
54    printf("\n%s=== %s +%d, %s, %d, %p\n",           \
55          _macro, _file, _line, _func, _size, _datPtr); \
56 }
57 #else
58 #define SCH_MEM_LOG(_macro, _file, _line, _func, _size, _dataPtr) {}
59 #endif
60
61 #define SCH_ALLOC(_datPtr, _size)                               \
62 {                                                               \
63    uint8_t _ret;                                                    \
64    _ret = SGetSBuf(SCH_MEM_REGION, SCH_POOL,                    \
65           (Data **)&_datPtr, _size);                             \
66    if(_ret == ROK)                                              \
67    {  \
68       SCH_MEM_LOG("SCH_ALLOC", __FILE__, __LINE__, __FUNCTION__, _size, _datPtr);\
69       memset(_datPtr, 0, _size);                         \
70    }                                                            \
71    else                                                         \
72    {                                                            \
73       _datPtr = NULLP;                                          \
74    }                                                            \
75 }
76
77 /* free a static buffer */
78 #define SCH_FREE(_datPtr, _size)                                \
79 {                                                               \
80    if(_datPtr)                                                  \
81    {\
82       SCH_MEM_LOG("SCH_FREE", __FILE__, __LINE__, __FUNCTION__, _size, _datPtr);\
83       SPutSBuf(SCH_MEM_REGION, SCH_POOL,                        \
84             (Data *)_datPtr,(Size) _size);                            \
85       _datPtr = NULLP;                                          \
86    }                                                            \
87 }
88                           
89 /* Fill post structure for msg from SCH to MAC */
90 #define FILL_PST_SCH_TO_MAC(_pst, _inst)                     \
91 {                                                            \
92    _pst.srcProcId = ODU_GET_PROCID();                       \
93    _pst.dstProcId = ODU_GET_PROCID();                       \
94    _pst.srcEnt    = ENTMAC;                                  \
95    _pst.dstEnt    = ENTMAC;                                  \
96    _pst.srcInst   = 1;                                       \
97    _pst.dstInst   = 0;                                       \
98    _pst.selector  = ODU_SELECTOR_TC;                         \
99 }
100
101 /* Table array declarations */
102 int8_t coresetIdxTable[MAX_CORESET_INDEX][4];
103 int8_t searchSpaceIdxTable[MAX_SEARCH_SPACE_INDEX][4];
104 uint8_t defaultUlAckTbl[DEFAULT_UL_ACK_LIST_COUNT];
105 uint8_t minMsg3SchTime[MAX_NUM_MU];
106 uint8_t pucchResourceSet[MAX_PUCCH_RES_SET_IDX][4];
107 uint8_t puschDeltaTable[MAX_MU_PUSCH];
108 uint16_t prachCfgIdxTable[MAX_PRACH_CONFIG_IDX][8];
109 uint16_t numRbForPrachTable[MAX_RACH_NUM_RB_IDX][5];
110 uint8_t schCmnDlRvTbl[4];
111 /* Functions declarations : Linked list handler */
112 uint8_t addNodeToLList(CmLListCp *llist, void *blockToAdd, CmLList *currNode);
113 uint8_t deleteNodeFromLList(CmLListCp *llist, CmLList *node);
114
115 /* Functions declarations : Slot format handler */
116 #ifdef NR_TDD
117 SlotConfig schGetSlotSymbFrmt(uint16_t slot, uint32_t bitMap);
118 uint8_t calculateSlotPatternLength(uint8_t scs, uint8_t periodicity);
119 #endif
120
121 /* Functions declarations : Resource allocation handler */
122 uint16_t schCalcTbSize(uint32_t payLoadSize);
123 uint16_t schCalcNumPrb(uint16_t tbSize, uint16_t mcs, uint8_t numSymbols);
124 uint16_t schCalcTbSizeFromNPrb(uint16_t numPrb, uint16_t mcs, uint8_t numSymbols);
125 bool fillPrbBitmap(uint64_t *prbBitmap, uint16_t startPrb, uint16_t numPrb);
126 CmLList* isPrbAvailable(CmLListCp *freePrbBlockList, uint16_t startPrb, uint16_t numPrb);
127 void removeAllocatedPrbFromFreePrbList(CmLListCp *freePrbBlockList, CmLList *node, \
128    uint16_t startPrb, uint16_t numPrb);
129 uint8_t findDmrsStartSymbol(uint16_t dlDmrsSymbBitMap);
130 void covertFreqDomRsrcMapToIAPIFormat(uint8_t *sourceBitMap, uint8_t *destBitMap);
131
132 uint8_t updateLcListReqPRB(CmLListCp *lcLL, uint8_t lcId, uint32_t payloadSize);
133 uint32_t calculateEstimateTBSize(uint32_t reqBO, uint16_t mcsIdx,uint8_t numSymbols,\
134                                    uint16_t maxPRB, uint16_t *estPrb);
135 void deleteLcLL(CmLListCp *lcLL);
136
137 CmLList *schPageInfoSearchFromPageList(SlotTimingInfo slotInfo, CmLListCp *storedPageList);
138 void schDeleteFromPageInfoList(CmLListCp *list, CmLList *node);
139
140 #if 0
141 /*Will be enabled for debugging*/
142 void printLcLL(CmLListCp *lcLL);
143 #endif
144
145 /**********************************************************************
146   End of file
147  **********************************************************************/