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