Projects/AVRISP-MKII/AVRISP.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 SSec_Compat Project Compatibility:
  10  *
  11  *  The following list indicates what microcontrollers are compatible with this project.
  12  *
  13  *  - Series 7 USB AVRs
  14  *  - Series 6 USB AVRs
  15  *  - Series 4 USB AVRs
  16  *  - Series 2 USB AVRs (8KB versions with reduced features only)
  17  *
  18  *  \section SSec_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>Usable Speeds:</b></td>
  41  *   <td>Full Speed Mode</td>
  42  *  </tr>
  43  * </table>
  44  *
  45  *  \section SSec_Description Project Description:
  46  *
  47  *  Firmware for an AVRStudio compatible AVRISP-MKII clone programmer. This project will enable the USB AVR series of
  48  *  microcontrollers to act as a clone of the official Atmel AVRISP-MKII programmer, usable within AVRStudio. In its
  49  *  most basic form, it allows for the programming of 5V AVRs from within AVRStudio with no special hardware other than
  50  *  the USB AVR and the parts needed for the USB interface. If the user desires, more advanced circuits incorporating
  51  *  level conversion can be made to allow for the programming of 3.3V AVR designs.
  52  *
  53  *  This device spoofs Atmel's official AVRISP-MKII device PID so that it remains compatible with Atmel's AVRISP-MKII
  54  *  drivers. When prompted, direct your OS to install Atmel's AVRISP-MKII drivers provided with AVRStudio.
  55  *
  56  *  Note that this design currently has the following limitations:
  57  *    - Minimum ISP target clock speed of 500KHz due to hardware SPI module prescaler limitations
  58  *    - No reversed/shorted target connector detection and notification
  59  *    - Very slow TPI and PDI programming when in software emulated USART mode
  60  *
  61  *  On AVR models with an ADC converter, AVCC should be tied to 5V (e.g. VBUS) and the VTARGET_ADC_CHANNEL token should be
  62  *  set to an appropriate ADC channel number in the project makefile for VTARGET detection to operate correctly. On models
  63  *  without an ADC converter, VTARGET will report a fixed 5V level at all times.
  64  *
  65  *  When compiled for the XPLAIN board target, this will automatically configure itself for the correct connections to the
  66  *  XPLAIN's XMEGA AVR, and will enable hardware PDI/TPI only programming support (since ISP mode is not needed). Note that
  67  *  the first revision XPLAIN board lacks a bootloader on the AT90USB1287, and thus for this firmware to be loaded, an external
  68  *  programmer will be required.
  69  *
  70  *  While this application can be compiled for USB AVRs with as little as 8KB of FLASH, for full functionality 16KB or more
  71  *  of FLASH is required. On 8KB devices, ISP or PDI/TPI programming support can be disabled to reduce program size.
  72  *
  73  *  \section Sec_ISP ISP Connections
  74  *  Connections to the device for SPI programming (when enabled):
  75  *
  76  *  <table>
  77  *   <tr>
  78  *    <td><b>Programmer Pin:</b></td>
  79  *    <td><b>Target Device Pin:</b></td>
  80  *    <td><b>ISP 6 Pin Layout:</b></td>
  81  *   </tr>
  82  *   <tr>
  83  *    <td>MISO</td>
  84  *    <td>PDO</td>
  85  *    <td>1</td>
  86  *   </tr>
  87  *   <tr>
  88  *    <td>ADCx <b><sup>1</sup></b></td>
  89  *    <td>VTARGET</td>
  90  *    <td>2</td>
  91  *   </tr>
  92  *   <tr>
  93  *    <td>SCLK</td>
  94  *    <td>SCLK</td>
  95  *    <td>3</td>
  96  *   </tr>
  97  *   <tr>
  98  *    <td>MOSI</td>
  99  *    <td>PDI</td>
 100  *    <td>4</td>
 101  *   </tr>
 102  *   <tr>
 103  *    <td>PORTx.y <b><sup>2</sup></b></td>
 104  *    <td>/RESET</td>
 105  *    <td>5</td>
 106  *   </tr>
 107  *   <tr>
 108  *    <td>GND</td>
 109  *    <td>GND</td>
 110  *    <td>6</td>
 111  *   </tr>
 112  *  </table>
 113  *
 114  *  In addition, the AVR's XCK pin will generate a .5MHz clock when SPI programming is used, to act as an external
 115  *  device clock if the fuses have been mis-set. To use the recovery clock, connect XCK to the target AVR's XTAL1
 116  *  pin, and set the ISP programming speed to 125KHz or below.
 117  *
 118  *  <b><sup>1</sup></b> <i>Optional, see \ref SSec_Options section - for USB AVRs with ADC modules only</i> \n
 119  *  <b><sup>2</sup></b> <i>See AUX line related tokens in the \ref SSec_Options section</i>
 120  *
 121  *  \section Sec_PDI PDI Connections
 122  *  Connections to the device for PDI programming<b><sup>1</sup></b> (when enabled):
 123  *
 124  *  <table>
 125  *   <tr>
 126  *    <td><b>Programmer Pin:</b></td>
 127  *    <td><b>Target Device Pin:</b></td>
 128  *    <td><b>PDI 6 Pin Layout:</b></td>
 129  *   </tr>
 130  *   <tr>
 131  *    <td>MISO <b><sup>2</sup></b></td>
 132  *    <td>DATA</td>
 133  *    <td>1</td>
 134  *   </tr>
 135  *   <tr>
 136  *    <td>ADCx <b><sup>1</sup></b></td>
 137  *    <td>VTARGET</td>
 138  *    <td>2</td>
 139  *   </tr>
 140  *   <tr>
 141  *    <td>N/A</td>
 142  *    <td>N/A</td>
 143  *    <td>3</td>
 144  *   </tr>
 145  *   <tr>
 146  *    <td>N/A</td>
 147  *    <td>N/A</td>
 148  *    <td>4</td>
 149  *   </tr>
 150  *   <tr>
 151  *    <td>PORTx.y <b><sup>2, 3</sup></b></td>
 152  *    <td>CLOCK</td>
 153  *    <td>5</td>
 154  *   </tr>
 155  *   <tr>
 156  *    <td>GND</td>
 157  *    <td>GND</td>
 158  *    <td>6</td>
 159  *   </tr>
 160  *  </table>
 161  *
 162  *  <b><sup>1</sup></b> <i>Optional, see \ref SSec_Options section - for USB AVRs with ADC modules only</i> \n
 163  *  <b><sup>2</sup></b> <i>When XPROG_VIA_HARDWARE_USART is set, the AVR's Tx and Rx become the DATA line when connected together
 164  *                         via a pair of 220 ohm resistors, and the AVR's XCK pin becomes CLOCK.</i> \n
 165  *  <b><sup>3</sup></b> <i>See AUX line related tokens in the \ref SSec_Options section</i>
 166  *
 167  *  \section Sec_TPI TPI Connections
 168  *  Connections to the device for TPI programming<b><sup>1</sup></b> (when enabled):
 169  *
 170  *  <table>
 171  *   <tr>
 172  *    <td><b>Programmer Pin:</b></td>
 173  *    <td><b>Target Device Pin:</b></td>
 174  *    <td><b>TPI 6 Pin Layout:</b></td>
 175  *   </tr>
 176  *   <tr>
 177  *    <td>MISO <b><sup>2</sup></b></td>
 178  *    <td>DATA</td>
 179  *    <td>1</td>
 180  *   </tr>
 181  *   <tr>
 182  *    <td>ADCx <b><sup>1</sup></b></td>
 183  *    <td>VTARGET</td>
 184  *    <td>2</td>
 185  *   </tr>
 186  *   <tr>
 187  *    <td>SCLK <b><sup>2</sup></b></td>
 188  *    <td>CLOCK</td>
 189  *    <td>3</td>
 190  *   </tr>
 191  *   <tr>
 192  *    <td>N/A</td>
 193  *    <td>N/A</td>
 194  *    <td>4</td>
 195  *   </tr>
 196  *   <tr>
 197  *    <td>PORTx.y <b><sup>3</sup></b></td>
 198  *    <td>/RESET</td>
 199  *    <td>5</td>
 200  *   </tr>
 201  *   <tr>
 202  *    <td>GND</td>
 203  *    <td>GND</td>
 204  *    <td>6</td>
 205  *   </tr>
 206  *  </table>
 207  *
 208  *  <b><sup>1</sup></b> <i>Optional, see \ref SSec_Options section - for USB AVRs with ADC modules only</i> \n
 209  *  <b><sup>2</sup></b> <i>When XPROG_VIA_HARDWARE_USART is set, the AVR's Tx and Rx become the DATA line when connected together
 210  *                         via a pair of 220 ohm resistors, and the AVR's XCK pin becomes CLOCK.</i> \n
 211  *  <b><sup>3</sup></b> <i>See AUX line related tokens in the \ref SSec_Options section</i>
 212  *
 213  *  \section SSec_Options Project Options
 214  *
 215  *  The following defines can be found in this project, which can control the project behaviour when defined, or changed in value.
 216  *
 217  *  <table>
 218  *   <tr>
 219  *    <td><b>Define Name:</b></td>
 220  *    <td><b>Location:</b></td>
 221  *    <td><b>Description:</b></td>
 222  *   </tr>
 223  *   <tr>
 224  *    <td>AUX_LINE_PORT</td>
 225  *    <td>Makefile CDEFS</td>
 226  *    <td>PORT register for the programmer's AUX target line. The use of this line varies between the programming protocols,
 227  *        but is generally used for the target's /RESET line. <i>Ignored when compiled for the XPLAIN board.</i></td>
 228  *   </tr>
 229  *   <tr>
 230  *    <td>AUX_LINE_PIN</td>
 231  *    <td>Makefile CDEFS</td>
 232  *    <td>PIN register for the programmer's AUX target line. The use of this line varies between the programming protocols,
 233  *        but is generally used for the target's /RESET line. <i>Ignored when compiled for the XPLAIN board.</i></td>
 234  *   </tr>
 235  *   <tr>
 236  *    <td>AUX_LINE_DDR</td>
 237  *    <td>Makefile CDEFS</td>
 238  *    <td>DDR register for the programmer's AUX target line. The use of this line varies between the programming protocols,
 239  *        but is generally used for the target's /RESET line. <i>Ignored when compiled for the XPLAIN board.</i></td>
 240  *   </tr>
 241  *   <tr>
 242  *    <td>AUX_LINE_MASK</td>
 243  *    <td>Makefile CDEFS</td>
 244  *    <td>Mask for the programmer's AUX target line. The use of this line varies between the programming protocols,
 245  *        but is generally used for the target's /RESET line. <b>Must not be the AVR's /SS pin</b>. <i>Ignored when
 246  *        compiled for the XPLAIN board.</i></td>
 247  *   </tr>
 248  *   <tr>
 249  *    <td>VTARGET_ADC_CHANNEL</td>
 250  *    <td>Makefile CDEFS</td>
 251  *    <td>ADC channel number (on supported AVRs) to use for VTARGET level detection, if NO_VTARGET_DETECT is not defined.</td>
 252  *   </tr>
 253  *   <tr>
 254  *    <td>ENABLE_ISP_PROTOCOL</td>
 255  *    <td>Makefile CDEFS</td>
 256  *    <td>Define to enable SPI programming protocol support. <i>Ignored when compiled for the XPLAIN board.</i></td>
 257  *   </tr>
 258  *   <tr>
 259  *    <td>ENABLE_XPROG_PROTOCOL</td>
 260  *    <td>Makefile CDEFS</td>
 261  *    <td>Define to enable PDI and TPI programming protocol support. <i>Ignored when compiled for the XPLAIN board.</i></td>
 262  *   </tr>
 263  *   <tr>
 264  *    <td>XPROG_VIA_HARDWARE_USART</td>
 265  *    <td>Makefile CDEFS</td>
 266  *    <td>Define to force the PDI and TPI protocols (when enabled) to use the much faster hardware USART instead of bit-banging
 267  *        to match the official AVRISP pinout. This breaks pinout compatibility with the official AVRISP MKII (and requires
 268  *        seperate ISP, PDI, and TPI programming headers) but increases programming speed dramatically.
 269  *        <i>Ignored when compiled for the XPLAIN board.</i></td>
 270  *   </tr>
 271  *   <tr>
 272  *    <td>NO_VTARGET_DETECT</td>
 273  *    <td>Makefile CDEFS</td>
 274  *    <td>Define to disable VTARGET sampling and reporting on AVR models with an ADC converter. This will cause the programmer
 275  *        to report a fixed 5V target voltage to the host regardless of the real target voltage.</td>
 276  *   </tr>
 277  *   <tr>
 278  *    <td>LIBUSB_FILTERDRV_COMPAT</td>
 279  *    <td>Makefile CDEFS</td>
 280  *    <td>Define to switch to a non-standard endpoint scheme, breaking compatibility with AVRStudio under Windows but making
 281  *        the code compatible with Windows builds of avrdude using the libUSB driver. Linux platforms are not affected by this
 282  *        option.
 283  *   </tr>
 284  *  </table>
 285  */