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	DEFAULT_ACCEPTMBOX_SIZE   16
#define	DEFAULT_RAW_RECVMBOX_SIZE   16
#define	DEFAULT_TCP_RECVMBOX_SIZE   16
#define	DHCP_DEBUG   LWIP_DBG_OFF
#define	DHCP_USED
#define	DNS_DEBUG   LWIP_DBG_OFF
#define	ETHARP_DEBUG   LWIP_DBG_OFF
#define	ETHARP_STATS   0
#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_ALL
#define	LWIP_DBG_TYPES_ON   LWIP_DBG_ON
#define	LWIP_DHCP   1
	LWIP_DHCP==1: Enable DHCP module. More...
#define	LWIP_NETCONN   1
#define	LWIP_NETIF_STATUS_CALLBACK   1
#define	LWIP_NOASSERT
#define	LWIP_RAW   0
#define	LWIP_SOCKET   0
#define	LWIP_STATS   1
	LWIP_STATS==1: Enable statistics collection in lwip_stats. More...
#define	LWIP_STATS_DISPLAY   1
	LWIP_STATS_DISPLAY==1: Compile in the statistics output functions. More...
#define	LWIP_STATS_LARGE   1
	LWIP_STATS_LARGE==1: Use 32 bits counter instead of 16. More...
#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   15 * 1024
	MEM_SIZE: the size of the heap memory. More...
#define	MEM_STATS   1
#define	MEMP_DEBUG   LWIP_DBG_OFF
#define	MEMP_NUM_NETBUF   9
	MEMP_NUM_NETBUF: the number of struct netbufs. More...
#define	MEMP_NUM_NETCONN   16
	MEMP_NUM_NETCONN: the number of struct netconns. More...
#define	MEMP_NUM_PBUF   10
	MEMP_NUM_PBUF: the number of memp struct pbufs (used for PBUF_ROM and PBUF_REF). More...
#define	MEMP_NUM_TCP_PCB   16
	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	netifINTERFACE_TASK_PRIORITY   (tskIDLE_PRIORITY + 4)
	The priority of the netif stack. More...
#define	netifINTERFACE_TASK_STACK_SIZE   256
	The stack sizes allocated to the netif stack: (256 * 4) = 1048 bytes. More...
#define	NO_SYS   0
	NO_SYS==1: Provides VERY minimal functionality. More...
#define	PBUF_DEBUG   LWIP_DBG_OFF
#define	PBUF_POOL_BUFSIZE   LWIP_MEM_ALIGN_SIZE(TCP_MSS+40+PBUF_LINK_HLEN+4)
	PBUF_POOL_BUFSIZE: the size of each pbuf in the pbuf pool. More...
#define	PBUF_POOL_SIZE   15
	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   1
	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   1460
	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	TCPIP_MBOX_SIZE   16
	The mailbox size for the tcpip thread messages. More...
#define	TCPIP_THREAD_PRIO   (tskIDLE_PRIORITY + 5)
	The priority of the TCPIP stack. More...
#define	TCPIP_THREAD_STACKSIZE   256
	The stack sizes allocated to the TCPIP stack: (256 * 4) = 1048 bytes. More...
#define	TIMERS_DEBUG   LWIP_DBG_OFF
#define	UDP_DEBUG   LWIP_DBG_OFF
#define	UDP_STATS   0

#define API_LIB_DEBUG   LWIP_DBG_OFF

Referenced by netconn_recv_data(), and netconn_send().

#define API_MSG_DEBUG   LWIP_DBG_OFF

Referenced by accept_function().

#define AUTOIP_DEBUG   LWIP_DBG_OFF

#define DEFAULT_ACCEPTMBOX_SIZE   16

Referenced by do_listen().

#define DEFAULT_RAW_RECVMBOX_SIZE   16

Referenced by netconn_alloc().

#define DEFAULT_TCP_RECVMBOX_SIZE   16

Referenced by netconn_alloc().

#define DHCP_DEBUG   LWIP_DBG_OFF

Referenced by dhcp_arp_reply(), dhcp_bind(), dhcp_check(), dhcp_coarse_tmr(), dhcp_create_msg(), dhcp_decline(), dhcp_discover(), dhcp_fine_tmr(), dhcp_handle_nak(), dhcp_handle_offer(), dhcp_inform(), dhcp_parse_reply(), dhcp_rebind(), dhcp_reboot(), dhcp_recv(), dhcp_release(), dhcp_renew(), dhcp_select(), dhcp_start(), dhcp_stop(), dhcp_t1_timeout(), dhcp_t2_timeout(), and dhcp_timeout().

#define DHCP_USED

#define DNS_DEBUG   LWIP_DBG_OFF

#define ETHARP_DEBUG   LWIP_DBG_OFF

Referenced by etharp_arp_input(), etharp_find_entry(), etharp_free_entry(), etharp_output(), etharp_query(), etharp_raw(), etharp_request(), etharp_send_ip(), etharp_tmr(), etharp_update_arp_entry(), and ethernet_input().

#define ETHARP_STATS   0

#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

Referenced by inet_chksum_pseudo(), and inet_chksum_pseudo_partial().

#define IP_DEBUG   LWIP_DBG_OFF

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

#define IP_REASS_DEBUG   LWIP_DBG_OFF

Referenced by ip_frag(), ip_reass(), ip_reass_enqueue_new_datagram(), and ip_reass_tmr().

#define IP_STATS   1

#define IPFRAG_STATS   0

#define LINK_STATS   1

