Add updated board driver directory summaries to the documentation.

[pub/USBasp.git] / Projects / XPLAINBridge / XPLAINBridge.txt

diff --git a/Projects/XPLAINBridge/XPLAINBridge.txt b/Projects/XPLAINBridge/XPLAINBridge.txt
index e90a2d6..f967d3b 100644 (file)
--- a/Projects/XPLAINBridge/XPLAINBridge.txt
+++ b/Projects/XPLAINBridge/XPLAINBridge.txt
@@ -4,56 +4,68 @@
  *  documentation pages. It is not a project source file.\r
  */\r
  \r
  *  documentation pages. It is not a project source file.\r
  */\r
  \r

-/** \mainpage XPLAIN UART Bridge Project\r
+/** \mainpage XPLAIN UART Bridge/PDI Programmer Project\r

  *\r
  *\r

- *  \section SSec_Compat Demo Compatibility:\r
+ *  \section SSec_Compat Project Compatibility:\r

  *\r
  *\r

- *  The following list indicates what microcontrollers are compatible with this demo.\r
+ *  The following list indicates what microcontrollers are compatible with this project.\r

  *\r
  *  - AT90USB1287\r
  *\r
  *  \section SSec_Info USB Information:\r
  *\r
  *\r
  *  - AT90USB1287\r
  *\r
  *  \section SSec_Info USB Information:\r
  *\r

- *  The following table gives a rundown of the USB utilization of this demo.\r
+ *  The following table gives a rundown of the USB utilization of this project.\r

  *\r
  *  <table>\r
  *   <tr>\r
  *    <td><b>USB Mode:</b></td>\r
  *\r
  *  <table>\r
  *   <tr>\r
  *    <td><b>USB Mode:</b></td>\r

- *    <td>Device</td>\r
+ *    <td>1) Device</td>\r
+ *    <td>2) Device</td>\r

  *   </tr>\r
  *   <tr>\r
  *    <td><b>USB Class:</b></td>\r
  *   </tr>\r
  *   <tr>\r
  *    <td><b>USB Class:</b></td>\r

- *    <td>Communications Device Class (CDC)</td>\r
+ *    <td>1) Communications Device Class (CDC)</td>\r
+ *    <td>2) Vendor Specific Class</td>\r

  *   </tr>\r
  *   <tr> \r
  *    <td><b>USB Subclass:</b></td>\r
  *   </tr>\r
  *   <tr> \r
  *    <td><b>USB Subclass:</b></td>\r

- *    <td>Abstract Control Model (ACM)</td>\r
+ *    <td>1) Abstract Control Model (ACM)</td>\r
+ *    <td>2) N/A</td>\r

  *   </tr>\r
  *   <tr>\r
  *    <td><b>Relevant Standards:</b></td>\r
  *   </tr>\r
  *   <tr>\r
  *    <td><b>Relevant Standards:</b></td>\r

- *    <td>USBIF CDC Class Standard</td>\r
+ *    <td>1) USBIF CDC Class Standard</td>\r
+ *    <td>2) Atmel AVRISP MKII Protocol Specification</td>\r

  *   </tr>\r
  *   <tr>\r
  *    <td><b>Usable Speeds:</b></td>\r
  *   </tr>\r
  *   <tr>\r
  *    <td><b>Usable Speeds:</b></td>\r

- *    <td>Full Speed Mode</td>\r
+ *    <td>1) Full Speed Mode</td>\r
+ *    <td>2) Full Speed Mode</td>\r

  *   </tr>\r
  *  </table>\r
  *\r
  *  \section SSec_Description Project Description: \r
  *\r
  *   </tr>\r
  *  </table>\r
  *\r
  *  \section SSec_Description Project Description: \r
  *\r

- *  This is a virtual serial port to soft-UART converter, for use on the Atmel XPLAIN boards. This project replaces the firmware\r
- *  preloaded onto the XPLAIN's onboard AT90USB1287 microcontroller to act as a a UART-to-USB bridge between the device and the\r
- *  host. When inserted, the device will enumerate as a regular COM port on the host, which can then be opened and data exchanged\r
- *  between the XMEGA and Host as if the XMEGA was connected directly to the host's serial port.\r
+ *  This project serves a dual purpose. When loaded into the USB AVR on the XPLAIN board, it will act as either a USB to Serial\r
+ *  converter for the XPLAIN's hardware USART (at a speed of 9600 baud), or an AVRStudio compaible PDI programmer for the XMEGA.\r
+ *  This project replaces the firmware preloaded onto the XPLAIN's onboard AT90USB1287 microcontroller.\r

  *\r
  *\r

- *  After running this demo for the first time on a new computer, you will need to supply the .INF file located in this demo\r
+ *  When power to the board is applied, the TDI pin (pin 9) of the USB AVR's JTAG port is read. If the pin is left high, the device\r
+ *  will enumerate as a regular COM port on the host, which can then be opened and data exchanged between the XMEGA and Host as if\r
+ *  the XMEGA was connected directly to the host's serial port. If the pin is pulled low by shorting it to GND (pin 10), the device\r
+ *  will enumerate as an AVRISP-MKII to the host, so that the XMEGA can be reprogrammed by AVRStudio or other compatible software\r
+ *  such as avrdude.\r
+ *\r
+ *  After running this project for the first time on a new computer, you will need to supply the .INF file located in this project\r

  *  project's directory as the device's driver when running under Windows. This will enable Windows to use its inbuilt CDC drivers,\r
  *  negating the need for custom drivers for the device. Other Operating Systems should automatically use their own inbuilt CDC-ACM\r
  *  drivers.\r
  *\r
  *  project's directory as the device's driver when running under Windows. This will enable Windows to use its inbuilt CDC drivers,\r
  *  negating the need for custom drivers for the device. Other Operating Systems should automatically use their own inbuilt CDC-ACM\r
  *  drivers.\r
  *\r

+ *  This project relies on files from the LUFA AVRISP-MKII project for compilation.\r
+ *\r

  *  \section SSec_Options Project Options\r
  *\r
  *  \section SSec_Options Project Options\r
  *\r

- *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.\r
+ *  The following defines can be found in this project, which can control the project behaviour when defined, or changed in value.\r

  *\r
  *  <table>\r
  *   <tr>\r
  *\r
  *  <table>\r
  *   <tr>\r