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
   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 XP, or on modern
  53  *  Linux kernels.
  54  *
  55  *  Before running, you will need to install the INF file that
  56  *  is located in the RNDISEthernet project directory. This will
  57  *  enable Windows to use its inbuilt RNDIS drivers, negating the
  58  *  need for special Windows drivers for the device. To install,
  59  *  right-click the .INF file and choose the Install option. If
  60  *  Windows 2000 is used, the Microsoft INF file in the hotfix
  61  *  will need to be altered to use the VID/PID of the demo and
  62  *  then chosen instead of the LUFA RNDIS INF file when prompted.
  63  *
  64  *  When enumerated, this demo will install as a new network
  65  *  adapter which ethernet packets can be sent to and received
  66  *  from. When packets are received from the host, the on-board LEDs should
  67  *  flash.
  68  *
  69  *  \section Sec_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  *    <th><b>Define Name:</b></th>
  76  *    <th><b>Location:</b></th>
  77  *    <th><b>Description:</b></th>
  78  *   </tr>
  79  *   <tr>
  80  *    <td>ADAPTER_MAC_ADDRESS</td>
  81  *    <td>AppConfig.h</td>
  82  *    <td>Configures the MAC address of the RNDIS adapter on the host (PC) side.</td>
  83  *   </tr>
  84  *  </table>
  85  */
  86