Demos/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  *  Remote Network Driver Interface demonstration application.
  10  *  This gives a simple reference application for implementing
  11  *  a CDC RNDIS device acting as a simple network interface for
  12  *  ethernet packet exchange. RNDIS is a proprietary Microsoft
  13  *  standard; this demo will only work on Windows 2000 (manually
  14  *  patched with the Microsoft RNDIS hotfix) and above (with no
  15  *  manual patches), or on the latest Linux kernels.
  16  *
  17  *  Before running, you will need to install the INF file that
  18  *  is located in the RNDISEthernet project directory. This will
  19  *  enable Windows to use its inbuilt RNDIS drivers, negating the
  20  *  need for special Windows drivers for the device. To install,
  21  *  right-click the .INF file and choose the Install option. If
  22  *  Windows 2000 is used, the Microsoft INF file in the hotfix
  23  *  will need to be altered to use the VID/PID of the demo and
  24  *  then chosen instead of the LUFA RNDIS INF file when prompted.
  25  *
  26  *  When enumerated, this demo will install as a new network
  27  *  adapter which ethernet packets can be sent to and received
  28  *  from. Running on top of the adapter is a very simple TCP/IP
  29  *  stack with a HTTP webserver and TELNET host which can be
  30  *  accessed through a web browser at IP address 10.0.0.2:80 or
  31  *  through a TELNET client at 10.0.0.2:25. This device also supports
  32  *  ping echos via the ICMP protocol.
  33  *
  34  *  \note The TCP/IP stack in this demo has a number of limitations
  35  *  and should serve as an example only - it is not fully featured nor
  36  *  compliant to the TCP/IP specification. For complete projects, it is
  37  *  recommended that it be replaced with an external open source TCP/IP
  38  *  stack that is feature complete, such as the uIP stack.
  39  *
  40  *  <table>
  41  *   <tr>
  42  *    <td><b>USB Mode:</b></td>
  43  *    <td>Device</td>
  44  *   </tr>
  45  *   <tr>
  46  *    <td><b>USB Class:</b></td>
  47  *    <td>Communications Device Class (CDC)</td>
  48  *   </tr>
  49  *   <tr>
  50  *    <td><b>USB Subclass:</b></td>
  51  *    <td>Remote NDIS (Microsoft Proprietary CDC Class Networking Standard)</td>
  52  *   </tr>
  53  *   <tr>
  54  *    <td><b>Relevant Standards:</b></td>
  55  *    <td>Microsoft RNDIS Specification</td>
  56  *   </tr>
  57  *   <tr>
  58  *    <td><b>Usable Speeds:</b></td>
  59  *    <td>Full Speed Mode</td>
  60  *   </tr>
  61  *  </table>
  62  */