#define LWIP_DBG_MIN_LEVEL   LWIP_DBG_LEVEL_ALL

#define LWIP_DBG_TYPES_ON   LWIP_DBG_ON

#define LWIP_DHCP   1

LWIP_DHCP==1: Enable DHCP module.

#define LWIP_NETCONN   1

#define LWIP_NETIF_STATUS_CALLBACK   1

#define LWIP_NOASSERT

#define LWIP_RAW   0

#define LWIP_SOCKET   0

#define LWIP_STATS   1

LWIP_STATS==1: Enable statistics collection in lwip_stats.

#define LWIP_STATS_DISPLAY   1

LWIP_STATS_DISPLAY==1: Compile in the statistics output functions.

#define LWIP_STATS_LARGE   1

LWIP_STATS_LARGE==1: Use 32 bits counter instead of 16.

#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   15 * 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   9

MEMP_NUM_NETBUF: the number of struct netbufs.

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

#define MEMP_NUM_NETCONN   16

MEMP_NUM_NETCONN: the number of struct netconns.

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

#define MEMP_NUM_PBUF   10

MEMP_NUM_PBUF: the number of memp struct pbufs (used for PBUF_ROM and PBUF_REF).

If the application sends a lot of data out of ROM (or other static memory), this should be set high.

#define MEMP_NUM_TCP_PCB   16

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 NETIF_DEBUG   LWIP_DBG_OFF

Referenced by ethernetif_input(), ksz8851snl_low_level_init(), ksz8851snl_low_level_input(), ksz8851snl_low_level_output(), ksz8851snl_rx_populate_queue(), ksz8851snl_update(), netif_add(), netif_find(), netif_remove(), netif_set_default(), netif_set_gw(), netif_set_ipaddr(), and netif_set_netmask().

#define netifINTERFACE_TASK_PRIORITY   (tskIDLE_PRIORITY + 4)

The priority of the netif stack.

Referenced by ethernetif_init().

#define netifINTERFACE_TASK_STACK_SIZE   256

The stack sizes allocated to the netif stack: (256 * 4) = 1048 bytes.

Referenced by ethernetif_init().

#define NO_SYS   0

NO_SYS==1: Provides VERY minimal functionality.

Otherwise, use lwIP facilities.

#define PBUF_DEBUG   LWIP_DBG_OFF

Referenced by pbuf_alloc(), pbuf_alloced_custom(), pbuf_chain(), pbuf_copy(), pbuf_dechain(), pbuf_free(), pbuf_free_ooseq(), and pbuf_header().

#define PBUF_POOL_BUFSIZE   LWIP_MEM_ALIGN_SIZE(TCP_MSS+40+PBUF_LINK_HLEN+4)

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.

NOTE: Added extra word to handle Micrel requirement.

Referenced by ksz8851snl_rx_populate_queue().

#define PBUF_POOL_SIZE   15

PBUF_POOL_SIZE: the number of buffers in the pbuf pool.

#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   1

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

Referenced by tcp_output(), tcp_receive(), and tcp_slowtmr().

#define TCP_DEBUG   LWIP_DBG_OFF

Referenced by tcp_alloc(), tcp_bind(), tcp_close(), tcp_connect(), tcp_fasttmr(), tcp_keepalive(), tcp_kill_prio(), tcp_kill_timewait(), tcp_listen_input(), tcp_output_segment(), tcp_pcb_purge(), tcp_process(), tcp_recved(), tcp_rst(), tcp_slowtmr(), and tcp_zero_window_probe().

#define TCP_FR_DEBUG   LWIP_DBG_OFF

Referenced by tcp_rexmit_fast().

#define TCP_INPUT_DEBUG   LWIP_DBG_OFF

Referenced by tcp_input(), tcp_parseopt(), tcp_process(), tcp_process_refused_data(), and tcp_receive().

#define TCP_MSS   1460

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_OUTPUT_DEBUG   LWIP_DBG_OFF

Referenced by tcp_create_segment(), tcp_enqueue_flags(), tcp_output(), tcp_output_segment(), tcp_send_empty_ack(), tcp_write(), and tcp_write_checks().

#define TCP_QLEN_DEBUG   LWIP_DBG_OFF

Referenced by tcp_enqueue_flags(), tcp_process(), tcp_receive(), tcp_write(), and tcp_write_checks().

#define TCP_RST_DEBUG   LWIP_DBG_OFF

Referenced by tcp_abandon(), tcp_input(), tcp_listen_input(), and tcp_rst().

#define TCP_RTO_DEBUG   LWIP_DBG_OFF

Referenced by tcp_output_segment(), tcp_receive(), and tcp_slowtmr().

#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

Referenced by tcpip_input(), and tcpip_thread().

#define TCPIP_MBOX_SIZE   16

The mailbox size for the tcpip thread messages.

Referenced by tcpip_init().

#define TCPIP_THREAD_PRIO   (tskIDLE_PRIORITY + 5)

The priority of the TCPIP stack.

Referenced by tcpip_init().

#define TCPIP_THREAD_STACKSIZE   256

The stack sizes allocated to the TCPIP stack: (256 * 4) = 1048 bytes.

Referenced by tcpip_init().

#define TIMERS_DEBUG   LWIP_DBG_OFF

Referenced by arp_timer(), dhcp_timer_coarse(), dhcp_timer_fine(), and ip_reass_timer().

#define UDP_DEBUG   LWIP_DBG_OFF

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

#define UDP_STATS   0