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   *  - 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   *    - No demos, bootloaders or projects have been ported for the XMEGA devices in the current release,
  29   *      although the architecture is supported in the LUFA core library.
  30   *    - Endpoints of more than 64 bytes are not currently supported in this release.
  31   *    - Isochronous endpoints are not currently supported in this release. As a result, the audio class
  32   *      cannot be used on XMEGA devices.
  33   *    - Multiple-bank endpoints are not currently supported in this release.
  34   *    - Early revisions of the ATXMEGA128A1U are incompatible with LUFA, due to their various errata
  35   *      relating to the USB controller.
  36   *  - Architecture Independent
  37   *    - The HID parser fails for array type elements that have a MIN and MAX usage applied; each element
  38   *      in the array will receive a unique incrementing usage from the MIN value, up to MAX.
  39   *    - The LUFA library is not watchdog aware, and thus timeouts are possible if short periods are used
  40   *      and a lengthy USB operation is initiated.
  41   *    - 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).
  42   *  - Build System
  43   *    - No known issues.
  44   *
  45   *  \section Sec_KnownIssues130303 Version 130303
  46   *  - AVR8 Architecture
  47   *    - No known issues.
  48   *  - UC3 Architecture
  49   *    \warning The UC3 device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only. \n
  50   *
  51   *    - No demos, bootloaders or projects have been ported for the UC3 devices in the current release,
  52   *      although the architecture is supported in the LUFA core library.
  53   *    - DMA transfers to and from the USB controller are not yet implemented for this release.
  54   *    - The UC3C, UC3D and UC3L sub-families of UC3 are not currently supported by the library due to their
  55   *      altered USB controller design.
  56   *    - The various \c CreateStream() functions for creating standard \c <stdio.h> compatible virtual file
  57   *      streams are not available on the UC3 architecture, due to a lack of suitable library support.
  58   *  - XMEGA Architecture
  59   *    \warning The XMEGA device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only.
  60   *
  61   *    - No demos, bootloaders or projects have been ported for the XMEGA devices in the current release,
  62   *      although the architecture is supported in the LUFA core library.
  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 revisions of the ATXMEGA128A1U are incompatible with LUFA, due to their various errata
  68   *      relating to the USB controller.
  69   *  - Architecture Independent
  70   *    - The HID parser fails for array type elements that have a MIN and MAX usage applied; each element
  71   *      in the array will receive a unique incrementing usage from the MIN value, up to MAX.
  72   *    - The LUFA library is not watchdog aware, and thus timeouts are possible if short periods are used
  73   *      and a lengthy USB operation is initiated.
  74   *    - 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).
  75   *  - Build System
  76   *    - No known issues.
  77   *
  78   *  \section Sec_KnownIssues120730 Version 120730
  79   *  - AVR8 Architecture
  80   *    - No known issues.
  81   *  - UC3 Architecture
  82   *    \warning The UC3 device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only. \n
  83   *
  84   *    - No demos, bootloaders or projects have been ported for the UC3 devices in the current release,
  85   *      although the architecture is supported in the LUFA core library.
  86   *    - DMA transfers to and from the USB controller are not yet implemented for this release.
  87   *    - The UC3C, UC3D and UC3L sub-families of UC3 are not currently supported by the library due to their
  88   *      altered USB controller design.
  89   *    - The various \c CreateStream() functions for creating standard \c <stdio.h> compatible virtual file
  90   *      streams are not available on the UC3 architecture, due to a lack of suitable library support.
  91   *  - XMEGA Architecture
  92   *    \warning The XMEGA device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only.
  93   *
  94   *    - No demos, bootloaders or projects have been ported for the XMEGA devices in the current release,
  95   *      although the architecture is supported in the LUFA core library.
  96   *    - Endpoints of more than 64 bytes are not currently supported in this release.
  97   *    - Isochronous endpoints are not currently supported in this release. As a result, the audio class
  98   *      cannot be used on XMEGA devices.
  99   *    - Multiple-bank endpoints are not currently supported in this release.
 100   *    - Early revisions of the ATXMEGA128A1U are incompatible with LUFA, due to their various errata
 101   *      relating to the USB controller.
 102   *  - Architecture Independent
 103   *    - The HID parser fails for array type elements that have a MIN and MAX usage applied; each element
 104   *      in the array will receive a unique incrementing usage from the MIN value, up to MAX.
 105   *    - The LUFA library is not watchdog aware, and thus timeouts are possible if short periods are used
 106   *      and a lengthy USB operation is initiated.
 107   *  - Build System
 108   *    - No known issues.
 109   */
 110