c04af4bd397763071633ac9c6b42df2792ea4d80
[o-du/l2.git] / src / du_app / du_mgr.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 /* This file contains message handling functionality for DU cell management */
20 #ifndef __DU_MGR_H__
21 #define __DU_MGR_H__
22 #define DU_PROC  0
23
24 /* SAP IDs */
25 #define DU_MAC_SUID 0
26 #define DU_MAC_SPID 0
27
28 /* Instance */
29 #define RLC_UL_INST 0
30 #define RLC_DL_INST 1
31
32 /* SAP state */
33 #define DU_SAP_UNBOUND 1
34 #define DU_SAP_BINDING 2
35 #define DU_SAP_BOUND   3
36
37 #define DU_ZERO_VAL 0
38
39 /* Macros */
40 #define ADD 0
41 #define DEL 1
42
43 #define RLC_GEN_CFG      1
44 #define RLC_MAC_SAP_CFG  2
45 #define RLC_UDX_SAP_CFG  4
46
47 #define MAC_GEN_CFG   1
48 #define MAC_SAP_CFG   2
49 #define MAX_MAC_SAP   2
50
51 #define DU_RLC_UL_CONFIGURED  (RLC_GEN_CFG |  \
52       RLC_MAC_SAP_CFG | RLC_UDX_SAP_CFG)
53 #define DU_RLC_DL_CONFIGURED DU_RLC_UL_CONFIGURED
54
55 #define MAC_CONFIGURED (MAC_GEN_CFG | MAC_SAP_CFG)
56
57 #define DU_SET_ZERO(_buf, _size)   \
58    memset((_buf), 0, _size);
59
60 typedef enum
61 {
62    SLICE_INFO_NOT_AVAILABLE,
63    SLICE_CONFIGURED,
64    SLICE_RECONFIGURED
65 }SliceCfgState;
66
67 typedef enum
68 {
69    CELL_OUT_OF_SERVICE,
70    ACTIVATION_IN_PROGRESS,
71    ACTIVATED,
72    DELETION_IN_PROGRESS
73 }CellStatus;
74
75 typedef enum
76 {
77    UE_INACTIVE,
78    UE_ACTIVE,
79    UE_DELETION_IN_PROGRESS
80 }UeState;
81
82 typedef enum
83 {
84    UE_CTXT_UNKNOWN,
85    UE_CTXT_SETUP,
86    UE_CTXT_MOD,
87    UE_CTXT_RRC_RECFG_COMPLETE,
88    UE_CTXT_CFG_QUERY,
89    UE_CTXT_RELEASE
90 }UeCtxtActionType;
91
92 /** F1AP Msg IE **/
93 typedef struct f1setupRsp
94 {
95    uint32_t transId; /* Uniquely identify transaction */
96    char     cuName[CU_DU_NAME_LEN_MAX];   /* CU Name */
97    F1RrcVersion    rrcVersion;  /* RRC version */
98 }F1SetupRsp;
99
100 typedef struct f1DlRrcMsg 
101 {
102    uint32_t gnbDuUeF1apId;
103    uint32_t gnbCuUeF1apId;
104    uint8_t  srbId;
105    bool     execDup;
106    bool     deliveryStatRpt;
107    uint16_t rrcMsgSize;
108    uint8_t  *rrcMsgPdu;
109 }F1DlRrcMsg;
110
111 typedef struct gtpTnlCfg
112 {
113    uint32_t ulTnlAddress;  /* remote Address */
114    uint32_t dlTnlAddress;  /* local Address */
115    uint32_t teId;
116 }GtpTnlCfg;
117
118 typedef struct upTnlCfg
119 {
120    ConfigType configType;
121    uint8_t cellId;
122    uint8_t ueId;
123    uint8_t drbId;
124    GtpTnlCfg *tnlCfg1; /* Tunnel 1 */
125    GtpTnlCfg *tnlCfg2; /* Tunnel 2 */
126 }UpTnlCfg;
127
128 typedef struct duUeCfg
129 {
130    void *cellGrpCfg;
131    void *ueNrCapability;
132    uint8_t numRlcLcs;        /* Rlc Ue Cfg */
133    RlcBearerCfg rlcLcCfg[MAX_NUM_LC];
134    uint8_t numMacLcs;        /* Mac Ue Cfg */
135    LcCfg   macLcCfg[MAX_NUM_LC];
136    AmbrCfg *ambrCfg;
137    uint8_t numDrb;
138    UpTnlCfg upTnlInfo[MAX_NUM_DRB];  /* User plane TNL Info*/
139    uint8_t numDrbSetupMod;        /*No. of DRB Added during Modification*/
140    MacUeCfg copyOfmacUeCfg;
141 }DuUeCfg;
142
143 typedef struct f1UeContextSetup
144 {
145    UeCtxtActionType actionType;
146    uint8_t cellIdx;
147    DuUeCfg  duUeCfg;        
148    bool     dlRrcMsgPres;
149    F1DlRrcMsg  *dlRrcMsg;
150 }F1UeContextSetupDb;
151
152 typedef struct cellCfgParams
153 {
154    NrEcgi      nrEcgi;         /* ECGI */
155    uint16_t    nrPci;          /* PCI */
156    uint16_t    fiveGsTac;         /* 5gSTac */
157    Plmn        plmn[MAX_PLMN]; /* List of serving PLMN IDs */
158    uint32_t    maxUe;          /* max UE per slot */
159 }CellCfgParams;
160
161 typedef struct duUeCb
162 {
163    F1UeContextSetupDb *f1UeDb;
164    uint16_t crnti;
165    uint32_t gnbDuUeF1apId;   /* GNB DU UE F1AP ID */
166    uint32_t gnbCuUeF1apId;   /* GNB CU UE F1AP ID */
167    uint32_t drbBitMap;       /* Drb Bit Map */
168    UeState  ueState;         /* UE Active/ Ue Inactive state */
169    MacUeCfg macUeCfg;        /* Mac Ue Cfg */
170    RlcUeCfg rlcUeCfg;        /* Rlc Ue Cfg */
171 }DuUeCb;
172
173 typedef struct  slotInfo
174 {
175    uint16_t sfn;
176    uint16_t slot;
177 }SlotInfo;
178
179 typedef struct duCellCb
180 {
181    uint16_t       cellId;                 /* Internal cell Id */
182    CellCfgParams  cellInfo;               /* Cell info */
183    /* pointer to store the address of macCellCfg params used to send du-app to MAC */
184    MacCellCfg     *duMacCellCfg;
185    CellStatus     cellStatus;             /* Cell status */
186    uint32_t       numActvUes;             /* Total Active UEs */
187    DuUeCb         ueCb[MAX_NUM_UE];       /* UE CONTEXT */
188    SlotInfo       currSlotInfo;
189 }DuCellCb;
190
191 typedef struct duLSapCb
192 {
193    Pst pst;
194    SuId        suId;
195    SpId        spId;
196    State       sapState;
197    Mem         mem;
198    CmTimer     timer;
199    uint8_t     bndRetryCnt;
200    uint8_t     maxBndRetry;
201    TmrCfg      bndTmr;
202 }DuLSapCb;
203
204 typedef struct ueCcchCtxt
205 {
206    uint32_t gnbDuUeF1apId; /* GNB DU UE F1AP ID */
207    uint16_t crnti;         /* CRNTI */
208    uint16_t cellId;        /* Cell Id */
209 }UeCcchCtxt;
210
211 /* This structure is added to store the information about the F1AP pdu and
212  * transId so that It can be used in future */
213 typedef struct reservedF1apPduInfo
214 {
215    uint8_t transId;               /* trans Id */
216    void *f1apMsg;              /* msg structure */
217 }ReservedF1apPduInfo;
218
219 /* DU APP DB */
220 typedef struct duCb
221 {
222    Mem           mem;                       /* Memory configs */
223    TskInit       init;                      /* DU Init */
224    bool          f1Status;                  /* Status of F1 connection */
225    bool          e2Status;                  /* Status of E2 connection */
226    uint8_t       numCfgCells;               /* number of configured cells */ 
227    DuCellCb*     cfgCellLst[MAX_NUM_CELL];  /* List of cells at DU APP of type DuCellCb */
228    uint8_t       numActvCells;              /* Number of active cells */
229    DuCellCb*     actvCellLst[MAX_NUM_CELL]; /* List of cells activated/to be activated of type DuCellCb */
230    uint32_t      gnbDuUeF1apIdGenerator;    /* Generating Du Ue F1ap Id */
231    uint32_t      numUe;                     /* current number of UEs */
232    UeCcchCtxt    ueCcchCtxt[MAX_NUM_UE];    /* mapping of gnbDuUeF1apId to CRNTI required for CCCH processing*/
233    uint8_t       numTeId;                   /* current number of TEIDs configured in the system*/
234    UpTnlCfg*     upTnlCfg[MAX_TEID];        /* tunnel info for every Drb */
235    CmLListCp     reservedF1apPduList;       /*storing F1AP pdu infomation and transId */
236    SliceCfgState sliceState;
237    F1SetupMsg    f1SetupReqAndRspMsg;
238 }DuCb;
239
240
241 typedef struct duLSapCfg
242 {
243    SuId        suId;
244    SpId        spId;
245    Ent         srcEnt;
246    Inst        srcInst;
247    ProcId      dstProcId;
248    Ent         dstEnt;
249    Inst        dstInst;
250    Priority    dstPrior;
251    Route       dstRoute;
252    Selector    dstSel;
253    Mem         mem;
254    uint8_t          maxBndRetry;
255    TmrCfg      bndTmr;
256    TmrCfg      connTmr;
257 }DuLSapCfg;
258
259 /* global variables */
260 DuCb duCb;
261 //DuCfgParams duCfgParam;
262
263 /* DU Cell Functions */
264 uint8_t duActvInit(Ent entity, Inst inst, Region region, Reason reason);
265 uint8_t duActvTsk(Pst *pst, Buffer *mBuf);
266 uint8_t duSendRlcUlCfg();
267 uint8_t duSendRlcDlCfg();
268 uint8_t duBuildRlcCfg(Inst inst);
269 uint8_t duBuildRlcLsapCfg(Ent ent, Inst inst, uint8_t lsapInst);
270 uint8_t duBuildRlcUsapCfg(uint8_t elemId, Ent ent, Inst inst);
271 uint8_t DuHdlRlcCfgComplete(Pst *pst, RlcMngmt *cfm);
272 uint8_t duHdlRlcCntrlCfgComplete(Pst *pst, RlcMngmt *cfm);
273 uint8_t duProcRlcUlCfgComplete(Pst *pst, RlcMngmt *cfm);
274 uint8_t duProcRlcDlCfgComplete(Pst *pst, RlcMngmt *cfm);
275 uint8_t duSendMacCfg();
276 uint8_t duBuildMacGenCfg();
277 uint8_t duBuildMacUsapCfg(SpId sapId);
278 uint8_t duHdlMacCfgComplete(Pst *pst, RgMngmt *cfm);
279 uint8_t duBindUnbindRlcToMacSap(uint8_t inst, uint8_t action);
280 uint8_t duProcCfgComplete();
281 uint8_t duSendSchCfg();
282 uint8_t duSctpStartReq();
283 uint8_t duSctpNtfyHdl(Buffer *mBuf, CmInetSctpNotification *ntfy);
284
285 uint8_t duBuildEgtpCfgReq();
286 uint8_t duHdlEgtpCfgComplete(CmStatus cfm);
287 uint8_t duSendEgtpSrvOpenReq();
288 uint8_t duHdlEgtpSrvOpenComplete(CmStatus cfm);
289 uint8_t duSendEgtpTnlMgmtReq(uint8_t action, uint32_t teIdMod, GtpTnlCfg *tnlInfo);
290 uint8_t duSendEgtpDatInd(Buffer *mBuf);
291 uint8_t duHdlSchCfgComplete(Pst *pst, RgMngmt *cfm);
292 uint8_t duBuildAndSendMacCellStart();
293 uint8_t duBuildAndSendMacCellStop(uint16_t cellId);
294 #endif
295
296 /**********************************************************************
297   End of file
298  **********************************************************************/