RetroArch
opt.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without modification,
6  * are permitted provided that the following conditions are met:
7  *
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.
15  *
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
25  * OF SUCH DAMAGE.
26  *
27  * This file is part of the lwIP TCP/IP stack.
28  *
29  * Author: Adam Dunkels <[email protected]>
30  *
31  */
32 #ifndef __LWIP_OPT_H__
33 #define __LWIP_OPT_H__
34 
35 /* Include user defined options first */
36 #include "lwipopts.h"
37 #include "lwip/debug.h"
38 
39 /* Define default values for unconfigured parameters. */
40 
41 /* Platform specific locking */
42 
43 /*
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.
47  */
48 #ifndef SYS_LIGHTWEIGHT_PROT
49 #define SYS_LIGHTWEIGHT_PROT 0
50 #endif
51 
52 #ifndef NO_SYS
53 #define NO_SYS 0
54 #endif
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. */
59 
60 #ifndef MEM_ALIGNMENT
61 #define MEM_ALIGNMENT 1
62 #endif
63 
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. */
66 #ifndef MEM_SIZE
67 #define MEM_SIZE 1600
68 #endif
69 
70 #ifndef MEMP_SANITY_CHECK
71 #define MEMP_SANITY_CHECK 0
72 #endif
73 
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. */
77 #ifndef MEMP_NUM_PBUF
78 #define MEMP_NUM_PBUF 16
79 #endif
80 
81 /* Number of raw connection PCBs */
82 #ifndef MEMP_NUM_RAW_PCB
83 #define MEMP_NUM_RAW_PCB 4
84 #endif
85 
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
90 #endif
91 /* MEMP_NUM_TCP_PCB: the number of simulatenously active TCP
92  connections. */
93 #ifndef MEMP_NUM_TCP_PCB
94 #define MEMP_NUM_TCP_PCB 5
95 #endif
96 /* MEMP_NUM_TCP_PCB_LISTEN: the number of listening TCP
97  connections. */
98 #ifndef MEMP_NUM_TCP_PCB_LISTEN
99 #define MEMP_NUM_TCP_PCB_LISTEN 8
100 #endif
101 /* MEMP_NUM_TCP_SEG: the number of simultaneously queued TCP
102  segments. */
103 #ifndef MEMP_NUM_TCP_SEG
104 #define MEMP_NUM_TCP_SEG 16
105 #endif
106 /* MEMP_NUM_SYS_TIMEOUT: the number of simulateously active
107  timeouts. */
108 #ifndef MEMP_NUM_SYS_TIMEOUT
109 #define MEMP_NUM_SYS_TIMEOUT 3
110 #endif
111 
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
117 #endif
118 /* MEMP_NUM_NETCONN: the number of struct netconns. */
119 #ifndef MEMP_NUM_NETCONN
120 #define MEMP_NUM_NETCONN 4
121 #endif
122 /* MEMP_NUM_APIMSG: the number of struct api_msg, used for
123  communication between the TCP/IP stack and the sequential
124  programs. */
125 #ifndef MEMP_NUM_API_MSG
126 #define MEMP_NUM_API_MSG 8
127 #endif
128 /* MEMP_NUM_TCPIPMSG: the number of struct tcpip_msg, which is used
129  for sequential API communication and incoming packets. Used in
130  src/api/tcpip.c. */
131 #ifndef MEMP_NUM_TCPIP_MSG
132 #define MEMP_NUM_TCPIP_MSG 8
133 #endif
134 
135 /* ---------- Pbuf options ---------- */
136 /* PBUF_POOL_SIZE: the number of buffers in the pbuf pool. */
137 
138 #ifndef PBUF_POOL_SIZE
139 #define PBUF_POOL_SIZE 16
140 #endif
141 
142 /* PBUF_POOL_BUFSIZE: the size of each pbuf in the pbuf pool. */
143 
144 #ifndef PBUF_POOL_BUFSIZE
145 #define PBUF_POOL_BUFSIZE 128
146 #endif
147 
148 /* PBUF_LINK_HLEN: the number of bytes that should be allocated for a
149  link level header. Defaults to 14 for Ethernet. */
150 
151 #ifndef PBUF_LINK_HLEN
152 #define PBUF_LINK_HLEN 14
153 #endif
154 
155 
156 
157 /* ---------- ARP options ---------- */
158 
160 #ifndef ARP_TABLE_SIZE
161 #define ARP_TABLE_SIZE 10
162 #endif
163 
176 #ifndef ARP_QUEUEING
177 #define ARP_QUEUEING 1
178 #endif
179 
180 /* This option is deprecated */
181 #ifdef ETHARP_QUEUE_FIRST
182 #error ETHARP_QUEUE_FIRST option is deprecated. Remove it from your lwipopts.h.
183 #endif
184 
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.
188 #endif
189 
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. */
194 #ifndef IP_FORWARD
195 #define IP_FORWARD 0
196 #endif
197 
198 /* If defined to 1, IP options are allowed (but not parsed). If
199  defined to 0, all packets with IP options are dropped. */
200 #ifndef IP_OPTIONS
201 #define IP_OPTIONS 1
202 #endif
203 
210 #ifndef IP_REASSEMBLY
211 #define IP_REASSEMBLY 1
212 #endif
213 
215 #ifndef IP_FRAG
216 #define IP_FRAG 1
217 #endif
218 
219 /* ---------- ICMP options ---------- */
220 
221 #ifndef ICMP_TTL
222 #define ICMP_TTL 255
223 #endif
224 
225 /* ---------- RAW options ---------- */
226 
227 #ifndef LWIP_RAW
228 #define LWIP_RAW 1
229 #endif
230 
231 #ifndef RAW_TTL
232 #define RAW_TTL 255
233 #endif
234 
235 /* ---------- DHCP options ---------- */
236 
237 #ifndef LWIP_DHCP
238 #define LWIP_DHCP 0
239 #endif
240 
241 /* 1 if you want to do an ARP check on the offered address
242  (recommended). */
243 #ifndef DHCP_DOES_ARP_CHECK
244 #define DHCP_DOES_ARP_CHECK 1
245 #endif
246 
247 /* ---------- UDP options ---------- */
248 #ifndef LWIP_UDP
249 #define LWIP_UDP 1
250 #endif
251 
252 #ifndef UDP_TTL
253 #define UDP_TTL 255
254 #endif
255 
256 /* ---------- TCP options ---------- */
257 #ifndef LWIP_TCP
258 #define LWIP_TCP 1
259 #endif
260 
261 #ifndef TCP_TTL
262 #define TCP_TTL 255
263 #endif
264 
265 #ifndef TCP_WND
266 #define TCP_WND 2048
267 #endif
268 
269 #ifndef TCP_MAXRTX
270 #define TCP_MAXRTX 12
271 #endif
272 
273 #ifndef TCP_SYNMAXRTX
274 #define TCP_SYNMAXRTX 6
275 #endif
276 
277 
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
282 #endif
283 
284 /* TCP Maximum segment size. */
285 #ifndef TCP_MSS
286 #define TCP_MSS 128 /* A *very* conservative default. */
287 #endif
288 
289 /* TCP sender buffer space (bytes). */
290 #ifndef TCP_SND_BUF
291 #define TCP_SND_BUF 256
292 #endif
293 
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
298 #endif
299 
300 
301 /* Maximum number of retransmissions of data segments. */
302 
303 /* Maximum number of retransmissions of SYN segments. */
304 
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 */
308 #ifndef TCP_SNDLOWAT
309 #define TCP_SNDLOWAT TCP_SND_BUF/2
310 #endif
311 
312 /* Support loop interface (127.0.0.1) */
313 #ifndef LWIP_HAVE_LOOPIF
314 #define LWIP_HAVE_LOOPIF 1
315 #endif
316 
317 #ifndef LWIP_EVENT_API
318 #define LWIP_EVENT_API 0
319 #define LWIP_CALLBACK_API 1
320 #else
321 #define LWIP_EVENT_API 1
322 #define LWIP_CALLBACK_API 0
323 #endif
324 
325 #ifndef LWIP_COMPAT_SOCKETS
326 #define LWIP_COMPAT_SOCKETS 1
327 #endif
328 
329 
330 #ifndef TCPIP_THREAD_PRIO
331 #define TCPIP_THREAD_PRIO 1
332 #endif
333 
334 #ifndef SLIPIF_THREAD_PRIO
335 #define SLIPIF_THREAD_PRIO 1
336 #endif
337 
338 #ifndef PPP_THREAD_PRIO
339 #define PPP_THREAD_PRIO 1
340 #endif
341 
342 #ifndef DEFAULT_THREAD_PRIO
343 #define DEFAULT_THREAD_PRIO 1
344 #endif
345 
346 
347 /* ---------- Socket Options ---------- */
348 /* Enable SO_REUSEADDR and SO_REUSEPORT options */
349 #ifndef SO_REUSE
350 # define SO_REUSE 0
351 #endif
352 
353 
354 /* ---------- Statistics options ---------- */
355 #ifndef LWIP_STATS
356 #define LWIP_STATS 1
357 #endif
358 
359 #if LWIP_STATS
360 
361 #ifndef LWIP_STATS_DISPLAY
362 #define LWIP_STATS_DISPLAY 0
363 #endif
364 
365 #ifndef LINK_STATS
366 #define LINK_STATS 1
367 #endif
368 
369 #ifndef IP_STATS
370 #define IP_STATS 1
371 #endif
372 
373 #ifndef IPFRAG_STATS
374 #define IPFRAG_STATS 1
375 #endif
376 
377 #ifndef ICMP_STATS
378 #define ICMP_STATS 1
379 #endif
380 
381 #ifndef UDP_STATS
382 #define UDP_STATS 1
383 #endif
384 
385 #ifndef TCP_STATS
386 #define TCP_STATS 1
387 #endif
388 
389 #ifndef MEM_STATS
390 #define MEM_STATS 1
391 #endif
392 
393 #ifndef MEMP_STATS
394 #define MEMP_STATS 1
395 #endif
396 
397 #ifndef PBUF_STATS
398 #define PBUF_STATS 1
399 #endif
400 
401 #ifndef SYS_STATS
402 #define SYS_STATS 1
403 #endif
404 
405 #ifndef RAW_STATS
406 #define RAW_STATS 0
407 #endif
408 
409 #else
410 
411 #define LINK_STATS 0
412 #define IP_STATS 0
413 #define IPFRAG_STATS 0
414 #define ICMP_STATS 0
415 #define UDP_STATS 0
416 #define TCP_STATS 0
417 #define MEM_STATS 0
418 #define MEMP_STATS 0
419 #define PBUF_STATS 0
420 #define SYS_STATS 0
421 #define RAW_STATS 0
422 #define LWIP_STATS_DISPLAY 0
423 
424 #endif /* LWIP_STATS */
425 
426 /* ---------- PPP options ---------- */
427 
428 #ifndef PPP_SUPPORT
429 #define PPP_SUPPORT 0 /* Set for PPP */
430 #endif
431 
432 #if PPP_SUPPORT
433 
434 #define NUM_PPP 1 /* Max PPP sessions. */
435 
436 
437 
438 #ifndef PAP_SUPPORT
439 #define PAP_SUPPORT 0 /* Set for PAP. */
440 #endif
441 
442 #ifndef CHAP_SUPPORT
443 #define CHAP_SUPPORT 0 /* Set for CHAP. */
444 #endif
445 
446 #define MSCHAP_SUPPORT 0 /* Set for MSCHAP (NOT FUNCTIONAL!) */
447 #define CBCP_SUPPORT 0 /* Set for CBCP (NOT FUNCTIONAL!) */
448 #define CCP_SUPPORT 0 /* Set for CCP (NOT FUNCTIONAL!) */
449 
450 #ifndef VJ_SUPPORT
451 #define VJ_SUPPORT 0 /* Set for VJ header compression. */
452 #endif
453 
454 #ifndef MD5_SUPPORT
455 #define MD5_SUPPORT 0 /* Set for MD5 (see also CHAP) */
456 #endif
457 
458 
459 /*
460  * Timeouts.
461  */
462 #define FSM_DEFTIMEOUT 6 /* Timeout time in seconds */
463 #define FSM_DEFMAXTERMREQS 2 /* Maximum Terminate-Request transmissions */
464 #define FSM_DEFMAXCONFREQS 10 /* Maximum Configure-Request transmissions */
465 #define FSM_DEFMAXNAKLOOPS 5 /* Maximum number of nak loops */
466 
467 #define UPAP_DEFTIMEOUT 6 /* Timeout (seconds) for retransmitting req */
468 #define UPAP_DEFREQTIME 30 /* Time to wait for auth-req from peer */
469 
470 #define CHAP_DEFTIMEOUT 6 /* Timeout time in seconds */
471 #define CHAP_DEFTRANSMITS 10 /* max # times to send challenge */
472 
473 
474 /* Interval in seconds between keepalive echo requests, 0 to disable. */
475 #if 1
476 #define LCP_ECHOINTERVAL 0
477 #else
478 #define LCP_ECHOINTERVAL 10
479 #endif
480 
481 /* Number of unanswered echo requests before failure. */
482 #define LCP_MAXECHOFAILS 3
483 
484 /* Max Xmit idle time (in jiffies) before resend flag char. */
485 #define PPP_MAXIDLEFLAG 100
486 
487 /*
488  * Packet sizes
489  *
490  * Note - lcp shouldn't be allowed to negotiate stuff outside these
491  * limits. See lcp.h in the pppd directory.
492  * (XXX - these constants should simply be shared by lcp.c instead
493  * of living in lcp.h)
494  */
495 #define PPP_MTU 1500 /* Default MTU (size of Info field) */
496 #if 0
497 #define PPP_MAXMTU 65535 - (PPP_HDRLEN + PPP_FCSLEN)
498 #else
499 #define PPP_MAXMTU 1500 /* Largest MTU we allow */
500 #endif
501 #define PPP_MINMTU 64
502 #define PPP_MRU 1500 /* default MRU = max length of info field */
503 #define PPP_MAXMRU 1500 /* Largest MRU we allow */
504 #define PPP_DEFMRU 296 /* Try for this */
505 #define PPP_MINMRU 128 /* No MRUs below this */
506 
507 
508 #define MAXNAMELEN 256 /* max length of hostname or name for auth */
509 #define MAXSECRETLEN 256 /* max length of password or secret */
510 
511 #endif /* PPP_SUPPORT */
512 
513 /* checksum options - set to zero for hardware checksum support */
514 
515 #ifndef CHECKSUM_GEN_IP
516 #define CHECKSUM_GEN_IP 1
517 #endif
518 
519 #ifndef CHECKSUM_GEN_UDP
520 #define CHECKSUM_GEN_UDP 1
521 #endif
522 
523 #ifndef CHECKSUM_GEN_TCP
524 #define CHECKSUM_GEN_TCP 1
525 #endif
526 
527 #ifndef CHECKSUM_CHECK_IP
528 #define CHECKSUM_CHECK_IP 1
529 #endif
530 
531 #ifndef CHECKSUM_CHECK_UDP
532 #define CHECKSUM_CHECK_UDP 1
533 #endif
534 
535 #ifndef CHECKSUM_CHECK_TCP
536 #define CHECKSUM_CHECK_TCP 1
537 #endif
538 
539 /* Debugging options all default to off */
540 
541 #ifndef DBG_TYPES_ON
542 #define DBG_TYPES_ON 0
543 #endif
544 
545 #ifndef ETHARP_DEBUG
546 #define ETHARP_DEBUG DBG_OFF
547 #endif
548 
549 #ifndef NETIF_DEBUG
550 #define NETIF_DEBUG DBG_OFF
551 #endif
552 
553 #ifndef PBUF_DEBUG
554 #define PBUF_DEBUG DBG_OFF
555 #endif
556 
557 #ifndef API_LIB_DEBUG
558 #define API_LIB_DEBUG DBG_OFF
559 #endif
560 
561 #ifndef API_MSG_DEBUG
562 #define API_MSG_DEBUG DBG_OFF
563 #endif
564 
565 #ifndef SOCKETS_DEBUG
566 #define SOCKETS_DEBUG DBG_OFF
567 #endif
568 
569 #ifndef ICMP_DEBUG
570 #define ICMP_DEBUG DBG_OFF
571 #endif
572 
573 #ifndef INET_DEBUG
574 #define INET_DEBUG DBG_OFF
575 #endif
576 
577 #ifndef IP_DEBUG
578 #define IP_DEBUG DBG_OFF
579 #endif
580 
581 #ifndef IP_REASS_DEBUG
582 #define IP_REASS_DEBUG DBG_OFF
583 #endif
584 
585 #ifndef RAW_DEBUG
586 #define RAW_DEBUG DBG_OFF
587 #endif
588 
589 #ifndef MEM_DEBUG
590 #define MEM_DEBUG DBG_OFF
591 #endif
592 
593 #ifndef MEMP_DEBUG
594 #define MEMP_DEBUG DBG_OFF
595 #endif
596 
597 #ifndef SYS_DEBUG
598 #define SYS_DEBUG DBG_OFF
599 #endif
600 
601 #ifndef TCP_DEBUG
602 #define TCP_DEBUG DBG_OFF
603 #endif
604 
605 #ifndef TCP_INPUT_DEBUG
606 #define TCP_INPUT_DEBUG DBG_OFF
607 #endif
608 
609 #ifndef TCP_FR_DEBUG
610 #define TCP_FR_DEBUG DBG_OFF
611 #endif
612 
613 #ifndef TCP_RTO_DEBUG
614 #define TCP_RTO_DEBUG DBG_OFF
615 #endif
616 
617 #ifndef TCP_REXMIT_DEBUG
618 #define TCP_REXMIT_DEBUG DBG_OFF
619 #endif
620 
621 #ifndef TCP_CWND_DEBUG
622 #define TCP_CWND_DEBUG DBG_OFF
623 #endif
624 
625 #ifndef TCP_WND_DEBUG
626 #define TCP_WND_DEBUG DBG_OFF
627 #endif
628 
629 #ifndef TCP_OUTPUT_DEBUG
630 #define TCP_OUTPUT_DEBUG DBG_OFF
631 #endif
632 
633 #ifndef TCP_RST_DEBUG
634 #define TCP_RST_DEBUG DBG_OFF
635 #endif
636 
637 #ifndef TCP_QLEN_DEBUG
638 #define TCP_QLEN_DEBUG DBG_OFF
639 #endif
640 
641 #ifndef UDP_DEBUG
642 #define UDP_DEBUG DBG_OFF
643 #endif
644 
645 #ifndef TCPIP_DEBUG
646 #define TCPIP_DEBUG DBG_OFF
647 #endif
648 
649 #ifndef PPP_DEBUG
650 #define PPP_DEBUG DBG_OFF
651 #endif
652 
653 #ifndef SLIP_DEBUG
654 #define SLIP_DEBUG DBG_OFF
655 #endif
656 
657 #ifndef DHCP_DEBUG
658 #define DHCP_DEBUG DBG_OFF
659 #endif
660 
661 
662 #ifndef DBG_MIN_LEVEL
663 #define DBG_MIN_LEVEL DBG_LEVEL_OFF
664 #endif
665 
666 #endif /* __LWIP_OPT_H__ */
667 
668 
669 
Generated by   doxygen 1.8.15