diff options
author | Dean Camera <dean@fourwalledcubicle.com> | 2011-02-19 22:59:27 +0000 |
---|---|---|
committer | Dean Camera <dean@fourwalledcubicle.com> | 2011-02-19 22:59:27 +0000 |
commit | 1daa5e16f9a395fb2943906a715adb35b8106988 (patch) | |
tree | 016c5790c2b0e50753f9a4edda21ce54b40e914d /LUFA/ManPages | |
parent | 3832182fe1de292998eef73e00511f73af0efa87 (diff) | |
download | lufa-1daa5e16f9a395fb2943906a715adb35b8106988.tar.gz lufa-1daa5e16f9a395fb2943906a715adb35b8106988.tar.bz2 lufa-1daa5e16f9a395fb2943906a715adb35b8106988.zip |
Initial restructuring of the core USB driver module to support multiple architectures in the future.
Diffstat (limited to 'LUFA/ManPages')
-rw-r--r-- | LUFA/ManPages/DirectorySummaries.txt | 204 |
1 files changed, 130 insertions, 74 deletions
diff --git a/LUFA/ManPages/DirectorySummaries.txt b/LUFA/ManPages/DirectorySummaries.txt index a02d4076b..504742bf5 100644 --- a/LUFA/ManPages/DirectorySummaries.txt +++ b/LUFA/ManPages/DirectorySummaries.txt @@ -13,44 +13,31 @@ * \dir LUFA/Drivers * \brief Library hardware and software drivers. * - * This folder contains all the library hardware and software drivers for each supported board and USB AVR + * This folder contains all the library hardware and software drivers for each supported board, architecture and * microcontroller model. * * \dir LUFA/Drivers/Misc * \brief Miscellaneous driver files. * - * This folder contains drivers for aspects other than the USB interface, board hardware or AVR peripherals. + * This folder contains drivers for aspects other than the USB interface, board hardware or microcontroller peripherals. * * \dir LUFA/Drivers/Peripheral - * \brief USB AVR peripheral driver files. + * \brief Microcontroller peripheral driver files. * - * This folder contains drivers for several of the AVR internal peripherals such as the USART, compatible with - * all USB AVR models. - * - * \dir LUFA/Drivers/Peripheral/AVR8 - * \brief AVR8 AVR microcontroller model specific peripheral driver files. - * - * This folder contains drivers for several of the AVR internal peripherals such as the USART, compatible only with - * the 8-bit AVR microcontroller models, such as the AT90USB1287. Its contents should <b>not</b> be included by the - * user application - the dispatch header file located in the parent directory should be used instead. + * This folder contains drivers for various low level microcontroller peripherals, usually located on the microcontroller + * die within the same physical chip. * * \dir LUFA/Drivers/USB * \brief USB controller peripheral driver files. * - * This folder contains the main header files required to implement the USB interface in the USB supporting AVR models. - * The header files contained directly in this folder should be included in the user application in order to gain USB - * functionality, and the appropriate C source files in the LowLevel and HighLevel driver folders added to the compile - * and link stages. - * - * \dir LUFA/Drivers/USB/LowLevel - * \brief Low level USB driver files. + * This folder contains the complete LUFA USB stack and controller files, including the core driver and stack, as well + * as the USB class driver implementations. * - * This folder contains low level USB driver source files required to implement USB functionality on the USB AVR microcontrollers. + * \dir LUFA/Drivers/USB/Core + * \brief Core USB driver files. * - * \dir LUFA/Drivers/USB/HighLevel - * \brief High level USB driver files. - * - * This folder contains high level USB driver source files required to implement USB functionality on the USB AVR microcontrollers. + * This folder contains the core USB stack and controller driver files, to correctly implement USB functionality on the + * target architecture and microcontroller model. This * * \dir LUFA/Drivers/USB/Class * \brief USB Class helper driver files. @@ -76,34 +63,12 @@ * the Atmel corporation. Header files in this folder should be included in user applications requiring the functionality of * hardware placed on supported boards. * - * \dir LUFA/Drivers/Board/USBKEY - * \brief USBKEY board hardware driver files. - * - * This folder contains drivers for hardware on the Atmel USBKEY demonstration board. The header files in this folder should - * not be included directly in user applications; the similarly named dispatch header files located in the parent Board directory - * should be included instead. - * - * \dir LUFA/Drivers/Board/STK526 - * \brief STK526 board hardware driver files. - * - * This folder contains drivers for hardware on the Atmel STK526 development board. The header files in this folder should - * not be included directly in user applications; the similarly named dispatch header files located in the parent Board directory - * should be included instead. - * - * \dir LUFA/Drivers/Board/STK525 - * \brief STK525 board hardware driver files. - * - * This folder contains drivers for hardware on the Atmel STK525 development board. The header files in this folder should - * not be included directly in user applications; the similarly named dispatch header files located in the parent Board directory - * should be included instead. - * - * \dir LUFA/Drivers/Board/RZUSBSTICK - * \brief RZUSBSTICK board hardware driver files. - * - * This folder contains drivers for hardware on the Atmel RZUSBSTICK board, as used in the Atmel "Raven" wireless kits. The header - * files in this folder should not be included directly in user applications; the similarly named dispatch header files located in - * the parent Board directory should be included instead. + * \dir LUFA/Drivers/Board/ADAFRUITU4 + * \brief ADAFRUITU4 board hardware driver files. * + * This folder contains drivers for hardware on the Adafruit U4 breakout board (http://ladyada.net/products/atmega32u4breakout). + * The header files in this folder should not be included directly in user applications; the similarly named dispatch header files + * located in the parent Board directory should be included instead. * \dir LUFA/Drivers/Board/ATAVRUSBRF01 * \brief ATAVRUSBRF01 board hardware driver files. * @@ -111,6 +76,13 @@ * files in this folder should not be included directly in user applications; the similarly named dispatch header files located in * the parent Board directory should be included instead. * + * \dir LUFA/Drivers/Board/BENITO + * \brief BENITO board hardware driver files. + * + * This folder contains drivers for hardware on the Benito boards (http://dorkbotpdx.org/wiki/benito). The header files in this + * folder should not be included directly in user applications; the similarly named dispatch header files located in the parent + * Board directory should be included instead. + * * \dir LUFA/Drivers/Board/BUMBLEB * \brief BUMBLEB board hardware driver files. * @@ -118,12 +90,26 @@ * files in this folder should not be included directly in user applications; the similarly named dispatch header files located in * the parent Board directory should be included instead. * - * \dir LUFA/Drivers/Board/XPLAIN - * \brief XPLAIN board hardware driver files. + * \dir LUFA/Drivers/Board/BUI + * \brief BUI board hardware driver files. * - * This folder contains drivers for hardware on the Atmel XPLAIN board (all hardware revisions). The header files in this folder - * should not be included directly in user applications; the similarly named dispatch header files located in the parent Board - * directory should be included instead. + * This folder contains drivers for hardware on the Busware BUI (http://www.busware.de/tiki-index.php?page=BUI). + * The header files in this folder should not be included directly in user applications; the similarly named dispatch header files + * located in the parent Board directory should be included instead. + * + * \dir LUFA/Drivers/Board/BLACKCAT + * \brief BLACKCAT board hardware driver files. + * + * This folder contains drivers for hardware on the TCNISO Blackcat USB JTAG (http://www.embeddedcomputers.net/products/BlackcatUSB/. + * The header files in this folder should not be included directly in user applications; the similarly named dispatch header files + * located in the parent Board directory should be included instead. + * + * \dir LUFA/Drivers/Board/CULV3 + * \brief CULV3 board hardware driver files. + * + * This folder contains drivers for hardware on the Busware CUL V3 (http://busware.de/tiki-index.php?page=CUL). + * The header files in this folder should not be included directly in user applications; the similarly named dispatch header files + * located in the parent Board directory should be included instead. * * \dir LUFA/Drivers/Board/EVK527 * \brief XPLAIN board hardware driver files. @@ -132,31 +118,31 @@ * not be included directly in user applications; the similarly named dispatch header files located in the parent Board directory * should be included instead. * - * \dir LUFA/Drivers/Board/TEENSY - * \brief TEENSY board hardware driver files. + * \dir LUFA/Drivers/Board/JMDBU2 + * \brief JM-DB-U2 board hardware driver files. * - * This folder contains drivers for hardware on all revisions of the PJRC Teensy boards (http://www.pjrc.com/teensy/). The header - * files in this folder should not be included directly in user applications; the similarly named dispatch header files located - * in the parent Board directory should be included instead. + * This folder contains drivers for hardware on the JM-DB-U2 boards (http://u2.mattair.net/). The header files in this folder + * should not be included directly in user applications; the similarly named dispatch header files located in the parent Board + * directory should be included instead. * - * \dir LUFA/Drivers/Board/USBTINYMKII - * \brief USBTINY-MKII board hardware driver files. + * \dir LUFA/Drivers/Board/MAXIMUS + * \brief MAXIMUS board hardware driver files. * - * This folder contains drivers for hardware on all revisions of the USBTINY-MKII boards (http://tom-itx.dyndns.org:81/~webpage/). - * The header files in this folder should not be included directly in user applications; the similarly named dispatch header files - * located in the parent Board directory should be included instead. + * This folder contains drivers for hardware on the Maximus boards (http://www.avrusb.com/). The header files in this folder + * should not be included directly in user applications; the similarly named dispatch header files located in the parent Board + * directory should be included instead. * - * \dir LUFA/Drivers/Board/BENITO - * \brief BENITO board hardware driver files. + * \dir LUFA/Drivers/Board/MICROSIN162 + * \brief MICROSIN162 board hardware driver files. * - * This folder contains drivers for hardware on the Benito boards (http://dorkbotpdx.org/wiki/benito). The header files in this - * folder should not be included directly in user applications; the similarly named dispatch header files located in the parent - * Board directory should be included instead. + * This folder contains drivers for hardware on the Microsin AVR-USB162 board (http://microsin.ru/content/view/685/44/). The + * header files in this folder should not be included directly in user applications; the similarly named dispatch header files + * located in the parent Board directory should be included instead. * - * \dir LUFA/Drivers/Board/JMDBU2 - * \brief JM-DB-U2 board hardware driver files. + * \dir LUFA/Drivers/Board/MINIMUS + * \brief MINIMUS board hardware driver files. * - * This folder contains drivers for hardware on the JM-DB-U2 boards (http://u2.mattair.net/). The header files in this folder + * This folder contains drivers for hardware on the Minimus boards (http://www.minimususb.com/). The header files in this folder * should not be included directly in user applications; the similarly named dispatch header files located in the parent Board * directory should be included instead. * @@ -167,6 +153,55 @@ * The header files in this folder should not be included directly in user applications; the similarly named dispatch header files * located in the parent Board directory should be included instead. * + * \dir LUFA/Drivers/Board/RZUSBSTICK + * \brief RZUSBSTICK board hardware driver files. + * + * This folder contains drivers for hardware on the Atmel RZUSBSTICK board, as used in the Atmel "Raven" wireless kits. The header + * files in this folder should not be included directly in user applications; the similarly named dispatch header files located in + * the parent Board directory should be included instead. + * + * \dir LUFA/Drivers/Board/SPARKFUN8U2 + * \brief SPARKFUN8U2 board hardware driver files. + * + * This folder contains drivers for hardware on the Sparkfun ATMEGA8U2 breakout board (http://www.sparkfun.com/products/10277). The + * header files in this folder should not be included directly in user applications; the similarly named dispatch header files located + * in the parent Board directory should be included instead. + * + * \dir LUFA/Drivers/Board/STK525 + * \brief STK525 board hardware driver files. + * + * This folder contains drivers for hardware on the Atmel STK525 development board. The header files in this folder should + * not be included directly in user applications; the similarly named dispatch header files located in the parent Board directory + * should be included instead. + * + * \dir LUFA/Drivers/Board/STK526 + * \brief STK526 board hardware driver files. + * + * This folder contains drivers for hardware on the Atmel STK526 development board. The header files in this folder should + * not be included directly in user applications; the similarly named dispatch header files located in the parent Board directory + * should be included instead. + * + * \dir LUFA/Drivers/Board/TEENSY + * \brief TEENSY board hardware driver files. + * + * This folder contains drivers for hardware on all revisions of the PJRC Teensy boards (http://www.pjrc.com/teensy/). The header + * files in this folder should not be included directly in user applications; the similarly named dispatch header files located + * in the parent Board directory should be included instead. + * + * \dir LUFA/Drivers/Board/UDIP + * \brief UDIP board hardware driver files. + * + * This folder contains drivers for hardware on the Linnix UDIP boards (http://linnix.com/udip/). + * The header files in this folder should not be included directly in user applications; the similarly named dispatch header files + * located in the parent Board directory should be included instead. + * + * \dir LUFA/Drivers/Board/UNO + * \brief UNO board hardware driver files. + * + * This folder contains drivers for hardware on the Arduino Uno boards (http://www.arduino.cc). + * The header files in this folder should not be included directly in user applications; the similarly named dispatch header files + * located in the parent Board directory should be included instead. + * * \dir LUFA/Drivers/Board/USBFOO * \brief USBFOO board hardware driver files. * @@ -174,6 +209,27 @@ * The header files in this folder should not be included directly in user applications; the similarly named dispatch header files * located in the parent Board directory should be included instead. * + * \dir LUFA/Drivers/Board/USBKEY + * \brief USBKEY board hardware driver files. + * + * This folder contains drivers for hardware on the Atmel USBKEY demonstration board. The header files in this folder should + * not be included directly in user applications; the similarly named dispatch header files located in the parent Board directory + * should be included instead. + * + * \dir LUFA/Drivers/Board/USBTINYMKII + * \brief USBTINY-MKII board hardware driver files. + * + * This folder contains drivers for hardware on all revisions of the USBTINY-MKII boards (http://tom-itx.dyndns.org:81/~webpage/). + * The header files in this folder should not be included directly in user applications; the similarly named dispatch header files + * located in the parent Board directory should be included instead. + * + * \dir LUFA/Drivers/Board/XPLAIN + * \brief XPLAIN board hardware driver files. + * + * This folder contains drivers for hardware on the Atmel XPLAIN board (all hardware revisions). The header files in this folder + * should not be included directly in user applications; the similarly named dispatch header files located in the parent Board + * directory should be included instead. + * * \dir LUFA/CodeTemplates * \brief Code templates for use in LUFA powered applications. * |