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 #define MAX_NUM_TRANSACTION 256     /* As per, O-RAN WG3 E2AP v3.0, section 9.2.33 */
  51
  52 /* allocate and zero out a static buffer */
  53 #define RIC_ALLOC(_datPtr, _size)                                \
  54 {                                                               \
  55    S16 _ret;                                                    \
  56    _ret = SGetSBuf(RIC_APP_MEM_REG, RIC_POOL,                  \
  57                      (Data **)&_datPtr, _size);                  \
  58    if(_ret == ROK)                                              \
  59       memset(_datPtr, 0, _size);                         \
  60    else                                                         \
  61       _datPtr = NULLP;                                          \
  62 }
  63
  64 /* free a static buffer */
  65 #define RIC_FREE(_datPtr, _size)                                 \
  66    SPutSBuf(RIC_APP_MEM_REG, RIC_POOL,                         \
  67          (Data *)_datPtr, _size);
  68
  69 #define SEARCH_DU_DB(_duIdx, _duId, _duDb){\
  70    _duDb = NULLP; \
  71    for(_duIdx=0; _duIdx < ricCb.numDu; _duIdx++)\
  72    {\
  73       if(ricCb.duInfo[_duIdx].duId == _duId)\
  74       {\
  75          _duDb =  (&ricCb.duInfo[_duIdx]);\
  76          break; \
  77      }\
  78    }\
  79 }
  80
  81 /* O-RAN.WG3.E2AP-R003-v03.00 : Section 9.2.26 */
  82 typedef enum
  83 {
  84    NG,
  85    XN,
  86    E1,
  87    F1,
  88    W1,
  89    S1,
  90    X2
  91 }InterfaceType;
  92
  93
  94 typedef struct
  95 {
  96    uint16_t  id;
  97    uint16_t  revisionCounter;
  98 }RanFunction;
  99
 100 typedef struct
 101 {
 102    InterfaceType   interfaceType;
 103    uint64_t        componentId;
 104 }E2NodeComponent;
 105
 106 typedef struct duDb
 107 {
 108    uint32_t        duId;
 109    uint8_t         ricTransIdCounter;
 110    uint16_t        numOfRanFunction;
 111    RanFunction     ranFunction[MAX_RAN_FUNCTION];
 112    E2NodeComponent e2NodeComponent;
 113    Bool            ricSubscribedToDu;
 114 }DuDb;
 115
 116 typedef struct ricCfgParams
 117 {
 118    uint32_t        ricId;
 119    char            ricName[RIC_DU_NAME_LEN_MAX];
 120    RicSctpParams   sctpParams;
 121    Plmn            plmn;
 122 }RicCfgParams;
 123
 124 typedef struct cuGlobalCb
 125 {
 126    RicCfgParams ricCfgParams;
 127    uint8_t      numDu;
 128    DuDb         duInfo[MAX_DU_SUPPORTED];
 129 }RicGlobalCb;
 130
 131 RicGlobalCb ricCb;
 132
 133 typedef struct
 134 {
 135    uint8_t numOfRanFunToBeAdded;
 136    RanFunction ranFunToBeAdded[MAX_RAN_FUNCTION];
 137    uint8_t numOfRanFunToBeModified;
 138    RanFunction ranFunToBeModified[MAX_RAN_FUNCTION];
 139    uint8_t numOfRanFunTodeleted;
 140    RanFunction ranFunToBeDeleted[MAX_RAN_FUNCTION];
 141 }RicTmpRanFunList;
 142
 143 void readRicCfg();
 144 void cuAppInmsgHdlr(Buffer *mBuf);
 145 void sctpNtfyInd(CmInetSctpNotification *ntfy);
 146
 147 #endif
 148
 149 /**********************************************************************
 150          End of file
 151 **********************************************************************/