Merge in latest trunk.

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

diff --git a/Projects/XPLAINBridge/XPLAINBridge.txt b/Projects/XPLAINBridge/XPLAINBridge.txt
index fe7e739..bc0ca37 100644 (file)
--- a/Projects/XPLAINBridge/XPLAINBridge.txt
+++ b/Projects/XPLAINBridge/XPLAINBridge.txt
@@ -3,16 +3,16 @@
  *  This file contains special DoxyGen information for the generation of the main page and other special
  *  documentation pages. It is not a project source file.
  */
- 
+
 /** \mainpage XPLAIN UART Bridge/PDI Programmer Project
  *
- *  \section SSec_Compat Project Compatibility:
+ *  \section Sec_Compat Project Compatibility:
  *
  *  The following list indicates what microcontrollers are compatible with this project.
  *
- *  - AT90USB1287
+ *  \li AT90USB1287
  *
- *  \section SSec_Info USB Information:
+ *  \section Sec_Info USB Information:
  *
  *  The following table gives a rundown of the USB utilization of this project.
  *
@@ -27,7 +27,7 @@
  *    <td>1) Communications Device Class (CDC)</td>
  *    <td>2) Vendor Specific Class</td>
  *   </tr>
- *   <tr> 
+ *   <tr>
  *    <td><b>USB Subclass:</b></td>
  *    <td>1) Abstract Control Model (ACM)</td>
  *    <td>2) N/A</td>
@@ -38,13 +38,13 @@
  *    <td>2) Atmel AVRISP MKII Protocol Specification</td>
  *   </tr>
  *   <tr>
- *    <td><b>Usable Speeds:</b></td>
+ *    <td><b>Supported USB Speeds:</b></td>
  *    <td>1) Full Speed Mode</td>
  *    <td>2) Full Speed Mode</td>
  *   </tr>
  *  </table>
  *
- *  \section SSec_Description Project Description: 
+ *  \section Sec_Description Project Description:
  *
  *  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
  *  converter for the XPLAIN's hardware USART (at a speed of 9600 baud), or an AVRStudio compatible PDI programmer for the XMEGA.
@@ -68,7 +68,7 @@
  *
  *  This project relies on files from the LUFA AVRISP-MKII project for compilation.
  *
- *  \section SSec_Options Project Options
+ *  \section Sec_Options Project Options
  *
  *  The following defines can be found in this project, which can control the project behaviour when defined, or changed in value.
  *
@@ -79,15 +79,31 @@
  *    <td><b>Description:</b></td>
  *   </tr>
  *   <tr>
- *    <td>BUFFER_SIZE</td>
- *    <td>LightweightRingBuff.h</td>
- *    <td>Defines the maximum number of bytes which can be buffered in each Ring Buffer when in serial bridge mode.</td>
- *   </tr>
- *   <tr>
  *    <td>LIBUSB_DRIVER_COMPAT</td>
- *    <td>Makefile LUFA_OPTS</td>
+ *    <td>AppConfig.h</td>
  *    <td>Define to switch to a non-standard endpoint scheme, breaking compatibility with AVRStudio under Windows but making
  *        the code compatible with software such as avrdude (all platforms) that use the libUSB driver.
+ *
+ *        \note This option is incompatible with \c RESET_TOGGLES_LIBUSB_COMPAT.</td>
+ *   </tr>
+ *   <tr>
+ *    <td>RESET_TOGGLES_LIBUSB_COMPAT</td>
+ *    <td>Makefile LUFA_OPTS</td>
+ *    <td>Define to make the /RESET line of the AVR toggle between Jungo and libUSB driver compatibility modes. Each time the AVR is
+ *        reset externally via the reset pin, the compatibility mode will be toggled. The compatibility mode is preserved between
+ *        power cycles and is not toggled via other forms of reset such as Watchdog or Brown Out.
+ *
+ *        When this option is enabled, all board LEDs will flash twice on startup for Jungo compatibility mode, and five times for
+ *        libUSB compatibility mode.
+ *
+ *        \note This option is incompatible with \c LIBUSB_DRIVER_COMPAT.</td>
+ *   </tr>
+ *   <tr>
+ *    <td>FIRMWARE_VERSION_MINOR</td>
+ *    <td>AppConfig.h</td>
+ *    <td>Define to set the minor firmware revision nunber reported to the host on request. By default this will use a firmware version compatible
+ *        with the latest Atmel IDE version, however if desired the reported minor value can be adjusted here.</td>
  *   </tr>
  *  </table>
  */
+