9
0
Fork 0

DHCP-related documentation updates/warning fixes

git-svn-id: https://nuttx.svn.sourceforge.net/svnroot/nuttx/trunk@2824 7fd9a85b-ad96-42d3-883c-3090e2eb8679
This commit is contained in:
patacongo 2010-08-06 16:14:02 +00:00
parent c05056d41b
commit 252110031a
5 changed files with 130 additions and 1 deletions

View File

@ -8,7 +8,7 @@
<tr align="center" bgcolor="#e4e4e4">
<td>
<h1><big><font color="#3c34ec"><i>NuttShell (NSH)</i></font></big></h1>
<p>Last Updated: June 08, 2009</p>
<p>Last Updated: July 06, 2010</p>
</td>
</tr>
</table>
@ -2099,6 +2099,23 @@ nsh>
<th align="left">Description</th>
</tr>
<tr>
<td valign="top"><b><code>CONFIG_NET=y</code></b></td>
<td>
Of course, networking must be enabled.
</td>
</tr>
<tr>
<td valign="top"><b><code>CONFIG_NSOCKET_DESCRIPTORS</code></b></td>
<td>
And, of course, you must allocate some socket descriptors.
</td>
</tr>
<tr>
<td valign="top"><b><code>CONFIG_NET_TCP=y</code></b></td>
<td>
TCP/IP support is required for telnet (as well as various other TCP-related configuration settings).
</td>
</tr>
<td valign="top"><b><code>CONFIG_EXAMPLES_NSH_IOBUFFER_SIZE</code></b></td>
<td>
Determines the size of the I/O buffer to use for sending/
@ -2139,6 +2156,49 @@ nsh>
</tr>
</table></center>
<p>
If you use DHCPC, then some special configuration network options are
required. These include:
</p>
<center><table width="100%">
<tr bgcolor="#e4e4e4">
<th align="left" width="25%">Configuration</th>
<th align="left">Description</th>
</tr>
<tr>
<td valign="top"><b><code>CONFIG_NET=y</code></b></td>
<td>
Of course, networking must be enabled.
</td>
</tr>
<tr>
<td valign="top"><b><code>CONFIG_NSOCKET_DESCRIPTORS</code></b></td>
<td>
And, of course, you must allocate some socket descriptors.
</td>
</tr>
<tr>
<td valign="top"><b><code>CONFIG_NET_UDP=y</code></b></td>
<td>
UDP support is required for DHCP (as well as various other UDP-related configuration settings).
</td>
</tr>
<tr>
<td valign="top"><b><code>CONFIG_NET_BROADCAST=y</code></b></td>
<td>
UDP broadcast support is needed.
</td>
</tr>
<tr>
<td valign="top"><b><code>CONFIG_NET_BUFSIZE=650</code></b> (or larger)</td>
<td>
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).
</td>
</tr>
</table></center>
<p>
If <code>CONFIG_EXAMPLES_NSH_ROMFSETC</code> is selected, then the following additional
configuration setting apply:

View File

@ -22,6 +22,14 @@ examples/dhcpd
make -f Makefile.host
NuttX configuration settings:
CONFIG_NET=y - Of course
CONFIG_NSOCKET_DESCRIPTORS - And, of course, you must allocate some
socket descriptors.
CONFIG_NET_UDP=y - UDP support is required for DHCP
(as well as various other UDP-related
configuration settings)
CONFIG_NET_BROADCAST=y - UDP broadcast support is needed.
CONFIG_EXAMPLE_DHCPD_NOMAC - (May be defined to use software assigned MAC)
CONFIG_EXAMPLE_DHCPD_IPADDR - Target IP address
@ -353,6 +361,21 @@ examples/uip
CONFIG_EXAMPLE_UIP_NETMASK - Network mask
CONFIG_EXAMPLE_UIP_DHCPC - Select to get IP address via DHCP
If you use DHCPC, then some special configuration network options are
required. These include:
CONFIG_NET=y - Of course
CONFIG_NSOCKET_DESCRIPTORS - And, of course, you must allocate some
socket descriptors.
CONFIG_NET_UDP=y - UDP support is required for DHCP
(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
(or larger) prepared to receive DHCP messages of up to
576 bytes (excluding Ethernet, IP, or UDP
headers and FCS).
Other configuration items apply also to the selected webserver net utility.
Additional relevant settings for the uIP webserver net utility are:

View File

@ -893,6 +893,16 @@ NSH-Specific Configuration Settings
must be defined. If CONFIG_EXAMPLES_NSH_TELNET is selected, then there some
other configuration settings that apply:
* CONFIG_NET=y
Of course, networking must be enabled
* CONFIG_NSOCKET_DESCRIPTORS
And, of course, you must allocate some socket descriptors.
* CONFIG_NET_TCP=y
TCP/IP support is required for telnet (as well as various other TCP-related
configuration settings).
* CONFIG_EXAMPLES_NSH_IOBUFFER_SIZE
Determines the size of the I/O buffer to use for sending/
receiving TELNET commands/reponses
@ -914,6 +924,26 @@ NSH-Specific Configuration Settings
Set if your ethernet hardware has no built-in MAC address.
If set, a bogus MAC will be assigned.
If you use DHCPC, then some special configuration network options are
required. These include:
* CONFIG_NET=y
Of course, networking must be enabled
* CONFIG_NSOCKET_DESCRIPTORS
And, of course, you must allocate some socket descriptors.
* CONFIG_NET_UDP=y
UDP support is required for DHCP (as well as various other UDP-related
configuration settings)
* CONFIG_NET_BROADCAST=y
UDP broadcast support is needed.
* CONFIG_NET_BUFSIZE=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).
If CONFIG_EXAMPLES_NSH_ROMFSETC is selected, then the following additional
configuration setting apply:

View File

@ -60,6 +60,7 @@
#include <net/if.h>
#include <net/uip/uip-lib.h>
#if defined(CONFIG_EXAMPLES_NSH_DHCPC)
# include <net/uip/resolv.h>
# include <net/uip/dhcpc.h>
#endif

View File

@ -13,6 +13,9 @@ include:
webclient - HTTP web client
webserver - HTTP web server
You may find additional information on these apps in the uIP forum
accessible through: http://www.sics.se/~adam/uip/index.php/Main_Page
Additional applications that were not part of uIP (but which are
highly influenced by uIP) include:
@ -21,4 +24,16 @@ highly influenced by uIP) include:
thttpd - This is a port of Jef Poskanzer's THTTPD HTPPD server.
See http://acme.com/software/thttpd/.
If you use DHCPC/D, then some special configuration network options are
required. These include:
CONFIG_NET=y Of course
CONFIG_NSOCKET_DESCRIPTORS And, of course, you must allocate some
socket descriptors.
CONFIG_NET_UDP=y UDP support is required for DHCP
(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
(or larger) DHCP messages of up to 576 bytes (excluding
Ethernet, IP, or UDP headers and FCS).