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 /* Defines APIs exchanged between du_app and cl module of RLC */
24 #define EVENT_RLC_UE_CREATE_REQ 210
25 #define EVENT_RLC_UE_CREATE_RSP 211 /*!< Config Confirm */
26 #define EVENT_UL_RRC_MSG_TRANS_TO_DU 212
27 #define EVENT_DL_RRC_MSG_TRANS_TO_RLC 213
28 #define EVENT_RRC_DELIVERY_MSG_TRANS_TO_DU 214
29 #define EVENT_RLC_UE_RECONFIG_REQ 215
30 #define EVENT_RLC_UE_RECONFIG_RSP 216
31 #define EVENT_DL_RRC_MSG_RSP_TO_DU 217
32 #define EVENT_DL_USER_DATA_TRANS_TO_RLC 218
33 #define EVENT_UL_USER_DATA_TRANS_TO_DU 219
34 #define EVENT_RLC_UE_DELETE_REQ 220
35 #define EVENT_RLC_UE_DELETE_RSP 221
36 #define EVENT_RLC_SLICE_PM_TO_DU 222
41 /* RLC Direction Config */
42 #define RLC_CFG_DIR_UL 1 /*!< Uplink direction */
43 #define RLC_CFG_DIR_DL 2 /*!< Downlink direction */
44 #define RLC_CFG_DIR_BOTH 3 /*!< Both Downlink and Uplink Direction*/
47 /* Logical Channel Type */
48 #define LCH_BCCH 1 /*!< BCCH Logical Channel */
49 #define LCH_PCCH 2 /*!< PCCH Logical Channel */
50 #define LCH_CCCH 3 /*!< CCCH Logical Channel */
51 #define LCH_DTCH 4 /*!< DTCH Logical Channel */
52 #define LCH_DCCH 5 /*!< DCCH Logical Channel */
56 RB_TYPE_SRB, /* Signalling Radio Bearer */
57 RB_TYPE_DRB /* Data Radio Bearer */
62 TRANSMISSION_IN_PROGRESS,
63 TRANSMISSION_COMPLETE,
69 RLC_CFG_REAS_NONE , /*!< No Failure */
70 RLC_CFG_REAS_RB_CREAT_FAIL , /*!< RB CB creation Failure */
71 RLC_CFG_REAS_UE_CREAT_FAIL , /*!< UE CB creation Failure */
72 RLC_CFG_REAS_CELL_CREAT_FAIL , /*!< CELL CB creation Failure */
73 RLC_CFG_REAS_RB_PRSNT , /*!< RB CB already present */
74 RLC_CFG_REAS_LCHTYPE_MIS , /*!< Logical channel type mismatch */
75 RLC_CFG_REAS_RB_UNKWN , /*!< RB Cb unknown */
76 RLC_CFG_REAS_UE_UNKWN , /*!< UE Cb unknown */
77 RLC_CFG_REAS_CELL_UNKWN , /*!< Cell Cb unknown */
78 RLC_CFG_REAS_RB_DEL_FAIL , /*!< RB Cb Deletion Failure */
79 RLC_CFG_REAS_UE_DEL_FAIL , /*!< UE Cb Deletion Failure */
80 RLC_CFG_REAS_RB_REEST_FAIL , /*!< RB Cb Re establish Failure */
81 RLC_CFG_REAS_RB_MODE_MIS , /*!< RB Cb Mode mismatch */
82 RLC_CFG_REAS_REEST_FAIL , /*!< RB Cb Re-establishment Failed */
83 RLC_CFG_REAS_RECFG_FAIL , /*!< RB Cb Re-configuration Failed */
84 RLC_CFG_REAS_INVALID_CFG , /*!< Invalid Configuration Type */
85 RLC_CFG_REAS_SAME_UEID , /*!< UE Ids match in ChngUeId Request */
86 RLC_CFG_REAS_CELL_DEL_FAIL , /*!< Cell Cb Deletion Failure */
87 RLC_CFG_REAS_INVALID_LCHID , /*!< Invalid LChId */
88 RLC_CFG_REAS_INVALID_DIR , /*!< Invalid Direction */
89 RLC_CFG_REAS_UE_EXISTS , /*!< UE ID already exists */
90 RLC_CFG_REAS_INVALID_SNLEN , /*!< Invalid SN Length */
91 RLC_CFG_REAS_SNLEN_MIS , /*!< SN Length mismatch */
92 RLC_CFG_REAS_INVALID_RGUSAP /*!< Invalid RGU SAP ID */
97 SUCCESSFUL , /*!< No Failure */
98 INVALID_CELLID , /*!< CellId not present */
99 INVALID_UEID , /*!< UEId not present */
104 RLC_AM, //Acknowledged Mode
105 RLC_UM_BI_DIRECTIONAL, //UnAcknowledged Mode
106 RLC_UM_UNI_DIRECTIONAL_UL,
107 RLC_UM_UNI_DIRECTIONAL_DL
124 RLC_DU_APP_RSP_OK = 1,
128 typedef struct ulAmCfg
130 SnLenAm snLenUl; /* Sequence Number length in bits. Allowed values are 12 and 18 */
131 int8_t reAssemTmr; /* T_reassembling Timer in msec*/
132 int16_t statProhTmr; /* T_status_prohibit Timer in msec*/
136 typedef struct dlAmCfg
138 SnLenAm snLenDl; /* Sequence Number length in bits. Allowed values are 12 and 18 */
139 uint16_t pollRetxTmr; /* T_poll_retransmit Timer in msec */
140 int16_t pollPdu; /* Used to trigger a poll for every pollPdu.*/
141 int32_t pollByte; /* Poll_Byte in bytes. */
142 uint8_t maxRetxTh; /* Max_Retx_Threshold */
146 typedef struct dlUmCfg
148 SnLenUm snLenDlUm; /* Sequence Number length in bits. Allowed values are 6 and 12 */
152 typedef struct ulUmCfg
154 SnLenUm snLenUlUm; /* Sequence Number length in bits. Allowed values are 6 and 12 */
155 int8_t reAssemTmr; /* T_reassembling Timer in msec*/
159 typedef struct amBearerCfg
165 typedef struct umBiDirBearerCfg
171 typedef struct umUniDirUlBearerCfg
174 }UmUniDirUlBearerCfg;
176 typedef struct umUniDirDlBearerCfg
179 }UmUniDirDlBearerCfg;
181 /* Spec Ref: 38.331, 6.3.2 RLC-BearerConfig */
182 typedef struct rlcBearerCfg
184 ConfigType configType;
194 UmBiDirBearerCfg *umBiDirCfg;
195 UmUniDirUlBearerCfg *umUniDirUlCfg;
196 UmUniDirDlBearerCfg *umUniDirDlCfg;
198 bool isLcAddModRspSent;
201 typedef struct rlcUeCfg
206 RlcBearerCfg rlcLcCfg[MAX_NUM_LC];
207 UeCfgState rlcUeCfgState; /* InActive / Completed */
210 typedef struct rlcUeCfgRsp
215 FailureReason reason;
218 typedef struct rlcUeDelete
224 typedef struct rlcUeDeleteRsp
228 UeDeleteResult result;
231 /* UL RRC Message from RLC to DU APP */
232 typedef struct ulRrcMsgInfo
234 uint16_t cellId; /* Cell Id */
235 uint16_t ueId; /* UE Id */
236 uint8_t lcId; /* Logical channel Id */
237 uint16_t msgLen; /* RRC message length (in bytes) */
238 uint8_t *rrcMsg; /* RRC Message (UL-DCCH Message) */
241 /* UL User Data from RLC to DU APP */
242 typedef struct ulUserDatInfo
244 uint16_t cellId; /* Cell Id */
245 uint16_t ueId; /* UE Id */
247 uint16_t msgLen; /* User data length (in bytes) */
248 uint8_t *userData; /* User data (UL-DTCH Message) */
251 /* DL RRC Message from DU APP to RLC */
252 typedef struct dlRrcMsgInfo
254 uint16_t cellId; /* Cell Id */
255 uint16_t ueId; /* UE Id */
256 RlcRbType rbType; /* Radio Bearer Type */
257 uint8_t rbId; /* Radio Bearer Id */
258 uint8_t lcType; /* Logical channel type */
259 uint8_t lcId; /* Logical channel Id */
260 bool execDup; /* Execution duplication enabled */
261 bool deliveryStaRpt; /* Reporting of delivery status by RLC to DU-APP enabled */
262 uint16_t msgLen; /* RRC Message length */
263 uint8_t *rrcMsg; /* RRC Message (DL-DCCH Message) */
266 /* DL RRC Message Rsp From RLC to DU APP */
267 typedef struct dlRrcMsgRsp
269 uint16_t cellId; /* Cell Id */
270 uint16_t crnti; /* UE index */
271 DlMsgState state; /* Dl RRC Msg State */
274 /* RRC delivery message from RLC to DU APP */
275 typedef struct rrcDeliveryStatus
277 uint16_t deliveryStatus;
278 uint16_t triggeringMessage;
287 /*Pm Metric for NW Slicing from RLC to DUAPP*/
288 typedef struct slicePm
290 SliceIdentifier networkSliceIdentifier;
295 typedef struct slicePmList
298 SlicePm *sliceRecord;
301 typedef struct rrcDeliveryReportInfo
306 RrcDeliveryStatus rrcDeliveryStatus;
309 /* DL Data Message from DU APP to RLC */
310 typedef struct dlDataMsgInfo
312 uint16_t cellId; /* Cell Id */
313 uint16_t ueId; /* UE Id */
314 uint8_t rbId; /* Radio Bearer Id */
315 uint16_t msgLen; /* Message length */
316 Buffer *dlMsg; /* DL Data */
319 /* Function Pointers */
320 /* UE create Request from DU APP to RLC*/
321 typedef uint8_t (*DuRlcUeCreateReq) ARGS((
325 /* UE Cfg Response from RLC to DU APP*/
326 typedef uint8_t (*RlcDuUeCfgRsp) ARGS((
328 RlcUeCfgRsp *ueCfgRsp));
330 /* UE Delete Response from RLC to DU APP*/
331 typedef uint8_t (*RlcDuUeDeleteRsp) ARGS((
333 RlcUeDeleteRsp *ueDelRsp));
335 /* UL RRC Message from RLC to DU APP */
336 typedef uint8_t (*RlcUlRrcMsgToDuFunc) ARGS((
338 RlcUlRrcMsgInfo *ulRrcMsgInfo));
340 /* DL RRC Message from DU APP to RLC */
341 typedef uint8_t (*DuDlRrcMsgToRlcFunc) ARGS((
343 RlcDlRrcMsgInfo *dlRrcMsgInfo));
345 /* RRC delivery message from RLC to DU APP */
346 typedef uint8_t (*RlcRrcDeliveryReportToDuFunc) ARGS((
348 RrcDeliveryReport *rrcDeliveryReport));
350 /* UE Reconfig Request from DU APP to RLC */
351 typedef uint8_t (*DuRlcUeReconfigReq) ARGS((
355 /* UE Delete Request from DU APP to RLC */
356 typedef uint8_t (*DuRlcUeDeleteReq) ARGS((
358 RlcUeDelete *ueDelete));
360 /* DL RRC Message from RLC to DU APP */
361 typedef uint8_t (*RlcDlRrcMsgRspToDuFunc) ARGS((
363 RlcDlRrcMsgRsp *dlRrcMsgRsp));
365 /* UL User data from RLC to DU APP */
366 typedef uint8_t (*RlcUlUserDataToDuFunc) ARGS((
368 RlcUlUserDatInfo *ulUserData));
370 /* DL User Data from DU APP to RLC */
371 typedef uint8_t (*DuRlcDlUserDataToRlcFunc) ARGS((
373 RlcDlUserDataInfo *dlDataMsg));
375 /* Slice Metrics from RLC to DU APP */
376 typedef uint8_t (*RlcSlicePmToDuFunc) ARGS((
378 SlicePmList *sliceStats));
380 /* Pack/Unpack function declarations */
381 uint8_t packDuRlcUeCreateReq(Pst *pst, RlcUeCfg *ueCfg);
382 uint8_t unpackRlcUeCreateReq(DuRlcUeCreateReq func, Pst *pst, Buffer *mBuf);
383 uint8_t packRlcDuUeCfgRsp(Pst *pst, RlcUeCfgRsp *ueCfgRsp);
384 uint8_t unpackRlcUeCfgRsp(RlcDuUeCfgRsp func, Pst *pst, Buffer *mBuf);
385 uint8_t packRlcUlRrcMsgToDu(Pst *pst, RlcUlRrcMsgInfo *ulRrcMsgInfo);
386 uint8_t unpackRlcUlRrcMsgToDu(RlcUlRrcMsgToDuFunc func, Pst *pst, Buffer *mBuf);
387 uint8_t packDlRrcMsgToRlc(Pst *pst, RlcDlRrcMsgInfo *dlRrcMsgInfo);
388 uint8_t unpackDlRrcMsgToRlc(DuDlRrcMsgToRlcFunc func, Pst *pst, Buffer *mBuf);
389 uint8_t packRrcDeliveryReportToDu(Pst *pst, RrcDeliveryReport *rrcDeliveryReport);
390 uint8_t unpackRrcDeliveryReportToDu(RlcRrcDeliveryReportToDuFunc func,Pst *pst, Buffer *mBuf);
391 uint8_t packDuRlcUeReconfigReq(Pst *pst, RlcUeCfg *ueCfg);
392 uint8_t unpackRlcUeReconfigReq(DuRlcUeReconfigReq func, Pst *pst, Buffer *mBuf);
393 uint8_t packRlcDlRrcMsgRspToDu(Pst *pst, RlcDlRrcMsgRsp *dlRrcMsgRsp);
394 uint8_t unpackRlcDlRrcMsgRspToDu(RlcDlRrcMsgRspToDuFunc func, Pst *pst, Buffer *mBuf);
395 uint8_t packRlcUlUserDataToDu(Pst *pst, RlcUlUserDatInfo *ulUserData);
396 uint8_t unpackRlcUlUserDataToDu(RlcUlUserDataToDuFunc func, Pst *pst, Buffer *mBuf);
397 uint8_t packRlcDlUserDataToRlc(Pst *pst, RlcDlUserDataInfo *dlDataMsg);
398 uint8_t unpackRlcDlUserDataToRlc(DuRlcDlUserDataToRlcFunc func, Pst *pst, Buffer *mBuf);
399 uint8_t packDuRlcUeDeleteReq(Pst *pst, RlcUeDelete *ueDelete);
400 uint8_t unpackRlcUeDeleteReq(DuRlcUeDeleteReq func, Pst *pst, Buffer *mBuf);
401 uint8_t packRlcDuUeDeleteRsp(Pst *pst, RlcUeDeleteRsp *ueDeleteRsp);
402 uint8_t unpackRlcUeDeleteRsp(RlcDuUeDeleteRsp func, Pst *pst, Buffer *mBuf);
403 uint8_t packRlcDuSlicePm(Pst *pst, SlicePmList *sliceStats);
404 uint8_t unpackRlcSlicePm(RlcSlicePmToDuFunc func, Pst *pst, Buffer *mBuf);
406 /* Event Handler function declarations */
407 uint8_t RlcProcUeCreateReq(Pst *pst, RlcUeCfg *ueCfg);
408 uint8_t DuProcRlcUeCfgRsp(Pst *pst, RlcUeCfgRsp *cfgRsp);
409 uint8_t DuProcRlcUlRrcMsgTrans(Pst *pst, RlcUlRrcMsgInfo *ulRrcMsgInfo);
410 uint8_t RlcProcDlRrcMsgTransfer(Pst *pst, RlcDlRrcMsgInfo *dlRrcMsgInfo);
411 uint8_t DuProcRlcRrcDeliveryReport(Pst *pst, RrcDeliveryReport *rrcDeliveryReport);
412 uint8_t RlcProcUeReconfigReq(Pst *pst, RlcUeCfg *ueCfg);
413 uint8_t DuProcRlcDlRrcMsgRsp(Pst *pst, RlcDlRrcMsgRsp *dlRrcMsg);
414 uint8_t DuProcRlcUlUserDataTrans(Pst *pst, RlcUlUserDatInfo *ulUserData);
415 uint8_t RlcProcDlUserDataTransfer(Pst *pst, RlcDlUserDataInfo *dlDataMsgInfo);
416 uint8_t RlcProcUeDeleteReq(Pst *pst, RlcUeDelete *ueDelete);
417 uint8_t DuProcRlcUeDeleteRsp(Pst *pst, RlcUeDeleteRsp *delRsp);
418 uint8_t DuProcRlcSliceMetrics(Pst *pst, SlicePmList *sliceStats);
419 #endif /* RLC_INF_H */
421 /**********************************************************************
423 **********************************************************************/