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    CELL_INACTIVE,
 118    CELL_ACTIVE,
 119    CELL_DELETION_IN_PROGRESS
 120 }CellStatusInfo;
 121
 122 typedef enum
 123 {
 124    UE_IDLE,
 125    UE_ATTACH_IN_PROGRESS,
 126    UE_ACTIVE,
 127    UE_HANDOVER_IN_PROGRESS
 128 }UeState;
 129
 130 typedef struct RrcVersion
 131 {
 132   uint8_t    rrcVer;     /* Latest RRC Version */
 133   uint32_t   extRrcVer;  /* Latest RRC version extended */
 134 }RrcVersion;
 135
 136 typedef struct cuCfgParams
 137 {
 138    uint32_t         cuId;
 139    char             cuName[CU_DU_NAME_LEN_MAX];
 140    CuSctpParams     sctpParams;
 141    Plmn             plmn;
 142    CuEgtpParams     egtpParams;
 143    RrcVersion       rrcVersion;
 144 }CuCfgParams;
 145
 146 typedef struct handoverInfo
 147 {
 148    uint32_t sourceDuId;
 149    uint32_t targetDuId;
 150 }HandoverInfo;
 151
 152 typedef struct dlAmCfg
 153 {
 154    uint8_t        snLenDl;              /* Sequence Number length in bits. Allowed values are 12 and 18 */
 155    int8_t         reAssemTmr;           /* T_reassembling Timer in msec*/
 156    int16_t        statProhTmr;          /* T_status_prohibit Timer in msec*/
 157 }DlAmCfg;
 158
 159 typedef struct ulAmCfg
 160 {
 161    uint8_t      snLenUl;             /* Sequence Number length in bits. Allowed values are 12 and 18 */
 162    uint16_t     pollRetxTmr;         /* T_poll_retransmit Timer in msec */
 163    int16_t      pollPdu;             /* Used to trigger a poll for every pollPdu.*/
 164    int32_t      pollByte;            /* Poll_Byte in bytes. */
 165    uint8_t      maxRetxTh;           /* Max_Retx_Threshold */
 166 }UlAmCfg;
 167
 168 typedef struct amBearerCfg
 169 {
 170    UlAmCfg  ulAmCfg;
 171    DlAmCfg  dlAmCfg;
 172 }AmBearerCfg;
 173
 174 typedef struct ulUmCfg
 175 {
 176    uint8_t        snLenUlUm;             /* Sequence Number length in bits. Allowed values are 6 and 12 */
 177 }UlUmCfg;
 178
 179 typedef struct dlUmCfg
 180 {
 181    uint8_t        snLenDlUm;             /* Sequence Number length in bits. Allowed values are 6 and 12 */
 182    int8_t         reAssemTmr;            /* T_reassembling Timer in msec*/
 183 }DlUmCfg;
 184
 185 typedef struct umBiDirBearerCfg
 186 {
 187    UlUmCfg  ulUmCfg;
 188    DlUmCfg  dlUmCfg;
 189 }UmBiDirBearerCfg;
 190
 191 typedef struct umUniDirUlBearerCfg
 192 {
 193    UlUmCfg  ulUmCfg;
 194 }UmUniDirUlBearerCfg;
 195
 196 typedef struct umUniDirDlBearerCfg
 197 {
 198    DlUmCfg  dlUmCfg;
 199 }UmUniDirDlBearerCfg;
 200
 201 typedef struct rlcLcCfg
 202 {
 203    uint8_t rlcMode;
 204    union
 205    {
 206       AmBearerCfg         amCfg;
 207       UmBiDirBearerCfg    umBiDirCfg;
 208       UmUniDirUlBearerCfg umUniDirUlCfg;
 209       UmUniDirDlBearerCfg umUniDirDlCfg;
 210    }u;
 211 }RlcLcCfg;
 212
 213 typedef struct macLcCfg
 214 {
 215    uint8_t priority;
 216    uint8_t lcGroup;
 217    uint8_t schReqId;
 218    uint8_t pbr;        // prioritisedBitRate
 219    uint8_t bsd;        // bucketSizeDuration
 220 }MacLcCfg;
 221
 222 typedef struct srbInfo
 223 {
 224    uint8_t   srbId;
 225    uint8_t   lcId;
 226    RlcLcCfg  rlcLcCfg;
 227    MacLcCfg  macLcCfg;
 228    bool      cfgSentToUe;
 229 }SrbInfo;
 230
 231 typedef struct qosInfo
 232 {
 233    uint8_t nonDynFiveQI;
 234    uint16_t avgWindow;
 235    uint16_t maxBurstDataVol;
 236    uint8_t priorityLevel;
 237    uint8_t preemptionCapability;
 238    uint8_t preemptionVulnerability;
 239    uint8_t pduSessionId;
 240 }QosInfo;
 241
 242 typedef struct flowsMapped
 243 {
 244    uint8_t qosFlowId;
 245    QosInfo qos;
 246 }FlowsMapped;
 247
 248 typedef struct TnlInfo
 249 {
 250    uint8_t address[4];
 251    uint8_t teId[4];
 252 }TnlInfo;
 253
 254 typedef struct drbInfo
 255 {
 256    uint8_t drbId;
 257    uint8_t lcId;
 258    QosInfo qos;
 259    Snssai *snssai;
 260    uint8_t numFlowMap;
 261    FlowsMapped flowMapList[MAX_QOS_FLOWS];
 262    TnlInfo ulUpTnlInfo;
 263    TnlInfo dlUpTnlInfo;
 264    uint8_t rlcMode;
 265    RlcLcCfg  rlcLcCfg;
 266    MacLcCfg  macLcCfg;
 267    bool      cfgSentToUe;
 268 }DrbInfo;
 269
 270 typedef struct cuCellCb CuCellCb;
 271
 272 #ifdef NR_DRX
 273 /* The following list of structures is taken from the DRX-Config section of specification 33.331. */
 274 typedef struct drxOnDurationTimer
 275 {
 276    bool  onDurationTimerValInMs;
 277    union
 278    {
 279       uint8_t  subMilliSeconds;
 280       uint16_t milliSeconds;
 281    }onDurationtimerValue;
 282 }DrxOnDurationTimer;
 283
 284 typedef struct drxLongCycleStartOffset
 285 {
 286    uint16_t drxLongCycleStartOffsetChoice;
 287    uint16_t drxLongCycleStartOffsetVal;
 288 }DrxLongCycleStartOffset;
 289
 290 typedef struct shortDrx
 291 {
 292    uint16_t   drxShortCycle;
 293    uint8_t    drxShortCycleTimer;
 294 }ShortDrx;
 295
 296 typedef struct drxCfg
 297 {
 298    DrxOnDurationTimer       drxOnDurationTimer;
 299    uint16_t                 drxInactivityTimer;
 300    uint8_t                  drxHarqRttTimerDl;
 301    uint8_t                  drxHarqRttTimerUl;
 302    uint16_t                 drxRetransmissionTimerDl;
 303    uint16_t                 drxRetransmissionTimerUl;
 304    DrxLongCycleStartOffset  drxLongCycleStartOffset;
 305    bool                     shortDrxPres;
 306    ShortDrx                 shortDrx;
 307    uint8_t                  drxSlotOffset;
 308 }DrxCfg;
 309 #endif
 310
 311 typedef struct cuUeCb
 312 {
 313    CuCellCb  *cellCb;
 314    uint32_t  crnti;
 315    uint8_t   gnbDuUeF1apId;
 316    uint8_t   gnbCuUeF1apId;
 317    uint16_t  pdcpSn;
 318    uint8_t   numSrb;
 319    SrbInfo   srbList[MAX_NUM_SRB];
 320    uint8_t   numDrb;
 321    DrbInfo   drbList[MAX_NUM_DRB];
 322    F1apMsgDb f1apMsgDb;
 323    UeState   state;
 324 #ifdef NR_DRX
 325    bool      drxCfgPresent;
 326    DrxCfg    drxCfg;
 327 #endif
 328    HandoverInfo hoInfo;
 329 }CuUeCb;
 330
 331 struct cuCellCb
 332 {
 333    uint32_t nrCellId;
 334    uint8_t  numUe;
 335    CuUeCb   *ueCb[MAX_NUM_UE];
 336    CellStatusInfo cellStatus;
 337 };
 338
 339 typedef struct duDb
 340 {
 341    uint32_t duId;
 342    char     duName[CU_DU_NAME_LEN_MAX];
 343    uint8_t  numCells;
 344    CuCellCb cellCb[MAX_NUM_CELL];
 345    uint8_t  numUe;
 346    CuUeCb   ueCb[MAX_NUM_CELL * MAX_NUM_UE];
 347 }DuDb;
 348
 349 typedef struct cuGlobalCb
 350 {
 351    CuCfgParams cuCfgParams;
 352    uint8_t     numSnssaiSupported;
 353    Snssai      *snssaiList[MAX_NUM_OF_SLICE];
 354    uint8_t     numDu;
 355    DuDb        duInfo[MAX_DU_SUPPORTED];
 356    uint32_t    gnbCuUeF1apIdGenerator;   /* Generating CU UE F1AP ID */
 357 }CuGlobalCb;
 358
 359 CuGlobalCb cuCb;
 360
 361 void readCuCfg();
 362 void cuAppInmsgHdlr(Buffer *mBuf);
 363 void sctpNtfyInd(CmInetSctpNotification *ntfy);
 364 uint8_t egtpInitReq();
 365 void *cuConsoleHandler(void *);
 366
 367 #endif
 368
 369 /**********************************************************************
 370          End of file
 371 **********************************************************************/