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