Add start of an architecture port to the Atmel USB XMEGA devices.

[pub/USBasp.git] / Projects / Webserver / Webserver.txt

diff --git a/Projects/Webserver/Webserver.txt b/Projects/Webserver/Webserver.txt
index 7f65876..32bdb59 100644 (file)
--- a/Projects/Webserver/Webserver.txt
+++ b/Projects/Webserver/Webserver.txt
@@ -3,16 +3,16 @@
  *  This file contains special DoxyGen information for the generation of the main page and other special
  *  documentation pages. It is not a project source file.
  */
  *  This file contains special DoxyGen information for the generation of the main page and other special
  *  documentation pages. It is not a project source file.
  */

- 
+

 /** \mainpage uIP Powered Webserver Project
  *
 /** \mainpage uIP Powered Webserver Project
  *

- *  \section SSec_Compat Project Compatibility:
+ *  \section Sec_Compat Project Compatibility:

  *
  *  The following list indicates what microcontrollers are compatible with this project.
  *
  *
  *  The following list indicates what microcontrollers are compatible with this project.
  *

- *  - Series 7 USB AVRs
+ *  - Series 7 USB AVRs (AT90USBxxx7)

  *
  *

- *  \section SSec_Info USB Information:
+ *  \section Sec_Info USB Information:

  *
  *  The following table gives a rundown of the USB utilization of this project.
  *
  *
  *  The following table gives a rundown of the USB utilization of this project.
  *


@@ -26,7 +26,7 @@
  *    <td>Communications Device Class (CDC) \n
  *        Mass Storage Device</td>
  *   </tr>
  *    <td>Communications Device Class (CDC) \n
  *        Mass Storage Device</td>
  *   </tr>

- *   <tr> 
+ *   <tr>

  *    <td><b>USB Subclass:</b></td>
  *    <td>Remote NDIS (Microsoft Proprietary CDC Class Networking Standard) \n
  *        Bulk-Only Transport</td>
  *    <td><b>USB Subclass:</b></td>
  *    <td>Remote NDIS (Microsoft Proprietary CDC Class Networking Standard) \n
  *        Bulk-Only Transport</td>


@@ -45,29 +45,31 @@
  *   </tr>
  *  </table>
  *
  *   </tr>
  *  </table>
  *

- *  \section SSec_Description Project Description: 
+ *  \section Sec_Description Project Description:

  *
  *  Simple HTTP webserver project. This project combines the LUFA library with the uIP TCP/IP full network stack and FatFS
  *
  *  Simple HTTP webserver project. This project combines the LUFA library with the uIP TCP/IP full network stack and FatFS

- *  library to create a RNDIS host capable of serving out HTTP webpages to multiple hosts simultaneously. This project
+ *  library to create a RNDIS host capable of serving out HTTP web pages to multiple hosts simultaneously. This project

  *  demonstrates how the libraries can be combined into a robust network enabled application, with the addition of a RNDIS
  *  network device.
  *
  *  demonstrates how the libraries can be combined into a robust network enabled application, with the addition of a RNDIS
  *  network device.
  *

- *  To use this project, plug the USB AVR into a computer, so that it enumerates as a standard Mass Storage device. Load
- *  HTML files onto the disk, so that they can be served out to clients -- the default file to serve should be called
+ *  To use this project, plug the USB AVR into a computer, so that it enumerates as a standard Mass Storage and RNDIS composite
+ *  device. Load HTML files onto the disk, so that they can be served out to clients -- the default file to serve should be called

  *  <i>index.htm</i>. Filenames must be in 8.3 format for them to be retrieved correctly by the webserver, and the total
  *  <i>index.htm</i>. Filenames must be in 8.3 format for them to be retrieved correctly by the webserver, and the total

- *  requested file path must be equal to or less than the maximum URI length (\see \ref SSec_Options).
+ *  requested file path must be equal to or less than the maximum URI length (\see \ref Sec_Options). Supply the included INF
+ *  file when requested on Windows machines to enable the RNDIS interface, and allow the files to be viewed on a standard web-browser
+ *  using the IP address 10.0.0.2.

  *
  *  When attached to a RNDIS class device, such as a USB (desktop) modem, the system will enumerate the device, set the
  *  appropriate parameters needed for connectivity and begin listening for new HTTP connections on port 80 and TELNET
  *  connections on port 23. The device IP, netmask and default gateway IP must be set to values appropriate for the RNDIS
  *
  *  When attached to a RNDIS class device, such as a USB (desktop) modem, the system will enumerate the device, set the
  *  appropriate parameters needed for connectivity and begin listening for new HTTP connections on port 80 and TELNET
  *  connections on port 23. The device IP, netmask and default gateway IP must be set to values appropriate for the RNDIS

- *  device being used for this project to work if the DHCP client is disabled (see \ref SSec_Options) - otherwise, the device
+ *  device being used for this project to work if the DHCP client is disabled (see \ref Sec_Options) - otherwise, the device

  *  will query the network's DHCP server for these parameters automatically.
  *
  *  will query the network's DHCP server for these parameters automatically.
  *

- *  When properly configured, the webserver can be accessed from any HTTP webrowser by typing in the device's statically or
+ *  When properly configured, the webserver can be accessed from any HTTP web browser by typing in the device's statically or

  *  dynamically allocated IP address. The TELNET client can be accessed via any network socket app by connecting to the device
  *  on port 23 on the device's statically or dynamically allocated IP address.
  *
  *  dynamically allocated IP address. The TELNET client can be accessed via any network socket app by connecting to the device
  *  on port 23 on the device's statically or dynamically allocated IP address.
  *

- *  \section SSec_Options Project Options
+ *  \section Sec_Options Project Options

  *
  *  The following defines can be found in this project, which can control the project behaviour when defined, or changed in value.
  *
  *
  *  The following defines can be found in this project, which can control the project behaviour when defined, or changed in value.
  *


@@ -79,16 +81,21 @@
  *   </tr>
  *   <tr>
  *    <td>ENABLE_TELNET_SERVER</td>
  *   </tr>
  *   <tr>
  *    <td>ENABLE_TELNET_SERVER</td>

- *    <td>Makefile CDEFS</td>
+ *    <td>Makefile LUFA_OPTS</td>

  *    <td>When defined, this enables the TELNET server in addition to the HTTP webserver, which listens for incoming connections
  *        and processes user commands.</td>
  *   </tr>
  *   <tr>
  *    <td>ENABLE_DHCP_CLIENT</td>
  *    <td>When defined, this enables the TELNET server in addition to the HTTP webserver, which listens for incoming connections
  *        and processes user commands.</td>
  *   </tr>
  *   <tr>
  *    <td>ENABLE_DHCP_CLIENT</td>

- *    <td>Makefile CDEFS</td>
+ *    <td>Makefile LUFA_OPTS</td>

  *    <td>When defined, this enables the DHCP client for dynamic IP allocation of the network settings from a DHCP server.</td>
  *   </tr>
  *   <tr>
  *    <td>When defined, this enables the DHCP client for dynamic IP allocation of the network settings from a DHCP server.</td>
  *   </tr>
  *   <tr>

+ *    <td>ENABLE_DHCP_SERVER</td>
+ *    <td>Makefile LUFA_OPTS</td>
+ *    <td>When defined, this enables the DHCP server for dynamic IP allocation of the network settings to a DHCP client.</td>
+ *   </tr>
+ *   <tr>

  *    <td>DEVICE_IP_ADDRESS</td>
  *    <td>Lib/uIPManagement.h</td>
  *    <td>IP address that the webserver should use when connected to a RNDIS device (when ENABLE_DHCP_CLIENT is not defined).</td>
  *    <td>DEVICE_IP_ADDRESS</td>
  *    <td>Lib/uIPManagement.h</td>
  *    <td>IP address that the webserver should use when connected to a RNDIS device (when ENABLE_DHCP_CLIENT is not defined).</td>


@@ -106,8 +113,9 @@
  *   </tr>
  *   <tr>
  *    <td>MAX_URI_LENGTH</td>
  *   </tr>
  *   <tr>
  *    <td>MAX_URI_LENGTH</td>

- *    <td>Makefile CDEFS</td>
- *    <td>Maximum length of a URI for the Webserver. This is the maximum file path, including subdirectories and seperators.</td>
+ *    <td>Makefile LUFA_OPTS</td>
+ *    <td>Maximum length of a URI for the Webserver. This is the maximum file path, including subdirectories and separators.</td>

  *   </tr>
  *  </table>
  *   </tr>
  *  </table>

- */
\ No newline at end of file
+ */
+