Microchip® Advanced Software Framework

lwipopts.h File Reference

LwIP configuration.

Copyright (c) 2013-2018 Microchip Technology Inc. and its subsidiaries.

#include "conf_eth.h"

Macros

#define API_LIB_DEBUG   LWIP_DBG_OFF
 
#define API_MSG_DEBUG   LWIP_DBG_OFF
 
#define AUTOIP_DEBUG   LWIP_DBG_OFF
 
#define DHCP_DEBUG   LWIP_DBG_OFF
 
#define DHCP_DOES_ARP_CHECK   1
 
#define DHCP_USED
 
#define DNS_DEBUG   LWIP_DBG_OFF
 
#define ETHARP_DEBUG   LWIP_DBG_OFF
 
#define HTTP_RAW_USED
 
#define ICMP_DEBUG   LWIP_DBG_OFF
 
#define ICMP_STATS   0
 
#define IGMP_DEBUG   LWIP_DBG_OFF
 
#define IGMP_STATS   0
 
#define INET_DEBUG   LWIP_DBG_OFF
 
#define IP_DEBUG   LWIP_DBG_OFF
 
#define IP_REASS_DEBUG   LWIP_DBG_OFF
 
#define IP_STATS   1
 
#define IPFRAG_STATS   0
 
#define LINK_STATS   1
 
#define LWIP_DBG_MIN_LEVEL   LWIP_DBG_LEVEL_SEVERE
 
#define LWIP_DBG_TYPES_ON   LWIP_DBG_OFF
 
#define LWIP_DHCP   1
 PBUF_POOL_BUFSIZE: the size of each pbuf in the pbuf pool. More...
 
#define LWIP_NETCONN   0
 
#define LWIP_NETIF_STATUS_CALLBACK   1
 
#define LWIP_NOASSERT
 
#define LWIP_RAW   1
 
#define LWIP_SOCKET   0
 
#define LWIP_STATS   1
 
#define LWIP_STATS_DISPLAY   0
 
#define LWIP_STATS_LARGE   0
 
#define LWIP_TCP   1
 LWIP_TCP==1: Turn on TCP. More...
 
#define LWIP_UDP   1
 LWIP_UDP==1: Turn on UDP. More...
 
#define MEM_ALIGNMENT   4
 MEM_ALIGNMENT: should be set to the alignment of the CPU 4 byte alignment -> #define MEM_ALIGNMENT 4 2 byte alignment -> #define MEM_ALIGNMENT 2. More...
 
#define MEM_DEBUG   LWIP_DBG_OFF
 
#define MEM_SIZE   20 * 1024
 MEM_SIZE: the size of the heap memory. More...
 
#define MEM_STATS   1
 
#define MEMP_DEBUG   LWIP_DBG_OFF
 
#define MEMP_NUM_NETBUF   0
 MEMP_NUM_NETBUF: the number of struct netbufs. More...
 
#define MEMP_NUM_NETCONN   0
 MEMP_NUM_NETCONN: the number of struct netconns. More...
 
#define MEMP_NUM_TCP_PCB   14
 MEMP_NUM_TCP_PCB: the number of simulatenously active TCP connections. More...
 
#define MEMP_NUM_TCP_PCB_LISTEN   1
 MEMP_NUM_TCP_PCB_LISTEN: the number of listening TCP connections. More...
 
#define MEMP_STATS   1
 
#define NETIF_DEBUG   LWIP_DBG_OFF
 
#define NO_SYS   1
 NO_SYS==1: Provides VERY minimal functionality. More...
 
#define PBUF_DEBUG   LWIP_DBG_OFF
 
#define PBUF_POOL_SIZE   10
 PBUF_POOL_SIZE: the number of buffers in the pbuf pool. More...
 
#define PPP_DEBUG   LWIP_DBG_OFF
 
#define RAW_DEBUG   LWIP_DBG_OFF
 
#define SLIP_DEBUG   LWIP_DBG_OFF
 
#define SNMP_MIB_DEBUG   LWIP_DBG_OFF
 
#define SNMP_MSG_DEBUG   LWIP_DBG_OFF
 
