First run at integrating LWIP into the tree (again)
[akaros.git] / user / lwip / include / lwip / tcpip.h
1 /*
2  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
3  * All rights reserved. 
4  * 
5  * Redistribution and use in source and binary forms, with or without modification, 
6  * are permitted provided that the following conditions are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright notice,
9  *    this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright notice,
11  *    this list of conditions and the following disclaimer in the documentation
12  *    and/or other materials provided with the distribution.
13  * 3. The name of the author may not be used to endorse or promote products
14  *    derived from this software without specific prior written permission. 
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED 
17  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
18  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 
19  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 
21  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
22  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
23  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 
24  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 
25  * OF SUCH DAMAGE.
26  *
27  * This file is part of the lwIP TCP/IP stack.
28  * 
29  * Author: Adam Dunkels <adam@sics.se>
30  *
31  */
32
33 #ifndef __LWIP_TCPIP_H__
34 #define __LWIP_TCPIP_H__
35
36 #include "lwip/opt.h"
37
38 #if !NO_SYS /* don't build if not configured for use in lwipopts.h */
39
40 #include "lwip/api_msg.h"
41 #include "lwip/netifapi.h"
42 #include "lwip/pbuf.h"
43 #include "lwip/api.h"
44 #include "lwip/sys.h"
45 #include "lwip/netif.h"
46
47 #ifdef __cplusplus
48 extern "C" {
49 #endif
50
51 #if LWIP_TCPIP_CORE_LOCKING
52 /** The global semaphore to lock the stack. */
53 extern sys_sem_t lock_tcpip_core;
54 #define LOCK_TCPIP_CORE()     sys_sem_wait(lock_tcpip_core)
55 #define UNLOCK_TCPIP_CORE()   sys_sem_signal(lock_tcpip_core)
56 #define TCPIP_APIMSG(m)       tcpip_apimsg_lock(m)
57 #define TCPIP_APIMSG_ACK(m)
58 #define TCPIP_NETIFAPI(m)     tcpip_netifapi_lock(m)
59 #define TCPIP_NETIFAPI_ACK(m)
60 #else
61 #define LOCK_TCPIP_CORE()
62 #define UNLOCK_TCPIP_CORE()
63 #define TCPIP_APIMSG(m)       tcpip_apimsg(m)
64 #define TCPIP_APIMSG_ACK(m)   sys_sem_signal(m->conn->op_completed)
65 #define TCPIP_NETIFAPI(m)     tcpip_netifapi(m)
66 #define TCPIP_NETIFAPI_ACK(m) sys_sem_signal(m->sem)
67 #endif /* LWIP_TCPIP_CORE_LOCKING */
68
69 void tcpip_init(void (* tcpip_init_done)(void *), void *arg);
70
71 #if LWIP_NETCONN
72 err_t tcpip_apimsg(struct api_msg *apimsg);
73 #if LWIP_TCPIP_CORE_LOCKING
74 err_t tcpip_apimsg_lock(struct api_msg *apimsg);
75 #endif /* LWIP_TCPIP_CORE_LOCKING */
76 #endif /* LWIP_NETCONN */
77
78 err_t tcpip_input(struct pbuf *p, struct netif *inp);
79
80 #if LWIP_NETIF_API
81 err_t tcpip_netifapi(struct netifapi_msg *netifapimsg);
82 #if LWIP_TCPIP_CORE_LOCKING
83 err_t tcpip_netifapi_lock(struct netifapi_msg *netifapimsg);
84 #endif /* LWIP_TCPIP_CORE_LOCKING */
85 #endif /* LWIP_NETIF_API */
86
87 err_t tcpip_callback_with_block(void (*f)(void *ctx), void *ctx, u8_t block);
88 #define tcpip_callback(f, ctx)              tcpip_callback_with_block(f, ctx, 1)
89
90 /* free pbufs or heap memory from another context without blocking */
91 err_t pbuf_free_callback(struct pbuf *p);
92 err_t mem_free_callback(void *m);
93
94 err_t tcpip_timeout(u32_t msecs, sys_timeout_handler h, void *arg);
95 err_t tcpip_untimeout(sys_timeout_handler h, void *arg);
96
97 enum tcpip_msg_type {
98 #if LWIP_NETCONN
99   TCPIP_MSG_API,
100 #endif /* LWIP_NETCONN */
101   TCPIP_MSG_INPKT,
102 #if LWIP_NETIF_API
103   TCPIP_MSG_NETIFAPI,
104 #endif /* LWIP_NETIF_API */
105   TCPIP_MSG_CALLBACK,
106   TCPIP_MSG_TIMEOUT,
107   TCPIP_MSG_UNTIMEOUT
108 };
109
110 struct tcpip_msg {
111   enum tcpip_msg_type type;
112   sys_sem_t *sem;
113   union {
114 #if LWIP_NETCONN
115     struct api_msg *apimsg;
116 #endif /* LWIP_NETCONN */
117 #if LWIP_NETIF_API
118     struct netifapi_msg *netifapimsg;
119 #endif /* LWIP_NETIF_API */
120     struct {
121       struct pbuf *p;
122       struct netif *netif;
123     } inp;
124     struct {
125       void (*f)(void *ctx);
126       void *ctx;
127     } cb;
128     struct {
129       u32_t msecs;
130       sys_timeout_handler h;
131       void *arg;
132     } tmo;
133   } msg;
134 };
135
136 #ifdef __cplusplus
137 }
138 #endif
139
140 #endif /* !NO_SYS */
141
142 #endif /* __LWIP_TCPIP_H__ */