Added comments on some ARP options.

This commit is contained in:
likewise 2003-03-11 13:57:25 +00:00
parent daeb21b3b9
commit 400ff200ee

View File

@ -33,10 +33,10 @@
#define __LWIP_OPT_H__ #define __LWIP_OPT_H__
#include "lwip/debug.h" #include "lwip/debug.h"
/* Include user options which override defaults */ /* Include user defined options first */
#include "lwipopts.h" #include "lwipopts.h"
/* Define default values for all configuration parameters. */ /* Define default values for unconfigured parameters. */
/* Platform specific locking */ /* Platform specific locking */
@ -146,27 +146,29 @@ a lot of data that needs to be copied, this should be set high. */
/* ---------- ARP options ---------- */ /* ---------- ARP options ---------- */
/** Number of active hardware address, IP address pairs cached */
#ifndef ARP_TABLE_SIZE #ifndef ARP_TABLE_SIZE
#define ARP_TABLE_SIZE 10 #define ARP_TABLE_SIZE 10
#endif #endif
/**
* If enabled, outgoing packets are queued during hardware address
* resolution. The etharp.c implementation queues 1 packet only.
*/
#ifndef ARP_QUEUEING #ifndef ARP_QUEUEING
#define ARP_QUEUEING 1 #define ARP_QUEUEING 1
#endif #endif
/** /**
* - If enabled, cache entries are generated for every kind of ARP traffic or * If defined to 1, cache entries are updated or added for every kind of ARP traffic
* broadcast IP traffic. This enhances behaviour for sending to a dynamic set * or broadcast IP traffic. Recommended for routers.
* of hosts, for example if acting as a gateway. * If defined to 0, only existing cache entries are updated. Entries are added when
* - If disabled, cache entries are generated only for IP destination addresses * lwIP is sending to them. Recommended for embedded devices.
* in use by lwIP or applications. This enhances performance if sending to a small,
* reasonably static number of hosts. Typically for embedded devices.
*/ */
#ifndef ETHARP_ALWAYS_INSERT #ifndef ETHARP_ALWAYS_INSERT
#define ETHARP_ALWAYS_INSERT 1 #define ETHARP_ALWAYS_INSERT 1
#endif #endif
/* ---------- IP options ---------- */ /* ---------- IP options ---------- */
/* Define IP_FORWARD to 1 if you wish to have the ability to forward /* Define IP_FORWARD to 1 if you wish to have the ability to forward
IP packets across network interfaces. If you are going to run lwIP IP packets across network interfaces. If you are going to run lwIP
@ -181,12 +183,17 @@ a lot of data that needs to be copied, this should be set high. */
#define IP_OPTIONS 1 #define IP_OPTIONS 1
#endif #endif
/* IP reassembly and segmentation.These are orthogonal even /** IP reassembly and segmentation. Even if they both deal with IP
* if they both deal with IP fragments */ * fragments, note that these are orthogonal, one dealing with incoming
* packets, the other with outgoing packets
*/
/** Reassemble incoming fragmented IP packets */
#ifndef IP_REASSEMBLY #ifndef IP_REASSEMBLY
#define IP_REASSEMBLY 1 #define IP_REASSEMBLY 1
#endif #endif
/** Fragment outgoing IP packets if their size exceeds MTU */
#ifndef IP_FRAG #ifndef IP_FRAG
#define IP_FRAG 1 #define IP_FRAG 1
#endif #endif