Make SPI and USART peripheral dispatch driver headers in preparation for a set of...

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

diff --git a/Projects/Webserver/Webserver.txt b/Projects/Webserver/Webserver.txt
index e1d2985..05d0b1f 100644 (file)
--- a/Projects/Webserver/Webserver.txt
+++ b/Projects/Webserver/Webserver.txt
@@ -19,19 +19,25 @@
  *  <table>\r
  *   <tr>\r
  *    <td><b>USB Mode:</b></td>\r
  *  <table>\r
  *   <tr>\r
  *    <td><b>USB Mode:</b></td>\r

- *    <td>Host</td>\r
+ *    <td>Dual Mode Host/Device</td>\r

  *   </tr>\r
  *   <tr>\r
  *    <td><b>USB Class:</b></td>\r
  *   </tr>\r
  *   <tr>\r
  *    <td><b>USB Class:</b></td>\r

- *    <td>Communications Device Class (CDC)</td>\r
+ *    <td>Communications Device Class (CDC) \n\r
+ *        Mass Storage Device</td>\r

  *   </tr>\r
  *   <tr> \r
  *    <td><b>USB Subclass:</b></td>\r
  *   </tr>\r
  *   <tr> \r
  *    <td><b>USB Subclass:</b></td>\r

- *    <td>Remote NDIS (Microsoft Proprietary CDC Class Networking Standard)</td>\r
+ *    <td>Remote NDIS (Microsoft Proprietary CDC Class Networking Standard) \n\r
+ *        Bulk-Only Transport</td>\r

  *   </tr>\r
  *   <tr>\r
  *    <td><b>Relevant Standards:</b></td>\r
  *   </tr>\r
  *   <tr>\r
  *    <td><b>Relevant Standards:</b></td>\r

- *    <td>Microsoft RNDIS Specification</td>\r
+ *    <td>Microsoft RNDIS Specification \n\r
+ *        USBIF Mass Storage Standard \n\r
+ *        USB Bulk-Only Transport Standard \n\r
+ *        SCSI Primary Commands Specification \n\r
+ *        SCSI Block Commands Specification</td>\r

  *   </tr>\r
  *   <tr>\r
  *    <td><b>Usable Speeds:</b></td>\r
  *   </tr>\r
  *   <tr>\r
  *    <td><b>Usable Speeds:</b></td>\r


@@ -41,16 +47,25 @@
  *\r
  *  \section SSec_Description Project Description: \r
  *\r
  *\r
  *  \section SSec_Description Project Description: \r
  *\r

- *  Simple HTTP webserver project. This project combines the LUFA library with the uIP TCP/IP full network stack, to create a\r
- *  RNDIS host capable of serving out HTTP webpages to up to 10 hosts simultaneously. This project demonstrates how the two\r
- *  libraries can be combined into a robust network enabled application, with the addition of a RNDIS network device.\r
+ *  Simple HTTP webserver project. This project combines the LUFA library with the uIP TCP/IP full network stack and FatFS\r
+ *  library to create a RNDIS host capable of serving out HTTP webpages to multiple hosts simultaneously. This project\r
+ *  demonstrates how the libraries can be combined into a robust network enabled application, with the addition of a RNDIS\r
+ *  network device.\r

  *\r
  *\r

- *  To use this project, plug the USB AVR into a RNDIS class device, such as a USB (desktop) modem. If compatible, the project\r
- *  will enumerate the device, set the appropriate parameters needed for connectivity and begin listening for new HTTP connections\r
- *  on port 80. The device IP, netmask and default gateway IP must be set to values appropriate for the RNDIS device being used\r
- *  for this project to work.\r
+ *  To use this project, plug the USB AVR into a computer, so that it enumerates as a standard Mass Storage device. Load\r
+ *  HTML files onto the disk, so that they can be served out to clients -- the default file to serve should be called\r
+ *  <i>index.htm</i>. Filenames must be in 8.3 format for them to be retrieved correctly by the webserver, and the total\r
+ *  requested file path must be equal to or less than the maximum URI length (\see \ref SSec_Options).\r

  *\r
  *\r

- *  When properly configured, the webserver can be accessed from any HTTP webrowser by typing in the device's IP address.\r
+ *  When attached to a RNDIS class device, such as a USB (desktop) modem, the system will enumerate the device, set the\r
+ *  appropriate parameters needed for connectivity and begin listening for new HTTP connections on port 80 and TELNET\r
+ *  connections on port 23. The device IP, netmask and default gateway IP must be set to values appropriate for the RNDIS\r
+ *  device being used for this project to work if the DHCP client is disabled (see \ref SSec_Options) - otherwise, the device\r
+ *  will query the network's DHCP server for these parameters automatically.\r
+ *\r
+ *  When properly configured, the webserver can be accessed from any HTTP webrowser by typing in the device's statically or\r
+ *  dynamically allocated IP address. The TELNET client can be accessed via any network socket app by connecting to the device\r
+ *  on port 23 on the device's statically or dynamically allocated IP address.\r

  *\r
  *  \section SSec_Options Project Options\r
  *\r
  *\r
  *  \section SSec_Options Project Options\r
  *\r


@@ -63,25 +78,30 @@
  *    <td><b>Description:</b></td>\r
  *   </tr>\r
  *   <tr>\r
  *    <td><b>Description:</b></td>\r
  *   </tr>\r
  *   <tr>\r

- *    <td>ENABLE_DHCP</td>\r
+ *    <td>ENABLE_DHCP_CLIENT</td>\r

  *    <td>Makefile CDEFS</td>\r
  *    <td>Makefile CDEFS</td>\r

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

  *   </tr>\r
  *   <tr>\r
  *    <td>DEVICE_IP_ADDRESS</td>\r
  *   </tr>\r
  *   <tr>\r
  *    <td>DEVICE_IP_ADDRESS</td>\r

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

  *   </tr>\r
  *   <tr>\r
  *    <td>DEVICE_NETMASK</td>\r
  *   </tr>\r
  *   <tr>\r
  *    <td>DEVICE_NETMASK</td>\r

- *    <td>Webserver.h</td>\r
- *    <td>Netmask that the webserver should use when connected to a RNDIS device (when ENABLE_DHCP is not defined).</td>\r
+ *    <td>Lib/uIPManagement.h</td>\r
+ *    <td>Netmask that the webserver should use when connected to a RNDIS device (when ENABLE_DHCP_CLIENT is not defined).</td>\r

  *   </tr>\r
  *   <tr>\r
  *    <td>DEVICE_GATEWAY</td>\r
  *   </tr>\r
  *   <tr>\r
  *    <td>DEVICE_GATEWAY</td>\r

- *    <td>Webserver.h</td>\r
- *    <td>Default routing gateway that the webserver should use when connected to a RNDIS device (when ENABLE_DHCP\r
+ *    <td>Lib/uIPManagement.h</td>\r
+ *    <td>Default routing gateway that the webserver should use when connected to a RNDIS device (when ENABLE_DHCP_CLIENT\r

  *        is not defined).</td>\r
  *   </tr>\r
  *        is not defined).</td>\r
  *   </tr>\r

+ *   <tr>\r
+ *    <td>MAX_URI_LENGTH</td>\r
+ *    <td>Makefile CDEFS</td>\r
+ *    <td>Maximum length of a URI for the Webserver. This is the maximum file path, including subdirectories and seperators.</td>\r
+ *   </tr>\r

  *  </table>\r
  */
\ No newline at end of file
  *  </table>\r
  */
\ No newline at end of file