m2m_socket_host_if.h

Go to the documentation of this file.

#ifndef __M2M_SOCKET_HOST_IF_H__
#define __M2M_SOCKET_HOST_IF_H__


#ifdef  __cplusplus
extern "C" {
#endif

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

#ifndef _BOOT_
#ifndef _FIRMWARE_
#include "socket/include/socket.h"
#else
#include "driver/include/m2m_types.h"
#endif
#endif

/*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*
MACROS
*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*/

#ifdef _FIRMWARE_
#define HOSTNAME_MAX_SIZE                       (100)
#endif

#define SSL_MAX_OPT_LEN                         HOSTNAME_MAX_SIZE



#define SOCKET_CMD_INVALID                                      0x00

#define SOCKET_CMD_BIND                                 0x41

#define SOCKET_CMD_LISTEN                                       0x42

#define SOCKET_CMD_ACCEPT                                       0x43

#define SOCKET_CMD_CONNECT                              0x44

#define SOCKET_CMD_SEND                                 0x45

#define SOCKET_CMD_RECV                                 0x46

#define SOCKET_CMD_SENDTO                                       0x47

#define SOCKET_CMD_RECVFROM                             0x48

#define SOCKET_CMD_CLOSE                                        0x49

#define SOCKET_CMD_DNS_RESOLVE                  0x4A

#define SOCKET_CMD_SSL_CONNECT                  0x4B

#define SOCKET_CMD_SSL_SEND                             0x4C    

#define SOCKET_CMD_SSL_RECV                             0x4D

#define SOCKET_CMD_SSL_CLOSE                            0x4E

#define SOCKET_CMD_SET_SOCKET_OPTION            0x4F

#define SOCKET_CMD_SSL_CREATE                           0x50

#define SOCKET_CMD_SSL_SET_SOCK_OPT                     0x51


#define SOCKET_CMD_PING                                         0x52





#define PING_ERR_SUCCESS                                        0
#define PING_ERR_DEST_UNREACH                           1
#define PING_ERR_TIMEOUT                                        2

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


typedef struct{ 
        uint16          u16Family;
        uint16          u16Port;
        uint32          u32IPAddr;
}tstrSockAddr;


typedef sint8                   SOCKET;
typedef tstrSockAddr    tstrUIPSockAddr;



typedef struct{
        char            acHostName[HOSTNAME_MAX_SIZE];
        uint32          u32HostIP;
}tstrDnsReply;


typedef struct{
        tstrSockAddr    strAddr;
        SOCKET          sock;
        uint8           u8Void;
        uint16          u16SessionID;
}tstrBindCmd;


typedef struct{
        SOCKET          sock;
        sint8           s8Status;
        uint16          u16SessionID;
}tstrBindReply;


typedef struct{
        SOCKET  sock;
        uint8   u8BackLog;
        uint16  u16SessionID;
}tstrListenCmd;


typedef struct{
        SOCKET          sock;
        sint8                   s8Status;
        uint16          u16SessionID;
}tstrListenReply;


typedef struct{
        tstrSockAddr    strAddr;
        SOCKET                  sListenSock;
        SOCKET                  sConnectedSock;
        uint16                  u16Void;
}tstrAcceptReply;


typedef struct{
        tstrSockAddr    strAddr;
        SOCKET                  sock;
        uint8                   u8SslFlags;
        uint16                  u16SessionID;
}tstrConnectCmd;


typedef struct{
        SOCKET          sock;
        sint8           s8Error;
        uint16          u16AppDataOffset;
}tstrConnectReply;


typedef struct{
        SOCKET                  sock;
        uint8                   u8Void;
        uint16                  u16DataSize;
        tstrSockAddr    strAddr;
        uint16          u16SessionID;
        uint16                  u16Void;
}tstrSendCmd;


typedef struct{
        SOCKET          sock;
        uint8           u8Void;
        sint16          s16SentBytes;
        uint16          u16SessionID;
        uint16          u16Void;
}tstrSendReply;


typedef struct{
        uint32          u32Timeoutmsec;
        SOCKET          sock;
        uint8           u8Void;
        uint16          u16SessionID;
        uint16          u16BufLen;
}tstrRecvCmd;


typedef struct{
        tstrSockAddr            strRemoteAddr;
        sint16                  s16RecvStatus;
        uint16                  u16DataOffset;
        SOCKET                  sock;
        uint8                   u8Void;
        uint16                  u16SessionID;
}tstrRecvReply;


typedef struct{
        uint32          u32OptionValue;
        SOCKET          sock;
        uint8           u8Option;
        uint16          u16SessionID;
}tstrSetSocketOptCmd;


typedef struct{
        SOCKET          sslSock;
        uint8           __PAD24__[3];
}tstrSSLSocketCreateCmd;


typedef struct{
        SOCKET          sock;
        uint8           u8Option;
        uint16          u16SessionID;
        uint32          u32OptLen;
        uint8           au8OptVal[SSL_MAX_OPT_LEN];
}tstrSSLSetSockOptCmd;


typedef struct{
        uint32  u32DestIPAddr;
        uint32  u32CmdPrivate;
        uint16  u16PingCount;
        uint8   u8TTL;
        uint8   __PAD8__;
}tstrPingCmd;


typedef struct{
        uint32  u32IPAddr;
        uint32  u32CmdPrivate;
        uint32  u32RTT;
        uint16  u16Success;
        uint16  u16Fail;
        uint8   u8ErrorCode;
        uint8   __PAD24__[3];
}tstrPingReply;

#ifdef  __cplusplus
}
#endif /* __cplusplus */

#endif /* __M2M_SOCKET_HOST_IF_H__ */