src/cm/du_app_rlc_inf.h

   1 /*******************************************************************************
   2 ################################################################################
   3 #   Copyright (c) [2017-2019] [Radisys]                                        #
   4 #                                                                              #
   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                                    #
   8 #                                                                              #
   9 #       http://www.apache.org/licenses/LICENSE-2.0                             #
  10 #                                                                              #
  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 *******************************************************************************/
  18
  19 /* Defines APIs exchanged between du_app and cl module of RLC */
  20 #ifndef __RLC_INF_H__
  21 #define __RLC_INF_H__
  22
  23 /* Macro for Ue Context */
  24 #define MAX_NUM_LOGICAL_CHANNELS 11
  25 #define EVENT_RLC_UL_UE_CREATE_REQ  210
  26 #define EVENT_RLC_UL_UE_CREATE_RSP 211    /*!< Config Confirm */
  27 #define EVENT_UL_RRC_MSG_TRANS_TO_DU  212
  28
  29 #define RB_ID_SRB 0
  30 #define RB_ID_DRB 1
  31
  32 #define RB_TYPE_SRB 0        /* Signalling Radio Bearer */
  33 #define RB_TYPE_DRB 1        /* Data Radio Bearer */
  34
  35 /* RLC Direction Config */
  36 #define RLC_CFG_DIR_UL        1     /*!< Uplink direction */
  37 #define RLC_CFG_DIR_DL        2     /*!< Downlink direction */
  38 #define RLC_CFG_DIR_BOTH      3     /*!< Both Downlink and Uplink Direction*/
  39
  40
  41 /* Logical Channel Type */
  42 #define LCH_BCCH      1      /*!< BCCH Logical Channel */
  43 #define LCH_PCCH      2      /*!< PCCH Logical Channel */
  44 #define LCH_CCCH      3      /*!< CCCH Logical Channel */
  45 #define LCH_DTCH      4      /*!< DTCH Logical Channel */
  46 #define LCH_DCCH      5      /*!< DCCH Logical Channel */
  47
  48
  49 typedef enum
  50 {
  51    RLC_CFG_REAS_NONE            ,  /*!< No Failure */
  52    RLC_CFG_REAS_RB_CREAT_FAIL   ,  /*!< RB CB creation Failure */
  53    RLC_CFG_REAS_UE_CREAT_FAIL   ,  /*!< UE CB creation Failure */
  54    RLC_CFG_REAS_CELL_CREAT_FAIL ,  /*!< CELL CB creation Failure */
  55    RLC_CFG_REAS_RB_PRSNT        ,  /*!< RB CB already present */
  56    RLC_CFG_REAS_LCHTYPE_MIS     ,  /*!< Logical channel type mismatch */
  57    RLC_CFG_REAS_RB_UNKWN        ,  /*!< RB Cb unknown */
  58    RLC_CFG_REAS_UE_UNKWN        ,  /*!< UE Cb unknown */
  59    RLC_CFG_REAS_CELL_UNKWN      ,  /*!< Cell Cb unknown */
  60    RLC_CFG_REAS_RB_DEL_FAIL     ,  /*!< RB Cb Deletion Failure */
  61    RLC_CFG_REAS_UE_DEL_FAIL     ,  /*!< UE Cb Deletion Failure */
  62    RLC_CFG_REAS_RB_REEST_FAIL   ,  /*!< RB Cb Re establish Failure */
  63    RLC_CFG_REAS_RB_MODE_MIS     ,  /*!< RB Cb Mode mismatch */
  64    RLC_CFG_REAS_REEST_FAIL      ,  /*!< RB Cb Re-establishment Failed */
  65    RLC_CFG_REAS_RECFG_FAIL      ,  /*!< RB Cb Re-configuration Failed */
  66    RLC_CFG_REAS_INVALID_CFG     ,  /*!< Invalid Configuration Type */
  67    RLC_CFG_REAS_SAME_UEID       ,  /*!< UE Ids match in ChngUeId Request */
  68    RLC_CFG_REAS_CELL_DEL_FAIL   ,  /*!< Cell Cb Deletion Failure */
  69    RLC_CFG_REAS_INVALID_LCHID   ,  /*!< Invalid LChId */
  70    RLC_CFG_REAS_INVALID_DIR     ,  /*!< Invalid Direction */
  71    RLC_CFG_REAS_UE_EXISTS       ,  /*!< UE ID already exists */
  72    RLC_CFG_REAS_INVALID_SNLEN   ,  /*!< Invalid SN Length */
  73    RLC_CFG_REAS_SNLEN_MIS       ,  /*!< SN Length mismatch */
  74    RLC_CFG_REAS_INVALID_RGUSAP     /*!< Invalid RGU SAP ID */
  75 }FailureReason;
  76
  77 typedef enum
  78 {
  79    RLC_AM,                    //Acknowledged Mode
  80    RLC_UM_BI_DIRECTIONAL,     //UnAcknowledged Mode
  81    RLC_UM_UNI_DIRECTIONAL_UL,
  82    RLC_UM_UNI_DIRECTIONAL_DL
  83 }RlcMode;
  84
  85 typedef enum
  86 {
  87    AM_SIZE_12,
  88    AM_SIZE_18
  89 }SnLenAm;
  90
  91 typedef enum
  92 {
  93    UM_SIZE_6,
  94    UM_SIZE_12
  95 }SnLenUm;
  96
  97 typedef enum
  98 {
  99    POLL_RETX_TMR_5MS,
 100    POLL_RETX_TMR_10MS,
 101    POLL_RETX_TMR_15MS,
 102    POLL_RETX_TMR_20MS,
 103    POLL_RETX_TMR_25MS,
 104    POLL_RETX_TMR_30MS,
 105    POLL_RETX_TMR_35MS,
 106    POLL_RETX_TMR_40MS,
 107    POLL_RETX_TMR_45MS,
 108    POLL_RETX_TMR_50MS,
 109    POLL_RETX_TMR_55MS,
 110    POLL_RETX_TMR_60MS,
 111    POLL_RETX_TMR_65MS,
 112    POLL_RETX_TMR_70MS,
 113    POLL_RETX_TMR_75MS,
 114    POLL_RETX_TMR_80MS,
 115    POLL_RETX_TMR_85MS,
 116    POLL_RETX_TMR_90MS,
 117    POLL_RETX_TMR_95MS,
 118    POLL_RETX_TMR_100MS,
 119    POLL_RETX_TMR_105MS,
 120    POLL_RETX_TMR_110MS,
 121    POLL_RETX_TMR_115MS,
 122    POLL_RETX_TMR_120MS,
 123    POLL_RETX_TMR_125MS,
 124    POLL_RETX_TMR_130MS,
 125    POLL_RETX_TMR_135MS,
 126    POLL_RETX_TMR_140MS,
 127    POLL_RETX_TMR_145MS,
 128    POLL_RETX_TMR_150MS,
 129    POLL_RETX_TMR_155MS,
 130    POLL_RETX_TMR_160MS,
 131    POLL_RETX_TMR_165MS,
 132    POLL_RETX_TMR_170MS,
 133    POLL_RETX_TMR_175MS,
 134    POLL_RETX_TMR_180MS,
 135    POLL_RETX_TMR_185MS,
 136    POLL_RETX_TMR_190MS,
 137    POLL_RETX_TMR_195MS,
 138    POLL_RETX_TMR_200MS,
 139    POLL_RETX_TMR_205MS,
 140    POLL_RETX_TMR_210MS,
 141    POLL_RETX_TMR_215MS,
 142    POLL_RETX_TMR_220MS,
 143    POLL_RETX_TMR_225MS,
 144    POLL_RETX_TMR_230MS,
 145    POLL_RETX_TMR_235MS,
 146    POLL_RETX_TMR_240MS,
 147    POLL_RETX_TMR_245MS,
 148    POLL_RETX_TMR_250MS,
 149    POLL_RETX_TMR_300MS,
 150    POLL_RETX_TMR_350MS,
 151    POLL_RETX_TMR_400MS,
 152    POLL_RETX_TMR_450MS,
 153    POLL_RETX_TMR_500MS,
 154    POLL_RETX_TMR_800MS,
 155    POLL_RETX_TMR_1000MS,
 156    POLL_RETX_TMR_2000MS,
 157    POLL_RETX_TMR_4000MS,
 158    POLL_RETX_TMR_SPARE5,
 159    POLL_RETX_TMR_SPARE4,
 160    POLL_RETX_TMR_SPARE3,
 161    POLL_RETX_TMR_SPARE2,
 162    POLL_RETX_TMR_SPARE1
 163
 164 }TpollReTxTmr;
 165
 166 typedef enum
 167 {
 168    POLL_PDU_TMR_4MS,
 169    POLL_PDU_TMR_8MS,
 170    POLL_PDU_TMR_16MS,
 171    POLL_PDU_TMR_32MS,
 172    POLL_PDU_TMR_64MS,
 173    POLL_PDU_TMR_128MS,
 174    POLL_PDU_TMR_256MS,
 175    POLL_PDU_TMR_512MS,
 176    POLL_PDU_TMR_1024MS,
 177    POLL_PDU_TMR_2048MS,
 178    POLL_PDU_TMR_4096MS,
 179    POLL_PDU_TMR_6144MS,
 180    POLL_PDU_TMR_8192MS,
 181    POLL_PDU_TMR_12288MS,
 182    POLL_PDU_TMR_16384MS,
 183    POLL_PDU_TMR_20480MS,
 184    POLL_PDU_TMR_24576MS,
 185    POLL_PDU_TMR_28672MS,
 186    POLL_PDU_TMR_32768MS,
 187    POLL_PDU_TMR_40960MS,
 188    POLL_PDU_TMR_49152MS,
 189    POLL_PDU_TMR_57344MS,
 190    POLL_PDU_TMR_65536MS,
 191    POLL_PDU_TMR_INFINITY,
 192    POLL_PDU_TMR_SPARE_8,
 193    POLL_PDU_TMR_SPARE_7,
 194    POLL_PDU_TMR_SPARE_6,
 195    POLL_PDU_TMR_SPARE_5,
 196    POLL_PDU_TMR_SPARE_4,
 197    POLL_PDU_TMR_SPARE_3,
 198    POLL_PDU_TMR_SPARE_2,
 199    POLL_PDU_TMR_SPARE_1
 200
 201 }PollPdu;
 202
 203 typedef enum
 204 {
 205    POLL_BYTES_1KB,
 206    POLL_BYTES_2KB,
 207    POLL_BYTES_5KB,
 208    POLL_BYTES_8KB,
 209    POLL_BYTES_10KB,
 210    POLL_BYTES_15KB,
 211    POLL_BYTES_25KB,
 212    POLL_BYTES_50KB,
 213    POLL_BYTES_75KB,
 214    POLL_BYTES_100KB,
 215    POLL_BYTES_125KB,
 216    POLL_BYTES_250KB,
 217    POLL_BYTES_375KB,
 218    POLL_BYTES_500KB,
 219    POLL_BYTES_750KB,
 220    POLL_BYTES_1000KB,
 221    POLL_BYTES_1250KB,
 222    POLL_BYTES_1500KB,
 223    POLL_BYTES_2000KB,
 224    POLL_BYTES_3000KB,
 225    POLL_BYTES_4000KB,
 226    POLL_BYTES_4500KB,
 227    POLL_BYTES_5000KB,
 228    POLL_BYTES_5500KB,
 229    POLL_BYTES_6000KB,
 230    POLL_BYTES_6500KB,
 231    POLL_BYTES_7000KB,
 232    POLL_BYTES_7500KB,
 233    POLL_BYTES_8MB,
 234    POLL_BYTES_9MB,
 235    POLL_BYTES_10MB,
 236    POLL_BYTES_11MB,
 237    POLL_BYTES_12MB,
 238    POLL_BYTES_13MB,
 239    POLL_BYTES_14MB,
 240    POLL_BYTES_15MB,
 241    POLL_BYTES_16MB,
 242    POLL_BYTES_17MB,
 243    POLL_BYTES_18MB,
 244    POLL_BYTES_20MB,
 245    POLL_BYTES_25MB,
 246    POLL_BYTES_30MB,
 247    POLL_BYTES_40MB,
 248    POLL_BYTES_INFINITY,
 249    POLL_BYTES_SPARE_20,
 250    POLL_BYTES_SPARE_19,
 251    POLL_BYTES_SPARE_18,
 252    POLL_BYTES_SPARE_17,
 253    POLL_BYTES_SPARE_16,
 254    POLL_BYTES_SPARE_15,
 255    POLL_BYTES_SPARE_14,
 256    POLL_BYTES_SPARE_13,
 257    POLL_BYTES_SPARE_12,
 258    POLL_BYTES_SPARE_11,
 259    POLL_BYTES_SPARE_10,
 260    POLL_BYTES_SPARE_9,
 261    POLL_BYTES_SPARE_8,
 262    POLL_BYTES_SPARE_7,
 263    POLL_BYTES_SPARE_6,
 264    POLL_BYTES_SPARE_5,
 265    POLL_BYTES_SPARE_4,
 266    POLL_BYTES_SPARE_3,
 267    POLL_BYTES_SPARE_2,
 268    POLL_BYTES_SPARE_1
 269
 270 }PollBytes;
 271
 272 typedef enum
 273 {
 274    RETX_TH_1,
 275    RETX_TH_2,
 276    RETX_TH_3,
 277    RETX_TH_4,
 278    RETX_TH_6,
 279    RETX_TH_8,
 280    RETX_TH_16,
 281    RETX_TH_32
 282
 283 }MaxRetxTh;
 284
 285 typedef enum
 286 {
 287    RE_ASM_0MS,
 288    RE_ASM_5MS,
 289    RE_ASM_10MS,
 290    RE_ASM_15MS,
 291    RE_ASM_20MS,
 292    RE_ASM_25MS,
 293    RE_ASM_30MS,
 294    RE_ASM_35MS,
 295    RE_ASM_40MS,
 296    RE_ASM_45MS,
 297    RE_ASM_50MS,
 298    RE_ASM_55MS,
 299    RE_ASM_60MS,
 300    RE_ASM_65MS,
 301    RE_ASM_70MS,
 302    RE_ASM_75MS,
 303    RE_ASM_80MS,
 304    RE_ASM_85MS,
 305    RE_ASM_90MS,
 306    RE_ASM_95MS,
 307    RE_ASM_100MS,
 308    RE_ASM_105MS,
 309    RE_ASM_110MS,
 310    RE_ASM_115MS,
 311    RE_ASM_120MS,
 312    RE_ASM_125MS,
 313    RE_ASM_130MS,
 314    RE_ASM_135MS,
 315    RE_ASM_140MS,
 316    RE_ASM_145MS,
 317    RE_ASM_150MS,
 318    RE_ASM_155MS,
 319    RE_ASM_160MS,
 320    RE_ASM_165MS,
 321    RE_ASM_170MS,
 322    RE_ASM_175MS,
 323    RE_ASM_180MS,
 324    RE_ASM_185MS,
 325    RE_ASM_190MS,
 326    RE_ASM_195MS,
 327    RE_ASM_200MS,
 328    RE_ASM_SPARE1
 329
 330 }TReAssembleTmr;
 331
 332 typedef enum
 333 {
 334    PROH_0MS,
 335    PROH_5MS,
 336    PROH_10MS,
 337    PROH_15MS,
 338    PROH_20MS,
 339    PROH_25MS,
 340    PROH_30MS,
 341    PROH_35MS,
 342    PROH_40MS,
 343    PROH_45MS,
 344    PROH_50MS,
 345    PROH_55MS,
 346    PROH_60MS,
 347    PROH_65MS,
 348    PROH_70MS,
 349    PROH_75MS,
 350    PROH_80MS,
 351    PROH_85MS,
 352    PROH_90MS,
 353    PROH_95MS,
 354    PROH_100MS,
 355    PROH_105MS,
 356    PROH_110MS,
 357    PROH_115MS,
 358    PROH_120MS,
 359    PROH_125MS,
 360    PROH_130MS,
 361    PROH_135MS,
 362    PROH_140MS,
 363    PROH_145MS,
 364    PROH_150MS,
 365    PROH_155MS,
 366    PROH_160MS,
 367    PROH_165MS,
 368    PROH_170MS,
 369    PROH_175MS,
 370    PROH_180MS,
 371    PROH_185MS,
 372    PROH_190MS,
 373    PROH_195MS,
 374    PROH_200MS,
 375    PROH_205MS,
 376    PROH_210MS,
 377    PROH_215MS,
 378    PROH_220MS,
 379    PROH_225MS,
 380    PROH_230MS,
 381    PROH_235MS,
 382    PROH_240MS,
 383    PROH_245MS,
 384    PROH_250MS,
 385    PROH_300MS,
 386    PROH_350MS,
 387    PROH_400MS,
 388    PROH_450MS,
 389    PROH_500MS,
 390    PROH_800MS,
 391    PROH_1000MS,
 392    PROH_1200MS,
 393    PROH_1600MS,
 394    PROH_2000MS,
 395    PROH_2400MS,
 396    PROH_SPARE2,
 397    PROH_SPARE1
 398
 399 }TStatProhTmr;
 400
 401 typedef enum
 402 {
 403    RLC_DU_APP_RSP_NOK,
 404    RLC_DU_APP_RSP_OK
 405 }RlcRsp;
 406
 407 typedef struct ulAmCfg
 408 {
 409    SnLenAm        snLenUl;              /* Sequence Number length in bits. Allowed values are 12 and 18 */
 410    TReAssembleTmr reAssemTmr;           /* T_reassembling Timer in msec*/
 411    TStatProhTmr   statProhTmr;          /* T_status_prohibit Timer in msec*/
 412
 413 }UlAmCfg;
 414
 415 typedef struct dlAmCfg
 416 {
 417    SnLenAm        snLenDl;             /* Sequence Number length in bits. Allowed values are 12 and 18 */
 418    TpollReTxTmr   pollRetxTmr;         /* T_poll_retransmit Timer in msec */
 419    PollPdu        pollPdu;             /* Used to trigger a poll for every pollPdu.*/
 420    PollBytes      pollByte;            /* Poll_Byte in bytes. */
 421    MaxRetxTh      maxRetxTh;           /* Max_Retx_Threshold */
 422
 423 }DlAmCfg;
 424
 425 typedef struct dlUmCfg
 426 {
 427    SnLenUm        snLenDlUm;             /* Sequence Number length in bits. Allowed values are 6 and 12 */
 428
 429 }DlUmCfg;
 430
 431 typedef struct ulUmCfg
 432 {
 433    SnLenUm        snLenUlUm;             /* Sequence Number length in bits. Allowed values are 6 and 12 */
 434    TReAssembleTmr reAssemTmr;            /* T_reassembling Timer in msec*/
 435
 436 }UlUmCfg;
 437
 438 typedef struct amBearerCfg
 439 {
 440    UlAmCfg  ulAmCfg;
 441    DlAmCfg  dlAmCfg;
 442 }AmBearerCfg;
 443
 444 typedef struct umBiDirBearerCfg
 445 {
 446    UlUmCfg  ulUmCfg;
 447    DlUmCfg  dlUmCfg;
 448 }UmBiDirBearerCfg;
 449
 450 typedef struct umUniDirUlBearerCfg
 451 {
 452    UlUmCfg  ulUmCfg;
 453 }UmUniDirUlBearerCfg;
 454
 455 typedef struct umUniDirDlBearerCfg
 456 {
 457    DlUmCfg  dlUmCfg;
 458 }UmUniDirDlBearerCfg;
 459
 460 /* Spec Ref: 38.331, 6.3.2 RLC-BearerConfig */
 461 typedef struct rlcBearerCfg
 462 {
 463    uint8_t      rbId;
 464    uint8_t      rbType;
 465    uint8_t      lcId;
 466    uint8_t      lcType;
 467    RlcMode      rlcMode;
 468    union
 469    {
 470       AmBearerCfg         amCfg;
 471       UmBiDirBearerCfg    umBiDirCfg;
 472       UmUniDirUlBearerCfg umUniDirUlCfg;
 473       UmUniDirDlBearerCfg umUniDirDlCfg;
 474    }u;
 475 }RlcBearerCfg;
 476
 477 typedef struct rlcUeCfg
 478 {
 479    uint16_t     cellId;
 480    uint8_t      ueIdx;
 481    uint8_t      numLcs;
 482    RlcBearerCfg rlcBearerCfg[MAX_NUM_LOGICAL_CHANNELS];
 483 }RlcUeCfg;
 484
 485 typedef struct rlcUeCfgRsp
 486 {
 487    uint16_t       cellId;
 488    uint16_t       ueIdx;
 489    RlcRsp         result;
 490    FailureReason  reason;
 491 }RlcUeCfgRsp;
 492
 493 /* UL RRC Message from RLC to DU APP */
 494 typedef struct ulRrcMsgInfo
 495 {
 496    uint16_t   cellId;       /* Cell Id */
 497    uint16_t   ueIdx;        /* UE Index */
 498    uint8_t    lcId;         /* Logical channel Id */
 499    uint16_t   msgLen;       /* RRC message length (in bytes) */
 500    uint8_t    *rrcMsg;      /* RRC Message (UL-DCCH Message) */
 501 }RlcUlRrcMsgInfo;
 502
 503 /* Function Pointers */
 504 /* UE create Request from DU APP to RLC*/
 505 typedef uint8_t (*DuRlcUlUeCreateReq) ARGS((
 506    Pst           *pst,
 507    RlcUeCfg      *ueCfg ));
 508
 509 /* UE create Response from RLC to DU APP*/
 510 typedef uint8_t (*RlcUlDuUeCreateRsp) ARGS((
 511    Pst          *pst,
 512    RlcUeCfgRsp  *ueCfgRsp));
 513
 514 /* UL RRC Message from RLC to DU APP */
 515 typedef uint8_t (*RlcUlRrcMsgToDuFunc) ARGS((
 516    Pst           *pst,
 517    RlcUlRrcMsgInfo *ulRrcMsgInfo));
 518
 519 /* Function Declarations */
 520 uint8_t packDuRlcUlUeCreateReq(Pst *pst, RlcUeCfg *ueCfg);
 521 uint8_t unpackRlcUlUeCreateReq(DuRlcUlUeCreateReq func, Pst *pst, Buffer *mBuf);
 522 uint8_t RlcUlProcUeCreateReq(Pst *pst, RlcUeCfg *ueCfg);
 523 uint8_t packRlcUlDuUeCreateRsp(Pst *pst, RlcUeCfgRsp *ueCfgRsp);
 524 uint8_t unpackRlcUlUeCreateRsp(RlcUlDuUeCreateRsp func, Pst *pst, Buffer *mBuf);
 525 uint8_t DuProcRlcUlUeCreateRsp(Pst *pst, RlcUeCfgRsp *cfgRsp);
 526 uint8_t packRlcUlRrcMsgToDu(Pst *pst, RlcUlRrcMsgInfo *ulRrcMsgInfo);
 527 uint8_t DuProcRlcUlRrcMsgTrans(Pst *pst, RlcUlRrcMsgInfo *ulRrcMsgInfo);
 528 uint8_t unpackRlcUlRrcMsgToDu(RlcUlRrcMsgToDuFunc func, Pst *pst, Buffer *mBuf);
 529
 530 #endif /* RLC_INF_H */
 531
 532 /**********************************************************************
 533          End of file
 534 **********************************************************************/