1 /** 2 * @file 3 * TCPIP API internal implementations (do not use in application code) 4 */ 5 6 /* 7 * Copyright (c) 2001-2004 Swedish Institute of Computer Science. 8 * All rights reserved. 9 * 10 * Redistribution and use in source and binary forms, with or without modification, 11 * are permitted provided that the following conditions are met: 12 * 13 * 1. Redistributions of source code must retain the above copyright notice, 14 * this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright notice, 16 * this list of conditions and the following disclaimer in the documentation 17 * and/or other materials provided with the distribution. 18 * 3. The name of the author may not be used to endorse or promote products 19 * derived from this software without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED 22 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 23 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 24 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 25 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 26 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 29 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 30 * OF SUCH DAMAGE. 31 * 32 * This file is part of the lwIP TCP/IP stack. 33 * 34 * Author: Adam Dunkels <adam@sics.se> 35 * 36 */ 37 #ifndef LWIP_HDR_TCPIP_PRIV_H 38 #define LWIP_HDR_TCPIP_PRIV_H 39 40 #include "lwip/opt.h" 41 42 #if !NO_SYS /* don't build if not configured for use in lwipopts.h */ 43 44 #include "lwip/tcpip.h" 45 #include "lwip/sys.h" 46 #include "lwip/timeouts.h" 47 48 #if defined (__cplusplus) && __cplusplus 49 extern "C" { 50 #endif 51 52 struct pbuf; 53 struct netif; 54 55 #if LWIP_MPU_COMPATIBLE 56 #define API_VAR_REF(name) (*(name)) 57 #define API_VAR_DECLARE(type, name) type * name 58 #define API_VAR_ALLOC(type, pool, name, errorval) do { \ 59 name = (type *)memp_malloc(pool); \ 60 if (name == NULL) { \ 61 return errorval; \ 62 } \ 63 } while (0) 64 #define API_VAR_ALLOC_POOL(type, pool, name, errorval) do { \ 65 name = (type *)LWIP_MEMPOOL_ALLOC(pool); \ 66 if (name == NULL) { \ 67 return errorval; \ 68 } \ 69 } while (0) 70 #define API_VAR_FREE(pool, name) memp_free(pool, name) 71 #define API_VAR_FREE_POOL(pool, name) LWIP_MEMPOOL_FREE(pool, name) 72 #define API_EXPR_REF(expr) (&(expr)) 73 #if LWIP_NETCONN_SEM_PER_THREAD 74 #define API_EXPR_REF_SEM(expr) (expr) 75 #else 76 #define API_EXPR_REF_SEM(expr) API_EXPR_REF(expr) 77 #endif 78 #define API_EXPR_DEREF(expr) expr 79 #define API_MSG_M_DEF(m) m 80 #define API_MSG_M_DEF_C(t, m) t m 81 #else /* LWIP_MPU_COMPATIBLE */ 82 #define API_VAR_REF(name) name 83 #define API_VAR_DECLARE(type, name) type name 84 #define API_VAR_ALLOC(type, pool, name, errorval) 85 #define API_VAR_ALLOC_POOL(type, pool, name, errorval) 86 #define API_VAR_FREE(pool, name) 87 #define API_VAR_FREE_POOL(pool, name) 88 #define API_EXPR_REF(expr) expr 89 #define API_EXPR_REF_SEM(expr) API_EXPR_REF(expr) 90 #define API_EXPR_DEREF(expr) (*(expr)) 91 #define API_MSG_M_DEF(m) *m 92 #define API_MSG_M_DEF_C(t, m) const t * m 93 #endif /* LWIP_MPU_COMPATIBLE */ 94 95 err_t tcpip_send_msg_wait_sem(tcpip_callback_fn fn, void *apimsg, sys_sem_t *sem); 96 97 struct tcpip_api_call_data { 98 #if ((!LWIP_TCPIP_CORE_LOCKING) || LWIP_API_MESH) 99 err_t err; 100 #if !LWIP_NETCONN_SEM_PER_THREAD 101 sys_sem_t sem; 102 #endif /* LWIP_NETCONN_SEM_PER_THREAD */ 103 #else /* !LWIP_TCPIP_CORE_LOCKING */ 104 u8_t dummy; /* avoid empty struct :-( */ 105 #endif /* ((!LWIP_TCPIP_CORE_LOCKING) || LWIP_API_MESH) */ 106 }; 107 typedef err_t (*tcpip_api_call_fn)(struct tcpip_api_call_data *call); 108 err_t tcpip_api_call(tcpip_api_call_fn fn, struct tcpip_api_call_data *call); 109 #if LWIP_API_MESH 110 err_t tcpip_linklayer_event_call(tcpip_api_call_fn fn, struct tcpip_api_call_data *call); 111 #endif 112 113 #if LWIP_TCP 114 void tcp_unlock_accept(ip6_addr_t *ipaddr); 115 #endif 116 117 #ifdef DUAL_MBOX 118 err_t 119 tcpip_netifapi_priority(tcpip_api_call_fn fn, struct tcpip_api_call_data *call); 120 #endif 121 enum tcpip_msg_type { 122 TCPIP_MSG_API, 123 TCPIP_MSG_API_CALL, 124 #if LWIP_API_MESH 125 TCPIP_MSG_LL_EVENT_CALL, 126 #endif 127 TCPIP_MSG_INPKT, 128 #if LWIP_TCPIP_TIMEOUT && LWIP_TIMERS 129 TCPIP_MSG_TIMEOUT, 130 TCPIP_MSG_UNTIMEOUT, 131 #endif /* LWIP_TCPIP_TIMEOUT && LWIP_TIMERS */ 132 TCPIP_MSG_CALLBACK, 133 TCPIP_MSG_CALLBACK_STATIC, 134 #if LWIP_PLC || LWIP_IEEE802154 135 TCPIP_MSG_INPKT_LLN, 136 #endif 137 #if LWIP_LOWPOWER 138 TCPIP_MSG_NA, 139 #endif 140 #if LWIP_L3_EVENT_MSG 141 TCPIP_L3_EVENT_MSG, 142 #endif 143 }; 144 145 struct tcpip_msg { 146 enum tcpip_msg_type type; 147 union { 148 struct { 149 tcpip_callback_fn function; 150 void *msg; 151 } api_msg; 152 struct { 153 tcpip_api_call_fn function; 154 struct tcpip_api_call_data *arg; 155 sys_sem_t *sem; 156 } api_call; 157 struct { 158 struct pbuf *p; 159 struct netif *netif; 160 netif_input_fn input_fn; 161 #if LWIP_PLC || LWIP_IEEE802154 162 struct linklayer_addr st_sender_mac; 163 struct linklayer_addr st_recevr_mac; 164 netif_lln_input_fn input_lln_fn; 165 #endif 166 } inp; 167 struct { 168 tcpip_callback_fn function; 169 void *ctx; 170 } cb; 171 #if LWIP_TCPIP_TIMEOUT && LWIP_TIMERS 172 struct { 173 u32_t msecs; 174 sys_timeout_handler h; 175 void *arg; 176 } tmo; 177 #endif /* LWIP_TCPIP_TIMEOUT && LWIP_TIMERS */ 178 #if LWIP_LOWPOWER 179 struct { 180 enum lowpower_msg_type type; 181 lowpower_sem_t wait_up; 182 } lowpower; 183 #endif 184 #if LWIP_L3_EVENT_MSG 185 struct { 186 enum l3_event_msg_type type; 187 void *msg; 188 } l3_event_msg; 189 #endif 190 } msg; 191 }; 192 193 #if defined (__cplusplus) && __cplusplus 194 } 195 #endif 196 197 #endif /* !NO_SYS */ 198 199 #endif /* LWIP_HDR_TCPIP_PRIV_H */ 200