socketndk.h

Go to the documentation of this file.

/*
 * Copyright (c) 2014-2019, 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.
 * */
/*
 * ======== socket.h ========
 *
 * NDK socket APIs
 *
 */

#ifndef _SOCKET_NDK_H_
#define _SOCKET_NDK_H_

/* NDK_NOUSERAPIS is a temporary fix to enable NIMU drivers to avoid a POSIX
 * dependency.  User code typically doesn't throw it (and therefore
 * has a POSIX dependency).
 */
#ifndef NDK_NOUSERAPIS
/* use TI POSIX to get timeval, needed by fdSelect() */
#include <sys/time.h>
#endif

#ifdef __cplusplus
extern "C" {
#endif

/* Network Support Macros for "Unix-like" functions */
#ifdef NDK_BIGENDIAN
#define NDK_htons(a) (a)
#define NDK_htonl(a) (a)
#define NDK_ntohl(a) (a)
#define NDK_ntohs(a) (a)
#else
#define NDK_htons(a) ( (((a)>>8)&0xffU) + (((a)<<8)&0xff00U) )
/*
 * Fix warning when compiling for IAR (SDOCM00103001):
 *
 *     Warning[Pe061]: integer operation result is out of range
 *
 * This macro has been updated to perform masking operations before shifting.
 * In its previous form (which shifts THEN masks), the IAR compiler generated
 * a warning because it did not like shaving off bits, as it is a (potential)
 * accidental loss of data.  Changing the code to mask first (purposefully
 * losing the data) then shifting afterward fixes the warning.
 *
 * Note that the TI and GCC compilers never cared about this ...
 *
 */
#define NDK_htonl(a) ((((a) & 0xff000000) >> 24) | (((a) & 0x00ff0000) >> 8) | \
                  (((a) & 0x0000ff00) << 8)  | (((a) & 0x000000ff) << 24) )
#define NDK_ntohl(a) NDK_htonl(a)
#define NDK_ntohs(a) NDK_htons(a)
#endif

/* OS and Sockets Types */
typedef void * SOCKET; /* OS Socket Type */

/*
 * Select uses bit masks of file descriptors.  These macros
 * manipulate handle lists. NDK_FD_SETSIZE can be modified as
 * needed.
 *
 */
#define NDK_FD_SETSIZE 16

#define _SYS_SELECT_H   1 // TODO: still needed for struct timeval conflict
typedef struct NDK_fd_set {
    uint32_t    count;
    void *fd[NDK_FD_SETSIZE];
} NDK_fd_set;

extern void    fdsetRemoveEntry( NDK_fd_set *pSet, void *hEntry );
extern uint32_t    fdsetTestEntry( NDK_fd_set *pSet, void *hEntry );
extern void    mmCopy( void* pDst, void* pSrc, uint32_t Size );

#define NDK_FD_SET(n, p)    {if((p)->count<NDK_FD_SETSIZE){(p)->fd[(p)->count++]=(n);}}

#define NDK_FD_CLR(n, p)    fdsetRemoveEntry( (p), (n) )

#define NDK_FD_ISSET(n, p)  fdsetTestEntry( (p), (n) )

#define NDK_FD_COPY(f, t)   mmCopy((t), (f), sizeof(NDK_fd_set))

#define NDK_FD_ZERO(p)      ((p)->count=0)

/* Socket address families */
#define AF_UNSPEC       0
#define AF_TASK         1               /* Intertask Communication */
#define AF_INET         2               /* Internet: UDP, TCP, etc. */
#define AF_INET6        10              /* IPV6 */
#define AF_RAWETH       12              /* Raw Ethernet Protocol */

/* Socket Types */
#define SOCK_STREAM     1               /* stream socket */
#define SOCK_DGRAM      2               /* datagram socket */
#define SOCK_RAW        3               /* raw-protocol interface */
#define SOCK_STREAMNC   4               /* non-copy stream socket */
#define SOCK_RAWETH     5               /* non-copy raw eth socket */

/* Protocols */
#define IPPROTO_IP      0               /* IP Placeholder */
#define IPPROTO_ICMP    1               /* ICMP */
#define IPPROTO_IGMP    2               /* IGMP */
#define IPPROTO_TCP     6               /* TCP */
#define IPPROTO_UDP     17              /* UDP */
#define IPPROTO_IPV6    41              /* IPV6  */
#define IPPROTO_ICMPV6  58              /* ICMPV6 Header. */

/* Option flags per-socket. */
#define SO_DEBUG        0x0001          /* turn on debugging info recording */
#define SO_ACCEPTCONN   0x0002          /* socket has had listen() */
#define SO_REUSEADDR    0x0004          /* allow local address reuse */
#define SO_KEEPALIVE    0x0008          /* keep connections alive */
#define SO_DONTROUTE    0x0010
#define SO_BROADCAST    0x0020
#define SO_USELOOPBACK  0x0040          /* bypass hardware when possible */
#define SO_LINGER       0x0080          /* linger on close if data present */
#define SO_OOBINLINE    0x0100          /* leave received OOB data in line */
#define SO_REUSEPORT    0x0200          /* allow local address & port reuse */
#define SO_TIMESTAMP    0x0400          /* timestamp received dgram traffic */

