]> git.friedersdorff.com Git - max/tmk_keyboard.git/blob - tmk_core/protocol/lufa/LUFA-git/LUFA/DoxygenPages/KnownIssues.txt
Merge commit '5a0132f1c1c9a14fd2941f0a5e29bbf5e31da20c' into master-core-pull
[max/tmk_keyboard.git] / tmk_core / protocol / lufa / LUFA-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_KnownIssues140928 Version 140928
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).
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_KnownIssues140302 Version 140302
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 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_KnownIssues130901 Version 130901
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 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_KnownIssues130303 Version 130303
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   *    - No demos, bootloaders or projects have been ported for the XMEGA devices in the current release,
125   *      although the architecture is supported in the LUFA core library.
126   *    - Endpoints of more than 64 bytes are not currently supported in this release.
127   *    - Isochronous endpoints are not currently supported in this release. As a result, the audio class
128   *      cannot be used on XMEGA devices.
129   *    - Multiple-bank endpoints are not currently supported in this release.
130   *    - Early revisions of the ATXMEGA128A1U are incompatible with LUFA, due to their various errata
131   *      relating to the USB controller.
132   *  - Architecture Independent
133   *    - The LUFA library is not watchdog aware, and thus timeouts are possible if short periods are used
134   *      and a lengthy USB operation is initiated.
135   *    - 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).
136   *  - Build System
137   *    - No known issues.
138   *
139   *  \section Sec_KnownIssues120730 Version 120730
140   *  - AVR8 Architecture
141   *    - No known issues.
142   *  - UC3 Architecture
143   *    \warning The UC3 device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only. \n
144   *
145   *    - No demos, bootloaders or projects have been ported for the UC3 devices in the current release,
146   *      although the architecture is supported in the LUFA core library.
147   *    - DMA transfers to and from the USB controller are not yet implemented for this release.
148   *    - The UC3C, UC3D and UC3L sub-families of UC3 are not currently supported by the library due to their
149   *      altered USB controller design.
150   *    - The various \c CreateStream() functions for creating standard \c <stdio.h> compatible virtual file
151   *      streams are not available on the UC3 architecture, due to a lack of suitable library support.
152   *  - XMEGA Architecture
153   *    \warning The XMEGA device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only.
154   *
155   *    - No demos, bootloaders or projects have been ported for the XMEGA devices in the current release,
156   *      although the architecture is supported in the LUFA core library.
157   *    - Endpoints of more than 64 bytes are not currently supported in this release.
158   *    - Isochronous endpoints are not currently supported in this release. As a result, the audio class
159   *      cannot be used on XMEGA devices.
160   *    - Multiple-bank endpoints are not currently supported in this release.
161   *    - Early revisions of the ATXMEGA128A1U are incompatible with LUFA, due to their various errata
162   *      relating to the USB controller.
163   *  - Architecture Independent
164   *    - The LUFA library is not watchdog aware, and thus timeouts are possible if short periods are used
165   *      and a lengthy USB operation is initiated.
166   *    - 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).
167   *  - Build System
168   *    - No known issues.
169   */
170