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