/* Additional options (not flags) */
#define SO_SNDBUF       0x1001          /* send buffer size */
#define SO_RCVBUF       0x1002          /* receive buffer size */
#define SO_SNDLOWAT     0x1003          /* send low-water mark */
#define SO_RCVLOWAT     0x1004          /* receive low-water mark */
#define SO_SNDTIMEO     0x1005          /* send timeout */
#define SO_RCVTIMEO     0x1006          /* receive timeout */
#define SO_ERROR        0x1007          /* get error status and clear */
#define SO_TYPE         0x1008          /* get socket type */
#define SO_PRIVSTATE    0x1009          /* get/deny privileged state */
#define SO_IFDEVICE     0x100a          /* broadcast IO device */
#define SO_BLOCKING     0x100b          /* blocking is default */
#define SO_TXTIMESTAMP  0x100c          /* register a call-out function */
                                        /* to timestamp transmitted payload  */
                                        /* data.  */
#define SO_PRIORITY     0x100d          /* Use this to set the priority of the socket. */

#define SOL_SOCKET      0xFFFF          /* Level used for above options */

/* Structure used for manipulating linger option. */
struct  linger {
    int l_onoff;                /* option on/off */
    int l_linger;               /* linger time */
};

/* IP Level (IPPROTO_IP) Socket Options */
#define IP_OPTIONS                  1       /* get/set IP Options (20 byte max) */
#define IP_HDRINCL                  2       /* IP Header included with data (raw only) */
#define IP_TOS                      3       /* IP tos & preced. */
#define IP_TTL                      4       /* IP ttl */

/* Multicast Support as per RFC3678 */
#define IP_ADD_MEMBERSHIP                       5       /* Join a Multicast group. */
#define IP_DROP_MEMBERSHIP                      6       /* Leave a Multicast group. */

/* TCP Level (IPPROTO_TCP) Socket Options */
#define NDK_TCP_NODELAY     0x01    /* Don't delay send to combine packet data */
#define NDK_TCP_MAXSEG      0x02    /* Adjust MSS (down only) */
#define NDK_TCP_NOPUSH      0x04    /* Don't send just to finish a data block */
#define NDK_TCP_NOOPT       0x08    /* Don't use TCP options */
#define NDK_TCP_SACKPERMITTED 0x10  /* RFC 2018 - SACK is permitted */
#define NDK_TCP_MAXRTT      0x20    /* Set maximum RTT value used in calculation */

/* Read/Write Flags */
#define MSG_OOB         0x0001  /* Read OOB data (not supported) */
#define MSG_PEEK        0x0002  /* Get Rx data but leave in queue */
#define MSG_WAITALL     0x0004  /* Wait for data to fill buffers */
#define MSG_DONTWAIT    0x0008  /* Don't wait for resources */
#define MSG_DONTROUTE   0x0010  /* Won't route if not local to subnet */
#define MSG_NOSIGNAL    0x0020  /* Unused (fix for NDK-115) */

/* Generic Socket address storage data structure. */
struct sockaddr {
    uint16_t sa_family; /* address family */
    char sa_data[14]; /* socket data */
};

/* Structure used by kernel to store most */
/* addresses. */
struct in_addr {
    uint32_t  s_addr;             /* 32 bit long IP address, net order */
};

/* Structure used for handling the Multicast socket options  */
/* as defined by RFC3678 */
struct ip_mreq
{
    struct in_addr  imr_multiaddr;  /* IP Address of the group     */
    struct in_addr  imr_interface;  /* IP Address of the interface */
};

/* AF_INET family (IPv4) Socket address data structure. */
struct sockaddr_in {
    uint16_t       sin_family;         /* address family */
    uint16_t       sin_port;           /* port */
    struct in_addr sin_addr;
    char           sin_zero[8];        /* fixed length address value */
};

#define IPV6_UCAST_DEF_HOP_LIMIT    64
#define IPV6_MCAST_DEF_HOP_LIMIT    1

/* Socket options defined at IPPROTO_IPV6 level. */
#define IPV6_UNICAST_HOPS       1
#define IPV6_MULTICAST_IF       2
#define IPV6_MULTICAST_HOPS     3
#define IPV6_MULTICAST_LOOP     4
#define IPV6_JOIN_GROUP         5
#define IPV6_LEAVE_GROUP        6
#define IPV6_V6ONLY             7

/* Structure used by kernel to store IPv6 */
/* addresses. */
struct in6_addr {
    union
    {
        unsigned char u6_addr8[16];
        uint16_t      u6_addr16[8];
        uint32_t      u6_addr32[4];
    }in6_u;
#define s6_addr     in6_u.u6_addr8
#define s6_addr16   in6_u.u6_addr16
#define s6_addr32   in6_u.u6_addr32
};

/* Structure used for handling the Multicast socket options  */
/* as defined by RFC3678 for IPv6 */
struct ipv6_mreq
{
    struct in6_addr ipv6mr_multiaddr;  /* IP Address of the group     */
    uint32_t        ipv6mr_interface;  /* local interface */
};

