CI: Build on Arch (bleeding-ege) and Ubuntu (stable) AVR-GCC toolchains.

[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 eb2c244..740a56c 100644 (file)
--- a/Projects/AVRISP-MKII/AVRISP-MKII.txt
+++ b/Projects/AVRISP-MKII/AVRISP-MKII.txt
@@ -3,19 +3,19 @@
  *  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.
  */
  *  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 AVRISP MKII Programmer Project
  *
 /** \mainpage AVRISP MKII Programmer Project
  *

- *  \section SSec_Compat Project Compatibility:
+ *  \section Sec_Compat Project Compatibility

  *
  *  The following list indicates what microcontrollers are compatible with this project.
  *
  *
  *  The following list indicates what microcontrollers are compatible with this project.
  *

- *  - Series 7 USB AVRs
- *  - Series 6 USB AVRs
- *  - Series 4 USB AVRs
- *  - Series 2 USB AVRs (8KB versions with reduced features only)
+ *  \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 SSec_Info USB Information:
+ *  \section Sec_Info USB Information

  *
  *  The following table gives a rundown of the USB utilization of this project.
  *
  *
  *  The following table gives a rundown of the USB utilization of this project.
  *


@@ -28,7 +28,7 @@
  *   <td><b>USB Class:</b></td>
  *   <td>Vendor Specific Class</td>
  *  </tr>
  *   <td><b>USB Class:</b></td>
  *   <td>Vendor Specific Class</td>
  *  </tr>

- *  <tr> 
+ *  <tr>

  *   <td><b>USB Subclass:</b></td>
  *   <td>N/A</td>
  *  </tr>
  *   <td><b>USB Subclass:</b></td>
  *   <td>N/A</td>
  *  </tr>


@@ -37,41 +37,69 @@
  *   <td>Atmel AVRISP MKII Protocol Specification</td>
  *  </tr>
  *  <tr>
  *   <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>
  *
  *   <td>Full Speed Mode</td>
  *  </tr>
  * </table>
  *

- *  \section SSec_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 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 or with any software capable of driving a real Atmel AVRISP-MKII programmer. In its most
+ *  basic form, it allows for the programming of AVR TINY, MEGA and XMEGA devices at the programmer's VCC voltage from
+ *  within Atmel Studio 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 target AVRs running at a different voltage to the programmer.

  *
  *  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. It is currently tested working under the following configurations:
+ *
+ *    - <b>Windows:</b> Atmel Studio 7, with alternative driver
+ *    - <b>Windows:</b> AVRDUDE 6.2, with alternative driver
+ *    - <b>Linux:</b> AVRDUDE 6.1
+ *
+ *  <b>Note that this clone requires a libUSB based driver under Windows,</b> due to an incompatible change in the official
+ *  Jungo based driver. The alternative driver given here will function with both real and clone AVRISP devices in Atmel
+ *  Studio 7 onwards under Windows - and as a bonus, also provides AVRDude access to the programmer.
+ *
+ *  As of Atmel Studio version 7.0.1417 the legacy Jungo driver has been deprecated in favor of an official libUSB based
+ *  driver, making the driver packaged here superfluous. Use the driver packaged here only if you are still using an earlier
+ *  Atmel Studio 7 build, otherwise the official Atmel libUSB driver should be used.

  *
  *  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
- *  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.
+ *  On AVR models with an ADC converter, the USB AVR's AVCC pin 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 without an ADC converter, VTARGET will report a fixed 3.3V level at all times
+ *  which should allow the programmer to remain compatible at the protocol level with all AVR devices.

  *
  *  While this application can be compiled for USB AVRs with as little as 8KB of FLASH, for full functionality 16KB or more
  *
  *  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.
+ *  of FLASH is required. On 8KB devices, ISP or PDI/TPI protocol programming support can be disabled to reduce program size.
+ *
+ *  \section Sec_Installation Installation
+ *  The programmer supports multiple platforms, both Windows and Linux.
+ *
+ *  \subsection SSec_LinuxInstallation Linux Installation
+ *  On Linux systems, the programmer should be usable out of the box with no special setup other than (on some systems)
+ *  editing of the system permissions to allow the programmer to be used from a non-elevated (root) context. The programmer
+ *  is compatible with the free open source AVRDude programming software project.
+ *
+ *  \subsection SSec_WindowsInstallation Windows Installation
+ *  On Windows systems, due to an unfortunate limitation of the USB AVR devices and the Atmel Studio platform, the programmer
+ *  requires an alternative libUSB based driver. Uninstall the existing Jungo driver for the device (if installed) and replace
+ *  it with the driver that ships with this project, to enable access to the programmer in Atmel Studio and AVRDUDE.

  *
  *  \section Sec_ISP ISP Connections
  *  Connections to the device for SPI programming (when enabled):
  *
  *  <table>
  *   <tr>
  *
  *  \section Sec_ISP ISP Connections
  *  Connections to the device for SPI programming (when enabled):
  *
  *  <table>
  *   <tr>

- *    <td><b>Programmer Pin:</b></td>
- *    <td><b>Target Device Pin:</b></td>
- *    <td><b>ISP 6 Pin Layout:</b></td>
+ *    <th><b>Programmer Pin:</b></th>
+ *    <th><b>Target Device Pin:</b></th>
+ *    <th><b>ISP 6 Pin Layout:</b></th>

  *   </tr>
  *   <tr>
  *    <td>MISO</td>
  *   </tr>
  *   <tr>
  *    <td>MISO</td>


@@ -105,21 +133,21 @@
  *   </tr>
  *  </table>
  *
  *   </tr>
  *  </table>
  *

- *  In addition, the AVR's XCK pin will generate a .5MHz clock when SPI programming is used, to act as an external
- *  device clock if the fuses have been mis-set. To use the recovery clock, connect XCK to the target AVR's XTAL1
- *  pin, and set the ISP programming speed to 125KHz or below.
+ *  In addition, the AVR's OCR1A pin will generate a 4MHz clock, to act as an external rescue device clock if the
+ *  fuses have been mis-set. To use the recovery clock, connect the OCR1A pin of the USB AVR to the target AVR's
+ *  XTAL1 pin, and set the ISP programming speed to 125KHz (note: other ISP speeds will not work correctly).

  *
  *

- *  <b><sup>1</sup></b> <i>Optional, see \ref SSec_Options section - for USB AVRs with ADC modules only</i> \n
- *  <b><sup>2</sup></b> <i>See AUX line related tokens in the \ref SSec_Options section</i>
+ *  <b><sup>1</sup></b> <i>Optional, see \ref Sec_Options section - for USB AVRs with ADC modules only</i> \n
+ *  <b><sup>2</sup></b> <i>See AUX line related tokens in the \ref Sec_Options section</i>

  *
  *  \section Sec_PDI PDI Connections
  *  Connections to the device for PDI programming (when enabled):
  *
  *  <table>
  *   <tr>
  *
  *  \section Sec_PDI PDI Connections
  *  Connections to the device for PDI programming (when enabled):
  *
  *  <table>
  *   <tr>

- *    <td><b>Programmer Pin:</b></td>
- *    <td><b>Target Device Pin:</b></td>
- *    <td><b>PDI 6 Pin Layout:</b></td>
+ *    <th><b>Programmer Pin:</b></th>
+ *    <th><b>Target Device Pin:</b></th>
+ *    <th><b>PDI 6 Pin Layout:</b></th>

  *   </tr>
  *   <tr>
  *    <td>Tx/Rx <b><sup>2</sup></b></td>
  *   </tr>
  *   <tr>
  *    <td>Tx/Rx <b><sup>2</sup></b></td>


@@ -153,7 +181,7 @@
  *   </tr>
  *  </table>
  *
  *   </tr>
  *  </table>
  *

- *  <b><sup>1</sup></b> <i>Optional, see \ref SSec_Options section - for USB AVRs with ADC modules only</i> \n
+ *  <b><sup>1</sup></b> <i>Optional, see \ref Sec_Options section - for USB AVRs with ADC modules only</i> \n

  *  <b><sup>2</sup></b> <i>The AVR's Tx and Rx become the DATA line when connected together via a pair of 220 ohm resistors</i> \n
  *
  *  \section Sec_TPI TPI Connections
  *  <b><sup>2</sup></b> <i>The AVR's Tx and Rx become the DATA line when connected together via a pair of 220 ohm resistors</i> \n
  *
  *  \section Sec_TPI TPI Connections


@@ -161,9 +189,9 @@
  *
  *  <table>
  *   <tr>
  *
  *  <table>
  *   <tr>

- *    <td><b>Programmer Pin:</b></td>
- *    <td><b>Target Device Pin:</b></td>
- *    <td><b>TPI 6 Pin Layout:</b></td>
+ *    <th><b>Programmer Pin:</b></th>
+ *    <th><b>Target Device Pin:</b></th>
+ *    <th><b>TPI 6 Pin Layout:</b></th>

  *   </tr>
  *   <tr>
  *    <td>Tx/Rx <b><sup>2</sup></b></td>
  *   </tr>
  *   <tr>
  *    <td>Tx/Rx <b><sup>2</sup></b></td>


@@ -197,88 +225,115 @@
  *   </tr>
  *  </table>
  *
  *   </tr>
  *  </table>
  *

- *  <b><sup>1</sup></b> <i>Optional, see \ref SSec_Options section - for USB AVRs with ADC modules only</i> \n
+ *  <b><sup>1</sup></b> <i>Optional, see \ref Sec_Options section - for USB AVRs with ADC modules only</i> \n

  *  <b><sup>2</sup></b> <i>The AVR's Tx and Rx become the DATA line when connected together via a pair of 220 ohm resistors</i> \n
  *  <b><sup>2</sup></b> <i>The AVR's Tx and Rx become the DATA line when connected together via a pair of 220 ohm resistors</i> \n

- *  <b><sup>3</sup></b> <i>See AUX line related tokens in the \ref SSec_Options section</i>
+ *  <b><sup>3</sup></b> <i>See AUX line related tokens in the \ref Sec_Options section</i>

  *
  *

- *  \section SSec_Options Project Options
+ *  \section Sec_Options Project Options

  *
  *

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

  *
  *  <table>
  *   <tr>
  *
  *  <table>
  *   <tr>

- *    <td><b>Define Name:</b></td>
- *    <td><b>Location:</b></td>
- *    <td><b>Description:</b></td>
+ *    <th><b>Define Name:</b></th>
+ *    <th><b>Location:</b></th>
+ *    <th><b>Description:</b></th>

  *   </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,
  *    <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>
  *   </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,
  *    <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>
  *   </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,
  *    <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>
  *   </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,
  *    <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>
  *   </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.
  *    <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>
  *   </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>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>
  *   </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>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>
  *   </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
  *    <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>
  *   </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
  *    <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>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>
  *   </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

- *        to 2. <i>Ignored when compiled for targets lacking an ADC, or when NO_VTARGET_DETECT is defined.</i></td>  
- *   </tr> 
+ *        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>XCK_RESCUE_CLOCK_ENABLE</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>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>
  *   <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.
+ *    <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>
  */
  *   </tr>
  *  </table>
  */

+