#define SOCKETS_DEBUG   LWIP_DBG_OFF
 
#define SYS_DEBUG   LWIP_DBG_OFF
 
#define SYS_LIGHTWEIGHT_PROT   0
 SYS_LIGHTWEIGHT_PROT==1: if you want inter-task protection for certain critical regions during buffer allocation, deallocation and memory allocation and deallocation. More...
 
#define SYS_STATS   1
 
#define TCP_CWND_DEBUG   LWIP_DBG_OFF
 
#define TCP_DEBUG   LWIP_DBG_OFF
 
#define TCP_FR_DEBUG   LWIP_DBG_OFF
 
#define TCP_INPUT_DEBUG   LWIP_DBG_OFF
 
#define TCP_MSS   1500
 TCP_MSS: The maximum segment size controls the maximum amount of payload bytes per packet. More...
 
#define TCP_OUTPUT_DEBUG   LWIP_DBG_OFF
 
#define TCP_QLEN_DEBUG   LWIP_DBG_OFF
 
#define TCP_RST_DEBUG   LWIP_DBG_OFF
 
#define TCP_RTO_DEBUG   LWIP_DBG_OFF
 
#define TCP_SND_BUF   (2 * TCP_MSS)
 TCP_SND_BUF: TCP sender buffer space (bytes). More...
 
#define TCP_STATS   1
 
#define TCP_WND   (2 * TCP_MSS)
 TCP_WND: The size of a TCP window. More...
 
#define TCP_WND_DEBUG   LWIP_DBG_OFF
 
#define TCPIP_DEBUG   LWIP_DBG_OFF
 
#define TIMERS_DEBUG   LWIP_DBG_OFF
 
#define UDP_DEBUG   LWIP_DBG_OFF
 
#define UDP_STATS   0
 

#define API_LIB_DEBUG   LWIP_DBG_OFF
#define API_MSG_DEBUG   LWIP_DBG_OFF
#define AUTOIP_DEBUG   LWIP_DBG_OFF
#define DHCP_DOES_ARP_CHECK   1
#define DHCP_USED
#define DNS_DEBUG   LWIP_DBG_OFF
#define HTTP_RAW_USED
#define ICMP_DEBUG   LWIP_DBG_OFF

Referenced by icmp_input(), and icmp_send_response().

#define ICMP_STATS   0
#define IGMP_DEBUG   LWIP_DBG_OFF
#define IGMP_STATS   0
#define INET_DEBUG   LWIP_DBG_OFF
#define IP_DEBUG   LWIP_DBG_OFF

Referenced by ip_input(), ip_output(), and ip_route().

#define IP_REASS_DEBUG   LWIP_DBG_OFF
#define IP_STATS   1
#define IPFRAG_STATS   0
#define LINK_STATS   1
#define LWIP_DBG_MIN_LEVEL   LWIP_DBG_LEVEL_SEVERE
#define LWIP_DBG_TYPES_ON   LWIP_DBG_OFF
#define LWIP_DHCP   1

PBUF_POOL_BUFSIZE: the size of each pbuf in the pbuf pool.

The default is designed to accomodate single full size TCP frame in one pbuf, including TCP_MSS, IP header, and link header. LWIP_DHCP==1: Enable DHCP module.

#define LWIP_NETCONN   0
#define LWIP_NETIF_STATUS_CALLBACK   1
#define LWIP_NOASSERT
#define LWIP_RAW   1
#define LWIP_SOCKET   0
#define LWIP_STATS   1
#define LWIP_STATS_DISPLAY   0
#define LWIP_STATS_LARGE   0
#define LWIP_TCP   1

LWIP_TCP==1: Turn on TCP.

#define LWIP_UDP   1

LWIP_UDP==1: Turn on UDP.

#define MEM_ALIGNMENT   4

MEM_ALIGNMENT: should be set to the alignment of the CPU 4 byte alignment -> #define MEM_ALIGNMENT 4 2 byte alignment -> #define MEM_ALIGNMENT 2.

Referenced by if(), mem_free(), mem_init(), mem_malloc(), memp_free(), pbuf_alloc(), and tcp_enqueue_flags().

