diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2012-04-18 20:06:18 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2012-04-18 20:06:18 +0000 |
| commit | c48da94605c12009dc30ab861a97a78c1d4d26de (patch) | |
| tree | bee6ca630cacb942855ba65881400a04cac03bc6 /LUFA/DoxygenPages/KnownIssues.txt | |
| parent | 1ab76048c9c727a588a0cc0fab285222b5916df5 (diff) | |
| download | lufa-c48da94605c12009dc30ab861a97a78c1d4d26de.tar.gz lufa-c48da94605c12009dc30ab861a97a78c1d4d26de.tar.bz2 lufa-c48da94605c12009dc30ab861a97a78c1d4d26de.zip | |
Add known issues to the documentation.
Diffstat (limited to 'LUFA/DoxygenPages/KnownIssues.txt')
| -rw-r--r-- | LUFA/DoxygenPages/KnownIssues.txt | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/LUFA/DoxygenPages/KnownIssues.txt b/LUFA/DoxygenPages/KnownIssues.txt new file mode 100644 index 000000000..67da093c9 --- /dev/null +++ b/LUFA/DoxygenPages/KnownIssues.txt @@ -0,0 +1,38 @@ +/** \file
+ *
+ * This file contains special DoxyGen information for the generation of the main page and other special
+ * documentation pages. It is not a project source file.
+ */
+
+ /** \page Page_KnownIssues Known Issues
+ * The following are known issues present in each official LUFA release. This list should contain all known
+ * issues in the library. Most of these issues should be corrected in the future release - see
+ * \ref Page_FutureChanges for a list of planned changes in future releases.
+ *
+ * \section Sec_KnownIssuesXXXXXX Version XXXXXX
+ * - AVR8 Architecture
+ * - No known issues.
+ * - XMEGA Architecture
+ * - No demos, bootloaders or projects have been ported for the XMEGA devices in the current release,
+ * although the architecture is supported in the LUFA core library.
+ * - Endpoints of more than 64 bytes are not currently supported in this release.
+ * - Isochronous endpoints are not currently supported in this release. As a result, the audio class
+ * cannot be used on XMEGA devices.
+ * - Multiple-bank endpoints are not currently supported in this release.
+ * - Early revisions of the ATXMEGA128A1U are incompatible with LUFA, due to their various errata
+ * relating to the USB controller.
+ * - UC3 Architecture
+ * - No demos, bootloaders or projects have been ported for the UC3 devices in the current release,
+ * although the architecture is supported in the LUFA core library.
+ * - DMA transfers to and from the USB controller are not yet implemented for this release.
+ * - The UC3C, UC3D and UC3L sub-families of UC3 are not currently supported by the library due to their
+ * altered USB controller design.
+ * - Architecture Independant
+ * - The HID parser fails for array type elements that have a MIN and MAX usage applied; each element
+ * in the array will receive a unique incrementing usage from the MIN value, up to MAX.
+ * - The current application makefiles do not work if the output directory is not the same directory
+ * as the makefile itself.
+ * - The LUFA library is not watchdog aware, and thus timeouts are possible if short periods are used
+ * and a lengthy USB operation is initiated.
+ */
+
|