src/ric_stub/ric_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 __RIC_MGR_MAIN_H__
  20 #define __RIC_MGR_MAIN_H__
  21
  22 #define RIC_ID 1
  23 #define RIC_NAME "ORAN_OAM_RIC"
  24
  25 #define DU_IP_V6_ADDR "0000:0000:0000:0000:0000:0000:0000:0001"
  26 #define RIC_IP_V6_ADDR "0000:0000:0000:0000:0000:0000:0000:0011"
  27
  28 #ifndef O1_ENABLE
  29 #define LOCAL_IP_RIC "192.168.130.80"
  30
  31 #define E2_SCTP_PORT 36421
  32 #define NUM_E2_ASSOC 1
  33 #define REMOTE_IP_DU (char*[]){"192.168.130.81", "192.168.130.83"}
  34 #endif
  35
  36 #define RRC_VER 0
  37 #define EXT_RRC_VER 5
  38 #define PLMN_MCC0 3
  39 #define PLMN_MCC1 1
  40 #define PLMN_MCC2 1
  41 #define PLMN_MNC0 4
  42 #define PLMN_MNC1 8
  43 #define PLMN_MNC2 0
  44
  45 #define RIC_DU_NAME_LEN_MAX 30      /* Max length of RIC/DU name string */
  46
  47 #define RIC_APP_MEM_REG 1
  48 #define RIC_POOL 1
  49 #define MAX_RAN_FUNCTION 256        /* O-RAN.WG3.E2AP-R003-v03.00 : Section 9.1.2.2 : maxofRANfunctionID */
  50
  51 /* allocate and zero out a static buffer */
  52 #define RIC_ALLOC(_datPtr, _size)                                \
  53 {                                                               \
  54    S16 _ret;                                                    \
  55    _ret = SGetSBuf(RIC_APP_MEM_REG, RIC_POOL,                  \
  56                      (Data **)&_datPtr, _size);                  \
  57    if(_ret == ROK)                                              \
  58       memset(_datPtr, 0, _size);                         \
  59    else                                                         \
  60       _datPtr = NULLP;                                          \
  61 }
  62
  63 /* free a static buffer */
  64 #define RIC_FREE(_datPtr, _size)                                 \
  65    SPutSBuf(RIC_APP_MEM_REG, RIC_POOL,                         \
  66          (Data *)_datPtr, _size);
  67
  68 #define SEARCH_DU_DB(_duIdx, _duId, _duDb){\
  69    _duDb = NULLP; \
  70    for(_duIdx=0; _duIdx < ricCb.numDu; _duIdx++)\
  71    {\
  72       if(ricCb.duInfo[_duIdx].duId == _duId)\
  73       {\
  74          _duDb =  (&ricCb.duInfo[_duIdx]);\
  75          break; \
  76      }\
  77    }\
  78 }
  79
  80 /* O-RAN.WG3.E2AP-R003-v03.00 : Section 9.2.26 */
  81 typedef enum
  82 {
  83    NG,
  84    XN,
  85    E1,
  86    F1,
  87    W1,
  88    S1,
  89    X2
  90 }InterfaceType;
  91
  92
  93 typedef struct
  94 {
  95    uint16_t  id;
  96    uint16_t  revisionCounter;
  97 }RanFunction;
  98
  99 typedef struct
 100 {
 101    InterfaceType   interfaceType;
 102    uint64_t        componentId;
 103 }E2NodeComponent;
 104
 105 typedef struct duDb
 106 {
 107    uint32_t        duId;
 108    uint16_t        numOfRanFunction;
 109    RanFunction     ranFunction[MAX_RAN_FUNCTION];
 110    E2NodeComponent e2NodeComponent;
 111    Bool            ricSubscribedToDu;
 112 }DuDb;
 113
 114 typedef struct ricCfgParams
 115 {
 116    uint32_t        ricId;
 117    char            ricName[RIC_DU_NAME_LEN_MAX];
 118    RicSctpParams   sctpParams;
 119    Plmn            plmn;
 120 }RicCfgParams;
 121
 122 typedef struct cuGlobalCb
 123 {
 124    RicCfgParams ricCfgParams;
 125    uint8_t      numDu;
 126    DuDb         duInfo[MAX_DU_SUPPORTED];
 127 }RicGlobalCb;
 128
 129 RicGlobalCb ricCb;
 130
 131 void readRicCfg();
 132 void cuAppInmsgHdlr(Buffer *mBuf);
 133 void sctpNtfyInd(CmInetSctpNotification *ntfy);
 134
 135 #endif
 136
 137 /**********************************************************************
 138          End of file
 139 **********************************************************************/