git.sur5r.net Git - freertos/blob - Demo/Common/ethernet/lwIP/include/lwip/sockets.h

   1 /*\r
   2  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.\r
   3  * All rights reserved. \r
   4  * \r
   5  * Redistribution and use in source and binary forms, with or without modification, \r
   6  * are permitted provided that the following conditions are met:\r
   7  *\r
   8  * 1. Redistributions of source code must retain the above copyright notice,\r
   9  *    this list of conditions and the following disclaimer.\r
  10  * 2. Redistributions in binary form must reproduce the above copyright notice,\r
  11  *    this list of conditions and the following disclaimer in the documentation\r
  12  *    and/or other materials provided with the distribution.\r
  13  * 3. The name of the author may not be used to endorse or promote products\r
  14  *    derived from this software without specific prior written permission. \r
  15  *\r
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED \r
  17  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF \r
  18  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT \r
  19  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, \r
  20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT \r
  21  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS \r
  22  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN \r
  23  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING \r
  24  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY \r
  25  * OF SUCH DAMAGE.\r
  26  *\r
  27  * This file is part of the lwIP TCP/IP stack.\r
  28  * \r
  29  * Author: Adam Dunkels <adam@sics.se>\r
  30  *\r
  31  */\r
  32 \r
  33 \r
  34 #ifndef __LWIP_SOCKETS_H__\r
  35 #define __LWIP_SOCKETS_H__\r
  36 #include "lwip/ip_addr.h"\r
  37 \r
  38 struct sockaddr_in {\r
  39   u8_t sin_len;\r
  40   u8_t sin_family;\r
  41   u16_t sin_port;\r
  42   struct in_addr sin_addr;\r
  43   char sin_zero[8];\r
  44 };\r
  45 \r
  46 struct sockaddr {\r
  47   u8_t sa_len;\r
  48   u8_t sa_family;\r
  49   char sa_data[14];\r
  50 };\r
  51 \r
  52 #ifndef socklen_t\r
  53 #  define socklen_t int\r
  54 #endif\r
  55 \r
  56 \r
  57 #define SOCK_STREAM     1\r
  58 #define SOCK_DGRAM      2\r
  59 #define SOCK_RAW        3\r
  60 \r
  61 /*\r
  62  * Option flags per-socket.\r
  63  */\r
  64 #define  SO_DEBUG  0x0001    /* turn on debugging info recording */\r
  65 #define  SO_ACCEPTCONN  0x0002    /* socket has had listen() */\r
  66 #define  SO_REUSEADDR  0x0004    /* allow local address reuse */\r
  67 #define  SO_KEEPALIVE  0x0008    /* keep connections alive */\r
  68 #define  SO_DONTROUTE  0x0010    /* just use interface addresses */\r
  69 #define  SO_BROADCAST  0x0020    /* permit sending of broadcast msgs */\r
  70 #define  SO_USELOOPBACK  0x0040    /* bypass hardware when possible */\r
  71 #define  SO_LINGER  0x0080    /* linger on close if data present */\r
  72 #define  SO_OOBINLINE  0x0100    /* leave received OOB data in line */\r
  73 #define  SO_REUSEPORT   0x0200          /* allow local address & port reuse */\r
  74 \r
  75 #define SO_DONTLINGER   (int)(~SO_LINGER)\r
  76 \r
  77 /*\r
  78  * Additional options, not kept in so_options.\r
  79  */\r
  80 #define SO_SNDBUF  0x1001    /* send buffer size */\r
  81 #define SO_RCVBUF  0x1002    /* receive buffer size */\r
  82 #define SO_SNDLOWAT  0x1003    /* send low-water mark */\r
  83 #define SO_RCVLOWAT  0x1004    /* receive low-water mark */\r
  84 #define SO_SNDTIMEO  0x1005    /* send timeout */\r
  85 #define SO_RCVTIMEO  0x1006    /* receive timeout */\r
  86 #define  SO_ERROR  0x1007    /* get error status and clear */\r
  87 #define  SO_TYPE    0x1008    /* get socket type */\r
  88 \r
  89 \r
  90 \r
  91 /*\r
  92  * Structure used for manipulating linger option.\r
  93  */\r
  94 struct linger {\r
  95        int l_onoff;                /* option on/off */\r
  96        int l_linger;               /* linger time */\r
  97 };\r
  98 \r
  99 /*\r
 100  * Level number for (get/set)sockopt() to apply to socket itself.\r
 101  */\r
 102 #define  SOL_SOCKET  0xfff    /* options for socket level */\r
 103 \r
 104 \r
 105 #define AF_UNSPEC       0\r
 106 #define AF_INET         2\r
 107 #define PF_INET         AF_INET\r
 108 #define PF_UNSPEC       AF_UNSPEC\r
 109 \r
 110 #define IPPROTO_IP      0\r
 111 #define IPPROTO_TCP     6\r
 112 #define IPPROTO_UDP     17\r
 113 \r
 114 #define INADDR_ANY      0\r
 115 #define INADDR_BROADCAST 0xffffffff\r
 116 \r
 117 /* Flags we can use with send and recv. */\r
 118 #define MSG_DONTWAIT    0x40            /* Nonblocking i/o for this operation only */\r
 119 \r
 120 \r
 121 /*\r
 122  * Options for level IPPROTO_IP\r
 123  */\r
 124 #define IP_TOS       1\r
 125 #define IP_TTL       2\r
 126 \r
 127 \r
 128 #define IPTOS_TOS_MASK          0x1E\r
 129 #define IPTOS_TOS(tos)          ((tos) & IPTOS_TOS_MASK)\r
 130 #define IPTOS_LOWDELAY          0x10\r
 131 #define IPTOS_THROUGHPUT        0x08\r
 132 #define IPTOS_RELIABILITY       0x04\r
 133 #define IPTOS_LOWCOST           0x02\r
 134 #define IPTOS_MINCOST           IPTOS_LOWCOST\r
 135 \r
 136 /*\r
 137  * Definitions for IP precedence (also in ip_tos) (hopefully unused)\r
 138  */\r
 139 #define IPTOS_PREC_MASK                 0xe0\r
 140 #define IPTOS_PREC(tos)                ((tos) & IPTOS_PREC_MASK)\r
 141 #define IPTOS_PREC_NETCONTROL           0xe0\r
 142 #define IPTOS_PREC_INTERNETCONTROL      0xc0\r
 143 #define IPTOS_PREC_CRITIC_ECP           0xa0\r
 144 #define IPTOS_PREC_FLASHOVERRIDE        0x80\r
 145 #define IPTOS_PREC_FLASH                0x60\r
 146 #define IPTOS_PREC_IMMEDIATE            0x40\r
 147 #define IPTOS_PREC_PRIORITY             0x20\r
 148 #define IPTOS_PREC_ROUTINE              0x00\r
 149 \r
 150 \r
 151 /*\r
 152  * Commands for ioctlsocket(),  taken from the BSD file fcntl.h.\r
 153  *\r
 154  *\r
 155  * Ioctl's have the command encoded in the lower word,\r
 156  * and the size of any in or out parameters in the upper\r
 157  * word.  The high 2 bits of the upper word are used\r
 158  * to encode the in/out status of the parameter; for now\r
 159  * we restrict parameters to at most 128 bytes.\r
 160  */\r
 161 #if !defined(FIONREAD) || !defined(FIONBIO)\r
 162 #define IOCPARM_MASK    0x7f            /* parameters must be < 128 bytes */\r
 163 #define IOC_VOID        0x20000000      /* no parameters */\r
 164 #define IOC_OUT         0x40000000      /* copy out parameters */\r
 165 #define IOC_IN          0x80000000      /* copy in parameters */\r
 166 #define IOC_INOUT       (IOC_IN|IOC_OUT)\r
 167                                         /* 0x20000000 distinguishes new &\r
 168                                            old ioctl's */\r
 169 #define _IO(x,y)        (IOC_VOID|((x)<<8)|(y))\r
 170 \r
 171 #define _IOR(x,y,t)     (IOC_OUT|(((long)sizeof(t)&IOCPARM_MASK)<<16)|((x)<<8)|(y))\r
 172 \r
 173 #define _IOW(x,y,t)     (IOC_IN|(((long)sizeof(t)&IOCPARM_MASK)<<16)|((x)<<8)|(y))\r
 174 #endif\r
 175 \r
 176 #ifndef FIONREAD\r
 177 #define FIONREAD    _IOR('f', 127, unsigned long) /* get # bytes to read */\r
 178 #endif\r
 179 #ifndef FIONBIO\r
 180 #define FIONBIO     _IOW('f', 126, unsigned long) /* set/clear non-blocking i/o */\r
 181 #endif\r
 182 \r
 183 /* Socket I/O Controls */\r
 184 #ifndef SIOCSHIWAT\r
 185 #define SIOCSHIWAT  _IOW('s',  0, unsigned long)  /* set high watermark */\r
 186 #define SIOCGHIWAT  _IOR('s',  1, unsigned long)  /* get high watermark */\r
 187 #define SIOCSLOWAT  _IOW('s',  2, unsigned long)  /* set low watermark */\r
 188 #define SIOCGLOWAT  _IOR('s',  3, unsigned long)  /* get low watermark */\r
 189 #define SIOCATMARK  _IOR('s',  7, unsigned long)  /* at oob mark? */\r
 190 #endif\r
 191 \r
 192 #ifndef O_NONBLOCK\r
 193 #define O_NONBLOCK    04000U\r
 194 #endif\r
 195 \r
 196 #ifndef FD_SET\r
 197   #undef  FD_SETSIZE\r
 198   #define FD_SETSIZE    16\r
 199   #define FD_SET(n, p)  ((p)->fd_bits[(n)/8] |=  (1 << ((n) & 7)))\r
 200   #define FD_CLR(n, p)  ((p)->fd_bits[(n)/8] &= ~(1 << ((n) & 7)))\r
 201   #define FD_ISSET(n,p) ((p)->fd_bits[(n)/8] &   (1 << ((n) & 7)))\r
 202   #define FD_ZERO(p)    memset((void*)(p),0,sizeof(*(p)))\r
 203 \r
 204   typedef struct fd_set {\r
 205           unsigned char fd_bits [(FD_SETSIZE+7)/8];\r
 206         } fd_set;\r
 207 \r
 208 /* \r
 209  * only define this in sockets.c so it does not interfere\r
 210  * with other projects namespaces where timeval is present\r
 211  */ \r
 212 #ifndef LWIP_TIMEVAL_PRIVATE\r
 213 #define LWIP_TIMEVAL_PRIVATE 1\r
 214 #endif\r
 215 \r
 216 #if LWIP_TIMEVAL_PRIVATE\r
 217   struct timeval {\r
 218     long    tv_sec;         /* seconds */\r
 219     long    tv_usec;        /* and microseconds */\r
 220   };\r
 221 #endif\r
 222 \r
 223 #endif\r
 224 \r
 225 int lwip_accept(int s, struct sockaddr *addr, socklen_t *addrlen);\r
 226 int lwip_bind(int s, struct sockaddr *name, socklen_t namelen);\r
 227 int lwip_shutdown(int s, int how);\r
 228 int lwip_getpeername (int s, struct sockaddr *name, socklen_t *namelen);\r
 229 int lwip_getsockname (int s, struct sockaddr *name, socklen_t *namelen);\r
 230 int lwip_getsockopt (int s, int level, int optname, void *optval, socklen_t *optlen);\r
 231 int lwip_setsockopt (int s, int level, int optname, const void *optval, socklen_t optlen);\r
 232 int lwip_close(int s);\r
 233 int lwip_connect(int s, struct sockaddr *name, socklen_t namelen);\r
 234 int lwip_listen(int s, int backlog);\r
 235 int lwip_recv(int s, void *mem, int len, unsigned int flags);\r
 236 int lwip_read(int s, void *mem, int len);\r
 237 int lwip_recvfrom(int s, void *mem, int len, unsigned int flags,\r
 238       struct sockaddr *from, socklen_t *fromlen);\r
 239 int lwip_send(int s, void *dataptr, int size, unsigned int flags);\r
 240 int lwip_sendto(int s, void *dataptr, int size, unsigned int flags,\r
 241     struct sockaddr *to, socklen_t tolen);\r
 242 int lwip_socket(int domain, int type, int protocol);\r
 243 int lwip_write(int s, void *dataptr, int size);\r
 244 int lwip_select(int maxfdp1, fd_set *readset, fd_set *writeset, fd_set *exceptset,\r
 245                 struct timeval *timeout);\r
 246 int lwip_ioctl(int s, long cmd, void *argp);\r
 247 \r
 248 #if LWIP_COMPAT_SOCKETS\r
 249 #define accept(a,b,c)         lwip_accept(a,b,c)\r
 250 #define bind(a,b,c)           lwip_bind(a,b,c)\r
 251 #define shutdown(a,b)         lwip_shutdown(a,b)\r
 252 #define close(s)              lwip_close(s)\r
 253 #define connect(a,b,c)        lwip_connect(a,b,c)\r
 254 #define getsockname(a,b,c)    lwip_getsockname(a,b,c)\r
 255 #define getpeername(a,b,c)    lwip_getpeername(a,b,c)\r
 256 #define setsockopt(a,b,c,d,e) lwip_setsockopt(a,b,c,d,e)\r
 257 #define getsockopt(a,b,c,d,e) lwip_getsockopt(a,b,c,d,e)\r
 258 #define listen(a,b)           lwip_listen(a,b)\r
 259 #define recv(a,b,c,d)         lwip_recv(a,b,c,d)\r
 260 #define read(a,b,c)           lwip_read(a,b,c)\r
 261 #define recvfrom(a,b,c,d,e,f) lwip_recvfrom(a,b,c,d,e,f)\r
 262 #define send(a,b,c,d)         lwip_send(a,b,c,d)\r
 263 #define sendto(a,b,c,d,e,f)   lwip_sendto(a,b,c,d,e,f)\r
 264 #define socket(a,b,c)         lwip_socket(a,b,c)\r
 265 #define write(a,b,c)          lwip_write(a,b,c)\r
 266 #define select(a,b,c,d,e)     lwip_select(a,b,c,d,e)\r
 267 #define ioctlsocket(a,b,c)    lwip_ioctl(a,b,c)\r
 268 #endif /* LWIP_COMPAT_SOCKETS */\r
 269 \r
 270 #endif /* __LWIP_SOCKETS_H__ */\r
 271 \r