2 * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
5 * Redistribution and use in source and binary forms, with or without modification,
6 * are permitted provided that the following conditions are met:
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.
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
27 * This file is part of the lwIP TCP/IP stack.
29 * Author: Adam Dunkels <adam@sics.se>
32 #ifndef __LWIP_OPT_H__
33 #define __LWIP_OPT_H__
35 /* Include user defined options first */
37 #include "lwip/debug.h"
39 /* Define default values for unconfigured parameters. */
41 /* Platform specific locking */
44 * enable SYS_LIGHTWEIGHT_PROT in lwipopts.h if you want inter-task protection
45 * for certain critical regions during buffer allocation, deallocation and memory
46 * allocation and deallocation.
48 #ifndef SYS_LIGHTWEIGHT_PROT
49 #define SYS_LIGHTWEIGHT_PROT 0
55 /* ---------- Memory options ---------- */
56 /* MEM_ALIGNMENT: should be set to the alignment of the CPU for which
57 lwIP is compiled. 4 byte alignment -> define MEM_ALIGNMENT to 4, 2
58 byte alignment -> define MEM_ALIGNMENT to 2. */
61 #define MEM_ALIGNMENT 1
64 /* MEM_SIZE: the size of the heap memory. If the application will send
65 a lot of data that needs to be copied, this should be set high. */
70 #ifndef MEMP_SANITY_CHECK
71 #define MEMP_SANITY_CHECK 0
74 /* MEMP_NUM_PBUF: the number of memp struct pbufs. If the application
75 sends a lot of data out of ROM (or other static memory), this
76 should be set high. */
78 #define MEMP_NUM_PBUF 16
81 /* Number of raw connection PCBs */
82 #ifndef MEMP_NUM_RAW_PCB
83 #define MEMP_NUM_RAW_PCB 4
86 /* MEMP_NUM_UDP_PCB: the number of UDP protocol control blocks. One
87 per active UDP "connection". */
88 #ifndef MEMP_NUM_UDP_PCB
89 #define MEMP_NUM_UDP_PCB 4
91 /* MEMP_NUM_TCP_PCB: the number of simulatenously active TCP
93 #ifndef MEMP_NUM_TCP_PCB
94 #define MEMP_NUM_TCP_PCB 5
96 /* MEMP_NUM_TCP_PCB_LISTEN: the number of listening TCP
98 #ifndef MEMP_NUM_TCP_PCB_LISTEN
99 #define MEMP_NUM_TCP_PCB_LISTEN 8
101 /* MEMP_NUM_TCP_SEG: the number of simultaneously queued TCP
103 #ifndef MEMP_NUM_TCP_SEG
104 #define MEMP_NUM_TCP_SEG 16
106 /* MEMP_NUM_SYS_TIMEOUT: the number of simulateously active
108 #ifndef MEMP_NUM_SYS_TIMEOUT
109 #define MEMP_NUM_SYS_TIMEOUT 3
112 /* The following four are used only with the sequential API and can be
113 set to 0 if the application only will use the raw API. */
114 /* MEMP_NUM_NETBUF: the number of struct netbufs. */
115 #ifndef MEMP_NUM_NETBUF
116 #define MEMP_NUM_NETBUF 2
118 /* MEMP_NUM_NETCONN: the number of struct netconns. */
119 #ifndef MEMP_NUM_NETCONN
120 #define MEMP_NUM_NETCONN 4
122 /* MEMP_NUM_APIMSG: the number of struct api_msg, used for
123 communication between the TCP/IP stack and the sequential
125 #ifndef MEMP_NUM_API_MSG
126 #define MEMP_NUM_API_MSG 8
128 /* MEMP_NUM_TCPIPMSG: the number of struct tcpip_msg, which is used
129 for sequential API communication and incoming packets. Used in
131 #ifndef MEMP_NUM_TCPIP_MSG
132 #define MEMP_NUM_TCPIP_MSG 8
135 /* ---------- Pbuf options ---------- */
136 /* PBUF_POOL_SIZE: the number of buffers in the pbuf pool. */
138 #ifndef PBUF_POOL_SIZE
139 #define PBUF_POOL_SIZE 16
142 /* PBUF_POOL_BUFSIZE: the size of each pbuf in the pbuf pool. */
144 #ifndef PBUF_POOL_BUFSIZE
145 #define PBUF_POOL_BUFSIZE 128
148 /* PBUF_LINK_HLEN: the number of bytes that should be allocated for a
149 link level header. Defaults to 14 for Ethernet. */
151 #ifndef PBUF_LINK_HLEN
152 #define PBUF_LINK_HLEN 14
157 /* ---------- ARP options ---------- */
159 /** Number of active hardware address, IP address pairs cached */
160 #ifndef ARP_TABLE_SIZE
161 #define ARP_TABLE_SIZE 10
165 * If enabled, outgoing packets are queued during hardware address
168 * This feature has not stabilized yet. Single-packet queueing is
169 * believed to be stable, multi-packet queueing is believed to
170 * clash with the TCP segment queueing.
172 * As multi-packet-queueing is currently disabled, enabling this
173 * _should_ work, but we need your testing feedback on lwip-users.
177 #define ARP_QUEUEING 1
180 /* This option is deprecated */
181 #ifdef ETHARP_QUEUE_FIRST
182 #error ETHARP_QUEUE_FIRST option is deprecated. Remove it from your lwipopts.h.
185 /* This option is removed to comply with the ARP standard */
186 #ifdef ETHARP_ALWAYS_INSERT
187 #error ETHARP_ALWAYS_INSERT option is deprecated. Remove it from your lwipopts.h.
190 /* ---------- IP options ---------- */
191 /* Define IP_FORWARD to 1 if you wish to have the ability to forward
192 IP packets across network interfaces. If you are going to run lwIP
193 on a device with only one network interface, define this to 0. */
198 /* If defined to 1, IP options are allowed (but not parsed). If
199 defined to 0, all packets with IP options are dropped. */
204 /** IP reassembly and segmentation. Even if they both deal with IP
205 * fragments, note that these are orthogonal, one dealing with incoming
206 * packets, the other with outgoing packets
209 /** Reassemble incoming fragmented IP packets */
210 #ifndef IP_REASSEMBLY
211 #define IP_REASSEMBLY 1
214 /** Fragment outgoing IP packets if their size exceeds MTU */
219 /* ---------- ICMP options ---------- */
225 /* ---------- RAW options ---------- */
235 /* ---------- DHCP options ---------- */
241 /* 1 if you want to do an ARP check on the offered address
243 #ifndef DHCP_DOES_ARP_CHECK
244 #define DHCP_DOES_ARP_CHECK 1
247 /* ---------- UDP options ---------- */
256 /* ---------- TCP options ---------- */
270 #define TCP_MAXRTX 12
273 #ifndef TCP_SYNMAXRTX
274 #define TCP_SYNMAXRTX 6
278 /* Controls if TCP should queue segments that arrive out of
279 order. Define to 0 if your device is low on memory. */
280 #ifndef TCP_QUEUE_OOSEQ
281 #define TCP_QUEUE_OOSEQ 1
284 /* TCP Maximum segment size. */
286 #define TCP_MSS 128 /* A *very* conservative default. */
289 /* TCP sender buffer space (bytes). */
291 #define TCP_SND_BUF 256
294 /* TCP sender buffer space (pbufs). This must be at least = 2 *
295 TCP_SND_BUF/TCP_MSS for things to work. */
296 #ifndef TCP_SND_QUEUELEN
297 #define TCP_SND_QUEUELEN 4 * TCP_SND_BUF/TCP_MSS
301 /* Maximum number of retransmissions of data segments. */
303 /* Maximum number of retransmissions of SYN segments. */
305 /* TCP writable space (bytes). This must be less than or equal
306 to TCP_SND_BUF. It is the amount of space which must be
307 available in the tcp snd_buf for select to return writable */
309 #define TCP_SNDLOWAT TCP_SND_BUF/2
312 /* Support loop interface (127.0.0.1) */
313 #ifndef LWIP_HAVE_LOOPIF
314 #define LWIP_HAVE_LOOPIF 0
317 #ifndef LWIP_EVENT_API
318 #define LWIP_EVENT_API 0
319 #define LWIP_CALLBACK_API 1
321 #define LWIP_EVENT_API 1
322 #define LWIP_CALLBACK_API 0
325 #ifndef LWIP_COMPAT_SOCKETS
326 #define LWIP_COMPAT_SOCKETS 1
330 #ifndef TCPIP_THREAD_PRIO
331 #define TCPIP_THREAD_PRIO 1
334 #ifndef SLIPIF_THREAD_PRIO
335 #define SLIPIF_THREAD_PRIO 1
338 #ifndef PPP_THREAD_PRIO
339 #define PPP_THREAD_PRIO 1
342 #ifndef DEFAULT_THREAD_PRIO
343 #define DEFAULT_THREAD_PRIO 1
347 /* ---------- Socket Options ---------- */
348 /* Enable SO_REUSEADDR and SO_REUSEPORT options */
351 /* I removed the lot since this was an ugly hack. It broke the raw-API.
352 It also came with many ugly goto's, Christiaan Simons. */
353 #error "SO_REUSE currently unavailable, this was a hack"
357 /* ---------- Statistics options ---------- */
364 #ifndef LWIP_STATS_DISPLAY
365 #define LWIP_STATS_DISPLAY 0
377 #define IPFRAG_STATS 1
416 #define IPFRAG_STATS 0
425 #define LWIP_STATS_DISPLAY 0
427 #endif /* LWIP_STATS */
429 /* ---------- PPP options ---------- */
432 #define PPP_SUPPORT 0 /* Set for PPP */
437 #define NUM_PPP 1 /* Max PPP sessions. */
442 #define PAP_SUPPORT 0 /* Set for PAP. */
446 #define CHAP_SUPPORT 0 /* Set for CHAP. */
449 #define MSCHAP_SUPPORT 0 /* Set for MSCHAP (NOT FUNCTIONAL!) */
450 #define CBCP_SUPPORT 0 /* Set for CBCP (NOT FUNCTIONAL!) */
451 #define CCP_SUPPORT 0 /* Set for CCP (NOT FUNCTIONAL!) */
454 #define VJ_SUPPORT 0 /* Set for VJ header compression. */
458 #define MD5_SUPPORT 0 /* Set for MD5 (see also CHAP) */
465 #define FSM_DEFTIMEOUT 6 /* Timeout time in seconds */
466 #define FSM_DEFMAXTERMREQS 2 /* Maximum Terminate-Request transmissions */
467 #define FSM_DEFMAXCONFREQS 10 /* Maximum Configure-Request transmissions */
468 #define FSM_DEFMAXNAKLOOPS 5 /* Maximum number of nak loops */
470 #define UPAP_DEFTIMEOUT 6 /* Timeout (seconds) for retransmitting req */
471 #define UPAP_DEFREQTIME 30 /* Time to wait for auth-req from peer */
473 #define CHAP_DEFTIMEOUT 6 /* Timeout time in seconds */
474 #define CHAP_DEFTRANSMITS 10 /* max # times to send challenge */
477 /* Interval in seconds between keepalive echo requests, 0 to disable. */
479 #define LCP_ECHOINTERVAL 0
481 #define LCP_ECHOINTERVAL 10
484 /* Number of unanswered echo requests before failure. */
485 #define LCP_MAXECHOFAILS 3
487 /* Max Xmit idle time (in jiffies) before resend flag char. */
488 #define PPP_MAXIDLEFLAG 100
493 * Note - lcp shouldn't be allowed to negotiate stuff outside these
494 * limits. See lcp.h in the pppd directory.
495 * (XXX - these constants should simply be shared by lcp.c instead
496 * of living in lcp.h)
498 #define PPP_MTU 1500 /* Default MTU (size of Info field) */
500 #define PPP_MAXMTU 65535 - (PPP_HDRLEN + PPP_FCSLEN)
502 #define PPP_MAXMTU 1500 /* Largest MTU we allow */
504 #define PPP_MINMTU 64
505 #define PPP_MRU 1500 /* default MRU = max length of info field */
506 #define PPP_MAXMRU 1500 /* Largest MRU we allow */
507 #define PPP_DEFMRU 296 /* Try for this */
508 #define PPP_MINMRU 128 /* No MRUs below this */
511 #define MAXNAMELEN 256 /* max length of hostname or name for auth */
512 #define MAXSECRETLEN 256 /* max length of password or secret */
514 #endif /* PPP_SUPPORT */
516 /* checksum options - set to zero for hardware checksum support */
518 #ifndef CHECKSUM_GEN_IP
519 #define CHECKSUM_GEN_IP 1
522 #ifndef CHECKSUM_GEN_UDP
523 #define CHECKSUM_GEN_UDP 1
526 #ifndef CHECKSUM_GEN_TCP
527 #define CHECKSUM_GEN_TCP 1
530 #ifndef CHECKSUM_CHECK_IP
531 #define CHECKSUM_CHECK_IP 1
534 #ifndef CHECKSUM_CHECK_UDP
535 #define CHECKSUM_CHECK_UDP 1
538 #ifndef CHECKSUM_CHECK_TCP
539 #define CHECKSUM_CHECK_TCP 1
542 /* Debugging options all default to off */
545 #define DBG_TYPES_ON 0
549 #define ETHARP_DEBUG DBG_OFF
553 #define NETIF_DEBUG DBG_OFF
557 #define PBUF_DEBUG DBG_OFF
560 #ifndef API_LIB_DEBUG
561 #define API_LIB_DEBUG DBG_OFF
564 #ifndef API_MSG_DEBUG
565 #define API_MSG_DEBUG DBG_OFF
568 #ifndef SOCKETS_DEBUG
569 #define SOCKETS_DEBUG DBG_OFF
573 #define ICMP_DEBUG DBG_OFF
577 #define INET_DEBUG DBG_OFF
581 #define IP_DEBUG DBG_OFF
584 #ifndef IP_REASS_DEBUG
585 #define IP_REASS_DEBUG DBG_OFF
589 #define RAW_DEBUG DBG_OFF
593 #define MEM_DEBUG DBG_OFF
597 #define MEMP_DEBUG DBG_OFF
601 #define SYS_DEBUG DBG_OFF
605 #define TCP_DEBUG DBG_OFF
608 #ifndef TCP_INPUT_DEBUG
609 #define TCP_INPUT_DEBUG DBG_OFF
613 #define TCP_FR_DEBUG DBG_OFF
616 #ifndef TCP_RTO_DEBUG
617 #define TCP_RTO_DEBUG DBG_OFF
620 #ifndef TCP_REXMIT_DEBUG
621 #define TCP_REXMIT_DEBUG DBG_OFF
624 #ifndef TCP_CWND_DEBUG
625 #define TCP_CWND_DEBUG DBG_OFF
628 #ifndef TCP_WND_DEBUG
629 #define TCP_WND_DEBUG DBG_OFF
632 #ifndef TCP_OUTPUT_DEBUG
633 #define TCP_OUTPUT_DEBUG DBG_OFF
636 #ifndef TCP_RST_DEBUG
637 #define TCP_RST_DEBUG DBG_OFF
640 #ifndef TCP_QLEN_DEBUG
641 #define TCP_QLEN_DEBUG DBG_OFF
645 #define UDP_DEBUG DBG_OFF
649 #define TCPIP_DEBUG DBG_OFF
653 #define PPP_DEBUG DBG_OFF
657 #define SLIP_DEBUG DBG_OFF
661 #define DHCP_DEBUG DBG_OFF
665 #ifndef DBG_MIN_LEVEL
666 #define DBG_MIN_LEVEL DBG_LEVEL_OFF
669 #endif /* __LWIP_OPT_H__ */