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,
92 UE_CTXT_RRC_RECFG_COMPLETE,
98 typedef struct f1setupRsp
100 uint32_t transId; /* Uniquely identify transaction */
101 char cuName[CU_DU_NAME_LEN_MAX]; /* CU Name */
102 F1RrcVersion rrcVersion; /* RRC version */
105 typedef struct f1DlRrcMsg
107 uint32_t gnbDuUeF1apId;
108 uint32_t gnbCuUeF1apId;
111 bool deliveryStatRpt;
116 typedef struct gtpTnlCfg
118 uint32_t ulTnlAddress; /* remote Address */
119 uint32_t dlTnlAddress; /* local Address */
123 typedef struct upTnlCfg
125 ConfigType configType;
129 GtpTnlCfg *tnlCfg1; /* Tunnel 1 */
130 GtpTnlCfg *tnlCfg2; /* Tunnel 2 */
134 /* This structures is taken from the DRX Cycle section of
135 * specification 33.473. */
136 typedef struct drxCycle
138 uint16_t drxLongCycleLength;
139 bool shortDrxCyclePres;
140 ShortDrx shortDrxCycle;
144 typedef struct duLcCfg
146 ConfigType configType;
150 typedef struct duMacUeCfg
155 bool macCellGrpCfgPres;
156 MacCellGrpCfg macCellGrpCfg;
157 bool phyCellGrpCfgPres;
158 PhyCellGrpCfg phyCellGrpCfg;
160 SpCellRecfg spCellCfg;
162 ModulationInfo dlModInfo; /* DL modulation info */ //TBD
163 ModulationInfo ulModInfo; /* UL modulation info */ //TBD
165 DuLcCfg lcCfgList[MAX_NUM_LC];
166 UeCfgState macUeCfgState; /* InActive / Completed */ //TBD
167 DataTransmissionAction transmissionAction; //TBD
169 bool drxConfigIndicatorRelease;
173 typedef struct duRlcBearerCfg
175 ConfigType configType;
176 RlcBearerCfg rlcBearerCfg;
179 typedef struct duRlcUeCfg
184 DuRlcBearerCfg rlcLcCfg[MAX_NUM_LC];
185 UeCfgState rlcUeCfgState; /* InActive / Completed */
189 typedef struct duUeCfg
192 void *ueNrCapability;
193 uint8_t numRlcLcs; /* Rlc Ue Cfg */
194 DuRlcBearerCfg rlcLcCfg[MAX_NUM_LC];
195 uint8_t numMacLcs; /* Mac Ue Cfg */
196 DuLcCfg macLcCfg[MAX_NUM_LC];
199 UpTnlCfg upTnlInfo[MAX_NUM_DRB]; /* User plane TNL Info*/
200 uint8_t numDrbSetupMod; /*No. of DRB Added during Modification*/
201 uint8_t numDrbModified; /*No. of DRB Modified during Modification*/
202 DuMacUeCfg copyOfmacUeCfg;
203 DataTransmissionAction dataTransmissionAction;
207 bool drxConfigIndicatorRelease;
211 typedef struct f1UeContextSetup
213 UeCtxtActionType actionType;
217 F1DlRrcMsg *dlRrcMsg;
220 typedef struct cellCfgParams
222 NrEcgi nrEcgi; /* ECGI */
223 uint16_t nrPci; /* PCI */
224 uint16_t fiveGsTac; /* 5gSTac */
225 Plmn plmn[MAX_PLMN]; /* List of serving PLMN IDs */
226 uint32_t maxUe; /* max UE per slot */
229 typedef struct duUeCb
231 F1UeContextSetupDb *f1UeDb;
233 uint32_t gnbDuUeF1apId; /* GNB DU UE F1AP ID */
234 uint32_t gnbCuUeF1apId; /* GNB CU UE F1AP ID */
235 uint32_t drbBitMap; /* Drb Bit Map */
236 UeState ueState; /* UE Active/ Ue Inactive state */
237 MacCfraResource cfraResource; /* CF-RA resource assigned by MAC/SCH */
238 DuMacUeCfg duMacUeCfg; /* Mac Ue Cfg */
239 DuRlcUeCfg duRlcUeCfg; /* Rlc Ue Cfg */
242 typedef struct slotInfo
248 typedef struct pagingMsg
250 /*Note: Paging UEID is extracted from 5gSTMSI as per Spec 38.304, Sec 7.1.
251 *This is not same as DU-UE_F1AP_ID or CU_UE_F1AP_ID*/
252 uint16_t pagUeId; /* UE Identifier from CU*/
254 /*TODO: When RAN Inititated Paging will be supported then I-RNTI will be
255 * added as a choice for UE Identity along with S-TMSI*/
256 uint64_t sTmsi; /* UE Paging Identity: S-TMSI */
257 bool pagingDrxPres; /* flag to indicate paging drx present or not */
258 uint16_t pagingDrx; /* UE specific paging drx */
259 uint8_t pagPriority; /* Paging priority */
260 uint16_t pagingFrame; /* paging frame */
261 uint16_t pagingFrameOffset; /* paging offset */
262 uint8_t i_s; /* Index points to PO from the sub-frame pattern */
263 uint16_t T; /* T is DRX cycle of the UE */
266 typedef struct duPagUeRecord
268 uint16_t pagUeId; /*UEID calculated from 5gsTMSI as per Spec 38.304*/
269 uint64_t sTmsi; /* UE Paging Identity: S-TMSI */
272 typedef struct duPagInfo
274 uint8_t i_s; /*Index of PO*/
275 CmLListCp pagUeList; /*List of UEs to be paged in this Paging Frame/Paging Occ*/
278 typedef struct duPagInfoMap
280 uint16_t pf; /* Paging Frame*/
281 CmLListCp pagInfoList; /* Master List of Paging Identified by PF and i_s*/
284 typedef struct duCellCb
286 uint16_t cellId; /* Internal cell Id */
287 CellCfgParams cellInfo; /* Cell info */
288 /* pointer to store the address of macCellCfg params used to send du-app to MAC */
289 MacCellCfg *duMacCellCfg;
290 CellStatus cellStatus; /* Cell status */
291 uint32_t numActvUes; /* Total Active UEs */
292 DuUeCb ueCb[MAX_NUM_UE]; /* Stores UE context */
293 SlotInfo currSlotInfo;
294 DuPagingMsg tmpPagingInfoOfUe; /* UE paging information */
295 CmHashListCp pagingInfoMap; /*Paging Map between PF and PagingInfoList*/
298 typedef struct duLSapCb
311 typedef struct ueCcchCtxt
313 uint32_t gnbDuUeF1apId; /* GNB DU UE F1AP ID */
314 uint16_t crnti; /* CRNTI */
315 uint16_t cellId; /* Cell Id */
318 /* This structure is added to store the information about the F1AP pdu and
319 * transId so that It can be used in future */
320 typedef struct reservedF1apPduInfo
322 uint8_t transId; /* trans Id */
323 void *f1apMsg; /* msg structure */
324 }ReservedF1apPduInfo;
326 typedef struct duTimer
328 CmTqCp tmrTqCp; /*!< Timer Task Queue Cntrl Point */
329 CmTqType tmrTq[DU_TQ_SIZE]; /*!< Timer Task Queue */
330 uint8_t tmrRes; /*!< Timer resolution */
336 Mem mem; /* Memory configs */
337 TskInit init; /* DU Init */
338 bool f1Status; /* Status of F1 connection */
339 bool e2Status; /* Status of E2 connection */
340 E2apDb e2apDb; /* E2AP database */
341 uint8_t numCfgCells; /* number of configured cells */
342 DuCellCb* cfgCellLst[MAX_NUM_CELL]; /* List of cells at DU APP of type DuCellCb */
343 uint8_t numActvCells; /* Number of active cells */
344 DuCellCb* actvCellLst[MAX_NUM_CELL]; /* List of cells activated/to be activated of type DuCellCb */
345 uint32_t gnbDuUeF1apIdGenerator; /* Generating Du Ue F1ap Id */
346 uint32_t numUe; /* current number of UEs */
347 UeCcchCtxt ueCcchCtxt[MAX_NUM_UE]; /* mapping of gnbDuUeF1apId to CRNTI required for CCCH processing*/
348 uint8_t numTeId; /* current number of TEIDs configured in the system*/
349 UpTnlCfg* upTnlCfg[MAX_TEID]; /* tunnel info for every Drb */
350 CmLListCp reservedF1apPduList; /*storing F1AP pdu infomation and transId */
351 SliceCfgState sliceState; /* Slice status */
352 F1SetupMsg f1SetupReqAndRspMsg; /* f1 Setup Req And Rsp Msg*/
353 DuTimers duTimersInfo; /* Du timers queue */
357 typedef struct duLSapCfg
375 /* global variables */
377 //DuCfgParams duCfgParam;
379 /* DU Cell Functions */
380 uint8_t duActvInit(Ent entity, Inst inst, Region region, Reason reason);
381 uint8_t duActvTsk(Pst *pst, Buffer *mBuf);
382 uint8_t duSendRlcUlCfg();
383 uint8_t duSendRlcDlCfg();
384 uint8_t duBuildRlcCfg(Inst inst);
385 uint8_t duBuildRlcLsapCfg(Ent ent, Inst inst, uint8_t lsapInst);
386 uint8_t duBuildRlcUsapCfg(uint8_t elemId, Ent ent, Inst inst);
387 uint8_t DuHdlRlcCfgComplete(Pst *pst, RlcMngmt *cfm);
388 uint8_t duHdlRlcCntrlCfgComplete(Pst *pst, RlcMngmt *cfm);
389 uint8_t duProcRlcUlCfgComplete(Pst *pst, RlcMngmt *cfm);
390 uint8_t duProcRlcDlCfgComplete(Pst *pst, RlcMngmt *cfm);
391 uint8_t duSendMacCfg();
392 uint8_t duBuildMacGenCfg();
393 uint8_t duBuildMacUsapCfg(SpId sapId);
394 uint8_t duHdlMacCfgComplete(Pst *pst, RgMngmt *cfm);
395 uint8_t duBindUnbindRlcToMacSap(uint8_t inst, uint8_t action);
396 uint8_t duProcCfgComplete();
397 uint8_t duSendSchCfg();
398 uint8_t duSctpStartReq();
399 uint8_t duSctpNtfyHdl(Buffer *mBuf, CmInetSctpNotification *ntfy);
401 uint8_t duBuildEgtpCfgReq();
402 uint8_t duHdlEgtpCfgComplete(CmStatus cfm);
403 uint8_t duSendEgtpSrvOpenReq();
404 uint8_t duHdlEgtpSrvOpenComplete(CmStatus cfm);
405 uint8_t duSendEgtpTnlMgmtReq(uint8_t action, uint32_t teIdMod, GtpTnlCfg *tnlInfo);
406 uint8_t duSendEgtpDatInd(Buffer *mBuf);
407 uint8_t duHdlSchCfgComplete(Pst *pst, RgMngmt *cfm);
408 uint8_t duBuildAndSendMacCellStart();
409 uint8_t duBuildAndSendMacCellStop(uint16_t cellId);
413 /**********************************************************************
415 **********************************************************************/