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 3d43cb1..2cf8ceb 100644 (file)
--- a/Projects/AVRISP-MKII/AVRISP-MKII.txt
+++ b/Projects/AVRISP-MKII/AVRISP-MKII.txt
@@ -214,60 +214,60 @@
  *   </tr>
  *   <tr>
  *    <td>AUX_LINE_PORT</td>
  *   </tr>
  *   <tr>
  *    <td>AUX_LINE_PORT</td>

- *    <td>Makefile LUFA_OPTS</td>
+ *    <td>AppConfig.h</td>

  *    <td>PORT register for the programmer's AUX target line. The use of this line varies between the programming protocols,
  *        but is generally used for the target's /RESET line.
  *        \n \n <i>Ignored when compiled for the XPLAIN board.</i></td>
  *   </tr>
  *   <tr>
  *    <td>AUX_LINE_PIN</td>
  *    <td>PORT register for the programmer's AUX target line. The use of this line varies between the programming protocols,
  *        but is generally used for the target's /RESET line.
  *        \n \n <i>Ignored when compiled for the XPLAIN board.</i></td>
  *   </tr>
  *   <tr>
  *    <td>AUX_LINE_PIN</td>

- *    <td>Makefile LUFA_OPTS</td>
+ *    <td>AppConfig.h</td>

  *    <td>PIN register for the programmer's AUX target line. The use of this line varies between the programming protocols,
  *        but is generally used for the target's /RESET line.
  *        \n \n <i>Ignored when compiled for the XPLAIN board.</i></td>
  *   </tr>
  *   <tr>
  *    <td>AUX_LINE_DDR</td>
  *    <td>PIN register for the programmer's AUX target line. The use of this line varies between the programming protocols,
  *        but is generally used for the target's /RESET line.
  *        \n \n <i>Ignored when compiled for the XPLAIN board.</i></td>
  *   </tr>
  *   <tr>
  *    <td>AUX_LINE_DDR</td>

- *    <td>Makefile LUFA_OPTS</td>
+ *    <td>AppConfig.h</td>

  *    <td>DDR register for the programmer's AUX target line. The use of this line varies between the programming protocols,
  *        but is generally used for the target's /RESET line.
  *        \n \n <i>Ignored when compiled for the XPLAIN board.</i></td>
  *   </tr>
  *   <tr>
  *    <td>AUX_LINE_MASK</td>
  *    <td>DDR register for the programmer's AUX target line. The use of this line varies between the programming protocols,
  *        but is generally used for the target's /RESET line.
  *        \n \n <i>Ignored when compiled for the XPLAIN board.</i></td>
  *   </tr>
  *   <tr>
  *    <td>AUX_LINE_MASK</td>

- *    <td>Makefile LUFA_OPTS</td>
+ *    <td>AppConfig.h</td>

  *    <td>Mask for the programmer's AUX target line. The use of this line varies between the programming protocols,
  *        but is generally used for the target's /RESET line. <b>Must not be the AVR's /SS pin</b>.
  *        \n \n <i>Ignored when compiled for the XPLAIN board.</i></td>
  *   </tr>
  *   <tr>
  *    <td>VTARGET_ADC_CHANNEL</td>
  *    <td>Mask for the programmer's AUX target line. The use of this line varies between the programming protocols,
  *        but is generally used for the target's /RESET line. <b>Must not be the AVR's /SS pin</b>.
  *        \n \n <i>Ignored when compiled for the XPLAIN board.</i></td>
  *   </tr>
  *   <tr>
  *    <td>VTARGET_ADC_CHANNEL</td>

- *    <td>Makefile LUFA_OPTS</td>
+ *    <td>AppConfig.h</td>

  *    <td>ADC channel number (on supported AVRs) to use for VTARGET level detection, if NO_VTARGET_DETECT is not defined.
  *        \n \n <i>Ignored when compiled for targets lacking an ADC.</i></td>
  *   </tr>
  *   <tr>
  *    <td>ENABLE_ISP_PROTOCOL</td>
  *    <td>ADC channel number (on supported AVRs) to use for VTARGET level detection, if NO_VTARGET_DETECT is not defined.
  *        \n \n <i>Ignored when compiled for targets lacking an ADC.</i></td>
  *   </tr>
  *   <tr>
  *    <td>ENABLE_ISP_PROTOCOL</td>

- *    <td>Makefile LUFA_OPTS</td>
+ *    <td>AppConfig.h</td>

  *    <td>Define to enable SPI programming protocol support.
  *        \n \n <i>Ignored when compiled for the XPLAIN board.</i></td>
  *   </tr>
  *   <tr>
  *    <td>ENABLE_XPROG_PROTOCOL</td>
  *    <td>Define to enable SPI programming protocol support.
  *        \n \n <i>Ignored when compiled for the XPLAIN board.</i></td>
  *   </tr>
  *   <tr>
  *    <td>ENABLE_XPROG_PROTOCOL</td>

- *    <td>Makefile LUFA_OPTS</td>
+ *    <td>AppConfig.h</td>

  *    <td>Define to enable PDI and TPI programming protocol support.
  *        \n \n <i>Ignored when compiled for the XPLAIN board.</i></td>
  *   </tr>
  *   <tr>
  *    <td>NO_VTARGET_DETECT</td>
  *    <td>Define to enable PDI and TPI programming protocol support.
  *        \n \n <i>Ignored when compiled for the XPLAIN board.</i></td>
  *   </tr>
  *   <tr>
  *    <td>NO_VTARGET_DETECT</td>

