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 /*Refer Spec 38.331 Annexure A: maxNrofPageRec : 32 [Maximum number of page records]*/
  61 #define MAX_PAGING_UE_RECORDS 32
  62
  63 typedef enum
  64 {
  65    SLICE_INFO_NOT_AVAILABLE,
  66    SLICE_CONFIGURED,
  67    SLICE_RECONFIGURED
  68 }SliceCfgState;
  69
  70 typedef enum
  71 {
  72    CELL_OUT_OF_SERVICE,
  73    ACTIVATION_IN_PROGRESS,
  74    ACTIVATED,
  75    DELETION_IN_PROGRESS
  76 }CellStatus;
  77
  78 typedef enum
  79 {
  80    UE_INACTIVE,
  81    UE_ACTIVE,
  82    UE_HANDIN_IN_PROGRESS,
  83    UE_DELETION_IN_PROGRESS
  84 }UeState;
  85
  86 typedef enum
  87 {
  88    UE_CTXT_UNKNOWN,
  89    UE_CTXT_SETUP,
  90    UE_CTXT_MOD,
  91    UE_CTXT_RRC_RECFG_COMPLETE,
  92    UE_CTXT_CFG_QUERY,
  93    UE_CTXT_RELEASE
  94 }UeCtxtActionType;
  95
  96 /** F1AP Msg IE **/
  97 typedef struct f1setupRsp
  98 {
  99    uint32_t transId; /* Uniquely identify transaction */
 100    char     cuName[CU_DU_NAME_LEN_MAX];   /* CU Name */
 101    F1RrcVersion    rrcVersion;  /* RRC version */
 102 }F1SetupRsp;
 103
 104 typedef struct f1DlRrcMsg
 105 {
 106    uint32_t gnbDuUeF1apId;
 107    uint32_t gnbCuUeF1apId;
 108    uint8_t  srbId;
 109    bool     execDup;
 110    bool     deliveryStatRpt;
 111    uint16_t rrcMsgSize;
 112    uint8_t  *rrcMsgPdu;
 113 }F1DlRrcMsg;
 114
 115 typedef struct gtpTnlCfg
 116 {
 117    uint32_t ulTnlAddress;  /* remote Address */
 118    uint32_t dlTnlAddress;  /* local Address */
 119    uint32_t teId;
 120 }GtpTnlCfg;
 121
 122 typedef struct upTnlCfg
 123 {
 124    ConfigType configType;
 125    uint8_t cellId;
 126    uint8_t ueId;
 127    uint8_t drbId;
 128    GtpTnlCfg *tnlCfg1; /* Tunnel 1 */
 129    GtpTnlCfg *tnlCfg2; /* Tunnel 2 */
 130 }UpTnlCfg;
 131
 132 #ifdef NR_DRX
 133 /* This structures is taken from the DRX Cycle section of
 134  * specification 33.473. */
 135 typedef struct drxCycle
 136 {
 137    uint16_t drxLongCycleLength;
 138    bool     shortDrxCyclePres;
 139    ShortDrx shortDrxCycle;
 140 }DrxCycle;
 141 #endif
 142
 143 typedef struct duUeCfg
 144 {
 145    void *cellGrpCfg;
 146    void *ueNrCapability;
 147    uint8_t numRlcLcs;        /* Rlc Ue Cfg */
 148    RlcBearerCfg rlcLcCfg[MAX_NUM_LC];
 149    uint8_t numMacLcs;        /* Mac Ue Cfg */
 150    LcCfg   macLcCfg[MAX_NUM_LC];
 151    AmbrCfg *ambrCfg;
 152    uint8_t numDrb;
 153    UpTnlCfg upTnlInfo[MAX_NUM_DRB];  /* User plane TNL Info*/
 154    uint8_t numDrbSetupMod;        /*No. of DRB Added during Modification*/
 155    MacUeCfg copyOfmacUeCfg;
 156    DataTransmissionAction dataTransmissionAction;
 157 #ifdef NR_DRX
 158    bool     drxCyclePres;
 159    DrxCycle drxCycle;
 160    bool     drxConfigIndicatorRelease;
 161 #endif
 162 }DuUeCfg;
 163
 164 typedef struct f1UeContextSetup
 165 {
 166    UeCtxtActionType actionType;
 167    uint8_t cellIdx;
 168    DuUeCfg  duUeCfg;
 169    bool     dlRrcMsgPres;
 170    F1DlRrcMsg  *dlRrcMsg;
 171 }F1UeContextSetupDb;
 172
 173 typedef struct cellCfgParams
 174 {
 175    NrEcgi      nrEcgi;         /* ECGI */
 176    uint16_t    nrPci;          /* PCI */
 177    uint16_t    fiveGsTac;         /* 5gSTac */
 178    Plmn        plmn[MAX_PLMN]; /* List of serving PLMN IDs */
 179    uint32_t    maxUe;          /* max UE per slot */
 180 }CellCfgParams;
 181
 182 typedef struct duUeCb
 183 {
 184    F1UeContextSetupDb *f1UeDb;
 185    uint16_t crnti;
 186    uint32_t gnbDuUeF1apId;   /* GNB DU UE F1AP ID */
 187    uint32_t gnbCuUeF1apId;   /* GNB CU UE F1AP ID */
 188    uint32_t drbBitMap;       /* Drb Bit Map */
 189    UeState  ueState;         /* UE Active/ Ue Inactive state */
 190    MacCfraResource cfraResource; /* CF-RA resource assigned by MAC/SCH */
 191    MacUeCfg macUeCfg;        /* Mac Ue Cfg */
 192    RlcUeCfg rlcUeCfg;        /* Rlc Ue Cfg */
 193 }DuUeCb;
 194
 195 typedef struct  slotInfo
 196 {
 197    uint16_t sfn;
 198    uint16_t slot;
 199 }SlotInfo;
 200
 201 typedef struct pagingMsg
 202 {
 203    /*Note: Paging UEID is extracted from 5gSTMSI as per Spec 38.304, Sec 7.1.
 204     *This is not same as DU-UE_F1AP_ID or CU_UE_F1AP_ID*/
 205    uint16_t  pagUeId;              /* UE Identifier from CU*/
 206
 207    /*TODO: When RAN Inititated Paging will be supported then I-RNTI will be
 208     * added as a choice for UE Identity along with S-TMSI*/
 209    uint64_t  sTmsi;             /* UE Paging Identity: S-TMSI */
 210    bool      pagingDrxPres;     /* flag to indicate paging drx present or not */
 211    uint16_t  pagingDrx;         /* UE specific paging drx */
 212    uint8_t   pagPriority;       /* Paging priority */
 213    uint16_t  pagingFrame;       /* paging frame */
 214    uint16_t  pagingFrameOffset; /* paging offset */
 215    uint8_t   i_s;               /* Index points to PO from the sub-frame pattern */
 216    uint16_t  T;                 /* T is DRX cycle of the UE */
 217 }DuPagingMsg;
 218
 219 typedef struct duPagUeRecord
 220 {
 221    uint16_t  pagUeId;           /*UEID calculated from 5gsTMSI as per Spec 38.304*/
 222    uint64_t  sTmsi;             /* UE Paging Identity: S-TMSI */
 223 }DuPagUeRecord;
 224
 225 typedef struct duPagInfo
 226 {
 227    uint8_t      i_s;          /*Index of PO*/
 228    CmLListCp    pagUeList;    /*List of UEs to be paged in this Paging Frame/Paging Occ*/
 229 }DuPagUeList;
 230
 231 typedef struct duPagInfoMap
 232 {
 233    uint16_t    pf;             /* Paging Frame*/
 234    CmLListCp   pagInfoList;    /* Master List of Paging Identified by PF and i_s*/
 235 }DuPagInfoList;
 236
 237 typedef struct duCellCb
 238 {
 239    uint16_t       cellId;                 /* Internal cell Id */
 240    CellCfgParams  cellInfo;               /* Cell info */
 241    /* pointer to store the address of macCellCfg params used to send du-app to MAC */
 242    MacCellCfg     *duMacCellCfg;
 243    CellStatus     cellStatus;             /* Cell status */
 244    uint32_t       numActvUes;             /* Total Active UEs */
 245    DuUeCb         ueCb[MAX_NUM_UE];       /* Stores UE context */
 246    SlotInfo       currSlotInfo;
 247    DuPagingMsg    tmpPagingInfoOfUe;      /* UE paging information */
 248    CmHashListCp   pagingInfoMap;          /*Paging Map between PF and PagingInfoList*/
 249 }DuCellCb;
 250
 251 typedef struct duLSapCb
 252 {
 253    Pst pst;
 254    SuId        suId;
 255    SpId        spId;
 256    State       sapState;
 257    Mem         mem;
 258    CmTimer     timer;
 259    uint8_t     bndRetryCnt;
 260    uint8_t     maxBndRetry;
 261    TmrCfg      bndTmr;
 262 }DuLSapCb;
 263
 264 typedef struct ueCcchCtxt
 265 {
 266    uint32_t gnbDuUeF1apId; /* GNB DU UE F1AP ID */
 267    uint16_t crnti;         /* CRNTI */
 268    uint16_t cellId;        /* Cell Id */
 269 }UeCcchCtxt;
 270
 271 /* This structure is added to store the information about the F1AP pdu and
 272  * transId so that It can be used in future */
 273 typedef struct reservedF1apPduInfo
 274 {
 275    uint8_t transId;               /* trans Id */
 276    void *f1apMsg;              /* msg structure */
 277 }ReservedF1apPduInfo;
 278
 279 /* DU APP DB */
 280 typedef struct duCb
 281 {
 282    Mem           mem;                       /* Memory configs */
 283    TskInit       init;                      /* DU Init */
 284    bool          f1Status;                  /* Status of F1 connection */
 285    bool          e2Status;                  /* Status of E2 connection */
 286    uint8_t       numCfgCells;               /* number of configured cells */
 287    DuCellCb*     cfgCellLst[MAX_NUM_CELL];  /* List of cells at DU APP of type DuCellCb */
 288    uint8_t       numActvCells;              /* Number of active cells */
 289    DuCellCb*     actvCellLst[MAX_NUM_CELL]; /* List of cells activated/to be activated of type DuCellCb */
 290    uint32_t      gnbDuUeF1apIdGenerator;    /* Generating Du Ue F1ap Id */
 291    uint32_t      numUe;                     /* current number of UEs */
 292    UeCcchCtxt    ueCcchCtxt[MAX_NUM_UE];    /* mapping of gnbDuUeF1apId to CRNTI required for CCCH processing*/
 293    uint8_t       numTeId;                   /* current number of TEIDs configured in the system*/
 294    UpTnlCfg*     upTnlCfg[MAX_TEID];        /* tunnel info for every Drb */
 295    CmLListCp     reservedF1apPduList;       /*storing F1AP pdu infomation and transId */
 296    SliceCfgState sliceState;
 297    F1SetupMsg    f1SetupReqAndRspMsg;
 298 }DuCb;
 299
 300
 301 typedef struct duLSapCfg
 302 {
 303    SuId        suId;
 304    SpId        spId;
 305    Ent         srcEnt;
 306    Inst        srcInst;
 307    ProcId      dstProcId;
 308    Ent         dstEnt;
 309    Inst        dstInst;
 310    Priority    dstPrior;
 311    Route       dstRoute;
 312    Selector    dstSel;
 313    Mem         mem;
 314    uint8_t          maxBndRetry;
 315    TmrCfg      bndTmr;
 316    TmrCfg      connTmr;
 317 }DuLSapCfg;
 318
 319 /* global variables */
 320 DuCb duCb;
 321 //DuCfgParams duCfgParam;
 322
 323 /* DU Cell Functions */
 324 uint8_t duActvInit(Ent entity, Inst inst, Region region, Reason reason);
 325 uint8_t duActvTsk(Pst *pst, Buffer *mBuf);
 326 uint8_t duSendRlcUlCfg();
 327 uint8_t duSendRlcDlCfg();
 328 uint8_t duBuildRlcCfg(Inst inst);
 329 uint8_t duBuildRlcLsapCfg(Ent ent, Inst inst, uint8_t lsapInst);
 330 uint8_t duBuildRlcUsapCfg(uint8_t elemId, Ent ent, Inst inst);
 331 uint8_t DuHdlRlcCfgComplete(Pst *pst, RlcMngmt *cfm);
 332 uint8_t duHdlRlcCntrlCfgComplete(Pst *pst, RlcMngmt *cfm);
 333 uint8_t duProcRlcUlCfgComplete(Pst *pst, RlcMngmt *cfm);
 334 uint8_t duProcRlcDlCfgComplete(Pst *pst, RlcMngmt *cfm);
 335 uint8_t duSendMacCfg();
 336 uint8_t duBuildMacGenCfg();
 337 uint8_t duBuildMacUsapCfg(SpId sapId);
 338 uint8_t duHdlMacCfgComplete(Pst *pst, RgMngmt *cfm);
 339 uint8_t duBindUnbindRlcToMacSap(uint8_t inst, uint8_t action);
 340 uint8_t duProcCfgComplete();
 341 uint8_t duSendSchCfg();
 342 uint8_t duSctpStartReq();
 343 uint8_t duSctpNtfyHdl(Buffer *mBuf, CmInetSctpNotification *ntfy);
 344
 345 uint8_t duBuildEgtpCfgReq();
 346 uint8_t duHdlEgtpCfgComplete(CmStatus cfm);
 347 uint8_t duSendEgtpSrvOpenReq();
 348 uint8_t duHdlEgtpSrvOpenComplete(CmStatus cfm);
 349 uint8_t duSendEgtpTnlMgmtReq(uint8_t action, uint32_t teIdMod, GtpTnlCfg *tnlInfo);
 350 uint8_t duSendEgtpDatInd(Buffer *mBuf);
 351 uint8_t duHdlSchCfgComplete(Pst *pst, RgMngmt *cfm);
 352 uint8_t duBuildAndSendMacCellStart();
 353 uint8_t duBuildAndSendMacCellStop(uint16_t cellId);
 354
 355 #endif
 356
 357 /**********************************************************************
 358   End of file
 359  **********************************************************************/