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. */
151 #ifndef PBUF_LINK_HLEN
152 #define PBUF_LINK_HLEN 0
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
166 * resolution. The etharp.c implementation queues 1 packet only.
169 #define ARP_QUEUEING 1
171 /** If enabled, the first packet queued will not be overwritten by
172 * later packets. If disabled, later packets overwrite early packets
173 * in the queue. Default is disabled, which is recommended.
175 #ifndef ARP_QUEUE_FIRST
176 #define ARP_QUEUE_FIRST 0
179 /* This option is removed to comply with the ARP standard */
180 #ifdef ETHARP_ALWAYS_INSERT
181 #error ETHARP_ALWAYS_INSERT option is deprecated. Remove it from your lwipopts.h.
184 /* ---------- IP options ---------- */
185 /* Define IP_FORWARD to 1 if you wish to have the ability to forward
186 IP packets across network interfaces. If you are going to run lwIP
187 on a device with only one network interface, define this to 0. */
192 /* If defined to 1, IP options are allowed (but not parsed). If
193 defined to 0, all packets with IP options are dropped. */
198 /** IP reassembly and segmentation. Even if they both deal with IP
199 * fragments, note that these are orthogonal, one dealing with incoming
200 * packets, the other with outgoing packets
203 /** Reassemble incoming fragmented IP packets */
204 #ifndef IP_REASSEMBLY
205 #define IP_REASSEMBLY 1
208 /** Fragment outgoing IP packets if their size exceeds MTU */
213 /* ---------- ICMP options ---------- */
219 /* ---------- RAW options ---------- */
229 /* ---------- DHCP options ---------- */
235 /* 1 if you want to do an ARP check on the offered address
237 #ifndef DHCP_DOES_ARP_CHECK
238 #define DHCP_DOES_ARP_CHECK 1
241 /* ---------- UDP options ---------- */
250 /* ---------- TCP options ---------- */
264 #define TCP_MAXRTX 12
267 #ifndef TCP_SYNMAXRTX
268 #define TCP_SYNMAXRTX 6
272 /* Controls if TCP should queue segments that arrive out of
273 order. Define to 0 if your device is low on memory. */
274 #ifndef TCP_QUEUE_OOSEQ
275 #define TCP_QUEUE_OOSEQ 1
278 /* TCP Maximum segment size. */
280 #define TCP_MSS 128 /* A *very* conservative default. */
283 /* TCP sender buffer space (bytes). */
285 #define TCP_SND_BUF 256
288 /* TCP sender buffer space (pbufs). This must be at least = 2 *
289 TCP_SND_BUF/TCP_MSS for things to work. */
290 #ifndef TCP_SND_QUEUELEN
291 #define TCP_SND_QUEUELEN 4 * TCP_SND_BUF/TCP_MSS
295 /* Maximum number of retransmissions of data segments. */
297 /* Maximum number of retransmissions of SYN segments. */
299 /* TCP writable space (bytes). This must be less than or equal
300 to TCP_SND_BUF. It is the amount of space which must be
301 available in the tcp snd_buf for select to return writable */
303 #define TCP_SNDLOWAT TCP_SND_BUF/2
306 /* Support loop interface (127.0.0.1) */
307 #ifndef LWIP_HAVE_LOOPIF
308 #define LWIP_HAVE_LOOPIF 1
311 #ifndef LWIP_EVENT_API
312 #define LWIP_EVENT_API 0
313 #define LWIP_CALLBACK_API 1
315 #define LWIP_EVENT_API 1
316 #define LWIP_CALLBACK_API 0
319 #ifndef LWIP_COMPAT_SOCKETS
320 #define LWIP_COMPAT_SOCKETS 1
324 #ifndef TCPIP_THREAD_PRIO
325 #define TCPIP_THREAD_PRIO 1
328 #ifndef SLIPIF_THREAD_PRIO
329 #define SLIPIF_THREAD_PRIO 1
332 #ifndef PPP_THREAD_PRIO
333 #define PPP_THREAD_PRIO 1
336 #ifndef DEFAULT_THREAD_PRIO
337 #define DEFAULT_THREAD_PRIO 1
341 /* ---------- Socket Options ---------- */
342 /* Enable SO_REUSEADDR and SO_REUSEPORT options */
348 /* ---------- Statistics options ---------- */
355 #ifndef LWIP_STATS_DISPLAY
356 #define LWIP_STATS_DISPLAY 0
368 #define IPFRAG_STATS 1
407 #define IPFRAG_STATS 0
416 #define LWIP_STATS_DISPLAY 0
418 #endif /* LWIP_STATS */
420 /* ---------- PPP options ---------- */
423 #define PPP_SUPPORT 0 /* Set for PPP */
428 #define NUM_PPP 1 /* Max PPP sessions. */
433 #define PAP_SUPPORT 0 /* Set for PAP. */
437 #define CHAP_SUPPORT 0 /* Set for CHAP. */
440 #define MSCHAP_SUPPORT 0 /* Set for MSCHAP (NOT FUNCTIONAL!) */
441 #define CBCP_SUPPORT 0 /* Set for CBCP (NOT FUNCTIONAL!) */
442 #define CCP_SUPPORT 0 /* Set for CCP (NOT FUNCTIONAL!) */
445 #define VJ_SUPPORT 0 /* Set for VJ header compression. */
449 #define MD5_SUPPORT 0 /* Set for MD5 (see also CHAP) */
456 #define FSM_DEFTIMEOUT 6 /* Timeout time in seconds */
457 #define FSM_DEFMAXTERMREQS 2 /* Maximum Terminate-Request transmissions */
458 #define FSM_DEFMAXCONFREQS 10 /* Maximum Configure-Request transmissions */
459 #define FSM_DEFMAXNAKLOOPS 5 /* Maximum number of nak loops */
461 #define UPAP_DEFTIMEOUT 6 /* Timeout (seconds) for retransmitting req */
462 #define UPAP_DEFREQTIME 30 /* Time to wait for auth-req from peer */
464 #define CHAP_DEFTIMEOUT 6 /* Timeout time in seconds */
465 #define CHAP_DEFTRANSMITS 10 /* max # times to send challenge */
468 /* Interval in seconds between keepalive echo requests, 0 to disable. */
470 #define LCP_ECHOINTERVAL 0
472 #define LCP_ECHOINTERVAL 10
475 /* Number of unanswered echo requests before failure. */
476 #define LCP_MAXECHOFAILS 3
478 /* Max Xmit idle time (in jiffies) before resend flag char. */
479 #define PPP_MAXIDLEFLAG 100
484 * Note - lcp shouldn't be allowed to negotiate stuff outside these
485 * limits. See lcp.h in the pppd directory.
486 * (XXX - these constants should simply be shared by lcp.c instead
487 * of living in lcp.h)
489 #define PPP_MTU 1500 /* Default MTU (size of Info field) */
491 #define PPP_MAXMTU 65535 - (PPP_HDRLEN + PPP_FCSLEN)
493 #define PPP_MAXMTU 1500 /* Largest MTU we allow */
495 #define PPP_MINMTU 64
496 #define PPP_MRU 1500 /* default MRU = max length of info field */
497 #define PPP_MAXMRU 1500 /* Largest MRU we allow */
498 #define PPP_DEFMRU 296 /* Try for this */
499 #define PPP_MINMRU 128 /* No MRUs below this */
502 #define MAXNAMELEN 256 /* max length of hostname or name for auth */
503 #define MAXSECRETLEN 256 /* max length of password or secret */
505 #endif /* PPP_SUPPORT */
507 /* checksum options - set to zero for hardware checksum support */
509 #ifndef CHECKSUM_GEN_IP
510 #define CHECKSUM_GEN_IP 1
513 #ifndef CHECKSUM_GEN_UDP
514 #define CHECKSUM_GEN_UDP 1
517 #ifndef CHECKSUM_GEN_TCP
518 #define CHECKSUM_GEN_TCP 1
521 #ifndef CHECKSUM_CHECK_IP
522 #define CHECKSUM_CHECK_IP 1
525 #ifndef CHECKSUM_CHECK_UDP
526 #define CHECKSUM_CHECK_UDP 1
529 #ifndef CHECKSUM_CHECK_TCP
530 #define CHECKSUM_CHECK_TCP 1
533 /* Debugging options all default to off */
536 #define DBG_TYPES_ON 0
540 #define ETHARP_DEBUG DBG_OFF
544 #define NETIF_DEBUG DBG_OFF
548 #define PBUF_DEBUG DBG_OFF
551 #ifndef API_LIB_DEBUG
552 #define API_LIB_DEBUG DBG_OFF
555 #ifndef API_MSG_DEBUG
556 #define API_MSG_DEBUG DBG_OFF
559 #ifndef SOCKETS_DEBUG
560 #define SOCKETS_DEBUG DBG_OFF
564 #define ICMP_DEBUG DBG_OFF
568 #define INET_DEBUG DBG_OFF
572 #define IP_DEBUG DBG_OFF
575 #ifndef IP_REASS_DEBUG
576 #define IP_REASS_DEBUG DBG_OFF
580 #define RAW_DEBUG DBG_OFF
584 #define MEM_DEBUG DBG_OFF
588 #define MEMP_DEBUG DBG_OFF
592 #define SYS_DEBUG DBG_OFF
596 #define TCP_DEBUG DBG_OFF
599 #ifndef TCP_INPUT_DEBUG
600 #define TCP_INPUT_DEBUG DBG_OFF
604 #define TCP_FR_DEBUG DBG_OFF
607 #ifndef TCP_RTO_DEBUG
608 #define TCP_RTO_DEBUG DBG_OFF
611 #ifndef TCP_REXMIT_DEBUG
612 #define TCP_REXMIT_DEBUG DBG_OFF
615 #ifndef TCP_CWND_DEBUG
616 #define TCP_CWND_DEBUG DBG_OFF
619 #ifndef TCP_WND_DEBUG
620 #define TCP_WND_DEBUG DBG_OFF
623 #ifndef TCP_OUTPUT_DEBUG
624 #define TCP_OUTPUT_DEBUG DBG_OFF
627 #ifndef TCP_RST_DEBUG
628 #define TCP_RST_DEBUG DBG_OFF
631 #ifndef TCP_QLEN_DEBUG
632 #define TCP_QLEN_DEBUG DBG_OFF
636 #define UDP_DEBUG DBG_OFF
640 #define TCPIP_DEBUG DBG_OFF
644 #define PPP_DEBUG DBG_OFF
648 #define SLIP_DEBUG DBG_OFF
652 #define DHCP_DEBUG DBG_OFF
656 #ifndef DBG_MIN_LEVEL
657 #define DBG_MIN_LEVEL DBG_LEVEL_OFF
660 #endif /* __LWIP_OPT_H__ */