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