X-Git-Url: http://git.linex4red.de/pub/lufa.git/blobdiff_plain/6b5e684c77e5fa855b609d01e9a07fec296e9257..refs/heads/master:/Demos/Device/ClassDriver/RNDISEthernet/RNDISEthernet.txt

diff --git a/Demos/Device/ClassDriver/RNDISEthernet/RNDISEthernet.txt b/Demos/Device/ClassDriver/RNDISEthernet/RNDISEthernet.txt
index ab325ca00..c926ddae5 100644
--- a/Demos/Device/ClassDriver/RNDISEthernet/RNDISEthernet.txt
+++ b/Demos/Device/ClassDriver/RNDISEthernet/RNDISEthernet.txt
@@ -3,17 +3,20 @@
  *  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)
+
+/** \mainpage RNDIS Class Ethernet Demo
  *
- *  \section SSec_Compat Demo Compatibility:
+ *  \section Sec_Compat Demo Compatibility:
  *
  *  The following list indicates what microcontrollers are compatible with this demo.
  *
- *  - Series 7 USB AVRs
- *  - Series 6 USB AVRs
+ *  \li Series 7 USB AVRs (AT90USBxxx7)
+ *  \li Series 6 USB AVRs (AT90USBxxx6)
+ *  \li Series AU XMEGA AVRs (ATXMEGAxxxAxU)
+ *  \li Series B XMEGA AVRs (ATXMEGAxxxBx)
+ *  \li Series C XMEGA AVRs (ATXMEGAxxxCx)
  *
- *  \section SSec_Info USB Information:
+ *  \section Sec_Info USB Information:
  *
  *  The following table gives a rundown of the USB utilization of this demo.
  *
@@ -26,7 +29,7 @@
  *    <td><b>USB Class:</b></td>
  *    <td>Communications Device Class (CDC)</td>
  *   </tr>
- *   <tr> 
+ *   <tr>
  *    <td><b>USB Subclass:</b></td>
  *    <td>Remote NDIS (Microsoft Proprietary CDC Class Networking Standard)</td>
  *   </tr>
@@ -35,21 +38,20 @@
  *    <td>Microsoft RNDIS Specification</td>
  *   </tr>
  *   <tr>
- *    <td><b>Usable Speeds:</b></td>
+ *    <td><b>Supported USB Speeds:</b></td>
  *    <td>Full Speed Mode</td>
  *   </tr>
  *  </table>
  *
- *  \section SSec_Description Project Description: 
+ *  \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.
- *  
+ *  standard; this demo will only work on Windows XP, or on modern
+ *  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
@@ -58,65 +60,27 @@
  *  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.
+ *  from. When packets are received from the host, the on-board LEDs should
+ *  flash.
  *
- *  \section SSec_Options Project Options
+ *  \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.
  *
  *  <table>
  *   <tr>
- *    <td><b>Define Name:</b></td>
- *    <td><b>Location:</b></td>
- *    <td><b>Description:</b></td>
- *   </tr>
- *   <tr>
- *    <td>NO_DECODE_ETHERNET</td>
- *    <td>Makefile LUFA_OPTS</td>
- *    <td>When defined, received Ethernet headers will not be decoded and printed to the device serial port.</td>
- *   </tr>
- *   <tr>
- *    <td>NO_DECODE_ARP</td>
- *    <td>Makefile LUFA_OPTS</td>
- *    <td>When defined, received ARP headers will not be decoded and printed to the device serial port.</td>
- *   </tr>
- *   <tr>
- *    <td>NO_DECODE_IP</td>
- *    <td>Makefile LUFA_OPTS</td>
- *    <td>When defined, received IP headers will not be decoded and printed to the device serial port.</td>
- *   </tr>
- *   <tr>
- *    <td>NO_DECODE_ICMP</td>
- *    <td>Makefile LUFA_OPTS</td>
- *    <td>When defined, received ICMP headers will not be decoded and printed to the device serial port.</td>
- *   </tr>
- *   <tr>
- *    <td>NO_DECODE_TCP</td>
- *    <td>Makefile LUFA_OPTS</td>
- *    <td>When defined, received TCP headers will not be decoded and printed to the device serial port.</td>
- *   </tr>
- *   <tr>
- *    <td>NO_DECODE_UDP</td>
- *    <td>Makefile LUFA_OPTS</td>
- *    <td>When defined, received UDP headers will not be decoded and printed to the device serial port.</td>
+ *    <th><b>Define Name:</b></th>
+ *    <th><b>Location:</b></th>
+ *    <th><b>Description:</b></th>
  *   </tr>
  *   <tr>
- *    <td>NO_DECODE_DHCP</td>
- *    <td>Makefile LUFA_OPTS</td>
- *    <td>When defined, received DHCP headers will not be decoded and printed to the device serial port.</td>
+ *    <td>ADAPTER_MAC_ADDRESS</td>
+ *    <td>AppConfig.h</td>
+ *    <td>Configures the MAC address of the RNDIS adapter on the host (PC) side.</td>
  *   </tr>
  *  </table>
- */
\ No newline at end of file
+ */
+