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  *  - Series 7 USB AVRs (AT90USBxxx7)
  14  *  - Series 6 USB AVRs (AT90USBxxx6)
  15  *  - Series 4 USB AVRs (ATMEGAxxU4)
  16  *  - 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>Usable 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 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  *    - No reversed/shorted target connector detection and notification
  58  *    - A separate header is required for each of the ISP, PDI and TPI programming protocols that the user wishes to use
  59  *
  60  *  On AVR models with an ADC converter, AVCC should be tied to 5V (e.g. VBUS) and the VTARGET_ADC_CHANNEL token should be
  61  *  set to an appropriate ADC channel number in the project makefile for VTARGET detection to operate correctly. On models
  62  *  without an ADC converter, VTARGET will report a fixed 5V level at all times.
  63  *
  64  *  While this application can be compiled for USB AVRs with as little as 8KB of FLASH, for full functionality 16KB or more
  65  *  of FLASH is required. On 8KB devices, ISP or PDI/TPI programming support can be disabled to reduce program size.
  66  *
  67  *  \section Sec_ISP ISP Connections
  68  *  Connections to the device for SPI programming (when enabled):
  69  *
  70  *  <table>
  71  *   <tr>
  72  *    <td><b>Programmer Pin:</b></td>
  73  *    <td><b>Target Device Pin:</b></td>
  74  *    <td><b>ISP 6 Pin Layout:</b></td>
  75  *   </tr>
  76  *   <tr>
  77  *    <td>MISO</td>
  78  *    <td>PDO</td>
  79  *    <td>1</td>
  80  *   </tr>
  81  *   <tr>
  82  *    <td>ADCx <b><sup>1</sup></b></td>
  83  *    <td>VTARGET</td>
  84  *    <td>2</td>
  85  *   </tr>
  86  *   <tr>
  87  *    <td>SCLK</td>
  88  *    <td>SCLK</td>
  89  *    <td>3</td>
  90  *   </tr>
  91  *   <tr>
  92  *    <td>MOSI</td>
  93  *    <td>PDI</td>
  94  *    <td>4</td>
  95  *   </tr>
  96  *   <tr>
  97  *    <td>PORTx.y <b><sup>2</sup></b></td>
  98  *    <td>/RESET</td>
  99  *    <td>5</td>
 100  *   </tr>
 101  *   <tr>
 102  *    <td>GND</td>
 103  *    <td>GND</td>
 104  *    <td>6</td>
 105  *   </tr>
 106  *  </table>
 107  *
 108  *  In addition, the AVR's OCR1A pin will generate a 4MHz clock, to act as an external rescue device clock if the
 109  *  fuses have been mis-set. To use the recovery clock, connect the OCR1A pin of the USB AVR to the target AVR's
 110  *  XTAL1 pin, and set the ISP programming speed to 125KHz (note: other ISP speeds will not work correctly).
 111  *
 112  *  <b><sup>1</sup></b> <i>Optional, see \ref Sec_Options section - for USB AVRs with ADC modules only</i> \n
 113  *  <b><sup>2</sup></b> <i>See AUX line related tokens in the \ref Sec_Options section</i>
 114  *
 115  *  \section Sec_PDI PDI Connections
 116  *  Connections to the device for PDI programming (when enabled):
 117  *
 118  *  <table>
 119  *   <tr>
 120  *    <td><b>Programmer Pin:</b></td>
 121  *    <td><b>Target Device Pin:</b></td>
 122  *    <td><b>PDI 6 Pin Layout:</b></td>
 123  *   </tr>
 124  *   <tr>
 125  *    <td>Tx/Rx <b><sup>2</sup></b></td>
 126  *    <td>DATA</td>
 127  *    <td>1</td>
 128  *   </tr>
 129  *   <tr>
 130  *    <td>ADCx <b><sup>1</sup></b></td>
 131  *    <td>VTARGET</td>
 132  *    <td>2</td>
 133  *   </tr>
 134  *   <tr>
 135  *    <td>N/A</td>
 136  *    <td>N/A</td>
 137  *    <td>3</td>
 138  *   </tr>
 139  *   <tr>
 140  *    <td>N/A</td>
 141  *    <td>N/A</td>
 142  *    <td>4</td>
 143  *   </tr>
 144  *   <tr>
 145  *    <td>XCK</td>
 146  *    <td>CLOCK</td>
 147  *    <td>5</td>
 148  *   </tr>
 149  *   <tr>
 150  *    <td>GND</td>
 151  *    <td>GND</td>
 152  *    <td>6</td>
 153  *   </tr>
 154  *  </table>
 155  *
 156  *  <b><sup>1</sup></b> <i>Optional, see \ref Sec_Options section - for USB AVRs with ADC modules only</i> \n
 157  *  <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
 158  *
 159  *  \section Sec_TPI TPI Connections
 160  *  Connections to the device for TPI programming (when enabled):
 161  *
 162  *  <table>
 163  *   <tr>
 164  *    <td><b>Programmer Pin:</b></td>
 165  *    <td><b>Target Device Pin:</b></td>
 166  *    <td><b>TPI 6 Pin Layout:</b></td>
 167  *   </tr>
 168  *   <tr>
 169  *    <td>Tx/Rx <b><sup>2</sup></b></td>
 170  *    <td>DATA</td>
 171  *    <td>1</td>
 172  *   </tr>
 173  *   <tr>
 174  *    <td>ADCx <b><sup>1</sup></b></td>
 175  *    <td>VTARGET</td>
 176  *    <td>2</td>
 177  *   </tr>
 178  *   <tr>
 179  *    <td>XCK <b><sup>2</sup></b></td>
 180  *    <td>CLOCK</td>
 181  *    <td>3</td>
 182  *   </tr>
 183  *   <tr>
 184  *    <td>N/A</td>
 185  *    <td>N/A</td>
 186  *    <td>4</td>
 187  *   </tr>
 188  *   <tr>
 189  *    <td>PORTx.y <b><sup>3</sup></b></td>
 190  *    <td>/RESET</td>
 191  *    <td>5</td>
 192  *   </tr>
 193  *   <tr>
 194  *    <td>GND</td>
 195  *    <td>GND</td>
 196  *    <td>6</td>
 197  *   </tr>
 198  *  </table>
 199  *
 200  *  <b><sup>1</sup></b> <i>Optional, see \ref Sec_Options section - for USB AVRs with ADC modules only</i> \n
 201  *  <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
 202  *  <b><sup>3</sup></b> <i>See AUX line related tokens in the \ref Sec_Options section</i>
 203  *
 204  *  \section Sec_Options Project Options
 205  *
 206  *  The following defines can be found in this project, which can control the project behaviour when defined, or changed in value.
 207  *
 208  *  <table>
 209  *   <tr>
 210  *    <td><b>Define Name:</b></td>
 211  *    <td><b>Location:</b></td>
 212  *    <td><b>Description:</b></td>
 213  *   </tr>
 214  *   <tr>
 215  *    <td>AUX_LINE_PORT</td>
 216  *    <td>Makefile LUFA_OPTS</td>
 217  *    <td>PORT register for the programmer's AUX target line. The use of this line varies between the programming protocols,
 218  *        but is generally used for the target's /RESET line. <i>Ignored when compiled for the XPLAIN board.</i></td>
 219  *   </tr>
 220  *   <tr>
 221  *    <td>AUX_LINE_PIN</td>
 222  *    <td>Makefile LUFA_OPTS</td>
 223  *    <td>PIN register for the programmer's AUX target line. The use of this line varies between the programming protocols,
 224  *        but is generally used for the target's /RESET line. <i>Ignored when compiled for the XPLAIN board.</i></td>
 225  *   </tr>
 226  *   <tr>
 227  *    <td>AUX_LINE_DDR</td>
 228  *    <td>Makefile LUFA_OPTS</td>
 229  *    <td>DDR register for the programmer's AUX target line. The use of this line varies between the programming protocols,
 230  *        but is generally used for the target's /RESET line. <i>Ignored when compiled for the XPLAIN board.</i></td>
 231  *   </tr>
 232  *   <tr>
 233  *    <td>AUX_LINE_MASK</td>
 234  *    <td>Makefile LUFA_OPTS</td>
 235  *    <td>Mask for the programmer's AUX target line. The use of this line varies between the programming protocols,
 236  *        but is generally used for the target's /RESET line. <b>Must not be the AVR's /SS pin</b>. <i>Ignored when
 237  *        compiled for the XPLAIN board.</i></td>
 238  *   </tr>
 239  *   <tr>
 240  *    <td>VTARGET_ADC_CHANNEL</td>
 241  *    <td>Makefile LUFA_OPTS</td>
 242  *    <td>ADC channel number (on supported AVRs) to use for VTARGET level detection, if NO_VTARGET_DETECT is not defined.
 243  *        <i>Ignored when compiled for targets lacking an ADC.</i></td>
 244  *   </tr>
 245  *   <tr>
 246  *    <td>ENABLE_ISP_PROTOCOL</td>
 247  *    <td>Makefile LUFA_OPTS</td>
 248  *    <td>Define to enable SPI programming protocol support. <i>Ignored when compiled for the XPLAIN board.</i></td>
 249  *   </tr>
 250  *   <tr>
 251  *    <td>ENABLE_XPROG_PROTOCOL</td>
 252  *    <td>Makefile LUFA_OPTS</td>
 253  *    <td>Define to enable PDI and TPI programming protocol support. <i>Ignored when compiled for the XPLAIN board.</i></td>
 254  *   </tr>
 255  *   <tr>
 256  *    <td>NO_VTARGET_DETECT</td>
 257  *    <td>Makefile LUFA_OPTS</td>
 258  *    <td>Define to disable VTARGET sampling and reporting on AVR models with an ADC converter. This will cause the programmer
 259  *        to report a fixed 5V target voltage to the host regardless of the real target voltage. <i>Ignored when compiled for
 260  *        targets lacking an ADC.</i></td>
 261  *   </tr>
 262  *   <tr>
 263  *    <td>VTARGET_REF_VOLTS</td>
 264  *    <td>Makefile LUFA_OPTS</td>
 265  *    <td>Indicates the programmer AVR's AVCC reference voltage when measuring the target's supply voltage. Note that the supply
 266  *        voltage should never exceed the reference voltage on the programmer AVR without some form of protection to prevent damage
 267  *        to the ADC. <i>Ignored when compiled for targets lacking an ADC, or when NO_VTARGET_DETECT is defined.</i></td>
 268  *   </tr>
 269  *   <tr>
 270  *    <td>VTARGET_SCALE_FACTOR</td>
 271  *    <td>Makefile LUFA_OPTS</td>
 272  *    <td>Indicates the target's supply voltage scale factor when applied to the ADC. A simple resistive divider can be used on the
 273  *        ADC pin for measuring the target's supply voltage, so that voltages above the programmer AVR's AVCC reference voltage can be
 274  *        measured. This should be the reciprocal of the division performed - e.g. if the VTARGET voltage is halved, this should be set
 275  *        to 2. <i>Ignored when compiled for targets lacking an ADC, or when NO_VTARGET_DETECT is defined.</i></td>
 276  *   </tr>
 277  *   <tr>
 278  *    <td>LIBUSB_DRIVER_COMPAT</td>
 279  *    <td>Makefile LUFA_OPTS</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 software such as avrdude (all platforms) that use the libUSB driver.
 282  *   </tr>
 283  *   <tr>
 284  *    <td>XCK_RESCUE_CLOCK_ENABLE</td>
 285  *    <td>Makefile LUFA_OPTS</td>
 286  *    <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
 287  *        hardware that does not expose the OCR1A pin of the AVR, but *may* cause some issues with PDI programming mode.
 288  *   </tr>
 289  *  </table>
 290  */
 291