sl_socket.h

/*
 *   Copyright (C) 2016 Texas Instruments Incorporated
 *
 *   All rights reserved. Property of Texas Instruments Incorporated.
 *   Restricted rights to use, duplicate or disclose this code are
 *   granted through contract.
 *
 *   The program may not be used without the written permission of
 *   Texas Instruments Incorporated or against the terms and conditions
 *   stipulated in the agreement under which this program has been supplied,
 *   and under no circumstances can it be used with non-TI connectivity device.
 *   
 */

 
/*****************************************************************************/
/* Include files                                                             */
/*****************************************************************************/
#include <ti/drivers/net/wifi/simplelink.h>

#ifndef __SL_SOCKET_H__
#define __SL_SOCKET_H__


#ifdef    __cplusplus
extern "C" {
#endif

/*****************************************************************************/
/* Macro declarations                                                        */
/*****************************************************************************/
#undef SL_FD_SETSIZE
#define SL_FD_SETSIZE                          SL_MAX_SOCKETS         /* Number of sockets to select on - same is max sockets!               */
#define SL_BSD_SOCKET_ID_MASK                  (0x1F)                 /* Index using the LBS 4 bits for socket id 0-7 */

/* Define some BSD protocol constants.  */
#define SL_SOCK_STREAM                         (1)                       /* TCP Socket                                                          */
#define SL_SOCK_DGRAM                          (2)                       /* UDP Socket                                                          */
#define SL_SOCK_RAW                            (3)                       /* Raw socket                                                          */
#define SL_IPPROTO_TCP                         (6)                       /* TCP Raw Socket                                                      */
#define SL_IPPROTO_UDP                         (17)                      /* UDP Raw Socket                                                      */
#define SL_IPPROTO_RAW                         (255)                     /* Raw Socket                                                          */
#define SL_SEC_SOCKET                          (100)                     /* Secured Socket Layer (SSL,TLS)                                      */

/* Address families.  */
#define     SL_AF_INET                         (2)                       /* IPv4 socket (UDP, TCP, etc)                                          */
#define     SL_AF_INET6                        (3)                       /* IPv6 socket (UDP, TCP, etc)                                          */
#define     SL_AF_RF                           (6)                       /* data include RF parameter, All layer by user (Wifi could be disconnected) */ 
#define     SL_AF_PACKET                       (17)
/* Protocol families, same as address families.  */
#define     SL_PF_INET                         AF_INET
#define     SL_PF_INET6                        AF_INET6
#define     SL_INADDR_ANY                      (0)                       /*  bind any address  */
#define     SL_IN6ADDR_ANY                     (0)


/* Max payload size by protocol */
#define SL_SOCKET_PAYLOAD_TYPE_MASK            (0xF0)  /*4 bits type, 4 bits sockets id */
#define SL_SOCKET_PAYLOAD_TYPE_RAW_TRANCEIVER  (0x80)  /* 1536 bytes */

  
/* SL_SOCKET_EVENT_CLASS_BSD user events */               
#define    SL_SOCKET_TX_FAILED_EVENT              (1) 
#define    SL_SOCKET_ASYNC_EVENT                  (2)


/* SL_SOCKET_EVENT_CLASS_BSD user trigger events */               
#define    SL_SOCKET_TRIGGER_EVENT_SELECT         (1) 

#define SL_SOL_SOCKET          (1)   /* Define the socket option category. */
#define SL_IPPROTO_IP          (2)   /* Define the IP option category.     */
#define SL_SOL_PHY_OPT         (3)   /* Define the PHY option category.    */

#define SL_SO_RCVBUF           (8)   /* Setting TCP receive buffer size */
#define SL_SO_KEEPALIVE        (9)   /* Connections are kept alive with periodic messages */
#define SL_SO_LINGER           (13)  /* Socket lingers on close pending remaining send/receive packets. */
#define SL_SO_RCVTIMEO         (20)  /* Enable receive timeout */
#define SL_SO_NONBLOCKING      (24)  /* Enable . disable nonblocking mode  */
#define SL_SO_SECMETHOD        (25)  /* security metohd */
#define SL_SO_SECURE_MASK      (26)  /* security mask */
#define SL_SO_SECURE_FILES     (27)  /* security files */
#define SL_SO_CHANGE_CHANNEL   (28)  /* This option is available only when transceiver started */
#define SL_SO_SECURE_FILES_PRIVATE_KEY_FILE_NAME (30) /* This option used to configue secure file */
#define SL_SO_SECURE_FILES_CERTIFICATE_FILE_NAME (31) /* This option used to configue secure file */
#define SL_SO_SECURE_FILES_CA_FILE_NAME          (32) /* This option used to configue secure file */
#define SL_SO_SECURE_FILES_PEER_CERT_OR_DH_KEY_FILE_NAME      (33) /* This option used to configue secure file - in server mode DH params file, and in client mode peer cert for domain verification */
#define SL_SO_STARTTLS                           (35)  /* initiate STARTTLS on non secure socket */
#define SL_SO_SSL_CONNECTION_PARAMS              (36)  /* retrieve by getsockopt the connection params of the current SSL connection in to SlSockSSLConnectionParams_t*/
#define SL_SO_KEEPALIVETIME                      (37)  /* keepalive time out  */
#define SL_SO_SECURE_DISABLE_CERTIFICATE_STORE   (38)  /* disable certificate store */
#define SL_SO_RX_NO_IP_BOUNDARY                  (39)  /* connectionless socket disable rx boundary */
#define SL_SO_SECURE_ALPN       (40) /* set the ALPN bitmap list */
#define SL_SO_SECURE_EXT_CLIENT_CHLNG_RESP (41) /*set external challange for client certificate */
#define SL_SO_SECURE_DOMAIN_NAME_VERIFICATION (42) /* set a domain name for verification */

#define SL_IP_MULTICAST_IF      (60) /* Specify outgoing multicast interface */
#define SL_IP_MULTICAST_TTL     (61) /* Specify the TTL value to use for outgoing multicast packet. */
#define SL_IP_ADD_MEMBERSHIP    (65) /* Join IPv4 multicast membership */
#define SL_IP_DROP_MEMBERSHIP   (66) /* Leave IPv4 multicast membership */
#define SL_IP_HDRINCL           (67) /* Raw socket IPv4 header included. */
#define SL_IP_RAW_RX_NO_HEADER  (68) /* Proprietary socket option that does not includeIPv4/IPv6 header (and extension headers) on received raw sockets*/
#define SL_IP_RAW_IPV6_HDRINCL  (69) /* Transmitted buffer over IPv6 socket contains IPv6 header. */
#define SL_IPV6_ADD_MEMBERSHIP  (70) /* Join IPv6 multicast membership */
#define SL_IPV6_DROP_MEMBERSHIP (71) /* Leave IPv6 multicast membership */
#define SL_IPV6_MULTICAST_HOPS  (72) /* Specify the hops value to use for outgoing multicast packet. */

#define SL_SO_PHY_RATE              (100)   /* WLAN Transmit rate */
#define SL_SO_PHY_TX_POWER          (101)   /* TX Power level */  
#define SL_SO_PHY_NUM_FRAMES_TO_TX  (102)   /* Number of frames to transmit */
#define SL_SO_PHY_PREAMBLE          (103)   /* Preamble for transmission */
#define SL_SO_PHY_TX_INHIBIT_THRESHOLD (104)   /* TX Inhibit Threshold (CCA) */
#define SL_SO_PHY_TX_TIMEOUT           (105)   /* TX timeout for Transceiver frames (lifetime) in miliseconds (max value is 100ms) */
#define SL_SO_PHY_ALLOW_ACKS           (106)   /* Enable sending ACKs in transceiver mode */

typedef enum
{
  SL_TX_INHIBIT_THRESHOLD_MIN = 1,
  SL_TX_INHIBIT_THRESHOLD_LOW = 2,
  SL_TX_INHIBIT_THRESHOLD_DEFAULT = 3,
  SL_TX_INHIBIT_THRESHOLD_MED = 4,
  SL_TX_INHIBIT_THRESHOLD_HIGH = 5,
  SL_TX_INHIBIT_THRESHOLD_MAX = 6
} SlTxInhibitThreshold_e;

#define SL_SO_SEC_METHOD_SSLV3                             (0)  /* security metohd SSL v3*/
#define SL_SO_SEC_METHOD_TLSV1                             (1)  /* security metohd TLS v1*/
#define SL_SO_SEC_METHOD_TLSV1_1                           (2)  /* security metohd TLS v1_1*/
#define SL_SO_SEC_METHOD_TLSV1_2                           (3)  /* security metohd TLS v1_2*/
#define SL_SO_SEC_METHOD_SSLv3_TLSV1_2                     (4)  /* use highest possible version from SSLv3 - TLS 1.2*/
#define SL_SO_SEC_METHOD_DLSV1                             (5)  /* security metohd DTL v1  */

#define SL_SEC_MASK_SSL_RSA_WITH_RC4_128_SHA                         (1 << 0)
#define SL_SEC_MASK_SSL_RSA_WITH_RC4_128_MD5                         (1 << 1)
#define SL_SEC_MASK_TLS_RSA_WITH_AES_256_CBC_SHA                     (1 << 2)
#define SL_SEC_MASK_TLS_DHE_RSA_WITH_AES_256_CBC_SHA                 (1 << 3)
#define SL_SEC_MASK_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA               (1 << 4)
#define SL_SEC_MASK_TLS_ECDHE_RSA_WITH_RC4_128_SHA                   (1 << 5)
#define SL_SEC_MASK_TLS_RSA_WITH_AES_128_CBC_SHA256                  (1 << 6)
#define SL_SEC_MASK_TLS_RSA_WITH_AES_256_CBC_SHA256                  (1 << 7)
#define SL_SEC_MASK_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256            (1 << 8)
#define SL_SEC_MASK_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256          (1 << 9)
#define SL_SEC_MASK_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA             (1 << 10)
#define SL_SEC_MASK_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA             (1 << 11)
#define SL_SEC_MASK_TLS_RSA_WITH_AES_128_GCM_SHA256                  (1 << 12)
#define SL_SEC_MASK_TLS_RSA_WITH_AES_256_GCM_SHA384                  (1 << 13)
#define SL_SEC_MASK_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256              (1 << 14)
#define SL_SEC_MASK_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384              (1 << 15)
#define SL_SEC_MASK_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256            (1 << 16)
#define SL_SEC_MASK_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384            (1 << 17)
#define SL_SEC_MASK_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256          (1 << 18)
#define SL_SEC_MASK_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384          (1 << 19)
#define SL_SEC_MASK_TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256    (1 << 20)
#define SL_SEC_MASK_TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256      (1 << 21)
#define SL_SEC_MASK_TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256        (1 << 22)

#define SL_SEC_MASK_SECURE_DEFAULT                         ((SL_SEC_MASK_TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256  <<  1)  -  1)

#define SL_SECURE_ALPN_H1               (1 << 0)
#define SL_SECURE_ALPN_H2               (1 << 1)
#define SL_SECURE_ALPN_H2C              (1 << 2)
#define SL_SECURE_ALPN_H2_14            (1 << 3)
#define SL_SECURE_ALPN_H2_16            (1 << 4)
#define SL_SECURE_ALPN_FULL_LIST        ((SL_SECURE_ALPN_H2_16 << 1 ) - 1)


#define SL_MSG_DONTWAIT                                   (0x00000008)  /* Nonblocking IO */

/* AP DHCP Server - IP Release reason code */
#define SL_IP_LEASE_PEER_RELEASE     (0)
#define SL_IP_LEASE_PEER_DECLINE     (1)
#define SL_IP_LEASE_EXPIRED          (2)

/* possible types when receiving SL_SOCKET_ASYNC_EVENT*/
#define SL_SSL_ACCEPT                                        (0) /* accept failed due to ssl issue ( tcp pass) */
#define SL_RX_FRAGMENTATION_TOO_BIG                          (1) /* connection less mode, rx packet fragmentation > 16K, packet is being released */
#define SL_OTHER_SIDE_CLOSE_SSL_DATA_NOT_ENCRYPTED           (2) /* remote side down from secure to unsecure */
#define SL_SSL_NOTIFICATION_CONNECTED_SECURED                (3) /* STARTTLS success */
#define SL_SSL_NOTIFICATION_HANDSHAKE_FAILED                 (4) /* STARTTLS handshake faild */
#define SL_SSL_NOTIFICATION_WRONG_ROOT_CA                    (5) /* Root CA configured is wrong, the name is in SocketAsyncEvent.EventData.extraInfo */
#define SL_SOCKET_ASYNC_EVENT_SSL_NOTIFICATION_WRONG_ROOT_CA (5)
#define SL_MAX_ISSUER_AND_SUBJECT_NAME_LEN                   (16)

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

/* Internet address   */
typedef struct SlInAddr_t
{
#ifndef s_addr 
    _u32           s_addr;             /* Internet address 32 bits */
#else
    union S_un {
       struct { _u8 s_b1,s_b2,s_b3,s_b4; } S_un_b;
       struct { _u8 s_w1,s_w2; } S_un_w;
        _u32 S_addr;
    } S_un;
#endif
}SlInAddr_t;

/* IpV6 or Ipv6 EUI64 */
typedef struct SlIn6Addr_t
{
    union 
    {
        _u8   _S6_u8[16];
        _u32  _S6_u32[4];
    } _S6_un;
}SlIn6Addr_t;


/* sockopt */
typedef struct 
{
    _u32 KeepaliveEnabled; /* 0 = disabled;1 = enabled; default = 1*/
}SlSockKeepalive_t;

typedef struct 
{
    _u32 ReuseaddrEnabled; /* 0 = disabled; 1 = enabled; default = 1*/
}SlSockReuseaddr_t;

typedef struct 
{
    _i32 RxIpNoBoundaryEnabled;  /* 0 = keep IP boundary; 1 = don`t keep ip boundary; default = 0; */
} SlSockRxNoIpBoundary_t;


typedef struct 
{
    _u32 WinSize;          /* receive window size for tcp sockets  */
}SlSockWinsize_t;

typedef struct 
{
    _u32 NonBlockingEnabled;/* 0 = disabled;1 = enabled;default = 1*/
}SlSockNonblocking_t;

typedef struct
{
    _u8   Sd;
    _u8   Type;
    _i16  Val;
    _i8   pExtraInfo[128];
} SlSocketAsyncEvent_t;

typedef struct
{
   _i16        Status;
    _u8        Sd;
    _u8        Padding;
} SlSockTxFailEventData_t;


typedef union
{
    SlSockTxFailEventData_t   SockTxFailData;
    SlSocketAsyncEvent_t      SockAsyncData;
} SlSockEventData_u;


typedef struct
{
   _u32                    Event;
    SlSockEventData_u      SocketAsyncEvent;
} SlSockEvent_t;

typedef struct
{
   _u32         Event;
   _u32         EventData;
} SlSockTriggerEvent_t;


typedef struct
{
    _u32    SecureALPN;
} SlSockSecureALPN_t;

typedef struct
{
    _u32    SecureMask;
} SlSockSecureMask_t;

typedef struct
{
    _u8     SecureMethod;
} SlSockSecureMethod_t;

typedef struct
{
    _u16 SubjectNameXoredSha1;
    _u16 IssuerNameXoredSha1;
    _i8  FromDate[8];
    _i8  ToDate[8];
    _i8  SubjectName[SL_MAX_ISSUER_AND_SUBJECT_NAME_LEN];
    _i8  IssuerName[SL_MAX_ISSUER_AND_SUBJECT_NAME_LEN];
    _i8  SubjectNameLen;
    _i8  IssuerNameLen; 
    _i8  Padding[2];
} SlSockSSLCertInfo_t;


typedef struct
{
    _u32     SecureVersion;              /* what version of SSL decided in the handshake    */
    _u32     SecureCipherSuit;           /* what Cipher Index was decided in the handshake  */
    _u32     SecureIsPeerValidated;      /* was the other peer verified         */
    _u32     SecureALPNChosenProtocol;    /* bit indicate one of the protocol defined above
                                         SL_SECURE_ALPN_H1   
                                         SL_SECURE_ALPN_H2   
                                         SL_SECURE_ALPN_H2C  
                                         SL_SECURE_ALPN_H2_14
                                         SL_SECURE_ALPN_H2_16
                                         */
    SlSockSSLCertInfo_t SecurePeerCertinfo;
} SlSockSSLConnectionParams_t;

typedef enum
{
  SL_BSD_SECURED_PRIVATE_KEY_IDX = 0,
  SL_BSD_SECURED_CERTIFICATE_IDX,
  SL_BSD_SECURED_CA_IDX,
  SL_BSD_SECURED_DH_IDX
}SlSockSecureSocketFilesIndex_e;

typedef struct 
{
    SlInAddr_t   imr_multiaddr;     /* The IPv4 multicast address to join */
    SlInAddr_t   imr_interface;     /* The interface to use for this group */
}SlSockIpMreq_t;

typedef struct{
    SlIn6Addr_t ipv6mr_multiaddr; /* IPv6 multicast address of group */
    _u32        ipv6mr_interface; /*should be 0 to choose the default multicast interface*/
}SlSockIpV6Mreq_t;

typedef struct 
{
    _u32 l_onoff;                            /* 0 = disabled; 1 = enabled; default = 0;*/
    _u32 l_linger;                           /* linger time in seconds; default = 0;*/
}SlSocklinger_t;

/* sockopt */
typedef _i32   SlTime_t;
typedef _i32   SlSuseconds_t;

typedef struct SlTimeval_t
{
    SlTime_t          tv_sec;             /* Seconds      */
    SlSuseconds_t     tv_usec;            /* Microseconds */
}SlTimeval_t;

typedef _u16 SlSocklen_t;

/* IpV4 socket address */
typedef struct SlSockAddr_t
{
    _u16          sa_family;     /* Address family (e.g. , AF_INET)     */
    _u8           sa_data[14];  /* Protocol- specific address information*/
}SlSockAddr_t;


typedef struct SlSockAddrIn6_t
{
    _u16           sin6_family;                 /* AF_INET6 || AF_INET6_EUI_48*/
    _u16           sin6_port;                   /* Transport layer port.  */
    _u32           sin6_flowinfo;               /* IPv6 flow information. */
    SlIn6Addr_t    sin6_addr;                   /* IPv6 address. */
    _u32           sin6_scope_id;               /* set of interfaces for a scope. */
}SlSockAddrIn6_t;

/* Socket address, Internet style. */

typedef struct SlSockAddrIn_t
{
    _u16              sin_family;         /* Internet Protocol (AF_INET).                    */
    _u16              sin_port;           /* Address port (16 bits).                         */
    SlInAddr_t        sin_addr;           /* Internet address (32 bits).                     */
    _i8               sin_zero[8];        /* Not used.                                       */
}SlSockAddrIn_t;


typedef struct
{
    _u8  SecureFiles[4];
}SlSockSecureFiles_t;


typedef struct SlFdSet_t                    /* The select socket array manager */
{ 
   _u32        fd_array[(SL_FD_SETSIZE + (_u8)31)/(_u8)32]; /* Bit map of SOCKET Descriptors */
} SlFdSet_t;

typedef struct
{
    _u8   Rate;               /* Recevied Rate  */
    _u8   Channel;            /* The received channel*/
    _i8   Rssi;               /* The computed RSSI value in db of current frame */
    _u8   Padding;            /* pad to align to 32 bits */
    _u32  Timestamp;          /* Timestamp in microseconds,     */
}SlTransceiverRxOverHead_t;



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

#if _SL_INCLUDE_FUNC(sl_Socket)
_i16 sl_Socket(_i16 Domain, _i16 Type, _i16 Protocol);
#endif

#if _SL_INCLUDE_FUNC(sl_Close)
_i16 sl_Close(_i16 sd);
#endif

#if _SL_INCLUDE_FUNC(sl_Accept)
_i16 sl_Accept(_i16 sd, SlSockAddr_t *addr, SlSocklen_t *addrlen);
#endif

#if _SL_INCLUDE_FUNC(sl_Bind)
_i16 sl_Bind(_i16 sd, const SlSockAddr_t *addr, _i16 addrlen);
#endif

#if _SL_INCLUDE_FUNC(sl_Listen)
_i16 sl_Listen(_i16 sd, _i16 backlog);
#endif

#if _SL_INCLUDE_FUNC(sl_Connect)
_i16 sl_Connect(_i16 sd, const SlSockAddr_t *addr, _i16 addrlen);
#endif

#if _SL_INCLUDE_FUNC(sl_Select)
_i16 sl_Select(_i16 nfds, SlFdSet_t *readsds, SlFdSet_t *writesds, SlFdSet_t *exceptsds, struct SlTimeval_t *timeout);
#endif

void SL_SOCKET_FD_SET(_i16 fd, SlFdSet_t *fdset);

void SL_SOCKET_FD_CLR(_i16 fd, SlFdSet_t *fdset);


_i16  SL_SOCKET_FD_ISSET(_i16 fd, SlFdSet_t *fdset);

void SL_SOCKET_FD_ZERO(SlFdSet_t *fdset);

#if _SL_INCLUDE_FUNC(sl_SetSockOpt)
_i16 sl_SetSockOpt(_i16 sd, _i16 level, _i16 optname, const void *optval, SlSocklen_t optlen);
#endif

#if _SL_INCLUDE_FUNC(sl_GetSockOpt)
_i16 sl_GetSockOpt(_i16 sd, _i16 level, _i16 optname, void *optval, SlSocklen_t *optlen);
#endif

#if _SL_INCLUDE_FUNC(sl_Recv)
_i16 sl_Recv(_i16 sd, void *buf, _i16 len, _i16 flags);
#endif

#if _SL_INCLUDE_FUNC(sl_RecvFrom)
_i16 sl_RecvFrom(_i16 sd, void *buf, _i16 len, _i16 flags, SlSockAddr_t *from, SlSocklen_t *fromlen);
#endif

#if _SL_INCLUDE_FUNC(sl_Send )
_i16 sl_Send(_i16 sd, const void *buf, _i16 len, _i16 flags);
#endif

#if _SL_INCLUDE_FUNC(sl_SendTo)
_i16 sl_SendTo(_i16 sd, const void *buf, _i16 len, _i16 flags, const SlSockAddr_t *to, SlSocklen_t tolen);
#endif

#if _SL_INCLUDE_FUNC(sl_Htonl )
_u32 sl_Htonl( _u32 val );

#define sl_Ntohl sl_Htonl  /* Reorder the bytes of a 16-bit unsigned value from network order to processor orde. */
#endif

#if _SL_INCLUDE_FUNC(sl_Htons )
_u16 sl_Htons( _u16 val );

#define sl_Ntohs sl_Htons   /* Reorder the bytes of a 16-bit unsigned value from network order to processor orde. */
#endif


#ifdef  __cplusplus
}
#endif /* __cplusplus */

#endif /* __SOCKET_H__ */