1 /*******************************************************************************
2 ################################################################################
3 # Copyright (c) [2017-2019] [Radisys] #
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 #
9 # http://www.apache.org/licenses/LICENSE-2.0 #
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 *******************************************************************************/
19 /* This file contains message handling functionality for DU cell management */
33 #define DU_SAP_UNBOUND 1
34 #define DU_SAP_BINDING 2
35 #define DU_SAP_BOUND 3
44 #define RLC_MAC_SAP_CFG 2
45 #define RLC_UDX_SAP_CFG 4
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
55 #define MAC_CONFIGURED (MAC_GEN_CFG | MAC_SAP_CFG)
57 #define DU_SET_ZERO(_buf, _size) \
58 memset((_buf), 0, _size);
60 /*Refer Spec 38.331 Annexure A: maxNrofPageRec : 32 [Maximum number of page records]*/
61 #define MAX_PAGING_UE_RECORDS 32
65 SLICE_INFO_NOT_AVAILABLE,
73 ACTIVATION_IN_PROGRESS,
82 UE_HANDIN_IN_PROGRESS,
83 UE_DELETION_IN_PROGRESS
91 UE_CTXT_RRC_RECFG_COMPLETE,
97 typedef struct f1setupRsp
99 uint32_t transId; /* Uniquely identify transaction */
100 char cuName[CU_DU_NAME_LEN_MAX]; /* CU Name */
101 F1RrcVersion rrcVersion; /* RRC version */
104 typedef struct f1DlRrcMsg
106 uint32_t gnbDuUeF1apId;
107 uint32_t gnbCuUeF1apId;
110 bool deliveryStatRpt;
115 typedef struct gtpTnlCfg
117 uint32_t ulTnlAddress; /* remote Address */
118 uint32_t dlTnlAddress; /* local Address */
122 typedef struct upTnlCfg
124 ConfigType configType;
128 GtpTnlCfg *tnlCfg1; /* Tunnel 1 */
129 GtpTnlCfg *tnlCfg2; /* Tunnel 2 */
133 /* This structures is taken from the DRX Cycle section of
134 * specification 33.473. */
135 typedef struct drxCycle
137 uint16_t drxLongCycleLength;
138 bool shortDrxCyclePres;
139 ShortDrx shortDrxCycle;
143 typedef struct duUeCfg
146 void *ueNrCapability;
147 uint8_t numRlcLcs; /* Rlc Ue Cfg */
148 RlcBearerCfg rlcLcCfg[MAX_NUM_LC];
149 uint8_t numMacLcs; /* Mac Ue Cfg */
150 LcCfg macLcCfg[MAX_NUM_LC];
153 UpTnlCfg upTnlInfo[MAX_NUM_DRB]; /* User plane TNL Info*/
154 uint8_t numDrbSetupMod; /*No. of DRB Added during Modification*/
155 MacUeCfg copyOfmacUeCfg;
156 DataTransmissionAction dataTransmissionAction;
160 bool drxConfigIndicatorRelease;
164 typedef struct f1UeContextSetup
166 UeCtxtActionType actionType;
170 F1DlRrcMsg *dlRrcMsg;
173 typedef struct cellCfgParams
175 NrEcgi nrEcgi; /* ECGI */
176 uint16_t nrPci; /* PCI */
177 uint16_t fiveGsTac; /* 5gSTac */
178 Plmn plmn[MAX_PLMN]; /* List of serving PLMN IDs */
179 uint32_t maxUe; /* max UE per slot */
182 typedef struct duUeCb
184 F1UeContextSetupDb *f1UeDb;
186 uint32_t gnbDuUeF1apId; /* GNB DU UE F1AP ID */
187 uint32_t gnbCuUeF1apId; /* GNB CU UE F1AP ID */
188 uint32_t drbBitMap; /* Drb Bit Map */
189 UeState ueState; /* UE Active/ Ue Inactive state */
190 MacCfraResource cfraResource; /* CF-RA resource assigned by MAC/SCH */
191 MacUeCfg macUeCfg; /* Mac Ue Cfg */
192 RlcUeCfg rlcUeCfg; /* Rlc Ue Cfg */
195 typedef struct slotInfo
201 typedef struct pagingMsg
203 /*Note: Paging UEID is extracted from 5gSTMSI as per Spec 38.304, Sec 7.1.
204 *This is not same as DU-UE_F1AP_ID or CU_UE_F1AP_ID*/
205 uint16_t pagUeId; /* UE Identifier from CU*/
207 /*TODO: When RAN Inititated Paging will be supported then I-RNTI will be
208 * added as a choice for UE Identity along with S-TMSI*/
209 uint64_t sTmsi; /* UE Paging Identity: S-TMSI */
210 bool pagingDrxPres; /* flag to indicate paging drx present or not */
211 uint16_t pagingDrx; /* UE specific paging drx */
212 uint8_t pagPriority; /* Paging priority */
213 uint16_t pagingFrame; /* paging frame */
214 uint16_t pagingFrameOffset; /* paging offset */
215 uint8_t i_s; /* Index points to PO from the sub-frame pattern */
216 uint16_t T; /* T is DRX cycle of the UE */
219 typedef struct duPagUeRecord
221 uint16_t pagUeId; /*UEID calculated from 5gsTMSI as per Spec 38.304*/
222 uint64_t sTmsi; /* UE Paging Identity: S-TMSI */
225 typedef struct duPagInfo
227 uint8_t i_s; /*Index of PO*/
228 CmLListCp pagUeList; /*List of UEs to be paged in this Paging Frame/Paging Occ*/
231 typedef struct duPagInfoMap
233 uint16_t pf; /* Paging Frame*/
234 CmLListCp pagInfoList; /* Master List of Paging Identified by PF and i_s*/
237 typedef struct duCellCb
239 uint16_t cellId; /* Internal cell Id */
240 CellCfgParams cellInfo; /* Cell info */
241 /* pointer to store the address of macCellCfg params used to send du-app to MAC */
242 MacCellCfg *duMacCellCfg;
243 CellStatus cellStatus; /* Cell status */
244 uint32_t numActvUes; /* Total Active UEs */
245 DuUeCb ueCb[MAX_NUM_UE]; /* Stores UE context */
246 SlotInfo currSlotInfo;
247 DuPagingMsg tmpPagingInfoOfUe; /* UE paging information */
248 CmHashListCp pagingInfoMap; /*Paging Map between PF and PagingInfoList*/
251 typedef struct duLSapCb
264 typedef struct ueCcchCtxt
266 uint32_t gnbDuUeF1apId; /* GNB DU UE F1AP ID */
267 uint16_t crnti; /* CRNTI */
268 uint16_t cellId; /* Cell Id */
271 /* This structure is added to store the information about the F1AP pdu and
272 * transId so that It can be used in future */
273 typedef struct reservedF1apPduInfo
275 uint8_t transId; /* trans Id */
276 void *f1apMsg; /* msg structure */
277 }ReservedF1apPduInfo;
282 Mem mem; /* Memory configs */
283 TskInit init; /* DU Init */
284 bool f1Status; /* Status of F1 connection */
285 bool e2Status; /* Status of E2 connection */
286 uint8_t numCfgCells; /* number of configured cells */
287 DuCellCb* cfgCellLst[MAX_NUM_CELL]; /* List of cells at DU APP of type DuCellCb */
288 uint8_t numActvCells; /* Number of active cells */
289 DuCellCb* actvCellLst[MAX_NUM_CELL]; /* List of cells activated/to be activated of type DuCellCb */
290 uint32_t gnbDuUeF1apIdGenerator; /* Generating Du Ue F1ap Id */
291 uint32_t numUe; /* current number of UEs */
292 UeCcchCtxt ueCcchCtxt[MAX_NUM_UE]; /* mapping of gnbDuUeF1apId to CRNTI required for CCCH processing*/
293 uint8_t numTeId; /* current number of TEIDs configured in the system*/
294 UpTnlCfg* upTnlCfg[MAX_TEID]; /* tunnel info for every Drb */
295 CmLListCp reservedF1apPduList; /*storing F1AP pdu infomation and transId */
296 SliceCfgState sliceState;
297 F1SetupMsg f1SetupReqAndRspMsg;
301 typedef struct duLSapCfg
319 /* global variables */
321 //DuCfgParams duCfgParam;
323 /* DU Cell Functions */
324 uint8_t duActvInit(Ent entity, Inst inst, Region region, Reason reason);
325 uint8_t duActvTsk(Pst *pst, Buffer *mBuf);
326 uint8_t duSendRlcUlCfg();
327 uint8_t duSendRlcDlCfg();
328 uint8_t duBuildRlcCfg(Inst inst);
329 uint8_t duBuildRlcLsapCfg(Ent ent, Inst inst, uint8_t lsapInst);
330 uint8_t duBuildRlcUsapCfg(uint8_t elemId, Ent ent, Inst inst);
331 uint8_t DuHdlRlcCfgComplete(Pst *pst, RlcMngmt *cfm);
332 uint8_t duHdlRlcCntrlCfgComplete(Pst *pst, RlcMngmt *cfm);
333 uint8_t duProcRlcUlCfgComplete(Pst *pst, RlcMngmt *cfm);
334 uint8_t duProcRlcDlCfgComplete(Pst *pst, RlcMngmt *cfm);
335 uint8_t duSendMacCfg();
336 uint8_t duBuildMacGenCfg();
337 uint8_t duBuildMacUsapCfg(SpId sapId);
338 uint8_t duHdlMacCfgComplete(Pst *pst, RgMngmt *cfm);
339 uint8_t duBindUnbindRlcToMacSap(uint8_t inst, uint8_t action);
340 uint8_t duProcCfgComplete();
341 uint8_t duSendSchCfg();
342 uint8_t duSctpStartReq();
343 uint8_t duSctpNtfyHdl(Buffer *mBuf, CmInetSctpNotification *ntfy);
345 uint8_t duBuildEgtpCfgReq();
346 uint8_t duHdlEgtpCfgComplete(CmStatus cfm);
347 uint8_t duSendEgtpSrvOpenReq();
348 uint8_t duHdlEgtpSrvOpenComplete(CmStatus cfm);
349 uint8_t duSendEgtpTnlMgmtReq(uint8_t action, uint32_t teIdMod, GtpTnlCfg *tnlInfo);
350 uint8_t duSendEgtpDatInd(Buffer *mBuf);
351 uint8_t duHdlSchCfgComplete(Pst *pst, RgMngmt *cfm);
352 uint8_t duBuildAndSendMacCellStart();
353 uint8_t duBuildAndSendMacCellStop(uint16_t cellId);
357 /**********************************************************************
359 **********************************************************************/