src/cm/common_def.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 #ifndef __COMMON_DEF_H__
  19 #define __COMMON_DEF_H__
  20
  21 #include <stdio.h>
  22 #include <ctype.h>
  23 #include <stdlib.h>
  24 #include <string.h>
  25 #include <stdbool.h>
  26 #include <stdint.h>
  27
  28 #include "cm_mem.h"
  29 #include "envopt.h"
  30 #include "envdep.h"
  31 #include "envind.h"
  32 #include "gen.h"
  33 #include "ssi.h"
  34 #include "cm_math.h"
  35 #include "cm5.h"
  36 #include "cm_tkns.h"
  37 #include "cm_mblk.h"
  38 #include "cm_llist.h"
  39 #include "cm_hash.h"
  40 #include "cm_lte.h"
  41 #include "cm_err.h"
  42 #include "cm_tpt.h"
  43 #include "cm.h"
  44 #include "gen.x"           /* general */
  45 #include "ssi.x"           /* system services */
  46 #include "cm_tpt.x"
  47 #include "cm_tkns.x"
  48 #include "cm_mblk.x"
  49 #include "cm_llist.x"
  50 #include "cm5.x"
  51 #include "cm_hash.x"
  52 #include "cm_lte.x"
  53 #include "cm_lib.x"
  54 #include "du_log.h"
  55
  56 #define SCH_INST_START 1
  57 #define SCH_MAX_INST 1
  58
  59 /* MAX values */
  60 #define MAX_NUM_CELL 2 /* Changed to 2 to support cell Id 2 even if there is only one cell in DU */
  61 #define MAX_NUM_MU   4
  62 #define MAX_NUM_UE   3
  63 #define MAX_NUM_UE_PER_TTI 2
  64 #define MAX_NUM_LC   MAX_DRB_LCID + 1   /*Spec 38.331: Sec 6.4: maxLC-ID Keyword*/
  65 #define MAX_NUM_SRB  3    /* Max. no of Srbs */
  66 #define MAX_NUM_DRB  29   /* spec 38.331, maxDRB */
  67 #define MAX_NUM_SSB  64   /* spec 28.331, maxNrofSSBs */
  68 #define MAX_NUM_HARQ_PROC 16 /* spec 38.331, nrofHARQ-ProcessesForPDSCH */
  69 #define MAX_NUM_TB_PER_UE 2  /* spec 38.331, maxNrofCodeWordsScheduledByDCI */
  70
  71  /* SELECTORS */
  72 #define ODU_SELECTOR_LC 0
  73 #define ODU_SELECTOR_TC 1
  74 #define ODU_SELECTOR_LWLC 2
  75
  76 #define ODU_START_CRNTI   100
  77 #define ODU_END_CRNTI     500
  78
  79 /* LCID */
  80 #define SRB0_LCID  0
  81 #define SRB1_LCID  1
  82 #define SRB2_LCID  2
  83 #define SRB3_LCID  3
  84 #define MIN_DRB_LCID 4
  85 #define MAX_DRB_LCID 32
  86
  87 #define FREQ_DOM_RSRC_SIZE  6      /* i.e. 6 bytes because Size of frequency domain resource is 45 bits */
  88 #define PUCCH_FORMAT_0 0
  89 #define PUCCH_FORMAT_1 1
  90 #define PUCCH_FORMAT_2 2
  91 #define PUCCH_FORMAT_3 3
  92 #define PUCCH_FORMAT_4 4
  93
  94 #define DEFAULT_MCS 4
  95
  96 #define BANDWIDTH_20MHZ 20
  97 #define BANDWIDTH_100MHZ 100
  98
  99 /* PRB allocation as per 38.101, Section 5.3.2 */
 100 #define TOTAL_PRB_20MHZ_MU0 106
 101 #define TOTAL_PRB_100MHZ_MU1 273
 102 #ifdef NR_TDD
 103 #define MAX_NUM_RB TOTAL_PRB_100MHZ_MU1  /* value for numerology 1, 100 MHz */
 104 #else
 105 #define MAX_NUM_RB TOTAL_PRB_20MHZ_MU0 /* value for numerology 0, 20 MHz */
 106 #endif
 107
 108 /*Spec 38.331 Sec 6.4: Maximum number of paging occasion per paging frame*/
 109 #define MAX_PO_PER_PF 4
 110
 111 #ifdef NR_TDD
 112 #define MAX_SLOTS 20
 113 #else
 114 #define MAX_SLOTS 10
 115 #endif
 116
 117 #define MAX_SFN   1024
 118
 119 /*First SCS in kHz as per 3gpp spec 38.211 Table 4.2-1 */
 120 #define BASE_SCS 15
 121
 122 #define MAX_NUM_STATS_GRP 5 /* Max number of statistics group per configuration request */
 123 #define MAX_NUM_STATS 10    /* Max number of statistics per group */
 124
 125 /* Defining macros for common utility functions */
 126 #define ODU_GET_MSG_BUF SGetMsg
 127 #define ODU_PUT_MSG_BUF SPutMsg
 128 #define ODU_ADD_PRE_MSG_MULT SAddPreMsgMult
 129 #define ODU_ADD_PRE_MSG_MULT_IN_ORDER SAddPreMsgMultInOrder
 130 #define ODU_ADD_POST_MSG_MULT SAddPstMsgMult
 131 #define ODU_START_TASK SStartTask
 132 #define ODU_STOP_TASK SStopTask
 133 #define ODU_ATTACH_TTSK SAttachTTsk
 134 #define ODU_POST_TASK SPstTsk
 135 #define ODU_COPY_MSG_TO_FIX_BUF SCpyMsgFix
 136 #define ODU_COPY_FIX_BUF_TO_MSG SCpyFixMsg
 137 #define ODU_REG_TTSK SRegTTsk
 138 #define ODU_SET_PROC_ID SSetProcId
 139 #define ODU_GET_MSG_LEN SFndLenMsg
 140 #define ODU_EXIT_TASK SExitTsk
 141 #define ODU_PRINT_MSG SPrntMsg
 142 #define ODU_REM_PRE_MSG SRemPreMsg
 143 #define ODU_REM_PRE_MSG_MULT SRemPreMsgMult
 144 #define ODU_REM_POST_MSG_MULT SRemPstMsgMult
 145 #define ODU_REG_TMR_MT SRegTmrMt
 146 #define ODU_SEGMENT_MSG SSegMsg
 147 #define ODU_CAT_MSG SCatMsg
 148 #define ODU_GET_PROCID SFndProcId
 149 #define ODU_SET_THREAD_AFFINITY SSetAffinity
 150 #define ODU_CREATE_TASK SCreateSTsk
 151
 152 #define MAX_SYMB_PER_SLOT 14
 153
 154 /* Slice */
 155 #define SD_SIZE 3
 156
 157 #ifdef NR_TDD
 158 /* Maximum slots for max periodicity and highest numerology is 320.
 159  * However, aligning to fapi_interface.h, setting this macro to 160.
 160  * TODO : To support 160, FAPI_MAX_NUM_TLVS_CONFIG in fapi_interface.h
 161  * of Intel L1 must be incremented to a higher number */
 162 #define MAX_TDD_PERIODICITY_SLOTS 10
 163 #endif
 164
 165 #define GET_UE_ID( _crnti,_ueId)           \
 166 {                                          \
 167    _ueId = _crnti - ODU_START_CRNTI + 1;  \
 168 }
 169
 170 #define GET_CRNTI( _crnti, _ueId)          \
 171 {                                          \
 172    _crnti = _ueId + ODU_START_CRNTI - 1;  \
 173 }
 174
 175 /* Calculates cellIdx from cellId */
 176 #define GET_CELL_IDX(_cellId, _cellIdx)   \
 177 {                                         \
 178    _cellIdx = _cellId - 1;                \
 179 }
 180
 181 #define SET_BITS_MSB(_startBit, _numBits, _byte) \
 182 {                                                \
 183    _byte = (~((0xFF) >> _numBits));              \
 184        _byte >>= _startBit;                          \
 185 }
 186
 187 #define SET_BITS_LSB(_startBit, _numBits, _byte) \
 188 {                                                \
 189    _byte = (~((0xFF) << _numBits));              \
 190        _byte <<= _startBit;                          \
 191 }
 192
 193 /* this MACRO set 1 bit at the bit position */
 194 #define SET_ONE_BIT(_bitPos, _out)            \
 195 {                                             \
 196    _out = ((1<<_bitPos) | _out);              \
 197 }
 198
 199 /* this MACRO un-set 1 bit at the bit position */
 200 #define UNSET_ONE_BIT(_bitPos, _out)            \
 201 {                                               \
 202    _out = (~(1<<_bitPos) & _out);               \
 203 }
 204
 205 /* this MACRO finds the index of the rightmost set bit */
 206 #define GET_RIGHT_MOST_SET_BIT( _in,_bitPos)        \
 207 {                                                \
 208    _bitPos = __builtin_ctz(_in);                 \
 209 }
 210
 211 /* MACRO for checking CRNTI range*/
 212 #define CHECK_CRNTI(_crnti, _isCrntiValid)                                         \
 213 {                                                                   \
 214   _isCrntiValid = ((_crnti >= ODU_START_CRNTI && _crnti <= ODU_END_CRNTI ) ? 1 : 0); \
 215 }
 216
 217 #define CHECK_LCID(_lcId, _isLcidValid)      \
 218 {\
 219    _isLcidValid = ((_lcId >= SRB0_LCID && _lcId <= MAX_DRB_LCID) ? 1 : 0);\
 220 }
 221
 222 /**
 223  * @def TMR_CALCUATE_WAIT
 224  *
 225  *    This macro calculates and assigns wait time based on the value of the
 226  *    timer and the timer resolution. Timer value of 0 signifies that the
 227  *    timer is not configured
 228  *
 229  * @param[out] _wait   Time for which to arm the timer changed to proper
 230  *                     value according to the resolution
 231  * @param[in] _tmrVal   Value of the timer
 232  * @param[in] _timerRes   Resolution of the timer
 233  *
 234 */
 235 #define TMR_CALCUATE_WAIT(_wait, _tmrVal, _timerRes)          \
 236 {                                                             \
 237    (_wait) = ((_tmrVal) * SS_TICKS_SEC)/((_timerRes) * 1000); \
 238    if((0 != (_tmrVal)) && (0 == (_wait)))                     \
 239    {                                                          \
 240       (_wait) = 1;                                            \
 241    }                                                          \
 242 }
 243
 244 typedef enum
 245 {
 246    SUCCESSFUL,
 247    CELLID_INVALID,
 248    UEID_INVALID,
 249    RESOURCE_UNAVAILABLE,
 250    SLICE_NOT_FOUND,
 251    DUPLICATE_ENTRY,
 252    PARAM_INVALID,
 253    STATS_ID_NOT_FOUND
 254 }CauseOfResult ;
 255
 256 typedef enum
 257 {
 258    UE_CFG_INACTIVE,
 259    UE_CFG_INPROGRESS,
 260    UE_CREATE_COMPLETE,
 261    UE_DELETE_COMPLETE,
 262    UE_RECFG_COMPLETE,
 263    UE_RESET_COMPLETE
 264 }UeCfgState;
 265
 266 typedef enum
 267 {
 268    CONFIG_UNKNOWN,
 269    CONFIG_ADD,
 270    CONFIG_MOD,
 271    CONFIG_DEL,
 272    CONFIG_REESTABLISH
 273 }ConfigType;
 274
 275 #ifdef NR_TDD
 276 typedef enum
 277 {
 278    TX_PRDCTY_MS_0P5,
 279    TX_PRDCTY_MS_0P625,
 280    TX_PRDCTY_MS_1,
 281    TX_PRDCTY_MS_1P25,
 282    TX_PRDCTY_MS_2,
 283    TX_PRDCTY_MS_2P5,
 284    TX_PRDCTY_MS_5,
 285    TX_PRDCTY_MS_10
 286 }DlUlTxPeriodicity;
 287 #endif
 288
 289 typedef enum
 290 {
 291    SCS_15KHZ,
 292    SCS_30KHZ,
 293    SCS_60KHZ,
 294    SCS_120KHZ,
 295    SCS_240KHZ
 296 }SCS;
 297
 298 typedef enum
 299 {
 300    SSB_5MS,
 301    SSB_10MS,
 302    SSB_20MS,
 303    SSB_40MS,
 304    SSB_80MS,
 305    SSB_160MS
 306 }SSBPeriodicity;
 307
 308 typedef enum
 309 {
 310    CELL_UP,
 311    CELL_DOWN
 312 }OduCellStatus;
 313
 314
 315 typedef enum
 316 {
 317    DIR_NONE,
 318    DIR_UL,
 319    DIR_DL,
 320    DIR_BOTH
 321 }Direction;
 322
 323 typedef enum
 324 {
 325    SEARCH,
 326    CREATE,
 327    DELETE,
 328    PRINT,
 329    TRAVERSE_ALL
 330 }ActionTypeLL;
 331
 332 typedef struct slotTimingInfo
 333 {
 334    uint16_t cellId;
 335    uint16_t sfn;
 336    uint16_t slot;
 337 }SlotTimingInfo;
 338
 339 typedef struct PlmnIdentity
 340 {
 341    uint8_t mcc[3];
 342    uint8_t mnc[3];
 343 }Plmn;
 344
 345 typedef struct snssai
 346 {
 347    uint8_t   sst;
 348    uint8_t   sd[SD_SIZE];
 349 }Snssai;
 350
 351 typedef struct supportedSliceList
 352 {
 353    uint8_t    numSupportedSlices;
 354    Snssai    **snssai;
 355 }SupportedSliceList;
 356
 357 typedef struct oduCellId
 358 {
 359    uint16_t cellId;
 360 }OduCellId;
 361
 362 #ifdef NR_TDD
 363 typedef struct tddCfg
 364 {
 365    DlUlTxPeriodicity  tddPeriod;     /*DL UL Transmission periodicity */
 366    uint8_t            nrOfDlSlots;   /*No. of consecultive full DL slots at beginning of DL-UL pattern*/
 367    uint8_t            nrOfDlSymbols; /*No. of consecultive DL symbol at beginning of slot after last full DL slot*/
 368    uint8_t            nrOfUlSlots;   /*No. of consecutive full UL slots at the end of each DL-UL pattern*/
 369    uint8_t            nrOfUlSymbols; /*No. of consecutive UL symbols in the end of the slot before the first full UL slot*/
 370 }TDDCfg;
 371 #endif
 372
 373 typedef struct gConfiguration
 374 {
 375    uint8_t gPhyDeltaDl;
 376    uint8_t gPhyDeltaUl;
 377    uint8_t gUeThrptTimeIntervl;
 378    uint8_t gSnssaiThrptTimeIntervl;
 379    uint8_t gRadioFrameDuration;
 380    OduCellStatus gCellStatus;
 381    uint64_t gSlotCount;
 382    uint64_t gDlDataRcvdCnt;   /* Number of DL data received at EGTP */
 383 }GConfiguration;
 384
 385 GConfiguration gConfigInfo;
 386
 387 void fillCoresetFeqDomAllocMap(uint16_t startPrb, uint16_t prbSize, uint8_t *freqDomain);
 388 void oduCpyFixBufToMsg(uint8_t *fixBuf, Buffer *mBuf, uint16_t len);
 389 uint8_t buildPlmnId(Plmn plmn, uint8_t *buf);
 390 uint16_t convertScsEnumValToScsVal(uint8_t scsEnumValue);
 391 uint8_t convertScsValToScsEnum(uint32_t num);
 392 uint8_t convertSSBPeriodicityToEnum(uint32_t num);
 393
 394 uint8_t SGetSBufNewForDebug(char *file, const char *func, int line, Region region, Pool pool, Data **ptr, Size size);
 395 uint8_t SPutSBufNewForDebug(char *file, const char *func, int line, Region region, Pool pool, Data *ptr, Size size);
 396 uint8_t SGetStaticBufNewForDebug(char *file, const char *func, int line, \
 397 Region region, Pool pool, Data **ptr, Size size, uint8_t memType);
 398 uint8_t SPutStaticBufNewForDebug(char *file, const char *func, int line, \
 399 Region region, Pool pool, Data *ptr, Size size, uint8_t memType);
 400 uint8_t countSetBits(uint32_t num);
 401 uint32_t convertArfcnToFreqKhz(uint32_t arfcn);
 402 #endif
 403
 404 /**********************************************************************
 405   End of file
 406 ***********************************************************************/