Add additional preprocessor sanity checks for the XMEGA platform based on the USB...
[pub/USBasp.git] / LUFA / DoxygenPages / DeviceSupport.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 /**
8 * \page Page_DeviceSupport Device and Hardware Support
9 *
10 * <b>Atmel Microcontrollers:</b>
11 * \li \subpage Page_AVR8Support - Atmel AVR8 Support
12 * \li \subpage Page_UC3Support - Atmel AVR32 UC3 Support
13 * \li \subpage Page_XMEGASupport - Atmel XMEGA Support
14 */
15
16 /**
17 * \page Page_AVR8Support Atmel 8-Bit AVR (AVR8) Support
18 *
19 * \section Sec_AVR8Support_Devices Supported Microcontroller Models
20 *
21 * Currently supported AVR8 models:
22 *
23 * <table>
24 * <tr>
25 * <th width="150px">Part</th>
26 * <th width="150px">USB Device Mode</th>
27 * <th width="150px">USB Host Mode</th>
28 * </tr>
29 * <tr>
30 * <td>AT90USB82</td>
31 * <td bgcolor="#00EE00">Yes</td>
32 * <td bgcolor="#EE0000">No</td>
33 * </tr>
34 * <tr>
35 * <td>ATMEGA8U2</td>
36 * <td bgcolor="#00EE00">Yes</td>
37 * <td bgcolor="#EE0000">No</td>
38 * </tr>
39 * <tr>
40 * <td>AT90USB162</td>
41 * <td bgcolor="#00EE00">Yes</td>
42 * <td bgcolor="#EE0000">No</td>
43 * </tr>
44 * <tr>
45 * <td>ATMEGA16U2</td>
46 * <td bgcolor="#00EE00">Yes</td>
47 * <td bgcolor="#EE0000">No</td>
48 * </tr>
49 * <tr>
50 * <td>ATMEGA16U4</td>
51 * <td bgcolor="#00EE00">Yes</td>
52 * <td bgcolor="#EE0000">No</td>
53 * </tr>
54 * <tr>
55 * <td>ATMEGA32U2</td>
56 * <td bgcolor="#00EE00">Yes</td>
57 * <td bgcolor="#EE0000">No</td>
58 * </tr>
59 * <tr>
60 * <td>ATMEGA32U4</td>
61 * <td bgcolor="#00EE00">Yes</td>
62 * <td bgcolor="#EE0000">No</td>
63 * </tr>
64 * <tr>
65 * <td>ATMEGA32U6</td>
66 * <td bgcolor="#00EE00">Yes</td>
67 * <td bgcolor="#EE0000">No</td>
68 * </tr>
69 * <tr>
70 * <td>AT90USB646</td>
71 * <td bgcolor="#00EE00">Yes</td>
72 * <td bgcolor="#EE0000">No</td>
73 * </tr>
74 * <tr>
75 * <td>AT90USB647</td>
76 * <td bgcolor="#00EE00">Yes</td>
77 * <td bgcolor="#00EE00">Yes</td>
78 * </tr>
79 * <tr>
80 * <td>AT90USB1286</td>
81 * <td bgcolor="#00EE00">Yes</td>
82 * <td bgcolor="#EE0000">No</td>
83 * </tr>
84 * <tr>
85 * <td>AT90USB1287</td>
86 * <td bgcolor="#00EE00">Yes</td>
87 * <td bgcolor="#00EE00">Yes</td>
88 * </tr>
89 * </table>
90 *
91 * \section Sec_AVR8Support_Boards Supported Atmel Boards
92 * Currently supported Atmel AVR8 boards (see \ref Group_BoardTypes):
93 * - AT90USBKEY
94 * - ATAVRUSBRF01
95 * - EVK527
96 * - RZUSBSTICK
97 * - STK525
98 * - STK526
99 * - XPLAIN (Excluding the blue XPLAINED family boards)
100 *
101 * \section Sec_AVR8Support_ThirdParty Supported Third Party Models
102 * Currently supported third-party boards (see \ref Group_BoardTypes for makefile \c BOARD constant names):
103 * - Adafruit U4 Breakout Board
104 * - Arduino Uno
105 * - Bitwizard Multio and Big-Multio
106 * - Busware BUI
107 * - Busware CUL V3
108 * - Busware TUL
109 * - DorkbotPDX Duce
110 * - Fletchtronics Bumble-B (using manufacturer recommended peripheral layout)
111 * - Kernel Concepts USBFOO
112 * - Linnix UDIP
113 * - MattairTech JM-DB-U2
114 * - Maximus USB
115 * - Micropendous Boards (many versions)
116 * - Microsin AVR-USB162
117 * - Minimus USB
118 * - Olimex AVR-USB-162
119 * - Paranoid Studio's US2AX (V1, V2 and V3 hardware revisions)
120 * - PJRC Teensy (1.x and 2.x versions)
121 * - Sparkfun U2 Breakout Board
122 * - TCNISO Blackcat USB JTAG
123 * - Tempusdictum Benito
124 * - Tom's USBTINY-MKII (all revisions and versions)
125 * - Custom User Boards (with Board Drivers if desired, see \ref Page_WritingBoardDrivers)
126 */
127
128 /**
129 * \page Page_UC3Support Atmel 32-Bit UC3 AVR (UC3)
130 * Note: <i>The AVR32 UC3 device support is currently <b>experimental</b>, and is included for preview purposes only.</i>
131 *
132 * \section Sec_UC3Support_Devices Supported Microcontroller Models
133 *
134 * Currently supported UC3 models:
135 *
136 * <table>
137 * <tr>
138 * <th width="150px">Part</th>
139 * <th width="150px">USB Device Mode</th>
140 * <th width="150px">USB Host Mode</th>
141 * </tr>
142 * <tr>
143 * <td>AT32UC3A064</td>
144 * <td bgcolor="#00EE00">Yes</td>
145 * <td bgcolor="#00EE00">Yes</td>
146 * </tr>
147 * <tr>
148 * <td>AT32UC3A164</td>
149 * <td bgcolor="#00EE00">Yes</td>
150 * <td bgcolor="#00EE00">Yes</td>
151 * </tr>
152 * <tr>
153 * <td>AT32UC3A364</td>
154 * <td bgcolor="#00EE00">Yes</td>
155 * <td bgcolor="#00EE00">Yes</td>
156 * </tr>
157 * <tr>
158 * <td>AT32UC3A364S</td>
159 * <td bgcolor="#00EE00">Yes</td>
160 * <td bgcolor="#00EE00">Yes</td>
161 * </tr>
162 * <tr>
163 * <td>AT32UC3A464</td>
164 * <td bgcolor="#00EE00">Yes</td>
165 * <td bgcolor="#00EE00">Yes</td>
166 * </tr>
167 * <tr>
168 * <td>AT32UC3A464S</td>
169 * <td bgcolor="#00EE00">Yes</td>
170 * <td bgcolor="#00EE00">Yes</td>
171 * </tr>
172 * <tr>
173 * <td>AT32UC3B064</td>
174 * <td bgcolor="#00EE00">Yes</td>
175 * <td bgcolor="#00EE00">Yes</td>
176 * </tr>
177 * <tr>
178 * <td>AT32UC3B164</td>
179 * <td bgcolor="#00EE00">Yes</td>
180 * <td bgcolor="#00EE00">Yes</td>
181 * </tr>
182 * <tr>
183 * <td>AT32UC3A0128</td>
184 * <td bgcolor="#00EE00">Yes</td>
185 * <td bgcolor="#00EE00">Yes</td>
186 * </tr>
187 * <tr>
188 * <td>AT32UC3A1128</td>
189 * <td bgcolor="#00EE00">Yes</td>
190 * <td bgcolor="#00EE00">Yes</td>
191 * </tr>
192 * <tr>
193 * <td>AT32UC3A3128</td>
194 * <td bgcolor="#00EE00">Yes</td>
195 * <td bgcolor="#00EE00">Yes</td>
196 * </tr>
197 * <tr>
198 * <td>AT32UC3A3128S</td>
199 * <td bgcolor="#00EE00">Yes</td>
200 * <td bgcolor="#00EE00">Yes</td>
201 * </tr>
202 * <tr>
203 * <td>AT32UC3A4128</td>
204 * <td bgcolor="#00EE00">Yes</td>
205 * <td bgcolor="#00EE00">Yes</td>
206 * </tr>
207 * <tr>
208 * <td>AT32UC3A4128S</td>
209 * <td bgcolor="#00EE00">Yes</td>
210 * <td bgcolor="#00EE00">Yes</td>
211 * </tr>
212 * <tr>
213 * <td>AT32UC3B0128</td>
214 * <td bgcolor="#00EE00">Yes</td>
215 * <td bgcolor="#00EE00">Yes</td>
216 * </tr>
217 * <tr>
218 * <td>AT32UC3B1128</td>
219 * <td bgcolor="#00EE00">Yes</td>
220 * <td bgcolor="#00EE00">Yes</td>
221 * </tr>
222 * <tr>
223 * <td>AT32UC3A0256</td>
224 * <td bgcolor="#00EE00">Yes</td>
225 * <td bgcolor="#00EE00">Yes</td>
226 * </tr>
227 * <tr>
228 * <td>AT32UC3A1256</td>
229 * <td bgcolor="#00EE00">Yes</td>
230 * <td bgcolor="#00EE00">Yes</td>
231 * </tr>
232 * <tr>
233 * <td>AT32UC3A3256</td>
234 * <td bgcolor="#00EE00">Yes</td>
235 * <td bgcolor="#00EE00">Yes</td>
236 * </tr>
237 * <tr>
238 * <td>AT32UC3A3256S</td>
239 * <td bgcolor="#00EE00">Yes</td>
240 * <td bgcolor="#00EE00">Yes</td>
241 * </tr>
242 * <tr>
243 * <td>AT32UC3A4256</td>
244 * <td bgcolor="#00EE00">Yes</td>
245 * <td bgcolor="#00EE00">Yes</td>
246 * </tr>
247 * <tr>
248 * <td>AT32UC3A4256S</td>
249 * <td bgcolor="#00EE00">Yes</td>
250 * <td bgcolor="#00EE00">Yes</td>
251 * </tr>
252 * <tr>
253 * <td>AT32UC3B0256</td>
254 * <td bgcolor="#00EE00">Yes</td>
255 * <td bgcolor="#00EE00">Yes</td>
256 * </tr>
257 * <tr>
258 * <td>AT32UC3B1256</td>
259 * <td bgcolor="#00EE00">Yes</td>
260 * <td bgcolor="#00EE00">Yes</td>
261 * </tr>
262 * <tr>
263 * <td>AT32UC3A0512</td>
264 * <td bgcolor="#00EE00">Yes</td>
265 * <td bgcolor="#00EE00">Yes</td>
266 * </tr>
267 * <tr>
268 * <td>AT32UC3A1512</td>
269 * <td bgcolor="#00EE00">Yes</td>
270 * <td bgcolor="#00EE00">Yes</td>
271 * </tr>
272 * <tr>
273 * <td>AT32UC3B0512</td>
274 * <td bgcolor="#00EE00">Yes</td>
275 * <td bgcolor="#00EE00">Yes</td>
276 * </tr>
277 * <tr>
278 * <td>AT32UC3B1512</td>
279 * <td bgcolor="#00EE00">Yes</td>
280 * <td bgcolor="#00EE00">Yes</td>
281 * </tr>
282 * </table>
283 *
284 * \section Sec_UC3Support_Boards Supported Atmel Boards
285 *
286 * Currently supported Atmel UC3 boards (see \ref Group_BoardTypes):
287 * - EVK1100
288 * - EVK1101
289 * - EVK1104
290 *
291 * \section Sec_UC3Support_ThirdParty Supported Third Party Models
292 *
293 * Currently supported third-party boards (see \ref Group_BoardTypes for makefile \c BOARD constant names):
294 * - Custom User Boards (with Board Drivers if desired, see \ref Page_WritingBoardDrivers)
295 */
296
297 /**
298 * \page Page_XMEGASupport Atmel USB XMEGA AVR (XMEGA)
299 * Note: <i>The XMEGA device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only.</i>
300 *
301 * \section Sec_XMEGASupport_Devices Supported Microcontroller Models
302 *
303 * Currently supported XMEGA models:
304 *
305 * <table>
306 * <tr>
307 * <th width="150px">Part</th>
308 * <th width="150px">USB Device Mode</th>
309 * <th width="150px">USB Host Mode</th>
310 * </tr>
311 * <tr>
312 * <td>ATXMEGA16A4U</td>
313 * <td bgcolor="#00EE00">Yes</td>
314 * <td bgcolor="#EE0000">No</td>
315 * </tr>
316 * <tr>
317 * <td>ATXMEGA32A4U</td>
318 * <td bgcolor="#00EE00">Yes</td>
319 * <td bgcolor="#EE0000">No</td>
320 * </tr>
321 * <tr>
322 * <td>ATXMEGA64A4U</td>
323 * <td bgcolor="#00EE00">Yes</td>
324 * <td bgcolor="#EE0000">No</td>
325 * </tr>
326 * <tr>
327 * <td>ATXMEGA128A4U</td>
328 * <td bgcolor="#00EE00">Yes</td>
329 * <td bgcolor="#EE0000">No</td>
330 * </tr>
331 * <tr>
332 * <td>ATXMEGA64A3U</td>
333 * <td bgcolor="#00EE00">Yes</td>
334 * <td bgcolor="#EE0000">No</td>
335 * </tr>
336 * <tr>
337 * <td>ATXMEGA128A3U</td>
338 * <td bgcolor="#00EE00">Yes</td>
339 * <td bgcolor="#EE0000">No</td>
340 * </tr>
341 * <tr>
342 * <td>ATXMEGA192A3U</td>
343 * <td bgcolor="#00EE00">Yes</td>
344 * <td bgcolor="#EE0000">No</td>
345 * </tr>
346 * <tr>
347 * <td>ATXMEGA256A3U</td>
348 * <td bgcolor="#00EE00">Yes</td>
349 * <td bgcolor="#EE0000">No</td>
350 * </tr>
351 * <tr>
352 * <td>ATXMEGA256A3BU</td>
353 * <td bgcolor="#00EE00">Yes</td>
354 * <td bgcolor="#EE0000">No</td>
355 * </tr>
356 * <tr>
357 * <td>ATXMEGA128A1U</td>
358 * <td bgcolor="#00EE00">Yes</td>
359 * <td bgcolor="#EE0000">No</td>
360 * </tr>
361 * <tr>
362 * <td>ATXMEGA64B3</td>
363 * <td bgcolor="#00EE00">Yes</td>
364 * <td bgcolor="#EE0000">No</td>
365 * </tr>
366 * <tr>
367 * <td>ATXMEGA128B3</td>
368 * <td bgcolor="#00EE00">Yes</td>
369 * <td bgcolor="#EE0000">No</td>
370 * </tr>
371 * <tr>
372 * <td>ATXMEGA64B1</td>
373 * <td bgcolor="#00EE00">Yes</td>
374 * <td bgcolor="#EE0000">No</td>
375 * </tr>
376 * <tr>
377 * <td>ATXMEGA128B1</td>
378 * <td bgcolor="#00EE00">Yes</td>
379 * <td bgcolor="#EE0000">No</td>
380 * </tr>
381 * <tr>
382 * <td>ATXMEGA64C3</td>
383 * <td bgcolor="#00EE00">Yes</td>
384 * <td bgcolor="#EE0000">No</td>
385 * </tr>
386 * <tr>
387 * <td>ATXMEGA128C3</td>
388 * <td bgcolor="#00EE00">Yes</td>
389 * <td bgcolor="#EE0000">No</td>
390 * </tr>
391 * <tr>
392 * <td>ATXMEGA192C3</td>
393 * <td bgcolor="#00EE00">Yes</td>
394 * <td bgcolor="#EE0000">No</td>
395 * </tr>
396 * <tr>
397 * <td>ATXMEGA256C3</td>
398 * <td bgcolor="#00EE00">Yes</td>
399 * <td bgcolor="#EE0000">No</td>
400 * </tr>
401 * <tr>
402 * <td>ATXMEGA16C4</td>
403 * <td bgcolor="#00EE00">Yes</td>
404 * <td bgcolor="#EE0000">No</td>
405 * </tr>
406 * <tr>
407 * <td>ATXMEGA32C4</td>
408 * <td bgcolor="#00EE00">Yes</td>
409 * <td bgcolor="#EE0000">No</td>
410 * </tr>
411 * </table>
412 *
413 * \section Sec_XMEGASupport_Boards Supported Atmel Boards
414 * Currently supported Atmel XMEGA boards (see \ref Group_BoardTypes):
415 * - XMEGA A3BU Xplained
416 * - XMEGA B1 Xplained
417 *
418 * \section Sec_XMEGASupport_ThirdParty Supported Third Party Models
419 * Currently supported third-party boards (see \ref Group_BoardTypes for makefile \c BOARD constant names):
420 * - Custom User Boards (with Board Drivers if desired, see \ref Page_WritingBoardDrivers)
421 */
422