#define MEM_DEBUG   LWIP_DBG_OFF

Referenced by mem_free(), mem_malloc(), and mem_trim().

#define MEM_SIZE   20 * 1024

MEM_SIZE: the size of the heap memory.

If the application will send a lot of data that needs to be copied, this should be set high.

#define MEM_STATS   1
#define MEMP_DEBUG   LWIP_DBG_OFF
#define MEMP_NUM_NETBUF   0

MEMP_NUM_NETBUF: the number of struct netbufs.

(only needed if you use the sequential API, like api_lib.c)

#define MEMP_NUM_NETCONN   0

MEMP_NUM_NETCONN: the number of struct netconns.

(only needed if you use the sequential API, like api_lib.c)

#define MEMP_NUM_TCP_PCB   14

MEMP_NUM_TCP_PCB: the number of simulatenously active TCP connections.

(requires the LWIP_TCP option)

#define MEMP_NUM_TCP_PCB_LISTEN   1

MEMP_NUM_TCP_PCB_LISTEN: the number of listening TCP connections.

(requires the LWIP_TCP option)

#define MEMP_STATS   1
#define NO_SYS   1

NO_SYS==1: Provides VERY minimal functionality.

Otherwise, use lwIP facilities.

#define PBUF_POOL_SIZE   10

PBUF_POOL_SIZE: the number of buffers in the pbuf pool.

#define PPP_DEBUG   LWIP_DBG_OFF
#define RAW_DEBUG   LWIP_DBG_OFF

Referenced by raw_new(), and raw_sendto().

#define SLIP_DEBUG   LWIP_DBG_OFF
#define SNMP_MIB_DEBUG   LWIP_DBG_OFF
#define SNMP_MSG_DEBUG   LWIP_DBG_OFF
#define SOCKETS_DEBUG   LWIP_DBG_OFF
#define SYS_DEBUG   LWIP_DBG_OFF
#define SYS_LIGHTWEIGHT_PROT   0

SYS_LIGHTWEIGHT_PROT==1: if you want inter-task protection for certain critical regions during buffer allocation, deallocation and memory allocation and deallocation.

#define SYS_STATS   1
#define TCP_CWND_DEBUG   LWIP_DBG_OFF
#define TCP_FR_DEBUG   LWIP_DBG_OFF

Referenced by tcp_rexmit_fast().

#define TCP_MSS   1500

TCP_MSS: The maximum segment size controls the maximum amount of payload bytes per packet.

For maximum throughput, set this as high as possible for your network (i.e. 1460 bytes for standard ethernet). For the receive side, this MSS is advertised to the remote side when opening a connection. For the transmit size, this MSS sets an upper limit on the MSS advertised by the remote host.

Referenced by tcp_alloc(), tcp_connect(), tcp_output_segment(), and tcp_parseopt().

#define TCP_QLEN_DEBUG   LWIP_DBG_OFF
#define TCP_RST_DEBUG   LWIP_DBG_OFF
#define TCP_RTO_DEBUG   LWIP_DBG_OFF
#define TCP_SND_BUF   (2 * TCP_MSS)

TCP_SND_BUF: TCP sender buffer space (bytes).

To achieve good performance, this should be at least 2 * TCP_MSS.

Referenced by tcp_alloc().

#define TCP_STATS   1
#define TCP_WND   (2 * TCP_MSS)

TCP_WND: The size of a TCP window.

This must be at least (2 * TCP_MSS) for things to work well

Referenced by tcp_alloc(), tcp_close_shutdown(), tcp_connect(), tcp_input(), tcp_process_refused_data(), tcp_recved(), tcp_rst(), and tcp_update_rcv_ann_wnd().

#define TCP_WND_DEBUG   LWIP_DBG_OFF

Referenced by tcp_receive().

#define TCPIP_DEBUG   LWIP_DBG_OFF
#define TIMERS_DEBUG   LWIP_DBG_OFF
#define UDP_DEBUG   LWIP_DBG_OFF

Referenced by udp_bind(), udp_connect(), and udp_input().

#define UDP_STATS   0