socket.h

Go to the documentation of this file.

#ifndef __SOCKET_H__
#define __SOCKET_H__

#ifdef  __cplusplus
extern "C" {
#endif

/*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*
INCLUDES
*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*/

#include "driver/include/m2m_types.h"

/*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*
MACROS
*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*/
#define HOSTNAME_MAX_SIZE                                                                       100

#define SOCKET_BUFFER_MAX_LENGTH                                                        1400

#define  AF_INET                                                                                        2

#define  SOCK_STREAM                                                                            1

#define  SOCK_DGRAM                                                                                     2

#define SOCKET_FLAGS_SSL                                                                        0x01

#define TCP_SOCK_MAX                                                                            (7)

#define UDP_SOCK_MAX                                                                            4

#define MAX_SOCKET                                                                                      (TCP_SOCK_MAX + UDP_SOCK_MAX)

#define SOL_SOCKET                                                                                      1

#define SO_SET_UDP_SEND_CALLBACK                                                        0x00

#define IP_ADD_MEMBERSHIP                                                                       0x01

#define IP_DROP_MEMBERSHIP                                                                      0x02

// SSL Socket options

#define SOL_SSL_SOCKET                                                                                  2

#define SO_SSL_BYPASS_X509_VERIF                                                                0x01

#define SO_SSL_SNI                                                                                              0x02

#define SO_SSL_ENABLE_SESSION_CACHING                                           0x03

#define SO_SSL_ENABLE_CERTNAME_VALIDATION                                       0x04

#define SO_SSL_ENABLE_SNI_VALIDATION                                            0x04


#define SSL_CIPHER_RSA_WITH_AES_128_CBC_SHA                                     NBIT0
#define SSL_CIPHER_RSA_WITH_AES_128_CBC_SHA256                          NBIT1
#define SSL_CIPHER_DHE_RSA_WITH_AES_128_CBC_SHA                         NBIT2
#define SSL_CIPHER_DHE_RSA_WITH_AES_128_CBC_SHA256                      NBIT3
#define SSL_CIPHER_RSA_WITH_AES_128_GCM_SHA256                          NBIT4
#define SSL_CIPHER_DHE_RSA_WITH_AES_128_GCM_SHA256                      NBIT5
#define SSL_CIPHER_RSA_WITH_AES_256_CBC_SHA                                     NBIT6
#define SSL_CIPHER_RSA_WITH_AES_256_CBC_SHA256                          NBIT7
#define SSL_CIPHER_DHE_RSA_WITH_AES_256_CBC_SHA                         NBIT8
#define SSL_CIPHER_DHE_RSA_WITH_AES_256_CBC_SHA256                      NBIT9
#define SSL_CIPHER_ECDHE_RSA_WITH_AES_128_CBC_SHA                       NBIT10
#define SSL_CIPHER_ECDHE_RSA_WITH_AES_256_CBC_SHA                       NBIT11
#define SSL_CIPHER_ECDHE_RSA_WITH_AES_128_CBC_SHA256            NBIT12
#define SSL_CIPHER_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256          NBIT13
#define SSL_CIPHER_ECDHE_RSA_WITH_AES_128_GCM_SHA256            NBIT14
#define SSL_CIPHER_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256          NBIT15


#define SSL_ECC_ONLY_CIPHERS            \
(\
        SSL_CIPHER_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256  |       \
        SSL_CIPHER_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256          \
)

#define SSL_DEFAULT_CIPHERS     \
(\
        SSL_CIPHER_RSA_WITH_AES_128_CBC_SHA                             |       \
        SSL_CIPHER_RSA_WITH_AES_128_CBC_SHA256                  |       \
        SSL_CIPHER_DHE_RSA_WITH_AES_128_CBC_SHA                 |       \
        SSL_CIPHER_DHE_RSA_WITH_AES_128_CBC_SHA256              |       \
        SSL_CIPHER_RSA_WITH_AES_128_GCM_SHA256                  |       \
        SSL_CIPHER_DHE_RSA_WITH_AES_128_GCM_SHA256              |       \
        SSL_CIPHER_RSA_WITH_AES_256_CBC_SHA                             |       \
        SSL_CIPHER_RSA_WITH_AES_256_CBC_SHA256                  |       \
        SSL_CIPHER_DHE_RSA_WITH_AES_256_CBC_SHA                 |       \
        SSL_CIPHER_DHE_RSA_WITH_AES_256_CBC_SHA256                      \
)


#ifdef _NM_BSP_BIG_END
#define _htonl(m)                               (m)

#define _htons(A)                               (A)

#else
#define _htonl(m)               \
        (uint32)(((uint32)(m << 24)) | ((uint32)((m & 0x0000FF00) << 8)) | ((uint32)((m & 0x00FF0000) >> 8)) | ((uint32)(((uint32)m) >> 24)))

#define _htons(A)       (uint16)((((uint16) (A)) << 8) | (((uint16) (A)) >> 8))

#endif


#define _ntohl                  _htonl

#define _ntohs                  _htons

                
/**************
Socket Errors
**************/
#define SOCK_ERR_NO_ERROR                                                                       0

#define SOCK_ERR_INVALID_ADDRESS                                                        -1

#define SOCK_ERR_ADDR_ALREADY_IN_USE                                            -2

#define SOCK_ERR_MAX_TCP_SOCK                                                           -3

#define SOCK_ERR_MAX_UDP_SOCK                                                           -4

#define SOCK_ERR_INVALID_ARG                                                            -6

#define SOCK_ERR_MAX_LISTEN_SOCK                                                        -7

#define SOCK_ERR_INVALID                                                                        -9

#define SOCK_ERR_ADDR_IS_REQUIRED                                                       -11

#define SOCK_ERR_CONN_ABORTED                                                           -12

#define SOCK_ERR_TIMEOUT                                                                        -13

#define SOCK_ERR_BUFFER_FULL                                                            -14


/*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*
DATA TYPES
*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*/

typedef sint8  SOCKET;

typedef struct{
        uint32          s_addr;
}in_addr;


struct sockaddr{
    uint16              sa_family;
    uint8               sa_data[14];
};

struct sockaddr_in{
        uint16                  sin_family;
        uint16                  sin_port;
        in_addr                 sin_addr;
        uint8                   sin_zero[8];
};

typedef enum{
        SOCKET_MSG_BIND = 1,
        SOCKET_MSG_LISTEN,
        SOCKET_MSG_DNS_RESOLVE,
        SOCKET_MSG_ACCEPT,
        SOCKET_MSG_CONNECT,
        SOCKET_MSG_RECV,
        SOCKET_MSG_SEND,
        SOCKET_MSG_SENDTO,
        SOCKET_MSG_RECVFROM
}tenuSocketCallbackMsgType;
// @}


typedef struct{
        sint8           status;
}tstrSocketBindMsg;


typedef struct{
        sint8           status;
}tstrSocketListenMsg;



typedef struct{
        SOCKET          sock;
        struct          sockaddr_in     strAddr;
}tstrSocketAcceptMsg;


typedef struct{
        SOCKET  sock;
        sint8           s8Error;
}tstrSocketConnectMsg;


typedef struct{
        uint8                                   *pu8Buffer;
        sint16                                  s16BufferSize;
        uint16                                  u16RemainingSize;
        struct sockaddr_in              strRemoteAddr;
}tstrSocketRecvMsg;

typedef void (*tpfAppSocketCb) (SOCKET sock, uint8 u8Msg, void * pvMsg);


typedef void (*tpfAppResolveCb) (uint8* pu8DomainName, uint32 u32ServerIP);

typedef void (*tpfPingCb)(uint32 u32IPAddr, uint32 u32RTT, uint8 u8ErrorCode);
 
/*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*
FUNCTION PROTOTYPES
*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*/
NMI_API void socketInit(void);

NMI_API void socketDeinit(void);
NMI_API void registerSocketCallback(tpfAppSocketCb socket_cb, tpfAppResolveCb resolve_cb);
NMI_API SOCKET socket(uint16 u16Domain, uint8 u8Type, uint8 u8Flags);
NMI_API sint8 bind(SOCKET sock, struct sockaddr *pstrAddr, uint8 u8AddrLen);
NMI_API sint8 listen(SOCKET sock, uint8 backlog);
NMI_API sint8 accept(SOCKET sock, struct sockaddr *addr, uint8 *addrlen);
NMI_API sint8 connect(SOCKET sock, struct sockaddr *pstrAddr, uint8 u8AddrLen);
NMI_API sint16 recv(SOCKET sock, void *pvRecvBuf, uint16 u16BufLen, uint32 u32Timeoutmsec);
NMI_API sint16 recvfrom(SOCKET sock, void *pvRecvBuf, uint16 u16BufLen, uint32 u32Timeoutmsec);
NMI_API sint16 send(SOCKET sock, void *pvSendBuffer, uint16 u16SendLength, uint16 u16Flags);
NMI_API sint16 sendto(SOCKET sock, void *pvSendBuffer, uint16 u16SendLength, uint16 flags, struct sockaddr *pstrDestAddr, uint8 u8AddrLen);
NMI_API sint8 close(SOCKET sock);
NMI_API uint32 nmi_inet_addr(char *pcIpAddr);
NMI_API sint8 gethostbyname(uint8 * pcHostName);

NMI_API sint8 setsockopt(SOCKET socket, uint8 u8Level, uint8 option_name,
       const void *option_value, uint16 u16OptionLen);
NMI_API sint8 getsockopt(SOCKET sock, uint8 u8Level, uint8 u8OptName, const void *pvOptValue, uint8* pu8OptLen);
NMI_API sint8 m2m_ping_req(uint32 u32DstIP, uint8 u8TTL, tpfPingCb fpPingCb);
#ifdef  __cplusplus
}
#endif /* __cplusplus */

#endif /* __SOCKET_H__ */