- *    <td>Makefile LUFA_OPTS</td>
+ *    <td>AppConfig.h</td>

  *    <td>Define to disable VTARGET sampling and reporting on AVR models with an ADC converter. This will cause the programmer
  *        to report a fixed 3.3V target voltage to the host regardless of the real target voltage. 
  *        \n \n <i>Ignored when compiled for targets lacking an ADC.</i></td>
  *   </tr>
  *   <tr>
  *    <td>VTARGET_REF_VOLTS</td>
  *    <td>Define to disable VTARGET sampling and reporting on AVR models with an ADC converter. This will cause the programmer
  *        to report a fixed 3.3V target voltage to the host regardless of the real target voltage. 
  *        \n \n <i>Ignored when compiled for targets lacking an ADC.</i></td>
  *   </tr>
  *   <tr>
  *    <td>VTARGET_REF_VOLTS</td>

- *    <td>Makefile LUFA_OPTS</td>
+ *    <td>AppConfig.h</td>

  *    <td>Indicates the programmer AVR's AVCC reference voltage when measuring the target's supply voltage. Note that the supply
  *        voltage should never exceed the reference voltage on the programmer AVR without some form of protection to prevent damage
  *        to the ADC.
  *    <td>Indicates the programmer AVR's AVCC reference voltage when measuring the target's supply voltage. Note that the supply
  *        voltage should never exceed the reference voltage on the programmer AVR without some form of protection to prevent damage
  *        to the ADC.


@@ -275,14 +275,14 @@
  *   </tr>
  *   <tr>
  *    <td>VTARGET_USE_INTERNAL_REF</td>
  *   </tr>
  *   <tr>
  *    <td>VTARGET_USE_INTERNAL_REF</td>

- *    <td>Makefile LUFA_OPTS</td>
+ *    <td>AppConfig.h</td>

  *    <td>Selects the internal 2.56V ADC reference voltage, instead of using the AVR's VREF pin. When enabled, this option will
  *        override the VTARGET_REF_VOLTS configuration option.
  *        \n \n <i>Ignored when compiled for targets lacking an ADC, or when NO_VTARGET_DETECT is defined.</i></td>
  *   </tr>
  *   <tr>
  *    <td>VTARGET_SCALE_FACTOR</td>
  *    <td>Selects the internal 2.56V ADC reference voltage, instead of using the AVR's VREF pin. When enabled, this option will
  *        override the VTARGET_REF_VOLTS configuration option.
  *        \n \n <i>Ignored when compiled for targets lacking an ADC, or when NO_VTARGET_DETECT is defined.</i></td>
  *   </tr>
  *   <tr>
  *    <td>VTARGET_SCALE_FACTOR</td>

- *    <td>Makefile LUFA_OPTS</td>
+ *    <td>AppConfig.h</td>

  *    <td>Indicates the target's supply voltage scale factor when applied to the ADC. A simple resistive divider can be used on the
  *        ADC pin for measuring the target's supply voltage, so that voltages above the programmer AVR's AVCC reference voltage can be
  *        measured. This should be the reciprocal of the division performed - e.g. if the VTARGET voltage is halved, this should be set
  *    <td>Indicates the target's supply voltage scale factor when applied to the ADC. A simple resistive divider can be used on the
  *        ADC pin for measuring the target's supply voltage, so that voltages above the programmer AVR's AVCC reference voltage can be
  *        measured. This should be the reciprocal of the division performed - e.g. if the VTARGET voltage is halved, this should be set


@@ -291,7 +291,7 @@
  *   </tr>
  *   <tr>
  *    <td>LIBUSB_DRIVER_COMPAT</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.
  *
  *    <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.
  *


@@ -299,28 +299,31 @@
  *   </tr>
  *   <tr>
  *    <td>RESET_TOGGLES_LIBUSB_COMPAT</td>
  *   </tr>
  *   <tr>
  *    <td>RESET_TOGGLES_LIBUSB_COMPAT</td>

- *    <td>Makefile LUFA_OPTS</td>
+ *    <td>AppConfig.h</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.
  *
  *    <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>
  *        \note This option is incompatible with \c LIBUSB_DRIVER_COMPAT.</td>
  *   </tr>
  *   <tr>
  *    <td>XCK_RESCUE_CLOCK_ENABLE</td>

- *    <td>Makefile LUFA_OPTS</td>
+ *    <td>AppConfig.h</td>

  *    <td>Define to move the ISP rescue clock to the AVR's XCK pin instead of the OCR1A output pin. This is useful for existing programming
  *        hardware that does not expose the OCR1A pin of the AVR, but <i>may</i> cause some issues with PDI programming mode.</td>
  *   </tr>
  *   <tr>
  *    <td>INVERTED_ISP_MISO</td>
  *    <td>Define to move the ISP rescue clock to the AVR's XCK pin instead of the OCR1A output pin. This is useful for existing programming
  *        hardware that does not expose the OCR1A pin of the AVR, but <i>may</i> cause some issues with PDI programming mode.</td>
  *   </tr>
  *   <tr>
  *    <td>INVERTED_ISP_MISO</td>

- *    <td>Makefile LUFA_OPTS</td>
+ *    <td>AppConfig.h</td>

  *    <td>Define to invert the received data on the ISP MISO line. This is sometimes needed depending on the level translation hardware used,
  *        if the translator hardware inverts the received logic level.</td>
  *   </tr>
  *   <tr>
  *    <td>FIRMWARE_VERSION_MINOR</td>
  *    <td>Define to invert the received data on the ISP MISO line. This is sometimes needed depending on the level translation hardware used,
  *        if the translator hardware inverts the received logic level.</td>
  *   </tr>
  *   <tr>
  *    <td>FIRMWARE_VERSION_MINOR</td>

- *    <td>Makefile LUFA_OPTS</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>
  *    <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>