Donatien Garnier
ZG2100 Network interface source
lwip/include/lwip/tcpip.h@0:b802fc31f1db, 2010-07-09 (annotated)
- Committer:
- donatien
- Date:
- Fri Jul 09 15:37:23 2010 +0000
- Revision:
- 0:b802fc31f1db
- Child:
- 1:3a7c15057192
Who changed what in which revision?
| User | Revision | Line number | New 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_TCPIP_H__ |
| donatien | 0:b802fc31f1db | 33 | #define __LWIP_TCPIP_H__ |
| donatien | 0:b802fc31f1db | 34 | |
| donatien | 0:b802fc31f1db | 35 | #include "lwip/opt.h" |
| donatien | 0:b802fc31f1db | 36 | |
| donatien | 0:b802fc31f1db | 37 | #if !NO_SYS /* don't build if not configured for use in lwipopts.h */ |
| donatien | 0:b802fc31f1db | 38 | |
| donatien | 0:b802fc31f1db | 39 | #include "lwip/api_msg.h" |
| donatien | 0:b802fc31f1db | 40 | #include "lwip/netifapi.h" |
| donatien | 0:b802fc31f1db | 41 | #include "lwip/pbuf.h" |
| donatien | 0:b802fc31f1db | 42 | #include "lwip/api.h" |
| donatien | 0:b802fc31f1db | 43 | #include "lwip/sys.h" |
| donatien | 0:b802fc31f1db | 44 | #include "lwip/timers.h" |
| donatien | 0:b802fc31f1db | 45 | #include "lwip/netif.h" |
| donatien | 0:b802fc31f1db | 46 | |
| donatien | 0:b802fc31f1db | 47 | #ifdef __cplusplus |
| donatien | 0:b802fc31f1db | 48 | extern "C" { |
| donatien | 0:b802fc31f1db | 49 | #endif |
| donatien | 0:b802fc31f1db | 50 | |
| donatien | 0:b802fc31f1db | 51 | #if LWIP_TCPIP_CORE_LOCKING |
| donatien | 0:b802fc31f1db | 52 | /** The global semaphore to lock the stack. */ |
| donatien | 0:b802fc31f1db | 53 | extern sys_mutex_t lock_tcpip_core; |
| donatien | 0:b802fc31f1db | 54 | #define LOCK_TCPIP_CORE() sys_mutex_lock(&lock_tcpip_core) |
| donatien | 0:b802fc31f1db | 55 | #define UNLOCK_TCPIP_CORE() sys_mutex_unlock(&lock_tcpip_core) |
| donatien | 0:b802fc31f1db | 56 | #define TCPIP_APIMSG(m) tcpip_apimsg_lock(m) |
| donatien | 0:b802fc31f1db | 57 | #define TCPIP_APIMSG_ACK(m) |
| donatien | 0:b802fc31f1db | 58 | #define TCPIP_NETIFAPI(m) tcpip_netifapi_lock(m) |
| donatien | 0:b802fc31f1db | 59 | #define TCPIP_NETIFAPI_ACK(m) |
| donatien | 0:b802fc31f1db | 60 | #else /* LWIP_TCPIP_CORE_LOCKING */ |
| donatien | 0:b802fc31f1db | 61 | #define LOCK_TCPIP_CORE() |
| donatien | 0:b802fc31f1db | 62 | #define UNLOCK_TCPIP_CORE() |
| donatien | 0:b802fc31f1db | 63 | #define TCPIP_APIMSG(m) tcpip_apimsg(m) |
| donatien | 0:b802fc31f1db | 64 | #define TCPIP_APIMSG_ACK(m) sys_sem_signal(&m->conn->op_completed) |
| donatien | 0:b802fc31f1db | 65 | #define TCPIP_NETIFAPI(m) tcpip_netifapi(m) |
| donatien | 0:b802fc31f1db | 66 | #define TCPIP_NETIFAPI_ACK(m) sys_sem_signal(&m->sem) |
| donatien | 0:b802fc31f1db | 67 | #endif /* LWIP_TCPIP_CORE_LOCKING */ |
| donatien | 0:b802fc31f1db | 68 | |
| donatien | 0:b802fc31f1db | 69 | /** Function prototype for the init_done function passed to tcpip_init */ |
| donatien | 0:b802fc31f1db | 70 | typedef void (*tcpip_init_done_fn)(void *arg); |
| donatien | 0:b802fc31f1db | 71 | /** Function prototype for functions passed to tcpip_callback() */ |
| donatien | 0:b802fc31f1db | 72 | typedef void (*tcpip_callback_fn)(void *ctx); |
| donatien | 0:b802fc31f1db | 73 | |
| donatien | 0:b802fc31f1db | 74 | void tcpip_init(tcpip_init_done_fn tcpip_init_done, void *arg); |
| donatien | 0:b802fc31f1db | 75 | |
| donatien | 0:b802fc31f1db | 76 | #if LWIP_NETCONN |
| donatien | 0:b802fc31f1db | 77 | err_t tcpip_apimsg(struct api_msg *apimsg); |
| donatien | 0:b802fc31f1db | 78 | #if LWIP_TCPIP_CORE_LOCKING |
| donatien | 0:b802fc31f1db | 79 | err_t tcpip_apimsg_lock(struct api_msg *apimsg); |
| donatien | 0:b802fc31f1db | 80 | #endif /* LWIP_TCPIP_CORE_LOCKING */ |
| donatien | 0:b802fc31f1db | 81 | #endif /* LWIP_NETCONN */ |
| donatien | 0:b802fc31f1db | 82 | |
| donatien | 0:b802fc31f1db | 83 | err_t tcpip_input(struct pbuf *p, struct netif *inp); |
| donatien | 0:b802fc31f1db | 84 | |
| donatien | 0:b802fc31f1db | 85 | #if LWIP_NETIF_API |
| donatien | 0:b802fc31f1db | 86 | err_t tcpip_netifapi(struct netifapi_msg *netifapimsg); |
| donatien | 0:b802fc31f1db | 87 | #if LWIP_TCPIP_CORE_LOCKING |
| donatien | 0:b802fc31f1db | 88 | err_t tcpip_netifapi_lock(struct netifapi_msg *netifapimsg); |
| donatien | 0:b802fc31f1db | 89 | #endif /* LWIP_TCPIP_CORE_LOCKING */ |
| donatien | 0:b802fc31f1db | 90 | #endif /* LWIP_NETIF_API */ |
| donatien | 0:b802fc31f1db | 91 | |
| donatien | 0:b802fc31f1db | 92 | err_t tcpip_callback_with_block(tcpip_callback_fn function, void *ctx, u8_t block); |
| donatien | 0:b802fc31f1db | 93 | #define tcpip_callback(f, ctx) tcpip_callback_with_block(f, ctx, 1) |
| donatien | 0:b802fc31f1db | 94 | |
| donatien | 0:b802fc31f1db | 95 | /* free pbufs or heap memory from another context without blocking */ |
| donatien | 0:b802fc31f1db | 96 | err_t pbuf_free_callback(struct pbuf *p); |
| donatien | 0:b802fc31f1db | 97 | err_t mem_free_callback(void *m); |
| donatien | 0:b802fc31f1db | 98 | |
| donatien | 0:b802fc31f1db | 99 | err_t tcpip_timeout(u32_t msecs, sys_timeout_handler h, void *arg); |
| donatien | 0:b802fc31f1db | 100 | err_t tcpip_untimeout(sys_timeout_handler h, void *arg); |
| donatien | 0:b802fc31f1db | 101 | |
| donatien | 0:b802fc31f1db | 102 | enum tcpip_msg_type { |
| donatien | 0:b802fc31f1db | 103 | #if LWIP_NETCONN |
| donatien | 0:b802fc31f1db | 104 | TCPIP_MSG_API, |
| donatien | 0:b802fc31f1db | 105 | #endif /* LWIP_NETCONN */ |
| donatien | 0:b802fc31f1db | 106 | TCPIP_MSG_INPKT, |
| donatien | 0:b802fc31f1db | 107 | #if LWIP_NETIF_API |
| donatien | 0:b802fc31f1db | 108 | TCPIP_MSG_NETIFAPI, |
| donatien | 0:b802fc31f1db | 109 | #endif /* LWIP_NETIF_API */ |
| donatien | 0:b802fc31f1db | 110 | TCPIP_MSG_CALLBACK, |
| donatien | 0:b802fc31f1db | 111 | TCPIP_MSG_TIMEOUT, |
| donatien | 0:b802fc31f1db | 112 | TCPIP_MSG_UNTIMEOUT |
| donatien | 0:b802fc31f1db | 113 | }; |
| donatien | 0:b802fc31f1db | 114 | |
| donatien | 0:b802fc31f1db | 115 | struct tcpip_msg { |
| donatien | 0:b802fc31f1db | 116 | enum tcpip_msg_type type; |
| donatien | 0:b802fc31f1db | 117 | sys_sem_t *sem; |
| donatien | 0:b802fc31f1db | 118 | union { |
| donatien | 0:b802fc31f1db | 119 | #if LWIP_NETCONN |
| donatien | 0:b802fc31f1db | 120 | struct api_msg *apimsg; |
| donatien | 0:b802fc31f1db | 121 | #endif /* LWIP_NETCONN */ |
| donatien | 0:b802fc31f1db | 122 | #if LWIP_NETIF_API |
| donatien | 0:b802fc31f1db | 123 | struct netifapi_msg *netifapimsg; |
| donatien | 0:b802fc31f1db | 124 | #endif /* LWIP_NETIF_API */ |
| donatien | 0:b802fc31f1db | 125 | struct { |
| donatien | 0:b802fc31f1db | 126 | struct pbuf *p; |
| donatien | 0:b802fc31f1db | 127 | struct netif *netif; |
| donatien | 0:b802fc31f1db | 128 | } inp; |
| donatien | 0:b802fc31f1db | 129 | struct { |
| donatien | 0:b802fc31f1db | 130 | tcpip_callback_fn function; |
| donatien | 0:b802fc31f1db | 131 | void *ctx; |
| donatien | 0:b802fc31f1db | 132 | } cb; |
| donatien | 0:b802fc31f1db | 133 | struct { |
| donatien | 0:b802fc31f1db | 134 | u32_t msecs; |
| donatien | 0:b802fc31f1db | 135 | sys_timeout_handler h; |
| donatien | 0:b802fc31f1db | 136 | void *arg; |
| donatien | 0:b802fc31f1db | 137 | } tmo; |
| donatien | 0:b802fc31f1db | 138 | } msg; |
| donatien | 0:b802fc31f1db | 139 | }; |
| donatien | 0:b802fc31f1db | 140 | |
| donatien | 0:b802fc31f1db | 141 | #ifdef __cplusplus |
| donatien | 0:b802fc31f1db | 142 | } |
| donatien | 0:b802fc31f1db | 143 | #endif |
| donatien | 0:b802fc31f1db | 144 | |
| donatien | 0:b802fc31f1db | 145 | #endif /* !NO_SYS */ |
| donatien | 0:b802fc31f1db | 146 | |
| donatien | 0:b802fc31f1db | 147 | #endif /* __LWIP_TCPIP_H__ */ |