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