AVRISP.txt 10.5 KB
Newer Older
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
 *
9
 *  \section SSec_Compat Project Compatibility:
10
 *
11
 *  The following list indicates what microcontrollers are compatible with this project.
12
 *
13
14
15
 *  - Series 7 USB AVRs
 *  - Series 6 USB AVRs
 *  - Series 4 USB AVRs
16
 *  - Series 2 USB AVRs (8KB versions with reduced features only)
17
18
19
 *
 *  \section SSec_Info USB Information:
 *
20
 *  The following table gives a rundown of the USB utilization of this project.
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
 *
 * <table>
 *  <tr>
 *   <td><b>USB Mode:</b></td>
 *   <td>Device</td>
 *  </tr>
 *  <tr>
 *   <td><b>USB Class:</b></td>
 *   <td>Vendor Specific Class</td>
 *  </tr>
 *  <tr> 
 *   <td><b>USB Subclass:</b></td>
 *   <td>N/A</td>
 *  </tr>
 *  <tr>
 *   <td><b>Relevant Standards:</b></td>
 *   <td>Atmel AVRISP MKII Protocol Specification</td>
 *  </tr>
 *  <tr>
 *   <td><b>Usable Speeds:</b></td>
 *   <td>Full Speed Mode</td>
 *  </tr>
 * </table>
 *
 *  \section SSec_Description Project Description: 
 *
 *  Firmware for an AVRStudio compatible AVRISP-MKII clone programmer. This project will enable the USB AVR series of
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.
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:
Dean Camera's avatar
Dean Camera committed
57
 *    - Minimum ISP target clock speed of 500KHz due to hardware SPI module prescaler limitations
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
61
 *  set to an appropriate ADC channel number in the project makefile for VTARGET detection to operate correctly. On models
Dean Camera's avatar
Dean Camera committed
62
 *  without an ADC converter, VTARGET will report a fixed 5V level at all times.
63
 *
64
 *  When compiled for the XPLAIN board target, this will automatically configure itself for the correct connections to the
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.
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's avatar
Dean Camera committed
70
 *  of FLASH is required. On 8KB devices, ISP or PDI/TPI programming support can be disabled to reduce program size.
71
 *
72
 *  \section Sec_ISP ISP Connections
73
 *  Connections to the device for SPI programming (when enabled):
74
75
76
77
78
 *
 *  <table>
 *   <tr>
 *    <td><b>Programmer Pin:</b></td>
 *    <td><b>Target Device Pin:</b></td>
79
 *    <td><b>ISP 6 Pin Layout:</b></td>
80
81
82
83
 *   </tr>
 *   <tr>
 *    <td>MISO</td>
 *    <td>PDO</td>
84
 *    <td>1</td>
85
86
 *   </tr>
 *   <tr>
87
88
89
 *    <td>ADCx <b><sup>1</sup></b></td>
 *    <td>VTARGET</td>
 *    <td>2</td>
90
91
 *   </tr>
 *   <tr>
92
93
94
 *    <td>SCLK</td>
 *    <td>SCLK</td>
 *    <td>3</td>
95
96
 *   </tr>
 *   <tr>
97
98
99
 *    <td>MOSI</td>
 *    <td>PDI</td>
 *    <td>4</td>
100
101
102
103
 *   </tr>
 *   <tr>
 *    <td>PORTx.y <b><sup>2</sup></b></td>
 *    <td>/RESET</td>
104
105
106
107
108
109
 *    <td>5</td>
 *   </tr>
 *   <tr>
 *    <td>GND</td>
 *    <td>GND</td>
 *    <td>6</td>
110
111
112
 *   </tr>
 *  </table>
 *
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
 *  <b><sup>1</sup></b> <i>Optional, see \ref SSec_Options section - for USB AVRs with ADC modules only</i> \n
118
 *  <b><sup>2</sup></b> <i>See AUX line related tokens in the \ref SSec_Options section</i>
119
 *
120
 *  \section Sec_PDI PDI Connections
121
 *  Connections to the device for PDI programming<b><sup>1</sup></b> (when enabled):
122
123
 *
 *  <table>
124
125
126
 *   <tr>
 *    <td><b>Programmer Pin:</b></td>
 *    <td><b>Target Device Pin:</b></td>
127
 *    <td><b>PDI 6 Pin Layout:</b></td>
128
129
 *   </tr>
 *   <tr>
130
 *    <td>MISO <b><sup>2</sup></b></td>
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 *    <td>DATA</td>
 *    <td>1</td>
 *   </tr>
 *   <tr>
 *    <td>ADCx <b><sup>1</sup></b></td>
 *    <td>VTARGET</td>
 *    <td>2</td>
 *   </tr>
 *   <tr>
 *    <td>N/A</td>
 *    <td>N/A</td>
 *    <td>3</td>
 *   </tr>
 *   <tr>
 *    <td>N/A</td>
 *    <td>N/A</td>
 *    <td>4</td>
 *   </tr>
 *   <tr>
150
 *    <td>PORTx.y <b><sup>2, 3</sup></b></td>
