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 "cm_math.h"
  30 #include "envopt.h"
  31 #include "envdep.h"
  32 #include "envind.h"
  33 #include "gen.h"
  34 #include "ssi.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_math.x"
  47 #include "cm_tpt.x"
  48 #include "cm_tkns.x"
  49 #include "cm_mblk.x"
  50 #include "cm_llist.x"
  51 #include "cm5.x"
  52 #include "cm_hash.x"
  53 #include "cm_lte.x"
  54 #include "cm_lib.x"
  55 #include "du_log.h"
  56
  57 /* MAX values */
  58 #define MAX_NUM_CELL 1
  59 #define MAX_NUM_UE   1
  60 #define MAX_NUM_LC   11
  61 #define MAX_NUM_SRB  3    /* Max. no of Srbs */
  62 #define MAX_NUM_DRB  29   /* spec 38.331, maxDRB */
  63
  64 /* 5G ORAN phy delay */
  65 #define PHY_DELTA 2
  66
  67  /* SELECTORS */
  68 #define ODU_SELECTOR_LC 0
  69 #define ODU_SELECTOR_TC 1
  70 #define ODU_SELECTOR_LWLC 2
  71
  72 #define ODU_START_CRNTI   100
  73 #define ODU_END_CRNTI     500
  74
  75 /* LCID */
  76 #define SRB0_LCID  0
  77 #define SRB1_LCID  1
  78 #define SRB2_LCID  2
  79 #define SRB3_LCID  3
  80 #define MIN_DRB_LCID 4
  81 #define MAX_DRB_LCID 32
  82
  83 #define FREQ_DOM_RSRC_SIZE  6      /* i.e. 6 bytes because Size of frequency domain resource is 45 bits */
  84 #define PUCCH_FORMAT_0 0
  85 #define PUCCH_FORMAT_1 1
  86 #define PUCCH_FORMAT_2 2
  87 #define PUCCH_FORMAT_3 3
  88 #define PUCCH_FORMAT_4 4
  89
  90 #define BANDWIDTH_20MHZ 20
  91 #define BANDWIDTH_100MHZ 100
  92
  93 /* PRB allocation as per 38.101, Section 5.3.2 */
  94 #define TOTAL_PRB_20MHZ_MU0 106
  95 #define TOTAL_PRB_100MHZ_MU1 273
  96
  97 /* Defining macros for common utility functions */
  98 #define ODU_GET_MSG_BUF SGetMsg
  99 #define ODU_PUT_MSG_BUF SPutMsg
 100 #define ODU_ADD_PRE_MSG_MULT SAddPreMsgMult
 101 #define ODU_ADD_PRE_MSG_MULT_IN_ORDER SAddPreMsgMultInOrder
 102 #define ODU_ADD_POST_MSG_MULT SAddPstMsgMult
 103 #define ODU_START_TASK SStartTask
 104 #define ODU_STOP_TASK SStopTask
 105 #define ODU_ATTACH_TTSK SAttachTTsk
 106 #define ODU_POST_TASK SPstTsk
 107 #define ODU_COPY_MSG_TO_FIX_BUF SCpyMsgFix
 108 #define ODU_COPY_FIX_BUF_TO_MSG SCpyFixMsg
 109 #define ODU_REG_TTSK SRegTTsk
 110 #define ODU_SET_PROC_ID SSetProcId
 111 #define ODU_GET_MSG_LEN SFndLenMsg
 112 #define ODU_EXIT_TASK SExitTsk
 113 #define ODU_PRINT_MSG SPrntMsg
 114 #define ODU_REM_PRE_MSG SRemPreMsg
 115 #define ODU_REM_PRE_MSG_MULT SRemPreMsgMult
 116 #define ODU_REG_TMR_MT SRegTmrMt
 117 #define ODU_SEGMENT_MSG SSegMsg
 118 #define ODU_CAT_MSG SCatMsg
 119 #define ODU_GET_PROCID SFndProcId
 120 #define ODU_SET_THREAD_AFFINITY SSetAffinity
 121 #define ODU_CREATE_TASK SCreateSTsk
 122
 123 #ifdef NR_TDD
 124 /* Maximum slots for max periodicity and highest numerology is 320.
 125  * However, aligning to fapi_interface.h, setting this macro to 160 */
 126 #define MAX_TDD_PERIODICITY_SLOTS 160
 127 #define MAX_SYMB_PER_SLOT 14
 128 #endif
 129
 130 #define GET_UE_IDX( _crnti,_ueIdx)         \
 131 {                                          \
 132    _ueIdx = _crnti - ODU_START_CRNTI + 1;  \
 133 }
 134
 135 #define GET_CRNTI( _crnti,_ueIdx)          \
 136 {                                          \
 137    _crnti = _ueIdx + ODU_START_CRNTI - 1;  \
 138 }
 139
 140 /* Calculates cellIdx from cellId */
 141 #define GET_CELL_IDX(_cellId, _cellIdx)   \
 142 {                                         \
 143    _cellIdx = _cellId - 1;                \
 144 }
 145
 146 #define SET_BITS_MSB(_startBit, _numBits, _byte) \
 147 {                                                \
 148    _byte = (~((0xFF) >> _numBits));              \
 149        _byte >>= _startBit;                          \
 150 }
 151
 152 #define SET_BITS_LSB(_startBit, _numBits, _byte) \
 153 {                                                \
 154    _byte = (~((0xFF) << _numBits));              \
 155        _byte <<= _startBit;                          \
 156 }
 157
 158 /* this MACRO set 1 bit at the bit position */
 159 #define SET_ONE_BIT(_bitPos, _out)            \
 160 {                                             \
 161    _out = ((1<<_bitPos) | _out);              \
 162 }
 163
 164 /* this MACRO un-set 1 bit at the bit position */
 165 #define UNSET_ONE_BIT(_bitPos, _out)            \
 166 {                                               \
 167    _out = (~(1<<_bitPos) & _out);               \
 168 }
 169
 170 /* this MACRO finds the index of the rightmost set bit */
 171 #define GET_RIGHT_MOST_SET_BIT( _in,_bitPos)        \
 172 {                                                \
 173    _bitPos = __builtin_ctz(_in);                 \
 174 }
 175
 176 typedef enum
 177 {
 178    UE_CFG_INACTIVE,
 179    UE_CREATE_COMPLETE,
 180    UE_RECFG_COMPLETE
 181 }UeCfgState;
 182
 183 typedef enum
 184 {
 185    CONFIG_UNKNOWN,
 186    CONFIG_ADD,
 187    CONFIG_MOD,
 188    CONFIG_DEL
 189 }ConfigType;
 190
 191 #ifdef NR_TDD
 192 typedef enum
 193 {
 194    DL_SLOT,
 195    UL_SLOT,
 196    FLEXI_SLOT
 197 }SlotConfig;
 198
 199 typedef enum
 200 {
 201    TX_PRDCTY_MS_0P5,
 202    TX_PRDCTY_MS_0P625,
 203    TX_PRDCTY_MS_1,
 204    TX_PRDCTY_MS_1P25,
 205    TX_PRDCTY_MS_2,
 206    TX_PRDCTY_MS_2P5,
 207    TX_PRDCTY_MS_5,
 208    TX_PRDCTY_MS_10
 209 }DlUlTxPeriodicity;
 210 #endif
 211
 212 typedef enum
 213 {
 214    SCS_15KHZ,
 215    SCS_30KHZ,
 216    SCS_60KHZ,
 217    SCS_120KHZ,
 218    SCS_240KHZ
 219 }SCS;
 220
 221 typedef struct slotIndInfo
 222 {
 223    uint16_t cellId;
 224    uint16_t sfn;
 225    uint16_t slot;
 226 }SlotIndInfo;
 227
 228 typedef struct PlmnIdentity
 229 {
 230    uint8_t mcc[3];
 231    uint8_t mnc[3];
 232 }Plmn;
 233
 234 typedef struct oduCellId
 235 {
 236    uint16_t cellId;
 237 }OduCellId;
 238
 239 #ifdef NR_TDD
 240 typedef struct tddCfg
 241 {
 242    bool               pres;
 243    DlUlTxPeriodicity  tddPeriod;      /* DL UL Transmission periodicity */
 244    SlotConfig         slotCfg[MAX_TDD_PERIODICITY_SLOTS][MAX_SYMB_PER_SLOT];
 245 }TDDCfg;
 246 #endif
 247
 248
 249 uint64_t gSlotCount;
 250 uint64_t gDlDataRcvdCnt;   /* Number of DL data received at EGTP */
 251
 252 void freqDomRscAllocType0(uint16_t startPrb, uint16_t prbSize, uint8_t *freqDomain);
 253 void oduCpyFixBufToMsg(uint8_t *fixBuf, Buffer *mBuf, uint16_t len);
 254 uint8_t buildPlmnId(Plmn plmn, uint8_t *buf);
 255
 256 #endif
 257
 258 /**********************************************************************
 259   End of file
 260 ***********************************************************************/