AVRISP.txt 5.68 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
/** \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
 *
 *  \section SSec_Compat Demo Compatibility:
 *
11
 *  The following list indicates what microcontrollers are compatible with this demo.
12
 *
13
14
15
16
 *  - Series 7 USB AVRs
 *  - Series 6 USB AVRs
 *  - Series 4 USB AVRs
 *  - Series 2 USB AVRs
17
18
19
20
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
 *
 *  \section SSec_Info USB Information:
 *
 *  The following table gives a rundown of the USB utilization of this demo.
 *
 * <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
54
55
 *
 *  This device spoofs Atmel's official AVRISP-MKII device PID so that it remains compatible with Atmel's AVRISP-MKII
 *  drivers. When promted, direct your OS to install Atmel's AVRISP-MKII drivers provided with AVRStudio.
 *
56
57
58
59
 *  Note that this design currently has several limitations:
 *    - Minimum target clock speed of 500KHz due to hardware SPI used
 *    - No reversed/shorted target connector detection and notification
 *
60
61
62
63
 *  On AVR models with an ADC converter, ACC should be tied to 5V (e.g. VBUS) and the VTARGET_ADC_CHANNEL token should be
 *  set to an appropriate ADC channel number in the project makefile for VTARGET detection to operate correctly. On models
 *  without an ADC converter, VTARGET will report at a fixed 5V level.
 *
64
 *  Connections to the device are simple for SPI programming:
65
66
67
68
69
 *
 *  <table>
 *   <tr>
 *    <td><b>Programmer Pin:</b></td>
 *    <td><b>Target Device Pin:</b></td>
70
 *    <td><b>ISP 6 Pin Layout:</b></td>
71
72
73
74
 *   </tr>
 *   <tr>
 *    <td>MISO</td>
 *    <td>PDO</td>
75
 *    <td>1</td>
76
77
 *   </tr>
 *   <tr>
78
79
80
 *    <td>ADCx <b><sup>1</sup></b></td>
 *    <td>VTARGET</td>
 *    <td>2</td>
81
82
 *   </tr>
 *   <tr>
83
84
85
 *    <td>SCLK</td>
 *    <td>SCLK</td>
 *    <td>3</td>
86
87
 *   </tr>
 *   <tr>
88
89
90
 *    <td>MOSI</td>
 *    <td>PDI</td>
 *    <td>4</td>
91
92
93
94
 *   </tr>
 *   <tr>
 *    <td>PORTx.y <b><sup>2</sup></b></td>
 *    <td>/RESET</td>
95
96
97
98
99
100
 *    <td>5</td>
 *   </tr>
 *   <tr>
 *    <td>GND</td>
 *    <td>GND</td>
 *    <td>6</td>
101
102
103
104
105
106
 *   </tr>
 *  </table>
 *
 *  <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>See \ref SSec_Options section</i>
 *
107
108
109
110
 *
 *  Connections to the device are simple for SPI programming:
 *
 *  <table>
111
112
113
114
115
116
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
145
 *   <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>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>
 *    <td>PORTx.y <b><sup>2</sup></b></td>
 *    <td>CLOCK</td>
 *    <td>5</td>
 *   </tr>
 *   <tr>
 *    <td>GND</td>
 *    <td>GND</td>
 *    <td>6</td>
 *   </tr>
146
 *  </table>
147
 *
148
149
150
151
152
153
 *  \section SSec_Options Project Options
 *
 *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
 *
 *  <table>
 *   <tr>
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 *    <td><b>Define Name:</b></td>
 *    <td><b>Location:</b></td>
 *    <td><b>Description:</b></td>
 *   </tr>
 *   <tr>
 *    <td>RESET_LINE_PORT</td>
 *    <td>Makefile CDEFS</td>
 *    <td>PORT register for the programmer's target RESET line.</td>
 *   </tr>
 *   <tr>
 *    <td>RESET_LINE_DDR</td>
 *    <td>Makefile CDEFS</td>
 *    <td>DDR register for the programmer's target RESET line.</td>
 *   </tr>
 *   <tr>
 *    <td>RESET_LINE_MASK</td>
 *    <td>Makefile CDEFS</td>
171
172
 *    <td>Mask for the programmer's target RESET line on the chosen port. <b>Must not be the AVR's /SS pin</b>, as the
 *        target pins are tri-stated when not in use, and low signals on the /SS pin will force SPI slave mode when the
173
 *        pin is configured as an input. When in PDI programming mode, this is the target clock pin.</td>
174
 *   </tr>
175
176
177
178
179
 *   <tr>
 *    <td>VTARGET_ADC_CHANNEL</td>
 *    <td>Makefile CDEFS</td>
 *    <td>ADC channel number (on supported AVRs) to use for VTARGET level detection.</td> 
 *   </tr>
180
 *   <tr>
181
182
183
184
185
 *    <td>ENABLE_SPI_PROTOCOL</td>
 *    <td>Makefile CDEFS</td>
 *    <td>Define to enable SPI programming protocol support.</td>  
 *   </tr>
 *   <tr>
186
187
188
189
 *    <td>ENABLE_XPROG_PROTOCOL</td>
 *    <td>Makefile CDEFS</td>
 *    <td>Define to enable XMEGA PDI programming protocol support.</td>  
 *   </tr>
190
191
 *  </table>
 */