[Epic-ID: ODUHIGH-405][Task-ID: ODUHIGH-414] Support at CU and RIC stub for SCTP...
[o-du/l2.git] / src / ric_stub / ric_stub_sctp.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 all SCTP related functionality */
20
21 #ifndef __RIC_SCTP_H__
22 #define __RIC_SCTP_H__
23
24 #define MAX_RETRY 5
25 #define MAX_IPV6_LEN 16
26 #define MAX_DU_SUPPORTED 1 
27
28 /* Global variable declaration */
29 uint8_t   socket_type;      /* Socket type */
30   
31 typedef struct
32 {
33    uint16_t           numFd;
34    uint16_t           port;   
35    uint32_t           flag;
36    Buffer            *mBuf;
37    MsgLen             bufLen; 
38    CmInetNetAddr      addr;
39    CmInetFdSet        readFd;
40    CmInetSctpSndRcvInfo   info;
41    CmInetSctpNotification ntfy;
42 }sctpSockPollParams;
43
44 typedef struct
45 {
46    uint16_t              destPort;         /* DU PORTS */
47    uint16_t              srcPort;
48    bool                  bReadFdSet;
49    CmInetFd              sockFd;           /* Socket file descriptor */
50    CmInetAddr            peerAddr;
51    CmInetFd              lstnSockFd;       /* Listening Socket file descriptor */
52    CmInetNetAddrLst      destAddrLst;      /* DU Ip address */
53    CmInetNetAddrLst      localAddrLst;
54    CmInetNetAddr         destIpNetAddr;    /* DU Ip address */ 
55    Bool                  connUp;
56 }RicSctpDestCb;
57
58 typedef struct ipAddr
59 {
60  bool ipV4Pres;
61  uint32_t  ipV4Addr;
62  bool ipV6Pres;
63  uint8_t   ipV6Addr[MAX_IPV6_LEN];
64 }SctpIpAddr;
65
66 typedef struct sctpAssocInfo
67 {
68    SctpIpAddr  duIpAddr;
69    uint16_t    duPort;
70    SctpIpAddr  ricIpAddr;
71    uint16_t    ricPort;
72 }SctpAssocInfo;
73
74 typedef struct ricSctpParams
75 {
76    uint8_t        numDu;
77    SctpAssocInfo  sctpAssoc[MAX_DU_SUPPORTED];
78 }RicSctpParams;
79
80 typedef struct sctpGlobalCb
81 {
82    RicSctpParams sctpCfg;
83    uint8_t      numDu;
84    RicSctpDestCb destCb[MAX_DU_SUPPORTED]; 
85 }SctpGlobalCb;
86
87 SctpGlobalCb sctpCb;
88
89 uint8_t sctpActvInit();
90 uint8_t sctpSend(Buffer *mBuf);
91 uint8_t sctpCfgReq();
92 uint8_t sctpStartReq();
93 uint8_t sctpSetSockOpts(CmInetFd *sock_Fd);
94 uint8_t sctpAccept(RicSctpDestCb *destCb);
95 uint8_t sctpSockPoll();
96 uint8_t processPolling(sctpSockPollParams *pollParams, RicSctpDestCb *destCb, uint32_t *timeoutPtr, CmInetMemInfo *memInfo);
97 uint8_t fillAddrLst(CmInetNetAddrLst *addrLstPtr, SctpIpAddr *ipAddr);
98 uint8_t fillDestNetAddr(CmInetNetAddr *destAddrPtr, SctpIpAddr *dstIpPtr);
99
100 #endif
101
102 /**********************************************************************
103          End of file
104  **********************************************************************/