c9b1bc92248b0df4054a2896d0387236af070ff4
[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    CELL_OUT_OF_SERVICE,
63    ACTIVATION_IN_PROGRESS,
64    ACTIVATED,
65    DELETION_IN_PROGRESS
66 }CellStatus;
67
68 typedef enum
69 {
70    UE_INACTIVE,
71    UE_ACTIVE
72 }UeState;
73
74 typedef struct cellCfgParams
75 {
76    NrEcgi      nrEcgi;         /* ECGI */
77    uint16_t    nrPci;          /* PCI */
78    uint16_t    fiveGsTac;         /* 5gSTac */
79    Plmn        plmn[MAX_PLMN]; /* List of serving PLMN IDs */
80    uint32_t    maxUe;          /* max UE per slot */
81 }CellCfgParams;
82
83 typedef struct duUeCb
84 {
85    uint32_t    gnbDuUeF1apId; /* GNB DU UE F1AP ID */
86    uint32_t    gnbCuUeF1apId; /* GNB CU UE F1AP ID */
87    UeState     ueState;
88    MacUeCfg    macUeCfg;
89    RlcUeCfg    rlcUeCfg;
90 }DuUeCb;
91
92 typedef struct duCellCb
93 {
94    uint16_t       cellId;           /* Internal cell Id */
95    CellCfgParams  cellInfo;         /* Cell info */
96    /* pointer to store the address of macCellCfg params used to send du-app to MAC */
97    MacCellCfg    *duMacCellCfg;
98    bool           firstSlotIndRcvd;
99    CellStatus     cellStatus;       /* Cell status */
100    uint32_t       numActvUes;       /* Total Active UEs */
101    DuUeCb         ueCb[MAX_NUM_UE];  /* UE CONTEXT */
102 }DuCellCb;
103
104 typedef struct duLSapCb
105 {
106    Pst pst;
107    SuId        suId;
108    SpId        spId;
109    State       sapState;
110    Mem         mem;
111    CmTimer     timer;
112    uint8_t     bndRetryCnt;
113    uint8_t     maxBndRetry;
114    TmrCfg      bndTmr;
115 }DuLSapCb;
116
117 typedef struct ueCcchCtxt
118 {
119    uint32_t gnbDuUeF1apId; /* GNB DU UE F1AP ID */
120    uint16_t crnti;         /* CRNTI */
121    uint16_t cellId;        /* Cell Id */
122 }UeCcchCtxt;
123
124
125 /* DU APP DB */
126 typedef struct duCb
127 {
128    Mem           mem;    /* Memory configs */
129    TskInit       init;   /* DU Init */
130    //DuLSapCb      **macSap;  /* MAC SAP */
131    bool          f1Status; /* Status of F1 connection */
132    bool          e2Status; /* Status of E2 connection */
133    uint8_t       numCfgCells; 
134    DuCellCb*     cfgCellLst[MAX_NUM_CELL];     /* List of cells at DU APP of type DuCellCb */
135    uint8_t       numActvCells;
136    DuCellCb*     actvCellLst[MAX_NUM_CELL];    /* List of cells activated/to be activated of type DuCellCb */
137    uint32_t       numUe;            /* current number of UEs */
138    UeCcchCtxt     ueCcchCtxt[MAX_NUM_UE]; /* mapping of gnbDuUeF1apId to CRNTI required for CCCH processing*/
139 }DuCb;
140
141
142 typedef struct duLSapCfg
143 {
144    SuId        suId;
145    SpId        spId;
146    Ent         srcEnt;
147    Inst        srcInst;
148    ProcId      dstProcId;
149    Ent         dstEnt;
150    Inst        dstInst;
151    Priority    dstPrior;
152    Route       dstRoute;
153    Selector    dstSel;
154    Mem         mem;
155    uint8_t          maxBndRetry;
156    TmrCfg      bndTmr;
157    TmrCfg      connTmr;
158 }DuLSapCfg;
159
160 /* global variables */
161 DuCb duCb;
162 //DuCfgParams duCfgParam;
163
164 /* DU Cell Functions */
165 uint8_t duActvInit(Ent entity, Inst inst, Region region, Reason reason);
166 uint8_t duActvTsk(Pst *pst, Buffer *mBuf);
167 uint8_t duSendRlcUlCfg();
168 uint8_t duSendRlcDlCfg();
169 uint8_t duBuildRlcCfg(Inst inst);
170 uint8_t duBuildRlcLsapCfg(Ent ent, Inst inst, uint8_t lsapInst);
171 uint8_t duBuildRlcUsapCfg(uint8_t elemId, Ent ent, Inst inst);
172 uint8_t DuHdlRlcCfgComplete(Pst *pst, RlcMngmt *cfm);
173 uint8_t duHdlRlcCntrlCfgComplete(Pst *pst, RlcMngmt *cfm);
174 uint8_t duProcRlcUlCfgComplete(Pst *pst, RlcMngmt *cfm);
175 uint8_t duProcRlcDlCfgComplete(Pst *pst, RlcMngmt *cfm);
176 uint8_t duSendMacCfg();
177 uint8_t duBuildMacGenCfg();
178 uint8_t duBuildMacUsapCfg(SpId sapId);
179 uint8_t duHdlMacCfgComplete(Pst *pst, RgMngmt *cfm);
180 uint8_t duBindUnbindRlcToMacSap(uint8_t inst, uint8_t action);
181 uint8_t duProcCfgComplete();
182 uint8_t duSendSchCfg();
183 uint8_t duSctpStartReq();
184 uint8_t duSctpNtfyHdl(Buffer *mBuf, CmInetSctpNotification *ntfy);
185
186 uint8_t duBuildEgtpCfgReq();
187 uint8_t duHdlEgtpCfgComplete(CmStatus cfm);
188 uint8_t duSendEgtpSrvOpenReq();
189 uint8_t duHdlEgtpSrvOpenComplete(CmStatus cfm);
190 uint8_t duSendEgtpTnlMgmtReq(uint8_t action, uint32_t lclTeid, uint32_t remTeid);
191 uint8_t duHdlEgtpTnlMgmtCfm(EgtpTnlEvt tnlEvtCfm);
192 uint8_t duSendEgtpTestData();
193 uint8_t duSendEgtpDatInd(Buffer *mBuf);
194 uint8_t duHdlSchCfgComplete(Pst *pst, RgMngmt *cfm);
195 uint8_t duBuildAndSendMacCellStartReq();
196 uint8_t duBuildAndSendMacCellStopReq();
197 #endif
198
199 /**********************************************************************
200   End of file
201  **********************************************************************/