Minor documentation improvements.
[pub/USBasp.git] / 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_KnownIssuesXXXXXX Version XXXXXX
13 * None.
14 *
15 * \section Sec_KnownIssues151115 Version 151115
16 * - AVR8 Architecture
17 * - No known issues.
18 * - UC3 Architecture
19 * \warning The UC3 device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only. \n
20 *
21 * - No demos, bootloaders or projects have been ported for the UC3 devices in the current release,
22 * although the architecture is supported in the LUFA core library.
23 * - DMA transfers to and from the USB controller are not yet implemented for this release.
24 * - The UC3C, UC3D and UC3L sub-families of UC3 are not currently supported by the library due to their
25 * altered USB controller design.
26 * - The various \c *_CreateStream() functions for creating standard \c <stdio.h> compatible virtual file
27 * streams are not available on the UC3 architecture, due to a lack of suitable library support.
28 * - XMEGA Architecture
29 * \warning The XMEGA device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only.
30 *
31 * - Endpoints of more than 64 bytes are not currently supported in this release.
32 * - Isochronous endpoints are not currently supported in this release. As a result, the audio class
33 * cannot be used on XMEGA devices.
34 * - Multiple-bank endpoints are not currently supported in this release.
35 * - Early silicon revisions of the ATXMEGA128A1U are incompatible with LUFA, due to their various errata
36 * relating to the USB controller.
37 * - Architecture Independent
38 * - The LUFA library is not watchdog aware, and thus timeouts are possible if short periods are used
39 * and a lengthy USB operation is initiated.
40 * - 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).
41 * - Build System
42 * - No known issues.
43 * - Atmel Studio Integration
44 * - 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".
45 * - 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.
46 *
47 * \section Sec_KnownIssues140928 Version 140928
48 * - AVR8 Architecture
49 * - No known issues.
50 * - UC3 Architecture
51 * \warning The UC3 device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only. \n
52 *
53 * - No demos, bootloaders or projects have been ported for the UC3 devices in the current release,
54 * although the architecture is supported in the LUFA core library.
55 * - DMA transfers to and from the USB controller are not yet implemented for this release.
56 * - The UC3C, UC3D and UC3L sub-families of UC3 are not currently supported by the library due to their
57 * altered USB controller design.
58 * - The various \c *_CreateStream() functions for creating standard \c <stdio.h> compatible virtual file
59 * streams are not available on the UC3 architecture, due to a lack of suitable library support.
60 * - XMEGA Architecture
61 * \warning The XMEGA device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only.
62 *
63 * - Endpoints of more than 64 bytes are not currently supported in this release.
64 * - Isochronous endpoints are not currently supported in this release. As a result, the audio class
65 * cannot be used on XMEGA devices.
66 * - Multiple-bank endpoints are not currently supported in this release.
67 * - Early silicon revisions of the ATXMEGA128A1U are incompatible with LUFA, due to their various errata
68 * relating to the USB controller.
69 * - Architecture Independent
70 * - The LUFA library is not watchdog aware, and thus timeouts are possible if short periods are used
71 * and a lengthy USB operation is initiated.
72 * - 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).
73 * - Build System
74 * - No known issues.
75 * - Atmel Studio Integration
76 * - 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".
77 * - 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.
78 *
79 * \section Sec_KnownIssues140302 Version 140302
80 * - AVR8 Architecture
81 * - No known issues.
82 * - UC3 Architecture
83 * \warning The UC3 device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only. \n
84 *
85 * - No demos, bootloaders or projects have been ported for the UC3 devices in the current release,
86 * although the architecture is supported in the LUFA core library.
87 * - DMA transfers to and from the USB controller are not yet implemented for this release.
88 * - The UC3C, UC3D and UC3L sub-families of UC3 are not currently supported by the library due to their
89 * altered USB controller design.
90 * - The various \c *_CreateStream() functions for creating standard \c <stdio.h> compatible virtual file
91 * streams are not available on the UC3 architecture, due to a lack of suitable library support.
92 * - XMEGA Architecture
93 * \warning The XMEGA device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only.
94 *
95 * - Endpoints of more than 64 bytes are not currently supported in this release.
96 * - Isochronous endpoints are not currently supported in this release. As a result, the audio class
97 * cannot be used on XMEGA devices.
98 * - Multiple-bank endpoints are not currently supported in this release.
99 * - Early silicon revisions of the ATXMEGA128A1U are incompatible with LUFA, due to their various errata
100 * relating to the USB controller.
101 * - Architecture Independent
102 * - The LUFA library is not watchdog aware, and thus timeouts are possible if short periods are used
103 * and a lengthy USB operation is initiated.
104 * - 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).
105 * - Build System
106 * - No known issues.
107 * - Atmel Studio Integration
108 * - 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".
109 * - 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.
110 *
111 * \section Sec_KnownIssues130901 Version 130901
112 * - AVR8 Architecture
113 * - No known issues.
114 * - UC3 Architecture
115 * \warning The UC3 device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only. \n
116 *
117 * - No demos, bootloaders or projects have been ported for the UC3 devices in the current release,
118 * although the architecture is supported in the LUFA core library.
119 * - DMA transfers to and from the USB controller are not yet implemented for this release.
120 * - The UC3C, UC3D and UC3L sub-families of UC3 are not currently supported by the library due to their
121 * altered USB controller design.
122 * - The various \c *_CreateStream() functions for creating standard \c <stdio.h> compatible virtual file
123 * streams are not available on the UC3 architecture, due to a lack of suitable library support.
124 * - XMEGA Architecture
125 * \warning The XMEGA device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only.
126 *
127 * - Endpoints of more than 64 bytes are not currently supported in this release.
128 * - Isochronous endpoints are not currently supported in this release. As a result, the audio class
129 * cannot be used on XMEGA devices.
130 * - Multiple-bank endpoints are not currently supported in this release.
131 * - Early silicon revisions of the ATXMEGA128A1U are incompatible with LUFA, due to their various errata
132 * relating to the USB controller.
133 * - Architecture Independent
134 * - The LUFA library is not watchdog aware, and thus timeouts are possible if short periods are used
135 * and a lengthy USB operation is initiated.
136 * - 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).
137 * - Build System
138 * - No known issues.
139 * - Atmel Studio Integration
140 * - 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".
141 * - 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.
142 *
143 * \section Sec_KnownIssues130303 Version 130303
144 * - AVR8 Architecture
145 * - No known issues.
146 * - UC3 Architecture
147 * \warning The UC3 device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only. \n
148 *
149 * - No demos, bootloaders or projects have been ported for the UC3 devices in the current release,
150 * although the architecture is supported in the LUFA core library.
151 * - DMA transfers to and from the USB controller are not yet implemented for this release.
152 * - The UC3C, UC3D and UC3L sub-families of UC3 are not currently supported by the library due to their
153 * altered USB controller design.
154 * - The various \c CreateStream() functions for creating standard \c <stdio.h> compatible virtual file
155 * streams are not available on the UC3 architecture, due to a lack of suitable library support.
156 * - XMEGA Architecture
157 * \warning The XMEGA device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only.
158 *
159 * - No demos, bootloaders or projects have been ported for the XMEGA devices in the current release,
160 * although the architecture is supported in the LUFA core library.
161 * - Endpoints of more than 64 bytes are not currently supported in this release.
162 * - Isochronous endpoints are not currently supported in this release. As a result, the audio class
163 * cannot be used on XMEGA devices.
164 * - Multiple-bank endpoints are not currently supported in this release.
165 * - Early revisions of the ATXMEGA128A1U are incompatible with LUFA, due to their various errata
166 * relating to the USB controller.
167 * - Architecture Independent
168 * - The LUFA library is not watchdog aware, and thus timeouts are possible if short periods are used
169 * and a lengthy USB operation is initiated.
170 * - 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).
171 * - Build System
172 * - No known issues.
173 *
174 * \section Sec_KnownIssues120730 Version 120730
175 * - AVR8 Architecture
176 * - No known issues.
177 * - UC3 Architecture
178 * \warning The UC3 device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only. \n
179 *
180 * - No demos, bootloaders or projects have been ported for the UC3 devices in the current release,
181 * although the architecture is supported in the LUFA core library.
182 * - DMA transfers to and from the USB controller are not yet implemented for this release.
183 * - The UC3C, UC3D and UC3L sub-families of UC3 are not currently supported by the library due to their
184 * altered USB controller design.
185 * - The various \c CreateStream() functions for creating standard \c <stdio.h> compatible virtual file
186 * streams are not available on the UC3 architecture, due to a lack of suitable library support.
187 * - XMEGA Architecture
188 * \warning The XMEGA device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only.
189 *
190 * - No demos, bootloaders or projects have been ported for the XMEGA devices in the current release,
191 * although the architecture is supported in the LUFA core library.
192 * - Endpoints of more than 64 bytes are not currently supported in this release.
193 * - Isochronous endpoints are not currently supported in this release. As a result, the audio class
194 * cannot be used on XMEGA devices.
195 * - Multiple-bank endpoints are not currently supported in this release.
196 * - Early revisions of the ATXMEGA128A1U are incompatible with LUFA, due to their various errata
197 * relating to the USB controller.
198 * - Architecture Independent
199 * - The LUFA library is not watchdog aware, and thus timeouts are possible if short periods are used
200 * and a lengthy USB operation is initiated.
201 * - 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).
202 * - Build System
203 * - No known issues.
204 */
205