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