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