LUFA/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 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 MemoryAllocator
  14  *  \brief Auto-defragmenting dynamic memory allocation library.
  15  *
  16  *  This folder contains a simple handle-based dynamic memory allocation library, capable of handing out memory in
  17  *  block chunks. As new memory is allocated, the library will defragment the already allocated memory to ensure
  18  *  optimal memory usage. It is not used within the LUFA library, and is provided as a convenience for user applications.
  19  *
  20  *  \dir Scheduler
  21  *  \brief Simple round-robbin scheduler.
  22  *
  23  *  This folder contains the simple LUFA round-robbin scheduler, provided as a convenience for user applications. It
  24  *  is very simple in design, and is intended to make code easier to read, rather than providing a complete RTOS kernel.
  25  *
  26  *  \dir Drivers
  27  *  \brief Library hardware and software drivers.
  28  *
  29  *  This folder contains all the library hardware and software drivers for each supported board and USB AVR
  30  *  microcontroller model.
  31  *
  32  *  \dir Drivers/Misc
  33  *  \brief Miscellaneous driver files.
  34  *
  35  *  This folder contains drivers for aspects other than the USB interface, board hardware or AVR peripherals.
  36  *
  37  *  \dir Drivers/AT90USBXXX
  38  *  \brief USB AVR peripheral driver files.
  39  *
  40  *  This folder contains drivers for several of the AVR internal peripherals such as the USART, compatible with
  41  *  all USB AVR models.
  42  *
  43  *  \dir Drivers/AT90USBXXX/AT90USBXXX67
  44  *  \brief AT90USBXXX6, AT90USBXXX7 and ATMEGAXXU4 AVR model peripheral driver files. Its original name is due to legacy
  45  *  reasons.
  46  *
  47  *  This folder contains drivers for several of the AVR internal peripherals such as the USART, compatible only with
  48  *  the AT90USBXXX6, AT90USBXXX7 and ATMEGAXXU4 USB AVR models, such as the AT90USB1287. Its contents should <b>not</b> be
  49  *  included by the user application - the dispatch header file located in the parent AT90USBXXX directory should be used
  50  *  instead.
  51  *
  52  *  \dir Drivers/USB
  53  *  \brief USB controller peripheral driver files.
  54  *
  55  *  This folder contains the main header files required to implement the USB interface in the USB supporting AVR models.
  56  *  The header files contained directly in this folder should be included in the user application in order to gain USB
  57  *  functionality, and the appropriate C source files in the LowLevel and HighLevel driver folders added to the compile
  58  *  and link stages.
  59  *
  60  *  \dir Drivers/USB/LowLevel
  61  *  \brief Low level USB driver files.
  62  *
  63  *  This folder contains low level USB driver source files required to implement USB functionality on the USB AVR microcontrollers.
  64  *
  65  *  \dir Drivers/USB/HighLevel
  66  *  \brief High level USB driver files.
  67  *
  68  *  This folder contains high level USB driver source files required to implement USB functionality on the USB AVR microcontrollers.
  69  *
  70  *  \dir Drivers/USB/Class
  71  *  \brief USB Class helper driver files.
  72  *
  73  *  This folder contains drivers for implementing functionality of standardized USB classes. These are not used directly by the library,
  74  *  but provide a standard and library-maintained way of implementing functionality from some of the defined USB classes without extensive
  75  *  development effort. Is is recommended that these drivers be used where possible to reduce maintenance of user applications.
  76  *
  77  *  \dir Drivers/Board
  78  *  \brief Board hardware driver files.
  79  *
  80  *  This folder contains drivers for interfacing with the physical hardware on supported commercial boards, primarily from
  81  *  the Atmel corporation. Header files in this folder should be included in user applications requring the functionality of
  82  *  hardware placed on supported boards.
  83  *
  84  *  \dir Drivers/Board/USBKEY
  85  *  \brief USBKEY board hardware driver files.
  86  *
  87  *  This folder contains drivers for hardware on the Atmel USBKEY demonstration board. The header files in this folder should
  88  *  not be included directly in user applications; the similarly named dispatch header files located in the parent Board directory
  89  *  should be included instead.
  90  *
  91  *  \dir Drivers/Board/STK526
  92  *  \brief STK526 board hardware driver files.
  93  *
  94  *  This folder contains drivers for hardware on the Atmel STK526 development board. The header files in this folder should
  95  *  not be included directly in user applications; the similarly named dispatch header files located in the parent Board directory
  96  *  should be included instead.
  97  *
  98  *  \dir Drivers/Board/STK525
  99  *  \brief STK525 board hardware driver files.
 100  *
 101  *  This folder contains drivers for hardware on the Atmel STK525 development board. The header files in this folder should
 102  *  not be included directly in user applications; the similarly named dispatch header files located in the parent Board directory
 103  *  should be included instead.
 104  *
 105  *  \dir Drivers/Board/RZUSBSTICK
 106  *  \brief RZUSBSTICK board hardware driver files.
 107  *
 108  *  This folder contains drivers for hardware on the Atmel RZUSBSTICK board, as used in the Atmel "Raven" wireless kits. The header
 109  *  files in this folder should not be included directly in user applications; the similarly named dispatch header files located in
 110  *  the parent Board directory should be included instead.
 111  *
 112  *  \dir Drivers/Board/ATAVRUSBRF01
 113  *  \brief ATAVRUSBRF01 board hardware driver files.
 114  *
 115  *  This folder contains drivers for hardware on the Atmel ATAVRUSBRF01 board, as used in several Atmel wireless demo kits. The header
 116  *  files in this folder should not be included directly in user applications; the similarly named dispatch header files located in
 117  *  the parent Board directory should be included instead.
 118  *
 119  *  \dir DriverStubs
 120  *  \brief Driver stub header files for custom boards, to allow the LUFA board drivers to operate.
 121  *
 122  *  This contains stub files for the LUFA board drivers. If the LUFA board drivers are used with board hardare other than those
 123  *  directly supported by the library, the BOARD parameter of the application's makefile can be set to "USER", and these stub files
 124  *  copied to the "/Board/" directory of the application's folder. When fleshed out with working driver code for the custom board,
 125  *  the corresponding LUFA board APIs will work correctly with the non-standard board hardware.
 126  */