lib/lufa/Demos/Device/ClassDriver/RNDISEthernet/RNDISEthernet.txt

   1 /** \file
   2  *
   3  *  This file contains special DoxyGen information for the generation of the main page and other special
   4  *  documentation pages. It is not a project source file.
   5  */
   6
   7 /** \mainpage RNDIS Class Ethernet Demo (with Webserver/Telnet)
   8  *
   9  *  \section Sec_Compat Demo Compatibility:
  10  *
  11  *  The following list indicates what microcontrollers are compatible with this demo.
  12  *
  13  *  \li Series 7 USB AVRs (AT90USBxxx7)
  14  *  \li Series 6 USB AVRs (AT90USBxxx6)
  15  *  \li Series AU XMEGA AVRs (ATXMEGAxxxAxU)
  16  *  \li Series B XMEGA AVRs (ATXMEGAxxxBx)
  17  *  \li Series C XMEGA AVRs (ATXMEGAxxxCx)
  18  *
  19  *  \section Sec_Info USB Information:
  20  *
  21  *  The following table gives a rundown of the USB utilization of this demo.
  22  *
  23  *  <table>
  24  *   <tr>
  25  *    <td><b>USB Mode:</b></td>
  26  *    <td>Device</td>
  27  *   </tr>
  28  *   <tr>
  29  *    <td><b>USB Class:</b></td>
  30  *    <td>Communications Device Class (CDC)</td>
  31  *   </tr>
  32  *   <tr>
  33  *    <td><b>USB Subclass:</b></td>
  34  *    <td>Remote NDIS (Microsoft Proprietary CDC Class Networking Standard)</td>
  35  *   </tr>
  36  *   <tr>
  37  *    <td><b>Relevant Standards:</b></td>
  38  *    <td>Microsoft RNDIS Specification</td>
  39  *   </tr>
  40  *   <tr>
  41  *    <td><b>Supported USB Speeds:</b></td>
  42  *    <td>Full Speed Mode</td>
  43  *   </tr>
  44  *  </table>
  45  *
  46  *  \section Sec_Description Project Description:
  47  *
  48  *  Remote Network Driver Interface demonstration application.
  49  *  This gives a simple reference application for implementing
  50  *  a CDC RNDIS device acting as a simple network interface for
  51  *  ethernet packet exchange. RNDIS is a proprietary Microsoft
  52  *  standard; this demo will only work on Windows 2000 (manually
  53  *  patched with the Microsoft RNDIS hotfix) and above (with no
  54  *  manual patches), or on the latest Linux kernels.
  55  *
  56  *  Before running, you will need to install the INF file that
  57  *  is located in the RNDISEthernet project directory. This will
  58  *  enable Windows to use its inbuilt RNDIS drivers, negating the
  59  *  need for special Windows drivers for the device. To install,
  60  *  right-click the .INF file and choose the Install option. If
  61  *  Windows 2000 is used, the Microsoft INF file in the hotfix
  62  *  will need to be altered to use the VID/PID of the demo and
  63  *  then chosen instead of the LUFA RNDIS INF file when prompted.
  64  *
  65  *  When enumerated, this demo will install as a new network
  66  *  adapter which ethernet packets can be sent to and received
  67  *  from. Running on top of the adapter is a very simple TCP/IP
  68  *  stack with a HTTP webserver and TELNET host which can be
  69  *  accessed through a web browser at IP address 10.0.0.2:80 or
  70  *  through a TELNET client at 10.0.0.2:25. This device also supports
  71  *  ping echos via the ICMP protocol.
  72  *
  73  *  \note The TCP/IP stack in this demo has a number of limitations
  74  *  and should serve as an example only - it is not fully featured nor
  75  *  compliant to the TCP/IP specification. For complete projects, it is
  76  *  recommended that it be replaced with an external open source TCP/IP
  77  *  stack that is feature complete, such as the uIP stack.
  78  *
  79  *  \section Sec_Options Project Options
  80  *
  81  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  82  *
  83  *  <table>
  84  *   <tr>
  85  *    <th><b>Define Name:</b></th>
  86  *    <th><b>Location:</b></th>
  87  *    <th><b>Description:</b></th>
  88  *   </tr>
  89  *   <tr>
  90  *    <td>CLIENT_IP_ADDRESS</td>
  91  *    <td>AppConfig.h</td>
  92  *    <td>Configures the IP address given to the client (PC) via the DHCP server.</td>
  93  *   </tr>
  94  *   <tr>
  95  *    <td>SERVER_IP_ADDRESS</td>
  96  *    <td>AppConfig.h</td>
  97  *    <td>Configures the IP address of the virtual server.</td>
  98  *   </tr>
  99  *   <tr>
 100  *    <td>ADAPTER_MAC_ADDRESS</td>
 101  *    <td>AppConfig.h</td>
 102  *    <td>Configures the MAC address of the RNDIS adapter on the host (PC) side.</td>
 103  *   </tr>
 104  *   <tr>
 105  *    <td>SERVER_MAC_ADDRESS</td>
 106  *    <td>AppConfig.h</td>
 107  *    <td>Configures the MAC address of the virtual server on the network.</td>
 108  *   </tr>
 109  *   <tr>
 110  *    <td>NO_DECODE_ETHERNET</td>
 111  *    <td>AppConfig.h</td>
 112  *    <td>When defined, received Ethernet headers will not be decoded and printed to the device serial port.</td>
 113  *   </tr>
 114  *   <tr>
 115  *    <td>NO_DECODE_ARP</td>
 116  *    <td>AppConfig.h</td>
 117  *    <td>When defined, received ARP headers will not be decoded and printed to the device serial port.</td>
 118  *   </tr>
 119  *   <tr>
 120  *    <td>NO_DECODE_IP</td>
 121  *    <td>AppConfig.h</td>
 122  *    <td>When defined, received IP headers will not be decoded and printed to the device serial port.</td>
 123  *   </tr>
 124  *   <tr>
 125  *    <td>NO_DECODE_ICMP</td>
 126  *    <td>AppConfig.h</td>
 127  *    <td>When defined, received ICMP headers will not be decoded and printed to the device serial port.</td>
 128  *   </tr>
 129  *   <tr>
 130  *    <td>NO_DECODE_TCP</td>
 131  *    <td>AppConfig.h</td>
 132  *    <td>When defined, received TCP headers will not be decoded and printed to the device serial port.</td>
 133  *   </tr>
 134  *   <tr>
 135  *    <td>NO_DECODE_UDP</td>
 136  *    <td>AppConfig.h</td>
 137  *    <td>When defined, received UDP headers will not be decoded and printed to the device serial port.</td>
 138  *   </tr>
 139  *   <tr>
 140  *    <td>NO_DECODE_DHCP</td>
 141  *    <td>AppConfig.h</td>
 142  *    <td>When defined, received DHCP headers will not be decoded and printed to the device serial port.</td>
 143  *   </tr>
 144  *  </table>
 145  */
 146