7 * \defgroup uipopt Configuration options for uIP
10 * uIP is configured using the per-project configuration file
11 * "uipopt.h". This file contains all compile-time options for uIP and
12 * should be tweaked to match each specific project. The uIP
13 * distribution contains a documented example "uipopt.h" that can be
14 * copied and modified for each project.
16 * \note Contiki does not use the uipopt.h file to configure uIP, but
17 * uses a per-port uip-conf.h file that should be edited instead.
22 * Configuration options for uIP.
23 * \author Adam Dunkels <adam@dunkels.com>
25 * This file is used for tweaking various configuration options for
26 * uIP. You should make a copy of this file into one of your project's
27 * directories instead of editing this example "uipopt.h" file that
28 * comes with the uIP distribution.
32 * Copyright (c) 2001-2003, Adam Dunkels.
33 * All rights reserved.
35 * Redistribution and use in source and binary forms, with or without
36 * modification, are permitted provided that the following conditions
38 * 1. Redistributions of source code must retain the above copyright
39 * notice, this list of conditions and the following disclaimer.
40 * 2. Redistributions in binary form must reproduce the above copyright
41 * notice, this list of conditions and the following disclaimer in the
42 * documentation and/or other materials provided with the distribution.
43 * 3. The name of the author may not be used to endorse or promote
44 * products derived from this software without specific prior
47 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
48 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
49 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
50 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
51 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
52 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
53 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
54 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
55 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
56 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
57 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
59 * This file is part of the uIP TCP/IP stack.
61 * $Id: uipopt.h,v 1.11 2009/04/10 00:37:48 adamdunkels Exp $
68 #ifndef UIP_LITTLE_ENDIAN
69 #define UIP_LITTLE_ENDIAN 3412
70 #endif /* UIP_LITTLE_ENDIAN */
71 #ifndef UIP_BIG_ENDIAN
72 #define UIP_BIG_ENDIAN 1234
73 #endif /* UIP_BIG_ENDIAN */
75 /*------------------------------------------------------------------------------*/
78 * \defgroup uipoptstaticconf Static configuration options
81 * These configuration options can be used for setting the IP address
82 * settings statically, but only if UIP_FIXEDADDR is set to 1. The
83 * configuration options for a specific node includes IP address,
84 * netmask and default router as well as the Ethernet address. The
85 * netmask, default router and Ethernet address are applicable only
86 * if uIP should be run over Ethernet.
88 * This options are meaningful only for the IPv4 code.
90 * All of these should be changed to suit your project.
94 * Determines if uIP should use a fixed IP address or not.
96 * If uIP should use a fixed IP address, the settings are set in the
97 * uipopt.h file. If not, the macros uip_sethostaddr(),
98 * uip_setdraddr() and uip_setnetmask() should be used instead.
102 #define UIP_FIXEDADDR 0
105 * Ping IP address assignment.
107 * uIP uses a "ping" packets for setting its own IP address if this
108 * option is set. If so, uIP will start with an empty IP address and
109 * the destination IP address of the first incoming "ping" (ICMP echo)
110 * packet will be used for setting the hosts IP address.
112 * \note This works only if UIP_FIXEDADDR is 0.
116 #ifdef UIP_CONF_PINGADDRCONF
117 #define UIP_PINGADDRCONF UIP_CONF_PINGADDRCONF
118 #else /* UIP_CONF_PINGADDRCONF */
119 #define UIP_PINGADDRCONF 0
120 #endif /* UIP_CONF_PINGADDRCONF */
124 * Specifies if the uIP ARP module should be compiled with a fixed
125 * Ethernet MAC address or not.
127 * If this configuration option is 0, the macro uip_setethaddr() can
128 * be used to specify the Ethernet address at run-time.
132 #define UIP_FIXEDETHADDR 0
135 /*------------------------------------------------------------------------------*/
137 * \defgroup uipoptip IP configuration options
142 * The IP TTL (time to live) of IP packets sent by uIP.
144 * This should normally not be changed.
149 * The maximum time an IP fragment should wait in the reassembly
150 * buffer before it is dropped.
153 #define UIP_REASS_MAXAGE 60 /*60s*/
156 * Turn on support for IP packet reassembly.
158 * uIP supports reassembly of fragmented IP packets. This features
159 * requires an additional amount of RAM to hold the reassembly buffer
160 * and the reassembly code size is approximately 700 bytes. The
161 * reassembly buffer is of the same size as the uip_buf buffer
162 * (configured by UIP_BUFSIZE).
164 * \note IP packet reassembly is not heavily tested.
168 #ifdef UIP_CONF_REASSEMBLY
169 #define UIP_REASSEMBLY UIP_CONF_REASSEMBLY
170 #else /* UIP_CONF_REASSEMBLY */
171 #define UIP_REASSEMBLY 0
172 #endif /* UIP_CONF_REASSEMBLY */
175 /*------------------------------------------------------------------------------*/
177 * \defgroup uipoptipv6 IPv6 configuration options
182 /** The maximum transmission unit at the IP Layer*/
183 #define UIP_LINK_MTU 1280
185 #ifndef UIP_CONF_IPV6
186 /** Do we use IPv6 or not (default: no) */
187 #define UIP_CONF_IPV6 0
190 #ifndef UIP_CONF_IPV6_QUEUE_PKT
191 /** Do we do per %neighbor queuing during address resolution (default: no) */
192 #define UIP_CONF_IPV6_QUEUE_PKT 0
195 #ifndef UIP_CONF_IPV6_CHECKS
196 /** Do we do IPv6 consistency checks (highly recommended, default: yes) */
197 #define UIP_CONF_IPV6_CHECKS 1
200 #ifndef UIP_CONF_IPV6_REASSEMBLY
201 /** Do we do IPv6 fragmentation (default: no) */
202 #define UIP_CONF_IPV6_REASSEMBLY 0
205 #ifndef UIP_CONF_NETIF_MAX_ADDRESSES
206 /** Default number of IPv6 addresses associated to the node's interface */
207 #define UIP_CONF_NETIF_MAX_ADDRESSES 3
210 #ifndef UIP_CONF_ND6_MAX_PREFIXES
211 /** Default number of IPv6 prefixes associated to the node's interface */
212 #define UIP_CONF_ND6_MAX_PREFIXES 3
215 #ifndef UIP_CONF_ND6_MAX_NEIGHBORS
216 /** Default number of neighbors that can be stored in the %neighbor cache */
217 #define UIP_CONF_ND6_MAX_NEIGHBORS 4
220 #ifndef UIP_CONF_ND6_MAX_DEFROUTERS
221 /** Minimum number of default routers */
222 #define UIP_CONF_ND6_MAX_DEFROUTERS 2
226 /*------------------------------------------------------------------------------*/
228 * \defgroup uipoptudp UDP configuration options
231 * \note The UDP support in uIP is still not entirely complete; there
232 * is no support for sending or receiving broadcast or multicast
233 * packets, but it works well enough to support a number of vital
234 * applications such as DNS queries, though
238 * Toggles whether UDP support should be compiled in or not.
243 #define UIP_UDP UIP_CONF_UDP
244 #else /* UIP_CONF_UDP */
246 #endif /* UIP_CONF_UDP */
249 * Toggles if UDP checksums should be used or not.
251 * \note Support for UDP checksums is currently not included in uIP,
252 * so this option has no function.
256 #ifdef UIP_CONF_UDP_CHECKSUMS
257 #define UIP_UDP_CHECKSUMS UIP_CONF_UDP_CHECKSUMS
259 #define UIP_UDP_CHECKSUMS 0
263 * The maximum amount of concurrent UDP connections.
267 #ifdef UIP_CONF_UDP_CONNS
268 #define UIP_UDP_CONNS UIP_CONF_UDP_CONNS
269 #else /* UIP_CONF_UDP_CONNS */
270 #define UIP_UDP_CONNS 10
271 #endif /* UIP_CONF_UDP_CONNS */
274 * The name of the function that should be called when UDP datagrams arrive.
281 /*------------------------------------------------------------------------------*/
283 * \defgroup uipopttcp TCP configuration options
288 * Toggles whether UDP support should be compiled in or not.
293 #define UIP_TCP UIP_CONF_TCP
294 #else /* UIP_CONF_UDP */
296 #endif /* UIP_CONF_UDP */
299 * Determines if support for opening connections from uIP should be
302 * If the applications that are running on top of uIP for this project
303 * do not need to open outgoing TCP connections, this configuration
304 * option can be turned off to reduce the code size of uIP.
308 #ifndef UIP_CONF_ACTIVE_OPEN
309 #define UIP_ACTIVE_OPEN 1
310 #else /* UIP_CONF_ACTIVE_OPEN */
311 #define UIP_ACTIVE_OPEN UIP_CONF_ACTIVE_OPEN
312 #endif /* UIP_CONF_ACTIVE_OPEN */
315 * The maximum number of simultaneously open TCP connections.
317 * Since the TCP connections are statically allocated, turning this
318 * configuration knob down results in less RAM used. Each TCP
319 * connection requires approximately 30 bytes of memory.
323 #ifndef UIP_CONF_MAX_CONNECTIONS
325 #else /* UIP_CONF_MAX_CONNECTIONS */
326 #define UIP_CONNS UIP_CONF_MAX_CONNECTIONS
327 #endif /* UIP_CONF_MAX_CONNECTIONS */
331 * The maximum number of simultaneously listening TCP ports.
333 * Each listening TCP port requires 2 bytes of memory.
337 #ifndef UIP_CONF_MAX_LISTENPORTS
338 #define UIP_LISTENPORTS 20
339 #else /* UIP_CONF_MAX_LISTENPORTS */
340 #define UIP_LISTENPORTS UIP_CONF_MAX_LISTENPORTS
341 #endif /* UIP_CONF_MAX_LISTENPORTS */
344 * Determines if support for TCP urgent data notification should be
347 * Urgent data (out-of-band data) is a rarely used TCP feature that
348 * very seldom would be required.
352 #define UIP_URGDATA 0
355 * The initial retransmission timeout counted in timer pulses.
357 * This should not be changed.
362 * The maximum number of times a segment should be retransmitted
363 * before the connection should be aborted.
365 * This should not be changed.
370 * The maximum number of times a SYN segment should be retransmitted
371 * before a connection request should be deemed to have been
374 * This should not need to be changed.
376 #define UIP_MAXSYNRTX 5
379 * The TCP maximum segment size.
381 * This is should not be to set to more than
382 * UIP_BUFSIZE - UIP_LLH_LEN - UIP_TCPIP_HLEN.
384 #ifdef UIP_CONF_TCP_MSS
385 #define UIP_TCP_MSS UIP_CONF_TCP_MSS
387 #define UIP_TCP_MSS (UIP_BUFSIZE - UIP_LLH_LEN - UIP_TCPIP_HLEN)
391 * The size of the advertised receiver's window.
393 * Should be set low (i.e., to the size of the uip_buf buffer) if the
394 * application is slow to process incoming data, or high (32768 bytes)
395 * if the application processes data quickly.
399 #ifndef UIP_CONF_RECEIVE_WINDOW
400 #define UIP_RECEIVE_WINDOW UIP_TCP_MSS
402 #define UIP_RECEIVE_WINDOW UIP_CONF_RECEIVE_WINDOW
406 * How long a connection should stay in the TIME_WAIT state.
408 * This configuration option has no real implication, and it should be
411 #define UIP_TIME_WAIT_TIMEOUT 120
415 /*------------------------------------------------------------------------------*/
417 * \defgroup uipoptarp ARP configuration options
422 * The size of the ARP table.
424 * This option should be set to a larger value if this uIP node will
425 * have many connections from the local network.
429 #ifdef UIP_CONF_ARPTAB_SIZE
430 #define UIP_ARPTAB_SIZE UIP_CONF_ARPTAB_SIZE
432 #define UIP_ARPTAB_SIZE 8
436 * The maximum age of ARP table entries measured in 10ths of seconds.
438 * An UIP_ARP_MAXAGE of 120 corresponds to 20 minutes (BSD
441 #define UIP_ARP_MAXAGE 120
446 /*------------------------------------------------------------------------------*/
449 * \defgroup uipoptmac layer 2 options (for ipv6)
453 #define UIP_DEFAULT_PREFIX_LEN 64
457 /*------------------------------------------------------------------------------*/
460 * \defgroup uipoptsics 6lowpan options (for ipv6)
464 * Timeout for packet reassembly at the 6lowpan layer
467 #ifdef SICSLOWPAN_CONF_MAXAGE
468 #define SICSLOWPAN_REASS_MAXAGE SICSLOWPAN_CONF_MAXAGE
470 #define SICSLOWPAN_REASS_MAXAGE 20
474 * Do we compress the IP header or not (default: no)
476 #ifndef SICSLOWPAN_CONF_COMPRESSION
477 #define SICSLOWPAN_CONF_COMPRESSION 0
481 * If we use IPHC compression, how many address contexts do we support
483 #ifndef SICSLOWPAN_CONF_MAX_ADDR_CONTEXTS
484 #define SICSLOWPAN_CONF_MAX_ADDR_CONTEXTS 1
488 * Do we support 6lowpan fragmentation
490 #ifndef SICSLOWPAN_CONF_FRAG
491 #define SICSLOWPAN_CONF_FRAG 0
496 /*------------------------------------------------------------------------------*/
499 * \defgroup uipoptgeneral General configuration options
504 * The size of the uIP packet buffer.
506 * The uIP packet buffer should not be smaller than 60 bytes, and does
507 * not need to be larger than 1514 bytes. Lower size results in lower
508 * TCP throughput, larger size results in higher TCP throughput.
512 #ifndef UIP_CONF_BUFFER_SIZE
513 #define UIP_BUFSIZE UIP_LINK_MTU + UIP_LLH_LEN
514 #else /* UIP_CONF_BUFFER_SIZE */
515 #define UIP_BUFSIZE UIP_CONF_BUFFER_SIZE
516 #endif /* UIP_CONF_BUFFER_SIZE */
520 * Determines if statistics support should be compiled in.
522 * The statistics is useful for debugging and to show the user.
526 #ifndef UIP_CONF_STATISTICS
527 #define UIP_STATISTICS 0
528 #else /* UIP_CONF_STATISTICS */
529 #define UIP_STATISTICS UIP_CONF_STATISTICS
530 #endif /* UIP_CONF_STATISTICS */
533 * Determines if logging of certain events should be compiled in.
535 * This is useful mostly for debugging. The function uip_log()
536 * must be implemented to suit the architecture of the project, if
537 * logging is turned on.
541 #ifndef UIP_CONF_LOGGING
542 #define UIP_LOGGING 0
543 #else /* UIP_CONF_LOGGING */
544 #define UIP_LOGGING UIP_CONF_LOGGING
545 #endif /* UIP_CONF_LOGGING */
550 * This flag configures IP broadcast support. This is useful only
556 #ifndef UIP_CONF_BROADCAST
557 #define UIP_BROADCAST 0
558 #else /* UIP_CONF_BROADCAST */
559 #define UIP_BROADCAST UIP_CONF_BROADCAST
560 #endif /* UIP_CONF_BROADCAST */
563 * Print out a uIP log message.
565 * This function must be implemented by the module that uses uIP, and
566 * is called by uIP whenever a log message is generated.
568 void uip_log(char *msg
);
571 * The link level header length.
573 * This is the offset into the uip_buf where the IP header can be
574 * found. For Ethernet, this should be set to 14. For SLIP, this
575 * should be set to 0.
577 * \note we probably won't use this constant for other link layers than
578 * ethernet as they have variable header length (this is due to variable
579 * number and type of address fields and to optional security features)
580 * E.g.: 802.15.4 -> 2 + (1/2*4/8) + 0/5/6/10/14
581 * 802.11 -> 4 + (6*3/4) + 2
584 #ifdef UIP_CONF_LLH_LEN
585 #define UIP_LLH_LEN UIP_CONF_LLH_LEN
586 #else /* UIP_LLH_LEN */
587 #define UIP_LLH_LEN 14
588 #endif /* UIP_CONF_LLH_LEN */
591 /*------------------------------------------------------------------------------*/
593 * \defgroup uipoptcpu CPU architecture configuration
596 * The CPU architecture configuration is where the endianess of the
597 * CPU on which uIP is to be run is specified. Most CPUs today are
598 * little endian, and the most notable exception are the Motorolas
599 * which are big endian. The BYTE_ORDER macro should be changed to
600 * reflect the CPU architecture on which uIP is to be run.
604 * The byte order of the CPU architecture on which uIP is to be run.
606 * This option can be either UIP_BIG_ENDIAN (Motorola byte order) or
607 * UIP_LITTLE_ENDIAN (Intel byte order).
611 #ifdef UIP_CONF_BYTE_ORDER
612 #define UIP_BYTE_ORDER UIP_CONF_BYTE_ORDER
613 #else /* UIP_CONF_BYTE_ORDER */
614 #define UIP_BYTE_ORDER UIP_LITTLE_ENDIAN
615 #endif /* UIP_CONF_BYTE_ORDER */
618 /*------------------------------------------------------------------------------*/
624 typedef uint8_t u8_t
;
625 typedef uint16_t u16_t
;
626 typedef uint32_t u32_t
;
627 typedef uint32_t uip_stats_t
;
630 * \defgroup uipoptapp Application specific configurations
633 * An uIP application is implemented using a single application
634 * function that is called by uIP whenever a TCP/IP event occurs. The
635 * name of this function must be registered with uIP at compile time
636 * using the UIP_APPCALL definition.
638 * uIP applications can store the application state within the
639 * uip_conn structure by specifying the type of the application
640 * structure by typedef:ing the type uip_tcp_appstate_t and uip_udp_appstate_t.
642 * The file containing the definitions must be included in the
645 * The following example illustrates how this can look.
648 void httpd_appcall(void);
649 #define UIP_APPCALL httpd_appcall
657 typedef struct httpd_state uip_tcp_appstate_t
660 #define UIP_UDP_APPCALL DHCPApp_Callback
661 void UIP_UDP_APPCALL(void);
664 * \var #define UIP_APPCALL
666 * The name of the application function that uIP should call in
667 * response to TCP/IP events.
670 #define UIP_APPCALL WebserverApp_Callback
671 void UIP_APPCALL(void);
674 * \var typedef uip_tcp_appstate_t
676 * The type of the application state that is to be stored in the
677 * uip_conn structure. This usually is typedef:ed to a struct holding
678 * application state information.
682 uint8_t CurrentState
;
688 uint32_t ACKedFilePos
;
689 uint16_t SentChunkSize
;
690 } uip_tcp_appstate_t
;
693 * \var typedef uip_udp_appstate_t
695 * The type of the application state that is to be stored in the
696 * uip_conn structure. This usually is typedef:ed to a struct holding
697 * application state information.
701 uint8_t CurrentState
;
702 struct uip_udp_conn
* Connection
;
706 uint8_t AllocatedIP
[4];
708 uint8_t GatewayIP
[4];
711 } uip_udp_appstate_t
;
714 #endif /* __UIPOPT_H__ */