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 duLcCfg
145 ConfigType configType;
149 typedef struct duMacUeCfg
154 bool macCellGrpCfgPres;
155 MacCellGrpCfg macCellGrpCfg;
156 bool phyCellGrpCfgPres;
157 PhyCellGrpCfg phyCellGrpCfg;
159 SpCellRecfg spCellCfg;
161 ModulationInfo dlModInfo; /* DL modulation info */ //TBD
162 ModulationInfo ulModInfo; /* UL modulation info */ //TBD
164 DuLcCfg lcCfgList[MAX_NUM_LC];
165 UeCfgState macUeCfgState; /* InActive / Completed */ //TBD
166 DataTransmissionAction transmissionAction; //TBD
168 bool drxConfigIndicatorRelease;
172 typedef struct duRlcBearerCfg
174 ConfigType configType;
175 RlcBearerCfg rlcBearerCfg;
178 typedef struct duRlcUeCfg
183 DuRlcBearerCfg rlcLcCfg[MAX_NUM_LC];
184 UeCfgState rlcUeCfgState; /* InActive / Completed */
188 typedef struct duUeCfg
191 void *ueNrCapability;
192 uint8_t numRlcLcs; /* Rlc Ue Cfg */
193 DuRlcBearerCfg rlcLcCfg[MAX_NUM_LC];
194 uint8_t numMacLcs; /* Mac Ue Cfg */
195 DuLcCfg macLcCfg[MAX_NUM_LC];
198 UpTnlCfg upTnlInfo[MAX_NUM_DRB]; /* User plane TNL Info*/
199 uint8_t numDrbSetupMod; /*No. of DRB Added during Modification*/
200 uint8_t numDrbModified; /*No. of DRB Modified during Modification*/
201 DuMacUeCfg copyOfmacUeCfg;
202 DataTransmissionAction dataTransmissionAction;
206 bool drxConfigIndicatorRelease;
210 typedef struct f1UeContextSetup
212 UeCtxtActionType actionType;
216 F1DlRrcMsg *dlRrcMsg;
219 typedef struct cellCfgParams
221 NrEcgi nrEcgi; /* ECGI */
222 uint16_t nrPci; /* PCI */
223 uint16_t fiveGsTac; /* 5gSTac */
224 Plmn plmn[MAX_PLMN]; /* List of serving PLMN IDs */
225 uint32_t maxUe; /* max UE per slot */
228 typedef struct duUeCb
230 F1UeContextSetupDb *f1UeDb;
232 uint32_t gnbDuUeF1apId; /* GNB DU UE F1AP ID */
233 uint32_t gnbCuUeF1apId; /* GNB CU UE F1AP ID */
234 uint32_t drbBitMap; /* Drb Bit Map */
235 UeState ueState; /* UE Active/ Ue Inactive state */
236 MacCfraResource cfraResource; /* CF-RA resource assigned by MAC/SCH */
237 DuMacUeCfg duMacUeCfg; /* Mac Ue Cfg */
238 DuRlcUeCfg duRlcUeCfg; /* Rlc Ue Cfg */
241 typedef struct slotInfo
247 typedef struct pagingMsg
249 /*Note: Paging UEID is extracted from 5gSTMSI as per Spec 38.304, Sec 7.1.
250 *This is not same as DU-UE_F1AP_ID or CU_UE_F1AP_ID*/
251 uint16_t pagUeId; /* UE Identifier from CU*/
253 /*TODO: When RAN Inititated Paging will be supported then I-RNTI will be
254 * added as a choice for UE Identity along with S-TMSI*/
255 uint64_t sTmsi; /* UE Paging Identity: S-TMSI */
256 bool pagingDrxPres; /* flag to indicate paging drx present or not */
257 uint16_t pagingDrx; /* UE specific paging drx */
258 uint8_t pagPriority; /* Paging priority */
259 uint16_t pagingFrame; /* paging frame */
260 uint16_t pagingFrameOffset; /* paging offset */
261 uint8_t i_s; /* Index points to PO from the sub-frame pattern */
262 uint16_t T; /* T is DRX cycle of the UE */
265 typedef struct duPagUeRecord
267 uint16_t pagUeId; /*UEID calculated from 5gsTMSI as per Spec 38.304*/
268 uint64_t sTmsi; /* UE Paging Identity: S-TMSI */
271 typedef struct duPagInfo
273 uint8_t i_s; /*Index of PO*/
274 CmLListCp pagUeList; /*List of UEs to be paged in this Paging Frame/Paging Occ*/
277 typedef struct duPagInfoMap
279 uint16_t pf; /* Paging Frame*/
280 CmLListCp pagInfoList; /* Master List of Paging Identified by PF and i_s*/
283 typedef struct duCellCb
285 uint16_t cellId; /* Internal cell Id */
286 CellCfgParams cellInfo; /* Cell info */
287 /* pointer to store the address of macCellCfg params used to send du-app to MAC */
288 MacCellCfg *duMacCellCfg;
289 CellStatus cellStatus; /* Cell status */
290 uint32_t numActvUes; /* Total Active UEs */
291 DuUeCb ueCb[MAX_NUM_UE]; /* Stores UE context */
292 SlotInfo currSlotInfo;
293 DuPagingMsg tmpPagingInfoOfUe; /* UE paging information */
294 CmHashListCp pagingInfoMap; /*Paging Map between PF and PagingInfoList*/
297 typedef struct duLSapCb
310 typedef struct ueCcchCtxt
312 uint32_t gnbDuUeF1apId; /* GNB DU UE F1AP ID */
313 uint16_t crnti; /* CRNTI */
314 uint16_t cellId; /* Cell Id */
317 /* This structure is added to store the information about the F1AP pdu and
318 * transId so that It can be used in future */
319 typedef struct reservedF1apPduInfo
321 uint8_t transId; /* trans Id */
322 void *f1apMsg; /* msg structure */
323 }ReservedF1apPduInfo;
328 Mem mem; /* Memory configs */
329 TskInit init; /* DU Init */
330 bool f1Status; /* Status of F1 connection */
331 bool e2Status; /* Status of E2 connection */
332 uint8_t numCfgCells; /* number of configured cells */
333 DuCellCb* cfgCellLst[MAX_NUM_CELL]; /* List of cells at DU APP of type DuCellCb */
334 uint8_t numActvCells; /* Number of active cells */
335 DuCellCb* actvCellLst[MAX_NUM_CELL]; /* List of cells activated/to be activated of type DuCellCb */
336 uint32_t gnbDuUeF1apIdGenerator; /* Generating Du Ue F1ap Id */
337 uint32_t numUe; /* current number of UEs */
338 UeCcchCtxt ueCcchCtxt[MAX_NUM_UE]; /* mapping of gnbDuUeF1apId to CRNTI required for CCCH processing*/
339 uint8_t numTeId; /* current number of TEIDs configured in the system*/
340 UpTnlCfg* upTnlCfg[MAX_TEID]; /* tunnel info for every Drb */
341 CmLListCp reservedF1apPduList; /*storing F1AP pdu infomation and transId */
342 SliceCfgState sliceState;
343 F1SetupMsg f1SetupReqAndRspMsg;
347 typedef struct duLSapCfg
365 /* global variables */
367 //DuCfgParams duCfgParam;
369 /* DU Cell Functions */
370 uint8_t duActvInit(Ent entity, Inst inst, Region region, Reason reason);
371 uint8_t duActvTsk(Pst *pst, Buffer *mBuf);
372 uint8_t duSendRlcUlCfg();
373 uint8_t duSendRlcDlCfg();
374 uint8_t duBuildRlcCfg(Inst inst);
375 uint8_t duBuildRlcLsapCfg(Ent ent, Inst inst, uint8_t lsapInst);
376 uint8_t duBuildRlcUsapCfg(uint8_t elemId, Ent ent, Inst inst);
377 uint8_t DuHdlRlcCfgComplete(Pst *pst, RlcMngmt *cfm);
378 uint8_t duHdlRlcCntrlCfgComplete(Pst *pst, RlcMngmt *cfm);
379 uint8_t duProcRlcUlCfgComplete(Pst *pst, RlcMngmt *cfm);
380 uint8_t duProcRlcDlCfgComplete(Pst *pst, RlcMngmt *cfm);
381 uint8_t duSendMacCfg();
382 uint8_t duBuildMacGenCfg();
383 uint8_t duBuildMacUsapCfg(SpId sapId);
384 uint8_t duHdlMacCfgComplete(Pst *pst, RgMngmt *cfm);
385 uint8_t duBindUnbindRlcToMacSap(uint8_t inst, uint8_t action);
386 uint8_t duProcCfgComplete();
387 uint8_t duSendSchCfg();
388 uint8_t duSctpStartReq();
389 uint8_t duSctpNtfyHdl(Buffer *mBuf, CmInetSctpNotification *ntfy);
391 uint8_t duBuildEgtpCfgReq();
392 uint8_t duHdlEgtpCfgComplete(CmStatus cfm);
393 uint8_t duSendEgtpSrvOpenReq();
394 uint8_t duHdlEgtpSrvOpenComplete(CmStatus cfm);
395 uint8_t duSendEgtpTnlMgmtReq(uint8_t action, uint32_t teIdMod, GtpTnlCfg *tnlInfo);
396 uint8_t duSendEgtpDatInd(Buffer *mBuf);
397 uint8_t duHdlSchCfgComplete(Pst *pst, RgMngmt *cfm);
398 uint8_t duBuildAndSendMacCellStart();
399 uint8_t duBuildAndSendMacCellStop(uint16_t cellId);
403 /**********************************************************************
405 **********************************************************************/