123
Diff: utility/uipopt.h
- Revision:
- 8:4acb22344932
- Parent:
- 3:5b17e4656dd0
- Child:
- 9:a156d3de5647
diff -r 1bc7e6120801 -r 4acb22344932 utility/uipopt.h --- a/utility/uipopt.h Tue Apr 26 18:37:14 2016 +0000 +++ b/utility/uipopt.h Fri Jun 30 19:51:28 2017 +0000 @@ -1,10 +1,10 @@ /** - * \defgroup uipopt Configuration options for uIP + * \defgroup uipopt Configuration options for UIP * @{ * - * uIP is configured using the per-project configuration file - * uipopt.h. This file contains all compile-time options for uIP and - * should be tweaked to match each specific project. The uIP + * UIP is configured using the per-project configuration file + * uipopt.h. This file contains all compile-time options for UIP and + * should be tweaked to match each specific project. The UIP * distribution contains a documented example "uipopt.h" that can be * copied and modified for each project. * @@ -13,13 +13,13 @@ */ /** * \file - * Configuration options for uIP. + * Configuration options for UIP. * \author Adam Dunkels <adam@dunkels.com> * * This file is used for tweaking various configuration options for - * uIP. You should make a copy of this file into one of your project's + * UIP. You should make a copy of this file into one of your project's * directories instead of editing this example "uipopt.h" file that - * comes with the uIP distribution. + * comes with the UIP distribution. */ /* * Copyright (c) 2001-2003, Adam Dunkels. @@ -49,23 +49,23 @@ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * - * This file is part of the uIP TCP/IP stack. + * This file is part of the UIP TCP/IP stack. * * $Id: uipopt.h,v 1.4 2006/06/12 08:00:31 adam Exp $ * */ #ifndef __UIPOPT_H__ - #define __UIPOPT_H__ +#define __UIPOPT_H__ - #ifndef UIP_LITTLE_ENDIAN - #define UIP_LITTLE_ENDIAN 3412 - #endif /* UIP_LITTLE_ENDIAN */ +#ifndef UIP_LITTLE_ENDIAN +#define UIP_LITTLE_ENDIAN 3412 +#endif /* UIP_LITTLE_ENDIAN */ - #ifndef UIP_BIG_ENDIAN - #define UIP_BIG_ENDIAN 1234 - #endif /* UIP_BIG_ENDIAN */ +#ifndef UIP_BIG_ENDIAN +#define UIP_BIG_ENDIAN 1234 +#endif /* UIP_BIG_ENDIAN */ - #include "uip-conf.h" +#include "uip-conf.h" /*------------------------------------------------------------------------------*/ @@ -78,26 +78,26 @@ * configuration options for a specific node includes IP address, * netmask and default router as well as the Ethernet address. The * netmask, default router and Ethernet address are appliciable only - * if uIP should be run over Ethernet. + * if UIP should be run over Ethernet. * * All of these should be changed to suit your project. */ /** - * Determines if uIP should use a fixed IP address or not. + * Determines if UIP should use a fixed IP address or not. * - * If uIP should use a fixed IP address, the settings are set in the + * If UIP should use a fixed IP address, the settings are set in the * uipopt.h file. If not, the macros uip_sethostaddr(), * uip_setdraddr() and uip_setnetmask() should be used instead. * * \hideinitializer */ - #define UIP_FIXEDADDR 0 +#define UIP_FIXEDADDR 0 /** * Ping IP address asignment. * - * uIP uses a "ping" packets for setting its own IP address if this - * option is set. If so, uIP will start with an empty IP address and + * UIP uses a "ping" packets for setting its own IP address if this + * option is set. If so, UIP will start with an empty IP address and * the destination IP address of the first incoming "ping" (ICMP echo) * packet will be used for setting the hosts IP address. * @@ -106,15 +106,15 @@ * \hideinitializer */ - #ifdef UIP_CONF_PINGADDRCONF - #define UIP_PINGADDRCONF UIP_CONF_PINGADDRCONF - #else /* UIP_CONF_PINGADDRCONF */ +#ifdef UIP_CONF_PINGADDRCONF +#define UIP_PINGADDRCONF UIP_CONF_PINGADDRCONF +#else /* UIP_CONF_PINGADDRCONF */ - #define UIP_PINGADDRCONF 0 - #endif /* UIP_CONF_PINGADDRCONF */ +#define UIP_PINGADDRCONF 0 +#endif /* UIP_CONF_PINGADDRCONF */ /** - * Specifies if the uIP ARP module should be compiled with a fixed + * Specifies if the UIP ARP module should be compiled with a fixed * Ethernet MAC address or not. * * If this configuration option is 0, the macro uip_setethaddr() can @@ -123,7 +123,7 @@ * \hideinitializer */ - #define UIP_FIXEDETHADDR 0 +#define UIP_FIXEDETHADDR 0 /** @} */ @@ -134,16 +134,16 @@ * */ /** - * The IP TTL (time to live) of IP packets sent by uIP. + * The IP TTL (time to live) of IP packets sent by UIP. * * This should normally not be changed. */ - #define UIP_TTL 64 +#define UIP_TTL 64 /** * Turn on support for IP packet reassembly. * - * uIP supports reassembly of fragmented IP packets. This features + * UIP supports reassembly of fragmented IP packets. This features * requires an additonal amount of RAM to hold the reassembly buffer * and the reassembly code size is approximately 700 bytes. The * reassembly buffer is of the same size as the uip_buf buffer @@ -154,7 +154,7 @@ * \hideinitializer */ - #define UIP_REASSEMBLY 0 +#define UIP_REASSEMBLY 0 /** * The maximum time an IP fragment should wait in the reassembly @@ -162,7 +162,7 @@ * */ - #define UIP_REASS_MAXAGE 40 +#define UIP_REASS_MAXAGE 40 /** @} */ @@ -176,39 +176,39 @@ * * \hideinitializer */ - #ifdef UIP_CONF_UDP - #define UIP_UDP UIP_CONF_UDP - #else /* UIP_CONF_UDP */ +#ifdef UIP_CONF_UDP +#define UIP_UDP UIP_CONF_UDP +#else /* UIP_CONF_UDP */ - #define UIP_UDP 0 - #endif /* UIP_CONF_UDP */ +#define UIP_UDP 0 +#endif /* UIP_CONF_UDP */ /** * Toggles if UDP checksums should be used or not. * - * \note Support for UDP checksums is currently not included in uIP, + * \note Support for UDP checksums is currently not included in UIP, * so this option has no function. * * \hideinitializer */ - #ifdef UIP_CONF_UDP_CHECKSUMS - #define UIP_UDP_CHECKSUMS UIP_CONF_UDP_CHECKSUMS - #else - #define UIP_UDP_CHECKSUMS 0 - #endif +#ifdef UIP_CONF_UDP_CHECKSUMS +#define UIP_UDP_CHECKSUMS UIP_CONF_UDP_CHECKSUMS +#else +#define UIP_UDP_CHECKSUMS 0 +#endif /** * The maximum amount of concurrent UDP connections. * * \hideinitializer */ - #ifdef UIP_CONF_UDP_CONNS - #define UIP_UDP_CONNS UIP_CONF_UDP_CONNS - #else /* UIP_CONF_UDP_CONNS */ +#ifdef UIP_CONF_UDP_CONNS +#define UIP_UDP_CONNS UIP_CONF_UDP_CONNS +#else /* UIP_CONF_UDP_CONNS */ - #define UIP_UDP_CONNS 10 - #endif /* UIP_CONF_UDP_CONNS */ +#define UIP_UDP_CONNS 10 +#endif /* UIP_CONF_UDP_CONNS */ /** * The name of the function that should be called when UDP datagrams arrive. @@ -223,16 +223,16 @@ * @{ */ /** - * Determines if support for opening connections from uIP should be + * Determines if support for opening connections from UIP should be * compiled in. * - * If the applications that are running on top of uIP for this project + * If the applications that are running on top of UIP for this project * do not need to open outgoing TCP connections, this configration - * option can be turned off to reduce the code size of uIP. + * option can be turned off to reduce the code size of UIP. * * \hideinitializer */ - #define UIP_ACTIVE_OPEN 1 +#define UIP_ACTIVE_OPEN 1 /** * The maximum number of simultaneously open TCP connections. @@ -244,12 +244,12 @@ * \hideinitializer */ - #ifndef UIP_CONF_MAX_CONNECTIONS - #define UIP_CONNS 10 - #else /* UIP_CONF_MAX_CONNECTIONS */ +#ifndef UIP_CONF_MAX_CONNECTIONS +#define UIP_CONNS 10 +#else /* UIP_CONF_MAX_CONNECTIONS */ - #define UIP_CONNS UIP_CONF_MAX_CONNECTIONS - #endif /* UIP_CONF_MAX_CONNECTIONS */ +#define UIP_CONNS UIP_CONF_MAX_CONNECTIONS +#endif /* UIP_CONF_MAX_CONNECTIONS */ /** * The maximum number of simultaneously listening TCP ports. @@ -259,12 +259,12 @@ * \hideinitializer */ - #ifndef UIP_CONF_MAX_LISTENPORTS - #define UIP_LISTENPORTS 20 - #else /* UIP_CONF_MAX_LISTENPORTS */ +#ifndef UIP_CONF_MAX_LISTENPORTS +#define UIP_LISTENPORTS 20 +#else /* UIP_CONF_MAX_LISTENPORTS */ - #define UIP_LISTENPORTS UIP_CONF_MAX_LISTENPORTS - #endif /* UIP_CONF_MAX_LISTENPORTS */ +#define UIP_LISTENPORTS UIP_CONF_MAX_LISTENPORTS +#endif /* UIP_CONF_MAX_LISTENPORTS */ /** * Determines if support for TCP urgent data notification should be @@ -276,7 +276,7 @@ * \hideinitializer */ - #define UIP_URGDATA 0 +#define UIP_URGDATA 0 /** * The initial retransmission timeout counted in timer pulses. @@ -284,7 +284,7 @@ * This should not be changed. */ - #define UIP_RTO 3 +#define UIP_RTO 3 /** * The maximum number of times a segment should be retransmitted @@ -293,7 +293,7 @@ * This should not be changed. */ - #define UIP_MAXRTX 8 +#define UIP_MAXRTX 8 /** * The maximum number of times a SYN segment should be retransmitted @@ -303,7 +303,7 @@ * This should not need to be changed. */ - #define UIP_MAXSYNRTX 5 +#define UIP_MAXSYNRTX 5 /** * The TCP maximum segment size. @@ -312,11 +312,11 @@ * UIP_BUFSIZE - UIP_LLH_LEN - UIP_TCPIP_HLEN. */ - #ifndef UIP_CONF_TCP_MSS - #define UIP_TCP_MSS (UIP_BUFSIZE - UIP_LLH_LEN - UIP_TCPIP_HLEN) - #else - #define UIP_TCP_MSS UIP_CONF_TCP_MSS - #endif +#ifndef UIP_CONF_TCP_MSS +#define UIP_TCP_MSS (UIP_BUFSIZE - UIP_LLH_LEN - UIP_TCPIP_HLEN) +#else +#define UIP_TCP_MSS UIP_CONF_TCP_MSS +#endif /** * The size of the advertised receiver's window. * @@ -327,11 +327,11 @@ * \hideinitializer */ - #ifndef UIP_CONF_RECEIVE_WINDOW - #define UIP_RECEIVE_WINDOW UIP_TCP_MSS - #else - #define UIP_RECEIVE_WINDOW UIP_CONF_RECEIVE_WINDOW - #endif +#ifndef UIP_CONF_RECEIVE_WINDOW +#define UIP_RECEIVE_WINDOW UIP_TCP_MSS +#else +#define UIP_RECEIVE_WINDOW UIP_CONF_RECEIVE_WINDOW +#endif /** * How long a connection should stay in the TIME_WAIT state. * @@ -339,7 +339,7 @@ * left untouched. */ - #define UIP_TIME_WAIT_TIMEOUT 120 +#define UIP_TIME_WAIT_TIMEOUT 120 /** @} */ @@ -351,16 +351,16 @@ /** * The size of the ARP table. * - * This option should be set to a larger value if this uIP node will + * This option should be set to a larger value if this UIP node will * have many connections from the local network. * * \hideinitializer */ - #ifdef UIP_CONF_ARPTAB_SIZE - #define UIP_ARPTAB_SIZE UIP_CONF_ARPTAB_SIZE - #else - #define UIP_ARPTAB_SIZE 8 - #endif +#ifdef UIP_CONF_ARPTAB_SIZE +#define UIP_ARPTAB_SIZE UIP_CONF_ARPTAB_SIZE +#else +#define UIP_ARPTAB_SIZE 8 +#endif /** * The maxium age of ARP table entries measured in 10ths of seconds. * @@ -368,7 +368,7 @@ * default). */ - #define UIP_ARP_MAXAGE 120 +#define UIP_ARP_MAXAGE 120 /** @} */ @@ -378,20 +378,20 @@ * @{ */ /** - * The size of the uIP packet buffer. + * The size of the UIP packet buffer. * - * The uIP packet buffer should not be smaller than 60 bytes, and does + * The UIP packet buffer should not be smaller than 60 bytes, and does * not need to be larger than 1500 bytes. Lower size results in lower * TCP throughput, larger size results in higher TCP throughput. * * \hideinitializer */ - #ifndef UIP_CONF_BUFFER_SIZE - #define UIP_BUFSIZE 400 - #else /* UIP_CONF_BUFFER_SIZE */ +#ifndef UIP_CONF_BUFFER_SIZE +#define UIP_BUFSIZE 400 +#else /* UIP_CONF_BUFFER_SIZE */ - #define UIP_BUFSIZE UIP_CONF_BUFFER_SIZE - #endif /* UIP_CONF_BUFFER_SIZE */ +#define UIP_BUFSIZE UIP_CONF_BUFFER_SIZE +#endif /* UIP_CONF_BUFFER_SIZE */ /** * Determines if statistics support should be compiled in. @@ -401,12 +401,12 @@ * \hideinitializer */ - #ifndef UIP_CONF_STATISTICS - #define UIP_STATISTICS 0 - #else /* UIP_CONF_STATISTICS */ +#ifndef UIP_CONF_STATISTICS +#define UIP_STATISTICS 0 +#else /* UIP_CONF_STATISTICS */ - #define UIP_STATISTICS UIP_CONF_STATISTICS - #endif /* UIP_CONF_STATISTICS */ +#define UIP_STATISTICS UIP_CONF_STATISTICS +#endif /* UIP_CONF_STATISTICS */ /** * Determines if logging of certain events should be compiled in. @@ -418,12 +418,12 @@ * \hideinitializer */ - #ifndef UIP_CONF_LOGGING - #define UIP_LOGGING 0 - #else /* UIP_CONF_LOGGING */ +#ifndef UIP_CONF_LOGGING +#define UIP_LOGGING 0 +#else /* UIP_CONF_LOGGING */ - #define UIP_LOGGING UIP_CONF_LOGGING - #endif /* UIP_CONF_LOGGING */ +#define UIP_LOGGING UIP_CONF_LOGGING +#endif /* UIP_CONF_LOGGING */ /** * Broadcast support. @@ -435,18 +435,18 @@ * */ - #if UIP_UDP && UIP_CONF_BROADCAST - #define UIP_BROADCAST UIP_CONF_BROADCAST - #else /* UIP_CONF_BROADCAST */ +#if UIP_UDP && UIP_CONF_BROADCAST +#define UIP_BROADCAST UIP_CONF_BROADCAST +#else /* UIP_CONF_BROADCAST */ - #define UIP_BROADCAST 0 - #endif /* UIP_CONF_BROADCAST */ +#define UIP_BROADCAST 0 +#endif /* UIP_CONF_BROADCAST */ /** - * Print out a uIP log message. + * Print out a UIP log message. * - * This function must be implemented by the module that uses uIP, and - * is called by uIP whenever a log message is generated. + * This function must be implemented by the module that uses UIP, and + * is called by UIP whenever a log message is generated. */ void uip_log(char* msg); @@ -460,12 +460,12 @@ * \hideinitializer */ - #ifdef UIP_CONF_LLH_LEN - #define UIP_LLH_LEN UIP_CONF_LLH_LEN - #else /* UIP_CONF_LLH_LEN */ +#ifdef UIP_CONF_LLH_LEN +#define UIP_LLH_LEN UIP_CONF_LLH_LEN +#else /* UIP_CONF_LLH_LEN */ - #define UIP_LLH_LEN 14 - #endif /* UIP_CONF_LLH_LEN */ +#define UIP_LLH_LEN 14 +#endif /* UIP_CONF_LLH_LEN */ /** @} */ @@ -475,25 +475,25 @@ * @{ * * The CPU architecture configuration is where the endianess of the - * CPU on which uIP is to be run is specified. Most CPUs today are + * CPU on which UIP is to be run is specified. Most CPUs today are * little endian, and the most notable exception are the Motorolas * which are big endian. The BYTE_ORDER macro should be changed to - * reflect the CPU architecture on which uIP is to be run. + * reflect the CPU architecture on which UIP is to be run. */ /** - * The byte order of the CPU architecture on which uIP is to be run. + * The byte order of the CPU architecture on which UIP is to be run. * * This option can be either BIG_ENDIAN (Motorola byte order) or * LITTLE_ENDIAN (Intel byte order). * * \hideinitializer */ - #ifdef UIP_CONF_BYTE_ORDER - #define UIP_BYTE_ORDER UIP_CONF_BYTE_ORDER - #else /* UIP_CONF_BYTE_ORDER */ +#ifdef UIP_CONF_BYTE_ORDER +#define UIP_BYTE_ORDER UIP_CONF_BYTE_ORDER +#else /* UIP_CONF_BYTE_ORDER */ - #define UIP_BYTE_ORDER UIP_LITTLE_ENDIAN - #endif /* UIP_CONF_BYTE_ORDER */ +#define UIP_BYTE_ORDER UIP_LITTLE_ENDIAN +#endif /* UIP_CONF_BYTE_ORDER */ /** @} */ @@ -502,12 +502,12 @@ * \name Appication specific configurations * @{ * - * An uIP application is implemented using a single application - * function that is called by uIP whenever a TCP/IP event occurs. The - * name of this function must be registered with uIP at compile time + * An UIP application is implemented using a single application + * function that is called by UIP whenever a TCP/IP event occurs. The + * name of this function must be registered with UIP at compile time * using the UIP_APPCALL definition. * - * uIP applications can store the application state within the + * UIP applications can store the application state within the * uip_conn structure by specifying the type of the application * structure by typedef:ing the type uip_tcp_appstate_t and uip_udp_appstate_t. * @@ -532,7 +532,7 @@ /** * \var #define UIP_APPCALL * - * The name of the application function that uIP should call in + * The name of the application function that UIP should call in * response to TCP/IP events. * */