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_DU 218
33 #define EVENT_UL_USER_DATA_TRANS_TO_DU 219
38 #define RB_TYPE_SRB 0 /* Signalling Radio Bearer */
39 #define RB_TYPE_DRB 1 /* Data Radio Bearer */
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 TRANSMISSION_IN_PROGRESS,
57 TRANSMISSION_COMPLETE,
63 RLC_CFG_REAS_NONE , /*!< No Failure */
64 RLC_CFG_REAS_RB_CREAT_FAIL , /*!< RB CB creation Failure */
65 RLC_CFG_REAS_UE_CREAT_FAIL , /*!< UE CB creation Failure */
66 RLC_CFG_REAS_CELL_CREAT_FAIL , /*!< CELL CB creation Failure */
67 RLC_CFG_REAS_RB_PRSNT , /*!< RB CB already present */
68 RLC_CFG_REAS_LCHTYPE_MIS , /*!< Logical channel type mismatch */
69 RLC_CFG_REAS_RB_UNKWN , /*!< RB Cb unknown */
70 RLC_CFG_REAS_UE_UNKWN , /*!< UE Cb unknown */
71 RLC_CFG_REAS_CELL_UNKWN , /*!< Cell Cb unknown */
72 RLC_CFG_REAS_RB_DEL_FAIL , /*!< RB Cb Deletion Failure */
73 RLC_CFG_REAS_UE_DEL_FAIL , /*!< UE Cb Deletion Failure */
74 RLC_CFG_REAS_RB_REEST_FAIL , /*!< RB Cb Re establish Failure */
75 RLC_CFG_REAS_RB_MODE_MIS , /*!< RB Cb Mode mismatch */
76 RLC_CFG_REAS_REEST_FAIL , /*!< RB Cb Re-establishment Failed */
77 RLC_CFG_REAS_RECFG_FAIL , /*!< RB Cb Re-configuration Failed */
78 RLC_CFG_REAS_INVALID_CFG , /*!< Invalid Configuration Type */
79 RLC_CFG_REAS_SAME_UEID , /*!< UE Ids match in ChngUeId Request */
80 RLC_CFG_REAS_CELL_DEL_FAIL , /*!< Cell Cb Deletion Failure */
81 RLC_CFG_REAS_INVALID_LCHID , /*!< Invalid LChId */
82 RLC_CFG_REAS_INVALID_DIR , /*!< Invalid Direction */
83 RLC_CFG_REAS_UE_EXISTS , /*!< UE ID already exists */
84 RLC_CFG_REAS_INVALID_SNLEN , /*!< Invalid SN Length */
85 RLC_CFG_REAS_SNLEN_MIS , /*!< SN Length mismatch */
86 RLC_CFG_REAS_INVALID_RGUSAP /*!< Invalid RGU SAP ID */
91 RLC_AM, //Acknowledged Mode
92 RLC_UM_BI_DIRECTIONAL, //UnAcknowledged Mode
93 RLC_UM_UNI_DIRECTIONAL_UL,
94 RLC_UM_UNI_DIRECTIONAL_DL
231 typedef struct ulAmCfg
233 SnLenAm snLenUl; /* Sequence Number length in bits. Allowed values are 12 and 18 */
234 TReAssembleTmr reAssemTmr; /* T_reassembling Timer in msec*/
235 TStatProhTmr statProhTmr; /* T_status_prohibit Timer in msec*/
239 typedef struct dlAmCfg
241 SnLenAm snLenDl; /* Sequence Number length in bits. Allowed values are 12 and 18 */
242 uint16_t pollRetxTmr; /* T_poll_retransmit Timer in msec */
243 int16_t pollPdu; /* Used to trigger a poll for every pollPdu.*/
244 int32_t pollByte; /* Poll_Byte in bytes. */
245 uint8_t maxRetxTh; /* Max_Retx_Threshold */
249 typedef struct dlUmCfg
251 SnLenUm snLenDlUm; /* Sequence Number length in bits. Allowed values are 6 and 12 */
255 typedef struct ulUmCfg
257 SnLenUm snLenUlUm; /* Sequence Number length in bits. Allowed values are 6 and 12 */
258 TReAssembleTmr reAssemTmr; /* T_reassembling Timer in msec*/
262 typedef struct amBearerCfg
268 typedef struct umBiDirBearerCfg
274 typedef struct umUniDirUlBearerCfg
277 }UmUniDirUlBearerCfg;
279 typedef struct umUniDirDlBearerCfg
282 }UmUniDirDlBearerCfg;
284 /* Spec Ref: 38.331, 6.3.2 RLC-BearerConfig */
285 typedef struct rlcBearerCfg
287 ConfigType configType;
296 UmBiDirBearerCfg *umBiDirCfg;
297 UmUniDirUlBearerCfg *umUniDirUlCfg;
298 UmUniDirDlBearerCfg *umUniDirDlCfg;
302 typedef struct rlcUeCfg
307 RlcBearerCfg rlcLcCfg[MAX_NUM_LC];
308 UeCfgState rlcUeCfgState; /* InActive / Completed */
311 typedef struct rlcUeCfgRsp
316 FailureReason reason;
319 /* UL RRC Message from RLC to DU APP */
320 typedef struct ulRrcMsgInfo
322 uint16_t cellId; /* Cell Id */
323 uint16_t ueIdx; /* UE Index */
324 uint8_t lcId; /* Logical channel Id */
325 uint16_t msgLen; /* RRC message length (in bytes) */
326 uint8_t *rrcMsg; /* RRC Message (UL-DCCH Message) */
329 /* UL User Data from RLC to DU APP */
330 typedef struct ulUserDatInfo
332 uint16_t cellId; /* Cell Id */
333 uint16_t ueIdx; /* UE Index */
335 uint16_t msgLen; /* User data length (in bytes) */
336 uint8_t *userData; /* User data (UL-DTCH Message) */
339 /* DL RRC Message from DU APP to RLC */
340 typedef struct dlRrcMsgInfo
342 uint16_t cellId; /* Cell Id */
343 uint16_t ueIdx; /* UE index */
344 uint8_t rbType; /* Radio Bearer Type */
345 uint8_t rbId; /* Radio Bearer Id */
346 uint8_t lcType; /* Logical channel type */
347 uint8_t lcId; /* Logical channel Id */
348 bool execDup; /* Execution duplication enabled */
349 bool deliveryStaRpt; /* Reporting of delivery status by RLC to DU-APP enabled */
350 uint16_t msgLen; /* RRC Message length */
351 uint8_t *rrcMsg; /* RRC Message (DL-DCCH Message) */
354 /* DL RRC Message Rsp From RLC to DU APP */
355 typedef struct dlRrcMsgRsp
357 uint16_t cellId; /* Cell Id */
358 uint16_t crnti; /* UE index */
359 DlMsgState state; /* Dl RRC Msg State */
362 /* RRC delivery message from RLC to DU APP */
363 typedef struct rrcDeliveryStatus
365 uint16_t deliveryStatus;
366 uint16_t triggeringMessage;
369 typedef struct rrcDeliveryReportInfo
374 RrcDeliveryStatus rrcDeliveryStatus;
377 /* Function Pointers */
378 /* UE create Request from DU APP to RLC*/
379 typedef uint8_t (*DuRlcUeCreateReq) ARGS((
383 /* UE Cfg Response from RLC to DU APP*/
384 typedef uint8_t (*RlcDuUeCfgRsp) ARGS((
386 RlcUeCfgRsp *ueCfgRsp));
388 /* UL RRC Message from RLC to DU APP */
389 typedef uint8_t (*RlcUlRrcMsgToDuFunc) ARGS((
391 RlcUlRrcMsgInfo *ulRrcMsgInfo));
393 /* DL RRC Message from DU APP to RLC */
394 typedef uint8_t (*DuDlRrcMsgToRlcFunc) ARGS((
396 RlcDlRrcMsgInfo *dlRrcMsgInfo));
398 /* RRC delivery message from RLC to DU APP */
399 typedef uint8_t (*RlcRrcDeliveryReportToDuFunc) ARGS((
401 RrcDeliveryReport *rrcDeliveryReport));
403 typedef uint8_t (*DuRlcUeReconfigReq) ARGS((
407 /* DL RRC Message from RLC to DU APP */
408 typedef uint8_t (*RlcDlRrcMsgRspToDuFunc) ARGS((
410 RlcDlRrcMsgRsp *dlRrcMsgRsp));
412 /* UL User data from RLC to DU APP */
413 typedef uint8_t (*RlcUlUserDataToDuFunc) ARGS((
415 RlcUlUserDatInfo *ulUserData));
417 /* Pack/Unpack function declarations */
418 uint8_t packDuRlcUeCreateReq(Pst *pst, RlcUeCfg *ueCfg);
419 uint8_t unpackRlcUeCreateReq(DuRlcUeCreateReq func, Pst *pst, Buffer *mBuf);
420 uint8_t packRlcDuUeCfgRsp(Pst *pst, RlcUeCfgRsp *ueCfgRsp);
421 uint8_t unpackRlcUeCfgRsp(RlcDuUeCfgRsp func, Pst *pst, Buffer *mBuf);
422 uint8_t packRlcUlRrcMsgToDu(Pst *pst, RlcUlRrcMsgInfo *ulRrcMsgInfo);
423 uint8_t unpackRlcUlRrcMsgToDu(RlcUlRrcMsgToDuFunc func, Pst *pst, Buffer *mBuf);
424 uint8_t packDlRrcMsgToRlc(Pst *pst, RlcDlRrcMsgInfo *dlRrcMsgInfo);
425 uint8_t unpackDlRrcMsgToRlc(DuDlRrcMsgToRlcFunc func, Pst *pst, Buffer *mBuf);
426 uint8_t packRrcDeliveryReportToDu(Pst *pst, RrcDeliveryReport *rrcDeliveryReport);
427 uint8_t unpackRrcDeliveryReportToDu(RlcRrcDeliveryReportToDuFunc func,Pst *pst, Buffer *mBuf);
428 uint8_t packDuRlcUeReconfigReq(Pst *pst, RlcUeCfg *ueCfg);
429 uint8_t unpackRlcUeReconfigReq(DuRlcUeReconfigReq func, Pst *pst, Buffer *mBuf);
430 uint8_t packRlcDlRrcMsgRspToDu(Pst *pst, RlcDlRrcMsgRsp *dlRrcMsgRsp);
431 uint8_t unpackRlcDlRrcMsgRspToDu(RlcDlRrcMsgRspToDuFunc func, Pst *pst, Buffer *mBuf);
432 uint8_t packRlcUlUserDataToDu(Pst *pst, RlcUlUserDatInfo *ulUserData);
433 uint8_t unpackRlcUlUserDataToDu(RlcUlUserDataToDuFunc func, Pst *pst, Buffer *mBuf);
435 /* Event Handler function declarations */
436 uint8_t RlcProcUeCreateReq(Pst *pst, RlcUeCfg *ueCfg);
437 uint8_t DuProcRlcUeCfgRsp(Pst *pst, RlcUeCfgRsp *cfgRsp);
438 uint8_t DuProcRlcUlRrcMsgTrans(Pst *pst, RlcUlRrcMsgInfo *ulRrcMsgInfo);
439 uint8_t RlcProcDlRrcMsgTransfer(Pst *pst, RlcDlRrcMsgInfo *dlRrcMsgInfo);
440 uint8_t DuProcRlcRrcDeliveryReport(Pst *pst, RrcDeliveryReport *rrcDeliveryReport);
441 uint8_t RlcProcUeReconfigReq(Pst *pst, RlcUeCfg *ueCfg);
442 uint8_t DuProcRlcDlRrcMsgRsp(Pst *pst, RlcDlRrcMsgRsp *dlRrcMsg);
443 uint8_t DuProcRlcUlUserDataTrans(Pst *pst, RlcUlUserDatInfo *ulUserData);
445 #endif /* RLC_INF_H */
447 /**********************************************************************
449 **********************************************************************/