Merge "Implementation of Slice related configuration and Slice Discovery procedure...
[o-du/l2.git] / src / cu_stub / cu_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 __CU_MGR_MAIN_H__
20 #define __CU_MGR_MAIN_H__
21
22 #define MAX_IPV6_LEN 16
23 #define CU_DU_NAME_LEN_MAX 30      /* Max length of CU/DU name string */
24
25 #define CU_APP_MEM_REG 1
26 #define CU_POOL 1
27 #define MAX_DU_PORT 2
28 #define DU_PORT 38472
29 #define SD_SIZE   3 /*  As per the spec 38.473, SD size must be of size(3) */
30 #define MAX_NUM_OF_SLICE 1024 /* As per the spec 38.473, maxnoofSliceItems = 1024*/
31
32 /*VALID Tunnel ID*/
33 #define MIN_TEID 1   /*[Spec 29.281,Sec 5.1]: All Zero TEIDs are never assigned for setting up GTP-U Tunnel*/
34 #define MAX_TEID 10 /*[Spec 29.281]: Max limit is not mentioned but as per GTP-U Header Format, TEID occupies 4 octets */
35 /* allocate and zero out a static buffer */
36
37 #define CU_ALLOC(_datPtr, _size)                             \
38 {                                                            \
39    S16 _ret;                                                 \
40    _ret = SGetSBuf(CU_APP_MEM_REG, CU_POOL,                  \
41                      (Data **)&_datPtr, _size);              \
42    if(_ret == ROK)                                           \
43       memset(_datPtr, 0, _size);                      \
44    else                                                      \
45       _datPtr = NULLP;                                       \
46 }
47  
48 /* free a static buffer */
49 #define CU_FREE(_datPtr, _size)                              \
50    if(_datPtr)                                               \
51    SPutSBuf(CU_APP_MEM_REG, CU_POOL,                         \
52          (Data *)_datPtr, _size);
53
54
55 typedef struct ipAddr
56 {
57  Bool      ipV4Pres;
58  uint32_t  ipV4Addr;
59  Bool      ipV6Pres;
60  uint8_t   ipV6Addr[MAX_IPV6_LEN];
61 }SctpIpAddr;
62
63 typedef struct RrcVersion
64 {
65   uint8_t    rrcVer;     /* Latest RRC Version */
66   uint32_t   extRrcVer;  /* Latest RRC version extended */
67 }RrcVersion;
68
69 typedef struct egtpParams
70 {
71    SctpIpAddr  localIp;
72    uint16_t    localPort;
73    SctpIpAddr  destIp;
74    uint16_t    destPort;
75    uint32_t    currTunnelId;
76    uint32_t    minTunnelId;
77    uint32_t    maxTunnelId;
78 }EgtpParams;
79
80 typedef struct CuSctpParams
81 {
82    SctpIpAddr  duIpAddr;
83    uint16_t    duPort;
84    SctpIpAddr  cuIpAddr;
85    uint16_t    cuPort;
86 }CuSctpParams;
87
88 /* Single Network Slice Selection assistance Info */
89 typedef struct snssai
90 {
91    uint8_t sst;                /* Slice Type */
92    uint8_t sd[SD_SIZE];        /* Slice Differentiator */
93 }Snssai;
94
95 typedef struct cuCfgParams
96 {
97    uint32_t         cuId;
98    char             cuName[CU_DU_NAME_LEN_MAX];
99    CuSctpParams     sctpParams;
100    Plmn             plmn;
101    EgtpParams       egtpParams;
102    RrcVersion       rrcVersion;
103    uint8_t          numSnssaiSupported;
104    Snssai           *snssaiList[MAX_NUM_OF_SLICE];
105 }CuCfgParams;
106 CuCfgParams cuCfgParams; //global variable to hold all configs
107
108 void readCuCfg();
109 void cuAppInmsgHdlr(Buffer *mBuf);
110 void sctpNtfyInd(CmInetSctpNotification *ntfy);
111 uint8_t egtpInitReq();
112 void *cuConsoleHandler(void *);
113
114 #endif
115
116 /**********************************************************************
117          End of file
118 **********************************************************************/