Mistake on this page?
Report an issue in GitHub or email us
Modules | Macros

Modules

 ARP
 
 ICMP
 
 DHCP
 
 AUTOIP
 
 IGMP
 

Macros

#define LWIP_IPV4   1
 LWIP_IPV4==1: Enable IPv4. More...
 
#define IP_FORWARD   0
 IP_FORWARD==1: Enables the ability to forward IP packets across network interfaces. More...
 
#define IP_REASSEMBLY   1
 IP_REASSEMBLY==1: Reassemble incoming fragmented IP packets. More...
 
#define IP_FRAG   1
 IP_FRAG==1: Fragment outgoing IP packets if their size exceeds MTU. More...
 
#define IP_OPTIONS_ALLOWED   1
 IP_OPTIONS_ALLOWED: Defines the behavior for IP options. More...
 
#define IP_REASS_MAXAGE   15
 IP_REASS_MAXAGE: Maximum time (in multiples of IP_TMR_INTERVAL - so seconds, normally) a fragmented IP packet waits for all fragments to arrive. More...
 
#define IP_REASS_MAX_PBUFS   10
 IP_REASS_MAX_PBUFS: Total maximum amount of pbufs waiting to be reassembled. More...
 
#define IP_DEFAULT_TTL   255
 IP_DEFAULT_TTL: Default value for Time-To-Live used by transport layers. More...
 
#define IP_SOF_BROADCAST   0
 IP_SOF_BROADCAST=1: Use the SOF_BROADCAST field to enable broadcast filter per pcb on udp and raw send operations. More...
 
#define IP_SOF_BROADCAST_RECV   0
 IP_SOF_BROADCAST_RECV (requires IP_SOF_BROADCAST=1) enable the broadcast filter on recv operations. More...
 
#define IP_FORWARD_ALLOW_TX_ON_RX_NETIF   0
 IP_FORWARD_ALLOW_TX_ON_RX_NETIF==1: allow ip_forward() to send packets back out on the netif where it was received. More...
 

Detailed Description

Macro Definition Documentation

#define IP_DEFAULT_TTL   255

IP_DEFAULT_TTL: Default value for Time-To-Live used by transport layers.

Definition at line 801 of file opt.h.

#define IP_FORWARD   0

IP_FORWARD==1: Enables the ability to forward IP packets across network interfaces.

If you are going to run lwIP on a device with only one network interface, define this to 0.

Definition at line 736 of file opt.h.

#define IP_FORWARD_ALLOW_TX_ON_RX_NETIF   0

IP_FORWARD_ALLOW_TX_ON_RX_NETIF==1: allow ip_forward() to send packets back out on the netif where it was received.

This should only be used for wireless networks. ATTENTION: When this is 1, make sure your netif driver correctly marks incoming link-layer-broadcast/multicast packets as such using the corresponding pbuf flags!

Definition at line 829 of file opt.h.

#define IP_FRAG   1

IP_FRAG==1: Fragment outgoing IP packets if their size exceeds MTU.

Note that this option does not affect incoming packet sizes, which can be controlled via IP_REASSEMBLY.

Definition at line 754 of file opt.h.

#define IP_OPTIONS_ALLOWED   1

IP_OPTIONS_ALLOWED: Defines the behavior for IP options.

IP_OPTIONS_ALLOWED==0: All packets with IP options are dropped. IP_OPTIONS_ALLOWED==1: IP options are allowed (but not parsed).

Definition at line 773 of file opt.h.

#define IP_REASS_MAX_PBUFS   10

IP_REASS_MAX_PBUFS: Total maximum amount of pbufs waiting to be reassembled.

Since the received pbufs are enqueued, be sure to configure PBUF_POOL_SIZE > IP_REASS_MAX_PBUFS so that the stack is still able to receive packets even if the maximum amount of fragments is enqueued for reassembly! When IPv4 and IPv6 are enabled, this even changes to (PBUF_POOL_SIZE > 2 * IP_REASS_MAX_PBUFS)!

Definition at line 794 of file opt.h.

#define IP_REASS_MAXAGE   15

IP_REASS_MAXAGE: Maximum time (in multiples of IP_TMR_INTERVAL - so seconds, normally) a fragmented IP packet waits for all fragments to arrive.

If not all fragments arrived in this time, the whole packet is discarded.

Definition at line 782 of file opt.h.

#define IP_REASSEMBLY   1

IP_REASSEMBLY==1: Reassemble incoming fragmented IP packets.

Note that this option does not affect outgoing packet sizes, which can be controlled via IP_FRAG.

Definition at line 745 of file opt.h.

#define IP_SOF_BROADCAST   0

IP_SOF_BROADCAST=1: Use the SOF_BROADCAST field to enable broadcast filter per pcb on udp and raw send operations.

To enable broadcast filter on recv operations, you also have to set IP_SOF_BROADCAST_RECV=1.

Definition at line 810 of file opt.h.

#define IP_SOF_BROADCAST_RECV   0

IP_SOF_BROADCAST_RECV (requires IP_SOF_BROADCAST=1) enable the broadcast filter on recv operations.

Definition at line 818 of file opt.h.

#define LWIP_IPV4   1

LWIP_IPV4==1: Enable IPv4.

Definition at line 727 of file opt.h.

Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.