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