AVRISP.txt 10.5 KB
 Dean Camera committed Aug 17, 2009 1 2 3 4 5 6 7 8 /** \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 *  Dean Camera committed Dec 15, 2009 9  * \section SSec_Compat Project Compatibility:  Dean Camera committed Aug 17, 2009 10  *  Dean Camera committed Dec 15, 2009 11  * The following list indicates what microcontrollers are compatible with this project.  Dean Camera committed Aug 17, 2009 12  *  Dean Camera committed Oct 12, 2009 13 14 15  * - Series 7 USB AVRs * - Series 6 USB AVRs * - Series 4 USB AVRs  Dean Camera committed Dec 14, 2009 16  * - Series 2 USB AVRs (8KB versions with reduced features only)  Dean Camera committed Aug 17, 2009 17 18 19  * * \section SSec_Info USB Information: *  Dean Camera committed Dec 15, 2009 20  * The following table gives a rundown of the USB utilization of this project.  Dean Camera committed Aug 17, 2009 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47  * * *
USB Mode:Device
USB Class:Vendor Specific Class
USB Subclass:N/A
Relevant Standards:Atmel AVRISP MKII Protocol Specification
Usable Speeds:Full Speed Mode
* * * * * * * * * * * * * * * * * * * * * * \section SSec_Description Project Description: * * Firmware for an AVRStudio compatible AVRISP-MKII clone programmer. This project will enable the USB AVR series of  Dean Camera committed Aug 24, 2009 48 49 50 51  * 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.  Dean Camera committed Aug 17, 2009 52 53  * * This device spoofs Atmel's official AVRISP-MKII device PID so that it remains compatible with Atmel's AVRISP-MKII  Dean Camera committed Dec 14, 2009 54  * drivers. When prompted, direct your OS to install Atmel's AVRISP-MKII drivers provided with AVRStudio.  Dean Camera committed Aug 17, 2009 55  *  Dean Camera committed Jan 06, 2010 56  * Note that this design currently has the following limitations:  Dean Camera committed Dec 29, 2009 57  * - Minimum ISP target clock speed of 500KHz due to hardware SPI module prescaler limitations  Dean Camera committed Aug 24, 2009 58 59  * - No reversed/shorted target connector detection and notification *  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  Dean Camera committed Aug 25, 2009 61  * set to an appropriate ADC channel number in the project makefile for VTARGET detection to operate correctly. On models  Dean Camera committed Dec 29, 2009 62  * without an ADC converter, VTARGET will report a fixed 5V level at all times.  Dean Camera committed Aug 25, 2009 63  *  Dean Camera committed Dec 03, 2009 64  * When compiled for the XPLAIN board target, this will automatically configure itself for the correct connections to the  Dean Camera committed Jan 06, 2010 65 66 67  * XPLAIN's XMEGA AVR, and will enable PDI/TPI only programming support (since ISP mode is not needed). Note that the * first revision XPLAIN board lacks a bootloader on the AT90USB1287, and thus for this firmware to be loaded, an external * programmer will be required.  Dean Camera committed Dec 14, 2009 68 69  * * While this application can be compiled for USB AVRs with as little as 8KB of FLASH, for full functionality 16KB or more  Dean Camera committed Dec 29, 2009 70  * of FLASH is required. On 8KB devices, ISP or PDI/TPI programming support can be disabled to reduce program size.  Dean Camera committed Dec 03, 2009 71  *  Dean Camera committed Dec 15, 2009 72  * \section Sec_ISP ISP Connections  Dean Camera committed Dec 03, 2009 73  * Connections to the device for SPI programming (when enabled):  74 75 76 77 78  * * *
Programmer Pin:Target Device Pin:ISP 6 Pin Layout:
MISOPDO1
SCLKSCLK3
MOSIPDI4
PORTx.y 2/RESET5
GNDGND6
* *  Dean Camera committed Oct 01, 2009 79  *  80 81 82 83  * * * *  Dean Camera committed Oct 01, 2009 84  *  85 86  * *  Dean Camera committed Oct 01, 2009 87 88 89  * * *  90 91  * *  Dean Camera committed Oct 01, 2009 92 93 94  * * *  95 96  * *  Dean Camera committed Oct 01, 2009 97 98 99  * * *  100 101 102 103  * * * *  Dean Camera committed Oct 01, 2009 104 105 106 107 108 109  * * * * * *  110 111 112  * * *  Dean Camera committed Feb 10, 2010 113 114 115 116  * 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. *  117  * 1 Optional, see \ref SSec_Options section - for USB AVRs with ADC modules only \n  Dean Camera committed Dec 29, 2009 118  * 2 See AUX line related tokens in the \ref SSec_Options section  119  *  Dean Camera committed Dec 15, 2009 120  * \section Sec_PDI PDI Connections  Dean Camera committed Dec 11, 2009 121  * Connections to the device for PDI programming1 (when enabled):  122 123  * *  Dean Camera committed Dec 02, 2009 124 125 126  *
Programmer Pin:Target Device Pin:PDI 6 Pin Layout:
MISO 2DATA1
N/AN/A3
N/AN/A4
PORTx.y 2, 3CLOCK5
GNDGND6
* *  127  *  Dean Camera committed Dec 02, 2009 128 129  * *  Dean Camera committed Jan 25, 2010 130  *  Dean Camera committed Dec 02, 2009 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149  * * * * * * * * * * * * * * * * * * *  Dean Camera committed Jan 25, 2010 150  *  Dean Camera committed Dec 02, 2009 151 152 153 154 155 156 157 158  * * * * * * * *  159  *  Dean Camera committed Dec 02, 2009 160  *  Dean Camera committed Jan 25, 2010 161 162  * 1 Optional, see \ref SSec_Options section - for USB AVRs with ADC modules only \n * 2 When XPROG_VIA_HARDWARE_USART is set, the AVR's Tx and Rx become the DATA line when connected together  163  * via a pair of 220 ohm resistors, and the AVR's XCK pin becomes CLOCK. \n  Dean Camera committed Jan 25, 2010 164  * 3 See AUX line related tokens in the \ref SSec_Options section  Dean Camera committed Dec 11, 2009 165  *  166 167 168 169 170 171 172  * \section Sec_TPI TPI Connections * Connections to the device for TPI programming1 (when enabled): * * *
Programmer Pin:Target Device Pin:TPI 6 Pin Layout:
MISO 2DATA1
SCLK 2CLOCK3
N/AN/A4
PORTx.y 3/RESET5
GNDGND6
* *  Dean Camera committed Dec 24, 2009 173  *  174 175  * *  Dean Camera committed Jan 25, 2010 176  *  177 178 179 180 181 182 183 184 185  * * * * * * * * *  Dean Camera committed Jan 25, 2010 186  *  187 188 189 190 191 192 193 194 195  * * * * * * * * *  Dean Camera committed Jan 25, 2010 196  *  197 198 199 200 201 202 203 204 205 206  * * * * * * * * * *  Dean Camera committed Jan 25, 2010 207 208  * 1 Optional, see \ref SSec_Options section - for USB AVRs with ADC modules only \n * 2 When XPROG_VIA_HARDWARE_USART is set, the AVR's Tx and Rx become the DATA line when connected together  209  * via a pair of 220 ohm resistors, and the AVR's XCK pin becomes CLOCK. \n  Dean Camera committed Jan 25, 2010 210  * 3 See AUX line related tokens in the \ref SSec_Options section  211  *  Dean Camera committed Aug 17, 2009 212 213  * \section SSec_Options Project Options *  Dean Camera committed Dec 15, 2009 214  * The following defines can be found in this project, which can control the project behaviour when defined, or changed in value.  Dean Camera committed Aug 17, 2009 215 216 217  * * *
Define Name:Location:Description:
AUX_LINE_PORTMakefile CDEFSPORT 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. Ignored when compiled for the XPLAIN board.
AUX_LINE_PINMakefile CDEFSPIN 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. Ignored when compiled for the XPLAIN board.
AUX_LINE_DDRMakefile CDEFSDDR 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. Ignored when compiled for the XPLAIN board.
AUX_LINE_MASKMakefile CDEFSMask 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. Must not be the AVR's /SS pin. Ignored when * compiled for the XPLAIN board.
VTARGET_ADC_CHANNELMakefile CDEFSADC channel number (on supported AVRs) to use for VTARGET level detection, if NO_VTARGET_DETECT is not defined.
ENABLE_ISP_PROTOCOLMakefile CDEFSDefine to enable SPI programming protocol support. Ignored when compiled for the XPLAIN board.
ENABLE_XPROG_PROTOCOLMakefile CDEFSDefine to enable PDI and TPI programming protocol support. Ignored when compiled for the XPLAIN board.
XPROG_VIA_HARDWARE_USARTMakefile CDEFSDefine to force the PDI and TPI protocols (when enabled) to use the much faster hardware USART instead of bit-banging * to match the official AVRISP pinout. This breaks pinout compatibility with the official AVRISP MKII (and requires  Dean Camera committed Dec 29, 2009 267  * seperate ISP, PDI, and TPI programming headers) but increases programming speed dramatically.  268 269  * Ignored when compiled for the XPLAIN board.
NO_VTARGET_DETECTMakefile CDEFSDefine 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.
LIBUSB_FILTERDRV_COMPATMakefile CDEFSDefine to switch to a non-standard endpoint scheme, breaking compatibility with AVRStudio under Windows but making * the code compatible with Windows builds of avrdude using the libUSB driver. Linux platforms are not affected by this * option. *
 218 219 220 221 222  * * * * *  Dean Camera committed Dec 29, 2009 223  *  224  *  Dean Camera committed Dec 29, 2009 225 226  *  227 228  * *  Dean Camera committed Dec 29, 2009 229  *  Dean Camera committed Dec 13, 2009 230  *  Dean Camera committed Dec 29, 2009 231 232  *  Dean Camera committed Dec 13, 2009 233 234  * *  Dean Camera committed Dec 29, 2009 235  *  236  *  Dean Camera committed Dec 29, 2009 237 238  *  239 240  * *  Dean Camera committed Dec 29, 2009 241  *  242  *  Dean Camera committed Dec 29, 2009 243 244 245  *  Dean Camera committed Aug 17, 2009 246  *  Dean Camera committed Aug 25, 2009 247 248 249  * * *  Dean Camera committed Feb 13, 2010 250  *  Dean Camera committed Aug 25, 2009 251  *  252  *  253  *  Dean Camera committed Dec 03, 2009 254  *  Dean Camera committed Dec 03, 2009 255  *  Dean Camera committed Dec 03, 2009 256 257  * *  Dean Camera committed Dec 24, 2009 258  *  259  *  Dean Camera committed Dec 24, 2009 260  *  261  *  Dean Camera committed Dec 11, 2009 262  *  Dean Camera committed Dec 24, 2009 263  *  264  *  Dean Camera committed Dec 29, 2009 265 266  * *  Dean Camera committed Feb 13, 2010 270 271 272 273 274 275  * * * * *  Dean Camera committed Mar 31, 2010 276  *  Dean Camera committed Apr 06, 2010 277  *  Dean Camera committed Mar 31, 2010 278 279 280 281 282  * *  Dean Camera committed Aug 17, 2009 283 284  * */