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