LUFA/ManPages/DirectorySummaries.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 /** \dir LUFA/Common
   8  *  \brief Common library header files.
   9  *
  10  *  This folder contains header files which are common to all parts of the LUFA library. They may be used freely in
  11  *  user applications.
  12  *
  13  *  \dir LUFA/Drivers
  14  *  \brief Library hardware and software drivers.
  15  *
  16  *  This folder contains all the library hardware and software drivers for each supported board and USB AVR
  17  *  microcontroller model.
  18  *
  19  *  \dir LUFA/Drivers/Misc
  20  *  \brief Miscellaneous driver files.
  21  *
  22  *  This folder contains drivers for aspects other than the USB interface, board hardware or AVR peripherals.
  23  *
  24  *  \dir LUFA/Drivers/Peripheral
  25  *  \brief USB AVR peripheral driver files.
  26  *
  27  *  This folder contains drivers for several of the AVR internal peripherals such as the USART, compatible with
  28  *  all USB AVR models.
  29  *
  30  *  \dir LUFA/Drivers/Peripheral/AVR8
  31  *  \brief 8-Bit AVR model peripheral driver files.
  32  *
  33  *  This folder contains drivers for several of the AVR internal peripherals such as the USART and ADC, on supported
  34  *  32-Bit AVR models. Its contents should <b>not</b> be included by the user application - the dispatch header file
  35  *  located in the parent directory should be used instead.
  36  *
  37  *  \dir LUFA/Drivers/Peripheral/AVR32
  38  *  \brief 32-Bit AVR model peripheral driver files.
  39  *
  40  *  This folder contains drivers for several of the AVR internal peripherals such as the USART and ADC, on supported
  41  *  8-Bit AVR models. Its contents should <b>not</b> be included by the user application - the dispatch header file
  42  *  located in the parent directory should be used instead.
  43  *
  44  *  \dir LUFA/Drivers/USB
  45  *  \brief USB controller peripheral driver files.
  46  *
  47  *  This folder contains the main header files required to implement the USB interface in the USB supporting AVR models.
  48  *  The header files contained directly in this folder should be included in the user application in order to gain USB
  49  *  functionality, and the appropriate C source files in the LowLevel and HighLevel driver folders added to the compile
  50  *  and link stages.
  51  *
  52  *  \dir LUFA/Drivers/USB/LowLevel
  53  *  \brief Low level USB driver files.
  54  *
  55  *  This folder contains low level USB driver source files required to implement USB functionality on the USB AVR microcontrollers.
  56  *
  57  *  \dir LUFA/Drivers/USB/HighLevel
  58  *  \brief High level USB driver files.
  59  *
  60  *  This folder contains high level USB driver source files required to implement USB functionality on the USB AVR microcontrollers.
  61  *
  62  *  \dir LUFA/Drivers/USB/Class
  63  *  \brief USB Class helper driver files.
  64  *
  65  *  This folder contains drivers for implementing functionality of standardized USB classes. These are not used directly by the library,
  66  *  but provide a standard and library-maintained way of implementing functionality from some of the defined USB classes without extensive
  67  *  development effort. Is is recommended that these drivers be used where possible to reduce maintenance of user applications.
  68  *
  69  *  \dir LUFA/Drivers/USB/Class/Device
  70  *  \brief USB Device Class helper driver files.
  71  *
  72  *  Device mode drivers for the standard USB classes.
  73  *
  74  *  \dir LUFA/Drivers/USB/Class/Host
  75  *  \brief USB Host Class helper driver files.
  76  *
  77  *  Host mode drivers for the standard USB classes.
  78  *
  79  *  \dir LUFA/Drivers/Board
  80  *  \brief Board hardware driver files.
  81  *
  82  *  This folder contains drivers for interfacing with the physical hardware on supported commercial boards, primarily from
  83  *  the Atmel corporation. Header files in this folder should be included in user applications requiring the functionality of
  84  *  hardware placed on supported boards.
  85  *
  86  *  \dir LUFA/Drivers/Board/USBKEY
  87  *  \brief USBKEY board hardware driver files.
  88  *
  89  *  This folder contains drivers for hardware on the Atmel USBKEY demonstration board. The header files in this folder should
  90  *  not be included directly in user applications; the similarly named dispatch header files located in the parent Board directory
  91  *  should be included instead.
  92  *
  93  *  \dir LUFA/Drivers/Board/STK526
  94  *  \brief STK526 board hardware driver files.
  95  *
  96  *  This folder contains drivers for hardware on the Atmel STK526 development board. The header files in this folder should
  97  *  not be included directly in user applications; the similarly named dispatch header files located in the parent Board directory
  98  *  should be included instead.
  99  *
 100  *  \dir LUFA/Drivers/Board/STK525
 101  *  \brief STK525 board hardware driver files.
 102  *
 103  *  This folder contains drivers for hardware on the Atmel STK525 development board. The header files in this folder should
 104  *  not be included directly in user applications; the similarly named dispatch header files located in the parent Board directory
 105  *  should be included instead.
 106  *
 107  *  \dir LUFA/Drivers/Board/RZUSBSTICK
 108  *  \brief RZUSBSTICK board hardware driver files.
 109  *
 110  *  This folder contains drivers for hardware on the Atmel RZUSBSTICK board, as used in the Atmel "Raven" wireless kits. The header
 111  *  files in this folder should not be included directly in user applications; the similarly named dispatch header files located in
 112  *  the parent Board directory should be included instead.
 113  *
 114  *  \dir LUFA/Drivers/Board/ATAVRUSBRF01
 115  *  \brief ATAVRUSBRF01 board hardware driver files.
 116  *
 117  *  This folder contains drivers for hardware on the Atmel ATAVRUSBRF01 board, as used in several Atmel wireless demo kits. The header
 118  *  files in this folder should not be included directly in user applications; the similarly named dispatch header files located in
 119  *  the parent Board directory should be included instead.
 120  *
 121  *  \dir LUFA/DriverStubs
 122  *  \brief Driver stub header files for custom boards, to allow the LUFA board drivers to operate.
 123  *
 124  *  This contains stub files for the LUFA board drivers. If the LUFA board drivers are used with board hardware other than those
 125  *  directly supported by the library, the BOARD parameter of the application's makefile can be set to "USER", and these stub files
 126  *  copied to the "/Board/" directory of the application's folder. When fleshed out with working driver code for the custom board,
 127  *  the corresponding LUFA board APIs will work correctly with the non-standard board hardware.
 128  */