AVRISP-MKII.txt 11.8 KB
Newer Older
1
2
3
4
5
/** \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.
 */
6

7
8
/** \mainpage AVRISP MKII Programmer Project
 *
9
 *  \section Sec_Compat Project Compatibility:
10
11
12
 *
 *  The following list indicates what microcontrollers are compatible with this project.
 *
13
14
15
 *  - Series 7 USB AVRs (AT90USBxxx7)
 *  - Series 6 USB AVRs (AT90USBxxx6)
 *  - 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
21
22
23
24
25
26
27
28
29
30
 *
 *  The following table gives a rundown of the USB utilization of this project.
 *
 * <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>
31
 *  <tr>
32
33
34
35
36
37
38
39
40
41
42
43
44
 *   <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>
 *
45
 *  \section Sec_Description Project Description:
46
47
48
 *
 *  Firmware for an AVRStudio compatible AVRISP-MKII clone programmer. This project will enable the USB AVR series of
 *  microcontrollers to act as a clone of the official Atmel AVRISP-MKII programmer, usable within AVRStudio. In its
49
50
51
 *  most basic form, it allows for the programming of AVRs at the programmer's VCC voltage 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
54
55
56
57
 *
 *  This device spoofs Atmel's official AVRISP-MKII device PID so that it remains compatible with Atmel's AVRISP-MKII
 *  drivers. When prompted, direct your OS to install Atmel's AVRISP-MKII drivers provided with AVRStudio.
 *
 *  Note that this design currently has the following limitations:
 *    - 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
 *
Dean Camera's avatar
Dean Camera committed
60
 *  On AVR models with an ADC converter, AVCC should be tied to 5V (e.g. VBUS) and the \c 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 3.3V level at all times.
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 *
 *  While this application can be compiled for USB AVRs with as little as 8KB of FLASH, for full functionality 16KB or more
 *  of FLASH is required. On 8KB devices, ISP or PDI/TPI programming support can be disabled to reduce program size.
 *
 *  \section Sec_ISP ISP Connections
 *  Connections to the device for SPI programming (when enabled):
 *
 *  <table>
 *   <tr>
 *    <td><b>Programmer Pin:</b></td>
 *    <td><b>Target Device Pin:</b></td>
 *    <td><b>ISP 6 Pin Layout:</b></td>
 *   </tr>
 *   <tr>
 *    <td>MISO</td>
 *    <td>PDO</td>
 *    <td>1</td>
 *   </tr>
 *   <tr>
 *    <td>ADCx <b><sup>1</sup></b></td>
 *    <td>VTARGET</td>
 *    <td>2</td>
 *   </tr>
 *   <tr>
 *    <td>SCLK</td>
 *    <td>SCLK</td>
 *    <td>3</td>
 *   </tr>
 *   <tr>
 *    <td>MOSI</td>
 *    <td>PDI</td>
 *    <td>4</td>
 *   </tr>
 *   <tr>
 *    <td>PORTx.y <b><sup>2</sup></b></td>
 *    <td>/RESET</td>
 *    <td>5</td>
 *   </tr>
 *   <tr>
 *    <td>GND</td>
 *    <td>GND</td>
 *    <td>6</td>
 *   </tr>
 *  </table>
 *
108
109
110
 *  In addition, the AVR's OCR1A pin will generate a 4MHz clock, to act as an external rescue device clock if the
 *  fuses have been mis-set. To use the recovery clock, connect the OCR1A pin of the USB AVR to the target AVR's
 *  XTAL1 pin, and set the ISP programming speed to 125KHz (note: other ISP speeds will not work correctly).
111
 *
112
113
 *  <b><sup>1</sup></b> <i>Optional, see \ref Sec_Options section - for USB AVRs with ADC modules only</i> \n
 *  <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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 *
 *  <table>
 *   <tr>
 *    <td><b>Programmer Pin:</b></td>
 *    <td><b>Target Device Pin:</b></td>
 *    <td><b>PDI 6 Pin Layout:</b></td>
 *   </tr>
 *   <tr>
 *    <td>Tx/Rx <b><sup>2</sup></b></td>
 *    <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>
145
 *    <td>XCK</td>
146
147
148
149
150
151
152
153
154
155
 *    <td>CLOCK</td>
 *    <td>5</td>
 *   </tr>
 *   <tr>
 *    <td>GND</td>
 *    <td>GND</td>
 *    <td>6</td>
 *   </tr>
 *  </table>
 *
156
 *  <b><sup>1</sup></b> <i>Optional, see \ref Sec_Options section - for USB AVRs with ADC modules only</i> \n
157
158
159
 *  <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
 *
 *  \section Sec_TPI TPI Connections
160
 *  Connections to the device for TPI programming (when enabled):
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 *
 *  <table>
 *   <tr>
 *    <td><b>Programmer Pin:</b></td>
 *    <td><b>Target Device Pin:</b></td>
 *    <td><b>TPI 6 Pin Layout:</b></td>
 *   </tr>
 *   <tr>
 *    <td>Tx/Rx <b><sup>2</sup></b></td>
 *    <td>DATA</td>
 *    <td>1</td>
 *   </tr>
 *   <tr>
 *    <td>ADCx <b><sup>1</sup></b></td>
 *    <td>VTARGET</td>
 *    <td>2</td>
 *   </tr>
 *   <tr>
179
 *    <td>XCK <b><sup>2</sup></b></td>
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 *    <td>CLOCK</td>
 *    <td>3</td>
 *   </tr>
 *   <tr>
 *    <td>N/A</td>
 *    <td>N/A</td>
 *    <td>4</td>
 *   </tr>
 *   <tr>
 *    <td>PORTx.y <b><sup>3</sup></b></td>
 *    <td>/RESET</td>
 *    <td>5</td>
 *   </tr>
 *   <tr>
 *    <td>GND</td>
 *    <td>GND</td>
 *    <td>6</td>
 *   </tr>
 *  </table>
 *
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
209
210
211
212
213
214
215
 *
 *  <table>
 *   <tr>
 *    <td><b>Define Name:</b></td>
 *    <td><b>Location:</b></td>
 *    <td><b>Description:</b></td>
 *   </tr>
 *   <tr>
 *    <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,
Dean Camera's avatar
Dean Camera committed
218
219
 *        but is generally used for the target's /RESET line.
 *        \n \n <i>Ignored when compiled for the XPLAIN board.</i></td>
220
221
222
 *   </tr>
 *   <tr>
 *    <td>AUX_LINE_PIN</td>
223
 *    <td>Makefile LUFA_OPTS</td>
224
 *    <td>PIN register for the programmer's AUX target line. The use of this line varies between the programming protocols,
Dean Camera's avatar
Dean Camera committed
225
226
 *        but is generally used for the target's /RESET line.
 *        \n \n <i>Ignored when compiled for the XPLAIN board.</i></td>
227
228
229
 *   </tr>
 *   <tr>
 *    <td>AUX_LINE_DDR</td>
230
 *    <td>Makefile LUFA_OPTS</td>
231
 *    <td>DDR register for the programmer's AUX target line. The use of this line varies between the programming protocols,
Dean Camera's avatar
Dean Camera committed
232
233
 *        but is generally used for the target's /RESET line.
 *        \n \n <i>Ignored when compiled for the XPLAIN board.</i></td>
234
235
236
 *   </tr>
 *   <tr>
 *    <td>AUX_LINE_MASK</td>
237
 *    <td>Makefile LUFA_OPTS</td>
238
 *    <td>Mask for the programmer's AUX target line. The use of this line varies between the programming protocols,
Dean Camera's avatar
Dean Camera committed
239
240
 *        but is generally used for the target's /RESET line. <b>Must not be the AVR's /SS pin</b>.
 *        \n \n <i>Ignored when compiled for the XPLAIN board.</i></td>
241
242
243
 *   </tr>
 *   <tr>
 *    <td>VTARGET_ADC_CHANNEL</td>
244
 *    <td>Makefile LUFA_OPTS</td>
245
 *    <td>ADC channel number (on supported AVRs) to use for VTARGET level detection, if NO_VTARGET_DETECT is not defined.
Dean Camera's avatar
Dean Camera committed
246
 *        \n \n <i>Ignored when compiled for targets lacking an ADC.</i></td>
247
248
249
 *   </tr>
 *   <tr>
 *    <td>ENABLE_ISP_PROTOCOL</td>
250
 *    <td>Makefile LUFA_OPTS</td>
Dean Camera's avatar
Dean Camera committed
251
252
 *    <td>Define to enable SPI programming protocol support.
 *        \n \n <i>Ignored when compiled for the XPLAIN board.</i></td>
253
254
255
 *   </tr>
 *   <tr>
 *    <td>ENABLE_XPROG_PROTOCOL</td>
256
 *    <td>Makefile LUFA_OPTS</td>
Dean Camera's avatar
Dean Camera committed
257
258
 *    <td>Define to enable PDI and TPI programming protocol support.
 *        \n \n <i>Ignored when compiled for the XPLAIN board.</i></td>
259
260
261
 *   </tr>
 *   <tr>
 *    <td>NO_VTARGET_DETECT</td>
262
 *    <td>Makefile LUFA_OPTS</td>
263
 *    <td>Define to disable VTARGET sampling and reporting on AVR models with an ADC converter. This will cause the programmer
Dean Camera's avatar
Dean Camera committed
264
265
 *        to report a fixed 3.3V target voltage to the host regardless of the real target voltage. 
 *        \n \n <i>Ignored when compiled for targets lacking an ADC.</i></td>
266
267
 *   </tr>
 *   <tr>
268
 *    <td>VTARGET_REF_VOLTS</td>
269
 *    <td>Makefile LUFA_OPTS</td>
270
271
 *    <td>Indicates the programmer AVR's AVCC reference voltage when measuring the target's supply voltage. Note that the supply
 *        voltage should never exceed the reference voltage on the programmer AVR without some form of protection to prevent damage
Dean Camera's avatar
Dean Camera committed
272
273
 *        to the ADC.
 *        \n \n <i>Ignored when compiled for targets lacking an ADC, or when NO_VTARGET_DETECT is defined.</i></td>
274
275
 *   </tr>
 *   <tr>
276
277
278
 *    <td>VTARGET_USE_INTERNAL_REF</td>
 *    <td>Makefile LUFA_OPTS</td>
 *    <td>Selects the internal 2.56V ADC reference voltage, instead of using the AVR's VREF pin. When enabled, this option will
Dean Camera's avatar
Dean Camera committed
279
280
 *        override the VTARGET_REF_VOLTS configuration option.
 *        \n \n <i>Ignored when compiled for targets lacking an ADC, or when NO_VTARGET_DETECT is defined.</i></td>
281
282
 *   </tr>
 *   <tr>
283
 *    <td>VTARGET_SCALE_FACTOR</td>
284
 *    <td>Makefile LUFA_OPTS</td>
285
286
287
 *    <td>Indicates the target's supply voltage scale factor when applied to the ADC. A simple resistive divider can be used on the
 *        ADC pin for measuring the target's supply voltage, so that voltages above the programmer AVR's AVCC reference voltage can be
 *        measured. This should be the reciprocal of the division performed - e.g. if the VTARGET voltage is halved, this should be set
Dean Camera's avatar
Dean Camera committed
288
289
 *        to 2.
 *        \n \n <i>Ignored when compiled for targets lacking an ADC, or when NO_VTARGET_DETECT is defined.</i></td>
290
 *   </tr>
291
 *   <tr>
292
 *    <td>LIBUSB_DRIVER_COMPAT</td>
293
 *    <td>Makefile LUFA_OPTS</td>
294
 *    <td>Define to switch to a non-standard endpoint scheme, breaking compatibility with AVRStudio under Windows but making
295
 *        the code compatible with software such as avrdude (all platforms) that use the libUSB driver.</td>
296
 *   </tr>
297
298
299
300
 *   <tr>
 *    <td>XCK_RESCUE_CLOCK_ENABLE</td>
 *    <td>Makefile LUFA_OPTS</td>
 *    <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
Dean Camera's avatar
Dean Camera committed
301
 *        hardware that does not expose the OCR1A pin of the AVR, but <i>may</i> cause some issues with PDI programming mode.</td>
302
 *   </tr>
303
304
305
306
 *   <tr>
 *    <td>INVERTED_ISP_MISO</td>
 *    <td>Makefile LUFA_OPTS</td>
 *    <td>Define to invert the received data on the ISP MISO line. This is sometimes needed depending on the level translation hardware used,
307
308
309
310
 *        if the translator hardware inverts the received logic level.</td>
 *   </tr>
 *   <tr>
 *    <td>FIRMWARE_VERSION_MINOR</td>
Dean Camera's avatar
Dean Camera committed
311
 *    <td>Makefile LUFA_OPTS</td>
312
313
 *    <td>Define to set the minor firmware revision nunber reported to the host on request. By default this will use a firmware version compatible
 *        with the latest Atmel IDE version, however if desired the reported minor value can be adjusted here.</td>
314
 *   </tr>
315
316
 *  </table>
 */
317