X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/b9b03aadb219d06fbad9d110e508db93e45461af..7b5b8f199f0290d2befcde56fb99fe68c61d15ff:/Demos/Device/LowLevel/RNDISEthernet/RNDISEthernet.txt diff --git a/Demos/Device/LowLevel/RNDISEthernet/RNDISEthernet.txt b/Demos/Device/LowLevel/RNDISEthernet/RNDISEthernet.txt index 306cf8526..ac72d4ae7 100644 --- a/Demos/Device/LowLevel/RNDISEthernet/RNDISEthernet.txt +++ b/Demos/Device/LowLevel/RNDISEthernet/RNDISEthernet.txt @@ -1,115 +1,143 @@ -/** \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 RNDIS Class Ethernet Demo (with Webserver/Telnet) - * - * \section SSec_Info USB Information: - * - * The following table gives a rundown of the USB utilization of this demo. - * - * Remote Network Driver Interface demonstration application. - * This gives a simple reference application for implementing - * a CDC RNDIS device acting as a simple network interface for - * ethernet packet exchange. RNDIS is a proprietary Microsoft - * standard; this demo will only work on Windows 2000 (manually - * patched with the Microsoft RNDIS hotfix) and above (with no - * manual patches), or on the latest Linux kernels. - * - * Before running, you will need to install the INF file that - * is located in the RNDISEthernet project directory. This will - * enable Windows to use its inbuilt RNDIS drivers, negating the - * need for special Windows drivers for the device. To install, - * right-click the .INF file and choose the Install option. If - * Windows 2000 is used, the Microsoft INF file in the hotfix - * will need to be altered to use the VID/PID of the demo and - * then chosen instead of the LUFA RNDIS INF file when prompted. - * - * When enumerated, this demo will install as a new network - * adapter which ethernet packets can be sent to and received - * from. Running on top of the adapter is a very simple TCP/IP - * stack with a HTTP webserver and TELNET host which can be - * accessed through a web browser at IP address 10.0.0.2:80 or - * through a TELNET client at 10.0.0.2:25. This device also supports - * ping echos via the ICMP protocol. - * - * \note The TCP/IP stack in this demo has a number of limitations - * and should serve as an example only - it is not fully featured nor - * compliant to the TCP/IP specification. For complete projects, it is - * recommended that it be replaced with an external open source TCP/IP - * stack that is feature complete, such as the uIP stack. - * - * \section SSec_Description Project Description: - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
USB Mode:Device
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_Options Project Options - * - * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value. - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
Define Name:Location:Description:
NO_DECODE_ETHERNETMakefile CDEFSWhen defined, received Ethernet headers will not be decoded and printed to the device serial port.
NO_DECODE_ARPMakefile CDEFSWhen defined, received ARP headers will not be decoded and printed to the device serial port.
NO_DECODE_IPMakefile CDEFSWhen defined, received IP headers will not be decoded and printed to the device serial port.
NO_DECODE_ICMPMakefile CDEFSWhen defined, received ICMP headers will not be decoded and printed to the device serial port.
NO_DECODE_TCPMakefile CDEFSWhen defined, received TCP headers will not be decoded and printed to the device serial port.
NO_DECODE_UDPMakefile CDEFSWhen defined, received UDP headers will not be decoded and printed to the device serial port.
NO_DECODE_DHCPMakefile CDEFSWhen defined, received DHCP headers will not be decoded and printed to the device serial port.
- */ \ 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 RNDIS Class Ethernet Demo (with Webserver/Telnet) + * + * \section Sec_Compat Demo Compatibility: + * + * The following list indicates what microcontrollers are compatible with this demo. + * + * \li Series 7 USB AVRs (AT90USBxxx7) + * \li Series 6 USB AVRs (AT90USBxxx6) + * + * \section Sec_Info USB Information: + * + * The following table gives a rundown of the USB utilization of this demo. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
USB Mode:Device
USB Class:Communications Device Class (CDC)
USB Subclass:Remote NDIS (Microsoft Proprietary CDC Class Networking Standard)
Relevant Standards:Microsoft RNDIS Specification
Supported USB Speeds:Full Speed Mode
+ * + * \section Sec_Description Project Description: + * + * Remote Network Driver Interface demonstration application. + * This gives a simple reference application for implementing + * a CDC RNDIS device acting as a simple network interface for + * ethernet packet exchange. RNDIS is a proprietary Microsoft + * standard; this demo will only work on Windows 2000 (manually + * patched with the Microsoft RNDIS hotfix) and above (with no + * manual patches), or on the latest Linux kernels. + * + * Before running, you will need to install the INF file that + * is located in the RNDISEthernet project directory. This will + * enable Windows to use its inbuilt RNDIS drivers, negating the + * need for special Windows drivers for the device. To install, + * right-click the .INF file and choose the Install option. If + * Windows 2000 is used, the Microsoft INF file in the hotfix + * will need to be altered to use the VID/PID of the demo and + * then chosen instead of the LUFA RNDIS INF file when prompted. + * + * When enumerated, this demo will install as a new network + * adapter which ethernet packets can be sent to and received + * from. Running on top of the adapter is a very simple TCP/IP + * stack with a HTTP webserver and TELNET host which can be + * accessed through a web browser at IP address 10.0.0.2:80 or + * through a TELNET client at 10.0.0.2:25. This device also supports + * ping echos via the ICMP protocol. + * + * \note The TCP/IP stack in this demo has a number of limitations + * and should serve as an example only - it is not fully featured nor + * compliant to the TCP/IP specification. For complete projects, it is + * recommended that it be replaced with an external open source TCP/IP + * stack that is feature complete, such as the uIP stack. + * + * \section Sec_Options Project Options + * + * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
Define Name:Location:Description:
CLIENT_IP_ADDRESSAppConfig.hConfigures the IP address given to the client (PC) via the DHCP server.
SERVER_IP_ADDRESSAppConfig.hConfigures the IP address of the virtual server.
ADAPTER_MAC_ADDRESSAppConfig.hConfigures the MAC address of the RNDIS adapter on the host (PC) side.
SERVER_MAC_ADDRESSAppConfig.hConfigures the MAC address of the virtual server on the network.
NO_DECODE_ETHERNETAppConfig.hWhen defined, received Ethernet headers will not be decoded and printed to the device serial port.
NO_DECODE_ARPAppConfig.hWhen defined, received ARP headers will not be decoded and printed to the device serial port.
NO_DECODE_IPAppConfig.hWhen defined, received IP headers will not be decoded and printed to the device serial port.
NO_DECODE_ICMPAppConfig.hWhen defined, received ICMP headers will not be decoded and printed to the device serial port.
NO_DECODE_TCPAppConfig.hWhen defined, received TCP headers will not be decoded and printed to the device serial port.
NO_DECODE_UDPAppConfig.hWhen defined, received UDP headers will not be decoded and printed to the device serial port.
NO_DECODE_DHCPAppConfig.hWhen defined, received DHCP headers will not be decoded and printed to the device serial port.
+ */ +