From 935e3f385d1fc9c4a5db9587ce29580e615d1a46 Mon Sep 17 00:00:00 2001 From: Gregory Nutt Date: Sun, 16 Nov 2014 08:50:36 -0600 Subject: Clarify MTU/BUFSIZE in apps/ README.txt files and Documentation --- apps/examples/README.txt | 5 ++++- apps/netutils/README.txt | 5 ++++- apps/nshlib/README.txt | 10 ++++++---- 3 files changed, 14 insertions(+), 6 deletions(-) (limited to 'apps') diff --git a/apps/examples/README.txt b/apps/examples/README.txt index caac77e4a..c9b637439 100644 --- a/apps/examples/README.txt +++ b/apps/examples/README.txt @@ -1914,10 +1914,13 @@ examples/webserver (as well as various other UDP-related configuration settings). CONFIG_NET_BROADCAST=y - UDP broadcast support is needed. - CONFIG_NET_BUFSIZE=650 - Per RFC2131 (p. 9), the DHCP client must be + CONFIG_NET_ETH_MTU=650 - Per RFC2131 (p. 9), the DHCP client must be (or larger) prepared to receive DHCP messages of up to 576 bytes (excluding Ethernet, IP, or UDP headers and FCS). + NOTE: Note that the actual MTU setting will + depend upon the specific link protocol. + Here Ethernet is indicated. Other configuration items apply also to the selected webserver net utility. Additional relevant settings for the uIP webserver net utility are: diff --git a/apps/netutils/README.txt b/apps/netutils/README.txt index 818f6a784..394be98dc 100644 --- a/apps/netutils/README.txt +++ b/apps/netutils/README.txt @@ -116,7 +116,10 @@ required. These include: (as well as various other UDP-related configuration settings). CONFIG_NET_BROADCAST=y UDP broadcast support is needed. - CONFIG_NET_BUFSIZE=650 The client must be prepared to receive + CONFIG_NET_ETH_MTU=650 The client must be prepared to receive (or larger) DHCP messages of up to 576 bytes (excluding Ethernet, IP, or UDP headers and FCS). + NOTE: Note that the actual MTU setting will + depend upon the specific link protocol. + Here Ethernet is indicated. diff --git a/apps/nshlib/README.txt b/apps/nshlib/README.txt index 821e40027..b49daf2a0 100644 --- a/apps/nshlib/README.txt +++ b/apps/nshlib/README.txt @@ -961,7 +961,7 @@ Command Dependencies on Configuration Settings exec -- exit -- free -- - get CONFIG_NET && CONFIG_NET_UDP && CONFIG_NFILE_DESCRIPTORS > 0 && CONFIG_NET_BUFSIZE >= 558 (see note 1) + get CONFIG_NET && CONFIG_NET_UDP && CONFIG_NFILE_DESCRIPTORS > 0 && MTU >= 558 (see note 1) help -- hexdump CONFIG_NFILE_DESCRIPTORS > 0 ifconfig CONFIG_NET @@ -981,7 +981,7 @@ Command Dependencies on Configuration Settings nfsmount !CONFIG_DISABLE_MOUNTPOINT && CONFIG_NFILE_DESCRIPTORS > 0 && CONFIG_NET && CONFIG_NFS ping CONFIG_NET && CONFIG_NET_ICMP && CONFIG_NET_ICMP_PING && !CONFIG_DISABLE_SIGNALS ps -- - put CONFIG_NET && CONFIG_NET_UDP && CONFIG_NFILE_DESCRIPTORS > 0 && CONFIG_NET_BUFSIZE >= 558 (see note 1,2) + put CONFIG_NET && CONFIG_NET_UDP && CONFIG_NFILE_DESCRIPTORS > 0 && MTU >= 558 (see note 1,2) pwd !CONFIG_DISABLE_ENVIRON && CONFIG_NFILE_DESCRIPTORS > 0 rm (((!CONFIG_DISABLE_MOUNTPOINT && CONFIG_FS_WRITABLE) || !CONFIG_DISABLE_PSEUDOFS_OPERATIONS) && CONFIG_NFILE_DESCRIPTORS > 0) rmdir (((!CONFIG_DISABLE_MOUNTPOINT && CONFIG_FS_WRITABLE) || !CONFIG_DISABLE_PSEUDOFS_OPERATIONS) && CONFIG_NFILE_DESCRIPTORS > 0) @@ -998,7 +998,7 @@ Command Dependencies on Configuration Settings xd --- * NOTES: - 1. Because of hardware padding, the actual buffersize required for put and get + 1. Because of hardware padding, the actual MTU required for put and get operations size may be larger. 2. Special TFTP server start-up options will probably be required to permit creation of file for the correct operation of the put command. @@ -1331,9 +1331,11 @@ NSH-Specific Configuration Settings * CONFIG_NET_BROADCAST=y UDP broadcast support is needed. - * CONFIG_NET_BUFSIZE=650 (or larger) + * CONFIG_NET_ETH_MTU=650 (or larger) Per RFC2131 (p. 9), the DHCP client must be prepared to receive DHCP messages of up to 576 bytes (excluding Ethernet, IP, or UDP headers and FCS). + NOTE: Note that the actual MTU setting will depend upon the specific + link protocol. Here Ethernet is indicated. If CONFIG_NSH_ROMFSETC is selected, then the following additional configuration setting apply: -- cgit v1.2.3