/* AF_INET6 family (IPv6) Socket address data structure. */
struct sockaddr_in6 {
    uint16_t        sin6_family;            /* address family */
    uint16_t        sin6_port;              /* port */
    uint32_t        sin6_flowinfo;          /* IPv6 flow information */
    struct in6_addr sin6_addr;     /* IPv6 address */
    uint32_t        sin6_scope_id;          /* scope id */
};

/* Maximum queue length specifiable by listen. */
#define SOMAXCONN       8

/* Used by Shutdown() */
#define SHUT_RD   0     /* Read side of connection */
#define SHUT_WR   1     /* Write side of connection */
#define SHUT_RDWR 2     /* Both sides of connection */

/* Used by fdPoll() */
typedef struct _fdpollitem {
        void    *fd;
        uint16_t eventsRequested;
        uint16_t eventsDetected;
    } FDPOLLITEM;

/* Errror Return Values */
#define INVALID_SOCKET (void *)(-1L)        /* Used by socket() and accept() */
#define SOCKET_ERROR   -1                   /* Used by the rest */

/* Functions */

#ifndef NDK_NOUSERAPIS

/* File Descriptor Functions */
extern int    fdOpenSession( void *hTask );
extern void   fdCloseSession( void *hTask );
extern int    fdClose( void *fd );
extern int    fdShare( void *fd );
extern int    fdError();

extern int    fdSelect( int width, NDK_fd_set *readfds, NDK_fd_set *writefds,
                         NDK_fd_set *exceptfds, struct timeval *timeout );
extern void   fdSelectAbort( void *hTask );

extern int    fdStatus( SOCKET s, int request, int *results );
#define FDSTATUS_TYPE           0   /* get socket type */
#define FDSTATUS_TYPE_SOCKET    1
#define FDSTATUS_TYPE_PIPE      2
#define FDSTATUS_RECV           1   /* get socket rcv status */
#define FDSTATUS_SEND           2   /* get socket snd status */

extern int    fdPoll( FDPOLLITEM items[], uint32_t itemcnt, int32_t timeout );
#define POLLINFTIM              -1
#define POLLIN                  0x01
#define POLLOUT                 0x02
#define POLLPRI                 0x04
#define POLLNVAL                0x08

/* Socket Oriented Functions */
extern SOCKET NDK_accept( SOCKET s, struct sockaddr *pName, int *plen );
extern int    NDK_bind( SOCKET s, struct sockaddr *pName, int len );
extern int    NDK_connect( SOCKET s, struct sockaddr *pName, int len );
extern int    NDK_getpeername( SOCKET s, struct sockaddr *pName, int *plen );
extern int    NDK_getsockname( SOCKET s, struct sockaddr *pName, int *plen );
extern int    NDK_getsockopt( SOCKET s, int level, int op, void *pbuf, int *pbufsize );
extern int    NDK_listen( SOCKET s, int maxcon );
extern int    NDK_recv( SOCKET s, void *pbuf, int size, int flags );
extern int    NDK_recvfrom( SOCKET s, void *pbuf, int size, int flags, struct sockaddr *pName, int *plen );
extern int    NDK_recvnc( SOCKET s, void **ppbuf, int flags, void **pHandle );
extern int    NDK_recvncfrom( SOCKET s, void **ppbuf, int flags,
                           struct sockaddr *pName, int *plen, void **pHandle );
extern void   NDK_recvncfree( SOCKET Handle );
extern int    NDK_send( SOCKET s, void *pbuf, int size, int flags );
extern int    NDK_sendto( SOCKET s, void *pbuf, int size, int flags, struct sockaddr *pName, int len );
extern int    NDK_setsockopt( SOCKET s, int level, int op, void *pbuf, int bufsize );
extern int    NDK_shutdown( SOCKET s, int how );
extern SOCKET NDK_socket( int domain, int type, int protocol );

extern int    NDK_getsendncbuff(SOCKET s, uint32_t bufSize, void** phBuf, void **phPkt);
extern int    NDK_sendnc( SOCKET s, void *pbuf, int size, void *hPkt, int flags );
extern void   NDK_sendncfree( SOCKET Handle );
extern int    NDK_getSockCtx( SOCKET s);

/* Pipe Oriented Functions */
extern int    NDK_pipe( void **pfd1, void **pfd2 );

/* Hook function prototypes */
#define CREATE_SKT_CTX_HOOK 0
#define CLOSE_SKT_CTX_HOOK 1
#define NETSTART_ERROR_HOOK 2

typedef struct _NetStartError {
    int error;
} NetStartError_Obj;

typedef int (*NDK_HookFxn) (uintptr_t);
extern void NDK_registerHook(int type, NDK_HookFxn fxn);

/* Socket context defines */
#define NDK_NO_CTX -1

#endif /* NDK_NOUSERAPIS */

/* Call-out function prototype   */
typedef void   (*TimestampFxn)(unsigned char *pIpHdr);

#ifdef __cplusplus
}
#endif /* extern "C" */

#endif