aboutsummaryrefslogtreecommitdiffstats
path: root/LUFA/ManPages/DirectorySummaries.txt
blob: 36ba26d6569c9e17d6146bed632f2163dce2c723 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
/** \file
 *
 *  This file contains special DoxyGen information for the generation of the main page and other special
 *  documentation pages. It is not a project source file.
 */

/** \dir LUFA/Common
 *  \brief Common library header files.
 *
 *  This folder contains header files which are common to all parts of the LUFA library. They may be used freely in
 *  user applications.
 *
 *  \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
 *  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.
 *
 *  \dir LUFA/Drivers/Peripheral
 *  \brief USB AVR 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/AVRU4U6U7
 *  \brief AT90USBXXX6, AT90USBXXX7 and ATMEGAXXU4 AVR model peripheral driver files.
 *
 *  This folder contains drivers for several of the AVR internal peripherals such as the USART, compatible only with
 *  the AT90USBXXX6, AT90USBXXX7 and ATMEGAXXU4 USB AVR 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.
 *
 *  \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 low level USB driver source files required to implement USB functionality on the USB AVR microcontrollers.
 *
 *  \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.
 *
 *  \dir LUFA/Drivers/USB/Class
 *  \brief USB Class helper driver files.
 *
 *  This folder contains drivers for implementing functionality of standardized USB classes. These are not used directly by the library,
 *  but provide a standard and library-maintained way of implementing functionality from some of the defined USB classes without extensive
 *  development effort. Is is recommended that these drivers be used where possible to reduce maintenance of user applications.
 *
 *  \dir LUFA/Drivers/USB/Class/Device
 *  \brief USB Device Class helper driver files.
 *
 *  Device mode drivers for the standard USB classes.
 *
 *  \dir LUFA/Drivers/USB/Class/Host
 *  \brief USB Host Class helper driver files.
 *
 *  Host mode drivers for the standard USB classes.
 *
 *  \dir LUFA/Drivers/Board
 *  \brief Board hardware driver files.
 *
 *  This folder contains drivers for interfacing with the physical hardware on supported commercial boards, primarily from
 *  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/ATAVRUSBRF01
 *  \brief ATAVRUSBRF01 board hardware driver files.
 *
 *  This folder contains drivers for hardware on the Atmel ATAVRUSBRF01 board, as used in several Atmel wireless demo 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/BUMBLEB
 *  \brief BUMBLEB board hardware driver files.
 *
 *  This folder contains drivers for hardware on the Fletchtronics Bumble-B board (http://fletchtronics.net/bumble-b). 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/Drivers/Board/EVK527
 *  \brief XPLAIN board hardware driver files.
 *
 *  This folder contains drivers for hardware on the Atmel EVK527 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/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/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/JMDBU2
 *  \brief JM-DB-U2 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
 *  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/OLIMEX162
 *  \brief Olimex USB-STK-162 board hardware driver files.
 *
 *  This folder contains drivers for hardware on the Olimex AVR-USB-162 boards (http://www.olimex.com/dev/avr-usb-162.html).
 *  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.
 *
 *  This folder contains drivers for hardware on the USBFOO boards (http://shop.kernelconcepts.de/product_info.php?products_id=102).
 *  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.
 *
 *  This contains code templates for board drivers, sample LUFA project makefiles and other similar templates that can be copied into
 *  a LUFA powered application and modified to speed up development.
 *
 *  \dir LUFA/CodeTemplates/DriverStubs
 *  \brief Driver stub header files for custom boards, to allow the LUFA board drivers to operate.
 *
 *  This contains stub files for the LUFA board drivers. If the LUFA board drivers are used with board hardware other than those
 *  directly supported by the library, the BOARD parameter of the application's makefile can be set to "USER", and these stub files
 *  copied to the "/Board/" directory of the application's folder. When fleshed out with working driver code for the custom board,
 *  the corresponding LUFA board APIs will work correctly with the non-standard board hardware.
 */