X-Git-Url: http://git.linex4red.de/pub/lufa.git/blobdiff_plain/d11ed10c5314c44dc01c06954d1d73d4894cbff8..refs/heads/master:/Projects/Webserver/Webserver.txt diff --git a/Projects/Webserver/Webserver.txt b/Projects/Webserver/Webserver.txt index e78cf5eff..10aa71652 100644 --- a/Projects/Webserver/Webserver.txt +++ b/Projects/Webserver/Webserver.txt @@ -1,93 +1,126 @@ -/** \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 - * - * \section SSec_Compat Project Compatibility: - * - * The following list indicates what microcontrollers are compatible with this project. - * - * - Series 7 USB AVRs - * - * \section SSec_Info USB Information: - * - * The following table gives a rundown of the USB utilization of this project. - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
USB Mode:Host
USB Class:Communications Device Class (CDC)
USB Subclass:Remote NDIS (Microsoft Proprietary CDC Class Networking Standard)
Relevant Standards:Microsoft RNDIS Specification
Usable Speeds:Full Speed Mode
- * - * \section SSec_Description Project Description: - * - * 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 - * 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 - * index.htm. Filenames must be in 8.3 format for them to be retrieved correctly by the webserver. - - * When attached to a RNDIS class device, such as a USB (desktop) modem. If compatible, the system will enumerate the - * device, set the appropriate parameters needed for connectivity and begin listening for new HTTP connections on port 80. - * 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). - * - * When properly configured, the webserver can be accessed from any HTTP webrowser by typing in the device's static or - * dynamically allocated IP address. - * - * \section SSec_Options Project Options - * - * The following defines can be found in this project, which can control the project behaviour when defined, or changed in value. - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
Define Name:Location:Description:
ENABLE_DHCPMakefile CDEFSWhen defined, enables the DHCP client for dynamic IP allocation of the network settings from a DHCP server.
DEVICE_IP_ADDRESSLib/uIPManagement.hIP address that the webserver should use when connected to a RNDIS device (when ENABLE_DHCP is not defined).
DEVICE_NETMASKLib/uIPManagement.hNetmask that the webserver should use when connected to a RNDIS device (when ENABLE_DHCP is not defined).
DEVICE_GATEWAYLib/uIPManagement.hDefault routing gateway that the webserver should use when connected to a RNDIS device (when ENABLE_DHCP - * is not defined).
- */ \ No newline at end of file +/** \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 + * + * \section Sec_Compat Project Compatibility: + * + * The following list indicates what microcontrollers are compatible with this project. + * + * \li Series 7 USB AVRs (AT90USBxxx7) + * + * \section Sec_Info USB Information: + * + * The following table gives a rundown of the USB utilization of this project. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
USB Mode:Dual Mode Host/Device
USB Class:Communications Device Class (CDC) \n + * Mass Storage Device
USB Subclass:Remote NDIS (Microsoft Proprietary CDC Class Networking Standard) \n + * Bulk-Only Transport
Relevant Standards:Microsoft RNDIS Specification \n + * USBIF Mass Storage Standard \n + * USB Bulk-Only Transport Standard \n + * SCSI Primary Commands Specification \n + * SCSI Block Commands Specification
Supported USB Speeds:Full Speed Mode
+ * + * \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 + * 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. + * + * 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 + * index.htm. 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 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 + * 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. + * + * 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. + * + * \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. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
Define Name:Location:Description:
ENABLE_TELNET_SERVERAppConfig.hWhen defined, this enables the TELNET server in addition to the HTTP webserver, which listens for incoming connections + * and processes user commands.
ENABLE_DHCP_CLIENTAppConfig.hWhen defined, this enables the DHCP client for dynamic IP allocation of the network settings from a DHCP server.
ENABLE_DHCP_SERVERAppConfig.hWhen defined, this enables the DHCP server for dynamic IP allocation of the network settings to a DHCP client.
DEVICE_IP_ADDRESSAppConfig.hIP address that the webserver should use when connected to a RNDIS device (when ENABLE_DHCP_CLIENT is not defined).
DEVICE_NETMASKAppConfig.hNetmask that the webserver should use when connected to a RNDIS device (when ENABLE_DHCP_CLIENT is not defined).
DEVICE_GATEWAYAppConfig.hDefault routing gateway that the webserver should use when connected to a RNDIS device (when ENABLE_DHCP_CLIENT + * is not defined).
MAX_URI_LENGTHAppConfig.hMaximum length of a URI for the Webserver. This is the maximum file path, including subdirectories and separators.
SERVER_MAC_ADDRESSAppConfig.hMAC address of the server used when sending Ethernet packets onto the bus.
+ */ +