src/5gnrrlc/rlc_utils.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 /**********************************************************************
  20
  21         Name:     NR RLC file
  22
  23         Type:     C include file
  24
  25         Desc:     This file contain the hash definations for RLC
  26
  27         File:     kw.h
  28
  29 **********************************************************************/
  30 /** @file rlc_utils.h
  31 @brief RLC Hash definitions
  32 */
  33
  34 #ifndef __RLC_UTILS_H__
  35 #define __RLC_UTILS_H__
  36
  37 #ifdef __cplusplus
  38 extern "C" {
  39 #endif /* __cplusplus */
  40
  41 #include "du_log.h"
  42 \f
  43
  44 #define EKWxxx 1
  45 #define EMG099 1
  46 #define EMG102 2
  47 #define EMG103 3
  48 #define EMG104 4
  49
  50 /* RLC-SPLIT Activity */
  51 #define RLC_ONE       1
  52 #define RLC_BIT0      0x01
  53 #define RLC_BIT1      0x02
  54 #define RLC_BIT2      0x04
  55 #define RLC_BIT3      0x08
  56
  57 #define RLC_2K_BYTE   2048
  58
  59 /* RLC RB flag bits */
  60 #define RLC_RB_REESTABLISH_DL  RLC_BIT0
  61 #define RLC_RB_REESTABLISH_UL  RLC_BIT1
  62 #define RLC_RB_DELETE_DL       RLC_BIT2
  63 #define RLC_RB_DELETE_UL       RLC_BIT3
  64
  65
  66 #define RLC_MOD_1024           0x3FF  /* used for MOD 1024 */
  67
  68
  69 \f
  70 /************************************************************************
  71  *                            SAP States
  72  ************************************************************************/
  73
  74 #define RLC_SAP_NOT_CFG        0     /*!< SAP Not Configured */
  75 #define RLC_SAP_CFG            1     /*!< SAP Configured but not not bound */
  76 #define RLC_SAP_BND            2     /*!< SAP Bound */
  77 #define RLC_SAP_BINDING        3     /*!< SAP Bind initiated */
  78 #define RLC_SAP_UBND           4     /*!< SAP Unbind */
  79
  80 #define RLC_MAX_SAP_BND_RETRY  3     /*!< Maximum SAP Bin Retries */
  81
  82 #define RLC_MAX_UE             0xffffffff  /*!< Maximum number of UEs. */
  83
  84 /* Maximum number of Saps */
  85 #define RLC_MAX_UDXSAPS        1     /*!< Maximum number of UDX Saps */
  86 #define RLC_MAX_KWUSAPS        2     /*!< Maximum number of KWU Saps. */
  87 #define RLC_MAX_CKWSAPS        1     /*!< Maximum number of CKW Saps. */
  88 /*MCELL changes*/
  89 #define RLC_MAX_RGUSAPS        4//5     /*!< Maximum number of RGU Saps. */
  90
  91 #define RLC_MAX_RGUSAP_TMR     1     /*!< Maximum number of RGU SAP Timers. */
  92
  93 #define RLC_UI_RRC             0     /*!< Upper interface RRC sap Id. */
  94 #define RLC_UI_PDCP            1     /*!< Upper interface PDCP sap Id. */
  95
  96 #ifdef LTE_L2_MEAS
  97 /* TODO. This works for FDD only. For TDD the array dimension
  98  * should be changed according to the number of Harq Procs */
  99 #define RLC_MAX_TB_PER_UE      64    /*!< Maximum number of tbCb for UE */
 100 #define RLC_INVALID_TBID       RLC_MAX_TB_PER_UE
 101 #endif
 102 /*******************************************************************************
 103  *                              Memory related Defines
 104  ******************************************************************************/
 105 /* Allocate function */
 106 #ifdef ODU_MEMORY_DEBUG_LOG
 107 #define RLC_MEM_LOG(_macro, _file, _line, _func, _size, _datPtr)\
 108 {\
 109    printf("\n%s=== %s +%d, %s, %d, %p\n",           \
 110          _macro, _file, _line, _func, _size, _datPtr); \
 111 }
 112 #else
 113 #define RLC_MEM_LOG(_macro, _file, _line, _func, _size, _dataPtr) {}
 114 #endif
 115
 116 #define RLC_ALLOC(_cb,_buf, _size)                                    \
 117 {                                                                    \
 118  if (SGetSBuf(_cb->init.region, _cb->init.pool, (Data **)&_buf,      \
 119                 (Size) _size) == ROK)                                \
 120    {                                                                 \
 121       RLC_MEM_LOG("RLC_ALLOC", __FILE__, __LINE__, __FUNCTION__, _size, _buf);\
 122       memset((_buf), 0, _size);                              \
 123    }                                                                 \
 124    else                                                              \
 125    {                                                                 \
 126       (_buf) = NULLP;                                                \
 127    }                                                                 \
 128 }
 129
 130 #define RLC_FREE(_cb,_buf, _size)                          \
 131 {                                                         \
 132    if (_buf != NULLP)                                     \
 133    {                                                      \
 134       RLC_MEM_LOG("RLC_FREE", __FILE__, __LINE__, __FUNCTION__, _size, _buf);\
 135       (Void) SPutSBuf(_cb->init.region, _cb->init.pool,   \
 136             (Data *) _buf, (Size) _size);                 \
 137       _buf = NULLP;                                       \
 138    }                                                      \
 139 }
 140
 141 #define RLC_FREE_SHRABL_BUF(_region, _pool,_buf, _size)    \
 142 {                                                         \
 143    if (_buf != NULLP)                                     \
 144    { \
 145       RLC_MEM_LOG("RLC_FREE_SHRABL_BUF", __FILE__, __LINE__, __FUNCTION__, _size, _buf);\
 146       (Void) SPutStaticBuffer(_region, _pool,             \
 147             (Data *) _buf, (Size) _size, 0);                 \
 148       _buf = NULLP;                                       \
 149    }                                                      \
 150 }
 151
 152 #define RLC_FREE_SHRABL_BUF_WC(_region, _pool,_buf, _size) \
 153 {                                                         \
 154  if (_buf != NULLP){\
 155       RLC_MEM_LOG("RLC_FREE_SHRABL_BUF_WC", __FILE__, __LINE__, __FUNCTION__, _size, _buf);\
 156   (Void) SPutStaticBuffer(_region, _pool,                 \
 157         (Data *) _buf, (Size) _size, 0);                 \
 158   _buf = NULLP;      \
 159   }\
 160 }
 161
 162 #define RLC_ALLOC_SHRABL_BUF_WC(_region, _pool,_buf, _size)           \
 163 {                                                                    \
 164    if(SGetStaticBuffer(_region, _pool, (Data **)&_buf,                    \
 165             (Size) _size, 0)==ROK)                                    \
 166    {\
 167       RLC_MEM_LOG("RLC_ALLOC_SHRABL_BUF_WC", __FILE__, __LINE__, __FUNCTION__, _size, _buf);\
 168    }\
 169    else\
 170    {\
 171       (_buf) = NULLP;\
 172    }\
 173 }
 174
 175 #define RLC_ALLOC_SHRABL_BUF(_region, _pool,_buf, _size)              \
 176 {                                                                    \
 177  if (SGetStaticBuffer(_region, _pool, (Data **)&_buf,                \
 178                 (Size) _size, 0) == ROK)                                \
 179    {                                                                 \
 180       RLC_MEM_LOG("RLC_ALLOC_SHRABL_BUF", __FILE__, __LINE__, __FUNCTION__, _size, _buf);\
 181       memset((_buf), 0, _size);                              \
 182    }                                                                 \
 183    else                                                              \
 184    {                                                                 \
 185       (_buf) = NULLP;                                                \
 186    }                                                                 \
 187 }
 188
 189 #define RLC_ALLOC_WC(_cb,_buf, _size)  \
 190 {\
 191    if(SGetSBuf(_cb->init.region, _cb->init.pool, (Data **)&_buf, (Size) _size) == ROK)\
 192    {\
 193       RLC_MEM_LOG("RLC_ALLOC_WC", __FILE__, __LINE__, __FUNCTION__, _size, _buf);\
 194    }\
 195 }
 196
 197 #define RLC_REMOVE_SDU(_cb,_sduQ,_sdu)              \
 198 {                                               \
 199    if(_sdu->mBuf)                               \
 200    {                                            \
 201       RLC_MEM_LOG("RLC_REMOVE_SDU", __FILE__, __LINE__, __FUNCTION__, _sdu->sduSz, _sdu->mBuf);\
 202       ODU_PUT_MSG_BUF(_sdu->mBuf);    \
 203    }                                            \
 204    cmLListDelFrm(_sduQ,&_sdu->lstEnt);          \
 205    RLC_FREE(_cb,_sdu, sizeof(RlcSdu));            \
 206 }
 207
 208 /* kw002.201 Freeing from region of pst */
 209 #define RLC_PST_FREE(_region, _pool, _buf, _size)          \
 210 {                                                         \
 211    if (_buf != NULLP)                                     \
 212    {                                                      \
 213       RLC_MEM_LOG("RLC_PST_FREE", __FILE__, __LINE__, __FUNCTION__, _size, _buf);\
 214       (Void) SPutSBuf(_region, _pool,                     \
 215                       (Data *) _buf, (Size) _size);       \
 216       _buf = NULLP;                                       \
 217    }                                                      \
 218 }
 219
 220 #ifdef XEON_SPECIFIC_CHANGES
 221 #ifdef SS_LOCKLESS_MEMORY
 222 #define RLC_SHRABL_STATIC_BUF_FREE(_region, _pool, _buf, _size)     \
 223 {                                                                  \
 224    if (_buf != NULLP)                                              \
 225    {                                                               \
 226       (Void) SPutStaticBuffer(_region, _pool,                      \
 227                       (Data *) _buf, (Size) _size, 0);             \
 228       _buf = NULLP;                                                \
 229    }                                                               \
 230 }
 231
 232 #define RLC_SHRABL_STATIC_BUF_ALLOC(_region, _pool, _buf, _size)     \
 233 {                                                                        \
 234  SGetStaticBuffer(_region, _pool, (Data **)&_buf,      \
 235                 (Size) _size, 0);                                        \
 236 }
 237
 238 #else
 239
 240 #define RLC_SHRABL_STATIC_BUF_FREE(_region, _pool, _buf, _size)     \
 241 {                                                                  \
 242    if (_buf != NULLP)                                              \
 243    {                                                               \
 244       (Void) SPutSBuf(_region, _pool,                      \
 245                       (Data *) _buf, (Size) _size);             \
 246       _buf = NULLP;                                                \
 247    }                                                               \
 248 }
 249
 250 #define RLC_SHRABL_STATIC_BUF_ALLOC(_region, _pool, _buf, _size)     \
 251 {                                                                        \
 252  SGetSBuf(_region, _pool, (Data **)&_buf,      \
 253                 (Size) _size);                                        \
 254 }
 255 #endif /* SS_LOCKLESS_MEMORY */
 256
 257 #else
 258
 259 #define RLC_SHRABL_STATIC_BUF_FREE(_region, _pool, _buf, _size)     \
 260 {                                                                  \
 261    if (_buf != NULLP)                                              \
 262    {                                                               \
 263       RLC_MEM_LOG("RLC_SHRABL_STATIC_BUF_FREE", __FILE__, __LINE__, __FUNCTION__, _size, _buf);\
 264       (Void) SPutStaticBuffer(_region, _pool,                      \
 265             (Data *) _buf, (Size) _size, 0);             \
 266       _buf = NULLP;                                                \
 267    }                                                               \
 268 }
 269
 270 #define RLC_SHRABL_STATIC_BUF_ALLOC(_region, _pool, _buf, _size)     \
 271 {                                                                        \
 272    SGetStaticBuffer(_region, _pool, (Data **)&_buf,      \
 273          (Size) _size, 0);                                        \
 274    RLC_MEM_LOG("RLC_SHRABL_STATIC_BUF_ALLOC", __FILE__, __LINE__, __FUNCTION__, _size, _buf);\
 275 }
 276 #endif
 277
 278 #define RLC_MEM_CPY(_dst, _src, _size)  memcpy(_dst, _src, _size);
 279
 280 #define RLC_MEM_ZERO(_buf, _size) memset((_buf), 0, _size);
 281
 282 #define RLC_GET_MEM_REGION(_cb) (_cb->init.region)
 283
 284 #define RLC_GET_MEM_POOL(_cb) (_cb->init.pool)
 285
 286 #define RLC_GET_MEM_POOL_ADDRESS(_cb) (&_cb->init.pool)
 287
 288 /* Memset to value */
 289 #define RLC_MEM_SET(_arg, _val, _size) memset(_arg, _val, _size);
 290
 291 /* Alarms */
 292 /* Send an alarm for sapId events */
 293 /* kw005.201 added support for L2 Measurement */
 294 #ifdef LTE_L2_MEAS
 295 #define RLC_GETSDUIDX(_sduIdx) \
 296 {\
 297    _sduIdx = (((_sduIdx)+1) % RLC_L2MEAS_MAX_OUTSTNGSDU);\
 298 }
 299 #define RLC_SEND_SAPID_ALARM(_cb,_sapId, _evnt, _cause) \
 300 { \
 301    rlcLmmSendAlarm(_cb,LCM_CATEGORY_INTERFACE, _evnt, _cause, _sapId, 0, 0); \
 302 }
 303 #define RLC_SEND_UEID_ALARM(_cb,_ueId, _qci, _evnt, _cause) \
 304 { \
 305    rlcLmmSendAlarm(_cb,LCM_CATEGORY_INTERFACE, _evnt, _cause, 0, _ueId, _qci); \
 306 }
 307 #else /* LTE_L2_MEAS */
 308 #define RLC_SEND_SAPID_ALARM(_cb,_sapId, _evnt, _cause) \
 309 { \
 310    rlcLmmSendAlarm(_cb,LCM_CATEGORY_INTERFACE, _evnt, _cause, _sapId, 0); \
 311 }
 312 #define RLC_SEND_UEID_ALARM(_cb,_ueId, _evnt, _cause) \
 313 { \
 314    rlcLmmSendAlarm(_cb,LCM_CATEGORY_INTERFACE, _evnt, _cause, 0, _ueId); \
 315 }
 316 #endif /* LTE_L2_MEAS */
 317
 318 /*******************************************************************************
 319  *                              Common Defines
 320  ******************************************************************************/
 321
 322 /* RLC Configuration parameters */
 323 #define RLC_MAX_UL_LI                (2 * RLC_MAX_LI)
 324 /*macro RLC_MAX_DL_LI is moved to rlc_env.h file */
 325 #define RLC_MAX_DAT                  RLC_MAXIMUM_DAT
 326 /*macro RLC_MAX_PDU is moved to rlc_env.h file */
 327 #define RLC_MAX_RB_PER_CELL          10
 328 #define RLC_MAX_SRB_PER_UE           3
 329 #define RLC_MAX_DRB_PER_UE           32
 330 #define RLC_MAX_LCH_PER_UE           12
 331 #define RLC_MAX_LCH_PER_CELL         6
 332 #define RLC_MAX_NUM_RB               24
 333 #define RLC_MAX_UE                   0xffffffff
 334 #define RLC_UE_LIST_BUCKET_SIZE      128
 335 #define RLC_CELL_LIST_BUCKET_SIZE    10
 336 #define RLC_TRANS_ID_LST_BKT_SIZE    10
 337 #define RLC_MAX_RB                   32
 338
 339 /* RLC Mode defines */
 340 #define RLC_MODE_TM 1
 341 #define RLC_MODE_UM 2
 342 #define RLC_MODE_AM 3
 343
 344 /* Direction defines */
 345 #define RLC_DIR_UL        1     /*!< Unlink direction */
 346 #define RLC_DIR_DL        2     /*!< Downlink direction */
 347 #define RLC_DIR_BOTH      3     /*!< Both Downlink and Unlink */
 348
 349 #define RLC_DEF_SEQ_NUM 0 /**< Sequence number to pick in case of duplicate
 350                               entries in hash list searches*/
 351
 352 /**
 353  * @def RLC_MIN
 354  *
 355  *    Macro to find the miniumum of two numbers
 356  *
 357  * @param[in] x    First number
 358  * @param[in] y    Second number
 359  *
 360 */
 361 #define RLC_MIN(x,y) (x) < (y) ? (x) : (y)
 362
 363 /**
 364  * @def RLC_GET_RLCCB
 365  *
 366  *    Macro to the RLC instance
 367  *
 368  * @param[in] _inst    Instance Id
 369  *
 370 */
 371 #define RLC_GET_RLCCB(_inst) rlcCb[_inst]
 372
 373 #define RLC_ADD_SDU            1     /*!< Add SDU. */
 374 #define RLC_DEL_SDU            2     /*!< Delete SDU. */
 375
 376 #define RLC_CFM_NOK            0     /*!< Do not send DatCfm */
 377 #define RLC_CFM_OK             1     /*!< Send DatCfm */
 378
 379 /* Set the unsolictated Status flag */
 380 #define RLC_SET_USTA_FLAG(_rlcCb, _value) \
 381 { \
 382    _rlcCb->init.usta = _value; \
 383 }
 384
 385 /* Macros to get the init parameters */
 386 #define RLC_GET_DBG_MASK(_rlcCb) (_rlcCb->init.dbgMask)
 387 #define RLC_GET_LMPST_MEM_POOL(_rlcCb) (_rlcCb->init.lmPst.pool)
 388 #define RLC_GET_LMPST_MEM_REGION(_rlcCb) (_rlcCb->init.lmPst.region)
 389
 390 /* Macros for configuration module */
 391 #define RLC_CFG_FILL_CFG_CFM(_entCfm, _rbId, _rbType, _status, _reason)  \
 392 {                                                              \
 393    _entCfm->rbId  = _rbId;                                     \
 394    _entCfm->rbType = _rbType;                                  \
 395    _entCfm->status.status = _status;                           \
 396    _entCfm->status.reason = _reason;                           \
 397 }
 398
 399 /**
 400  * @def RLC_VALIDATE_UE_RBID
 401  *
 402  *    This macro validates whether the _rbId passed is valid or not. It checks
 403  *    if the _rbId is within the maximum value depending on the _rbType.
 404  *    Returns TRUE if valid else FALSE
 405  *
 406  * @param[in] _rbType    Type of the Radio Bearer; SRB or DRB
 407  * @param[in] _rbId      RB Id of the RB to be validated
 408  *
 409 */
 410 #define RLC_VALIDATE_UE_RBID(_rbType, _rbId)                     \
 411        ((_rbType == CM_LTE_SRB && _rbId < RLC_MAX_SRB_PER_UE) || \
 412        (_rbType == CM_LTE_DRB && _rbId < RLC_MAX_DRB_PER_UE))
 413
 414 /*******************************************************************************
 415  *                              UIM Defines
 416  ******************************************************************************/
 417 #if (ERRCLASS & ERRCLS_INT_PAR)
 418 #define RLC_VALDATE_SAP(_cb,_chkSpId, _sap, _ret)                             \
 419 {                                                                            \
 420    if (_chkSpId != _sap->spId)                                               \
 421    {                                                                         \
 422       RLCLOGERROR(_cb,ERRCLS_DEBUG, EKWxxx, (ErrVal) RFAILED,                 \
 423             "Sap Id Validation Failed.");                                    \
 424       _ret = RFAILED;                                                        \
 425    }                                                                         \
 426    /* SAP state validation */                                                \
 427    if(_sap->state != RLC_SAP_BND)                                             \
 428    {                                                                         \
 429       RLCLOGERROR(_cb,ERRCLS_INT_PAR, EKWXXX, (ErrVal) RFAILED,               \
 430             "Sap State Invalid.");                                           \
 431       RLC_SEND_SAPID_ALARM(_cb,0, LCM_EVENT_UI_INV_EVT, LCM_CAUSE_INV_STATE); \
 432       _ret = RFAILED;                                                        \
 433    }                                                                         \
 434 }
 435 #else /* ERRCLASS & ERRCLS_INT_PAR */
 436 #define RLC_VALDATE_SAP(_cb,_chkSpId, _sap, _ret)                             \
 437 {                                                                            \
 438    /* SAP state validation */                                                \
 439    if(_sap->state != RLC_SAP_BND)                                             \
 440    {                                                                         \
 441       RLCLOGERROR(_cb,ERRCLS_INT_PAR, EKWXXX, (ErrVal) RFAILED,               \
 442             "Sap State Invalid.");                                           \
 443       RLC_SEND_SAPID_ALARM(_cb,0, LCM_EVENT_UI_INV_EVT, LCM_CAUSE_INV_STATE); \
 444       _ret = RFAILED;                                                        \
 445    }                                                                         \
 446 }
 447 #endif /* ERRCLASS & ERRCLS_INT_PAR */
 448
 449 /*******************************************************************************
 450  *                              Timer Defines
 451  ******************************************************************************/
 452 #define RLC_TMR_LEN                     10
 453 #define RLC_MAX_UM_TMR                  1
 454 #define RLC_MAX_AM_TMR                  3
 455 #define RLC_MAX_THPT_TMR                1
 456 #define RLC_MAX_UE_TMR                  1
 457
 458 /* Timer events */
 459 #define EVENT_RLC_UMUL_REASSEMBLE_TMR     1
 460 #define EVENT_RLC_AMUL_REASSEMBLE_TMR     2
 461 #define EVENT_RLC_AMUL_STA_PROH_TMR       3
 462 #define EVENT_RLC_AMDL_POLL_RETX_TMR      4
 463 #define EVENT_RLC_WAIT_BNDCFM             5
 464 /* kw005.201 added support for L2 Measurement */
 465 #ifdef LTE_L2_MEAS
 466 #define EVENT_RLC_L2_TMR                  6
 467 #endif /* LTE_L2_MEAS */
 468 #define EVENT_RLC_UE_THROUGHPUT_TMR       7
 469 #define EVENT_RLC_UE_DELETE_TMR           8
 470 #define EVENT_RLC_SNSSAI_THROUGHPUT_TMR   9
 471
 472 /* Wait time for RLC Timers */
 473 #define RLC_UE_DELETE_WAIT_TIME           5 /*in milliseconds */
 474
 475 /*******************************************************************************
 476  *                              DBM Defines
 477  ******************************************************************************/
 478 /**
 479  * @def RLC_DBM_GET_RBCB_FROM_UECB
 480  *
 481  *    This macro makes _rbCb point to the RB in _ueCb based on the passed
 482  *    _rbId and _rbType. _rbCb can point to NULLP
 483  *
 484  * @param[in] _rbId      RB Id of the RB to be fetched
 485  * @param[in] _rbType    Type of the RB, SRB or DRB
 486  * @param[in] _ueCb      Pointer to the UECb for which to get the RB
 487  * @param[out] _rbCb     Pointer to the found RbCb
 488  *
 489 */
 490 #define RLC_DBM_GET_RBCB_FROM_UECB(_rbId, _rbType, _ueCb, _rbCb)            \
 491            (_rbCb) = ((_rbType) == CM_LTE_SRB) ? (_ueCb)->srbCb[(_rbId)] : \
 492                                                  (_ueCb)->drbCb[(_rbId)];
 493 /**
 494  * @def RLC_DBM_GET_CELL_RBCB
 495  *
 496  *    This macro makes _rbCb point to the RB in the _rbCbLst.
 497  *    _rbCb can point to NULLP
 498  *
 499  * @param[in] _rbId         RB Id of the RB to be fetched
 500  * @param[in] _rbCbLst      Pointer to array of RBCbs
 501  * @param[out] _rbCb        Pointer to the found RbCb
 502  *
 503 */
 504 #define RLC_DBM_GET_CELL_RBCB(_rbId, _rbCbLst, _rbCb) \
 505            (_rbCb) = (_rbCbLst)[(_rbId)];
 506
 507 /*******************************************************************************
 508  *                              UMM Defines
 509  ******************************************************************************/
 510 #define RLC_UMDL     rbCb->m.umDl
 511 #define RLC_UMUL     rbCb->m.umUl
 512
 513 /* Sequence Number length defines */
 514 #define RLC_UM_CFG_6BIT_SN_LEN      1 /**< UM 6-bit Sequence number length
 515                                           in bytes*/
 516 #define RLC_UM_CFG_12BIT_SN_LEN     2 /**< UM 12-bit Sequence number length
 517                                           in bytes*/
 518 /* 5GNR */
 519 /* Sequence Number length defines */
 520 #define RLC_AM_CFG_12BIT_SN_LEN      1 /**< AM 12-bit Sequence number length
 521                                           in bytes*/
 522 #define RLC_AM_CFG_18BIT_SN_LEN      2 /**< AM 18-bit Sequence number length
 523                                           in bytes*/
 524
 525 /**
 526  * @def RLC_REMOVE_MAC_HDR_SZ
 527  *
 528  *    If PDU size is greater than 127, MAC header would be 3 bytes else 2 bytes
 529  *
 530  * @param[in,out] _pduSz        Size of the pdu
 531  *
 532 */
 533 #define RLC_REMOVE_MAC_HDR_SZ(_pduSz) (_pduSz) -= ((_pduSz) > 127) ? 3 : 2;
 534
 535 /**
 536  * @def RLC_UM_GET_VALUE
 537  *
 538  *    This macro is used to calculate the value of UM state variables used
 539  *    in comparisons.  VR(UH) - UM Window Size is taken as the base modulus.
 540  *    Returns the modifed value
 541  *
 542  * @param[in] _val               Value of the state variable
 543  * @param[in] _kwUmUl        Um Uplink control block
 544  *
 545 */
 546 #define RLC_UM_GET_VALUE(_val,_kwUmUl)  \
 547      (((_val) - ((_kwUmUl).vrUh - (_kwUmUl).umWinSz)) & ((_kwUmUl).modBitMask))
 548
 549 /*******************************************************************************
 550  *                              AMM Defines
 551  ******************************************************************************/
 552 #define RLC_AMDL                           rbCb->m.amDl
 553 #define RLC_AMUL                           rbCb->m.amUl
 554
 555 /* PDU Types */
 556 #define RLC_DATA_PDU  1
 557 #define RLC_CNTRL_PDU 0
 558
 559 #define RLC_FI_FIRST_SEG                0x02
 560 #define RLC_FI_LAST_SEG                 0x01
 561 #define RLC_SI_FIRST_SEG                0x01
 562 #define RLC_SI_LAST_SEG                 0x02
 563 #define RLC_SI_MID_SEG                  0x03
 564
 565 #define RLC_POLL_SET                    0x40 /* 01000000 */
 566 #define RLC_POLL_UNSET                  0xbf /* 10111111 */
 567 #define RLC_MAX_NACK_CNT                100
 568 /*RLC_MAX_CNTRL_FIELDS (Maximum size of Status Pdu)
 569  *  = MAX_NACK_CNT * sizeof(NACK_SN,E1,E2,E3,soStart,soEnd, nackRange)
 570  * for 18 bit SN + Fixed Header*/
 571 #define RLC_MAX_CNTRL_FIELDS            ((RLC_MAX_NACK_CNT * 8) + 3)
 572
 573 /* Each LI(Length Indicator) holds approx 1+1/2 byte and some other fields thus keeping Header Size equal to twice of MAX LI */
 574 /* 5GNR_RLC: Need to change value of HDRSZ as per number of PDUs going in one datReq */
 575 #define RLC_MIN_HDRSZ                         1
 576 #define RLC_MAX_HDRSZ                         5
 577 #define RLC_AM_PDU_FIXED_HDRSZ                2
 578 #define RLC_AM_PDU_12BIT_SN_HDRSZ             2
 579 #define RLC_AM_PDU_18BIT_SN_HDRSZ             3
 580 #define RLC_AM_SEG_12BIT_SN_WITH_SO_HDRSZ     4
 581 #define RLC_AM_SEG_18BIT_SN_WITH_SO_HDRSZ     5
 582 #define RLC_AM_SEG_12BIT_SN_WITHOUT_SO_HDRSZ  2
 583 #define RLC_AM_SEG_18BIT_SN_WITHOUT_SO_HDRSZ  3
 584 #define RLC_EXTN_HDRSZ                  2
 585 #define RLC_CNTRL_PDU_FIXED_HDRSZ       3
 586 #define RLC_MAC_HDR_SZ2                 2
 587 #define RLC_MAC_HDR_SZ3                 3
 588 #define RLC_BYTE_LEN                    8
 589 #define RLC_2BYTE_LEN                   16
 590 #define RLC_E1_LEN                      1
 591 #define RLC_NACK_E1E2_LEN               12
 592 #define RLC_SO_LEN                      15
 593 #define RLC_DC_LEN                      1
 594 #define RLC_CPT_LEN                     3
 595 #define RLC_RF_LEN                      1
 596 #define RLC_P_LEN                       1
 597 #define RLC_FI_LEN                      2
 598 #define RLC_SI_LEN                      2
 599 #define RLC_E_LEN                       1
 600 #define RLC_SN_LEN                      10
 601 #define RLC_SN_LEN_12BITS               12
 602 #define RLC_SN_LEN_18BITS               18
 603 #define RLC_LSF_LEN                     1
 604 #define RLC_LI_LEN                      11
 605 #define RLC_STA_PDU_R_BITS_ACKSN_12BITS 7  /* 5GNR : Num Reserved bits in STATUS PDU */
 606 #define RLC_STA_PDU_R_BITS_ACKSN_18BITS 1
 607 #define RLC_STA_PDU_R_BITS_NACKSN_12BITS 1
 608 #define RLC_STA_PDU_R_BITS_NACKSN_18BITS 3
 609 #define RLC_NACK_RANGE_LEN               8
 610 #define RLC_SO_LEN_5GNR                  16
 611
 612 #define RLC_DC_POS                      0x80
 613 #define RLC_DC_SHT                      7
 614 #define RLC_POLL_POS                    0x40 /* 5GNR */
 615 #define RLC_POLL_SHT                    6    /* 5GNR */
 616 #define RLC_SI_POS                      0x30 /* 5GNR */
 617 #define RLC_SI_SHT                      4    /* 5GNR */
 618 #define RLC_SN_POS_12BIT                0x0F
 619 #define RLC_SN_POS_18BIT                0x03
 620 #define RLC_AM_GET_WIN_SZ(_snLen)       ((RLC_AM_CFG_12BIT_SN_LEN == (_snLen)) ? (2048) : (131072)) /* 5GNR */
 621 #define RLC_RCV_BUF_BIN_SIZE 512   /* receive buffer size */
 622 #define RLC_TX_BUF_BIN_SIZE 512   /* receive buffer size */
 623
 624 #define RLC_SDU_LST                     1
 625 #define RLC_SEG_LST                     2
 626 #define RLC_RETX_LST                    3
 627 #define RLC_ALL_BYTES_MISSING           0xffff
 628
 629 #define RLC_MAX_PDU_MAP                 30       /*!< Maximum PDU Map. */
 630
 631 #define RLC_LLIST_FIRST_SDU(lstCp, nod)          \
 632 {                                               \
 633    CmLList *tmpNode;                            \
 634    /*CM_LLIST_FIRST_NODE(&(lstCp), tmpNode);*/      \
 635    /*if (tmpNode != NULLP)*/                        \
 636    if((tmpNode=cmLListFirst(&lstCp)))            \
 637       nod = (RlcSdu *)tmpNode->node;             \
 638    else                                         \
 639       nod = NULLP;                              \
 640 }
 641
 642
 643 #define RLC_LLIST_FIRST_SEG(lstCp, nod)         \
 644 {                                              \
 645    CmLList *tmpNode;                           \
 646    /*CM_LLIST_FIRST_NODE(&(lstCp), tmpNode);*/     \
 647    /*if (tmpNode != NULLP)*/                       \
 648    if((tmpNode=cmLListFirst(&lstCp)))            \
 649       nod = (RlcSeg *)tmpNode->node;            \
 650    else                                        \
 651       nod = NULLP;                             \
 652 }
 653
 654 #define RLC_LLIST_FIRST_RETX(lstCp, nod)        \
 655 {                                              \
 656    CmLList *tmpNode;                           \
 657    /*CM_LLIST_FIRST_NODE(&(lstCp), tmpNode);*/     \
 658    /*if (tmpNode != NULLP)*/                       \
 659    if((tmpNode=cmLListFirst(&lstCp)))            \
 660       nod = (RlcRetx *)tmpNode->node;           \
 661    else                                        \
 662       nod = NULLP;                             \
 663 }
 664
 665 #define RLC_LLIST_NEXT_SDU(lstCp, nod)          \
 666 {                                              \
 667    CmLList *tmpNode;                           \
 668    /*CM_LLIST_NEXT_NODE(&(lstCp), tmpNode);*/      \
 669    /*if (tmpNode != NULLP)  */                     \
 670    if((tmpNode = cmLListNext(&lstCp)))          \
 671       nod = (RlcSdu *)tmpNode->node;            \
 672    else                                        \
 673       nod = NULLP;                             \
 674 }
 675
 676
 677 #define RLC_LLIST_NEXT_SEG(lstCp, nod)          \
 678 {                                              \
 679    CmLList *tmpNode;                           \
 680    (lstCp).crnt = &((nod)->lstEnt);            \
 681    /*CM_LLIST_NEXT_NODE(&(lstCp), tmpNode);*/      \
 682    /*if (tmpNode != NULLP)*/                       \
 683    if((tmpNode = cmLListNext(&lstCp)))           \
 684       nod = (RlcSeg *)tmpNode->node;            \
 685    else                                        \
 686       nod = NULLP;                             \
 687 }
 688
 689
 690 #define RLC_LLIST_NEXT_RETX(lstCp, nod)         \
 691 {                                              \
 692    CmLList *tmpNode;                           \
 693    /*CM_LLIST_NEXT_NODE(&(lstCp), tmpNode);*/      \
 694    /*if (tmpNode != NULLP) */                      \
 695    if ((tmpNode = cmLListNext(&lstCp)))          \
 696       nod = (RlcRetx *)tmpNode->node;           \
 697    else                                        \
 698       nod = NULLP;                             \
 699 }
 700
 701
 702 #define RLC_LLIST_LAST_RETX(lstCp, nod)         \
 703 {                                              \
 704    CmLList *tempNode = NULLP;                  \
 705    cmLListLast(&lstCp);                        \
 706    tempNode = cmLListCrnt(&lstCp);             \
 707    if (tempNode != NULLP)                      \
 708       nod = (RlcRetx *)tempNode->node;          \
 709    else                                        \
 710       nod = NULLP;                             \
 711 }
 712
 713 #define RLC_LLIST_LAST_SEG(lstCp, nod)          \
 714 {                                              \
 715    CmLList *tempNode = NULLP;                  \
 716    cmLListLast(&lstCp);                        \
 717    tempNode = cmLListCrnt(&lstCp);             \
 718    if (tempNode != NULLP)                      \
 719       nod = (RlcSeg *)tempNode->node;           \
 720    else                                        \
 721       nod = NULLP;                             \
 722 }
 723
 724 #define RLC_LLIST_LAST_SDU(lstCp, nod)          \
 725 {                                              \
 726    CmLList *tempNode = NULLP;                  \
 727    cmLListLast(&lstCp);                        \
 728    tempNode = cmLListCrnt(&lstCp);             \
 729    if (tempNode != NULLP)                      \
 730       nod = (RlcSdu *)tempNode->node;           \
 731    else                                        \
 732       nod = NULLP;                             \
 733 }
 734
 735 #define CM_LLIST_INS_AFT_CRNT(lstCp, nod)      \
 736 {                                              \
 737    CmLList *nodeToIns = &nod->lstEnt;\
 738    nodeToIns->node = (PTR) nod;\
 739    cmLListInsAfterCrnt(&lstCp, nodeToIns);     \
 740 }
 741
 742 #define CM_LLIST_INS_BEF_CRNT(lstCp, nod)      \
 743 {                                              \
 744    CmLList *nodeToIns = &nod->lstEnt;          \
 745    nodeToIns->node = (PTR) nod;                \
 746    cmLListInsCrnt(&lstCp, nodeToIns);          \
 747 }
 748
 749 #define RLC_LLIST_DEL_RECBUF(_recBuf)                      \
 750 {                                                          \
 751    RlcSeg  *_seg = NULLP;                                  \
 752    RLC_LLIST_FIRST_SEG(_recBuf->segLst, _seg);             \
 753    while (_seg)                                            \
 754    {                                                       \
 755       cmLListDelFrm(&_recBuf->segLst, &_seg->lstEnt);      \
 756       RLC_FREE(_seg, sizeof(RlcSeg));                      \
 757       RLC_LLIST_NEXT_SEG(_recBuf->segLst, _seg);           \
 758    }                                                       \
 759 }
 760
 761 #define RLC_UMM_LLIST_FIRST_SEG(lstCp, nod)         \
 762 {                                              \
 763    CmLList *tmpNode;                           \
 764    if((tmpNode=cmLListFirst(&lstCp)))            \
 765       nod = (RlcUmSeg *)tmpNode->node;            \
 766    else                                        \
 767       nod = NULLP;                             \
 768 } /*!< um mode first segment of linked list*/
 769
 770 #define RLC_UMM_LLIST_NEXT_SEG(lstCp, nod)          \
 771 {                                              \
 772    CmLList *tmpNode;                           \
 773    (lstCp).crnt = &((nod)->lstEnt);            \
 774    if((tmpNode = cmLListNext(&lstCp)))           \
 775       nod = (RlcUmSeg *)tmpNode->node;            \
 776    else                                        \
 777       nod = NULLP;                             \
 778 }/*!< next segment in um mode linked list*/
 779
 780 #define MODAMT(x, y, z,_snModMask)   \
 781 {                         \
 782    y = (x - z) & _snModMask;   \
 783 }
 784
 785 #define MODAMR(x, y, z , _snModMask)   \
 786 {                         \
 787    y = (x - z) & (_snModMask);   \
 788 }
 789
 790 /**
 791  * @def RLC_AM_IS_TRANS_WIN_STALLED
 792  *
 793  *    This macro is used to check if the AM transmit window is stalled or not.
 794  *    The tramist window is stalled when the distance between txNext and txNextAck
 795  *    is greater than equal to Window Size. Actually it should never be greater
 796  *    than Window Size.
 797  *    Returns TRUE if the window is stalled else FALSE
 798  *
 799  * @param[in] _amDl     AM Downlink control block
 800  *
 801 */
 802 #define RLC_AM_IS_TRANS_WIN_STALLED(_amDl)  \
 803      ((((_amDl)->txNext - (_amDl)->txNextAck) & _amDl->snModMask) >= (RLC_AM_GET_WIN_SZ(_amDl->snLen)))
 804
 805 #ifdef TENB_STATS
 806 #define RLC_AM_TRANS_WIN_SIZE(_amDl)  \
 807      (((_amDl)->txNext - (_amDl)->txNextAck) & _amDl->snModMask)
 808 #endif
 809
 810 #define RLC_AM_IS_POLL_BIT_SET(_amDl) \
 811   (RLC_AMDL.pollSn == ((RLC_AMDL.txNext - 1) & RLC_AMDL.snModMask))
 812
 813 #define RLC_FILL_CNTRL_INFO(cntrlInfo, _val, _len, _idx, _eb)\
 814 {                                                           \
 815    cntrlInfo.val = _val;                                    \
 816    cntrlInfo.len = _len;                                    \
 817    cntrlInfo.idx = _idx;                                    \
 818    cntrlInfo.emtBits = _eb;                                 \
 819 }
 820 #define RLC_FILL_PREV_IDX(cntrlInfo, _e1Idx, _e1eb, _idx, _eb) \
 821 {                                                                     \
 822   _e1Idx = cntrlInfo.e1Idx;                                           \
 823   _e1eb  = cntrlInfo.e1eb;                                            \
 824   _idx   = cntrlInfo.idx;                                             \
 825   _eb    = cntrlInfo.emtBits;                                         \
 826 }
 827
 828 #define RLC_FILL_HDR_ARGS(hdrInfo, _val, _len)  \
 829 {                                              \
 830    hdrInfo.val = _val;                         \
 831    hdrInfo.len = _len;                         \
 832 }
 833
 834 /* kw003.201 - This macro provides the header size other than the */
 835 /*             fixed header of 2 bytes for each AMD PDU or 4 bytes*/
 836 /*             for an AM PDU segment                              */
 837 #define RLC_AM_EXTN_HDRSZ(_numLi, _eHdrSz)       \
 838 {                                               \
 839    if ((_numLi - 1) % 2)                        \
 840    {                                            \
 841       _eHdrSz = ((3 * (_numLi - 2)) >> 1) + 2;  \
 842    }                                            \
 843    else                                         \
 844    {                                            \
 845       _eHdrSz = (3 * (_numLi - 1)) >> 1;        \
 846    }                                            \
 847 }
 848
 849 /* Update poll bit in the buffer */
 850 #define RLC_UPD_POLL_BIT(_gCb, _retx, _poll)                \
 851 {                                                          \
 852    uint8_t fHdr;                                                \
 853                                                            \
 854    if (_poll != _retx->amHdr.p)                            \
 855    {                                                       \
 856       /* Get the first byte of the buffer */               \
 857       SRemPreMsg((Data *)&fHdr, _retx->seg);               \
 858       if (_poll == TRUE)                                   \
 859       {                                                    \
 860          fHdr = fHdr | RLC_POLL_SET;                        \
 861       }                                                    \
 862       else                                                 \
 863       {                                                    \
 864          fHdr = fHdr & RLC_POLL_UNSET;                      \
 865       }                                                    \
 866       /* Concatenated updated hdr to the mBuf */           \
 867       SAddPreMsg ((Data)fHdr, _retx->seg);                 \
 868    }                                                       \
 869    /* Update poll bit in the hdrInfo */                    \
 870    _retx->amHdr.p = _poll;                                 \
 871 }
 872
 873 #define RLC_AM_ELIMINATE_EXTN_HDR(_pduSz, _sduSz, _numLi)   \
 874 {                                                          \
 875    if ( (_pduSz > _sduSz) && (_sduSz < 2048) )             \
 876    {                                                       \
 877       _pduSz -= (_numLi % 2) ? 1 : 2;                      \
 878    }                                                       \
 879 }
 880 /**
 881  * @def RLC_AM_CHK_SN_WITHIN_RECV_WINDOW
 882  *
 883  *    This macro is used to check if a Sequence Number falls within the AM
 884  *    reception window or not.
 885  *    The condition is VR(R) <= SN < VR(MR), which are subtracting the base
 886  *    modulus becomes 0 <= (SN - VR(R)) % SNLen < (VR(MR) - VR(R)) % SnLen
 887  *    NOTE: Careful with the parantheses
 888  *
 889  *    Returns TRUE if within the window; FALSE otherwise
 890  *
 891  * @param[in] _sn       The sequence number to be checked
 892  * @param[in] _amUl     AM Uplink control block
 893  *
 894 */
 895 #define RLC_AM_CHK_SN_WITHIN_RECV_WINDOW(_sn, _amUl)          \
 896   ((((_sn) - (_amUl->rxNext)) & (_amUl->snModMask)) < (((_amUl->vrMr) - (_amUl->rxNext)) & (_amUl->snModMask)))
 897
 898 #define RLC_POWER(x, y)  x << (y-1);
 899
 900 #ifndef L2_OPTMZ
 901 #define rlcCpyMsg(_cb,x, y) \
 902       (SAddMsgRef((x), RLC_GET_MEM_REGION(_cb), RLC_GET_MEM_POOL(_cb), (y)))
 903 #else
 904 /* L2 optimization for mUe/Tti: Removing dup buf*/
 905 #define rlcCpyMsg(_cb,x, y) \
 906       (SIncMsgRef((x), RLC_GET_MEM_REGION(_cb), RLC_GET_MEM_POOL(_cb), (y)))
 907 #endif
 908
 909 //      printf("Copy Msg %x \n",x);
 910
 911 /*******************************************************************************
 912  *                              Debugging Defines
 913  ******************************************************************************/
 914 #define RLC_DBG_SUB_MASK   DBGMASK_MI             /**< Use for sub-mask */
 915 #define RLC_DBGMASK_DETAIL (RLC_DBG_SUB_MASK << 0) /**< Parameters, It will give
 916                                                       in depth info */
 917 #define RLC_DBGMASK_BRIEF  (RLC_DBG_SUB_MASK << 1) /**< Info, It will give info at
 918                                                     entry and exit places along
 919                                                    with certain state changes */
 920 #define RLC_DBGMASK_ERROR  (RLC_DBG_SUB_MASK << 2) /**< Error information */
 921 #define RLC_DBGMASK_FATAL  (RLC_DBG_SUB_MASK << 3) /**< FATAL errors like memory
 922                                                     resource failure etc., */
 923
 924 #define RLC_DBG_MDL_MASK (RLC_DBG_SUB_MASK << 4)
 925
 926 #define RLC_DBGMASK_TM         (RLC_DBG_MDL_MASK << 0)    /**< TM */
 927 #define RLC_DBGMASK_UM         (RLC_DBG_MDL_MASK << 1)    /**< UM */
 928 #define RLC_DBGMASK_AM         (RLC_DBG_MDL_MASK << 2)    /**< AM */
 929 #define RLC_DBGMASK_DL         (RLC_DBG_MDL_MASK << 3)    /**< DL */
 930 #define RLC_DBGMASK_UL         (RLC_DBG_MDL_MASK << 4)    /**< UL */
 931 #define RLC_DBGMASK_CFG        (RLC_DBG_MDL_MASK << 5)    /**< CFG */
 932 #define RLC_DBGMASK_LMM        (RLC_DBG_MDL_MASK << 6)    /**< LMM */
 933 #define RLC_DBGMASK_INF        (RLC_DBG_MDL_MASK << 7)    /**< UI, LI */
 934 #define RLC_DBGMASK_DUT        (RLC_DBG_MDL_MASK << 8)    /**< DBM, UTL, TMR */
 935 #define RLC_DBGMASK_MBUF_PRNT  (RLC_DBG_MDL_MASK << 9)    /**< MBUF, useful in
 936                                                              integrated
 937                                                              testing */
 938 #define RLC_DBGMASK_MEM_INFO   (RLC_DBG_MDL_MASK << 10)   /**< Print SSI memory
 939                                                              information*/
 940 #define RLC_DBGMASK_UDX        (RLC_DBG_MDL_MASK << 11)   /**< UDX interface */
 941
 942 #ifdef DEBUGP
 943 #define RLC_PRNT_BORDER                                   \
 944 do                                                       \
 945 {                                                        \
 946    RLC_PRNT((_kwPBuf, "\n==========================\n")); \
 947 }while(0)
 948
 949 #define RLC_PRNT_HLINE(_cb,_pMsg)                                              \
 950 {                                                                             \
 951    sprintf((_cb)->init.prntBuf, "[RLC_LAYER: %s:%d]::", __FILE__, __LINE__);  \
 952    SPrint((_cb)->init.prntBuf);                                               \
 953    RLC_PRNT_TSTAMP(_cb);                                                       \
 954    sprintf((_cb)->init.prntBuf, _pMsg);                                       \
 955    SPrint((_cb)->init.prntBuf);                                               \
 956 }
 957
 958 #define RLC_PRNT(_cb,_prntbuf)  \
 959 {                              \
 960    sprintf _prntbuf;           \
 961    SPrint(_cb->init.prntBuf);  \
 962 }
 963
 964 #define RLC_PRINT_TO_BUFFER(_cb,...)                             \
 965 {                                                               \
 966    snprintf((_cb)->init.prntBuf, PRNTSZE, "[%s]::", __func__);  \
 967    SPrint((_cb)->init.prntBuf);                                 \
 968    snprintf(_cb->init.prntBuf, PRNTSZE,__VA_ARGS__);            \
 969    SPrint(_cb->init.prntBuf);                                   \
 970 }
 971
 972 #define RLC_PRNT_TSTAMP(_cb)                                   \
 973 {                                                             \
 974    S8 _buf[60];                                               \
 975    DateTime dt;                                               \
 976    memset((&dt), 0, sizeof(DateTime));                \
 977    SGetDateTime(&dt);                                         \
 978    sprintf(_buf, "date: %02d/%02d/%04d time: %02d:%02d:%02d", \
 979      (int)dt.month,(int)dt.day,(int)dt.year + 1900,           \
 980      (int)dt.hour,(int)dt.min,(int)dt.sec);                   \
 981    RLC_PRNT(_cb,(_cb->init.prntBuf,("[%s]", _buf)));           \
 982 }
 983
 984 #define RLC_PRNT_MBUF(_cb,_mBufPtr)                          \
 985 do                                                          \
 986 {                                                           \
 987    if(_cb->init.dbgMask & (RLC_DBGMASK_MBUF_PRNT))           \
 988    {                                                        \
 989      RLC_PRNT_HLINE(_cb,("\nMessage Buffer Contents:\n"));   \
 990      SPrntMsg ((Buffer *)_mBufPtr, 0, 0);                   \
 991    }                                                        \
 992 }while(0)
 993
 994 #define RLC_PRNT_MEMINFO(_cb)                                  \
 995 do                                                            \
 996 {                                                             \
 997    uint32_t  _memInfo;                                             \
 998    if(_cb->init.dbgMask & (RLC_DBGMASK_MEM_INFO))              \
 999    {                                                          \
1000      RLC_PRNT_HLINE(_cb,("\nMemory Information:\n"));          \
1001      SRegInfoShow(0, &_memInfo);                              \
1002    }                                                          \
1003 }while(0)
1004
1005 #define RLCDBGP_INTERNAL(_cb,_mask,...)           \
1006 do                                               \
1007 {                                                \
1008    if (!((_cb->init.dbgMask & _mask) ^ _mask))   \
1009    {                                             \
1010       RLC_PRINT_TO_BUFFER(_cb, __VA_ARGS__);      \
1011    }                                             \
1012 }while(0)
1013
1014 #define RLCDBGP_ERROR(_cb, ...) \
1015    RLCDBGP_INTERNAL(_cb,(RLC_DBGMASK_ERROR | RLC_MODULE),__VA_ARGS__)
1016
1017 #define RLCDBGP_DETAIL(_cb, ...) \
1018    RLCDBGP_INTERNAL(_cb,(RLC_DBGMASK_DETAIL | RLC_MODULE),__VA_ARGS__)
1019
1020 #define RLCDBGP_BRIEF(_cb, ...) \
1021    RLCDBGP_INTERNAL(_cb,(RLC_DBGMASK_BRIEF | RLC_MODULE),__VA_ARGS__)
1022
1023 #else  /* DEBUGP */
1024 #define RLC_PRNT_HLINE(_cb,_pMsg)
1025 #define RLC_PRNT(_cb,_prntbuf)
1026 #define RLC_PRNT_TSTAMP(_cb)
1027 #define RLC_PRNT_MBUF(_cb,_mBufPtr)
1028 #define RLC_PRNT_MEMINFO(_cb)
1029 #define RLCDBGP(_cb,_mask, _arg)
1030 #define RLCDBGP_ERROR(_cb, ...)
1031 #define RLCDBGP_DETAIL(_cb, ...)
1032 #define RLCDBGP_BRIEF(_cb, ...)
1033 #endif /* DEBUGP */
1034
1035 /*******************************************************************************
1036  *                              LMM Defines
1037  ******************************************************************************/
1038 #define RLC_LMM_RB_STS_INC(_cb)    (_cb)->genSts.numOfRb++;
1039
1040 #define RLC_LMM_RB_STS_DEC(_cb)    (_cb)->genSts.numOfRb--;
1041
1042 #if defined(SS_MULTICORE_SUPPORT) && defined(SS_M_PROTO_REGION)
1043 #define RLC_FILL_SAP_HELPER(_Sap, _cfg, _gCb)\
1044 {\
1045    _Sap->pst.selector = _cfg->selector; \
1046    _Sap->pst.route = _cfg->route; \
1047    _Sap->pst.prior =  _cfg->priority; \
1048    _Sap->pst.region = _gCb->init.region;\
1049    _Sap->pst.pool = _gCb->init.pool;\
1050    _Sap->pst.dstProcId = _cfg->procId; \
1051    _Sap->pst.dstEnt = _cfg->ent; \
1052    _Sap->pst.dstInst = _cfg->inst; \
1053    _Sap->pst.srcProcId = _gCb->init.procId; \
1054    _Sap->pst.srcEnt = _gCb->init.ent; \
1055    _Sap->pst.srcInst = _gCb->init.inst; \
1056    _Sap->pst.event = EVTNONE; \
1057    _Sap->spId = _cfg->sapId; \
1058    _Sap->state = RLC_SAP_CFG; \
1059 }
1060 #else /* defined(SS_MULTICORE_SUPPORT) && defined(SS_M_PROTO_REGION) */
1061 #define RLC_FILL_SAP_HELPER(_Sap, _cfg, _gCb)\
1062 {\
1063    _Sap->pst.selector = _cfg->selector; \
1064    _Sap->pst.route = _cfg->route; \
1065    _Sap->pst.prior =  _cfg->priority; \
1066    _Sap->pst.region = _cfg->mem.region;\
1067    _Sap->pst.pool = _cfg->mem.pool;\
1068    _Sap->pst.dstProcId = _cfg->procId;\
1069    _Sap->pst.dstEnt = _cfg->ent;\
1070    _Sap->pst.dstInst = _cfg->inst;\
1071    _Sap->pst.srcProcId = _gCb->init.procId;\
1072    _Sap->pst.srcEnt = _gCb->init.ent;\
1073    _Sap->pst.srcInst = _gCb->init.inst;\
1074    _Sap->pst.event = EVTNONE;\
1075    _Sap->spId = _cfg->sapId;\
1076    _Sap->state = RLC_SAP_CFG;\
1077 }
1078 #endif
1079
1080 /*******************************************************************************
1081  *                              UDX Defines
1082  ******************************************************************************/
1083 #define RLC_GET_DL_SAPCB(_cb, _rbCb) (_cb->u.dlCb->udxDlSap + _rbCb->udxSapId)
1084 #define RLC_GET_UDX_SAP(_cb) (_cb->u.ulCb->udxUlSap)
1085
1086 /* kw005.201 added support for L2 Measurement */
1087 #ifdef LTE_L2_MEAS
1088 #define RLC_L2_MAX_TIMERS        1
1089 #define RLC_QCI_LIST_BUCKET_SIZE 10
1090 #define RLC_TB_LIST_BUCKET_SIZE  10
1091 #define RLC_MAX_L2MEAS_EVT       10
1092 /* L2 Measurement index to be used in rbCb to store measData */
1093 #define RLC_L2MEAS_ACT_UE       0
1094 #define RLC_L2MEAS_DL_DELAY     1
1095 #define RLC_L2MEAS_DL_DISC      2
1096 #define RLC_L2MEAS_UU_LOSS      3
1097 #define RLC_L2MEAS_DL_IP        4
1098 #define RLC_L2MEAS_UL_IP        5
1099 #endif /* LTE_L2_MEAS */
1100
1101 #define RLC_RDWR_LOCK(_lockPtr)
1102 #define RLC_RDWR_UNLOCK(_lockPtr)
1103 #define RLC_TIME_DIFF(t1,t2)                  \
1104    (t1<t2 ? ((0xffffffff - t2) + t1 ): (t1 - t2))
1105
1106 /*******************************************************************/
1107
1108 /* Memory */
1109 #define RLC_MEM_REGION_UL    1
1110 #define RLC_MEM_REGION_DL    4
1111 #define RLC_POOL 1
1112
1113 /* Inst */
1114 #define RLC_UL_INST   0
1115 #define RLC_DL_INST   1
1116
1117 #define PDCP_SN 1
1118 #define RLC_REASSEMBLY_TMR_BASE   5   /* Used to calculate timer value from enum values */
1119
1120 /* Fill Pst structure for sending msg from RLC to DUAPP */
1121 #define FILL_PST_RLC_TO_DUAPP(_pst, _srcInst, _event) \
1122 {                                                              \
1123    _pst.selector    = ODU_SELECTOR_LWLC;                       \
1124    _pst.srcEnt      = ENTRLC;                                  \
1125    _pst.dstEnt      = ENTDUAPP;                                \
1126    _pst.dstInst     = 0;                                       \
1127    _pst.srcInst     = _srcInst;                                \
1128    _pst.dstProcId   = ODU_GET_PROCID();                        \
1129    _pst.srcProcId   = ODU_GET_PROCID();                        \
1130    if(_srcInst == RLC_UL_INST)                                 \
1131    {                                                           \
1132       _pst.region   = RLC_MEM_REGION_UL;                       \
1133    }                                                           \
1134    else if(_srcInst == RLC_DL_INST)                            \
1135    {                                                           \
1136       _pst.region   = RLC_MEM_REGION_DL;                       \
1137    }                                                           \
1138    _pst.pool        = RLC_POOL;                                \
1139    _pst.event       = _event;                                  \
1140    _pst.route       = 0;                                       \
1141    _pst.prior       = 0;                                       \
1142    _pst.intfVer     = 0;                                       \
1143 }
1144
1145 #define FILL_PST_RLC_TO_MAC(_pst, _srcInst, _event)    \
1146 {                                                      \
1147    pst.selector  = ODU_SELECTOR_LWLC;                  \
1148    pst.srcEnt    = ENTRLC;                             \
1149    pst.dstEnt    = ENTMAC;                             \
1150    pst.dstInst   = 0;                                  \
1151    pst.srcInst   = _srcInst;                           \
1152    pst.dstProcId = ODU_GET_PROCID();                   \
1153    pst.srcProcId = ODU_GET_PROCID();                   \
1154    if(_srcInst == RLC_UL_INST)                         \
1155    {                                                   \
1156       pst.region    = RLC_MEM_REGION_UL;               \
1157    }                                                   \
1158    else if(_srcInst == RLC_DL_INST)                    \
1159    {                                                   \
1160       pst.region    = RLC_MEM_REGION_DL;               \
1161    }                                                   \
1162    pst.pool      = RLC_POOL;                           \
1163    pst.event     = _event;                             \
1164    pst.route     = 0;                                  \
1165    pst.prior     = 0;                                  \
1166    pst.intfVer   = 0;                                  \
1167 }
1168
1169 /** @brief global variables */
1170 uint16_t getTransId();
1171
1172 /** @brief Local typedefs */
1173 typedef uint32_t    RlcSn;   /*!< Sequence Number length */
1174
1175 typedef RguDDatIndInfo KwDatIndInfo;
1176
1177 typedef RguDStaIndInfo KwDStaIndInfo;
1178
1179 typedef RguPduInfo KwPduInfo; /* kw002.201 : Aligning the structure with RGU */
1180
1181 typedef struct _amRlcStats
1182 {
1183    uint32_t   numDLStaPduSent;
1184    uint32_t   numDLNacksInStaPdu;
1185    uint32_t   numDLBytesUnused;
1186    uint32_t   numDLPollTimerExpiresSrb;
1187    uint32_t   numDLPollTimerExpiresDrb;
1188    uint32_t   numDLMaxRetx;
1189    uint32_t   numDLRetransPdus;
1190    uint32_t   numULPdusDiscarded;
1191    uint32_t   numULReAsmblTimerExpires;
1192    uint32_t   numULStaPduRcvd;
1193    uint32_t   numULNackInStaPduRcvd;
1194    uint32_t   numRlcAmCellSduTx; /* Count of SDUs transmitted in DL for all UEs */
1195    uint32_t   numRlcAmCellSduBytesTx; /*Total number of bytes transmitted in DL for all Ues */
1196    uint32_t   numRlcAmCellRetxPdu; /*Count of PDUs retransmitted for all Ues */
1197    uint32_t   numRlcAmMaxRetx; /*Total number of Max-RLC retransmissions hit for all the Ues */
1198    uint32_t   numRlcAmCellDupPduRx; /*Count of Duplicate PDUs detected for a UE in UL for all Ues */
1199    uint32_t   numRlcAmCellDropOutWinRx; /*Count of PDUs dropped due to Out of Window reception for all Ues */
1200    uint32_t   numRlcAmCellSduRx; /* Count of SDUs received in UL for all UEs*/
1201    uint32_t   numRlcAmCellSduBytesRx;/*Total number of bytes received in UL for all Ues*/
1202    uint32_t   numRlcAmCellNackRx; /*Total number of UL PDUs nacked for all the Ues*/
1203    uint32_t   numRlcAmCellWinStall; /*Number of window stalls detected for all the Ues */
1204 }AMRLCStats;
1205
1206 typedef struct _umRlcStats
1207 {
1208    uint32_t   numDLBytesUnused;
1209    uint32_t   numDLMaxRetx;
1210    uint32_t   numULPdusDiscarded;
1211    uint32_t   numULReAsmblTimerExpires;
1212    uint32_t   numULPdusOutsideWindow;
1213 }UMRLCStats;
1214
1215 typedef struct _rlcStats
1216 {
1217    AMRLCStats   amRlcStats;
1218    UMRLCStats   umRlcStats;
1219 }RLCStats;
1220
1221 RLCStats gRlcStats;
1222
1223 /* kw005.201 added support for L2 Measurement */
1224 #ifdef LTE_L2_MEAS
1225 typedef struct rlcSduSnMap RlcSduSnMap;
1226 typedef RguLchMapInfo KwLchMapInfo;
1227 #endif /*  LTE_L2_MEAS */
1228
1229 /** @defgroup ummode UM Module Info
1230 */
1231 /**
1232  * @brief  Structure to hold an Unacknowledged Mode header
1233  *
1234  * @details
1235  *    - si    : Segmentation Info
1236  *    - sn    : Sequence number
1237  *    - so    : Segmentation offset
1238 */
1239 typedef struct rlcUmHdr
1240 {
1241    uint8_t     si;              /*!< Segmentation Info */
1242    RlcSn       sn;              /*!< Sequence number */
1243    uint16_t    so;              /*!< Segmentation offset */
1244 }RlcUmHdr;
1245
1246 /**
1247  * @brief  Structure to hold an Acknowledged Mode header
1248  *
1249  * @details
1250  *    - dc    : Data/Control PDU
1251  *    - rf    : Resegmentation flag
1252  *    - p     : Poll bit
1253  *    - fi    : Framing Info
1254  *    - e     : Extension bit
1255  *    - lsf   : Last segment flat
1256  *    - sn    : Sequence number
1257  *    - so    : Segment offset
1258  *    - numLi : Number of length indicators in the following array (li)
1259  *    - li    : Length indicators
1260 */
1261 typedef struct rlcAmHdr
1262 {
1263    uint8_t     dc;              /*!< Data/Control PDU */
1264    uint8_t     p;               /*!< Poll bit */
1265    uint8_t     si;              /*!< Segmentation Info: 5GNR */
1266    RlcSn       sn;              /*!< Sequence number */
1267    uint32_t    so;              /*!< Segment offset */
1268 }RlcAmHdr;
1269
1270 /* structures used for encoding/decoding the headers */
1271 typedef struct rlcCntrlInfo
1272 {
1273    uint16_t  val;
1274    uint8_t   len;
1275    uint16_t  idx;
1276    uint8_t   emtBits;
1277    uint16_t  e1Idx;
1278    uint16_t  e2Idx;
1279    uint8_t   e1eb;
1280 }RlcCntrlInfo;
1281
1282 typedef struct rlcHdrInfo
1283 {
1284    uint32_t  val;
1285    uint8_t   len;
1286    uint8_t   eb;
1287    uint8_t   *hdr;
1288    uint16_t  idx;
1289    uint8_t   pEb;
1290    uint8_t   pLen;
1291 }RlcHdrInfo;
1292
1293 typedef struct rlcExtHdr
1294 {
1295    uint32_t val;
1296    uint16_t len;
1297    uint8_t  hdr;
1298    uint8_t  pLen;
1299 }RlcExtHdr;
1300
1301 /**
1302  * @brief  Structure to hold information about a Logical channel
1303  *
1304  * @details
1305  *    - lChId    : Logical channel Id
1306  *    - lChType  : Logical channel type
1307 */
1308 typedef struct rlcLchInfo
1309 {
1310    CmLteLcId     lChId;     /*!< Logical channel Id */
1311    CmLteLcType   lChType;   /*!< Logical channel type */
1312 }RlcLchInfo;
1313
1314 /* kw005.201 added support for L2 Measurement */
1315 #ifdef LTE_L2_MEAS
1316
1317 /** @struct RlcL2Cntr
1318  * RLC L2 Counter  */
1319 typedef struct rlcL2Cntr
1320 {
1321    struct
1322    {
1323       uint32_t  numActvUe;        /*!< number of active Ue */
1324       uint32_t  sampOc;           /*!< Total number of sampling occasion */
1325    }actUe;
1326    struct
1327    {
1328       uint32_t  dLoss;            /*!< Total number of lost packets */
1329       uint32_t  posPkts;          /*!< Total number of positively acknowlegded
1330                                   packets */
1331    }uuLoss;
1332    struct                    /*!< For DL IP throughput */
1333    {
1334       uint32_t volSummation;      /*!< Sum of data in bytes */
1335       uint32_t timeSummation;     /*!< Sum of time difference in milli sec*/
1336    }dlIpThruput;
1337    struct                    /*!< For UL IP throughput */
1338    {
1339       uint32_t volSummation;      /*!< Sum of data in bytes */
1340       uint32_t timeSummation;     /*!< Sum of time difference in milli sec*/
1341    }ulIpThruput;
1342    /* Discard new changes starts */
1343    struct                    /*!< For UL IP throughput */
1344    {
1345       uint32_t discSdus;          /*!< Total RLC SDUs discarded */
1346       uint32_t totSdus;           /*!< Total RLC SDUs received */
1347    }dlDisc;
1348    struct                    /*!< For UL IP throughput */
1349    {
1350       uint64_t sduDelay;          /*!< Total SDUs delay */
1351       uint32_t numSdus;
1352    }dlPjSduDelay;
1353    uint32_t    totDrbsPerQci;     /*!< Total Count of DRB's for this QCI */
1354 }RlcL2Cntr;
1355
1356 struct rlcSduSnMap
1357 {
1358    CmLList     lstEnt;
1359    Bool        failMarked;
1360    Bool        fullySent;
1361    uint32_t    sduId;
1362    uint16_t    numSn;
1363    uint16_t    snList[RLC_MAX_PDU_MAP];
1364    uint16_t    harqAck;
1365    uint16_t    reqSent;
1366    uint16_t    rspRcvd;
1367 };
1368
1369 typedef struct rlcSnSduMap
1370 {
1371    uint16_t         sn;
1372    CmLteLcId        lChId;              /*!< Logical channel Id */
1373    uint16_t         numSdu;
1374 #ifdef LTE_RLC_R9
1375    Bool        isBurstSplitted;    /*!< true: burst for this LCH is splitted */
1376 #endif /* LTE_RLC_R9 */
1377    RlcSduSnMap  *sduList[RLC_MAX_DL_LI];
1378 }RlcSnSduMap;
1379
1380 typedef struct rlcTbSnMap
1381 {
1382    CmHashListEnt  hlTbEnt;
1383    uint32_t       tbId;
1384    uint16_t       prevNumSn;
1385    uint16_t       numSn;
1386    RlcSnSduMap    snSduMap[RGU_MAX_PDU * RGU_MAX_LC];
1387 }RlcTbSnMap;
1388
1389 typedef struct rlcL2MeasCbUeMeasInfo
1390 {
1391    CmLteRnti   ueId;                    /*!< UE ID (Used only for IP Throughput
1392                                              in UL/DL */
1393    CmLteCellId cellId;                  /*!< UE ID (Used only for IP Throughput
1394                                              in UL/DL */
1395    Bool        isValid;                 /*! < is this UE entry valid */
1396    uint8_t     numLcId;                 /*!< Holds the number of LCh for which Ul Ip
1397                                              measurement is ON */
1398    uint8_t     lcId[RLC_MAX_LCH_PER_UE]; /*!< Holds the list of LCh for which Ul ip
1399                                              measurement is ON */
1400    RlcL2Cntr    measData[LKW_MAX_QCI];
1401    uint16_t     numQci;                  /*!< number of valid qcI */
1402    uint8_t      qci[LKW_MAX_QCI];        /*!< list of valid qcI */
1403 }RlcL2MeasCbUeMeasInfo;
1404
1405 typedef struct rlcL2MeasCbIpThMeas
1406 {
1407    uint8_t                   numUes;
1408    uint8_t                   totNumQci;
1409    uint8_t                   totQci[LKW_MAX_QCI];
1410    RlcL2MeasCbUeMeasInfo ueInfoLst[LKW_MAX_UE]; /*Added for handling meas for multiple ues*/
1411 }RlcL2MeasCbIpThMeas;
1412
1413 typedef struct rlcL2MeasCbNonIpThMeas
1414 {
1415    uint16_t    numSamples;              /*!< Number of samples to take on numActUe */
1416    uint16_t    numQci;                  /*!< number of valid qcI */
1417    uint8_t     qci[LKW_MAX_QCI];        /*!< list of valid qcI */
1418    RlcL2Cntr   measData[LKW_MAX_QCI];   /*!< Measurement CB */
1419 }RlcL2MeasCbNonIpThMeas;
1420
1421 typedef union rlcL2MeasCbIpNonIpThMeasVal
1422 {
1423    RlcL2MeasCbIpThMeas    ipThMeas;
1424    RlcL2MeasCbNonIpThMeas nonIpThMeas;
1425 }RlcL2MeasCbIpNonIpThMeasVal;
1426
1427 /** @struct RlcL2MeasCb
1428  * RLC L2 Measurement CB */
1429 typedef struct rlcL2MeasCb
1430 {
1431    uint8_t        measType;        /*!< Bit-wise set measurement types */
1432    RlcL2MeasCbIpNonIpThMeasVal val;   /* Union of IP tpt or non-ip tpt */
1433 }RlcL2MeasCb;
1434
1435 /** @struct RlcL2MeasEvtCb
1436  * RLC L2 Measurement Evt CB */
1437 typedef struct rlcL2MeasEvtCb
1438 {
1439    uint32_t      transId;                /*!< TransId of Measurement Req */
1440    uint32_t      cbIdx;                  /*!< TransId of Measurement Req */
1441    CmTimer       l2Tmr; /* NOT USED */                 /*!< L2 Timer per request */
1442    TmrCfg        l2TmrCfg; /* NOT USED */               /*!< Time period of measurement */
1443    RlcL2MeasCb   measCb;                 /*!< Measurement CB */
1444    EpcTime       startTime; /* NOT USED */            /*!<  start time when meas starts*/
1445 }RlcL2MeasEvtCb;
1446
1447 /** @struct RlcL2MeasRbCb
1448  * RLC L2 Measurement Rb CB */
1449 typedef struct rlcL2MeasRbCb
1450 {
1451    uint8_t        measOn;                      /*!< Measurements that are running */
1452    RlcL2Cntr      *l2Sts[RLC_MAX_L2MEAS_EVT];  /*!< L2 Mesurement statistics */
1453 }RlcL2MeasRbCb;
1454
1455 /** @struct RlcL2Cb
1456  * RLC L2  CB */
1457 typedef struct rlcL2Cb
1458 {
1459    uint16_t        rlcNumMeas;                   /*!< Number of measurements going on */
1460    RlcL2MeasEvtCb  rlcL2EvtCb[LKW_MAX_L2MEAS];  /*!< Pointers to Measurement Cb */
1461    uint8_t         measOn[LKW_MAX_QCI];          /*!< Measurement on */
1462    uint32_t        numActUe[LKW_MAX_QCI];       /*!< Measurement on */
1463 }RlcL2Cb;
1464
1465
1466 typedef enum _dlIpThrputState
1467 {
1468    KW_DL_IPTHRU_RESET = 0,
1469    KW_DL_IPTHRU_BURST_STARTED,
1470    KW_DL_IPTHRU_BURST_CONTINUE,
1471    KW_DL_IPTHRU_BURST_COMPLETED
1472 }DlIpThrputState;
1473
1474 /**
1475 * @struct rlcL2MeasSduLst
1476 * Structure to hold parameters of
1477 * burst sdus in DL for a RB */
1478 typedef struct rlcOutStngSduInfo
1479 {
1480    uint32_t  sduId;            /*!< SDU Id of sdu */
1481    MsgLen    sduLen;           /*!< Size of sdu */
1482    uint32_t  numTb;            /*!< Hold the number of TBs for this sdu in DL */
1483 }RlcOutStngSduInfo;
1484
1485 /**
1486 * @struct rlcL2MeasDlIpTh
1487 * Structure to hold parameters for DL ip
1488 * throughput for a RB */
1489 typedef struct rlcL2MeasDlIpTh
1490 {
1491    Bool               isBurstAct;            /*!< Set to TRUE when burst is active in DL */
1492    uint64_t           burstStartTime;        /*!< Holds the starting time of the burst */
1493    uint32_t           burstEndSduId;         /*!< Sdu ID when burst ends */
1494    uint8_t            lastSduIdx;            /*!< Holds the index of last outStanding sdu */
1495    RlcOutStngSduInfo  outStngSduArr[RLC_L2MEAS_MAX_OUTSTNGSDU];/*!< Hold the burst sdu information */
1496 }RlcL2MeasDlIpTh;
1497
1498 /**
1499 * @struct rlcL2MeasIpThruput
1500 * Structure to hold parameters for UL/DL ip
1501 * throughput for a RB */
1502 typedef struct rlcL2MeasIpThruput
1503 {
1504    uint32_t         dataVol;                 /*!< Holds volume of new data in bytes
1505                                               for UL IP throughput */
1506    uint32_t         ttiCnt;                  /*!< Holds ttiCnt received from MAC in UL */
1507    uint32_t         prevTtiCnt;        /*!< Holds previous ttiCnt received from MAC in UL */
1508    RlcL2MeasDlIpTh  dlIpTh;
1509 }RlcL2MeasIpThruput;
1510
1511 #endif /* LTE_L2_MEAS */
1512
1513 /**
1514  * @brief  Structure to hold an UE key for the UE hast lists
1515  *
1516  * @details
1517  *    - ueId    : UE Id
1518  *    - cellId  : Cell Id
1519 */
1520 typedef struct rlcUeKey
1521 {
1522    CmLteRnti     ueId;     /*!< UE Id */
1523    CmLteCellId   cellId;   /*!< Cell Id */
1524 }RlcUeKey;
1525
1526 /**
1527  * @brief  Structure to hold an information about the CKW SAP
1528  *
1529  * @details
1530  *    - pst   : Service user post structure
1531  *    - spId  : Service provider Id
1532  *    - suId  : Service user Id
1533  *    - state : State of the SAP
1534  *    - sts   : SAP specific statistics
1535 */
1536 typedef struct rlcCkwSapCb
1537 {
1538    Pst           pst;     /*!< Service user post structure */
1539    SpId          spId;    /*!< Service provider Id */
1540    SuId          suId;    /*!< Service user Id */
1541    uint8_t       state;   /*!< Sap Status */
1542    RlcCkwCntSts   sts;     /*!< Statistics */
1543 }RlcCkwSapCb;
1544
1545 /**
1546  * @brief  Structure to hold an information about the KWU SAP
1547  *
1548  * @details
1549  *    - pst   : Service user post structure
1550  *    - spId  : Service provider Id
1551  *    - suId  : Service user Id
1552  *    - state : State of the SAP
1553  *    - sts   : SAP specific statistics
1554 */
1555 typedef struct rlcKwuSapCb
1556 {
1557    Pst           pst;     /*!< Service user post structure */
1558    SpId          spId;    /*!< Service provider Id */
1559    SuId          suId;    /*!< Service user Id */
1560    uint8_t       state;   /*!< Sap Status */
1561    RlcKwuSapSts  sts;     /*!< Statistics */
1562 }RlcKwuSapCb;
1563
1564 /**
1565  * @brief  Structure to hold an information about the RGU SAP
1566  *
1567  * @details
1568  *    - pst       : Service user post structure
1569  *    - spId      : Service provider Id
1570  *    - suId      : Service user Id
1571  *    - state     : State of the SAP
1572  *    - bndTmr    : Bind Timer
1573  *    - bndTmrInt : Timer Interval
1574  *    - retryCnt  : Bind Retry Count
1575 */
1576 typedef struct rlcRguSapCb
1577 {
1578    Pst       pst;         /*!< Service user post structure */
1579    SpId      spId;        /*!< Service provider Id */
1580    SuId      suId;        /*!< Service user Id */
1581    uint8_t   state;       /*!< Sap Status */
1582    CmTimer   bndTmr;      /*!< Bind Timer */
1583    uint16_t  bndTmrInt;   /*!< Timer Interval */
1584    uint8_t   retryCnt;    /*!< Bind Retry Count */
1585 }RlcRguSapCb;
1586
1587 /**
1588  * @brief  Structure to hold an information about the UDX UL SAP
1589  *
1590  * @details
1591  *    - pst       : Service user post structure
1592  *    - spId      : Service provider Id
1593  *    - suId      : Service user Id
1594  *    - state     : State of the SAP
1595  *    - bndTmr    : Bind Timer
1596  *    - bndTmrInt : Timer Interval
1597  *    - retryCnt  : Bind Retry Count
1598 */
1599 typedef struct rlcUdxUlSapCb
1600 {
1601    Pst       pst;         /*!< Service user post structure */
1602    SpId      spId;        /*!< Service provider Id */
1603    SuId      suId;        /*!< Service user Id */
1604    uint8_t   state;       /*!< Sap Status */
1605    CmTimer   bndTmr;      /*!< Bind Timer */
1606    uint16_t  bndTmrInt;   /*!< Timer Interval */
1607    uint8_t   retryCnt;    /*!< Bind Retry Count */
1608 }RlcUdxUlSapCb;
1609
1610 /**
1611  * @brief  Structure to hold an information about the UDX DL SAP
1612  *
1613  * @details
1614  *    - pst       : Service user post structure
1615  *    - spId      : Service provider Id
1616  *    - suId      : Service user Id
1617  *    - state     : State of the SAP
1618 */
1619 typedef struct rlcUdxDlSapCb
1620 {
1621    Pst     pst;     /*!< Service user post structure */
1622    SpId    spId;    /*!< Service provider Id */
1623    SuId    suId;    /*!< Service user Id */
1624    uint8_t state;   /*!< Sap Status */
1625 }RlcUdxDlSapCb;
1626
1627 /**
1628  * @brief  Structure to hold info about memory to be freed
1629  *
1630  * @details
1631  *    - sduLst  : The SDU queues are appended to this queue, used
1632  *                for the UM SDU queues
1633  *    - txLst   : Stores to be released AM Mode TX PDUs
1634  *    - reTxLst : Stores to be released AM Re TX PDU's
1635  *    - rbLst   : List of AM DL RBs to be freed
1636 */
1637 typedef struct rlcDlDataToBeFreed
1638 {
1639    CmLListCp   sduLst;     /*!< Queue of SDU's to be freed  */
1640    CmLListCp   txLst;     /*!< Stores to be released TX PDUs */
1641    CmLListCp   reTxLst;   /*!< Stores to be released ReTX PDUs */
1642    CmLListCp   rbLst;     /*!< List of AM DL RBs to be freed */
1643 }RlcDlDataToBeFreed;
1644
1645 /**
1646  * @brief  Structure to hold an information about DL RLC instance
1647  *
1648  * @details
1649  *    - numKwuSaps        : Number of RLC KWU Saps
1650  *    - numUdxSaps        : Number of RLC UDX Saps
1651  *    - rlcKwuDlSap          : Pointer to the array of KWU SAPS
1652  *    - udxDlSap          : Pointer to the array of UDX SAPS
1653  *    - rguDlSap          : RGU Sap Control Block
1654  *    - cellLstCp         : Hashlist of CellCb
1655  *    - ueLstCp           : Hashlist of UeCb
1656  *    - toBeFreed         : Pointer to data to be freed
1657  *    - shutdownReveived  : Request for shutdown recevied or not
1658  *    - eventInQueue      : Event for cleanup exists in queue or not
1659  */
1660 typedef struct rlcDlCb
1661 {
1662    uint8_t             numKwuSaps;         /*!< Number of RLC Data Saps */
1663    uint8_t             numUdxSaps;         /*!< Number of RLC Data Saps */
1664    RlcKwuSapCb         *rlcKwuDlSap;          /*!< KWU Sap Control Block */
1665    RlcUdxDlSapCb       *udxDlSap;          /*!< UDX DL Sap Control Block */
1666    RlcRguSapCb         *rguDlSap;          /*!< RGU Sap Control Block */
1667    CmHashListCp        cellLstCp;          /*!< Hashlist of CellCb */
1668    CmHashListCp        ueLstCp;            /*!< Hashlist of UeCb */
1669    RlcDlDataToBeFreed  toBeFreed;          /*!< Pointer to data to be freed */
1670    Pst                 selfPst;            /*!< Pst to post events to self */
1671    Buffer              *selfPstMBuf;       /*!< Buffer used for self post */
1672    Bool                shutdownReceived;   /*!< Request for shutdown recevied */
1673    Bool                eventInQueue;       /*!< Event exists in queue or not */
1674 #ifdef LTE_L2_MEAS
1675    RlcL2Cb              rlcL2Cb; /*!< Control Block for L2 Measurements in RLC */
1676 #endif /* LTE_L2_MEAS */
1677 }RlcDlCb;
1678
1679 /**
1680  * @brief  Structure to hold an information about UL RLC instance
1681  *
1682  * @details
1683  *    - ckwSap       : CKW Sap Conrol Block
1684  *    - numKwuSaps   : Number of RLC KWU Saps
1685  *    - numUdxSaps   : Number of RLC UDX Saps
1686  *    - udxUlSap     : Pointer to the array of UDX SAPS
1687  *    - rlcKwuUlSap     : Pointer to the array of KWU SAPS
1688  *    - rguUlSap     : RGU Sap Control Block
1689  *    - cellLstCp    : Hashlist of CellCb
1690  *    - ueLstCp      : Hashlist of UeCb
1691  *    - transIdLstCp : Hashlist of cfg trans
1692  */
1693 typedef struct rlcUlCb
1694 {
1695    RlcCkwSapCb     ckwSap;         /*!< CKW Sap Conrol Block */
1696    uint8_t         numKwuSaps;     /*!< Number of RLC Data Saps */
1697    uint8_t         numUdxSaps;     /*!< Number of RLC Data Saps */
1698    RlcUdxUlSapCb   *udxUlSap;      /*!< UDX DL Sap Control Block */
1699    RlcKwuSapCb     *rlcKwuUlSap;      /*!< KWU Sap Control Block */
1700    RlcRguSapCb     *rguUlSap;      /*!< RGU Sap Control Block */
1701    CmHashListCp   cellLstCp;      /*!< Hashlist of CellCb */
1702    CmHashListCp   ueLstCp;        /*!< Hashlist of UeCb */
1703    CmHashListCp   transIdLstCp;   /*!< Hashlist of cfg trans */
1704    uint8_t        rlcUlUdxEventType;  /*!<Ue Create/ReConfig> */
1705 /* kw005.201 added support for L2 Measurement */
1706 #ifdef LTE_L2_MEAS
1707    RlcL2Cb        rlcL2Cb; /*!< Control Block for L2 Measurements in RLC */
1708 #endif /* LTE_L2_MEAS */
1709 }RlcUlCb;
1710
1711 typedef enum
1712 {
1713    SEARCH,
1714    CREATE,
1715    DELETE
1716 }RlcSnssaiActionType;
1717
1718 typedef struct rlcThptPerUe
1719 {
1720    uint16_t ueId;
1721    uint64_t dataVol;
1722 }RlcThptPerUe;
1723
1724 typedef struct rlcTptPerSnssai
1725 {
1726    Snssai   *snssai;
1727    uint64_t dataVol;
1728 }RlcTptPerSnssai;
1729
1730
1731 typedef struct rlcSnssaiTputInfo
1732 {
1733    CmTimer       snssaiThptTmr;                   /* Throughput Timer */
1734    CmLListCp     *tputPerSnssaiList;
1735 }RlcSnssaiTputInfo;
1736
1737 typedef struct rlcUeTputInfo
1738 {
1739    CmTimer       ueThptTmr;                   /* Throughput Timer */
1740    uint8_t       numActvUe;                 /* Number of Active UEs */
1741    RlcThptPerUe  thptPerUe[MAX_NUM_UE];     /* Throughput calculated per UE */
1742 }RlcUeTputInfo;
1743 /**
1744  * @brief  Structure to hold information about throughput at  RLC
1745  *
1746  */
1747 typedef struct rlcThpt
1748 {
1749    Inst               inst;                /* RLC instance */
1750    RlcUeTputInfo      ueTputInfo;
1751    RlcSnssaiTputInfo  snssaiTputInfo;
1752 }RlcThpt;
1753
1754 /**
1755  * @brief  Structure to hold an information about a RLC instance
1756  *
1757  * @details
1758  *    - init    : Task Initialization Info
1759  *    - genCfg  : General Configuration
1760  *    - genSts  : General Statistics
1761  *    - trcLen  : Trace Length
1762  *    - trcMask : Trace Mask
1763  *    - rlcTq    : Timer queue
1764  *    - rlcTqCp  : Timer queue control point
1765  *    - u       : Union depending on whether the instance is UL or DL
1766  *      - ulCb  : UL instance Control Block
1767  *      - dlCb  : DL instance Control Block
1768  */
1769 typedef struct rlcCb
1770 {
1771    TskInit    init;               /*!< Task Initialization Info */
1772    RlcGenCfg   genCfg;             /*!< General Configuration Structure */
1773    RlcGenSts   genSts;             /*!< General Statistics */
1774    S16        trcLen;             /*!< Trace Length */
1775    uint8_t         trcMask;            /*!< Trace Mask */
1776    CmTqType   rlcTq[RLC_TMR_LEN];   /*!< Timer queue */
1777    CmTqCp     rlcTqCp;             /*!< Timer queue control point */
1778    union
1779    {
1780       RlcUlCb   *ulCb;   /*!< Ul Control Block */
1781       RlcDlCb   *dlCb;   /*!< Dl Control Block */
1782    } u;
1783    uint8_t    dlSduId;   /*!< Downlink SDU ID */
1784    RlcThpt    rlcThpt;   /*!< Throughput at RLC*/
1785 }RlcCb;
1786
1787 RlcCb *rlcCb[MAX_RLC_INSTANCES];   /*!< RLC global control block */
1788
1789 /****************************************************************************
1790  *                      Declarations
1791  ***************************************************************************/
1792 S16 rlcGetSId ARGS((SystemId *s));
1793
1794 Void rlcTmrExpiry ARGS((PTR cb, S16 tmrEvnt));
1795
1796 S16 rlcLmmSendTrc ARGS ((RlcCb *gCb, Event event, Buffer *mBuf));
1797
1798 void rlcStartTmr ARGS((RlcCb *gCb, PTR cb, S16 tmrEvnt));
1799
1800 void rlcStopTmr  ARGS((RlcCb *gCb, PTR cb, uint8_t tmrType));
1801
1802 bool rlcChkTmr ARGS((RlcCb *gCb,PTR cb, S16 tmrEvnt));
1803
1804 void rlcUeThptTmrExpiry(PTR cb);
1805
1806 uint8_t  rlcUeDeleteTmrExpiry(PTR cb);
1807
1808 void rlcSnssaiThptTmrExpiry(PTR cb);
1809 RlcTptPerSnssai* rlcHandleSnssaiTputlist(RlcCb *gCb, Snssai *snssai,\
1810                                   RlcSnssaiActionType action);
1811 void rlcCalculateTputPerSnssai(CmLListCp *snssaiList);
1812 void rlcDelTputSnssaiList(RlcCb *gCb);
1813
1814 #ifdef LTE_L2_MEAS
1815 Void rlcLmmSendAlarm ARGS (( RlcCb *gCb,
1816                                    uint16_t category,
1817                                    uint16_t event,
1818                                    uint16_t cause,
1819                                    SuId suId,
1820                                    uint32_t ueId,
1821                                    uint8_t qci));
1822
1823 S16 RlcMiRlcDlL2MeasReq ARGS (( Pst *pst, RlcL2MeasReqEvt *measReqEvt ));
1824 S16 RlcMiRlcDlL2MeasSendReq ARGS((Pst *pst,uint8_t measType));
1825 S16 RlcMiRlcDlL2MeasStopReq ARGS((Pst *pst,uint8_t measType));
1826 S16 RlcMiRlcUlL2MeasReq ARGS (( Pst *pst, RlcL2MeasReqEvt *measReqEvt ));
1827 S16 RlcMiRlcUlL2MeasSendReq ARGS((Pst *pst,uint8_t measType));
1828 S16 RlcMiRlcUlL2MeasStopReq ARGS((Pst *pst,uint8_t measType));
1829 Void rlcUtlPlcMeasDatInL2Sts ARGS((RlcL2Cntr *measData,
1830                                          RlcL2MeasRbCb *rbL2Cb,
1831                                          uint8_t measType));
1832 #else /* LTE_L2_MEAS */
1833 Void rlcLmmSendAlarm ARGS ((RlcCb *gCb,
1834                                   uint16_t category,
1835                                   uint16_t event,
1836                                   uint16_t cause,
1837                                   SuId suId,
1838                                   uint32_t ueId));
1839 #endif /* LTE_L2_MEAS */
1840
1841 #ifdef __cplusplus
1842 }
1843 #endif /* __cplusplus */
1844
1845 #endif /* __RLC_UTILS_H__ */
1846 /**********************************************************************
1847
1848          End of file
1849 **********************************************************************/