slnetsock.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017-2018, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/*****************************************************************************/
/* Include files                                                             */
/*****************************************************************************/

#ifndef __SL_NET_SOCK_H__
#define __SL_NET_SOCK_H__

#include <stdint.h>

#ifdef    __cplusplus
extern "C" {
#endif


/*****************************************************************************/
/* Macro declarations                                                        */
/*****************************************************************************/

#define SLNETSOCK_MAX_CONCURRENT_SOCKETS                                    (32)  
/* Address families.  */
#define SLNETSOCK_AF_UNSPEC                                                 (0)   
#define SLNETSOCK_AF_INET                                                   (2)   
#define SLNETSOCK_AF_INET6                                                  (3)   
#define SLNETSOCK_AF_RF                                                     (6)   
#define SLNETSOCK_AF_PACKET                                                 (17)  
/* Protocol families, same as address families. */
#define SLNETSOCK_PF_UNSPEC                                                 SLNETSOCK_AF_UNSPEC
#define SLNETSOCK_PF_INET                                                   SLNETSOCK_AF_INET
#define SLNETSOCK_PF_INET6                                                  SLNETSOCK_AF_INET6

/* Define argument types specifies the socket type.  */
#define SLNETSOCK_SOCK_STREAM                                               (1)   
#define SLNETSOCK_SOCK_DGRAM                                                (2)   
#define SLNETSOCK_SOCK_RAW                                                  (3)   
#define SLNETSOCK_SOCK_RX_MTR                                               (4)   
#define SLNETSOCK_SOCK_MAC_WITH_CCA                                         (5)
#define SLNETSOCK_SOCK_MAC_WITH_NO_CCA                                      (6)
#define SLNETSOCK_SOCK_BRIDGE                                               (7)
#define SLNETSOCK_SOCK_ROUTER                                               (8)

/* Define some BSD protocol constants.  */
#define SLNETSOCK_PROTO_TCP                                                 (6)   
#define SLNETSOCK_PROTO_UDP                                                 (17)  
#define SLNETSOCK_PROTO_RAW                                                 (255) 
#define SLNETSOCK_PROTO_SECURE                                              (100) 
/* bind any addresses */
#define SLNETSOCK_INADDR_ANY                                                (0)
#define SLNETSOCK_IN6ADDR_ANY                                               (0)


/* socket options */

/* possible values for the level parameter in slNetSock_setOpt / slNetSock_getOpt */
#define SLNETSOCK_LVL_SOCKET                                                (1)   
#define SLNETSOCK_LVL_IP                                                    (2)   
#define SLNETSOCK_LVL_PHY                                                   (3)   
/* possible values for the option parameter in slNetSock_setOpt / slNetSock_getOpt */

/* socket level options (SLNETSOCK_LVL_SOCKET) */
#define SLNETSOCK_OPSOCK_RCV_BUF                                            (8)   
#define SLNETSOCK_OPSOCK_RCV_TIMEO                                          (20)  
#define SLNETSOCK_OPSOCK_KEEPALIVE                                          (9)   
#define SLNETSOCK_OPSOCK_KEEPALIVE_TIME                                     (37)  
#define SLNETSOCK_OPSOCK_LINGER                                             (13)  
#define SLNETSOCK_OPSOCK_NON_BLOCKING                                       (24)  
#define SLNETSOCK_OPSOCK_NON_IP_BOUNDARY                                    (39)  
#define SLNETSOCK_OPSOCK_ERROR                                              (58)  
#define SLNETSOCK_OPSOCK_SLNETSOCKSD                                        (59)  
#define SLNETSOCK_OPSOCK_BROADCAST                                          (200) 
/* IP level options (SLNETSOCK_LVL_IP) */
#define SLNETSOCK_OPIP_MULTICAST_TTL                                        (61)  
#define SLNETSOCK_OPIP_ADD_MEMBERSHIP                                       (65)  
#define SLNETSOCK_OPIP_DROP_MEMBERSHIP                                      (66)  
#define SLNETSOCK_OPIP_HDRINCL                                              (67)  
#define SLNETSOCK_OPIP_RAW_RX_NO_HEADER                                     (68)  
#define SLNETSOCK_OPIP_RAW_IPV6_HDRINCL                                     (69)  
#define SLNETSOCK_OPIPV6_ADD_MEMBERSHIP                                     (70)  
#define SLNETSOCK_OPIPV6_DROP_MEMBERSHIP                                    (71)  
#define SLNETSOCK_OPIPV6_MULTICAST_HOPS                                     (72)  
/* PHY level options (SLNETSOCK_LVL_PHY) */
#define SLNETSOCK_OPPHY_CHANNEL                                             (28)  
#define SLNETSOCK_OPPHY_RATE                                                (100) 
#define SLNETSOCK_OPPHY_TX_POWER                                            (101) 
#define SLNETSOCK_OPPHY_NUM_FRAMES_TO_TX                                    (102) 
#define SLNETSOCK_OPPHY_PREAMBLE                                            (103) 
#define SLNETSOCK_OPPHY_TX_INHIBIT_THRESHOLD                                (104) 
#define SLNETSOCK_OPPHY_TX_TIMEOUT                                          (105) 
#define SLNETSOCK_OPPHY_ALLOW_ACKS                                          (106) 
/* TCP level options (SLNETSOCK_PROTO_TCP) */
#define SLNETSOCK_TCP_NODELAY                                               (203) 
#define SLNETSOCK_TCP_MAXSEG                                                (204) 
#define SLNETSOCK_TCP_NOPUSH                                                (205) 
#define SLNETSOCK_TCP_NOOPT                                                 (206) 
#define SLNETSOCK_TCP_SACKPERMITTED                                         (207) 
#define SLNETSOCK_TCP_MAXRTT                                                (208) 
typedef enum
{
    SLNETSOCK_TX_INHIBIT_THRESHOLD_MIN     = 1,
    SLNETSOCK_TX_INHIBIT_THRESHOLD_LOW     = 2,
    SLNETSOCK_TX_INHIBIT_THRESHOLD_DEFAULT = 3,
    SLNETSOCK_TX_INHIBIT_THRESHOLD_MED     = 4,
    SLNETSOCK_TX_INHIBIT_THRESHOLD_HIGH    = 5,
    SLNETSOCK_TX_INHIBIT_THRESHOLD_MAX     = 6
} SlNetSockTxInhibitThreshold_e;

typedef enum
{
     SLNETSOCK_SEC_ATTRIB_PRIVATE_KEY               = 0,
     SLNETSOCK_SEC_ATTRIB_LOCAL_CERT                = 1,
     SLNETSOCK_SEC_ATTRIB_PEER_ROOT_CA              = 2,
     SLNETSOCK_SEC_ATTRIB_DH_KEY                    = 3,
     SLNETSOCK_SEC_ATTRIB_METHOD                    = 4,
     SLNETSOCK_SEC_ATTRIB_CIPHERS                   = 5,
     SLNETSOCK_SEC_ATTRIB_ALPN                      = 6,
     SLNETSOCK_SEC_ATTRIB_EXT_CLIENT_CHLNG_RESP     = 7,
     SLNETSOCK_SEC_ATTRIB_DOMAIN_NAME               = 8,

     SLNETSOCK_SEC_ATTRIB_DISABLE_CERT_STORE = 9
} SlNetSockSecAttrib_e;

/* available values for SLNETSOCK_SEC_ATTRIB_METHOD */
#define SLNETSOCK_SEC_METHOD_SSLV3                                          (0)   
#define SLNETSOCK_SEC_METHOD_TLSV1                                          (1)   
#define SLNETSOCK_SEC_METHOD_TLSV1_1                                        (2)   
#define SLNETSOCK_SEC_METHOD_TLSV1_2                                        (3)   
#define SLNETSOCK_SEC_METHOD_SSLv3_TLSV1_2                                  (4)   
#define SLNETSOCK_SEC_METHOD_DLSV1                                          (5)   
/* available values for SLNETSOCK_SEC_ATTRIB_CIPHERS. The value is bitmap! */
#define SLNETSOCK_SEC_CIPHER_SSL_RSA_WITH_RC4_128_SHA                       (1 << 0)
#define SLNETSOCK_SEC_CIPHER_SSL_RSA_WITH_RC4_128_MD5                       (1 << 1)
#define SLNETSOCK_SEC_CIPHER_TLS_RSA_WITH_AES_256_CBC_SHA                   (1 << 2)
#define SLNETSOCK_SEC_CIPHER_TLS_DHE_RSA_WITH_AES_256_CBC_SHA               (1 << 3)
#define SLNETSOCK_SEC_CIPHER_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA             (1 << 4)
#define SLNETSOCK_SEC_CIPHER_TLS_ECDHE_RSA_WITH_RC4_128_SHA                 (1 << 5)
#define SLNETSOCK_SEC_CIPHER_TLS_RSA_WITH_AES_128_CBC_SHA256                (1 << 6)
#define SLNETSOCK_SEC_CIPHER_TLS_RSA_WITH_AES_256_CBC_SHA256                (1 << 7)
#define SLNETSOCK_SEC_CIPHER_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256          (1 << 8)
#define SLNETSOCK_SEC_CIPHER_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256        (1 << 9)
#define SLNETSOCK_SEC_CIPHER_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA           (1 << 10)
#define SLNETSOCK_SEC_CIPHER_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA           (1 << 11)
#define SLNETSOCK_SEC_CIPHER_TLS_RSA_WITH_AES_128_GCM_SHA256                (1 << 12)
#define SLNETSOCK_SEC_CIPHER_TLS_RSA_WITH_AES_256_GCM_SHA384                (1 << 13)
#define SLNETSOCK_SEC_CIPHER_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256            (1 << 14)
#define SLNETSOCK_SEC_CIPHER_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384            (1 << 15)
#define SLNETSOCK_SEC_CIPHER_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256          (1 << 16)
#define SLNETSOCK_SEC_CIPHER_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384          (1 << 17)
#define SLNETSOCK_SEC_CIPHER_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256        (1 << 18)
#define SLNETSOCK_SEC_CIPHER_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384        (1 << 19)
#define SLNETSOCK_SEC_CIPHER_TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256  (1 << 20)
#define SLNETSOCK_SEC_CIPHER_TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256    (1 << 21)
#define SLNETSOCK_SEC_CIPHER_TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256      (1 << 22)
#define SLNETSOCK_SEC_CIPHER_FULL_LIST                                      (0xFFFFFFFF)

/* available values for SLNETSOCK_SEC_ATTRIB_ALPN */
#define SLNETSOCK_SEC_ALPN_H1                                               (1 << 0)
#define SLNETSOCK_SEC_ALPN_H2                                               (1 << 1)
#define SLNETSOCK_SEC_ALPN_H2C                                              (1 << 2)
#define SLNETSOCK_SEC_ALPN_H2_14                                            (1 << 3)
#define SLNETSOCK_SEC_ALPN_H2_16                                            (1 << 4)
#define SLNETSOCK_SEC_ALPN_FULL_LIST                                        ((SLNETSOCK_SEC_ALPN_H2_16 << 1 ) - 1)

/* available values for the flags of the SlNetSock_startSec function */
#define SLNETSOCK_SEC_START_SECURITY_SESSION_ONLY                           (1 << 0) 
#define SLNETSOCK_SEC_BIND_CONTEXT_ONLY                                     (1 << 1) 
#define SLNETSOCK_SEC_IS_SERVER                                             (1 << 2) 
/* available values for the flags of the SlNetSock_create function */

#define SLNETSOCK_CREATE_IF_STATE_ENABLE                                    (1 << 0) 
#define SLNETSOCK_CREATE_IF_STATUS_CONNECTED                                (1 << 1) 
#define SLNETSOCK_CREATE_ALLOW_PARTIAL_MATCH                                (1 << 2) 
/* Definitions for shutting down some or all parts of a full duplex connection */
#define SLNETSOCK_SHUT_RD                                                   (0) 
#define SLNETSOCK_SHUT_WR                                                   (1) 
#define SLNETSOCK_SHUT_RDWR                                                 (2) 
/* Length of address string representation  */
#define SLNETSOCK_INET6_ADDRSTRLEN                                          (46)
#define SLNETSOCK_INET_ADDRSTRLEN                                           (16)

/* flags used in send/recv and friends.
 *
 * Note these flags must not exceed 24-bits.  The implementation will
 * OR the 8-bits of security flags into the remaining high 8 bits of
 * 32-bit flag variables.
 */
#define SLNETSOCK_MSG_OOB         (0x0001)
#define SLNETSOCK_MSG_PEEK        (0x0002)
#define SLNETSOCK_MSG_WAITALL     (0x0004)
#define SLNETSOCK_MSG_DONTWAIT    (0x0008)
#define SLNETSOCK_MSG_DONTROUTE   (0x0010)
#define SLNETSOCK_MSG_NOSIGNAL    (0x0020)


/*****************************************************************************/
/* Structure/Enum declarations                                               */
/*****************************************************************************/

typedef struct SlNetSock_InAddr_t
{
#ifndef s_addr
    uint32_t s_addr;  /* Internet address 32 bits */
#else

    union S_un
    {
        uint32_t S_addr;
        struct
        {
            uint8_t s_b1,s_b2,s_b3,s_b4;
        } S_un_b;
        struct
        {
            uint16_t s_w1,s_w2;
        } S_un_w;
    } S_un;
#endif
} SlNetSock_InAddr_t;

typedef struct SlNetSock_In6Addr_t
{
    union
    {
        uint8_t  _S6_u8[16];
        uint16_t _S6_u16[8];
        uint32_t _S6_u32[4];
    } _S6_un;
} SlNetSock_In6Addr_t;

typedef struct SlNetSock_NoDelay_t
{
    uint32_t noDelayEnabled;      
} SlNetSock_NoDelay_t;

typedef struct SlNetSock_MaxSeg_t
{
    uint32_t maxSeg;               
} SlNetSock_MaxSeg_t;

typedef struct SlNetSock_NoPush_t
{
    uint32_t noPushEnabled;      
} SlNetSock_NoPush_t;

typedef struct SlNetSock_NoOpt_t
{
    uint32_t noOptEnabled;      
} SlNetSock_NoOpt_t;

typedef struct SlNetSock_SackPermitted_t
{
    uint32_t sackPermittedEnabled;      
} SlNetSock_SackPermitted_t;

typedef struct SlNetSock_MaxRtt_t
{
    uint32_t maxRtt;               
} SlNetSock_MaxRtt_t;

typedef struct SlNetSock_Keepalive_t
{
    uint32_t keepaliveEnabled;      
} SlNetSock_Keepalive_t;

typedef struct SlNetSock_NonIpBoundary_t
{
    int32_t nonIpBoundaryEnabled;   
} SlNetSock_NonIpBoundary_t;

typedef struct SlNetSock_Winsize_t
{
    uint32_t winSize;               
} SlNetSock_Winsize_t;

typedef struct SlNetSock_Nonblocking_t
{
    uint32_t nonBlockingEnabled;    
} SlNetSock_Nonblocking_t;

typedef struct SlNetSock_Broadcast_t
{
    uint32_t broadcastEnabled;    
} SlNetSock_Broadcast_t;

typedef struct SlNetSock_SecAttribNode_t
{
    SlNetSockSecAttrib_e              attribName;    
    uint8_t                          *attribBuff;    
    uint16_t                          attribBuffLen; 
    struct SlNetSock_SecAttribNode_t *next;
} SlNetSock_SecAttribNode_t;

typedef SlNetSock_SecAttribNode_t * SlNetSockSecAttrib_t;

typedef struct SlNetSock_SecureALPN_t
{
    uint32_t secureALPN;
} SlNetSock_SecureALPN_t;

typedef struct SlNetSock_SecureMask_t
{
    uint32_t secureMask;
} SlNetSock_SecureMask_t;

typedef struct SlNetSock_SecureMethod_t
{
    uint8_t secureMethod;
} SlNetSock_SecureMethod_t;

typedef struct SlNetSock_IpMreq_t
{
    SlNetSock_InAddr_t imr_multiaddr;     
    uint32_t           imr_interface;     
} SlNetSock_IpMreq_t;

typedef struct SlNetSock_IpV6Mreq_t
{
    SlNetSock_In6Addr_t ipv6mr_multiaddr; 
    uint32_t            ipv6mr_interface; 
} SlNetSock_IpV6Mreq_t;

typedef struct SlNetSock_linger_t
{
    uint32_t l_onoff;                    
    uint32_t l_linger;                   
} SlNetSock_linger_t;

typedef int32_t SlNetSockTime_t;
typedef int32_t SlNetSockuseconds_t;

typedef struct SlNetSock_Timeval_t
{
    SlNetSockTime_t      tv_sec;         
    SlNetSockuseconds_t  tv_usec;        
} SlNetSock_Timeval_t;

typedef uint16_t SlNetSocklen_t;

typedef struct SlNetSock_Addr_t
{
    uint16_t sa_family;                  
    uint8_t  sa_data[14];                
} SlNetSock_Addr_t;

typedef struct SlNetSock_AddrIn6_t
{
    uint16_t            sin6_family;     
    uint16_t            sin6_port;       
    uint32_t            sin6_flowinfo;   
    SlNetSock_In6Addr_t sin6_addr;       
    uint32_t            sin6_scope_id;   
} SlNetSock_AddrIn6_t;

typedef struct SlNetSock_AddrIn_t
{
    uint16_t           sin_family;       
    uint16_t           sin_port;         
    SlNetSock_InAddr_t sin_addr;         
    int8_t             sin_zero[8];      
} SlNetSock_AddrIn_t;

/* ss_family + pad must be large enough to hold max of
 * _SlNetSock_AddrIn6_t or _SlNetSock_AddrIn_t
 */
typedef struct SlNetSock_SockAddrStorage_t
{
    uint16_t ss_family;
    uint8_t  pad[26];
} SlNetSock_SockAddrStorage_t;

typedef struct SlNetSock_SdSet_t         
{
    uint32_t sdSetBitmap[(SLNETSOCK_MAX_CONCURRENT_SOCKETS + (uint8_t)31)/(uint8_t)32]; /* Bitmap of SOCKET Descriptors */
} SlNetSock_SdSet_t;


typedef struct SlNetSock_TransceiverRxOverHead_t
{
    uint8_t  rate;                       
    uint8_t  channel;                    
    int8_t   rssi;                       
    uint8_t  padding;                    
    uint32_t timestamp;                  
} SlNetSock_TransceiverRxOverHead_t;


/*****************************************************************************/
/* Function prototypes                                                       */
/*****************************************************************************/

int32_t SlNetSock_init(int32_t flags);

int16_t SlNetSock_create(int16_t domain, int16_t type, int16_t protocol, uint32_t ifBitmap, int16_t flags);


int32_t SlNetSock_close(int16_t sd);


int32_t SlNetSock_shutdown(int16_t sd, int16_t how);


int16_t SlNetSock_accept(int16_t sd, SlNetSock_Addr_t *addr, SlNetSocklen_t *addrlen);


int32_t SlNetSock_bind(int16_t sd, const SlNetSock_Addr_t *addr, int16_t addrlen);


int32_t SlNetSock_listen(int16_t sd, int16_t backlog);


int32_t SlNetSock_connect(int16_t sd, const SlNetSock_Addr_t *addr, SlNetSocklen_t addrlen);

int32_t SlNetSock_getPeerName(int16_t sd, SlNetSock_Addr_t *addr, SlNetSocklen_t *addrlen);


int32_t SlNetSock_getSockName(int16_t sd, SlNetSock_Addr_t *addr, SlNetSocklen_t *addrlen);


int32_t SlNetSock_select(int16_t nsds, SlNetSock_SdSet_t *readsds, SlNetSock_SdSet_t *writesds, SlNetSock_SdSet_t *exceptsds, SlNetSock_Timeval_t *timeout);


int32_t SlNetSock_sdsSet(int16_t sd, SlNetSock_SdSet_t *sdset);


int32_t SlNetSock_sdsClr(int16_t sd, SlNetSock_SdSet_t *sdset);


int32_t SlNetSock_sdsClrAll(SlNetSock_SdSet_t *sdset);


int32_t SlNetSock_sdsIsSet(int16_t sd, SlNetSock_SdSet_t *sdset);


int32_t SlNetSock_setOpt(int16_t sd, int16_t level, int16_t optname, void *optval, SlNetSocklen_t optlen);


int32_t SlNetSock_getOpt(int16_t sd, int16_t level, int16_t optname, void *optval, SlNetSocklen_t *optlen);


int32_t SlNetSock_recv(int16_t sd, void *buf, uint32_t len, uint32_t flags);


int32_t SlNetSock_recvFrom(int16_t sd, void *buf, uint32_t len, uint32_t flags, SlNetSock_Addr_t *from, SlNetSocklen_t *fromlen);


int32_t SlNetSock_send(int16_t sd, const void *buf, uint32_t len, uint32_t flags);


int32_t SlNetSock_sendTo(int16_t sd, const void *buf, uint32_t len, uint32_t flags, const SlNetSock_Addr_t *to, SlNetSocklen_t tolen);


int32_t SlNetSock_getIfID(uint16_t sd);


SlNetSockSecAttrib_t *SlNetSock_secAttribCreate(void);


int32_t SlNetSock_secAttribDelete(SlNetSockSecAttrib_t *secAttrib);


int32_t SlNetSock_secAttribSet(SlNetSockSecAttrib_t *secAttrib, SlNetSockSecAttrib_e attribName, void *val, uint16_t len);


int32_t SlNetSock_startSec(int16_t sd, SlNetSockSecAttrib_t *secAttrib, uint8_t flags);


#ifdef  __cplusplus
}
#endif /* __cplusplus */

#endif /* __NET_SOCK_H__ */