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 #define DU_PROC  0
  23
  24 /* SAP IDs */
  25 #define DU_MAC_SUID 0
  26 #define DU_MAC_SPID 0
  27
  28 /* Instance */
  29 #define RLC_UL_INST 0
  30 #define RLC_DL_INST 1
  31
  32 /* SAP state */
  33 #define DU_SAP_UNBOUND 1
  34 #define DU_SAP_BINDING 2
  35 #define DU_SAP_BOUND   3
  36
  37 #define DU_ZERO_VAL 0
  38
  39 /* Macros */
  40 #define ADD 0
  41 #define DEL 1
  42
  43 #define RLC_GEN_CFG      1
  44 #define RLC_MAC_SAP_CFG  2
  45 #define RLC_UDX_SAP_CFG  4
  46
  47 #define MAC_GEN_CFG   1
  48 #define MAC_SAP_CFG   2
  49 #define MAX_MAC_SAP   2
  50
  51 #define DU_RLC_UL_CONFIGURED  (RLC_GEN_CFG |  \
  52       RLC_MAC_SAP_CFG | RLC_UDX_SAP_CFG)
  53 #define DU_RLC_DL_CONFIGURED DU_RLC_UL_CONFIGURED
  54
  55 #define MAC_CONFIGURED (MAC_GEN_CFG | MAC_SAP_CFG)
  56
  57 #define DU_SET_ZERO(_buf, _size)   \
  58    memset((_buf), 0, _size);
  59
  60 typedef enum
  61 {
  62    SLICE_INFO_NOT_AVAILABLE,
  63    SLICE_CONFIGURED,
  64    SLICE_RECONFIGURED
  65 }SliceCfgState;
  66
  67 typedef enum
  68 {
  69    CELL_OUT_OF_SERVICE,
  70    ACTIVATION_IN_PROGRESS,
  71    ACTIVATED,
  72    DELETION_IN_PROGRESS
  73 }CellStatus;
  74
  75 typedef enum
  76 {
  77    UE_INACTIVE,
  78    UE_ACTIVE,
  79    UE_DELETION_IN_PROGRESS
  80 }UeState;
  81
  82 typedef enum
  83 {
  84    UE_CTXT_UNKNOWN,
  85    UE_CTXT_SETUP,
  86    UE_CTXT_MOD,
  87    UE_CTXT_RELEASE
  88 }UeCtxtActionType;
  89
  90 /** F1AP Msg IE **/
  91 typedef struct f1setupRsp
  92 {
  93    uint32_t transId; /* Uniquely identify transaction */
  94    char     cuName[CU_DU_NAME_LEN_MAX];   /* CU Name */
  95    F1RrcVersion    rrcVersion;  /* RRC version */
  96 }F1SetupRsp;
  97
  98 typedef struct f1DlRrcMsg
  99 {
 100    uint32_t gnbDuUeF1apId;
 101    uint32_t gnbCuUeF1apId;
 102    uint8_t  srbId;
 103    bool     execDup;
 104    bool     deliveryStatRpt;
 105    uint16_t rrcMsgSize;
 106    uint8_t  *rrcMsgPdu;
 107 }F1DlRrcMsg;
 108
 109 typedef struct gtpTnlCfg
 110 {
 111    uint32_t ulTnlAddress;  /* remote Address */
 112    uint32_t dlTnlAddress;  /* local Address */
 113    uint32_t teId;
 114 }GtpTnlCfg;
 115
 116 typedef struct upTnlCfg
 117 {
 118    ConfigType configType;
 119    uint8_t cellId;
 120    uint8_t ueIdx;
 121    uint8_t drbId;
 122    GtpTnlCfg *tnlCfg1; /* Tunnel 1 */
 123    GtpTnlCfg *tnlCfg2; /* Tunnel 2 */
 124 }UpTnlCfg;
 125
 126 typedef struct duUeCfg
 127 {
 128    void *cellGrpCfg;
 129    void *ueNrCapability;
 130    uint8_t numRlcLcs;        /* Rlc Ue Cfg */
 131    RlcBearerCfg rlcLcCfg[MAX_NUM_LC];
 132    uint8_t numMacLcs;        /* Mac Ue Cfg */
 133    LcCfg   macLcCfg[MAX_NUM_LC];
 134    AmbrCfg *ambrCfg;
 135    uint8_t numDrb;
 136    UpTnlCfg upTnlInfo[MAX_NUM_DRB];  /* User plane TNL Info*/
 137    MacUeCfg copyOfmacUeCfg;
 138 }DuUeCfg;
 139
 140 typedef struct f1UeContextSetup
 141 {
 142    UeCtxtActionType actionType;
 143    uint8_t cellIdx;
 144    DuUeCfg  duUeCfg;
 145    bool     dlRrcMsgPres;
 146    F1DlRrcMsg  *dlRrcMsg;
 147 }F1UeContextSetupDb;
 148
 149 typedef struct cellCfgParams
 150 {
 151    NrEcgi      nrEcgi;         /* ECGI */
 152    uint16_t    nrPci;          /* PCI */
 153    uint16_t    fiveGsTac;         /* 5gSTac */
 154    Plmn        plmn[MAX_PLMN]; /* List of serving PLMN IDs */
 155    uint32_t    maxUe;          /* max UE per slot */
 156 }CellCfgParams;
 157
 158 typedef struct duUeCb
 159 {
 160    F1UeContextSetupDb *f1UeDb;
 161    uint16_t crnti;
 162    uint32_t gnbDuUeF1apId;   /* GNB DU UE F1AP ID */
 163    uint32_t gnbCuUeF1apId;   /* GNB CU UE F1AP ID */
 164    uint32_t drbBitMap;       /* Drb Bit Map */
 165    UeState  ueState;         /* UE Active/ Ue Inactive state */
 166    MacUeCfg macUeCfg;        /* Mac Ue Cfg */
 167    RlcUeCfg rlcUeCfg;        /* Rlc Ue Cfg */
 168 }DuUeCb;
 169
 170 typedef struct duCellCb
 171 {
 172    uint16_t       cellId;                 /* Internal cell Id */
 173    CellCfgParams  cellInfo;               /* Cell info */
 174    /* pointer to store the address of macCellCfg params used to send du-app to MAC */
 175    MacCellCfg     *duMacCellCfg;
 176    CellStatus     cellStatus;             /* Cell status */
 177    uint32_t       gnbDuUeF1apIdGenerator; /* Generating Du Ue F1ap Id */
 178    uint32_t       numActvUes;             /* Total Active UEs */
 179    DuUeCb         ueCb[MAX_NUM_UE];       /* UE CONTEXT */
 180 }DuCellCb;
 181
 182 typedef struct duLSapCb
 183 {
 184    Pst pst;
 185    SuId        suId;
 186    SpId        spId;
 187    State       sapState;
 188    Mem         mem;
 189    CmTimer     timer;
 190    uint8_t     bndRetryCnt;
 191    uint8_t     maxBndRetry;
 192    TmrCfg      bndTmr;
 193 }DuLSapCb;
 194
 195 typedef struct ueCcchCtxt
 196 {
 197    uint32_t gnbDuUeF1apId; /* GNB DU UE F1AP ID */
 198    uint16_t crnti;         /* CRNTI */
 199    uint16_t cellId;        /* Cell Id */
 200 }UeCcchCtxt;
 201
 202 /* This structure is added to store the information about the F1AP pdu and
 203  * transId so that It can be used in future */
 204 typedef struct reservedF1apPduInfo
 205 {
 206    uint8_t transId;               /* trans Id */
 207    void *f1apMsg;              /* msg structure */
 208 }ReservedF1apPduInfo;
 209
 210 /* DU APP DB */
 211 typedef struct duCb
 212 {
 213    Mem           mem;                       /* Memory configs */
 214    TskInit       init;                      /* DU Init */
 215    bool          f1Status;                  /* Status of F1 connection */
 216    bool          e2Status;                  /* Status of E2 connection */
 217    uint8_t       numCfgCells;               /* number of configured cells */
 218    DuCellCb*     cfgCellLst[MAX_NUM_CELL];  /* List of cells at DU APP of type DuCellCb */
 219    uint8_t       numActvCells;              /* Number of active cells */
 220    DuCellCb*     actvCellLst[MAX_NUM_CELL]; /* List of cells activated/to be activated of type DuCellCb */
 221    uint32_t      numUe;                     /* current number of UEs */
 222    UeCcchCtxt    ueCcchCtxt[MAX_NUM_UE];    /* mapping of gnbDuUeF1apId to CRNTI required for CCCH processing*/
 223    uint8_t       numDrb;                    /* current number of DRbs*/
 224    UpTnlCfg*     upTnlCfg[MAX_NUM_DRB];     /* tunnel info for every Drb */
 225    CmLListCp     reservedF1apPduList;       /*storing F1AP pdu infomation and transId */
 226    SliceCfgState sliceState;
 227 }DuCb;
 228
 229
 230 typedef struct duLSapCfg
 231 {
 232    SuId        suId;
 233    SpId        spId;
 234    Ent         srcEnt;
 235    Inst        srcInst;
 236    ProcId      dstProcId;
 237    Ent         dstEnt;
 238    Inst        dstInst;
 239    Priority    dstPrior;
 240    Route       dstRoute;
 241    Selector    dstSel;
 242    Mem         mem;
 243    uint8_t          maxBndRetry;
 244    TmrCfg      bndTmr;
 245    TmrCfg      connTmr;
 246 }DuLSapCfg;
 247
 248 /* global variables */
 249 DuCb duCb;
 250 //DuCfgParams duCfgParam;
 251
 252 /* DU Cell Functions */
 253 uint8_t duActvInit(Ent entity, Inst inst, Region region, Reason reason);
 254 uint8_t duActvTsk(Pst *pst, Buffer *mBuf);
 255 uint8_t duSendRlcUlCfg();
 256 uint8_t duSendRlcDlCfg();
 257 uint8_t duBuildRlcCfg(Inst inst);
 258 uint8_t duBuildRlcLsapCfg(Ent ent, Inst inst, uint8_t lsapInst);
 259 uint8_t duBuildRlcUsapCfg(uint8_t elemId, Ent ent, Inst inst);
 260 uint8_t DuHdlRlcCfgComplete(Pst *pst, RlcMngmt *cfm);
 261 uint8_t duHdlRlcCntrlCfgComplete(Pst *pst, RlcMngmt *cfm);
 262 uint8_t duProcRlcUlCfgComplete(Pst *pst, RlcMngmt *cfm);
 263 uint8_t duProcRlcDlCfgComplete(Pst *pst, RlcMngmt *cfm);
 264 uint8_t duSendMacCfg();
 265 uint8_t duBuildMacGenCfg();
 266 uint8_t duBuildMacUsapCfg(SpId sapId);
 267 uint8_t duHdlMacCfgComplete(Pst *pst, RgMngmt *cfm);
 268 uint8_t duBindUnbindRlcToMacSap(uint8_t inst, uint8_t action);
 269 uint8_t duProcCfgComplete();
 270 uint8_t duSendSchCfg();
 271 uint8_t duSctpStartReq();
 272 uint8_t duSctpNtfyHdl(Buffer *mBuf, CmInetSctpNotification *ntfy);
 273
 274 uint8_t duBuildEgtpCfgReq();
 275 uint8_t duHdlEgtpCfgComplete(CmStatus cfm);
 276 uint8_t duSendEgtpSrvOpenReq();
 277 uint8_t duHdlEgtpSrvOpenComplete(CmStatus cfm);
 278 uint8_t duSendEgtpTnlMgmtReq(uint8_t action, uint32_t teIdMod, GtpTnlCfg *tnlInfo);
 279 uint8_t duSendEgtpDatInd(Buffer *mBuf);
 280 uint8_t duHdlSchCfgComplete(Pst *pst, RgMngmt *cfm);
 281 uint8_t duBuildAndSendMacCellStart();
 282 uint8_t duBuildAndSendMacCellStop(uint16_t cellId);
 283 #endif
 284
 285 /**********************************************************************
 286   End of file
 287  **********************************************************************/