Added additional bootloader API data to expose the bootloader start address and class...

[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 ab355bf..ad58dab 100644 (file)
--- a/Projects/AVRISP-MKII/AVRISP-MKII.txt
+++ b/Projects/AVRISP-MKII/AVRISP-MKII.txt
@@ -44,22 +44,23 @@
  *
  *  \section Sec_Description Project Description:
  *
  *
  *  \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 5V AVRs 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 advanced circuits incorporating
- *  level conversion can be made to allow for the programming of 3.3V AVR designs.
+ *  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
  *
  *  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
  *    - A separate header is required for each of the ISP, PDI and TPI programming protocols that the user wishes to use
  *
  *
  *  Note that this design currently has the following limitations:
  *    - No reversed/shorted target connector detection and notification
  *    - A separate header is required for each of the ISP, PDI and TPI programming protocols that the user wishes to use
  *

- *  On AVR models with an ADC converter, AVCC should be tied to 5V (e.g. VBUS) and the VTARGET_ADC_CHANNEL token should be
+ *  On AVR models with an ADC converter, AVCC should be tied to 5V (e.g. VBUS) and the \c VTARGET_ADC_CHANNEL token should be

  *  set to an appropriate ADC channel number in the project makefile for VTARGET detection to operate correctly. On models
  *  set to an appropriate ADC channel number in the project makefile for VTARGET detection to operate correctly. On models

- *  without an ADC converter, VTARGET will report a fixed 5V level at all times.
+ *  without an ADC converter, VTARGET will report a fixed 3.3V level at all times.

  *
  *  While this application can be compiled for USB AVRs with as little as 8KB of FLASH, for full functionality 16KB or more
  *  of FLASH is required. On 8KB devices, ISP or PDI/TPI programming support can be disabled to reduce program size.
  *
  *  While this application can be compiled for USB AVRs with as little as 8KB of FLASH, for full functionality 16KB or more
  *  of FLASH is required. On 8KB devices, ISP or PDI/TPI programming support can be disabled to reduce program size.


@@ -215,62 +216,69 @@
  *    <td>AUX_LINE_PORT</td>
  *    <td>Makefile LUFA_OPTS</td>
  *    <td>PORT register for the programmer's AUX target line. The use of this line varies between the programming protocols,
  *    <td>AUX_LINE_PORT</td>
  *    <td>Makefile LUFA_OPTS</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. <i>Ignored when compiled for the XPLAIN board.</i></td>
+ *        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>PIN register for the programmer's AUX target line. The use of this line varies between the programming protocols,
  *   </tr>
  *   <tr>
  *    <td>AUX_LINE_PIN</td>
  *    <td>Makefile LUFA_OPTS</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. <i>Ignored when compiled for the XPLAIN board.</i></td>
+ *        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>DDR register for the programmer's AUX target line. The use of this line varies between the programming protocols,
  *   </tr>
  *   <tr>
  *    <td>AUX_LINE_DDR</td>
  *    <td>Makefile LUFA_OPTS</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. <i>Ignored when compiled for the XPLAIN board.</i></td>
+ *        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>Mask for the programmer's AUX target line. The use of this line varies between the programming protocols,
  *   </tr>
  *   <tr>
  *    <td>AUX_LINE_MASK</td>
  *    <td>Makefile LUFA_OPTS</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>. <i>Ignored when
- *        compiled for the XPLAIN board.</i></td>
+ *        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>ADC channel number (on supported AVRs) to use for VTARGET level detection, if NO_VTARGET_DETECT is not defined.
  *   </tr>
  *   <tr>
  *    <td>VTARGET_ADC_CHANNEL</td>
  *    <td>Makefile LUFA_OPTS</td>
  *    <td>ADC channel number (on supported AVRs) to use for VTARGET level detection, if NO_VTARGET_DETECT is not defined.

- *        <i>Ignored when compiled for targets lacking an ADC.</i></td>
+ *        \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>
  *   </tr>
  *   <tr>
  *    <td>ENABLE_ISP_PROTOCOL</td>
  *    <td>Makefile LUFA_OPTS</td>

- *    <td>Define to enable SPI programming protocol support. <i>Ignored when compiled for the XPLAIN board.</i></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>
  *   </tr>
  *   <tr>
  *    <td>ENABLE_XPROG_PROTOCOL</td>
  *    <td>Makefile LUFA_OPTS</td>

- *    <td>Define to enable PDI and TPI programming protocol support. <i>Ignored when compiled for the XPLAIN board.</i></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>Define to disable VTARGET sampling and reporting on AVR models with an ADC converter. This will cause the programmer
  *   </tr>
  *   <tr>
  *    <td>NO_VTARGET_DETECT</td>
  *    <td>Makefile LUFA_OPTS</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 5V target voltage to the host regardless of the real target voltage. <i>Ignored when compiled for
- *        targets lacking an ADC.</i></td>
+ *        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>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
  *   </tr>
  *   <tr>
  *    <td>VTARGET_REF_VOLTS</td>
  *    <td>Makefile LUFA_OPTS</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. <i>Ignored when compiled for targets lacking an ADC, or when NO_VTARGET_DETECT is defined.</i></td>
+ *        to the ADC.
+ *        \n \n <i>Ignored when compiled for targets lacking an ADC, or when NO_VTARGET_DETECT is defined.</i></td>

  *   </tr>
  *   <tr>
  *    <td>VTARGET_USE_INTERNAL_REF</td>
  *    <td>Makefile LUFA_OPTS</td>
  *    <td>Selects the internal 2.56V ADC reference voltage, instead of using the AVR's VREF pin. When enabled, this option will
  *   </tr>
  *   <tr>
  *    <td>VTARGET_USE_INTERNAL_REF</td>
  *    <td>Makefile LUFA_OPTS</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.</i></td>
+ *        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>
  *   </tr>
  *   <tr>
  *    <td>VTARGET_SCALE_FACTOR</td>


@@ -278,19 +286,32 @@
  *    <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

- *        to 2. <i>Ignored when compiled for targets lacking an ADC, or when NO_VTARGET_DETECT is defined.</i></td>
+ *        to 2.
+ *        \n \n <i>Ignored when compiled for targets lacking an ADC, or when NO_VTARGET_DETECT is defined.</i></td>

  *   </tr>
  *   <tr>
  *    <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
  *   </tr>
  *   <tr>
  *    <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.
+ *        the code compatible with software such as avrdude (all platforms) that use the libUSB driver.</td>

  *   </tr>
  *   <tr>
  *    <td>XCK_RESCUE_CLOCK_ENABLE</td>
  *    <td>Makefile LUFA_OPTS</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
  *   </tr>
  *   <tr>
  *    <td>XCK_RESCUE_CLOCK_ENABLE</td>
  *    <td>Makefile LUFA_OPTS</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 *may* cause some issues with PDI programming mode.
+ *        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>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>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>
  */
  *   </tr>
  *  </table>
  */