151
152
153
154
155
156
157
158
 *    <td>CLOCK</td>
 *    <td>5</td>
 *   </tr>
 *   <tr>
 *    <td>GND</td>
 *    <td>GND</td>
 *    <td>6</td>
 *   </tr>
159
 *  </table>
160
 *
161
162
 *  <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>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.</i> \n
164
 *  <b><sup>3</sup></b> <i>See AUX line related tokens in the \ref SSec_Options section</i>
165
 *
166
167
168
169
170
171
172
 *  \section Sec_TPI TPI Connections
 *  Connections to the device for TPI programming<b><sup>1</sup></b> (when enabled):
 *
 *  <table>
 *   <tr>
 *    <td><b>Programmer Pin:</b></td>
 *    <td><b>Target Device Pin:</b></td>
173
 *    <td><b>TPI 6 Pin Layout:</b></td>
174
175
 *   </tr>
 *   <tr>
176
 *    <td>MISO <b><sup>2</sup></b></td>
177
178
179
180
181
182
183
184
185
 *    <td>DATA</td>
 *    <td>1</td>
 *   </tr>
 *   <tr>
 *    <td>ADCx <b><sup>1</sup></b></td>
 *    <td>VTARGET</td>
 *    <td>2</td>
 *   </tr>
 *   <tr>
186
 *    <td>SCLK <b><sup>2</sup></b></td>
187
188
189
190
191
192
193
194
195
 *    <td>CLOCK</td>
 *    <td>3</td>
 *   </tr>
 *   <tr>
 *    <td>N/A</td>
 *    <td>N/A</td>
 *    <td>4</td>
 *   </tr>
 *   <tr>
196
 *    <td>PORTx.y <b><sup>3</sup></b></td>
197
198
199
200
201
202
203
204
205
206
 *    <td>/RESET</td>
 *    <td>5</td>
 *   </tr>
 *   <tr>
 *    <td>GND</td>
 *    <td>GND</td>
 *    <td>6</td>
 *   </tr>
 *  </table>
 *
207
208
 *  <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>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.</i> \n
210
 *  <b><sup>3</sup></b> <i>See AUX line related tokens in the \ref SSec_Options section</i>
211
 *
212
213
 *  \section SSec_Options Project Options
 *
214
 *  The following defines can be found in this project, which can control the project behaviour when defined, or changed in value.
215
216
217
 *
 *  <table>
 *   <tr>
218
219
220
221
222
 *    <td><b>Define Name:</b></td>
 *    <td><b>Location:</b></td>
 *    <td><b>Description:</b></td>
 *   </tr>
 *   <tr>
223
 *    <td>AUX_LINE_PORT</td>
224
 *    <td>Makefile CDEFS</td>
225
226
 *    <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>
227
228
 *   </tr>
 *   <tr>
229
 *    <td>AUX_LINE_PIN</td>
230
 *    <td>Makefile CDEFS</td>
231
232
 *    <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>
233
234
 *   </tr>
 *   <tr>
235
 *    <td>AUX_LINE_DDR</td>
236
 *    <td>Makefile CDEFS</td>
237
238
 *    <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>
239
240
 *   </tr>
 *   <tr>
241
 *    <td>AUX_LINE_MASK</td>
242
 *    <td>Makefile CDEFS</td>
243
244
245
 *    <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>
246
 *   </tr>
247
248
249
 *   <tr>
 *    <td>VTARGET_ADC_CHANNEL</td>
 *    <td>Makefile CDEFS</td>
250
 *    <td>ADC channel number (on supported AVRs) to use for VTARGET level detection, if NO_VTARGET_DETECT is not defined.</td> 
251
 *   </tr>
252
 *   <tr>
253
 *    <td>ENABLE_ISP_PROTOCOL</td>
254
 *    <td>Makefile CDEFS</td>
255
 *    <td>Define to enable SPI programming protocol support. <i>Ignored when compiled for the XPLAIN board.</i></td>  
256
257
 *   </tr>
 *   <tr>
258
 *    <td>ENABLE_XPROG_PROTOCOL</td>
259
 *    <td>Makefile CDEFS</td>
260
 *    <td>Define to enable PDI and TPI programming protocol support. <i>Ignored when compiled for the XPLAIN board.</i></td>  
261
 *   </tr>
262
 *   <tr>
263
 *    <td>XPROG_VIA_HARDWARE_USART</td>
264
 *    <td>Makefile CDEFS</td>
Dean Camera's avatar
Dean Camera committed
265
266
 *    <td>Define 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 
267
 *        seperate ISP, PDI, and TPI programming headers) but increases programming speed dramatically.
268
269
 *        <i>Ignored when compiled for the XPLAIN board.</i></td>  
 *   </tr>
270
271
272
273
274
275
 *   <tr>
 *    <td>NO_VTARGET_DETECT</td>
 *    <td>Makefile CDEFS</td>
 *    <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.</td>  
 *   </tr>
276
 *   <tr>
277
 *    <td>LIBUSB_FILTERDRV_COMPAT</td>
278
279
280
281
282
 *    <td>Makefile CDEFS</td>
 *    <td>Define 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.
 *   </tr>
283
284
 *  </table>
 */