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 RADIO_FRAME_DURATION 10 /* Time duration of a radio frame in ms */
  57 /* MAX values */
  58 #define MAX_NUM_CELL 2 /* Changed to 2 to support cell Id 2 even if there is only one cell in DU */
  59 #define MAX_NUM_MU   4
  60 #define MAX_NUM_UE   3
  61 #define MAX_NUM_UE_PER_TTI 1
  62 #define MAX_NUM_LC   MAX_DRB_LCID + 1   /*Spec 38.331: Sec 6.4: maxLC-ID Keyword*/
  63 #define MAX_NUM_SRB  3    /* Max. no of Srbs */
  64 #define MAX_NUM_DRB  29   /* spec 38.331, maxDRB */
  65 #define MAX_NUM_SSB  64   /* spec 28.331, maxNrofSSBs */
  66
  67 /* 5G ORAN phy delay */
  68 #define PHY_DELTA_DL 1
  69 #define PHY_DELTA_UL 0
  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 #define ODU_UE_THROUGHPUT_PRINT_TIME_INTERVAL      5     /* in milliseconds */
 109 #define ODU_SNSSAI_THROUGHPUT_PRINT_TIME_INTERVAL  60000 /* in milliseconds */
 110
 111 /*Spec 38.331 Sec 6.4: Maximum number of paging occasion per paging frame*/
 112 #define MAX_PO_PER_PF 4
 113
 114 #ifdef NR_TDD
 115 #define MAX_SLOTS 20
 116 #else
 117 #define MAX_SLOTS 10
 118 #endif
 119
 120 #define MAX_SFN   1024
 121
 122 /* Defining macros for common utility functions */
 123 #define ODU_GET_MSG_BUF SGetMsg
 124 #define ODU_PUT_MSG_BUF SPutMsg
 125 #define ODU_ADD_PRE_MSG_MULT SAddPreMsgMult
 126 #define ODU_ADD_PRE_MSG_MULT_IN_ORDER SAddPreMsgMultInOrder
 127 #define ODU_ADD_POST_MSG_MULT SAddPstMsgMult
 128 #define ODU_START_TASK SStartTask
 129 #define ODU_STOP_TASK SStopTask
 130 #define ODU_ATTACH_TTSK SAttachTTsk
 131 #define ODU_POST_TASK SPstTsk
 132 #define ODU_COPY_MSG_TO_FIX_BUF SCpyMsgFix
 133 #define ODU_COPY_FIX_BUF_TO_MSG SCpyFixMsg
 134 #define ODU_REG_TTSK SRegTTsk
 135 #define ODU_SET_PROC_ID SSetProcId
 136 #define ODU_GET_MSG_LEN SFndLenMsg
 137 #define ODU_EXIT_TASK SExitTsk
 138 #define ODU_PRINT_MSG SPrntMsg
 139 #define ODU_REM_PRE_MSG SRemPreMsg
 140 #define ODU_REM_PRE_MSG_MULT SRemPreMsgMult
 141 #define ODU_REG_TMR_MT SRegTmrMt
 142 #define ODU_SEGMENT_MSG SSegMsg
 143 #define ODU_CAT_MSG SCatMsg
 144 #define ODU_GET_PROCID SFndProcId
 145 #define ODU_SET_THREAD_AFFINITY SSetAffinity
 146 #define ODU_CREATE_TASK SCreateSTsk
 147
 148 #define MAX_SYMB_PER_SLOT 14
 149
 150 /* Slice */
 151 #define SD_SIZE 3
 152
 153 #ifdef NR_TDD
 154 /* Maximum slots for max periodicity and highest numerology is 320.
 155  * However, aligning to fapi_interface.h, setting this macro to 160 */
 156 #define MAX_TDD_PERIODICITY_SLOTS 160
 157 #endif
 158
 159 #define GET_UE_ID( _crnti,_ueId)           \
 160 {                                          \
 161    _ueId = _crnti - ODU_START_CRNTI + 1;  \
 162 }
 163
 164 #define GET_CRNTI( _crnti, _ueId)          \
 165 {                                          \
 166    _crnti = _ueId + ODU_START_CRNTI - 1;  \
 167 }
 168
 169 /* Calculates cellIdx from cellId */
 170 #define GET_CELL_IDX(_cellId, _cellIdx)   \
 171 {                                         \
 172    _cellIdx = _cellId - 1;                \
 173 }
 174
 175 #define SET_BITS_MSB(_startBit, _numBits, _byte) \
 176 {                                                \
 177    _byte = (~((0xFF) >> _numBits));              \
 178        _byte >>= _startBit;                          \
 179 }
 180
 181 #define SET_BITS_LSB(_startBit, _numBits, _byte) \
 182 {                                                \
 183    _byte = (~((0xFF) << _numBits));              \
 184        _byte <<= _startBit;                          \
 185 }
 186
 187 /* this MACRO set 1 bit at the bit position */
 188 #define SET_ONE_BIT(_bitPos, _out)            \
 189 {                                             \
 190    _out = ((1<<_bitPos) | _out);              \
 191 }
 192
 193 /* this MACRO un-set 1 bit at the bit position */
 194 #define UNSET_ONE_BIT(_bitPos, _out)            \
 195 {                                               \
 196    _out = (~(1<<_bitPos) & _out);               \
 197 }
 198
 199 /* this MACRO finds the index of the rightmost set bit */
 200 #define GET_RIGHT_MOST_SET_BIT( _in,_bitPos)        \
 201 {                                                \
 202    _bitPos = __builtin_ctz(_in);                 \
 203 }
 204
 205 /* MACRO for checking CRNTI range*/
 206 #define CHECK_CRNTI(_crnti, _isCrntiValid)                                         \
 207 {                                                                   \
 208   _isCrntiValid = ((_crnti >= ODU_START_CRNTI && _crnti <= ODU_END_CRNTI ) ? 1 : 0); \
 209 }
 210
 211 #define CHECK_LCID(_lcId, _isLcidValid)      \
 212 {\
 213    _isLcidValid = ((_lcId >= SRB0_LCID && _lcId <= MAX_DRB_LCID) ? 1 : 0);\
 214 }
 215
 216 typedef enum
 217 {
 218    UE_CFG_INACTIVE,
 219    UE_CFG_INPROGRESS,
 220    UE_CREATE_COMPLETE,
 221    UE_DELETE_COMPLETE,
 222    UE_RECFG_COMPLETE
 223 }UeCfgState;
 224
 225 typedef enum
 226 {
 227    CONFIG_UNKNOWN,
 228    CONFIG_ADD,
 229    CONFIG_MOD,
 230    CONFIG_DEL
 231 }ConfigType;
 232
 233 #ifdef NR_TDD
 234 typedef enum
 235 {
 236    DL_SLOT,
 237    UL_SLOT,
 238    FLEXI_SLOT
 239 }SlotConfig;
 240
 241 typedef enum
 242 {
 243    TX_PRDCTY_MS_0P5,
 244    TX_PRDCTY_MS_0P625,
 245    TX_PRDCTY_MS_1,
 246    TX_PRDCTY_MS_1P25,
 247    TX_PRDCTY_MS_2,
 248    TX_PRDCTY_MS_2P5,
 249    TX_PRDCTY_MS_5,
 250    TX_PRDCTY_MS_10
 251 }DlUlTxPeriodicity;
 252 #endif
 253
 254 typedef enum
 255 {
 256    SCS_15KHZ,
 257    SCS_30KHZ,
 258    SCS_60KHZ,
 259    SCS_120KHZ,
 260    SCS_240KHZ
 261 }SCS;
 262
 263 typedef enum
 264 {
 265    SCS_5MS,
 266    SCS_10MS,
 267    SCS_20MS,
 268    SCS_40MS,
 269    SCS_80MS,
 270    SCS_160MS
 271 }ScsPeriodicity;
 272
 273 typedef enum
 274 {
 275    CELL_UP,
 276    CELL_DOWN
 277 }OduCellStatus;
 278
 279
 280 typedef enum
 281 {
 282    DIR_NONE,
 283    DIR_UL,
 284    DIR_DL,
 285    DIR_BOTH
 286 }Direction;
 287
 288 typedef enum
 289 {
 290    SEARCH,
 291    CREATE,
 292    DELETE,
 293    PRINT,
 294    TRAVERSE_ALL
 295 }ActionTypeLL;
 296
 297 typedef struct slotTimingInfo
 298 {
 299    uint16_t cellId;
 300    uint16_t sfn;
 301    uint16_t slot;
 302 }SlotTimingInfo;
 303
 304 typedef struct PlmnIdentity
 305 {
 306    uint8_t mcc[3];
 307    uint8_t mnc[3];
 308 }Plmn;
 309
 310 typedef struct snssai
 311 {
 312    uint8_t   sst;
 313    uint8_t   sd[SD_SIZE];
 314 }Snssai;
 315
 316 typedef struct oduCellId
 317 {
 318    uint16_t cellId;
 319 }OduCellId;
 320
 321 #ifdef NR_TDD
 322 typedef struct tddCfg
 323 {
 324    bool               pres;
 325    DlUlTxPeriodicity  tddPeriod;      /* DL UL Transmission periodicity */
 326    SlotConfig         slotCfg[MAX_TDD_PERIODICITY_SLOTS][MAX_SYMB_PER_SLOT];
 327 }TDDCfg;
 328 #endif
 329
 330 OduCellStatus gCellStatus;
 331 uint64_t gSlotCount;
 332 uint64_t gDlDataRcvdCnt;   /* Number of DL data received at EGTP */
 333
 334 void fillCoresetFeqDomAllocMap(uint16_t startPrb, uint16_t prbSize, uint8_t *freqDomain);
 335 void oduCpyFixBufToMsg(uint8_t *fixBuf, Buffer *mBuf, uint16_t len);
 336 uint8_t buildPlmnId(Plmn plmn, uint8_t *buf);
 337 uint16_t convertScsEnumValToScsVal(uint8_t scsEnumValue);
 338
 339 uint8_t SGetSBufNewForDebug(char *file, char *func, char *line, Region region, Pool pool, Data **ptr, Size size);
 340 uint8_t SPutSBufNewForDebug(char *file, char *func, char *line, Region region, Pool pool, Data *ptr, Size size);
 341 uint8_t SGetStaticBufNewForDebug(char *file, char *func, char *line, \
 342 Region region, Pool pool, Data **ptr, Size size, uint8_t memType);
 343 uint8_t SPutStaticBufNewForDebug(char *file, char *func, char *line, \
 344 Region region, Pool pool, Data *ptr, Size size, uint8_t memType);
 345 uint8_t countSetBits(uint32_t num);
 346
 347 #endif
 348
 349 /**********************************************************************
 350   End of file
 351 ***********************************************************************/