2 * Copyright (c) 2001-2003 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 __LWIPOPTS_H__
33 #define __LWIPOPTS_H__
37 /* Functions used to obtain and release exclusive access to the Tx buffer. The
38 Get function will block if the Tx buffer is not available - use with care! */
39 signed char *pcLwipBlockingGetTxBuffer( void );
40 void vLwipAppsReleaseTxBuffer( void );
42 #define CONFIG_LINKSPEED_AUTODETECT 1
45 #define TCPIP_THREAD_NAME "tcpip"
46 #define LWIP_HTTPD_MAX_TAG_NAME_LEN 20
47 #define LWIP_HTTPD_MAX_TAG_INSERT_LEN 1024
48 #define TCPIP_THREAD_PRIO configLWIP_TASK_PRIORITY
49 #define TCPIP_THREAD_STACKSIZE configMINIMAL_STACK_SIZE * 3
51 #define DEFAULT_TCP_RECVMBOX_SIZE 5
52 #define DEFAULT_ACCEPTMBOX_SIZE 5
53 #define TCPIP_MBOX_SIZE 10
56 #define LWIP_SOCKET (NO_SYS==0)
57 #define LWIP_NETCONN 1
63 /* DNS is not going to be used as this is a simple local example. */
66 #define LWIP_HAVE_LOOPIF 0
67 #define TCP_LISTEN_BACKLOG 0
68 #define LWIP_SO_RCVTIMEO 1
69 #define LWIP_SO_RCVBUF 1
73 #define LWIP_DBG_MIN_LEVEL 0
74 #define PPP_DEBUG LWIP_DBG_ON
75 #define MEM_DEBUG LWIP_DBG_ON
76 #define MEMP_DEBUG LWIP_DBG_ON
77 #define PBUF_DEBUG LWIP_DBG_ON
78 #define API_LIB_DEBUG LWIP_DBG_ON
79 #define API_MSG_DEBUG LWIP_DBG_ON
80 #define TCPIP_DEBUG LWIP_DBG_ON
81 #define NETIF_DEBUG LWIP_DBG_ON
82 #define SOCKETS_DEBUG LWIP_DBG_ON
83 #define DNS_DEBUG LWIP_DBG_ON
84 #define AUTOIP_DEBUG LWIP_DBG_ON
85 #define DHCP_DEBUG LWIP_DBG_ON
86 #define IP_DEBUG LWIP_DBG_ON
87 #define IP_REASS_DEBUG LWIP_DBG_ON
88 #define ICMP_DEBUG LWIP_DBG_ON
89 #define IGMP_DEBUG LWIP_DBG_ON
90 #define UDP_DEBUG LWIP_DBG_ON
91 #define TCP_DEBUG LWIP_DBG_ON
92 #define TCP_INPUT_DEBUG LWIP_DBG_ON
93 #define TCP_OUTPUT_DEBUG LWIP_DBG_ON
94 #define TCP_RTO_DEBUG LWIP_DBG_ON
95 #define TCP_CWND_DEBUG LWIP_DBG_ON
96 #define TCP_WND_DEBUG LWIP_DBG_ON
97 #define TCP_FR_DEBUG LWIP_DBG_ON
98 #define TCP_QLEN_DEBUG LWIP_DBG_ON
99 #define TCP_RST_DEBUG LWIP_DBG_ON
102 #define LWIP_DBG_TYPES_ON (LWIP_DBG_ON|LWIP_DBG_TRACE|LWIP_DBG_STATE|LWIP_DBG_FRESH|LWIP_DBG_HALT)
106 /* ---------- Memory options ---------- */
107 /* MEM_ALIGNMENT: should be set to the alignment of the CPU for which
108 lwIP is compiled. 4 byte alignment -> define MEM_ALIGNMENT to 4, 2
109 byte alignment -> define MEM_ALIGNMENT to 2. */
110 /* MSVC port: intel processors don't need 4-byte alignment,
111 but are faster that way! */
112 #define MEM_ALIGNMENT 64
114 /* MEM_SIZE: the size of the heap memory. If the application will send
115 a lot of data that needs to be copied, this should be set high. */
116 #define MEM_SIZE 0x20000
118 /* MEMP_NUM_PBUF: the number of memp struct pbufs. If the application
119 sends a lot of data out of ROM (or other static memory), this
120 should be set high. */
121 #define MEMP_NUM_PBUF 16
123 /* MEMP_NUM_RAW_PCB: the number of UDP protocol control blocks. One
124 per active RAW "connection". */
126 #define MEMP_NUM_RAW_PCB 0
128 /* MEMP_NUM_UDP_PCB: the number of UDP protocol control blocks. One
129 per active UDP "connection". */
130 #define MEMP_NUM_UDP_PCB 4
132 /* MEMP_NUM_TCP_PCB: the number of simulatenously active TCP
134 #define MEMP_NUM_TCP_PCB 32
136 /* MEMP_NUM_TCP_PCB_LISTEN: the number of listening TCP
138 #define MEMP_NUM_TCP_PCB_LISTEN 8
140 /* MEMP_NUM_TCP_SEG: the number of simultaneously queued TCP
142 #define MEMP_NUM_TCP_SEG 256
144 /* MEMP_NUM_SYS_TIMEOUT: the number of simulateously active
146 #define MEMP_NUM_SYS_TIMEOUT 8
148 /* The following four are used only with the sequential API and can be
149 set to 0 if the application only will use the raw API. */
150 /* MEMP_NUM_NETBUF: the number of struct netbufs. */
151 #define MEMP_NUM_NETBUF 8
153 /* MEMP_NUM_NETCONN: the number of struct netconns. */
154 #define MEMP_NUM_NETCONN 16
156 /* MEMP_NUM_TCPIP_MSG_*: the number of struct tcpip_msg, which is used
157 for sequential API communication and incoming packets. Used in
159 #define MEMP_NUM_TCPIP_MSG_API 4
160 #define MEMP_NUM_TCPIP_MSG_INPKT 4
162 #define MEMP_NUM_ARP_QUEUE 5
164 /* ---------- Pbuf options ---------- */
165 /* PBUF_POOL_SIZE: the number of buffers in the pbuf pool. */
166 #define PBUF_POOL_SIZE 256
168 /* PBUF_POOL_BUFSIZE: the size of each pbuf in the pbuf pool. */
169 #define PBUF_POOL_BUFSIZE 1700
171 /* PBUF_LINK_HLEN: the number of bytes that should be allocated for a
172 link level header. */
173 #define PBUF_LINK_HLEN 16
175 /** SYS_LIGHTWEIGHT_PROT
176 * define SYS_LIGHTWEIGHT_PROT in lwipopts.h if you want inter-task protection
177 * for certain critical regions during buffer allocation, deallocation and memory
178 * allocation and deallocation.
180 #define SYS_LIGHTWEIGHT_PROT (NO_SYS==0)
183 /* ---------- TCP options ---------- */
187 /* Controls if TCP should queue segments that arrive out of
188 order. Define to 0 if your device is low on memory. */
189 #define TCP_QUEUE_OOSEQ 1
191 /* TCP Maximum segment size. */
194 /* TCP sender buffer space (bytes). */
195 #define TCP_SND_BUF 8129
197 /* TCP sender buffer space (pbufs). This must be at least = 2 *
198 TCP_SND_BUF/TCP_MSS for things to work. */
199 #define TCP_SND_QUEUELEN (16 * TCP_SND_BUF/TCP_MSS)
201 #define CHECKSUM_GEN_TCP 0
202 #define CHECKSUM_GEN_UDP 0
203 #define CHECKSUM_GEN_IP 0
204 #define CHECKSUM_CHECK_TCP 0
205 #define CHECKSUM_CHECK_UDP 0
206 #define CHECKSUM_CHECK_IP 0
208 /* TCP writable space (bytes). This must be less than or equal
209 to TCP_SND_BUF. It is the amount of space which must be
210 available in the tcp snd_buf for select to return writable */
211 #define TCP_SNDLOWAT (TCP_SND_BUF/2)
213 /* TCP receive window. */
214 #define TCP_WND ( 2048 )
216 /* Maximum number of retransmissions of data segments. */
217 #define TCP_MAXRTX 12
219 /* Maximum number of retransmissions of SYN segments. */
220 #define TCP_SYNMAXRTX 4
223 /* ---------- ARP options ---------- */
225 #define ARP_TABLE_SIZE 10
226 #define ARP_QUEUEING 1
229 /* ---------- IP options ---------- */
230 /* Define IP_FORWARD to 1 if you wish to have the ability to forward
231 IP packets across network interfaces. If you are going to run lwIP
232 on a device with only one network interface, define this to 0. */
235 /* IP reassembly and segmentation.These are orthogonal even
236 * if they both deal with IP fragments */
237 #define IP_REASSEMBLY 1
238 #define IP_REASS_MAX_PBUFS 128
239 #define MEMP_NUM_REASSDATA 10
243 #define IP_FRAG_MAX_MTU 1500
244 #define IP_DEFAULT_TTL 255
245 #define LWIP_CHKSUM_ALGORITHM 3
248 /* ---------- ICMP options ---------- */
252 /* ---------- DHCP options ---------- */
253 /* Define LWIP_DHCP to 1 if you want DHCP configuration of
257 /* 1 if you want to do an ARP check on the offered address
259 #define DHCP_DOES_ARP_CHECK (LWIP_DHCP)
262 /* ---------- AUTOIP options ------- */
263 #define LWIP_AUTOIP 0
264 #define LWIP_DHCP_AUTOIP_COOP (LWIP_DHCP && LWIP_AUTOIP)
267 /* ---------- UDP options ---------- */
269 #define LWIP_UDPLITE 1
273 /* ---------- Statistics options ---------- */
276 #define LWIP_STATS_DISPLAY 0
283 #define IPFRAG_STATS 0
290 #endif /* LWIP_STATS */
293 #define NO_SYS_NO_TIMERS 1
294 #define MEMP_SEPARATE_POOLS 1
295 #define MEMP_NUM_FRAG_PBUF 256
296 #define IP_OPTIONS_ALLOWED 0
297 #define TCP_OVERSIZE TCP_MSS
298 #define LWIP_COMPAT_MUTEX 0
299 #define LWIP_ALLOW_MEM_FREE_FROM_OTHER_CONTEXT 1
302 /* ---------- PPP options ---------- */
304 #define PPP_SUPPORT 0 /* Set > 0 for PPP */
308 #define NUM_PPP 1 /* Max PPP sessions. */
310 /* Select modules to enable. Ideally these would be set in the makefile but
311 * we're limited by the command line length so you need to modify the settings
314 #define PPPOE_SUPPORT 1
315 #define PPPOS_SUPPORT 1
316 #define PAP_SUPPORT 1 /* Set > 0 for PAP. */
317 #define CHAP_SUPPORT 1 /* Set > 0 for CHAP. */
318 #define MSCHAP_SUPPORT 0 /* Set > 0 for MSCHAP (NOT FUNCTIONAL!) */
319 #define CBCP_SUPPORT 0 /* Set > 0 for CBCP (NOT FUNCTIONAL!) */
320 #define CCP_SUPPORT 0 /* Set > 0 for CCP (NOT FUNCTIONAL!) */
321 #define VJ_SUPPORT 1 /* Set > 0 for VJ header compression. */
322 #define MD5_SUPPORT 1 /* Set > 0 for MD5 (see also CHAP) */
324 #endif /* PPP_SUPPORT */
326 #endif /* __LWIPOPTS_H__ */