ZG2100 Network interface source

Committer:
donatien
Date:
Fri Aug 06 10:23:41 2010 +0000
Revision:
1:3a7c15057192
Parent:
0:b802fc31f1db

        

Who changed what in which revision?

UserRevisionLine numberNew contents of line
donatien 0:b802fc31f1db 1 /*
donatien 0:b802fc31f1db 2 * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
donatien 0:b802fc31f1db 3 * All rights reserved.
donatien 0:b802fc31f1db 4 *
donatien 0:b802fc31f1db 5 * Redistribution and use in source and binary forms, with or without modification,
donatien 0:b802fc31f1db 6 * are permitted provided that the following conditions are met:
donatien 0:b802fc31f1db 7 *
donatien 0:b802fc31f1db 8 * 1. Redistributions of source code must retain the above copyright notice,
donatien 0:b802fc31f1db 9 * this list of conditions and the following disclaimer.
donatien 0:b802fc31f1db 10 * 2. Redistributions in binary form must reproduce the above copyright notice,
donatien 0:b802fc31f1db 11 * this list of conditions and the following disclaimer in the documentation
donatien 0:b802fc31f1db 12 * and/or other materials provided with the distribution.
donatien 0:b802fc31f1db 13 * 3. The name of the author may not be used to endorse or promote products
donatien 0:b802fc31f1db 14 * derived from this software without specific prior written permission.
donatien 0:b802fc31f1db 15 *
donatien 0:b802fc31f1db 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
donatien 0:b802fc31f1db 17 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
donatien 0:b802fc31f1db 18 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
donatien 0:b802fc31f1db 19 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
donatien 0:b802fc31f1db 20 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
donatien 0:b802fc31f1db 21 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
donatien 0:b802fc31f1db 22 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
donatien 0:b802fc31f1db 23 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
donatien 0:b802fc31f1db 24 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
donatien 0:b802fc31f1db 25 * OF SUCH DAMAGE.
donatien 0:b802fc31f1db 26 *
donatien 0:b802fc31f1db 27 * This file is part of the lwIP TCP/IP stack.
donatien 0:b802fc31f1db 28 *
donatien 0:b802fc31f1db 29 * Author: Adam Dunkels <adam@sics.se>
donatien 0:b802fc31f1db 30 *
donatien 0:b802fc31f1db 31 */
donatien 0:b802fc31f1db 32 #ifndef __LWIP_API_H__
donatien 0:b802fc31f1db 33 #define __LWIP_API_H__
donatien 0:b802fc31f1db 34
donatien 0:b802fc31f1db 35 #include "lwip/opt.h"
donatien 0:b802fc31f1db 36
donatien 0:b802fc31f1db 37 #if LWIP_NETCONN /* don't build if not configured for use in lwipopts.h */
donatien 0:b802fc31f1db 38
donatien 0:b802fc31f1db 39 #include <stddef.h> /* for size_t */
donatien 0:b802fc31f1db 40
donatien 0:b802fc31f1db 41 #include "lwip/netbuf.h"
donatien 0:b802fc31f1db 42 #include "lwip/sys.h"
donatien 0:b802fc31f1db 43 #include "lwip/ip_addr.h"
donatien 0:b802fc31f1db 44 #include "lwip/err.h"
donatien 0:b802fc31f1db 45
donatien 0:b802fc31f1db 46 #ifdef __cplusplus
donatien 0:b802fc31f1db 47 extern "C" {
donatien 0:b802fc31f1db 48 #endif
donatien 0:b802fc31f1db 49
donatien 0:b802fc31f1db 50 /* Throughout this file, IP addresses and port numbers are expected to be in
donatien 0:b802fc31f1db 51 * the same byte order as in the corresponding pcb.
donatien 0:b802fc31f1db 52 */
donatien 0:b802fc31f1db 53
donatien 0:b802fc31f1db 54 /* Flags for netconn_write (u8_t) */
donatien 0:b802fc31f1db 55 #define NETCONN_NOFLAG 0x00
donatien 0:b802fc31f1db 56 #define NETCONN_NOCOPY 0x00 /* Only for source code compatibility */
donatien 0:b802fc31f1db 57 #define NETCONN_COPY 0x01
donatien 0:b802fc31f1db 58 #define NETCONN_MORE 0x02
donatien 0:b802fc31f1db 59 #define NETCONN_DONTBLOCK 0x04
donatien 0:b802fc31f1db 60
donatien 0:b802fc31f1db 61 /* Flags for struct netconn.flags (u8_t) */
donatien 0:b802fc31f1db 62 /** TCP: when data passed to netconn_write doesn't fit into the send buffer,
donatien 0:b802fc31f1db 63 this temporarily stores whether to wake up the original application task
donatien 0:b802fc31f1db 64 if data couldn't be sent in the first try. */
donatien 0:b802fc31f1db 65 #define NETCONN_FLAG_WRITE_DELAYED 0x01
donatien 0:b802fc31f1db 66 /** Should this netconn avoid blocking? */
donatien 0:b802fc31f1db 67 #define NETCONN_FLAG_NON_BLOCKING 0x02
donatien 0:b802fc31f1db 68 /** Was the last connect action a non-blocking one? */
donatien 0:b802fc31f1db 69 #define NETCONN_FLAG_IN_NONBLOCKING_CONNECT 0x04
donatien 0:b802fc31f1db 70 /** If this is set, a TCP netconn must call netconn_recved() to update
donatien 0:b802fc31f1db 71 the TCP receive window (done automatically if not set). */
donatien 0:b802fc31f1db 72 #define NETCONN_FLAG_NO_AUTO_RECVED 0x08
donatien 0:b802fc31f1db 73 /** If a nonblocking write has been rejected before, poll_tcp needs to
donatien 0:b802fc31f1db 74 check if the netconn is writable again */
donatien 0:b802fc31f1db 75 #define NETCONN_FLAG_CHECK_WRITESPACE 0x10
donatien 0:b802fc31f1db 76
donatien 0:b802fc31f1db 77
donatien 0:b802fc31f1db 78 /* Helpers to process several netconn_types by the same code */
donatien 0:b802fc31f1db 79 #define NETCONNTYPE_GROUP(t) (t&0xF0)
donatien 0:b802fc31f1db 80 #define NETCONNTYPE_DATAGRAM(t) (t&0xE0)
donatien 0:b802fc31f1db 81
donatien 0:b802fc31f1db 82 /** Protocol family and type of the netconn */
donatien 0:b802fc31f1db 83 enum netconn_type {
donatien 0:b802fc31f1db 84 NETCONN_INVALID = 0,
donatien 0:b802fc31f1db 85 /* NETCONN_TCP Group */
donatien 0:b802fc31f1db 86 NETCONN_TCP = 0x10,
donatien 0:b802fc31f1db 87 /* NETCONN_UDP Group */
donatien 0:b802fc31f1db 88 NETCONN_UDP = 0x20,
donatien 0:b802fc31f1db 89 NETCONN_UDPLITE = 0x21,
donatien 0:b802fc31f1db 90 NETCONN_UDPNOCHKSUM= 0x22,
donatien 0:b802fc31f1db 91 /* NETCONN_RAW Group */
donatien 0:b802fc31f1db 92 NETCONN_RAW = 0x40
donatien 0:b802fc31f1db 93 };
donatien 0:b802fc31f1db 94
donatien 0:b802fc31f1db 95 /** Current state of the netconn. Non-TCP netconns are always
donatien 0:b802fc31f1db 96 * in state NETCONN_NONE! */
donatien 0:b802fc31f1db 97 enum netconn_state {
donatien 0:b802fc31f1db 98 NETCONN_NONE,
donatien 0:b802fc31f1db 99 NETCONN_WRITE,
donatien 0:b802fc31f1db 100 NETCONN_LISTEN,
donatien 0:b802fc31f1db 101 NETCONN_CONNECT,
donatien 0:b802fc31f1db 102 NETCONN_CLOSE
donatien 0:b802fc31f1db 103 };
donatien 0:b802fc31f1db 104
donatien 0:b802fc31f1db 105 /** Use to inform the callback function about changes */
donatien 0:b802fc31f1db 106 enum netconn_evt {
donatien 0:b802fc31f1db 107 NETCONN_EVT_RCVPLUS,
donatien 0:b802fc31f1db 108 NETCONN_EVT_RCVMINUS,
donatien 0:b802fc31f1db 109 NETCONN_EVT_SENDPLUS,
donatien 0:b802fc31f1db 110 NETCONN_EVT_SENDMINUS,
donatien 0:b802fc31f1db 111 NETCONN_EVT_ERROR
donatien 0:b802fc31f1db 112 };
donatien 0:b802fc31f1db 113
donatien 0:b802fc31f1db 114 #if LWIP_IGMP
donatien 0:b802fc31f1db 115 /** Used for netconn_join_leave_group() */
donatien 0:b802fc31f1db 116 enum netconn_igmp {
donatien 0:b802fc31f1db 117 NETCONN_JOIN,
donatien 0:b802fc31f1db 118 NETCONN_LEAVE
donatien 0:b802fc31f1db 119 };
donatien 0:b802fc31f1db 120 #endif /* LWIP_IGMP */
donatien 0:b802fc31f1db 121
donatien 0:b802fc31f1db 122 /* forward-declare some structs to avoid to include their headers */
donatien 0:b802fc31f1db 123 struct ip_pcb;
donatien 0:b802fc31f1db 124 struct tcp_pcb;
donatien 0:b802fc31f1db 125 struct udp_pcb;
donatien 0:b802fc31f1db 126 struct raw_pcb;
donatien 0:b802fc31f1db 127 struct netconn;
donatien 0:b802fc31f1db 128 struct api_msg_msg;
donatien 0:b802fc31f1db 129
donatien 0:b802fc31f1db 130 /** A callback prototype to inform about events for a netconn */
donatien 0:b802fc31f1db 131 typedef void (* netconn_callback)(struct netconn *, enum netconn_evt, u16_t len);
donatien 0:b802fc31f1db 132
donatien 0:b802fc31f1db 133 /** A netconn descriptor */
donatien 0:b802fc31f1db 134 struct netconn {
donatien 0:b802fc31f1db 135 /** type of the netconn (TCP, UDP or RAW) */
donatien 0:b802fc31f1db 136 enum netconn_type type;
donatien 0:b802fc31f1db 137 /** current state of the netconn */
donatien 0:b802fc31f1db 138 enum netconn_state state;
donatien 0:b802fc31f1db 139 /** the lwIP internal protocol control block */
donatien 0:b802fc31f1db 140 union {
donatien 0:b802fc31f1db 141 struct ip_pcb *ip;
donatien 0:b802fc31f1db 142 struct tcp_pcb *tcp;
donatien 0:b802fc31f1db 143 struct udp_pcb *udp;
donatien 0:b802fc31f1db 144 struct raw_pcb *raw;
donatien 0:b802fc31f1db 145 } pcb;
donatien 0:b802fc31f1db 146 /** the last error this netconn had */
donatien 0:b802fc31f1db 147 err_t last_err;
donatien 0:b802fc31f1db 148 /** sem that is used to synchroneously execute functions in the core context */
donatien 0:b802fc31f1db 149 sys_sem_t op_completed;
donatien 0:b802fc31f1db 150 /** mbox where received packets are stored until they are fetched
donatien 0:b802fc31f1db 151 by the netconn application thread (can grow quite big) */
donatien 0:b802fc31f1db 152 sys_mbox_t recvmbox;
donatien 1:3a7c15057192 153 #if LWIP_TCP
donatien 0:b802fc31f1db 154 /** mbox where new connections are stored until processed
donatien 0:b802fc31f1db 155 by the application thread */
donatien 0:b802fc31f1db 156 sys_mbox_t acceptmbox;
donatien 1:3a7c15057192 157 #endif /* LWIP_TCP */
donatien 0:b802fc31f1db 158 /** only used for socket layer */
donatien 0:b802fc31f1db 159 #if LWIP_SOCKET
donatien 0:b802fc31f1db 160 int socket;
donatien 0:b802fc31f1db 161 #endif /* LWIP_SOCKET */
donatien 0:b802fc31f1db 162 #if LWIP_SO_RCVTIMEO
donatien 0:b802fc31f1db 163 /** timeout to wait for new data to be received
donatien 0:b802fc31f1db 164 (or connections to arrive for listening netconns) */
donatien 0:b802fc31f1db 165 int recv_timeout;
donatien 0:b802fc31f1db 166 #endif /* LWIP_SO_RCVTIMEO */
donatien 0:b802fc31f1db 167 #if LWIP_SO_RCVBUF
donatien 0:b802fc31f1db 168 /** maximum amount of bytes queued in recvmbox
donatien 0:b802fc31f1db 169 not used for TCP: adjust TCP_WND instead! */
donatien 0:b802fc31f1db 170 int recv_bufsize;
donatien 0:b802fc31f1db 171 #endif /* LWIP_SO_RCVBUF */
donatien 0:b802fc31f1db 172 /** number of bytes currently in recvmbox to be received,
donatien 0:b802fc31f1db 173 tested against recv_bufsize to limit bytes on recvmbox
donatien 0:b802fc31f1db 174 for UDP and RAW
donatien 0:b802fc31f1db 175 @todo: should only be necessary with LWIP_SO_RCVBUF==1 */
donatien 0:b802fc31f1db 176 s16_t recv_avail;
donatien 0:b802fc31f1db 177 /** flags holding more netconn-internal state, see NETCONN_FLAG_* defines */
donatien 0:b802fc31f1db 178 u8_t flags;
donatien 0:b802fc31f1db 179 #if LWIP_TCP
donatien 0:b802fc31f1db 180 /** TCP: when data passed to netconn_write doesn't fit into the send buffer,
donatien 0:b802fc31f1db 181 this temporarily stores how much is already sent. */
donatien 0:b802fc31f1db 182 size_t write_offset;
donatien 0:b802fc31f1db 183 /** TCP: when data passed to netconn_write doesn't fit into the send buffer,
donatien 0:b802fc31f1db 184 this temporarily stores the message.
donatien 0:b802fc31f1db 185 Also used during connect and close. */
donatien 0:b802fc31f1db 186 struct api_msg_msg *current_msg;
donatien 0:b802fc31f1db 187 #endif /* LWIP_TCP */
donatien 0:b802fc31f1db 188 /** A callback function that is informed about events for this netconn */
donatien 0:b802fc31f1db 189 netconn_callback callback;
donatien 0:b802fc31f1db 190 };
donatien 0:b802fc31f1db 191
donatien 0:b802fc31f1db 192 /** Register an Network connection event */
donatien 0:b802fc31f1db 193 #define API_EVENT(c,e,l) if (c->callback) { \
donatien 0:b802fc31f1db 194 (*c->callback)(c, e, l); \
donatien 0:b802fc31f1db 195 }
donatien 0:b802fc31f1db 196
donatien 0:b802fc31f1db 197 /** Set conn->last_err to err but don't overwrite fatal errors */
donatien 0:b802fc31f1db 198 #define NETCONN_SET_SAFE_ERR(conn, err) do { \
donatien 0:b802fc31f1db 199 SYS_ARCH_DECL_PROTECT(lev); \
donatien 0:b802fc31f1db 200 SYS_ARCH_PROTECT(lev); \
donatien 0:b802fc31f1db 201 if (!ERR_IS_FATAL((conn)->last_err)) { \
donatien 0:b802fc31f1db 202 (conn)->last_err = err; \
donatien 0:b802fc31f1db 203 } \
donatien 0:b802fc31f1db 204 SYS_ARCH_UNPROTECT(lev); \
donatien 0:b802fc31f1db 205 } while(0);
donatien 0:b802fc31f1db 206
donatien 0:b802fc31f1db 207 /* Network connection functions: */
donatien 0:b802fc31f1db 208 #define netconn_new(t) netconn_new_with_proto_and_callback(t, 0, NULL)
donatien 0:b802fc31f1db 209 #define netconn_new_with_callback(t, c) netconn_new_with_proto_and_callback(t, 0, c)
donatien 0:b802fc31f1db 210 struct
donatien 0:b802fc31f1db 211 netconn *netconn_new_with_proto_and_callback(enum netconn_type t, u8_t proto,
donatien 0:b802fc31f1db 212 netconn_callback callback);
donatien 0:b802fc31f1db 213 err_t netconn_delete(struct netconn *conn);
donatien 0:b802fc31f1db 214 /** Get the type of a netconn (as enum netconn_type). */
donatien 0:b802fc31f1db 215 #define netconn_type(conn) (conn->type)
donatien 0:b802fc31f1db 216
donatien 0:b802fc31f1db 217 err_t netconn_getaddr(struct netconn *conn, ip_addr_t *addr,
donatien 0:b802fc31f1db 218 u16_t *port, u8_t local);
donatien 0:b802fc31f1db 219 #define netconn_peer(c,i,p) netconn_getaddr(c,i,p,0)
donatien 0:b802fc31f1db 220 #define netconn_addr(c,i,p) netconn_getaddr(c,i,p,1)
donatien 0:b802fc31f1db 221
donatien 0:b802fc31f1db 222 err_t netconn_bind(struct netconn *conn, ip_addr_t *addr, u16_t port);
donatien 0:b802fc31f1db 223 err_t netconn_connect(struct netconn *conn, ip_addr_t *addr, u16_t port);
donatien 0:b802fc31f1db 224 err_t netconn_disconnect (struct netconn *conn);
donatien 0:b802fc31f1db 225 err_t netconn_listen_with_backlog(struct netconn *conn, u8_t backlog);
donatien 0:b802fc31f1db 226 #define netconn_listen(conn) netconn_listen_with_backlog(conn, TCP_DEFAULT_LISTEN_BACKLOG)
donatien 0:b802fc31f1db 227 err_t netconn_accept(struct netconn *conn, struct netconn **new_conn);
donatien 0:b802fc31f1db 228 err_t netconn_recv(struct netconn *conn, struct netbuf **new_buf);
donatien 0:b802fc31f1db 229 err_t netconn_recv_tcp_pbuf(struct netconn *conn, struct pbuf **new_buf);
donatien 0:b802fc31f1db 230 void netconn_recved(struct netconn *conn, u32_t length);
donatien 0:b802fc31f1db 231 err_t netconn_sendto(struct netconn *conn, struct netbuf *buf,
donatien 0:b802fc31f1db 232 ip_addr_t *addr, u16_t port);
donatien 0:b802fc31f1db 233 err_t netconn_send(struct netconn *conn, struct netbuf *buf);
donatien 0:b802fc31f1db 234 err_t netconn_write(struct netconn *conn, const void *dataptr, size_t size,
donatien 0:b802fc31f1db 235 u8_t apiflags);
donatien 0:b802fc31f1db 236 err_t netconn_close(struct netconn *conn);
donatien 1:3a7c15057192 237 err_t netconn_shutdown(struct netconn *conn, u8_t shut_rx, u8_t shut_tx);
donatien 0:b802fc31f1db 238
donatien 0:b802fc31f1db 239 #if LWIP_IGMP
donatien 0:b802fc31f1db 240 err_t netconn_join_leave_group(struct netconn *conn, ip_addr_t *multiaddr,
donatien 0:b802fc31f1db 241 ip_addr_t *netif_addr, enum netconn_igmp join_or_leave);
donatien 0:b802fc31f1db 242 #endif /* LWIP_IGMP */
donatien 0:b802fc31f1db 243 #if LWIP_DNS
donatien 0:b802fc31f1db 244 err_t netconn_gethostbyname(const char *name, ip_addr_t *addr);
donatien 0:b802fc31f1db 245 #endif /* LWIP_DNS */
donatien 0:b802fc31f1db 246
donatien 0:b802fc31f1db 247 #define netconn_err(conn) ((conn)->last_err)
donatien 0:b802fc31f1db 248 #define netconn_recv_bufsize(conn) ((conn)->recv_bufsize)
donatien 0:b802fc31f1db 249
donatien 0:b802fc31f1db 250 /** Set the blocking status of netconn calls (@todo: write/send is missing) */
donatien 0:b802fc31f1db 251 #define netconn_set_nonblocking(conn, val) do { if(val) { \
donatien 0:b802fc31f1db 252 (conn)->flags |= NETCONN_FLAG_NON_BLOCKING; \
donatien 0:b802fc31f1db 253 } else { \
donatien 0:b802fc31f1db 254 (conn)->flags &= ~ NETCONN_FLAG_NON_BLOCKING; }} while(0)
donatien 0:b802fc31f1db 255 /** Get the blocking status of netconn calls (@todo: write/send is missing) */
donatien 0:b802fc31f1db 256 #define netconn_is_nonblocking(conn) (((conn)->flags & NETCONN_FLAG_NON_BLOCKING) != 0)
donatien 0:b802fc31f1db 257
donatien 0:b802fc31f1db 258 /** TCP: Set the no-auto-recved status of netconn calls (see NETCONN_FLAG_NO_AUTO_RECVED) */
donatien 0:b802fc31f1db 259 #define netconn_set_noautorecved(conn, val) do { if(val) { \
donatien 0:b802fc31f1db 260 (conn)->flags |= NETCONN_FLAG_NO_AUTO_RECVED; \
donatien 0:b802fc31f1db 261 } else { \
donatien 0:b802fc31f1db 262 (conn)->flags &= ~ NETCONN_FLAG_NO_AUTO_RECVED; }} while(0)
donatien 0:b802fc31f1db 263 /** TCP: Get the no-auto-recved status of netconn calls (see NETCONN_FLAG_NO_AUTO_RECVED) */
donatien 0:b802fc31f1db 264 #define netconn_get_noautorecved(conn) (((conn)->flags & NETCONN_FLAG_NO_AUTO_RECVED) != 0)
donatien 0:b802fc31f1db 265
donatien 0:b802fc31f1db 266 #if LWIP_SO_RCVTIMEO
donatien 1:3a7c15057192 267 /** Set the receive timeout in milliseconds */
donatien 0:b802fc31f1db 268 #define netconn_set_recvtimeout(conn, timeout) ((conn)->recv_timeout = (timeout))
donatien 1:3a7c15057192 269 /** Get the receive timeout in milliseconds */
donatien 0:b802fc31f1db 270 #define netconn_get_recvtimeout(conn) ((conn)->recv_timeout)
donatien 0:b802fc31f1db 271 #endif /* LWIP_SO_RCVTIMEO */
donatien 0:b802fc31f1db 272 #if LWIP_SO_RCVBUF
donatien 0:b802fc31f1db 273 /** Set the receive buffer in bytes */
donatien 0:b802fc31f1db 274 #define netconn_set_recvbufsize(conn, recvbufsize) ((conn)->recv_bufsize = (recvbufsize))
donatien 0:b802fc31f1db 275 /** Get the receive buffer in bytes */
donatien 0:b802fc31f1db 276 #define netconn_get_recvbufsize(conn) ((conn)->recv_bufsize)
donatien 0:b802fc31f1db 277 #endif /* LWIP_SO_RCVBUF*/
donatien 0:b802fc31f1db 278
donatien 0:b802fc31f1db 279 #ifdef __cplusplus
donatien 0:b802fc31f1db 280 }
donatien 0:b802fc31f1db 281 #endif
donatien 0:b802fc31f1db 282
donatien 0:b802fc31f1db 283 #endif /* LWIP_NETCONN */
donatien 0:b802fc31f1db 284
donatien 0:b802fc31f1db 285 #endif /* __LWIP_API_H__ */