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#ifndef __LWIP_TCPIP_H__
33#define __LWIP_TCPIP_H__
34
35#include "lwip/opt.h"
36
37#if !NO_SYS                     /* don't build if not configured for use in lwipopts.h */
38
39#include "lwip/api_msg.h"
40#include "lwip/netifapi.h"
41#include "lwip/pbuf.h"
42#include "lwip/api.h"
43#include "lwip/sys.h"
44#include "lwip/netif.h"
45
46#ifdef __cplusplus
47extern "C" {
48#endif
49
50#if LWIP_TCPIP_CORE_LOCKING
51/** The global semaphore to lock the stack. */
52    extern sys_sem_t lock_tcpip_core;
53#define LOCK_TCPIP_CORE()     sys_sem_wait(lock_tcpip_core)
54#define UNLOCK_TCPIP_CORE()   sys_sem_signal(lock_tcpip_core)
55#define TCPIP_APIMSG(m)       tcpip_apimsg_lock(m)
56#define TCPIP_APIMSG_ACK(m)
57#define TCPIP_NETIFAPI(m)     tcpip_netifapi_lock(m)
58#define TCPIP_NETIFAPI_ACK(m)
59#else
60#define LOCK_TCPIP_CORE()
61#define UNLOCK_TCPIP_CORE()
62#define TCPIP_APIMSG(m)       tcpip_apimsg(m)
63#define TCPIP_APIMSG_ACK(m)   sys_sem_signal(m->conn->op_completed)
64#define TCPIP_NETIFAPI(m)     tcpip_netifapi(m)
65#define TCPIP_NETIFAPI_ACK(m) sys_sem_signal(m->sem)
66#endif                          /* LWIP_TCPIP_CORE_LOCKING */
67
68    void tcpip_init(void (*tcpip_init_done) (void *),
69                    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,
88                                    u8_t block);
89#define tcpip_callback(f, ctx)              tcpip_callback_with_block(f, ctx, 1)
90
91/* free pbufs or heap memory from another context without blocking */
92    err_t pbuf_free_callback(struct pbuf *p);
93    err_t mem_free_callback(void *m);
94
95    err_t tcpip_timeout(u32_t msecs, sys_timeout_handler h, void *arg);
96    err_t tcpip_untimeout(sys_timeout_handler h, void *arg);
97
98    enum tcpip_msg_type {
99#if LWIP_NETCONN
100        TCPIP_MSG_API,
101#endif                          /* LWIP_NETCONN */
102        TCPIP_MSG_INPKT,
103#if LWIP_NETIF_API
104        TCPIP_MSG_NETIFAPI,
105#endif                          /* LWIP_NETIF_API */
106        TCPIP_MSG_CALLBACK,
107        TCPIP_MSG_TIMEOUT,
108        TCPIP_MSG_UNTIMEOUT
109    };
110
111    struct tcpip_msg {
112        enum tcpip_msg_type type;
113        sys_sem_t *sem;
114        union {
115#if LWIP_NETCONN
116            struct api_msg *apimsg;
117#endif                          /* LWIP_NETCONN */
118#if LWIP_NETIF_API
119            struct netifapi_msg *netifapimsg;
120#endif                          /* LWIP_NETIF_API */
121            struct {
122                struct pbuf *p;
123                struct netif *netif;
124            } inp;
125            struct {
126                void (*f) (void *ctx);
127                void *ctx;
128            } cb;
129            struct {
130                u32_t msecs;
131                sys_timeout_handler h;
132                void *arg;
133            } tmo;
134        } msg;
135    };
136
137#ifdef __cplusplus
138}
139#endif
140#endif                          /* !NO_SYS */
141#endif                          /* __LWIP_TCPIP_H__ */
142