Minor documentation improvements.

[pub/USBasp.git] / Projects / AVRISP-MKII / AVRISP-MKII.txt

diff --git a/Projects/AVRISP-MKII/AVRISP-MKII.txt b/Projects/AVRISP-MKII/AVRISP-MKII.txt
index a6f00b4..44ed1e4 100644 (file)
--- a/Projects/AVRISP-MKII/AVRISP-MKII.txt
+++ b/Projects/AVRISP-MKII/AVRISP-MKII.txt
@@ -10,10 +10,10 @@
  *
  *  The following list indicates what microcontrollers are compatible with this project.
  *
- *  - Series 7 USB AVRs (AT90USBxxx7)
- *  - Series 6 USB AVRs (AT90USBxxx6)
- *  - Series 4 USB AVRs (ATMEGAxxU4)
- *  - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2) - <i>8KB versions with reduced features only</i>
+ *  \li Series 7 USB AVRs (AT90USBxxx7)
+ *  \li Series 6 USB AVRs (AT90USBxxx6)
+ *  \li Series 4 USB AVRs (ATMEGAxxU4)
+ *  \li Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2) - <i>8KB versions with reduced features only</i>
  *
  *  \section Sec_Info USB Information:
  *
@@ -37,21 +37,22 @@
  *   <td>Atmel AVRISP MKII Protocol Specification</td>
  *  </tr>
  *  <tr>
- *   <td><b>Usable Speeds:</b></td>
+ *   <td><b>Supported USB Speeds:</b></td>
  *   <td>Full Speed Mode</td>
  *  </tr>
  * </table>
  *
  *  \section Sec_Description Project Description:
  *
- *  Firmware for an AVRStudio compatible AVRISP-MKII clone programmer. This project will enable the USB AVR series of
- *  microcontrollers to act as a clone of the official Atmel AVRISP-MKII programmer, usable within AVRStudio. In its
- *  most basic form, it allows for the programming of AVRs at the programmer's VCC voltage from within AVRStudio with
- *  no special hardware other than the USB AVR and the parts needed for the USB interface. If the user desires, more
+ *  Firmware for an Atmel Studio/AVRStudio compatible AVRISP-MKII clone programmer. This project will enable the USB
+ *  AVR series of microcontrollers to act as a clone of the official Atmel AVRISP-MKII programmer, usable within
+ *  Atmel Studio/AVRStudio or with any software capable of driving a real Atmel AVRISP-MKII programmer. In its most
+ *  basic form, it allows for the programming of AVRs at the programmer's VCC voltage from within Atmel Studio/AVRStudio
+ *  with no special hardware other than the USB AVR and the parts needed for the USB interface. If the user desires, more
  *  advanced circuits incorporating level conversion can be made to allow for the programming of 3.3V AVR designs.
  *
  *  This device spoofs Atmel's official AVRISP-MKII device PID so that it remains compatible with Atmel's AVRISP-MKII
- *  drivers. When prompted, direct your OS to install Atmel's AVRISP-MKII drivers provided with AVRStudio.
+ *  drivers. When prompted, direct your OS to install Atmel's AVRISP-MKII drivers provided with Atmel Studio/AVRStudio.
  *
  *  Note that this design currently has the following limitations:
  *    - No reversed/shorted target connector detection and notification
@@ -292,7 +293,21 @@
  *    <td>LIBUSB_DRIVER_COMPAT</td>
  *    <td>Makefile LUFA_OPTS</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.</td>
+ *        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>XCK_RESCUE_CLOCK_ENABLE</td>