Projects/AVRISP-MKII/AVRISP-MKII.txt

   1 /** \file
   2  *
   3  *  This file contains special DoxyGen information for the generation of the main page and other special
   4  *  documentation pages. It is not a project source file.
   5  */
   6
   7 /** \mainpage AVRISP MKII Programmer Project
   8  *
   9  *  \section Sec_Compat Project Compatibility
  10  *
  11  *  The following list indicates what microcontrollers are compatible with this project.
  12  *
  13  *  \li Series 7 USB AVRs (AT90USBxxx7)
  14  *  \li Series 6 USB AVRs (AT90USBxxx6)
  15  *  \li Series 4 USB AVRs (ATMEGAxxU4)
  16  *  \li Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2) - <i>8KB versions with reduced features only</i>
  17  *
  18  *  \section Sec_Info USB Information
  19  *
  20  *  The following table gives a rundown of the USB utilization of this project.
  21  *
  22  * <table>
  23  *  <tr>
  24  *   <td><b>USB Mode:</b></td>
  25  *   <td>Device</td>
  26  *  </tr>
  27  *  <tr>
  28  *   <td><b>USB Class:</b></td>
  29  *   <td>Vendor Specific Class</td>
  30  *  </tr>
  31  *  <tr>
  32  *   <td><b>USB Subclass:</b></td>
  33  *   <td>N/A</td>
  34  *  </tr>
  35  *  <tr>
  36  *   <td><b>Relevant Standards:</b></td>
  37  *   <td>Atmel AVRISP MKII Protocol Specification</td>
  38  *  </tr>
  39  *  <tr>
  40  *   <td><b>Supported USB Speeds:</b></td>
  41  *   <td>Full Speed Mode</td>
  42  *  </tr>
  43  * </table>
  44  *
  45  *  \section Sec_Description Project Description
  46  *
  47  *  Firmware for an Atmel Studio compatible AVRISP-MKII clone programmer. This project will enable the USB
  48  *  AVR series of microcontrollers to act as a clone of the official Atmel AVRISP-MKII programmer, usable within
  49  *  Atmel Studio or with any software capable of driving a real Atmel AVRISP-MKII programmer. In its most
  50  *  basic form, it allows for the programming of AVR TINY, MEGA and XMEGA devices at the programmer's VCC voltage from
  51  *  within Atmel Studio with no special hardware other than the USB AVR and the parts needed for the USB
  52  *  interface. If the user desires, more advanced circuits incorporating level conversion can be made to allow for the
  53  *  programming of target AVRs running at a different voltage to the programmer.
  54  *
  55  *  This device spoofs Atmel's official AVRISP-MKII device PID so that it remains compatible with Atmel's AVRISP-MKII
  56  *  drivers. It is currently tested working under the following configurations:
  57  *
  58  *    - <b>Windows:</b> Atmel Studio 7, with alternative driver
  59  *    - <b>Windows:</b> AVRDUDE 6.2, with alternative driver
  60  *    - <b>Linux:</b> AVRDUDE 6.1
  61  *
  62  *  <b>Note that this clone requires a libUSB based driver under Windows,</b> due to an incompatible change in the official
  63  *  Jungo based driver. The alternative driver given here will function with both real and clone AVRISP devices in Atmel
  64  *  Studio 7 onwards under Windows - and as a bonus, also provides AVRDude access to the programmer.
  65  *
  66  *  As of Atmel Studio version 7.0.1417 the legacy Jungo driver has been deprecated in favor of an official libUSB based
  67  *  driver, making the driver packaged here superfluous. Use the driver packaged here only if you are still using an earlier
  68  *  Atmel Studio 7 build, otherwise the official Atmel libUSB driver should be used.
  69  *
  70  *  Note that this design currently has the following limitations:
  71  *    - No reversed/shorted target connector detection and notification
  72  *    - A separate header is required for each of the ISP, PDI and TPI programming protocols that the user wishes to use
  73  *
  74  *  On AVR models with an ADC converter, the USB AVR's AVCC pin should be tied to 5V (e.g. VBUS) and the
  75  *  \c VTARGET_ADC_CHANNEL token should be set to an appropriate ADC channel number in the project makefile for VTARGET
  76  *  detection to operate correctly. On models without an ADC converter, VTARGET will report a fixed 3.3V level at all times
  77  *  which should allow the programmer to remain compatible at the protocol level with all AVR devices.
  78  *
  79  *  While this application can be compiled for USB AVRs with as little as 8KB of FLASH, for full functionality 16KB or more
  80  *  of FLASH is required. On 8KB devices, ISP or PDI/TPI protocol programming support can be disabled to reduce program size.
  81  *
  82  *  \section Sec_KnownIssues Known Issues:
  83  *
  84  *  \par XMEGA EEPROM programming fails in some cases.
  85  *  Several users have reported that XMEGA EEPROM programming fails unless the chip is erased first. If a non-blank EEPROM
  86  *  is present, writing further EEPROM data causes corruption.
  87  *  <a href="https://github.com/abcminiuser/lufa/issues/25">LUFA issue tracker entry</a>.
  88  *
  89  *  \section Sec_Installation Installation
  90  *  The programmer supports multiple platforms, both Windows and Linux.
  91  *
  92  *  \subsection SSec_LinuxInstallation Linux Installation
  93  *  On Linux systems, the programmer should be usable out of the box with no special setup other than (on some systems)
  94  *  editing of the system permissions to allow the programmer to be used from a non-elevated (root) context. The programmer
  95  *  is compatible with the free open source AVRDude programming software project.
  96  *
  97  *  \subsection SSec_WindowsInstallation Windows Installation
  98  *  On Windows systems, due to an unfortunate limitation of the USB AVR devices and the Atmel Studio platform, the programmer
  99  *  requires an alternative libUSB based driver. Uninstall the existing Jungo driver for the device (if installed) and replace
 100  *  it with the driver that ships with this project, to enable access to the programmer in Atmel Studio and AVRDUDE.
 101  *
 102  *  \section Sec_ISP ISP Connections
 103  *  Connections to the device for SPI programming (when enabled):
 104  *
 105  *  <table>
 106  *   <tr>
 107  *    <th><b>Programmer Pin:</b></th>
 108  *    <th><b>Target Device Pin:</b></th>
 109  *    <th><b>ISP 6 Pin Layout:</b></th>
 110  *   </tr>
 111  *   <tr>
 112  *    <td>MISO</td>
 113  *    <td>PDO</td>
 114  *    <td>1</td>
 115  *   </tr>
 116  *   <tr>
 117  *    <td>ADCx <b><sup>1</sup></b></td>
 118  *    <td>VTARGET</td>
 119  *    <td>2</td>
 120  *   </tr>
 121  *   <tr>
 122  *    <td>SCLK</td>
 123  *    <td>SCLK</td>
 124  *    <td>3</td>
 125  *   </tr>
 126  *   <tr>
 127  *    <td>MOSI</td>
 128  *    <td>PDI</td>
 129  *    <td>4</td>
 130  *   </tr>
 131  *   <tr>
 132  *    <td>PORTx.y <b><sup>2</sup></b></td>
 133  *    <td>/RESET</td>
 134  *    <td>5</td>
 135  *   </tr>
 136  *   <tr>
 137  *    <td>GND</td>
 138  *    <td>GND</td>
 139  *    <td>6</td>
 140  *   </tr>
 141  *  </table>
 142  *
 143  *  In addition, the AVR's OCR1A pin will generate a 4MHz clock, to act as an external rescue device clock if the
 144  *  fuses have been mis-set. To use the recovery clock, connect the OCR1A pin of the USB AVR to the target AVR's
 145  *  XTAL1 pin, and set the ISP programming speed to 125KHz (note: other ISP speeds will not work correctly).
 146  *
 147  *  <b><sup>1</sup></b> <i>Optional, see \ref Sec_Options section - for USB AVRs with ADC modules only</i> \n
 148  *  <b><sup>2</sup></b> <i>See AUX line related tokens in the \ref Sec_Options section</i>
 149  *
 150  *  \section Sec_PDI PDI Connections
 151  *  Connections to the device for PDI programming (when enabled):
 152  *
 153  *  <table>
 154  *   <tr>
 155  *    <th><b>Programmer Pin:</b></th>
 156  *    <th><b>Target Device Pin:</b></th>
 157  *    <th><b>PDI 6 Pin Layout:</b></th>
 158  *   </tr>
 159  *   <tr>
 160  *    <td>Tx/Rx <b><sup>2</sup></b></td>
 161  *    <td>DATA</td>
 162  *    <td>1</td>
 163  *   </tr>
 164  *   <tr>
 165  *    <td>ADCx <b><sup>1</sup></b></td>
 166  *    <td>VTARGET</td>
 167  *    <td>2</td>
 168  *   </tr>
 169  *   <tr>
 170  *    <td>N/A</td>
 171  *    <td>N/A</td>
 172  *    <td>3</td>
 173  *   </tr>
 174  *   <tr>
 175  *    <td>N/A</td>
 176  *    <td>N/A</td>
 177  *    <td>4</td>
 178  *   </tr>
 179  *   <tr>
 180  *    <td>XCK</td>
 181  *    <td>CLOCK</td>
 182  *    <td>5</td>
 183  *   </tr>
 184  *   <tr>
 185  *    <td>GND</td>
 186  *    <td>GND</td>
 187  *    <td>6</td>
 188  *   </tr>
 189  *  </table>
 190  *
 191  *  <b><sup>1</sup></b> <i>Optional, see \ref Sec_Options section - for USB AVRs with ADC modules only</i> \n
 192  *  <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
 193  *
 194  *  \section Sec_TPI TPI Connections
 195  *  Connections to the device for TPI programming (when enabled):
 196  *
 197  *  <table>
 198  *   <tr>
 199  *    <th><b>Programmer Pin:</b></th>
 200  *    <th><b>Target Device Pin:</b></th>
 201  *    <th><b>TPI 6 Pin Layout:</b></th>
 202  *   </tr>
 203  *   <tr>
 204  *    <td>Tx/Rx <b><sup>2</sup></b></td>
 205  *    <td>DATA</td>
 206  *    <td>1</td>
 207  *   </tr>
 208  *   <tr>
 209  *    <td>ADCx <b><sup>1</sup></b></td>
 210  *    <td>VTARGET</td>
 211  *    <td>2</td>
 212  *   </tr>
 213  *   <tr>
 214  *    <td>XCK <b><sup>2</sup></b></td>
 215  *    <td>CLOCK</td>
 216  *    <td>3</td>
 217  *   </tr>
 218  *   <tr>
 219  *    <td>N/A</td>
 220  *    <td>N/A</td>
 221  *    <td>4</td>
 222  *   </tr>
 223  *   <tr>
 224  *    <td>PORTx.y <b><sup>3</sup></b></td>
 225  *    <td>/RESET</td>
 226  *    <td>5</td>
 227  *   </tr>
 228  *   <tr>
 229  *    <td>GND</td>
 230  *    <td>GND</td>
 231  *    <td>6</td>
 232  *   </tr>
 233  *  </table>
 234  *
 235  *  <b><sup>1</sup></b> <i>Optional, see \ref Sec_Options section - for USB AVRs with ADC modules only</i> \n
 236  *  <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
 237  *  <b><sup>3</sup></b> <i>See AUX line related tokens in the \ref Sec_Options section</i>
 238  *
 239  *  \section Sec_Options Project Options
 240  *
 241  *  The following defines can be found in this project, which can control the project behaviour when defined, or changed in value.
 242  *
 243  *  <table>
 244  *   <tr>
 245  *    <th><b>Define Name:</b></th>
 246  *    <th><b>Location:</b></th>
 247  *    <th><b>Description:</b></th>
 248  *   </tr>
 249  *   <tr>
 250  *    <td>AUX_LINE_PORT</td>
 251  *    <td>AppConfig.h</td>
 252  *    <td>PORT register for the programmer's AUX target line. The use of this line varies between the programming protocols,
 253  *        but is generally used for the target's /RESET line.
 254  *        \n \n <i>Ignored when compiled for the XPLAIN board.</i></td>
 255  *   </tr>
 256  *   <tr>
 257  *    <td>AUX_LINE_PIN</td>
 258  *    <td>AppConfig.h</td>
 259  *    <td>PIN register for the programmer's AUX target line. The use of this line varies between the programming protocols,
 260  *        but is generally used for the target's /RESET line.
 261  *        \n \n <i>Ignored when compiled for the XPLAIN board.</i></td>
 262  *   </tr>
 263  *   <tr>
 264  *    <td>AUX_LINE_DDR</td>
 265  *    <td>AppConfig.h</td>
 266  *    <td>DDR register for the programmer's AUX target line. The use of this line varies between the programming protocols,
 267  *        but is generally used for the target's /RESET line.
 268  *        \n \n <i>Ignored when compiled for the XPLAIN board.</i></td>
 269  *   </tr>
 270  *   <tr>
 271  *    <td>AUX_LINE_MASK</td>
 272  *    <td>AppConfig.h</td>
 273  *    <td>Mask for the programmer's AUX target line. The use of this line varies between the programming protocols,
 274  *        but is generally used for the target's /RESET line. <b>Must not be the AVR's /SS pin</b>.
 275  *        \n \n <i>Ignored when compiled for the XPLAIN board.</i></td>
 276  *   </tr>
 277  *   <tr>
 278  *    <td>VTARGET_ADC_CHANNEL</td>
 279  *    <td>AppConfig.h</td>
 280  *    <td>ADC channel number (on supported AVRs) to use for VTARGET level detection, if NO_VTARGET_DETECT is not defined.
 281  *        \n \n <i>Ignored when compiled for targets lacking an ADC.</i></td>
 282  *   </tr>
 283  *   <tr>
 284  *    <td>ENABLE_ISP_PROTOCOL</td>
 285  *    <td>AppConfig.h</td>
 286  *    <td>Define to enable SPI programming protocol support.
 287  *        \n \n <i>Ignored when compiled for the XPLAIN board.</i></td>
 288  *   </tr>
 289  *   <tr>
 290  *    <td>ENABLE_XPROG_PROTOCOL</td>
 291  *    <td>AppConfig.h</td>
 292  *    <td>Define to enable PDI and TPI programming protocol support.
 293  *        \n \n <i>Ignored when compiled for the XPLAIN board.</i></td>
 294  *   </tr>
 295  *   <tr>
 296  *    <td>NO_VTARGET_DETECT</td>
 297  *    <td>AppConfig.h</td>
 298  *    <td>Define to disable VTARGET sampling and reporting on AVR models with an ADC converter. This will cause the programmer
 299  *        to report a fixed 3.3V target voltage to the host regardless of the real target voltage.
 300  *        \n \n <i>Ignored when compiled for targets lacking an ADC.</i></td>
 301  *   </tr>
 302  *   <tr>
 303  *    <td>VTARGET_REF_VOLTS</td>
 304  *    <td>AppConfig.h</td>
 305  *    <td>Indicates the programmer AVR's AVCC reference voltage when measuring the target's supply voltage. Note that the supply
 306  *        voltage should never exceed the reference voltage on the programmer AVR without some form of protection to prevent damage
 307  *        to the ADC.
 308  *        \n \n <i>Ignored when compiled for targets lacking an ADC, or when NO_VTARGET_DETECT is defined.</i></td>
 309  *   </tr>
 310  *   <tr>
 311  *    <td>VTARGET_USE_INTERNAL_REF</td>
 312  *    <td>AppConfig.h</td>
 313  *    <td>Selects the internal 2.56V ADC reference voltage, instead of using the AVR's VREF pin. When enabled, this option will
 314  *        override the VTARGET_REF_VOLTS configuration option.
 315  *        \n \n <i>Ignored when compiled for targets lacking an ADC, or when NO_VTARGET_DETECT is defined.</i></td>
 316  *   </tr>
 317  *   <tr>
 318  *    <td>VTARGET_SCALE_FACTOR</td>
 319  *    <td>AppConfig.h</td>
 320  *    <td>Indicates the target's supply voltage scale factor when applied to the ADC. A simple resistive divider can be used on the
 321  *        ADC pin for measuring the target's supply voltage, so that voltages above the programmer AVR's AVCC reference voltage can be
 322  *        measured. This should be the reciprocal of the division performed - e.g. if the VTARGET voltage is halved, this should be set
 323  *        to 2.
 324  *        \n \n <i>Ignored when compiled for targets lacking an ADC, or when NO_VTARGET_DETECT is defined.</i></td>
 325  *   </tr>
 326  *   <tr>
 327  *    <td>XCK_RESCUE_CLOCK_ENABLE</td>
 328  *    <td>AppConfig.h</td>
 329  *    <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
 330  *        hardware that does not expose the OCR1A pin of the AVR, but <i>may</i> cause some issues with PDI programming mode.</td>
 331  *   </tr>
 332  *   <tr>
 333  *    <td>INVERTED_ISP_MISO</td>
 334  *    <td>AppConfig.h</td>
 335  *    <td>Define to invert the received data on the ISP MISO line. This is sometimes needed depending on the level translation hardware used,
 336  *        if the translator hardware inverts the received logic level.</td>
 337  *   </tr>
 338  *   <tr>
 339  *    <td>FIRMWARE_VERSION_MINOR</td>
 340  *    <td>AppConfig.h</td>
 341  *    <td>Define to set the minor firmware revision nunber reported to the host on request. By default this will use a firmware version compatible
 342  *        with the latest Atmel IDE version, however if desired the reported minor value can be adjusted here.</td>
 343  *   </tr>
 344  *  </table>
 345  */
 346