Demos/Device/LowLevel/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  *  - Series 7 USB AVRs (AT90USBxxx7)
  14  *  - Series 6 USB AVRs (AT90USBxxx6)
  15  *
  16  *  \section Sec_Info USB Information:
  17  *
  18  *  The following table gives a rundown of the USB utilization of this demo.
  19  *
  20  *  <table>
  21  *   <tr>
  22  *    <td><b>USB Mode:</b></td>
  23  *    <td>Device</td>
  24  *   </tr>
  25  *   <tr>
  26  *    <td><b>USB Class:</b></td>
  27  *    <td>Communications Device Class (CDC)</td>
  28  *   </tr>
  29  *   <tr>
  30  *    <td><b>USB Subclass:</b></td>
  31  *    <td>Remote NDIS (Microsoft Proprietary CDC Class Networking Standard)</td>
  32  *   </tr>
  33  *   <tr>
  34  *    <td><b>Relevant Standards:</b></td>
  35  *    <td>Microsoft RNDIS Specification</td>
  36  *   </tr>
  37  *   <tr>
  38  *    <td><b>Usable Speeds:</b></td>
  39  *    <td>Full Speed Mode</td>
  40  *   </tr>
  41  *  </table>
  42  *
  43  *  \section Sec_Description Project Description:
  44  *
  45  *  Remote Network Driver Interface demonstration application.
  46  *  This gives a simple reference application for implementing
  47  *  a CDC RNDIS device acting as a simple network interface for
  48  *  ethernet packet exchange. RNDIS is a proprietary Microsoft
  49  *  standard; this demo will only work on Windows 2000 (manually
  50  *  patched with the Microsoft RNDIS hotfix) and above (with no
  51  *  manual patches), or on the latest Linux kernels.
  52  *
  53  *  Before running, you will need to install the INF file that
  54  *  is located in the RNDISEthernet project directory. This will
  55  *  enable Windows to use its inbuilt RNDIS drivers, negating the
  56  *  need for special Windows drivers for the device. To install,
  57  *  right-click the .INF file and choose the Install option. If
  58  *  Windows 2000 is used, the Microsoft INF file in the hotfix
  59  *  will need to be altered to use the VID/PID of the demo and
  60  *  then chosen instead of the LUFA RNDIS INF file when prompted.
  61  *
  62  *  When enumerated, this demo will install as a new network
  63  *  adapter which ethernet packets can be sent to and received
  64  *  from. Running on top of the adapter is a very simple TCP/IP
  65  *  stack with a HTTP webserver and TELNET host which can be
  66  *  accessed through a web browser at IP address 10.0.0.2:80 or
  67  *  through a TELNET client at 10.0.0.2:25. This device also supports
  68  *  ping echos via the ICMP protocol.
  69  *
  70  *  \note The TCP/IP stack in this demo has a number of limitations
  71  *  and should serve as an example only - it is not fully featured nor
  72  *  compliant to the TCP/IP specification. For complete projects, it is
  73  *  recommended that it be replaced with an external open source TCP/IP
  74  *  stack that is feature complete, such as the uIP stack.
  75  *
  76  *  \section Sec_Options Project Options
  77  *
  78  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  79  *
  80  *  <table>
  81  *   <tr>
  82  *    <td><b>Define Name:</b></td>
  83  *    <td><b>Location:</b></td>
  84  *    <td><b>Description:</b></td>
  85  *   </tr>
  86  *   <tr>
  87  *    <td>NO_DECODE_ETHERNET</td>
  88  *    <td>Makefile LUFA_OPTS</td>
  89  *    <td>When defined, received Ethernet headers will not be decoded and printed to the device serial port.</td>
  90  *   </tr>
  91  *   <tr>
  92  *    <td>NO_DECODE_ARP</td>
  93  *    <td>Makefile LUFA_OPTS</td>
  94  *    <td>When defined, received ARP headers will not be decoded and printed to the device serial port.</td>
  95  *   </tr>
  96  *   <tr>
  97  *    <td>NO_DECODE_IP</td>
  98  *    <td>Makefile LUFA_OPTS</td>
  99  *    <td>When defined, received IP headers will not be decoded and printed to the device serial port.</td>
 100  *   </tr>
 101  *   <tr>
 102  *    <td>NO_DECODE_ICMP</td>
 103  *    <td>Makefile LUFA_OPTS</td>
 104  *    <td>When defined, received ICMP headers will not be decoded and printed to the device serial port.</td>
 105  *   </tr>
 106  *   <tr>
 107  *    <td>NO_DECODE_TCP</td>
 108  *    <td>Makefile LUFA_OPTS</td>
 109  *    <td>When defined, received TCP headers will not be decoded and printed to the device serial port.</td>
 110  *   </tr>
 111  *   <tr>
 112  *    <td>NO_DECODE_UDP</td>
 113  *    <td>Makefile LUFA_OPTS</td>
 114  *    <td>When defined, received UDP headers will not be decoded and printed to the device serial port.</td>
 115  *   </tr>
 116  *   <tr>
 117  *    <td>NO_DECODE_DHCP</td>
 118  *    <td>Makefile LUFA_OPTS</td>
 119  *    <td>When defined, received DHCP headers will not be decoded and printed to the device serial port.</td>
 120  *   </tr>
 121  *  </table>
 122  */
 123