sergiotarxz/nuttx-apps
sergiotarxz/nuttx-apps
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Clarify MTU/BUFSIZE in apps/ README.txt files and Documentation

Browse Source
This commit is contained in:
Gregory Nutt 2014-11-16 08:50:36 -06:00
parent c1d5da619e
commit 64b8c1841c
3 changed files with 14 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
examples/README.txt
View File

@ -1914,10 +1914,13 @@ examples/webserver
(as well as various other UDP-related (as well as various other UDP-related
configuration settings). configuration settings).
CONFIG_NET_BROADCAST=y - UDP broadcast support is needed. 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 (or larger) prepared to receive DHCP messages of up to
576 bytes (excluding Ethernet, IP, or UDP 576 bytes (excluding Ethernet, IP, or UDP
headers and FCS). 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. Other configuration items apply also to the selected webserver net utility.
Additional relevant settings for the uIP webserver net utility are: Additional relevant settings for the uIP webserver net utility are:

5
netutils/README.txt
View File

@ -116,7 +116,10 @@ required. These include:
(as well as various other UDP-related (as well as various other UDP-related
configuration settings). configuration settings).
CONFIG_NET_BROADCAST=y UDP broadcast support is needed. 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 (or larger) DHCP messages of up to 576 bytes (excluding
Ethernet, IP, or UDP headers and FCS). 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.

10
nshlib/README.txt
View File

@ -961,7 +961,7 @@ Command Dependencies on Configuration Settings
exec -- exec --
exit -- exit --
free -- 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 -- help --
hexdump CONFIG_NFILE_DESCRIPTORS > 0 hexdump CONFIG_NFILE_DESCRIPTORS > 0
ifconfig CONFIG_NET ifconfig CONFIG_NET
@ -981,7 +981,7 @@ Command Dependencies on Configuration Settings
nfsmount !CONFIG_DISABLE_MOUNTPOINT && CONFIG_NFILE_DESCRIPTORS > 0 && CONFIG_NET && CONFIG_NFS 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 ping CONFIG_NET && CONFIG_NET_ICMP && CONFIG_NET_ICMP_PING && !CONFIG_DISABLE_SIGNALS
ps -- 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 pwd !CONFIG_DISABLE_ENVIRON && CONFIG_NFILE_DESCRIPTORS > 0
rm (((!CONFIG_DISABLE_MOUNTPOINT && CONFIG_FS_WRITABLE) || !CONFIG_DISABLE_PSEUDOFS_OPERATIONS) && 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) 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 --- xd ---
* NOTES: * 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. operations size may be larger.
2. Special TFTP server start-up options will probably be required to permit 2. Special TFTP server start-up options will probably be required to permit
creation of file for the correct operation of the put command. creation of file for the correct operation of the put command.
@ -1331,9 +1331,11 @@ NSH-Specific Configuration Settings
* CONFIG_NET_BROADCAST=y * CONFIG_NET_BROADCAST=y
UDP broadcast support is needed. 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 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). 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 If CONFIG_NSH_ROMFSETC is selected, then the following additional
configuration setting apply: configuration setting apply: