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 MEM_SIZE_CHECK
  52 #define SCH_MEMORY_ALLOC_SIZE_LOG(_line, _func, _size) \
  53 {\
  54    DU_LOG("\n SCH line = %d, func = %s, _size= %d ", _line, _func, _size); \
  55 }
  56 #else
  57 #define SCH_MEMORY_ALLOC_SIZE_LOG(_line, _func, _size) {}
  58 #endif
  59
  60 #ifdef ODU_MEMORY_DEBUG_LOG
  61 #define SCH_MEM_LOG(_macro, _file, _line, _func, _size, _datPtr)\
  62 {\
  63    printf("\n%s,=== %s +%d, %s, %lu, %p \n",           \
  64          _macro, _file, _line, _func, (uint64_t)_size, (void *)_datPtr); \
  65 }
  66 #else
  67 #define SCH_MEM_LOG(_macro, _file, _line, _func, _size, _dataPtr) {}
  68 #endif
  69
  70 #define SCH_ALLOC(_datPtr, _size)                               \
  71 {                                                               \
  72    SCH_MEMORY_ALLOC_SIZE_LOG(__LINE__, __FUNCTION__, _size);         \
  73    uint8_t _ret;                                                \
  74    _ret = SGetSBuf(SCH_MEM_REGION, SCH_POOL,                    \
  75           (Data **)&_datPtr, _size);                             \
  76    if(_ret == ROK)                                              \
  77    {  \
  78       SCH_MEM_LOG("SCH,ALLOC", __FILE__, __LINE__, __FUNCTION__, _size, _datPtr);\
  79       memset(_datPtr, 0, _size);                         \
  80    }                                                            \
  81    else                                                         \
  82    {                                                            \
  83       _datPtr = NULLP;                                          \
  84    }                                                            \
  85 }
  86
  87 /* free a static buffer */
  88 #define SCH_FREE(_datPtr, _size)                                \
  89 {                                                               \
  90    if(_datPtr)                                                  \
  91    {\
  92       SCH_MEM_LOG("SCH,FREE", __FILE__, __LINE__, __FUNCTION__, _size, _datPtr);\
  93       SPutSBuf(SCH_MEM_REGION, SCH_POOL,                        \
  94             (Data *)_datPtr,(Size) _size);                            \
  95       _datPtr = NULLP;                                          \
  96    }                                                            \
  97 }
  98
  99 /* Fill post structure for msg from SCH to MAC */
 100 #define FILL_PST_SCH_TO_MAC(_pst, _inst)                     \
 101 {                                                            \
 102    _pst.srcProcId = ODU_GET_PROCID();                       \
 103    _pst.dstProcId = ODU_GET_PROCID();                       \
 104    _pst.srcEnt    = ENTMAC;                                  \
 105    _pst.dstEnt    = ENTMAC;                                  \
 106    _pst.srcInst   = 1;                                       \
 107    _pst.dstInst   = 0;                                       \
 108    _pst.selector  = ODU_SELECTOR_TC;                         \
 109 }
 110
 111
 112 /* Table array declarations */
 113 extern int8_t coresetIdxTable[MAX_CORESET_INDEX][4];
 114 extern int8_t searchSpaceIdxTable[MAX_SEARCH_SPACE_INDEX][4];
 115 extern uint8_t defaultUlAckTbl[DEFAULT_UL_ACK_LIST_COUNT];
 116 extern uint8_t minMsg3SchTime[MAX_NUM_MU];
 117 extern uint8_t pucchResourceSet[MAX_PUCCH_RES_SET_IDX][5];
 118 extern uint8_t puschDeltaTable[MAX_MU_PUSCH];
 119 extern uint16_t prachCfgIdxTable[MAX_PRACH_CONFIG_IDX][8];
 120 extern uint16_t numRbForPrachTable[MAX_RACH_NUM_RB_IDX][5];
 121 extern uint8_t schCmnDlRvTbl[4];
 122
 123 /* Functions declarations : Linked list handler */
 124 uint8_t addNodeToLList(CmLListCp *llist, void *blockToAdd, CmLList *currNode);
 125 uint8_t deleteNodeFromLList(CmLListCp *llist, CmLList *node);
 126
 127 /* Functions declarations : Slot format handler */
 128 #ifdef NR_TDD
 129 SlotConfig schGetSlotSymbFrmt(uint16_t slot, uint32_t bitMap);
 130 uint8_t calculateSlotPatternLength(uint8_t scs, uint8_t periodicity);
 131 #endif
 132
 133 /* Functions declarations : Resource allocation handler */
 134 uint16_t schCalcTbSize(uint32_t payLoadSize);
 135 uint16_t schCalcNumPrb(uint16_t tbSize, uint16_t mcs, uint8_t numSymbols);
 136 uint16_t schCalcTbSizeFromNPrb(uint16_t numPrb, uint16_t mcs, uint8_t numSymbols);
 137 bool fillPrbBitmap(uint64_t *prbBitmap, uint16_t startPrb, uint16_t numPrb);
 138 CmLList* isPrbAvailable(CmLListCp *freePrbBlockList, uint16_t startPrb, uint16_t numPrb);
 139 void removeAllocatedPrbFromFreePrbList(CmLListCp *freePrbBlockList, CmLList *node, \
 140    uint16_t startPrb, uint16_t numPrb);
 141 uint8_t findDmrsStartSymbol(uint16_t dlDmrsSymbBitMap);
 142
 143 uint8_t updateLcListReqPRB(CmLListCp *lcLL, uint8_t lcId, uint32_t payloadSize);
 144 uint32_t calculateEstimateTBSize(uint32_t reqBO, uint16_t mcsIdx,uint8_t numSymbols,\
 145                                    uint16_t maxPRB, uint16_t *estPrb);
 146 void deleteLcLL(CmLListCp *lcLL);
 147
 148 CmLList *schPageInfoSearchFromPageList(SlotTimingInfo slotInfo, CmLListCp *storedPageList);
 149 void schDeleteFromPageInfoList(CmLListCp *list, CmLList *node);
 150
 151 uint8_t countRBGFrmCoresetFreqRsrc(uint8_t *freqDomainRsrc);
 152 uint8_t findSsStartSymbol(uint8_t *mSymbolsWithinSlot);
 153 void fillCqiAggLvlMapping(SchPdcchInfo *pdcchInfo);
 154 uint8_t schUpdValY(SchUeCb *ueCb, SchPdcchInfo *pdcchInfo);
 155 uint16_t extractStartPrbForRBG(uint8_t *freqDomaRsrc, uint8_t rbgIndex);
 156 uint16_t schConvertSlotPeriodicityEnumToValue(SchMSlotPeriodicity slotPeriod);
 157 uint8_t extractNumOfCandForAggLvl(SchSearchSpace *searchSpace, uint8_t aggLvl);
 158 #if 0
 159 /*Will be enabled for debugging*/
 160 void printLcLL(CmLListCp *lcLL);
 161 #endif
 162
 163 /**********************************************************************
 164   End of file
 165  **********************************************************************/