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