3 * Sequential API Main thread module
8 * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
11 * Redistribution and use in source and binary forms, with or without modification,
12 * are permitted provided that the following conditions are met:
14 * 1. Redistributions of source code must retain the above copyright notice,
15 * this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright notice,
17 * this list of conditions and the following disclaimer in the documentation
18 * and/or other materials provided with the distribution.
19 * 3. The name of the author may not be used to endorse or promote products
20 * derived from this software without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
23 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
24 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
25 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
26 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
27 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
30 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
33 * This file is part of the lwIP TCP/IP stack.
35 * Author: Adam Dunkels <adam@sics.se>
41 #if !NO_SYS /* don't build if not configured for use in lwipopts.h */
44 #include "lwip/memp.h"
46 #include "lwip/pbuf.h"
47 #include "lwip/tcpip.h"
48 #include "lwip/init.h"
49 #include "netif/etharp.h"
50 #include "netif/ppp_oe.h"
52 /* global variables */
53 static tcpip_init_done_fn tcpip_init_done;
54 static void *tcpip_init_done_arg;
55 static sys_mbox_t mbox;
57 #if LWIP_TCPIP_CORE_LOCKING
58 /** The global semaphore to lock the stack. */
59 sys_mutex_t lock_tcpip_core;
60 #endif /* LWIP_TCPIP_CORE_LOCKING */
64 * The main lwIP thread. This thread has exclusive access to lwIP core functions
65 * (unless access to them is not locked). Other threads communicate with this
66 * thread using message boxes.
68 * It also starts all the timers to make sure they are running in the right
71 * @param arg unused argument
74 tcpip_thread(void *arg)
76 struct tcpip_msg *msg;
79 if (tcpip_init_done != NULL) {
80 tcpip_init_done(tcpip_init_done_arg);
84 while (1) { /* MAIN Loop */
86 LWIP_TCPIP_THREAD_ALIVE();
87 /* wait for a message, timeouts are processed while waiting */
88 sys_timeouts_mbox_fetch(&mbox, (void **)&msg);
93 LWIP_DEBUGF(TCPIP_DEBUG, ("tcpip_thread: API message %p\n", (void *)msg));
94 msg->msg.apimsg->function(&(msg->msg.apimsg->msg));
96 #endif /* LWIP_NETCONN */
98 #if !LWIP_TCPIP_CORE_LOCKING_INPUT
100 LWIP_DEBUGF(TCPIP_DEBUG, ("tcpip_thread: PACKET %p\n", (void *)msg));
102 if (msg->msg.inp.netif->flags & (NETIF_FLAG_ETHARP | NETIF_FLAG_ETHERNET)) {
103 ethernet_input(msg->msg.inp.p, msg->msg.inp.netif);
105 #endif /* LWIP_ETHERNET */
107 ip_input(msg->msg.inp.p, msg->msg.inp.netif);
109 memp_free(MEMP_TCPIP_MSG_INPKT, msg);
111 #endif /* LWIP_TCPIP_CORE_LOCKING_INPUT */
114 case TCPIP_MSG_NETIFAPI:
115 LWIP_DEBUGF(TCPIP_DEBUG, ("tcpip_thread: Netif API message %p\n", (void *)msg));
116 msg->msg.netifapimsg->function(&(msg->msg.netifapimsg->msg));
118 #endif /* LWIP_NETIF_API */
120 case TCPIP_MSG_CALLBACK:
121 LWIP_DEBUGF(TCPIP_DEBUG, ("tcpip_thread: CALLBACK %p\n", (void *)msg));
122 msg->msg.cb.function(msg->msg.cb.ctx);
123 memp_free(MEMP_TCPIP_MSG_API, msg);
126 #if LWIP_TCPIP_TIMEOUT
127 case TCPIP_MSG_TIMEOUT:
128 LWIP_DEBUGF(TCPIP_DEBUG, ("tcpip_thread: TIMEOUT %p\n", (void *)msg));
129 sys_timeout(msg->msg.tmo.msecs, msg->msg.tmo.h, msg->msg.tmo.arg);
130 memp_free(MEMP_TCPIP_MSG_API, msg);
132 case TCPIP_MSG_UNTIMEOUT:
133 LWIP_DEBUGF(TCPIP_DEBUG, ("tcpip_thread: UNTIMEOUT %p\n", (void *)msg));
134 sys_untimeout(msg->msg.tmo.h, msg->msg.tmo.arg);
135 memp_free(MEMP_TCPIP_MSG_API, msg);
137 #endif /* LWIP_TCPIP_TIMEOUT */
140 LWIP_DEBUGF(TCPIP_DEBUG, ("tcpip_thread: invalid message: %d\n", msg->type));
141 LWIP_ASSERT("tcpip_thread: invalid message", 0);
148 * Pass a received packet to tcpip_thread for input processing
150 * @param p the received packet, p->payload pointing to the Ethernet header or
151 * to an IP header (if inp doesn't have NETIF_FLAG_ETHARP or
152 * NETIF_FLAG_ETHERNET flags)
153 * @param inp the network interface on which the packet was received
156 tcpip_input(struct pbuf *p, struct netif *inp)
158 #if LWIP_TCPIP_CORE_LOCKING_INPUT
160 LWIP_DEBUGF(TCPIP_DEBUG, ("tcpip_input: PACKET %p/%p\n", (void *)p, (void *)inp));
163 if (inp->flags & (NETIF_FLAG_ETHARP | NETIF_FLAG_ETHERNET)) {
164 ret = ethernet_input(p, inp);
166 #endif /* LWIP_ETHERNET */
168 ret = ip_input(p, inp);
172 #else /* LWIP_TCPIP_CORE_LOCKING_INPUT */
173 struct tcpip_msg *msg;
175 if (sys_mbox_valid(&mbox)) {
176 msg = (struct tcpip_msg *)memp_malloc(MEMP_TCPIP_MSG_INPKT);
181 msg->type = TCPIP_MSG_INPKT;
183 msg->msg.inp.netif = inp;
184 if (sys_mbox_trypost(&mbox, msg) != ERR_OK) {
185 memp_free(MEMP_TCPIP_MSG_INPKT, msg);
191 #endif /* LWIP_TCPIP_CORE_LOCKING_INPUT */
195 * Call a specific function in the thread context of
196 * tcpip_thread for easy access synchronization.
197 * A function called in that way may access lwIP core code
198 * without fearing concurrent access.
200 * @param f the function to call
201 * @param ctx parameter passed to f
202 * @param block 1 to block until the request is posted, 0 to non-blocking mode
203 * @return ERR_OK if the function was called, another err_t if not
206 tcpip_callback_with_block(tcpip_callback_fn function, void *ctx, u8_t block)
208 struct tcpip_msg *msg;
210 if (sys_mbox_valid(&mbox)) {
211 msg = (struct tcpip_msg *)memp_malloc(MEMP_TCPIP_MSG_API);
216 msg->type = TCPIP_MSG_CALLBACK;
217 msg->msg.cb.function = function;
218 msg->msg.cb.ctx = ctx;
220 sys_mbox_post(&mbox, msg);
222 if (sys_mbox_trypost(&mbox, msg) != ERR_OK) {
223 memp_free(MEMP_TCPIP_MSG_API, msg);
232 #if LWIP_TCPIP_TIMEOUT
234 * call sys_timeout in tcpip_thread
236 * @param msec time in milliseconds for timeout
237 * @param h function to be called on timeout
238 * @param arg argument to pass to timeout function h
239 * @return ERR_MEM on memory error, ERR_OK otherwise
242 tcpip_timeout(u32_t msecs, sys_timeout_handler h, void *arg)
244 struct tcpip_msg *msg;
246 if (sys_mbox_valid(&mbox)) {
247 msg = (struct tcpip_msg *)memp_malloc(MEMP_TCPIP_MSG_API);
252 msg->type = TCPIP_MSG_TIMEOUT;
253 msg->msg.tmo.msecs = msecs;
255 msg->msg.tmo.arg = arg;
256 sys_mbox_post(&mbox, msg);
263 * call sys_untimeout in tcpip_thread
265 * @param msec time in milliseconds for timeout
266 * @param h function to be called on timeout
267 * @param arg argument to pass to timeout function h
268 * @return ERR_MEM on memory error, ERR_OK otherwise
271 tcpip_untimeout(sys_timeout_handler h, void *arg)
273 struct tcpip_msg *msg;
275 if (sys_mbox_valid(&mbox)) {
276 msg = (struct tcpip_msg *)memp_malloc(MEMP_TCPIP_MSG_API);
281 msg->type = TCPIP_MSG_UNTIMEOUT;
283 msg->msg.tmo.arg = arg;
284 sys_mbox_post(&mbox, msg);
289 #endif /* LWIP_TCPIP_TIMEOUT */
293 * Call the lower part of a netconn_* function
294 * This function is then running in the thread context
295 * of tcpip_thread and has exclusive access to lwIP core code.
297 * @param apimsg a struct containing the function to call and its parameters
298 * @return ERR_OK if the function was called, another err_t if not
301 tcpip_apimsg(struct api_msg *apimsg)
303 struct tcpip_msg msg;
305 /* catch functions that don't set err */
306 apimsg->msg.err = ERR_VAL;
309 if (sys_mbox_valid(&mbox)) {
310 msg.type = TCPIP_MSG_API;
311 msg.msg.apimsg = apimsg;
312 sys_mbox_post(&mbox, &msg);
313 sys_arch_sem_wait(&apimsg->msg.conn->op_completed, 0);
314 return apimsg->msg.err;
319 #if LWIP_TCPIP_CORE_LOCKING
321 * Call the lower part of a netconn_* function
322 * This function has exclusive access to lwIP core code by locking it
323 * before the function is called.
325 * @param apimsg a struct containing the function to call and its parameters
326 * @return ERR_OK (only for compatibility fo tcpip_apimsg())
329 tcpip_apimsg_lock(struct api_msg *apimsg)
332 /* catch functions that don't set err */
333 apimsg->msg.err = ERR_VAL;
337 apimsg->function(&(apimsg->msg));
339 return apimsg->msg.err;
342 #endif /* LWIP_TCPIP_CORE_LOCKING */
343 #endif /* LWIP_NETCONN */
346 #if !LWIP_TCPIP_CORE_LOCKING
348 * Much like tcpip_apimsg, but calls the lower part of a netifapi_*
351 * @param netifapimsg a struct containing the function to call and its parameters
352 * @return error code given back by the function that was called
355 tcpip_netifapi(struct netifapi_msg* netifapimsg)
357 struct tcpip_msg msg;
359 if (sys_mbox_valid(&mbox)) {
360 err_t err = sys_sem_new(&netifapimsg->msg.sem, 0);
362 netifapimsg->msg.err = err;
366 msg.type = TCPIP_MSG_NETIFAPI;
367 msg.msg.netifapimsg = netifapimsg;
368 sys_mbox_post(&mbox, &msg);
369 sys_sem_wait(&netifapimsg->msg.sem);
370 sys_sem_free(&netifapimsg->msg.sem);
371 return netifapimsg->msg.err;
375 #else /* !LWIP_TCPIP_CORE_LOCKING */
377 * Call the lower part of a netifapi_* function
378 * This function has exclusive access to lwIP core code by locking it
379 * before the function is called.
381 * @param netifapimsg a struct containing the function to call and its parameters
382 * @return ERR_OK (only for compatibility fo tcpip_netifapi())
385 tcpip_netifapi_lock(struct netifapi_msg* netifapimsg)
388 netifapimsg->function(&(netifapimsg->msg));
390 return netifapimsg->msg.err;
392 #endif /* !LWIP_TCPIP_CORE_LOCKING */
393 #endif /* LWIP_NETIF_API */
396 * Initialize this module:
397 * - initialize all sub modules
398 * - start the tcpip_thread
400 * @param initfunc a function to call when tcpip_thread is running and finished initializing
401 * @param arg argument to pass to initfunc
404 tcpip_init(tcpip_init_done_fn initfunc, void *arg)
408 tcpip_init_done = initfunc;
409 tcpip_init_done_arg = arg;
410 if(sys_mbox_new(&mbox, TCPIP_MBOX_SIZE) != ERR_OK) {
411 LWIP_ASSERT("failed to create tcpip_thread mbox", 0);
413 #if LWIP_TCPIP_CORE_LOCKING
414 if(sys_mutex_new(&lock_tcpip_core) != ERR_OK) {
415 LWIP_ASSERT("failed to create lock_tcpip_core", 0);
417 #endif /* LWIP_TCPIP_CORE_LOCKING */
419 sys_thread_new(TCPIP_THREAD_NAME, tcpip_thread, NULL, TCPIP_THREAD_STACKSIZE, TCPIP_THREAD_PRIO);
423 * Simple callback function used with tcpip_callback to free a pbuf
424 * (pbuf_free has a wrong signature for tcpip_callback)
426 * @param p The pbuf (chain) to be dereferenced.
429 pbuf_free_int(void *p)
431 struct pbuf *q = (struct pbuf *)p;
436 * A simple wrapper function that allows you to free a pbuf from interrupt context.
438 * @param p The pbuf (chain) to be dereferenced.
439 * @return ERR_OK if callback could be enqueued, an err_t if not
442 pbuf_free_callback(struct pbuf *p)
444 return tcpip_callback_with_block(pbuf_free_int, p, 0);
448 * A simple wrapper function that allows you to free heap memory from
451 * @param m the heap memory to free
452 * @return ERR_OK if callback could be enqueued, an err_t if not
455 mem_free_callback(void *m)
457 return tcpip_callback_with_block(mem_free, m, 0);