]> git.donarmstrong.com Git - qmk_firmware.git/blob - lib/lufa/LUFA/DoxygenPages/KnownIssues.txt
Merge commit '60b30c036397cb5627fa374bb930794b225daa29' as 'lib/lufa'
[qmk_firmware.git] / lib / lufa / LUFA / DoxygenPages / KnownIssues.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  /** \page Page_KnownIssues Known Issues
8   *  The following are known issues present in each official LUFA release. This list should contain all known
9   *  issues in the library. Most of these issues should be corrected in the future release - see
10   *  \ref Page_FutureChanges for a list of planned changes in future releases.
11   *
12   *  \section Sec_KnownIssues170418 Version 170418
13   *  - AVR8 Architecture
14   *    - No known issues.
15   *  - UC3 Architecture
16   *    \warning The UC3 device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only. \n
17   *
18   *    - No demos, bootloaders or projects have been ported for the UC3 devices in the current release,
19   *      although the architecture is supported in the LUFA core library.
20   *    - DMA transfers to and from the USB controller are not yet implemented for this release.
21   *    - The UC3C, UC3D and UC3L sub-families of UC3 are not currently supported by the library due to their
22   *      altered USB controller design.
23   *    - The various \c *_CreateStream() functions for creating standard \c <stdio.h> compatible virtual file
24   *      streams are not available on the UC3 architecture, due to a lack of suitable library support.
25   *  - XMEGA Architecture
26   *    \warning The XMEGA device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only.
27   *
28   *    - Endpoints of more than 64 bytes are not currently supported in this release.
29   *    - Isochronous endpoints are not currently supported in this release. As a result, the audio class
30   *      cannot be used on XMEGA devices.
31   *    - Multiple-bank endpoints are not currently supported in this release.
32   *    - Early silicon revisions of the ATXMEGA128A1U are incompatible with LUFA, due to their various errata
33   *      relating to the USB controller.
34   *  - Architecture Independent
35   *    - The LUFA library is not watchdog aware, and thus timeouts are possible if short periods are used
36   *      and a lengthy USB operation is initiated.
37   *    - No LUFA provided driver INF files for Windows are signed, and thus may fail to install on systems where driver signing is enforced (e.g. Windows 8/10).
38   *  - Build System
39   *    - No known issues.
40   *  - Atmel Studio Integration
41   *    - Not all devices are listed in the "Supported Parts" screen when selecting a device. To select an alternative device, change the "Show Device" drop-down to "All Parts".
42   *    - When switching boards after changing the device selection, a second conflicting \c BOARD symbol definition can be created that prevents successful compilation. To fix, open the project properties window (<i>Project->Project {name} Properties...</i> menu item), click the "Toolchain" tab, click "Symbols" under the "AVR/GNU C Compiler" section and remove the incorrect definition.
43   *
44   *  \section Sec_KnownIssues151115 Version 151115
45   *  - AVR8 Architecture
46   *    - No known issues.
47   *  - UC3 Architecture
48   *    \warning The UC3 device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only. \n
49   *
50   *    - No demos, bootloaders or projects have been ported for the UC3 devices in the current release,
51   *      although the architecture is supported in the LUFA core library.
52   *    - DMA transfers to and from the USB controller are not yet implemented for this release.
53   *    - The UC3C, UC3D and UC3L sub-families of UC3 are not currently supported by the library due to their
54   *      altered USB controller design.
55   *    - The various \c *_CreateStream() functions for creating standard \c <stdio.h> compatible virtual file
56   *      streams are not available on the UC3 architecture, due to a lack of suitable library support.
57   *  - XMEGA Architecture
58   *    \warning The XMEGA device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only.
59   *
60   *    - Endpoints of more than 64 bytes are not currently supported in this release.
61   *    - Isochronous endpoints are not currently supported in this release. As a result, the audio class
62   *      cannot be used on XMEGA devices.
63   *    - Multiple-bank endpoints are not currently supported in this release.
64   *    - Early silicon revisions of the ATXMEGA128A1U are incompatible with LUFA, due to their various errata
65   *      relating to the USB controller.
66   *  - Architecture Independent
67   *    - The LUFA library is not watchdog aware, and thus timeouts are possible if short periods are used
68   *      and a lengthy USB operation is initiated.
69   *    - No LUFA provided driver INF files for Windows are signed, and thus may fail to install on systems where driver signing is enforced (e.g. Windows 8).
70   *  - Build System
71   *    - No known issues.
72   *  - Atmel Studio Integration
73   *    - Not all devices are listed in the "Supported Parts" screen when selecting a device. To select an alternative device, change the "Show Device" drop-down to "All Parts".
74   *    - When switching boards after changing the device selection, a second conflicting \c BOARD symbol definition can be created that prevents successful compilation. To fix, open the project properties window (<i>Project->Project {name} Properties...</i> menu item), click the "Toolchain" tab, click "Symbols" under the "AVR/GNU C Compiler" section and remove the incorrect definition.
75   *
76   *  \section Sec_KnownIssues140928 Version 140928
77   *  - AVR8 Architecture
78   *    - No known issues.
79   *  - UC3 Architecture
80   *    \warning The UC3 device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only. \n
81   *
82   *    - No demos, bootloaders or projects have been ported for the UC3 devices in the current release,
83   *      although the architecture is supported in the LUFA core library.
84   *    - DMA transfers to and from the USB controller are not yet implemented for this release.
85   *    - The UC3C, UC3D and UC3L sub-families of UC3 are not currently supported by the library due to their
86   *      altered USB controller design.
87   *    - The various \c *_CreateStream() functions for creating standard \c <stdio.h> compatible virtual file
88   *      streams are not available on the UC3 architecture, due to a lack of suitable library support.
89   *  - XMEGA Architecture
90   *    \warning The XMEGA device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only.
91   *
92   *    - Endpoints of more than 64 bytes are not currently supported in this release.
93   *    - Isochronous endpoints are not currently supported in this release. As a result, the audio class
94   *      cannot be used on XMEGA devices.
95   *    - Multiple-bank endpoints are not currently supported in this release.
96   *    - Early silicon revisions of the ATXMEGA128A1U are incompatible with LUFA, due to their various errata
97   *      relating to the USB controller.
98   *  - Architecture Independent
99   *    - The LUFA library is not watchdog aware, and thus timeouts are possible if short periods are used
100   *      and a lengthy USB operation is initiated.
101   *    - No LUFA provided driver INF files for Windows are signed, and thus may fail to install on systems where driver signing is enforced (e.g. Windows 8).
102   *  - Build System
103   *    - No known issues.
104   *  - Atmel Studio Integration
105   *    - Not all devices are listed in the "Supported Parts" screen when selecting a device. To select an alternative device, change the "Show Device" drop-down to "All Parts".
106   *    - When switching boards after changing the device selection, a second conflicting \c BOARD symbol definition can be created that prevents successful compilation. To fix, open the project properties window (<i>Project->Project {name} Properties...</i> menu item), click the "Toolchain" tab, click "Symbols" under the "AVR/GNU C Compiler" section and remove the incorrect definition.
107   *
108   *  \section Sec_KnownIssues140302 Version 140302
109   *  - AVR8 Architecture
110   *    - No known issues.
111   *  - UC3 Architecture
112   *    \warning The UC3 device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only. \n
113   *
114   *    - No demos, bootloaders or projects have been ported for the UC3 devices in the current release,
115   *      although the architecture is supported in the LUFA core library.
116   *    - DMA transfers to and from the USB controller are not yet implemented for this release.
117   *    - The UC3C, UC3D and UC3L sub-families of UC3 are not currently supported by the library due to their
118   *      altered USB controller design.
119   *    - The various \c *_CreateStream() functions for creating standard \c <stdio.h> compatible virtual file
120   *      streams are not available on the UC3 architecture, due to a lack of suitable library support.
121   *  - XMEGA Architecture
122   *    \warning The XMEGA device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only.
123   *
124   *    - Endpoints of more than 64 bytes are not currently supported in this release.
125   *    - Isochronous endpoints are not currently supported in this release. As a result, the audio class
126   *      cannot be used on XMEGA devices.
127   *    - Multiple-bank endpoints are not currently supported in this release.
128   *    - Early silicon revisions of the ATXMEGA128A1U are incompatible with LUFA, due to their various errata
129   *      relating to the USB controller.
130   *  - Architecture Independent
131   *    - The LUFA library is not watchdog aware, and thus timeouts are possible if short periods are used
132   *      and a lengthy USB operation is initiated.
133   *    - No LUFA provided driver INF files for Windows are signed, and thus may fail to install on systems where driver signing is enforced (e.g. Windows 8).
134   *  - Build System
135   *    - No known issues.
136   *  - Atmel Studio Integration
137   *    - Not all devices are listed in the "Supported Parts" screen when selecting a device. To select an alternative device, change the "Show Device" drop-down to "All Parts".
138   *    - When switching boards after changing the device selection, a second conflicting BOARD symbol definition can be created that prevents successful compilation. To fix, open the project properties window (<i>Project->Project {name} Properties...</i> menu item), click the Toolchain tab, click "Symbols" under the "AVR/GNU C Compiler" section and remove the incorrect definition.
139   *
140   *  \section Sec_KnownIssues130901 Version 130901
141   *  - AVR8 Architecture
142   *    - No known issues.
143   *  - UC3 Architecture
144   *    \warning The UC3 device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only. \n
145   *
146   *    - No demos, bootloaders or projects have been ported for the UC3 devices in the current release,
147   *      although the architecture is supported in the LUFA core library.
148   *    - DMA transfers to and from the USB controller are not yet implemented for this release.
149   *    - The UC3C, UC3D and UC3L sub-families of UC3 are not currently supported by the library due to their
150   *      altered USB controller design.
151   *    - The various \c *_CreateStream() functions for creating standard \c <stdio.h> compatible virtual file
152   *      streams are not available on the UC3 architecture, due to a lack of suitable library support.
153   *  - XMEGA Architecture
154   *    \warning The XMEGA device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only.
155   *
156   *    - Endpoints of more than 64 bytes are not currently supported in this release.
157   *    - Isochronous endpoints are not currently supported in this release. As a result, the audio class
158   *      cannot be used on XMEGA devices.
159   *    - Multiple-bank endpoints are not currently supported in this release.
160   *    - Early silicon revisions of the ATXMEGA128A1U are incompatible with LUFA, due to their various errata
161   *      relating to the USB controller.
162   *  - Architecture Independent
163   *    - The LUFA library is not watchdog aware, and thus timeouts are possible if short periods are used
164   *      and a lengthy USB operation is initiated.
165   *    - No LUFA provided driver INF files for Windows are signed, and thus may fail to install on systems where driver signing is enforced (e.g. Windows 8).
166   *  - Build System
167   *    - No known issues.
168   *  - Atmel Studio Integration
169   *    - Not all devices are listed in the "Supported Parts" screen when selecting a device. To select an alternative device, change the "Show Device" drop-down to "All Parts".
170   *    - When switching boards after changing the device selection, a second conflicting BOARD symbol definition can be created that prevents successful compilation. To fix, open the project properties window (<i>Project->Project {name} Properties...</i> menu item), click the Toolchain tab, click "Symbols" under the "AVR/GNU C Compiler" section and remove the incorrect definition.
171   *
172   *  \section Sec_KnownIssues130303 Version 130303
173   *  - AVR8 Architecture
174   *    - No known issues.
175   *  - UC3 Architecture
176   *    \warning The UC3 device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only. \n
177   *
178   *    - No demos, bootloaders or projects have been ported for the UC3 devices in the current release,
179   *      although the architecture is supported in the LUFA core library.
180   *    - DMA transfers to and from the USB controller are not yet implemented for this release.
181   *    - The UC3C, UC3D and UC3L sub-families of UC3 are not currently supported by the library due to their
182   *      altered USB controller design.
183   *    - The various \c CreateStream() functions for creating standard \c <stdio.h> compatible virtual file
184   *      streams are not available on the UC3 architecture, due to a lack of suitable library support.
185   *  - XMEGA Architecture
186   *    \warning The XMEGA device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only.
187   *
188   *    - No demos, bootloaders or projects have been ported for the XMEGA devices in the current release,
189   *      although the architecture is supported in the LUFA core library.
190   *    - Endpoints of more than 64 bytes are not currently supported in this release.
191   *    - Isochronous endpoints are not currently supported in this release. As a result, the audio class
192   *      cannot be used on XMEGA devices.
193   *    - Multiple-bank endpoints are not currently supported in this release.
194   *    - Early revisions of the ATXMEGA128A1U are incompatible with LUFA, due to their various errata
195   *      relating to the USB controller.
196   *  - Architecture Independent
197   *    - The LUFA library is not watchdog aware, and thus timeouts are possible if short periods are used
198   *      and a lengthy USB operation is initiated.
199   *    - No LUFA provided driver INF files for Windows are signed, and thus may fail to install on systems where driver signing is enforced (e.g. Windows 8).
200   *  - Build System
201   *    - No known issues.
202   *
203   *  \section Sec_KnownIssues120730 Version 120730
204   *  - AVR8 Architecture
205   *    - No known issues.
206   *  - UC3 Architecture
207   *    \warning The UC3 device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only. \n
208   *
209   *    - No demos, bootloaders or projects have been ported for the UC3 devices in the current release,
210   *      although the architecture is supported in the LUFA core library.
211   *    - DMA transfers to and from the USB controller are not yet implemented for this release.
212   *    - The UC3C, UC3D and UC3L sub-families of UC3 are not currently supported by the library due to their
213   *      altered USB controller design.
214   *    - The various \c CreateStream() functions for creating standard \c <stdio.h> compatible virtual file
215   *      streams are not available on the UC3 architecture, due to a lack of suitable library support.
216   *  - XMEGA Architecture
217   *    \warning The XMEGA device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only.
218   *
219   *    - No demos, bootloaders or projects have been ported for the XMEGA devices in the current release,
220   *      although the architecture is supported in the LUFA core library.
221   *    - Endpoints of more than 64 bytes are not currently supported in this release.
222   *    - Isochronous endpoints are not currently supported in this release. As a result, the audio class
223   *      cannot be used on XMEGA devices.
224   *    - Multiple-bank endpoints are not currently supported in this release.
225   *    - Early revisions of the ATXMEGA128A1U are incompatible with LUFA, due to their various errata
226   *      relating to the USB controller.
227   *  - Architecture Independent
228   *    - The LUFA library is not watchdog aware, and thus timeouts are possible if short periods are used
229   *      and a lengthy USB operation is initiated.
230   *    - No LUFA provided driver INF files for Windows are signed, and thus may fail to install on systems where driver signing is enforced (e.g. Windows 8).
231   *  - Build System
232   *    - No known issues.
233   */
234