git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/WIN32-MSVC-lwIP/lwIP_Apps/lwipopts.h

   1 /*
   2  * Copyright (c) 2001-2003 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 <adam@sics.se>
  30  *
  31  */
  32 #ifndef __LWIPOPTS_H__
  33 #define __LWIPOPTS_H__
  34
  35 /* Functions used to obtain and release exclusive access to the Tx buffer.  The
  36 Get function will block if the Tx buffer is not available - use with care! */
  37 signed char *pcLwipBlockingGetTxBuffer( void );
  38 void vLwipAppsReleaseTxBuffer( void );
  39
  40
  41 /* SSI options. */
  42 #define TCPIP_THREAD_NAME              "tcpip"
  43 #define LWIP_HTTPD_MAX_TAG_NAME_LEN 20
  44 #define LWIP_HTTPD_MAX_TAG_INSERT_LEN 1024
  45 #define TCPIP_THREAD_PRIO configLWIP_TASK_PRIORITY
  46 #define TCPIP_THREAD_STACKSIZE configMINIMAL_STACK_SIZE * 3
  47
  48 #define DEFAULT_TCP_RECVMBOX_SIZE 5
  49 #define DEFAULT_ACCEPTMBOX_SIZE 5
  50 #define TCPIP_MBOX_SIZE                                 10
  51
  52 #define NO_SYS                                                  0
  53 #define LWIP_SOCKET                                             (NO_SYS==0)
  54 #define LWIP_NETCONN                            1
  55
  56 #define LWIP_SNMP                                               0
  57 #define LWIP_IGMP                                               0
  58 #define LWIP_ICMP                                               1
  59
  60 /* DNS is not going to be used as this is a simple local example. */
  61 #define LWIP_DNS                                                0
  62
  63 #define LWIP_HAVE_LOOPIF                                0
  64 #define TCP_LISTEN_BACKLOG                              0
  65 #define LWIP_SO_RCVTIMEO                                1
  66 #define LWIP_SO_RCVBUF                                  1
  67
  68 #ifdef LWIP_DEBUG
  69
  70 #define LWIP_DBG_MIN_LEVEL         0
  71 #define PPP_DEBUG                  LWIP_DBG_ON
  72 #define MEM_DEBUG                  LWIP_DBG_ON
  73 #define MEMP_DEBUG                 LWIP_DBG_ON
  74 #define PBUF_DEBUG                 LWIP_DBG_ON
  75 #define API_LIB_DEBUG              LWIP_DBG_ON
  76 #define API_MSG_DEBUG              LWIP_DBG_ON
  77 #define TCPIP_DEBUG                LWIP_DBG_ON
  78 #define NETIF_DEBUG                LWIP_DBG_ON
  79 #define SOCKETS_DEBUG              LWIP_DBG_ON
  80 #define DNS_DEBUG                  LWIP_DBG_ON
  81 #define AUTOIP_DEBUG               LWIP_DBG_ON
  82 #define DHCP_DEBUG                 LWIP_DBG_ON
  83 #define IP_DEBUG                   LWIP_DBG_ON
  84 #define IP_REASS_DEBUG             LWIP_DBG_ON
  85 #define ICMP_DEBUG                 LWIP_DBG_ON
  86 #define IGMP_DEBUG                 LWIP_DBG_ON
  87 #define UDP_DEBUG                  LWIP_DBG_ON
  88 #define TCP_DEBUG                  LWIP_DBG_ON
  89 #define TCP_INPUT_DEBUG            LWIP_DBG_ON
  90 #define TCP_OUTPUT_DEBUG           LWIP_DBG_ON
  91 #define TCP_RTO_DEBUG              LWIP_DBG_ON
  92 #define TCP_CWND_DEBUG             LWIP_DBG_ON
  93 #define TCP_WND_DEBUG              LWIP_DBG_ON
  94 #define TCP_FR_DEBUG               LWIP_DBG_ON
  95 #define TCP_QLEN_DEBUG             LWIP_DBG_ON
  96 #define TCP_RST_DEBUG              LWIP_DBG_ON
  97 #endif
  98
  99 #define LWIP_DBG_TYPES_ON         (LWIP_DBG_ON|LWIP_DBG_TRACE|LWIP_DBG_STATE|LWIP_DBG_FRESH|LWIP_DBG_HALT)
 100
 101
 102
 103 /* ---------- Memory options ---------- */
 104 /* MEM_ALIGNMENT: should be set to the alignment of the CPU for which
 105    lwIP is compiled. 4 byte alignment -> define MEM_ALIGNMENT to 4, 2
 106    byte alignment -> define MEM_ALIGNMENT to 2. */
 107 /* MSVC port: intel processors don't need 4-byte alignment,
 108    but are faster that way! */
 109 #define MEM_ALIGNMENT                   4
 110
 111 /* MEM_SIZE: the size of the heap memory. If the application will send
 112 a lot of data that needs to be copied, this should be set high. */
 113 #define MEM_SIZE                                10240
 114
 115 /* MEMP_NUM_PBUF: the number of memp struct pbufs. If the application
 116    sends a lot of data out of ROM (or other static memory), this
 117    should be set high. */
 118 #define MEMP_NUM_PBUF                   10
 119
 120 /* MEMP_NUM_RAW_PCB: the number of UDP protocol control blocks. One
 121    per active RAW "connection". */
 122 #define LWIP_RAW                                0
 123 #define MEMP_NUM_RAW_PCB                0
 124
 125 /* MEMP_NUM_UDP_PCB: the number of UDP protocol control blocks. One
 126    per active UDP "connection". */
 127 #define MEMP_NUM_UDP_PCB                2
 128
 129 /* MEMP_NUM_TCP_PCB: the number of simulatenously active TCP
 130    connections. */
 131 #define MEMP_NUM_TCP_PCB                30
 132
 133 /* MEMP_NUM_TCP_PCB_LISTEN: the number of listening TCP
 134    connections. */
 135 #define MEMP_NUM_TCP_PCB_LISTEN 2
 136
 137 /* MEMP_NUM_TCP_SEG: the number of simultaneously queued TCP
 138    segments. */
 139 #define MEMP_NUM_TCP_SEG                10
 140
 141 /* MEMP_NUM_SYS_TIMEOUT: the number of simulateously active
 142    timeouts. */
 143 #define MEMP_NUM_SYS_TIMEOUT    15
 144
 145 /* The following four are used only with the sequential API and can be
 146    set to 0 if the application only will use the raw API. */
 147 /* MEMP_NUM_NETBUF: the number of struct netbufs. */
 148 #define MEMP_NUM_NETBUF         0
 149
 150 /* MEMP_NUM_NETCONN: the number of struct netconns. */
 151 #define MEMP_NUM_NETCONN        10
 152
 153 /* MEMP_NUM_TCPIP_MSG_*: the number of struct tcpip_msg, which is used
 154    for sequential API communication and incoming packets. Used in
 155    src/api/tcpip.c. */
 156 #define MEMP_NUM_TCPIP_MSG_API   4
 157 #define MEMP_NUM_TCPIP_MSG_INPKT 4
 158
 159 #define MEMP_NUM_ARP_QUEUE              5
 160
 161 /* ---------- Pbuf options ---------- */
 162 /* PBUF_POOL_SIZE: the number of buffers in the pbuf pool. */
 163 #define PBUF_POOL_SIZE                  10
 164
 165 /* PBUF_POOL_BUFSIZE: the size of each pbuf in the pbuf pool. */
 166 #define PBUF_POOL_BUFSIZE               375
 167
 168 /* PBUF_LINK_HLEN: the number of bytes that should be allocated for a
 169    link level header. */
 170 #define PBUF_LINK_HLEN                  16
 171
 172 /** SYS_LIGHTWEIGHT_PROT
 173  * define SYS_LIGHTWEIGHT_PROT in lwipopts.h if you want inter-task protection
 174  * for certain critical regions during buffer allocation, deallocation and memory
 175  * allocation and deallocation.
 176  */
 177 #define SYS_LIGHTWEIGHT_PROT    (NO_SYS==0)
 178
 179
 180 /* ---------- TCP options ---------- */
 181 #define LWIP_TCP                                1
 182 #define TCP_TTL                                 255
 183
 184 /* Controls if TCP should queue segments that arrive out of
 185    order. Define to 0 if your device is low on memory. */
 186 #define TCP_QUEUE_OOSEQ                 1
 187
 188 /* TCP Maximum segment size. */
 189 #define TCP_MSS                                 1460
 190
 191 /* TCP sender buffer space (bytes). */
 192 #define TCP_SND_BUF                             ( TCP_MSS * 2 )
 193
 194 /* TCP sender buffer space (pbufs). This must be at least = 2 *
 195    TCP_SND_BUF/TCP_MSS for things to work. */
 196 #define TCP_SND_QUEUELEN                (4 * TCP_SND_BUF/TCP_MSS)
 197
 198 /* TCP writable space (bytes). This must be less than or equal
 199    to TCP_SND_BUF. It is the amount of space which must be
 200    available in the tcp snd_buf for select to return writable */
 201 #define TCP_SNDLOWAT                    (TCP_SND_BUF/2)
 202
 203 /* TCP receive window. */
 204 #define TCP_WND                                 ( PBUF_POOL_SIZE * PBUF_POOL_BUFSIZE )
 205
 206 /* Maximum number of retransmissions of data segments. */
 207 #define TCP_MAXRTX                              12
 208
 209 /* Maximum number of retransmissions of SYN segments. */
 210 #define TCP_SYNMAXRTX                   4
 211
 212
 213 /* ---------- ARP options ---------- */
 214 #define LWIP_ARP                                1
 215 #define ARP_TABLE_SIZE                  10
 216 #define ARP_QUEUEING                    1
 217
 218
 219 /* ---------- IP options ---------- */
 220 /* Define IP_FORWARD to 1 if you wish to have the ability to forward
 221    IP packets across network interfaces. If you are going to run lwIP
 222    on a device with only one network interface, define this to 0. */
 223 #define IP_FORWARD                              0
 224
 225 /* IP reassembly and segmentation.These are orthogonal even
 226  * if they both deal with IP fragments */
 227 #define IP_REASSEMBLY                   0
 228 #define IP_REASS_MAX_PBUFS              10
 229 #define MEMP_NUM_REASSDATA              10
 230 #define IP_FRAG                                 0
 231
 232
 233 /* ---------- ICMP options ---------- */
 234 #define ICMP_TTL                                255
 235
 236
 237 /* ---------- DHCP options ---------- */
 238 /* Define LWIP_DHCP to 1 if you want DHCP configuration of
 239    interfaces. */
 240 #define LWIP_DHCP                               0
 241
 242 /* 1 if you want to do an ARP check on the offered address
 243    (recommended). */
 244 #define DHCP_DOES_ARP_CHECK             (LWIP_DHCP)
 245
 246
 247 /* ---------- AUTOIP options ------- */
 248 #define LWIP_AUTOIP                             0
 249 #define LWIP_DHCP_AUTOIP_COOP   (LWIP_DHCP && LWIP_AUTOIP)
 250
 251
 252 /* ---------- UDP options ---------- */
 253 #define LWIP_UDP                                1
 254 #define LWIP_UDPLITE                    1
 255 #define UDP_TTL                                 255
 256
 257
 258 /* ---------- Statistics options ---------- */
 259
 260 #define LWIP_STATS                              1
 261 #define LWIP_STATS_DISPLAY              0
 262
 263 #if LWIP_STATS
 264         #define LINK_STATS                              1
 265         #define IP_STATS                                1
 266         #define ICMP_STATS                              0
 267         #define IGMP_STATS                              0
 268         #define IPFRAG_STATS                    0
 269         #define UDP_STATS                               1
 270         #define TCP_STATS                               1
 271         #define MEM_STATS                               1
 272         #define MEMP_STATS                              1
 273         #define PBUF_STATS                              1
 274         #define SYS_STATS                               1
 275 #endif /* LWIP_STATS */
 276
 277
 278 /* ---------- PPP options ---------- */
 279
 280 #define PPP_SUPPORT                      0        /* Set > 0 for PPP */
 281
 282 #if PPP_SUPPORT
 283
 284         #define NUM_PPP                                 1         /* Max PPP sessions. */
 285
 286         /* Select modules to enable.  Ideally these would be set in the makefile but
 287          * we're limited by the command line length so you need to modify the settings
 288          * in this file.
 289          */
 290         #define PPPOE_SUPPORT                   1
 291         #define PPPOS_SUPPORT                   1
 292         #define PAP_SUPPORT                             1         /* Set > 0 for PAP. */
 293         #define CHAP_SUPPORT                    1         /* Set > 0 for CHAP. */
 294         #define MSCHAP_SUPPORT                  0         /* Set > 0 for MSCHAP (NOT FUNCTIONAL!) */
 295         #define CBCP_SUPPORT                    0         /* Set > 0 for CBCP (NOT FUNCTIONAL!) */
 296         #define CCP_SUPPORT                             0         /* Set > 0 for CCP (NOT FUNCTIONAL!) */
 297         #define VJ_SUPPORT                              1         /* Set > 0 for VJ header compression. */
 298         #define MD5_SUPPORT                             1         /* Set > 0 for MD5 (see also CHAP) */
 299
 300 #endif /* PPP_SUPPORT */
 301
 302 #endif /* __LWIPOPTS_H__ */