src/cu_stub/cu_stub.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 #ifndef __CU_MGR_MAIN_H__
  20 #define __CU_MGR_MAIN_H__
  21
  22 #define CU_ID 1
  23 #define CU_NAME "ORAN OAM CU"
  24
  25 #define DU_IP_V6_ADDR "0000:0000:0000:0000:0000:0000:0000:0001"
  26 #define CU_IP_V6_ADDR "0000:0000:0000:0000:0000:0000:0000:0011"
  27
  28 #ifndef O1_ENABLE
  29 #define LOCAL_IP_CU "192.168.130.82"
  30
  31 #define F1_SCTP_PORT 38472  /* As per the spec 38.472, the registered port number for F1AP is 38472 */
  32 #define NUM_F1_ASSOC 1
  33 #define REMOTE_IP_DU (char*[]){"192.168.130.81", "192.168.130.83"}
  34
  35 #define XN_SCTP_PORT 38422 /* As per 3GPP TS 38.422, The SCTP Destination Port number value assigned by IANA to be used for XnAP is 38422 */
  36 #define NUM_XN_ASSOC 0
  37 #define REMOTE_IP_CU (char*[]){"192.168.130.84"}
  38 #define LOCAL_NODE_TYPE SERVER
  39 #endif
  40
  41 #define F1_EGTP_PORT 2152 /* As per the spec 29.281, the registered port number for GTP-U is 2152 */
  42 #define RRC_VER 0
  43 #define EXT_RRC_VER 5
  44
  45 #define PLMN_MCC0 3
  46 #define PLMN_MCC1 1
  47 #define PLMN_MCC2 1
  48 #define PLMN_MNC0 4
  49 #define PLMN_MNC1 8
  50 #define PLMN_MNC2 0
  51
  52 #define CU_DU_NAME_LEN_MAX 30      /* Max length of CU/DU name string */
  53
  54 #define CU_APP_MEM_REG 1
  55 #define CU_POOL 1
  56
  57 #define MAX_NUM_OF_SLICE 1024 /* As per the spec 38.473, maxnoofSliceItems = 1024*/
  58 #define MAX_QOS_FLOWS 64 /* As per the spec 38.331, maxNrofQFIs = 64 */
  59
  60 /* allocate and zero out a static buffer */
  61
  62 #define CU_ALLOC(_datPtr, _size)                             \
  63 {                                                            \
  64    S16 _ret;                                                 \
  65    _ret = SGetSBuf(CU_APP_MEM_REG, CU_POOL,                  \
  66                      (Data **)&_datPtr, _size);              \
  67    if(_ret == ROK)                                           \
  68       memset(_datPtr, 0, _size);                      \
  69    else                                                      \
  70       _datPtr = NULLP;                                       \
  71 }
  72
  73 /* free a static buffer */
  74 #define CU_FREE(_datPtr, _size)                              \
  75    if(_datPtr)                                               \
  76    SPutSBuf(CU_APP_MEM_REG, CU_POOL,                         \
  77          (Data *)_datPtr, _size);
  78
  79 #define SEARCH_DU_DB(_duIdx, _duId, _duDb){\
  80    _duDb = NULLP; \
  81    for(_duIdx=0; _duIdx < cuCb.numDu; _duIdx++)\
  82    {\
  83       if(cuCb.duInfo[_duIdx].duId == _duId)\
  84       {\
  85          _duDb =  (&cuCb.duInfo[_duIdx]);\
  86          break; \
  87      }\
  88    }\
  89 }
  90
  91 #define SEARCH_CELL_DB(_cellIdx, _duDb, _nrCellId, _cellCb){\
  92    _cellCb = NULLP; \
  93    for(_cellIdx=0; _cellIdx < _duDb->numCells; _cellIdx++)\
  94    {\
  95       if(_duDb->cellCb[_cellIdx].nrCellId == _nrCellId)\
  96       {\
  97          _cellCb = (&(_duDb->cellCb[_cellIdx]));\
  98          break;\
  99       }\
 100    }\
 101 }
 102
 103 #ifdef NR_DRX
 104 /* Set this parameter true of false as per the need to enable or disable drx of
 105  * a particular UE */
 106 #define DRX_TO_BE_RELEASE true
 107 #endif
 108
 109 typedef enum
 110 {
 111   Xn_Based_Inter_CU_HO = 1,
 112   Inter_DU_HO
 113 }HandoverType;
 114
 115 typedef enum
 116 {
 117    XN_SETUP_REQ,
 118    XN_SETUP_RSP,
 119    HO_REQ,
 120    HO_REQ_ACK
 121 }XnEventType;
 122
 123 typedef enum
 124 {
 125    CELL_INACTIVE,
 126    CELL_ACTIVE,
 127    CELL_DELETION_IN_PROGRESS
 128 }CellStatusInfo;
 129
 130 typedef enum
 131 {
 132    UE_IDLE,
 133    UE_ATTACH_IN_PROGRESS,
 134    UE_ACTIVE,
 135    UE_HANDOVER_IN_PROGRESS
 136 }UeState;
 137
 138 typedef struct RrcVersion
 139 {
 140   uint8_t    rrcVer;     /* Latest RRC Version */
 141   uint32_t   extRrcVer;  /* Latest RRC version extended */
 142 }RrcVersion;
 143
 144 typedef struct cuCfgParams
 145 {
 146    uint32_t         cuId;
 147    char             cuName[CU_DU_NAME_LEN_MAX];
 148    CuSctpParams     sctpParams;
 149    Plmn             plmn;
 150    CuEgtpParams     egtpParams;
 151    RrcVersion       rrcVersion;
 152 }CuCfgParams;
 153
 154 typedef struct handoverInfo
 155 {
 156    HandoverType HOType;
 157    uint32_t srcNodeId;   /* If Inter_DU HO, this is Source DU ID. In case of Inter CU HO, this is Source CU ID */
 158    uint32_t tgtNodeId;   /* If Inter_DU HO, this is Taregt DU ID. In case of Inter CU HO, this is Target CU ID */
 159    uint32_t tgtCellId;   /* Cell Id in target node to which UE is to be handed over */
 160    uint8_t  cuUeF1apIdSrc;  /* Used for Inter-CU HO. CU UE F1AP ID of UE in source CU */
 161    uint8_t  cuUeF1apIdTgt;  /* Used for Inter-CU HO. CU UE F1AP ID of UE in target CU */
 162 }HandoverInfo;
 163
 164 typedef struct dlAmCfg
 165 {
 166    uint8_t        snLenDl;              /* Sequence Number length in bits. Allowed values are 12 and 18 */
 167    int8_t         reAssemTmr;           /* T_reassembling Timer in msec*/
 168    int16_t        statProhTmr;          /* T_status_prohibit Timer in msec*/
 169 }DlAmCfg;
 170
 171 typedef struct ulAmCfg
 172 {
 173    uint8_t      snLenUl;             /* Sequence Number length in bits. Allowed values are 12 and 18 */
 174    uint16_t     pollRetxTmr;         /* T_poll_retransmit Timer in msec */
 175    int16_t      pollPdu;             /* Used to trigger a poll for every pollPdu.*/
 176    int32_t      pollByte;            /* Poll_Byte in bytes. */
 177    uint8_t      maxRetxTh;           /* Max_Retx_Threshold */
 178 }UlAmCfg;
 179
 180 typedef struct amBearerCfg
 181 {
 182    UlAmCfg  ulAmCfg;
 183    DlAmCfg  dlAmCfg;
 184 }AmBearerCfg;
 185
 186 typedef struct ulUmCfg
 187 {
 188    uint8_t        snLenUlUm;             /* Sequence Number length in bits. Allowed values are 6 and 12 */
 189 }UlUmCfg;
 190
 191 typedef struct dlUmCfg
 192 {
 193    uint8_t        snLenDlUm;             /* Sequence Number length in bits. Allowed values are 6 and 12 */
 194    int8_t         reAssemTmr;            /* T_reassembling Timer in msec*/
 195 }DlUmCfg;
 196
 197 typedef struct umBiDirBearerCfg
 198 {
 199    UlUmCfg  ulUmCfg;
 200    DlUmCfg  dlUmCfg;
 201 }UmBiDirBearerCfg;
 202
 203 typedef struct umUniDirUlBearerCfg
 204 {
 205    UlUmCfg  ulUmCfg;
 206 }UmUniDirUlBearerCfg;
 207
 208 typedef struct umUniDirDlBearerCfg
 209 {
 210    DlUmCfg  dlUmCfg;
 211 }UmUniDirDlBearerCfg;
 212
 213 typedef struct rlcLcCfg
 214 {
 215    uint8_t rlcMode;
 216    union
 217    {
 218       AmBearerCfg         amCfg;
 219       UmBiDirBearerCfg    umBiDirCfg;
 220       UmUniDirUlBearerCfg umUniDirUlCfg;
 221       UmUniDirDlBearerCfg umUniDirDlCfg;
 222    }u;
 223 }RlcLcCfg;
 224
 225 typedef struct macLcCfg
 226 {
 227    uint8_t priority;
 228    uint8_t lcGroup;
 229    uint8_t schReqId;
 230    uint8_t pbr;        // prioritisedBitRate
 231    uint8_t bsd;        // bucketSizeDuration
 232 }MacLcCfg;
 233
 234 typedef struct srbInfo
 235 {
 236    uint8_t   srbId;
 237    uint8_t   lcId;
 238    RlcLcCfg  rlcLcCfg;
 239    MacLcCfg  macLcCfg;
 240    bool      cfgSentToUe;
 241 }SrbInfo;
 242
 243 typedef struct qosInfo
 244 {
 245    uint8_t nonDynFiveQI;
 246    uint16_t avgWindow;
 247    uint16_t maxBurstDataVol;
 248    uint8_t priorityLevel;
 249    uint8_t preemptionCapability;
 250    uint8_t preemptionVulnerability;
 251    uint8_t pduSessionId;
 252 }QosInfo;
 253
 254 typedef struct flowsMapped
 255 {
 256    uint8_t qosFlowId;
 257    QosInfo qos;
 258 }FlowsMapped;
 259
 260 typedef struct TnlInfo
 261 {
 262    uint8_t address[4];
 263    uint8_t teId[4];
 264 }TnlInfo;
 265
 266 typedef struct drbInfo
 267 {
 268    uint8_t drbId;
 269    uint8_t lcId;
 270    QosInfo qos;
 271    Snssai *snssai;
 272    uint8_t numFlowMap;
 273    FlowsMapped flowMapList[MAX_QOS_FLOWS];
 274    TnlInfo ulUpTnlInfo;
 275    TnlInfo dlUpTnlInfo;
 276    uint8_t rlcMode;
 277    RlcLcCfg  rlcLcCfg;
 278    MacLcCfg  macLcCfg;
 279    bool      cfgSentToUe;
 280 }DrbInfo;
 281
 282 typedef struct cuCellCb CuCellCb;
 283
 284 #ifdef NR_DRX
 285 /* The following list of structures is taken from the DRX-Config section of specification 33.331. */
 286 typedef struct drxOnDurationTimer
 287 {
 288    bool  onDurationTimerValInMs;
 289    union
 290    {
 291       uint8_t  subMilliSeconds;
 292       uint16_t milliSeconds;
 293    }onDurationtimerValue;
 294 }DrxOnDurationTimer;
 295
 296 typedef struct drxLongCycleStartOffset
 297 {
 298    uint16_t drxLongCycleStartOffsetChoice;
 299    uint16_t drxLongCycleStartOffsetVal;
 300 }DrxLongCycleStartOffset;
 301
 302 typedef struct shortDrx
 303 {
 304    uint16_t   drxShortCycle;
 305    uint8_t    drxShortCycleTimer;
 306 }ShortDrx;
 307
 308 typedef struct drxCfg
 309 {
 310    DrxOnDurationTimer       drxOnDurationTimer;
 311    uint16_t                 drxInactivityTimer;
 312    uint8_t                  drxHarqRttTimerDl;
 313    uint8_t                  drxHarqRttTimerUl;
 314    uint16_t                 drxRetransmissionTimerDl;
 315    uint16_t                 drxRetransmissionTimerUl;
 316    DrxLongCycleStartOffset  drxLongCycleStartOffset;
 317    bool                     shortDrxPres;
 318    ShortDrx                 shortDrx;
 319    uint8_t                  drxSlotOffset;
 320 }DrxCfg;
 321 #endif
 322
 323 typedef struct cuUeCb
 324 {
 325    CuCellCb  *cellCb;
 326    uint32_t  crnti;
 327    uint8_t   gnbDuUeF1apId;
 328    uint8_t   gnbCuUeF1apId;
 329    uint16_t  pdcpSn;
 330    uint8_t   numSrb;
 331    SrbInfo   srbList[MAX_NUM_SRB];
 332    uint8_t   numDrb;
 333    DrbInfo   drbList[MAX_NUM_DRB];
 334    F1apMsgDb f1apMsgDb;
 335    UeState   state;
 336 #ifdef NR_DRX
 337    bool      drxCfgPresent;
 338    DrxCfg    drxCfg;
 339 #endif
 340    HandoverInfo hoInfo;
 341 }CuUeCb;
 342
 343 struct cuCellCb
 344 {
 345    uint32_t nrCellId;
 346    uint8_t  numUe;
 347    CuUeCb   *ueCb[MAX_NUM_UE];
 348    CellStatusInfo cellStatus;
 349 };
 350
 351 typedef struct duDb
 352 {
 353    uint32_t duId;
 354    char     duName[CU_DU_NAME_LEN_MAX];
 355    uint8_t  numCells;
 356    CuCellCb cellCb[MAX_NUM_CELL];
 357    uint8_t  numUe;
 358    CuUeCb   ueCb[MAX_NUM_CELL * MAX_NUM_UE];
 359    CuUeCb   *tempUeCtxtInHo;
 360 }DuDb;
 361
 362 typedef struct cuGlobalCb
 363 {
 364    CuCfgParams cuCfgParams;
 365    uint8_t     numSnssaiSupported;
 366    Snssai      *snssaiList[MAX_NUM_OF_SLICE];
 367    uint8_t     numDu;
 368    DuDb        duInfo[MAX_DU_SUPPORTED];
 369    uint32_t    gnbCuUeF1apIdGenerator;   /* Generating CU UE F1AP ID */
 370 }CuGlobalCb;
 371
 372 CuGlobalCb cuCb;
 373
 374 void readCuCfg();
 375 void cuAppInmsgHdlr(Buffer *mBuf);
 376 void sctpNtfyInd(CmInetSctpNotification *ntfy);
 377 uint8_t egtpInitReq();
 378 void *cuConsoleHandler(void *);
 379
 380 #endif
 381
 382 /**********************************************************************
 383          End of file
 384 **********************************************************************/