[JIRA ID- ODUHIGH-462] [ISSUE ID ODUHIGH-477] Adding support for drx configuration...
[o-du/l2.git] / src / cu_stub / cu_stub.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
19 #ifndef __CU_MGR_MAIN_H__
20 #define __CU_MGR_MAIN_H__
21
22 #define CU_ID 1
23 #define CU_NAME "ORAN_OAM_CU"
24
25 #define DU_IP_V6_ADDR "0000:0000:0000:0000:0000:0000:0000:0001"
26 #define CU_IP_V6_ADDR "0000:0000:0000:0000:0000:0000:0000:0011"
27
28 #ifndef O1_ENABLE
29 #define DU_IP_V4_ADDR (char*[]){"192.168.130.81", "192.168.130.83"}
30 #define DU_SCTP_PORT (int[]){38472, 38473}
31
32 #define CU_IP_V4_ADDR "192.168.130.82"
33 #define CU_SCTP_PORT_TO_DU (int[]){38472, 38473}
34 #endif
35
36 #define DU_EGTP_PORT  (int[]){39001, 39002}
37 #define CU_EGTP_PORT (int[]){39003, 39004}
38 #define RRC_VER 0
39 #define EXT_RRC_VER 5
40 #define PLMN_MCC0 3
41 #define PLMN_MCC1 1
42 #define PLMN_MCC2 1
43 #define PLMN_MNC0 4
44 #define PLMN_MNC1 8
45 #define PLMN_MNC2 0
46
47 #define CU_DU_NAME_LEN_MAX 30      /* Max length of CU/DU name string */
48
49 #define CU_APP_MEM_REG 1
50 #define CU_POOL 1
51
52 #define MAX_NUM_OF_SLICE 1024 /* As per the spec 38.473, maxnoofSliceItems = 1024*/
53 #define MAX_QOS_FLOWS 64 /* As per the spec 38.331, maxNrofQFIs = 64 */
54
55 /* allocate and zero out a static buffer */
56
57 #define CU_ALLOC(_datPtr, _size)                             \
58 {                                                            \
59    S16 _ret;                                                 \
60    _ret = SGetSBuf(CU_APP_MEM_REG, CU_POOL,                  \
61                      (Data **)&_datPtr, _size);              \
62    if(_ret == ROK)                                           \
63       memset(_datPtr, 0, _size);                      \
64    else                                                      \
65       _datPtr = NULLP;                                       \
66 }
67  
68 /* free a static buffer */
69 #define CU_FREE(_datPtr, _size)                              \
70    if(_datPtr)                                               \
71    SPutSBuf(CU_APP_MEM_REG, CU_POOL,                         \
72          (Data *)_datPtr, _size);
73
74 #define SEARCH_DU_DB(_duIdx, _duId, _duDb){\
75    _duDb = NULLP; \
76    for(_duIdx=0; _duIdx < cuCb.numDu; _duIdx++)\
77    {\
78       if(cuCb.duInfo[_duIdx].duId == _duId)\
79       {\
80          _duDb =  (&cuCb.duInfo[_duIdx]);\
81          break; \
82      }\
83    }\
84 }
85
86 #define SEARCH_CELL_DB(_cellIdx, _duDb, _nrCellId, _cellCb){\
87    _cellCb = NULLP; \
88    for(_cellIdx=0; _cellIdx < _duDb->numCells; _cellIdx++)\
89    {\
90       if(_duDb->cellCb[_cellIdx].nrCellId == _nrCellId)\
91       {\
92          _cellCb = (&(_duDb->cellCb[_cellIdx]));\
93          break;\
94       }\
95    }\
96 }
97
98 typedef enum
99 {
100    CELL_INACTIVE,
101    CELL_ACTIVE,
102    CELL_DELETION_IN_PROGRESS
103 }CellStatusInfo;
104
105 typedef enum
106 {
107    UE_IDLE,
108    UE_ATTACH_IN_PROGRESS,
109    UE_ACTIVE,
110    UE_HANDOVER_IN_PROGRESS
111 }UeState;
112
113 typedef struct RrcVersion
114 {
115   uint8_t    rrcVer;     /* Latest RRC Version */
116   uint32_t   extRrcVer;  /* Latest RRC version extended */
117 }RrcVersion;
118
119 typedef struct cuCfgParams
120 {
121    uint32_t         cuId;
122    char             cuName[CU_DU_NAME_LEN_MAX];
123    CuSctpParams     sctpParams;
124    Plmn             plmn;
125    CuEgtpParams     egtpParams;
126    RrcVersion       rrcVersion;
127 }CuCfgParams;
128
129 typedef struct handoverInfo
130 {
131    uint32_t sourceDuId;
132    uint32_t targetDuId;
133 }HandoverInfo;
134
135 typedef struct dlAmCfg
136 {
137    uint8_t        snLenDl;              /* Sequence Number length in bits. Allowed values are 12 and 18 */
138    int8_t         reAssemTmr;           /* T_reassembling Timer in msec*/
139    int16_t        statProhTmr;          /* T_status_prohibit Timer in msec*/
140 }DlAmCfg;
141
142 typedef struct ulAmCfg
143 {
144    uint8_t      snLenUl;             /* Sequence Number length in bits. Allowed values are 12 and 18 */
145    uint16_t     pollRetxTmr;         /* T_poll_retransmit Timer in msec */
146    int16_t      pollPdu;             /* Used to trigger a poll for every pollPdu.*/
147    int32_t      pollByte;            /* Poll_Byte in bytes. */
148    uint8_t      maxRetxTh;           /* Max_Retx_Threshold */
149 }UlAmCfg;
150
151 typedef struct amBearerCfg
152 {
153    UlAmCfg  ulAmCfg;
154    DlAmCfg  dlAmCfg;
155 }AmBearerCfg;
156
157 typedef struct ulUmCfg
158 {
159    uint8_t        snLenUlUm;             /* Sequence Number length in bits. Allowed values are 6 and 12 */
160 }UlUmCfg;
161
162 typedef struct dlUmCfg
163 {
164    uint8_t        snLenDlUm;             /* Sequence Number length in bits. Allowed values are 6 and 12 */
165    int8_t         reAssemTmr;            /* T_reassembling Timer in msec*/
166 }DlUmCfg;
167
168 typedef struct umBiDirBearerCfg
169 {
170    UlUmCfg  ulUmCfg;
171    DlUmCfg  dlUmCfg;
172 }UmBiDirBearerCfg;
173
174 typedef struct umUniDirUlBearerCfg
175 {
176    UlUmCfg  ulUmCfg;
177 }UmUniDirUlBearerCfg;
178
179 typedef struct umUniDirDlBearerCfg
180 {
181    DlUmCfg  dlUmCfg;
182 }UmUniDirDlBearerCfg;
183
184 typedef struct rlcLcCfg
185 {
186    uint8_t rlcMode;
187    union
188    {   
189       AmBearerCfg         amCfg;
190       UmBiDirBearerCfg    umBiDirCfg;
191       UmUniDirUlBearerCfg umUniDirUlCfg;
192       UmUniDirDlBearerCfg umUniDirDlCfg;
193    }u; 
194 }RlcLcCfg;
195
196 typedef struct macLcCfg
197 {
198    uint8_t priority;
199    uint8_t lcGroup;
200    uint8_t schReqId;
201    uint8_t pbr;        // prioritisedBitRate
202    uint8_t bsd;        // bucketSizeDuration
203 }MacLcCfg;
204
205 typedef struct srbInfo
206 {
207    uint8_t   srbId;
208    uint8_t   lcId;
209    RlcLcCfg  rlcLcCfg;
210    MacLcCfg  macLcCfg;
211    bool      cfgSentToUe;
212 }SrbInfo;
213
214 typedef struct qosInfo
215 {
216    uint8_t nonDynFiveQI;
217    uint16_t avgWindow;
218    uint16_t maxBurstDataVol;
219    uint8_t priorityLevel;
220    uint8_t preemptionCapability;
221    uint8_t preemptionVulnerability;
222    uint8_t pduSessionId;
223 }QosInfo;
224
225 typedef struct flowsMapped
226 {
227    uint8_t qosFlowId;
228    QosInfo qos;
229 }FlowsMapped;
230
231 typedef struct TnlInfo
232 {
233    uint8_t address[4];
234    uint8_t teId[4];
235 }TnlInfo;
236
237 typedef struct drbInfo
238 {
239    uint8_t drbId;
240    uint8_t lcId;
241    QosInfo qos;
242    Snssai *snssai;
243    uint8_t numFlowMap;
244    FlowsMapped flowMapList[MAX_QOS_FLOWS];
245    TnlInfo ulUpTnlInfo;
246    TnlInfo dlUpTnlInfo;
247    uint8_t rlcMode;
248    RlcLcCfg  rlcLcCfg;
249    MacLcCfg  macLcCfg;
250    bool      cfgSentToUe;
251 }DrbInfo;
252
253 typedef struct cuCellCb CuCellCb;
254
255 #ifdef NR_DRX
256 /* The following list of structures is taken from the DRX-Config section of specification 33.331. */
257 typedef struct drxOnDurationTimer
258 {
259    bool  onDurationTimerValInMs;
260    union
261    {
262       uint8_t  subMilliSeconds;
263       uint16_t milliSeconds;
264    }onDurationtimerValue;
265 }DrxOnDurationTimer;
266
267 typedef struct drxLongCycleStartOffset
268 {
269    uint16_t drxLongCycleStartOffsetChoice;
270    uint16_t drxLongCycleStartOffsetVal;
271 }DrxLongCycleStartOffset;
272
273 typedef struct shortDrx
274 {
275    uint16_t   drxShortCycle;
276    uint8_t    drxShortCycleTimer;
277 }ShortDrx;
278
279 typedef struct drxCfg
280 {
281    DrxOnDurationTimer       drxOnDurationTimer;
282    uint16_t                 drxInactivityTimer;
283    uint8_t                  drxHarqRttTimerDl;
284    uint8_t                  drxHarqRttTimerUl;
285    uint16_t                 drxRetransmissionTimerDl;
286    uint16_t                 drxRetransmissionTimerUl;
287    DrxLongCycleStartOffset  drxLongCycleStartOffset;
288    bool                     shortDrxPres;
289    ShortDrx                 shortDrx;
290    uint8_t                  drxSlotOffset;
291 }DrxCfg;
292 #endif
293
294 typedef struct cuUeCb
295 {
296    CuCellCb  *cellCb;
297    uint32_t  crnti;
298    uint8_t   gnbDuUeF1apId;
299    uint8_t   gnbCuUeF1apId;
300    uint8_t   numSrb;
301    SrbInfo   srbList[MAX_NUM_SRB];
302    uint8_t   numDrb;
303    DrbInfo   drbList[MAX_NUM_DRB];
304    F1apMsgDb f1apMsgDb;
305    UeState   state;
306 #ifdef NR_DRX
307    DrxCfg    drxCfg;
308 #endif
309    HandoverInfo hoInfo;
310 }CuUeCb;
311
312 struct cuCellCb
313 {
314    uint32_t nrCellId;
315    uint8_t  numUe;
316    CuUeCb   *ueCb[MAX_NUM_UE];
317    CellStatusInfo cellStatus;
318 };
319
320 typedef struct duDb
321 {
322    uint32_t duId;
323    char     duName[CU_DU_NAME_LEN_MAX];
324    uint8_t  numCells;
325    CuCellCb cellCb[MAX_NUM_CELL];  
326    uint8_t  numUe;
327    CuUeCb   ueCb[MAX_NUM_CELL * MAX_NUM_UE];
328 }DuDb;
329
330 typedef struct cuGlobalCb
331 {
332    CuCfgParams cuCfgParams;
333    uint8_t     numSnssaiSupported;
334    Snssai      *snssaiList[MAX_NUM_OF_SLICE];
335    uint8_t     numDu;
336    DuDb        duInfo[MAX_DU_SUPPORTED];
337    uint32_t    gnbCuUeF1apIdGenerator;   /* Generating CU UE F1AP ID */
338 }CuGlobalCb;
339
340 CuGlobalCb cuCb;
341
342 void readCuCfg();
343 void cuAppInmsgHdlr(Buffer *mBuf);
344 void sctpNtfyInd(CmInetSctpNotification *ntfy);
345 uint8_t egtpInitReq();
346 void *cuConsoleHandler(void *);
347
348 #endif
349
350 /**********************************************************************
351          End of file
352 **********************************************************************/