1 /*******************************************************************************
2 ################################################################################
3 # Copyright (c) [2017-2019] [Radisys] #
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 #
9 # http://www.apache.org/licenses/LICENSE-2.0 #
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__
44 #include "gen.x" /* general */
45 #include "ssi.x" /* system services */
56 #define RADIO_FRAME_DURATION 10 /* Time duration of a radio frame in ms */
58 #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_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 */
67 /* 5G ORAN phy delay */
68 #define PHY_DELTA_DL 1
69 #define PHY_DELTA_UL 0
72 #define ODU_SELECTOR_LC 0
73 #define ODU_SELECTOR_TC 1
74 #define ODU_SELECTOR_LWLC 2
76 #define ODU_START_CRNTI 100
77 #define ODU_END_CRNTI 500
84 #define MIN_DRB_LCID 4
85 #define MAX_DRB_LCID 32
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
96 #define BANDWIDTH_20MHZ 20
97 #define BANDWIDTH_100MHZ 100
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
103 #define MAX_NUM_RB TOTAL_PRB_100MHZ_MU1 /* value for numerology 1, 100 MHz */
105 #define MAX_NUM_RB TOTAL_PRB_20MHZ_MU0 /* value for numerology 0, 20 MHz */
108 #define ODU_UE_THROUGHPUT_PRINT_TIME_INTERVAL 5 /* in milliseconds */
109 #define ODU_SNSSAI_THROUGHPUT_PRINT_TIME_INTERVAL 60000 /* in milliseconds */
111 /*Spec 38.331 Sec 6.4: Maximum number of paging occasion per paging frame*/
112 #define MAX_PO_PER_PF 4
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
148 #define MAX_SYMB_PER_SLOT 14
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
159 #define GET_UE_ID( _crnti,_ueId) \
161 _ueId = _crnti - ODU_START_CRNTI + 1; \
164 #define GET_CRNTI( _crnti, _ueId) \
166 _crnti = _ueId + ODU_START_CRNTI - 1; \
169 /* Calculates cellIdx from cellId */
170 #define GET_CELL_IDX(_cellId, _cellIdx) \
172 _cellIdx = _cellId - 1; \
175 #define SET_BITS_MSB(_startBit, _numBits, _byte) \
177 _byte = (~((0xFF) >> _numBits)); \
178 _byte >>= _startBit; \
181 #define SET_BITS_LSB(_startBit, _numBits, _byte) \
183 _byte = (~((0xFF) << _numBits)); \
184 _byte <<= _startBit; \
187 /* this MACRO set 1 bit at the bit position */
188 #define SET_ONE_BIT(_bitPos, _out) \
190 _out = ((1<<_bitPos) | _out); \
193 /* this MACRO un-set 1 bit at the bit position */
194 #define UNSET_ONE_BIT(_bitPos, _out) \
196 _out = (~(1<<_bitPos) & _out); \
199 /* this MACRO finds the index of the rightmost set bit */
200 #define GET_RIGHT_MOST_SET_BIT( _in,_bitPos) \
202 _bitPos = __builtin_ctz(_in); \
205 /* MACRO for checking CRNTI range*/
206 #define CHECK_CRNTI(_crnti, _isCrntiValid) \
208 _isCrntiValid = ((_crnti >= ODU_START_CRNTI && _crnti <= ODU_END_CRNTI ) ? 1 : 0); \
211 #define CHECK_LCID(_lcId, _isLcidValid) \
213 _isLcidValid = ((_lcId >= SRB0_LCID && _lcId <= MAX_DRB_LCID) ? 1 : 0);\
297 typedef struct slotTimingInfo
304 typedef struct PlmnIdentity
310 typedef struct snssai
316 typedef struct oduCellId
322 typedef struct tddCfg
325 DlUlTxPeriodicity tddPeriod; /* DL UL Transmission periodicity */
326 SlotConfig slotCfg[MAX_TDD_PERIODICITY_SLOTS][MAX_SYMB_PER_SLOT];
330 OduCellStatus gCellStatus;
332 uint64_t gDlDataRcvdCnt; /* Number of DL data received at EGTP */
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);
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);
349 /**********************************************************************
351 ***********************************************************************/