src/du_app/du_mgr.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 /* This file contains message handling functionality for DU cell management */
  20 #ifndef __DU_MGR_H__
  21 #define __DU_MGR_H__
  22
  23 #include "stdio.h"
  24 #include "ctype.h"
  25 #include "envopt.h"        /* Environment options */
  26 #include "envdep.h"        /* Environment dependent */
  27 #include "envind.h"        /* Environment independent */
  28 #include "gen.h"           /* General */
  29 #include "ssi.h"           /* System services */
  30 #include "cm5.h"           /* Common timer defines */
  31 #include "cm_tkns.h"       /* Common tokens defines */
  32 #include "cm_mblk.h"       /* Common memory allocation library defines */
  33 #include "cm_llist.h"      /* Common link list  defines  */
  34 #include "cm_hash.h"       /* Common hashlist  defines */
  35 #include "cm_lte.h"
  36 #include "cm_inet.h"
  37 #include "lkw.h"
  38 #include "lrg.h"
  39 #include "legtp.h"
  40 #include "du_app_mac_inf.h"
  41
  42 #include "gen.x"           /* General */
  43 #include "ssi.x"           /* System services */
  44
  45 #include "cm5.x"           /* Common timer library */
  46 #include "cm_tkns.x"       /* Common tokens */
  47 #include "cm_mblk.x"       /* Common memory allocation */
  48 #include "cm_llist.x"      /* Common link list */
  49 #include "cm_hash.x"       /* Common hashlist */
  50 #include "cm_lte.x"
  51 #include "cm_inet.x"
  52 #include "cm_lib.x"
  53 #include "lkw.x"
  54 #include "lrg.x"
  55
  56 #include "du_cfg.h"
  57
  58 #define DU_PROC  0
  59 /* Memory related configs */
  60 #define DU_APP_MEM_REGION    0
  61 #define RLC_UL_MEM_REGION    1
  62 #define RLC_DL_MEM_REGION    4
  63 #define MAC_MEM_REGION       4
  64
  65 #define DU_POOL  1
  66 #define RLC_POOL  1
  67 #define RG_POOL 1
  68
  69 /* Events */
  70 #define EVTCFG 0
  71 #define EVTSCTPSTRT  1
  72 #define EVENT_CU_DATA  2
  73 #define EVENT_SCTP_NTFY  3
  74 #define EVTSRVOPENREQ  4
  75 #define EVTSRVOPENCFM  5
  76 #define EVTTNLMGMTREQ  6
  77 #define EVTTNLMGMTCFM  7
  78 #define EVTSLOTIND    8
  79 #define EVTSTARTPOLL  9
  80 #define EVENT_RIC_DATA  10
  81
  82 /* Selector */
  83 #define DU_SELECTOR_LC   0
  84 #define DU_SELECTOR_TC   1
  85 #define DU_SELECTOR_LWLC 2
  86
  87 /* SAP IDs */
  88 #define DU_MAC_SUID 0
  89 #define DU_MAC_SPID 0
  90
  91 /* Instance */
  92 #define RLC_UL_INST 0
  93 #define RLC_DL_INST 1
  94
  95 /* SAP state */
  96 #define DU_SAP_UNBOUND 1
  97 #define DU_SAP_BINDING 2
  98 #define DU_SAP_BOUND   3
  99
 100 #define DU_ZERO_VAL 0
 101
 102 /* Macros */
 103
 104 #define ADD 0
 105 #define DEL 1
 106
 107 #define RLC_GEN_CFG      1
 108 #define RLC_MAC_SAP_CFG  2
 109 #define RLC_UDX_SAP_CFG  4
 110
 111 #define MAC_GEN_CFG   1
 112 #define MAC_SAP_CFG   2
 113 #define MAX_MAC_SAP   2
 114
 115 #define DU_RLC_UL_CONFIGURED  (RLC_GEN_CFG |  \
 116       RLC_MAC_SAP_CFG | RLC_UDX_SAP_CFG)
 117 #define DU_RLC_DL_CONFIGURED DU_RLC_UL_CONFIGURED
 118
 119 #define MAC_CONFIGURED (MAC_GEN_CFG | MAC_SAP_CFG)
 120
 121 #define DU_SET_ZERO(_buf, _size)   \
 122    cmMemset((U8 *)(_buf), 0, _size);
 123
 124 /* allocate and zero out a static buffer */
 125 #define DU_ALLOC(_datPtr, _size)                                \
 126 {                                                               \
 127    S16 _ret;                                                    \
 128    _ret = SGetSBuf(DU_APP_MEM_REGION, DU_POOL,                  \
 129                     (Data **)&_datPtr, _size);                  \
 130    if(_ret == ROK)                                              \
 131       cmMemset((U8*)_datPtr, 0, _size);                         \
 132    else                                                         \
 133       _datPtr = NULLP;                                          \
 134 }
 135
 136 /* free a static buffer */
 137 #define DU_FREE(_datPtr, _size)                                 \
 138    if(_datPtr)                                                  \
 139       SPutSBuf(DU_APP_MEM_REGION, DU_POOL,                      \
 140          (Data *)_datPtr, _size);
 141
 142 /* Allocate shared memory to be used for LWLC
 143  * during inter-layer communication */
 144 #define DU_ALLOC_SHRABL_BUF(_buf, _size)                     \
 145 {                                                            \
 146    if(SGetStaticBuffer(DU_APP_MEM_REGION, DU_POOL,           \
 147       (Data **)&_buf, (Size) _size, 0) == ROK)               \
 148    {                                                         \
 149       cmMemset((U8 *)(_buf), 0, _size);                      \
 150    }                                                         \
 151    else                                                      \
 152    {                                                         \
 153       (_buf) = NULLP;                                        \
 154    }                                                         \
 155 }
 156
 157 /* Free shared memory, received through LWLC */
 158 #define DU_FREE_SHRABL_BUF(_region, _pool,_buf, _size)          \
 159 {                                                               \
 160    if (_buf != NULLP)                                           \
 161    {                                                            \
 162       (Void) SPutStaticBuffer(_region, _pool,                   \
 163            (Data *) _buf, (Size) _size, 0);                     \
 164        _buf = NULLP;                                            \
 165    }                                                            \
 166 }
 167
 168
 169 typedef enum
 170 {
 171    CELL_OUT_OF_SERVICE,
 172    ACTIVATION_IN_PROGRESS,
 173    ACTIVATED,
 174    DELETION_IN_PROGRESS
 175 }CellStatus;
 176
 177 typedef struct cellCfgParams
 178 {
 179    NrEcgi      nrEcgi;         /* ECGI */
 180    U16         nrPci;          /* PCI */
 181    U16         fiveGsTac;         /* 5gSTac */
 182    Plmn      plmn[MAX_PLMN]; /* List of serving PLMN IDs */
 183    U32         maxUe;          /* max UE per slot */
 184 }CellCfgParams;
 185
 186
 187 typedef struct duCellCb
 188 {
 189    U32            cellId;      /* Internal cell Id */
 190    CellCfgParams  cellInfo;    /* Cell info */
 191    Bool           firstSlotIndRcvd;
 192    CellStatus     cellStatus;  /*Cell status */
 193 }DuCellCb;
 194
 195 typedef struct duLSapCb
 196 {
 197    Pst pst;
 198    SuId        suId;
 199    SpId        spId;
 200    State       sapState;
 201    Mem         mem;
 202    CmTimer     timer;
 203    U8          bndRetryCnt;
 204    U8          maxBndRetry;
 205    TmrCfg      bndTmr;
 206 }DuLSapCb;
 207
 208 typedef struct ueCcchCtxt
 209 {
 210    uint32_t gnbDuUeF1apId; /* GNB DU UE F1AP ID */
 211    uint16_t crnti;         /* CRNTI */
 212    uint16_t cellId;        /* Cell Id */
 213 }UeCcchCtxt;
 214
 215
 216 /* DU APP DB */
 217 typedef struct duCb
 218 {
 219    Mem           mem;    /* Memory configs */
 220    TskInit       init;   /* DU Init */
 221    //DuLSapCb      **macSap;  /* MAC SAP */
 222    Bool          f1Status; /* Status of F1 connection */
 223    Bool          e2Status; /* Status of E2 connection */
 224    DuCellCb*     cfgCellLst[DU_MAX_CELLS];     /* List of cells at DU APP of type DuCellCb */
 225    DuCellCb*     actvCellLst[DU_MAX_CELLS];    /* List of cells activated/to be activated of type DuCellCb */
 226    /* pointer to store the address of macCellCfg params used to send du-app to MAC */
 227    MacCellCfg     *duMacCellCfg;     /* pointer to store params while sending DU-APP to MAC */
 228         uint32_t      numUe;              /* current number of UEs */
 229         UeCcchCtxt    ueCcchCtxt[DU_MAX_UE]; /* mapping of gnbDuUeF1apId to CRNTI required for CCCH processing*/
 230 }DuCb;
 231
 232
 233 typedef struct duLSapCfg
 234 {
 235    SuId        suId;
 236    SpId        spId;
 237    Ent         srcEnt;
 238    Inst        srcInst;
 239    ProcId      dstProcId;
 240    Ent         dstEnt;
 241    Inst        dstInst;
 242    Priority    dstPrior;
 243    Route       dstRoute;
 244    Selector    dstSel;
 245    Mem         mem;
 246    U8          maxBndRetry;
 247    TmrCfg      bndTmr;
 248    TmrCfg      connTmr;
 249 }DuLSapCfg;
 250
 251 /* global variables */
 252 DuCb duCb;
 253 //DuCfgParams duCfgParam;
 254
 255 /* DU Cell Functions */
 256 S16 duActvInit(Ent entity, Inst inst, Region region, Reason reason);
 257 S16 duActvTsk(Pst *pst, Buffer *mBuf);
 258 S16 duSendRlcUlCfg();
 259 S16 duSendRlcDlCfg();
 260 S16 duBuildRlcCfg(Inst inst);
 261 S16 duBuildRlcLsapCfg(Ent ent, Inst inst, U8 lsapInst);
 262 S16 duBuildRlcUsapCfg(U8 elemId, Ent ent, Inst inst);
 263 S16 duHdlRlcCfgComplete(Pst *pst, KwMngmt *cfm);
 264 S16 duHdlRlcCntrlCfgComplete(Pst *pst, KwMngmt *cfm);
 265 S16 duProcRlcUlCfgComplete(Pst *pst, KwMngmt *cfm);
 266 S16 duProcRlcDlCfgComplete(Pst *pst, KwMngmt *cfm);
 267 S16 duSendMacCfg();
 268 S16 duBuildMacGenCfg();
 269 S16 duBuildMacUsapCfg(SpId sapId);
 270 S16 duHdlMacCfgComplete(Pst *pst, RgMngmt *cfm);
 271 S16 duBindUnbindRlcToMacSap(U8 inst, U8 action);
 272 S16 duProcCfgComplete();
 273 S16 duSendSchCfg();
 274 S16 duSctpStartReq();
 275 S16 duSctpNtfyHdl(Buffer *mBuf, CmInetSctpNotification *ntfy);
 276
 277 S16 duBuildEgtpCfgReq();
 278 S16 duHdlEgtpCfgComplete(CmStatus cfm);
 279 S16 duSendEgtpSrvOpenReq();
 280 S16 duHdlEgtpSrvOpenComplete(CmStatus cfm);
 281 S16 duSendEgtpTnlMgmtReq(U8 action, U32 lclTeid, U32 remTeid);
 282 S16 duHdlEgtpTnlMgmtCfm(EgtpTnlEvt tnlEvtCfm);
 283 S16 duSendEgtpTestData();
 284 S16 duSendEgtpDatInd(Buffer *mBuf);
 285 S16 duHdlSchCfgComplete(Pst *pst, RgMngmt *cfm);
 286 uint16_t duBuildAndSendMacCellStartReq();
 287 uint16_t duBuildAndSendMacCellStopReq();
 288
 289 #endif
 290
 291 /**********************************************************************
 292          End of file
 293 **********************************************************************/