1 /** 2 * @file 3 * Modules initialization 4 * 5 */ 6 7 /* 8 * Copyright (c) 2001-2004 Swedish Institute of Computer Science. 9 * All rights reserved. 10 * 11 * Redistribution and use in source and binary forms, with or without modification, 12 * are permitted provided that the following conditions are met: 13 * 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. 21 * 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 31 * OF SUCH DAMAGE. 32 * 33 * This file is part of the lwIP TCP/IP stack. 34 * 35 * Author: Adam Dunkels <adam (at) sics.se> 36 * 37 */ 38 39 #include "lwip/opt.h" 40 41 #include "lwip/init.h" 42 #include "lwip/stats.h" 43 #include "lwip/sys.h" 44 #include "lwip/mem.h" 45 #include "lwip/memp.h" 46 #include "lwip/pbuf.h" 47 #include "lwip/netif.h" 48 #include "lwip/sockets.h" 49 #include "lwip/ip.h" 50 #include "lwip/raw.h" 51 #include "lwip/udp.h" 52 #include "lwip/tcp_impl.h" 53 #include "lwip/snmp_msg.h" 54 #include "lwip/autoip.h" 55 #include "lwip/igmp.h" 56 #include "lwip/dns.h" 57 #include "lwip/timers.h" 58 #include "netif/etharp.h" 59 60 /* Compile-time sanity checks for configuration errors. 61 * These can be done independently of LWIP_DEBUG, without penalty. 62 */ 63 #ifndef BYTE_ORDER 64 #error "BYTE_ORDER is not defined, you have to define it in your cc.h" 65 #endif 66 #if (!IP_SOF_BROADCAST && IP_SOF_BROADCAST_RECV) 67 #error "If you want to use broadcast filter per pcb on recv operations, you have to define IP_SOF_BROADCAST=1 in your lwipopts.h" 68 #endif 69 #if (!LWIP_ARP && ARP_QUEUEING) 70 #error "If you want to use ARP Queueing, you have to define LWIP_ARP=1 in your lwipopts.h" 71 #endif 72 #if (!LWIP_UDP && LWIP_UDPLITE) 73 #error "If you want to use UDP Lite, you have to define LWIP_UDP=1 in your lwipopts.h" 74 #endif 75 #if (!LWIP_UDP && LWIP_SNMP) 76 #error "If you want to use SNMP, you have to define LWIP_UDP=1 in your lwipopts.h" 77 #endif 78 #if (!LWIP_UDP && LWIP_DHCP) 79 #error "If you want to use DHCP, you have to define LWIP_UDP=1 in your lwipopts.h" 80 #endif 81 #if (!LWIP_UDP && LWIP_IGMP) 82 #error "If you want to use IGMP, you have to define LWIP_UDP=1 in your lwipopts.h" 83 #endif 84 #if (!LWIP_UDP && LWIP_SNMP) 85 #error "If you want to use SNMP, you have to define LWIP_UDP=1 in your lwipopts.h" 86 #endif 87 #if (!LWIP_UDP && LWIP_DNS) 88 #error "If you want to use DNS, you have to define LWIP_UDP=1 in your lwipopts.h" 89 #endif 90 #if (LWIP_ARP && ARP_QUEUEING && (MEMP_NUM_ARP_QUEUE<=0)) 91 #error "If you want to use ARP Queueing, you have to define MEMP_NUM_ARP_QUEUE>=1 in your lwipopts.h" 92 #endif 93 #if (LWIP_RAW && (MEMP_NUM_RAW_PCB<=0)) 94 #error "If you want to use RAW, you have to define MEMP_NUM_RAW_PCB>=1 in your lwipopts.h" 95 #endif 96 #if (LWIP_UDP && (MEMP_NUM_UDP_PCB<=0)) 97 #error "If you want to use UDP, you have to define MEMP_NUM_UDP_PCB>=1 in your lwipopts.h" 98 #endif 99 #if (LWIP_TCP && (MEMP_NUM_TCP_PCB<=0)) 100 #error "If you want to use TCP, you have to define MEMP_NUM_TCP_PCB>=1 in your lwipopts.h" 101 #endif 102 #if (LWIP_TCP && (TCP_WND > 0xffff)) 103 #error "If you want to use TCP, TCP_WND must fit in an u16_t, so, you have to reduce it in your lwipopts.h" 104 #endif 105 #if (LWIP_TCP && (TCP_SND_QUEUELEN > 0xffff)) 106 #error "If you want to use TCP, TCP_SND_QUEUELEN must fit in an u16_t, so, you have to reduce it in your lwipopts.h" 107 #endif 108 #if (LWIP_TCP && (TCP_SND_QUEUELEN < 2)) 109 #error "TCP_SND_QUEUELEN must be at least 2 for no-copy TCP writes to work" 110 #endif 111 #if (LWIP_TCP && ((TCP_MAXRTX > 12) || (TCP_SYNMAXRTX > 12))) 112 #error "If you want to use TCP, TCP_MAXRTX and TCP_SYNMAXRTX must less or equal to 12 (due to tcp_backoff table), so, you have to reduce them in your lwipopts.h" 113 #endif 114 #if (LWIP_TCP && TCP_LISTEN_BACKLOG && (TCP_DEFAULT_LISTEN_BACKLOG < 0) || (TCP_DEFAULT_LISTEN_BACKLOG > 0xff)) 115 #error "If you want to use TCP backlog, TCP_DEFAULT_LISTEN_BACKLOG must fit into an u8_t" 116 #endif 117 #if (LWIP_IGMP && (MEMP_NUM_IGMP_GROUP<=1)) 118 #error "If you want to use IGMP, you have to define MEMP_NUM_IGMP_GROUP>1 in your lwipopts.h" 119 #endif 120 #if (LWIP_NETIF_API && (NO_SYS==1)) 121 #error "If you want to use NETIF API, you have to define NO_SYS=0 in your lwipopts.h" 122 #endif 123 #if ((LWIP_SOCKET || LWIP_NETCONN) && (NO_SYS==1)) 124 #error "If you want to use Sequential API, you have to define NO_SYS=0 in your lwipopts.h" 125 #endif 126 #if ((LWIP_NETCONN || LWIP_SOCKET) && (MEMP_NUM_TCPIP_MSG_API<=0)) 127 #error "If you want to use Sequential API, you have to define MEMP_NUM_TCPIP_MSG_API>=1 in your lwipopts.h" 128 #endif 129 #if (!LWIP_NETCONN && LWIP_SOCKET) 130 #error "If you want to use Socket API, you have to define LWIP_NETCONN=1 in your lwipopts.h" 131 #endif 132 #if (((!LWIP_DHCP) || (!LWIP_AUTOIP)) && LWIP_DHCP_AUTOIP_COOP) 133 #error "If you want to use DHCP/AUTOIP cooperation mode, you have to define LWIP_DHCP=1 and LWIP_AUTOIP=1 in your lwipopts.h" 134 #endif 135 #if (((!LWIP_DHCP) || (!LWIP_ARP)) && DHCP_DOES_ARP_CHECK) 136 #error "If you want to use DHCP ARP checking, you have to define LWIP_DHCP=1 and LWIP_ARP=1 in your lwipopts.h" 137 #endif 138 #if (!LWIP_ARP && LWIP_AUTOIP) 139 #error "If you want to use AUTOIP, you have to define LWIP_ARP=1 in your lwipopts.h" 140 #endif 141 #if (LWIP_SNMP && (SNMP_CONCURRENT_REQUESTS<=0)) 142 #error "If you want to use SNMP, you have to define SNMP_CONCURRENT_REQUESTS>=1 in your lwipopts.h" 143 #endif 144 #if (LWIP_SNMP && (SNMP_TRAP_DESTINATIONS<=0)) 145 #error "If you want to use SNMP, you have to define SNMP_TRAP_DESTINATIONS>=1 in your lwipopts.h" 146 #endif 147 #if (LWIP_TCP && ((LWIP_EVENT_API && LWIP_CALLBACK_API) || (!LWIP_EVENT_API && !LWIP_CALLBACK_API))) 148 #error "One and exactly one of LWIP_EVENT_API and LWIP_CALLBACK_API has to be enabled in your lwipopts.h" 149 #endif 150 /* There must be sufficient timeouts, taking into account requirements of the subsystems. */ 151 #if LWIP_TIMERS && (MEMP_NUM_SYS_TIMEOUT < (LWIP_TCP + IP_REASSEMBLY + LWIP_ARP + (2*LWIP_DHCP) + LWIP_AUTOIP + LWIP_IGMP + LWIP_DNS + PPP_SUPPORT)) 152 #error "MEMP_NUM_SYS_TIMEOUT is too low to accomodate all required timeouts" 153 #endif 154 #if (IP_REASSEMBLY && (MEMP_NUM_REASSDATA > IP_REASS_MAX_PBUFS)) 155 #error "MEMP_NUM_REASSDATA > IP_REASS_MAX_PBUFS doesn't make sense since each struct ip_reassdata must hold 2 pbufs at least!" 156 #endif 157 #if (MEM_LIBC_MALLOC && MEM_USE_POOLS) 158 #error "MEM_LIBC_MALLOC and MEM_USE_POOLS may not both be simultaneously enabled in your lwipopts.h" 159 #endif 160 #if (MEM_USE_POOLS && !MEMP_USE_CUSTOM_POOLS) 161 #error "MEM_USE_POOLS requires custom pools (MEMP_USE_CUSTOM_POOLS) to be enabled in your lwipopts.h" 162 #endif 163 #if (PBUF_POOL_BUFSIZE <= MEM_ALIGNMENT) 164 #error "PBUF_POOL_BUFSIZE must be greater than MEM_ALIGNMENT or the offset may take the full first pbuf" 165 #endif 166 #if (TCP_QUEUE_OOSEQ && !LWIP_TCP) 167 #error "TCP_QUEUE_OOSEQ requires LWIP_TCP" 168 #endif 169 #if (DNS_LOCAL_HOSTLIST && !DNS_LOCAL_HOSTLIST_IS_DYNAMIC && !(defined(DNS_LOCAL_HOSTLIST_INIT))) 170 #error "you have to define define DNS_LOCAL_HOSTLIST_INIT {{'host1', 0x123}, {'host2', 0x234}} to initialize DNS_LOCAL_HOSTLIST" 171 #endif 172 #if PPP_SUPPORT && !PPPOS_SUPPORT & !PPPOE_SUPPORT 173 #error "PPP_SUPPORT needs either PPPOS_SUPPORT or PPPOE_SUPPORT turned on" 174 #endif 175 #if !LWIP_ETHERNET && (LWIP_ARP || PPPOE_SUPPORT) 176 #error "LWIP_ETHERNET needs to be turned on for LWIP_ARP or PPPOE_SUPPORT" 177 #endif 178 #if LWIP_IGMP && !defined(LWIP_RAND) 179 #error "When using IGMP, LWIP_RAND() needs to be defined to a random-function returning an u32_t random value" 180 #endif 181 #if LWIP_TCPIP_CORE_LOCKING_INPUT && !LWIP_TCPIP_CORE_LOCKING 182 #error "When using LWIP_TCPIP_CORE_LOCKING_INPUT, LWIP_TCPIP_CORE_LOCKING must be enabled, too" 183 #endif 184 #if LWIP_TCP && LWIP_NETIF_TX_SINGLE_PBUF && !TCP_OVERSIZE 185 #error "LWIP_NETIF_TX_SINGLE_PBUF needs TCP_OVERSIZE enabled to create single-pbuf TCP packets" 186 #endif 187 #if IP_FRAG && IP_FRAG_USES_STATIC_BUF && LWIP_NETIF_TX_SINGLE_PBUF 188 #error "LWIP_NETIF_TX_SINGLE_PBUF does not work with IP_FRAG_USES_STATIC_BUF==1 as that creates pbuf queues" 189 #endif 190 191 192 /* Compile-time checks for deprecated options. 193 */ 194 #ifdef MEMP_NUM_TCPIP_MSG 195 #error "MEMP_NUM_TCPIP_MSG option is deprecated. Remove it from your lwipopts.h." 196 #endif 197 #ifdef MEMP_NUM_API_MSG 198 #error "MEMP_NUM_API_MSG option is deprecated. Remove it from your lwipopts.h." 199 #endif 200 #ifdef TCP_REXMIT_DEBUG 201 #error "TCP_REXMIT_DEBUG option is deprecated. Remove it from your lwipopts.h." 202 #endif 203 #ifdef RAW_STATS 204 #error "RAW_STATS option is deprecated. Remove it from your lwipopts.h." 205 #endif 206 #ifdef ETHARP_QUEUE_FIRST 207 #error "ETHARP_QUEUE_FIRST option is deprecated. Remove it from your lwipopts.h." 208 #endif 209 #ifdef ETHARP_ALWAYS_INSERT 210 #error "ETHARP_ALWAYS_INSERT option is deprecated. Remove it from your lwipopts.h." 211 #endif 212 213 #ifdef LWIP_DEBUG 214 static void 215 lwip_sanity_check(void) 216 { 217 /* Warnings */ 218 #if LWIP_NETCONN 219 if (MEMP_NUM_NETCONN > (MEMP_NUM_TCP_PCB+MEMP_NUM_TCP_PCB_LISTEN+MEMP_NUM_UDP_PCB+MEMP_NUM_RAW_PCB)) 220 LWIP_PLATFORM_DIAG(("lwip_sanity_check: WARNING: MEMP_NUM_NETCONN should be less than the sum of MEMP_NUM_{TCP,RAW,UDP}_PCB+MEMP_NUM_TCP_PCB_LISTEN\n")); 221 #endif /* LWIP_NETCONN */ 222 #if LWIP_TCP 223 if (MEMP_NUM_TCP_SEG < TCP_SND_QUEUELEN) 224 LWIP_PLATFORM_DIAG(("lwip_sanity_check: WARNING: MEMP_NUM_TCP_SEG should be at least as big as TCP_SND_QUEUELEN\n")); 225 if (TCP_SND_BUF < 2 * TCP_MSS) 226 LWIP_PLATFORM_DIAG(("lwip_sanity_check: WARNING: TCP_SND_BUF must be at least as much as (2 * TCP_MSS) for things to work smoothly\n")); 227 if (TCP_SND_QUEUELEN < (2 * (TCP_SND_BUF/TCP_MSS))) 228 LWIP_PLATFORM_DIAG(("lwip_sanity_check: WARNING: TCP_SND_QUEUELEN must be at least as much as (2 * TCP_SND_BUF/TCP_MSS) for things to work\n")); 229 if (TCP_SNDLOWAT >= TCP_SND_BUF) 230 LWIP_PLATFORM_DIAG(("lwip_sanity_check: WARNING: TCP_SNDLOWAT must be less than TCP_SND_BUF.\n")); 231 if (TCP_SNDQUEUELOWAT >= TCP_SND_QUEUELEN) 232 LWIP_PLATFORM_DIAG(("lwip_sanity_check: WARNING: TCP_SNDQUEUELOWAT must be less than TCP_SND_QUEUELEN.\n")); 233 if (TCP_WND > (PBUF_POOL_SIZE*PBUF_POOL_BUFSIZE)) 234 LWIP_PLATFORM_DIAG(("lwip_sanity_check: WARNING: TCP_WND is larger than space provided by PBUF_POOL_SIZE*PBUF_POOL_BUFSIZE\n")); 235 if (TCP_WND < TCP_MSS) 236 LWIP_PLATFORM_DIAG(("lwip_sanity_check: WARNING: TCP_WND is smaller than MSS\n")); 237 #endif /* LWIP_TCP */ 238 #if LWIP_SOCKET 239 /* Check that the SO_* socket options and SOF_* lwIP-internal flags match */ 240 if (SO_ACCEPTCONN != SOF_ACCEPTCONN) 241 LWIP_PLATFORM_DIAG(("lwip_sanity_check: WARNING: SO_ACCEPTCONN != SOF_ACCEPTCONN\n")); 242 if (SO_REUSEADDR != SOF_REUSEADDR) 243 LWIP_PLATFORM_DIAG(("lwip_sanity_check: WARNING: SO_REUSEADDR != SOF_REUSEADDR\n")); 244 if (SO_KEEPALIVE != SOF_KEEPALIVE) 245 LWIP_PLATFORM_DIAG(("lwip_sanity_check: WARNING: SO_KEEPALIVE != SOF_KEEPALIVE\n")); 246 if (SO_BROADCAST != SOF_BROADCAST) 247 LWIP_PLATFORM_DIAG(("lwip_sanity_check: WARNING: SO_BROADCAST != SOF_BROADCAST\n")); 248 if (SO_LINGER != SOF_LINGER) 249 LWIP_PLATFORM_DIAG(("lwip_sanity_check: WARNING: SO_LINGER != SOF_LINGER\n")); 250 #endif /* LWIP_SOCKET */ 251 } 252 #else /* LWIP_DEBUG */ 253 #define lwip_sanity_check() 254 #endif /* LWIP_DEBUG */ 255 256 /** 257 * Perform Sanity check of user-configurable values, and initialize all modules. 258 */ 259 void 260 lwip_init(void) 261 { 262 /* Sanity check user-configurable values */ 263 lwip_sanity_check(); 264 265 /* Modules initialization */ 266 stats_init(); 267 #if !NO_SYS 268 sys_init(); 269 #endif /* !NO_SYS */ 270 lwip_mem_init(); 271 memp_init(); 272 pbuf_init(); 273 netif_init(); 274 #if LWIP_SOCKET 275 lwip_socket_init(); 276 #endif /* LWIP_SOCKET */ 277 ip_init(); 278 #if LWIP_ARP 279 etharp_init(); 280 #endif /* LWIP_ARP */ 281 #if LWIP_RAW 282 raw_init(); 283 #endif /* LWIP_RAW */ 284 #if LWIP_UDP 285 udp_init(); 286 #endif /* LWIP_UDP */ 287 #if LWIP_TCP 288 tcp_init(); 289 #endif /* LWIP_TCP */ 290 #if LWIP_SNMP 291 snmp_init(); 292 #endif /* LWIP_SNMP */ 293 #if LWIP_AUTOIP 294 autoip_init(); 295 #endif /* LWIP_AUTOIP */ 296 #if LWIP_IGMP 297 igmp_init(); 298 #endif /* LWIP_IGMP */ 299 #if LWIP_DNS 300 dns_init(); 301 #endif /* LWIP_DNS */ 302 303 #if LWIP_TIMERS 304 sys_timeouts_init(); 305 #endif /* LWIP_TIMERS */ 306 } 307
