From ccf4cffd78fd3ee56c5f6f61ce50e386ee50a513 Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Fri, 19 Aug 2011 06:04:39 +0000 Subject: Improve device support documentation in the manual; split out each architecture into a different sub-page of the Device Support section of the manual, add in table to indicate USB mode support for each microcontroller model. --- LUFA/ManPages/DeviceSupport.txt | 354 +++++++++++++++++++++++++++++++++------- 1 file changed, 298 insertions(+), 56 deletions(-) (limited to 'LUFA') diff --git a/LUFA/ManPages/DeviceSupport.txt b/LUFA/ManPages/DeviceSupport.txt index c248bbda2..7c16b6dda 100644 --- a/LUFA/ManPages/DeviceSupport.txt +++ b/LUFA/ManPages/DeviceSupport.txt @@ -7,22 +7,88 @@ /** * \page Page_DeviceSupport Device and Hardware Support * - * \section Sec_AVR8_Support Atmel 8-Bit AVR (AVR8) + * Atmel Microcontrollers: + * \li \subpage Page_AVR8Support - Atmel AVR8 Support + * \li \subpage Page_UC3Support - Atmel AVR32 UC3 Support + * \li \subpage Page_XMEGASupport - Atmel XMEGA Support + */ + +/** + * \page Page_AVR8Support Atmel 8-Bit AVR (AVR8) Support + * + * \section Sec_AVR8Support_Devices Supported Microcontroller Models * * Currently supported AVR8 models: - * - AT90USB82 (USB Device Only) - * - ATMEGA8U2 (USB Device Only) - * - AT90USB162 (USB Device Only) - * - ATMEGA16U2 (USB Device Only) - * - ATMEGA16U4 (USB Device Only) - * - ATMEGA32U2 (USB Device Only) - * - ATMEGA32U4 (USB Device Only) - * - ATMEGA32U6 (USB Device Only) - * - AT90USB646 (USB Device Only) - * - AT90USB647 (USB Host and Device) - * - AT90USB1286 (USB Device Only) - * - AT90USB1287 (USB Host and Device) * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
PartDevice ModeHost Mode
AT90USB82YesNo
ATMEGA8U2YesNo
AT90USB162YesNo
ATMEGA16U2YesNo
ATMEGA16U4YesNo
ATMEGA32U2YesNo
ATMEGA32U4YesNo
ATMEGA32U6YesNo
AT90USB646YesNo
AT90USB647YesYes
AT90USB1286YesNo
AT90USB1287YesYes
+ * + * \section Sec_AVR8Support_Boards Supported Atmel Boards * Currently supported Atmel AVR8 boards (see \ref Group_BoardTypes): * - AT90USBKEY * - ATAVRUSBRF01 @@ -32,7 +98,8 @@ * - STK526 * - XPLAIN (Excluding the blue XPLAINED family boards) * - * Currently supported third-party boards (see \ref Group_BoardTypes for makefile BOARD constant names): + * \section Sec_AVR8Support_ThirdParty Supported Third Party Models + * Currently supported third-party boards (see \ref Group_BoardTypes for makefile \c BOARD constant names): * - Adafruit U4 Breakout Board * - Arduino Uno * - Busware BUI @@ -51,64 +118,239 @@ * - Tempusdictum Benito * - Tom's USBTINY-MKII (all revisions and versions) * - Custom User Boards (with Board Drivers if desired, see \ref Page_WritingBoardDrivers) - * - * \section Sec_AVR32_Support Atmel 32-Bit UC3 AVR (UC3) + */ + +/** + * \page Page_UC3Support Atmel 32-Bit UC3 AVR (UC3) * Note: The AVR32 UC3 device support is currently experimental, and is included for preview purposes only. * + * \section Sec_UC3Support_Devices Supported Microcontroller Models + * * Currently supported UC3 models: - * - AT32UC3A064 (USB Host and Device) - * - AT32UC3A164 (USB Host and Device) - * - AT32UC3A364 (USB Host and Device) - * - AT32UC3A364S (USB Host and Device) - * - AT32UC3A464 (USB Host and Device) - * - AT32UC3A464S (USB Host and Device) - * - AT32UC3B064 (USB Host and Device) - * - AT32UC3B164 (USB Host and Device) - * - AT32UC3A0128 (USB Host and Device) - * - AT32UC3A1128 (USB Host and Device) - * - AT32UC3A3128 (USB Host and Device) - * - AT32UC3A3128S (USB Host and Device) - * - AT32UC3A4128 (USB Host and Device) - * - AT32UC3A4128S (USB Host and Device) - * - AT32UC3B0128 (USB Host and Device) - * - AT32UC3B1128 (USB Host and Device) - * - AT32UC3A0256 (USB Host and Device) - * - AT32UC3A1256 (USB Host and Device) - * - AT32UC3A3256 (USB Host and Device) - * - AT32UC3A3256S (USB Host and Device) - * - AT32UC3A4256 (USB Host and Device) - * - AT32UC3A4256S (USB Host and Device) - * - AT32UC3B0256 (USB Host and Device) - * - AT32UC3B1256 (USB Host and Device) - * - AT32UC3A0512 (USB Host and Device) - * - AT32UC3A1512 (USB Host and Device) - * - AT32UC3B0512 (USB Host and Device) - * - AT32UC3B1512 (USB Host and Device) + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
PartDevice ModeHost Mode
AT32UC3A064YesYes
AT32UC3A164YesYes
AT32UC3A364YesYes
AT32UC3A364SYesYes
AT32UC3A464YesYes
AT32UC3A464SYesYes
AT32UC3B064YesYes
AT32UC3B164YesYes
AT32UC3A0128YesYes
AT32UC3A1128YesYes
AT32UC3A3128YesYes
AT32UC3A3128SYesYes
AT32UC3A4128YesYes
AT32UC3A4128SYesYes
AT32UC3B0128YesYes
AT32UC3B1128YesYes
AT32UC3A0256YesYes
AT32UC3A1256YesYes
AT32UC3A3256YesYes
AT32UC3A3256SYesYes
AT32UC3A4256YesYes
AT32UC3A4256SYesYes
AT32UC3B0256YesYes
AT32UC3B1256YesYes
AT32UC3A0512YesYes
AT32UC3A1512YesYes
AT32UC3B0512YesYes
AT32UC3B1512YesYes
+ * + * \section Sec_UC3Support_Boards Supported Atmel Boards * * Currently supported Atmel UC3 boards (see \ref Group_BoardTypes): * - EVK1100 * - EVK1101 * - EVK1104 * - * Currently supported third-party boards (see \ref Group_BoardTypes for makefile BOARD constant names): - * - Custom User Boards (with Board Drivers if desired, see \ref Page_WritingBoardDrivers) + * \section Sec_UC3Support_ThirdParty Supported Third Party Models * - * \section Sec_XMEGA_Support Atmel USB XMEGA AVR (XMEGA) + * Currently supported third-party boards (see \ref Group_BoardTypes for makefile \c BOARD constant names): + * - Custom User Boards (with Board Drivers if desired, see \ref Page_WritingBoardDrivers) + */ + +/** + * \page Page_XMEGASupport Atmel USB XMEGA AVR (XMEGA) * Note: The XMEGA device support is currently experimental, and is included for preview purposes only. + * + * \section Sec_XMEGASupport_Devices Supported Microcontroller Models + * * Currently supported XMEGA models: - * - ATXMEGA16A4U (USB Device Only) - * - ATXMEGA32A4U (USB Device Only) - * - ATXMEGA64A3U (USB Device Only) - * - ATXMEGA128A3U (USB Device Only) - * - ATXMEGA192A3U (USB Device Only) - * - ATXMEGA256A3U (USB Device Only) - * - ATXMEGA256A3BU (USB Device Only) - * - ATXMEGA128A1U (USB Device Only) * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
PartDevice ModeHost Mode
ATXMEGA16A4UYesNo
ATXMEGA32A4UYesNo
ATXMEGA64A3UYesNo
ATXMEGA128A3UYesNo
ATXMEGA192A3UYesNo
ATXMEGA256A3UYesNo
ATXMEGA256A3BUYesNo
ATXMEGA128A1UYesNo
+ * + * \section Sec_XMEGASupport_Boards Supported Atmel Boards * Currently supported Atmel XMEGA boards (see \ref Group_BoardTypes): * - None * - * Currently supported third-party boards (see \ref Group_BoardTypes for makefile BOARD constant names): + * \section Sec_XMEGASupport_ThirdParty Supported Third Party Models + * Currently supported third-party boards (see \ref Group_BoardTypes for makefile \c BOARD constant names): * - Custom User Boards (with Board Drivers if desired, see \ref Page_WritingBoardDrivers) */ -- cgit v1.2.3