Projects/XPLAINBridge/XPLAINBridge.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 XPLAIN UART Bridge Project
   8  *
   9  *  \section SSec_Compat Project Compatibility:
  10  *
  11  *  The following list indicates what microcontrollers are compatible with this project.
  12  *
  13  *  - AT90USB1287
  14  *
  15  *  \section SSec_Info USB Information:
  16  *
  17  *  The following table gives a rundown of the USB utilization of this project.
  18  *
  19  *  <table>
  20  *   <tr>
  21  *    <td><b>USB Mode:</b></td>
  22  *    <td>Device</td>
  23  *   </tr>
  24  *   <tr>
  25  *    <td><b>USB Class:</b></td>
  26  *    <td>Communications Device Class (CDC)</td>
  27  *   </tr>
  28  *   <tr>
  29  *    <td><b>USB Subclass:</b></td>
  30  *    <td>Abstract Control Model (ACM)</td>
  31  *   </tr>
  32  *   <tr>
  33  *    <td><b>Relevant Standards:</b></td>
  34  *    <td>USBIF CDC Class Standard</td>
  35  *   </tr>
  36  *   <tr>
  37  *    <td><b>Usable Speeds:</b></td>
  38  *    <td>Full Speed Mode</td>
  39  *   </tr>
  40  *  </table>
  41  *
  42  *  \section SSec_Description Project Description:
  43  *
  44  *  This is a virtual serial port to soft-UART converter, for use on the Atmel XPLAIN boards. This project replaces the firmware
  45  *  preloaded onto the XPLAIN's onboard AT90USB1287 microcontroller to act as a a UART-to-USB bridge between the device and the
  46  *  host. When inserted, the device will enumerate as a regular COM port on the host, which can then be opened and data exchanged
  47  *  between the XMEGA and Host as if the XMEGA was connected directly to the host's serial port.
  48  *
  49  *  After running this project for the first time on a new computer, you will need to supply the .INF file located in this project
  50  *  project's directory as the device's driver when running under Windows. This will enable Windows to use its inbuilt CDC drivers,
  51  *  negating the need for custom drivers for the device. Other Operating Systems should automatically use their own inbuilt CDC-ACM
  52  *  drivers.
  53  *
  54  *  \section SSec_Options Project Options
  55  *
  56  *  The following defines can be found in this project, which can control the project behaviour when defined, or changed in value.
  57  *
  58  *  <table>
  59  *   <tr>
  60  *    <td><b>Define Name:</b></td>
  61  *    <td><b>Location:</b></td>
  62  *    <td><b>Description:</b></td>
  63  *   </tr>
  64  *   <tr>
  65  *    <td>BUFF_STATICSIZE</td>
  66  *    <td>RingBuff.h</td>
  67  *    <td>Defines the maximum number of bytes which can be buffered in each Ring Buffer.</td>
  68  *   </tr>
  69  *  </table>
  70  */