89b5d8985a3d6f088310ae204216dde24bea7f2c
[o-du/l2.git] / 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 1
59 #define MAX_NUM_MU   4
60 #define MAX_NUM_UE   2
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
66 /* 5G ORAN phy delay */
67 #define PHY_DELTA_DL 1
68 #define PHY_DELTA_UL 0
69
70  /* SELECTORS */ 
71 #define ODU_SELECTOR_LC 0
72 #define ODU_SELECTOR_TC 1
73 #define ODU_SELECTOR_LWLC 2
74
75 #define ODU_START_CRNTI   100
76 #define ODU_END_CRNTI     500
77
78 /* LCID */
79 #define SRB0_LCID  0
80 #define SRB1_LCID  1
81 #define SRB2_LCID  2
82 #define SRB3_LCID  3
83 #define MIN_DRB_LCID 4
84 #define MAX_DRB_LCID 32
85
86 #define FREQ_DOM_RSRC_SIZE  6      /* i.e. 6 bytes because Size of frequency domain resource is 45 bits */
87 #define PUCCH_FORMAT_0 0
88 #define PUCCH_FORMAT_1 1
89 #define PUCCH_FORMAT_2 2
90 #define PUCCH_FORMAT_3 3 
91 #define PUCCH_FORMAT_4 4
92
93 #define DEFAULT_MCS 4
94
95 #define BANDWIDTH_20MHZ 20
96 #define BANDWIDTH_100MHZ 100
97
98 /* PRB allocation as per 38.101, Section 5.3.2 */
99 #define TOTAL_PRB_20MHZ_MU0 106
100 #define TOTAL_PRB_100MHZ_MU1 273
101 #ifdef NR_TDD
102 #define MAX_NUM_RB TOTAL_PRB_100MHZ_MU1  /* value for numerology 1, 100 MHz */
103 #else
104 #define MAX_NUM_RB TOTAL_PRB_20MHZ_MU0 /* value for numerology 0, 20 MHz */
105 #endif
106
107 #define ODU_THROUGHPUT_PRINT_TIME_INTERVAL  5 /* in milliseconds */
108
109 /* Defining macros for common utility functions */
110 #define ODU_GET_MSG_BUF SGetMsg
111 #define ODU_PUT_MSG_BUF SPutMsg
112 #define ODU_ADD_PRE_MSG_MULT SAddPreMsgMult
113 #define ODU_ADD_PRE_MSG_MULT_IN_ORDER SAddPreMsgMultInOrder
114 #define ODU_ADD_POST_MSG_MULT SAddPstMsgMult
115 #define ODU_START_TASK SStartTask
116 #define ODU_STOP_TASK SStopTask
117 #define ODU_ATTACH_TTSK SAttachTTsk
118 #define ODU_POST_TASK SPstTsk
119 #define ODU_COPY_MSG_TO_FIX_BUF SCpyMsgFix
120 #define ODU_COPY_FIX_BUF_TO_MSG SCpyFixMsg
121 #define ODU_REG_TTSK SRegTTsk
122 #define ODU_SET_PROC_ID SSetProcId
123 #define ODU_GET_MSG_LEN SFndLenMsg
124 #define ODU_EXIT_TASK SExitTsk
125 #define ODU_PRINT_MSG SPrntMsg
126 #define ODU_REM_PRE_MSG SRemPreMsg
127 #define ODU_REM_PRE_MSG_MULT SRemPreMsgMult
128 #define ODU_REG_TMR_MT SRegTmrMt
129 #define ODU_SEGMENT_MSG SSegMsg
130 #define ODU_CAT_MSG SCatMsg
131 #define ODU_GET_PROCID SFndProcId
132 #define ODU_SET_THREAD_AFFINITY SSetAffinity
133 #define ODU_CREATE_TASK SCreateSTsk
134
135 #define MAX_SYMB_PER_SLOT 14 
136
137 /* Slice */
138 #define SD_SIZE 3
139
140 #ifdef NR_TDD
141 /* Maximum slots for max periodicity and highest numerology is 320.
142  * However, aligning to fapi_interface.h, setting this macro to 160 */
143 #define MAX_TDD_PERIODICITY_SLOTS 160 
144 #endif
145
146 #define GET_UE_IDX( _crnti,_ueIdx)         \
147 {                                          \
148    _ueIdx = _crnti - ODU_START_CRNTI + 1;  \
149 }
150
151 #define GET_CRNTI( _crnti,_ueIdx)          \
152 {                                          \
153    _crnti = _ueIdx + ODU_START_CRNTI - 1;  \
154 }
155
156 /* Calculates cellIdx from cellId */
157 #define GET_CELL_IDX(_cellId, _cellIdx)   \
158 {                                         \
159    _cellIdx = _cellId - 1;                \
160 }
161
162 #define SET_BITS_MSB(_startBit, _numBits, _byte) \
163 {                                                \
164    _byte = (~((0xFF) >> _numBits));              \
165        _byte >>= _startBit;                          \
166 }
167
168 #define SET_BITS_LSB(_startBit, _numBits, _byte) \
169 {                                                \
170    _byte = (~((0xFF) << _numBits));              \
171        _byte <<= _startBit;                          \
172 }
173
174 /* this MACRO set 1 bit at the bit position */
175 #define SET_ONE_BIT(_bitPos, _out)            \
176 {                                             \
177    _out = ((1<<_bitPos) | _out);              \
178 }
179
180 /* this MACRO un-set 1 bit at the bit position */
181 #define UNSET_ONE_BIT(_bitPos, _out)            \
182 {                                               \
183    _out = (~(1<<_bitPos) & _out);               \
184 }
185
186 /* this MACRO finds the index of the rightmost set bit */
187 #define GET_RIGHT_MOST_SET_BIT( _in,_bitPos)        \
188 {                                                \
189    _bitPos = __builtin_ctz(_in);                 \
190 }
191
192 /* MACRO for checking CRNTI range*/
193 #define CHECK_CRNTI(_crnti, _isCrntiValid)                                         \
194 {                                                                   \
195   _isCrntiValid = ((_crnti >= ODU_START_CRNTI && _crnti <= ODU_END_CRNTI ) ? 1 : 0); \
196 }
197
198 #define CHECK_LCID(_lcId, _isLcidValid)      \
199 {\
200    _isLcidValid = ((_lcId >= SRB0_LCID && _lcId <= MAX_DRB_LCID) ? 1 : 0);\
201 }
202
203 typedef enum
204 {
205    UE_CFG_INACTIVE,
206    UE_CFG_INPROGRESS,
207    UE_CREATE_COMPLETE,
208    UE_DELETE_COMPLETE,
209    UE_RECFG_COMPLETE
210 }UeCfgState;
211
212 typedef enum
213 {
214    CONFIG_UNKNOWN,
215    CONFIG_ADD,
216    CONFIG_MOD,
217    CONFIG_DEL
218 }ConfigType;
219
220 #ifdef NR_TDD
221 typedef enum
222 {
223    DL_SLOT,
224    UL_SLOT,
225    FLEXI_SLOT
226 }SlotConfig;
227
228 typedef enum
229 {
230    TX_PRDCTY_MS_0P5,
231    TX_PRDCTY_MS_0P625,
232    TX_PRDCTY_MS_1,
233    TX_PRDCTY_MS_1P25,
234    TX_PRDCTY_MS_2,
235    TX_PRDCTY_MS_2P5,
236    TX_PRDCTY_MS_5,
237    TX_PRDCTY_MS_10
238 }DlUlTxPeriodicity;
239 #endif
240
241 typedef enum
242 {
243    SCS_15KHZ,
244    SCS_30KHZ,
245    SCS_60KHZ,
246    SCS_120KHZ,
247    SCS_240KHZ
248 }SCS;
249
250 typedef enum
251 {
252    CELL_UP,
253    CELL_DOWN
254 }OduCellStatus;
255
256 typedef struct slotTimingInfo
257 {
258    uint16_t cellId;
259    uint16_t sfn;
260    uint16_t slot;
261 }SlotTimingInfo;
262
263 typedef struct PlmnIdentity
264 {
265    uint8_t mcc[3];
266    uint8_t mnc[3];
267 }Plmn;
268
269 typedef struct snssai
270 {
271    uint8_t   sst;
272    uint8_t   sd[SD_SIZE];
273 }Snssai;
274
275 typedef struct oduCellId
276 {
277    uint16_t cellId;
278 }OduCellId;
279
280 #ifdef NR_TDD
281 typedef struct tddCfg
282 {
283    bool               pres;
284    DlUlTxPeriodicity  tddPeriod;      /* DL UL Transmission periodicity */
285    SlotConfig         slotCfg[MAX_TDD_PERIODICITY_SLOTS][MAX_SYMB_PER_SLOT]; 
286 }TDDCfg;
287 #endif
288
289 OduCellStatus gCellStatus;
290 uint64_t gSlotCount;
291 uint64_t gDlDataRcvdCnt;   /* Number of DL data received at EGTP */
292
293 void fillCoresetFeqDomAllocMap(uint16_t startPrb, uint16_t prbSize, uint8_t *freqDomain);
294 void oduCpyFixBufToMsg(uint8_t *fixBuf, Buffer *mBuf, uint16_t len);
295 uint8_t buildPlmnId(Plmn plmn, uint8_t *buf);
296 uint16_t fetchScsValue(uint8_t scsEnumValue);
297
298 uint8_t SGetSBufNewForDebug(char *file, char *func, char *line, Region region, Pool pool, Data **ptr, Size size);
299 uint8_t SPutSBufNewForDebug(char *file, char *func, char *line, Region region, Pool pool, Data *ptr, Size size);
300 uint8_t SGetStaticBufNewForDebug(char *file, char *func, char *line, \
301 Region region, Pool pool, Data **ptr, Size size, uint8_t memType);
302 uint8_t SPutStaticBufNewForDebug(char *file, char *func, char *line, \
303 Region region, Pool pool, Data *ptr, Size size, uint8_t memType);
304
305 #endif
306
307 /**********************************************************************
308   End of file
309 ***********************************************************************/