Keyboard firmwares for Atmel AVR and Cortex-M
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

DirectorySummaries.txt 3.6KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  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. /** \dir Platform
  7. * \brief Platform specific drivers.
  8. *
  9. * This folder contains platform specific drivers and defines for various supported architectures. These may or may
  10. * not be used in a LUFA application, and are provided for convenience purposes.
  11. *
  12. * \dir Drivers
  13. * \brief Library hardware and software drivers.
  14. *
  15. * This folder contains all the library hardware and software drivers for each supported board, architecture and
  16. * microcontroller model.
  17. *
  18. * \dir Drivers/Misc
  19. * \brief Miscellaneous driver files.
  20. *
  21. * This folder contains drivers for aspects other than the USB interface, board hardware or microcontroller peripherals.
  22. *
  23. * \dir Drivers/Peripheral
  24. * \brief Microcontroller peripheral driver files.
  25. *
  26. * This folder contains drivers for various low level microcontroller peripherals, usually located on the microcontroller
  27. * die within the same physical chip.
  28. *
  29. * \dir Drivers/USB
  30. * \brief USB controller peripheral driver files.
  31. *
  32. * This folder contains the complete LUFA USB stack and controller files, including the core driver and stack, as well
  33. * as the USB class driver implementations.
  34. *
  35. * \dir Drivers/USB/Core
  36. * \brief Core USB driver files.
  37. *
  38. * This folder contains the core USB stack and controller driver files, to correctly implement USB functionality on the
  39. * target architecture and microcontroller model. This
  40. *
  41. * \dir Drivers/USB/Class
  42. * \brief USB Class helper driver files.
  43. *
  44. * This folder contains drivers for implementing functionality of standardized USB classes. These are not used directly by the library,
  45. * but provide a standard and library-maintained way of implementing functionality from some of the defined USB classes without extensive
  46. * development effort. Is is recommended that these drivers be used where possible to reduce maintenance of user applications.
  47. *
  48. * \dir Drivers/USB/Class/Device
  49. * \brief USB Device Class helper driver files.
  50. *
  51. * Device mode drivers for the standard USB classes.
  52. *
  53. * \dir Drivers/USB/Class/Host
  54. * \brief USB Host Class helper driver files.
  55. *
  56. * Host mode drivers for the standard USB classes.
  57. *
  58. * \dir Drivers/Board
  59. * \brief Board hardware driver files.
  60. *
  61. * This folder contains drivers for interfacing with the physical hardware on supported commercial boards, primarily from
  62. * the Atmel corporation. Header files in this folder should be included in user applications requiring the functionality of
  63. * hardware placed on supported boards.
  64. *
  65. * \dir CodeTemplates
  66. * \brief Code templates for use in LUFA powered applications.
  67. *
  68. * This contains code templates for board drivers, sample LUFA project makefiles and other similar templates that can be copied into
  69. * a LUFA powered application and modified to speed up development.
  70. *
  71. * \dir CodeTemplates/DriverStubs
  72. * \brief Driver stub header files for custom boards, to allow the LUFA board drivers to operate.
  73. *
  74. * This contains stub files for the LUFA board drivers. If the LUFA board drivers are used with board hardware other than those
  75. * directly supported by the library, the BOARD parameter of the application's makefile can be set to "USER", and these stub files
  76. * copied to the "/Board/" directory of the application's folder. When fleshed out with working driver code for the custom board,
  77. * the corresponding LUFA board APIs will work correctly with the non-standard board hardware.
  78. */