tcpip.h

00001 /*
00002  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
00003  * All rights reserved. 
00004  * 
00005  * Redistribution and use in source and binary forms, with or without modification, 
00006  * are permitted provided that the following conditions are met:
00007  *
00008  * 1. Redistributions of source code must retain the above copyright notice,
00009  *    this list of conditions and the following disclaimer.
00010  * 2. Redistributions in binary form must reproduce the above copyright notice,
00011  *    this list of conditions and the following disclaimer in the documentation
00012  *    and/or other materials provided with the distribution.
00013  * 3. The name of the author may not be used to endorse or promote products
00014  *    derived from this software without specific prior written permission. 
00015  *
00016  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED 
00017  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
00018  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 
00019  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
00020  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 
00021  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
00022  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
00023  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 
00024  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 
00025  * OF SUCH DAMAGE.
00026  *
00027  * This file is part of the lwIP TCP/IP stack.
00028  * 
00029  * Author: Adam Dunkels <adam@sics.se>
00030  *
00031  */
00032 #ifndef __LWIP_TCPIP_H__
00033 #define __LWIP_TCPIP_H__
00034 
00035 #include "lwip/opt.h"
00036 
00037 #if !NO_SYS /* don't build if not configured for use in lwipopts.h */
00038 
00039 #include "lwip/api_msg.h"
00040 #include "lwip/netifapi.h"
00041 #include "lwip/pbuf.h"
00042 #include "lwip/api.h"
00043 #include "lwip/sys.h"
00044 #include "lwip/timers.h"
00045 #include "lwip/netif.h"
00046 
00047 #ifdef __cplusplus
00048 extern "C" {
00049 #endif
00050 
00051 #if LWIP_TCPIP_CORE_LOCKING
00052 /** The global semaphore to lock the stack. */
00053 extern sys_mutex_t lock_tcpip_core;
00054 #define LOCK_TCPIP_CORE()     sys_mutex_lock(&lock_tcpip_core)
00055 #define UNLOCK_TCPIP_CORE()   sys_mutex_unlock(&lock_tcpip_core)
00056 #define TCPIP_APIMSG(m)       tcpip_apimsg_lock(m)
00057 #define TCPIP_APIMSG_ACK(m)
00058 #define TCPIP_NETIFAPI(m)     tcpip_netifapi_lock(m)
00059 #define TCPIP_NETIFAPI_ACK(m)
00060 #else /* LWIP_TCPIP_CORE_LOCKING */
00061 #define LOCK_TCPIP_CORE()
00062 #define UNLOCK_TCPIP_CORE()
00063 #define TCPIP_APIMSG(m)       tcpip_apimsg(m)
00064 #define TCPIP_APIMSG_ACK(m)   sys_sem_signal(&m->conn->op_completed)
00065 #define TCPIP_NETIFAPI(m)     tcpip_netifapi(m)
00066 #define TCPIP_NETIFAPI_ACK(m) sys_sem_signal(&m->sem)
00067 #endif /* LWIP_TCPIP_CORE_LOCKING */
00068 
00069 /** Function prototype for the init_done function passed to tcpip_init */
00070 typedef void (*tcpip_init_done_fn)(void *arg);
00071 /** Function prototype for functions passed to tcpip_callback() */
00072 typedef void (*tcpip_callback_fn)(void *ctx);
00073 
00074 void tcpip_init(tcpip_init_done_fn tcpip_init_done, void *arg);
00075 
00076 #if LWIP_NETCONN
00077 err_t tcpip_apimsg(struct api_msg *apimsg);
00078 #if LWIP_TCPIP_CORE_LOCKING
00079 err_t tcpip_apimsg_lock(struct api_msg *apimsg);
00080 #endif /* LWIP_TCPIP_CORE_LOCKING */
00081 #endif /* LWIP_NETCONN */
00082 
00083 err_t tcpip_input(struct pbuf *p, struct netif *inp);
00084 
00085 #if LWIP_NETIF_API
00086 err_t tcpip_netifapi(struct netifapi_msg *netifapimsg);
00087 #if LWIP_TCPIP_CORE_LOCKING
00088 err_t tcpip_netifapi_lock(struct netifapi_msg *netifapimsg);
00089 #endif /* LWIP_TCPIP_CORE_LOCKING */
00090 #endif /* LWIP_NETIF_API */
00091 
00092 err_t tcpip_callback_with_block(tcpip_callback_fn function, void *ctx, u8_t block);
00093 #define tcpip_callback(f, ctx)              tcpip_callback_with_block(f, ctx, 1)
00094 
00095 /* free pbufs or heap memory from another context without blocking */
00096 err_t pbuf_free_callback(struct pbuf *p);
00097 err_t mem_free_callback(void *m);
00098 
00099 err_t tcpip_timeout(u32_t msecs, sys_timeout_handler h, void *arg);
00100 err_t tcpip_untimeout(sys_timeout_handler h, void *arg);
00101 
00102 enum tcpip_msg_type {
00103 #if LWIP_NETCONN
00104   TCPIP_MSG_API,
00105 #endif /* LWIP_NETCONN */
00106   TCPIP_MSG_INPKT,
00107 #if LWIP_NETIF_API
00108   TCPIP_MSG_NETIFAPI,
00109 #endif /* LWIP_NETIF_API */
00110   TCPIP_MSG_CALLBACK,
00111   TCPIP_MSG_TIMEOUT,
00112   TCPIP_MSG_UNTIMEOUT
00113 };
00114 
00115 struct tcpip_msg {
00116   enum tcpip_msg_type type;
00117   sys_sem_t *sem;
00118   union {
00119 #if LWIP_NETCONN
00120     struct api_msg *apimsg;
00121 #endif /* LWIP_NETCONN */
00122 #if LWIP_NETIF_API
00123     struct netifapi_msg *netifapimsg;
00124 #endif /* LWIP_NETIF_API */
00125     struct {
00126       struct pbuf *p;
00127       struct netif *netif;
00128     } inp;
00129     struct {
00130       tcpip_callback_fn function;
00131       void *ctx;
00132     } cb;
00133     struct {
00134       u32_t msecs;
00135       sys_timeout_handler h;
00136       void *arg;
00137     } tmo;
00138   } msg;
00139 };
00140 
00141 #ifdef __cplusplus
00142 }
00143 #endif
00144 
00145 #endif /* !NO_SYS */
00146 
00147 #endif /* __LWIP_TCPIP_H__ */