Statistics
| Branch: | Tag: | Revision:

root / LUFA / ManPages / DirectorySummaries.txt @ 978b99e5

History | View | Annotate | Download (13.7 KB)

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, architecture and
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 microcontroller peripherals.
23
 *
24
 *  \dir LUFA/Drivers/Peripheral
25
 *  \brief Microcontroller peripheral driver files.
26
 *
27
 *  This folder contains drivers for various low level microcontroller peripherals, usually located on the microcontroller
28
 *  die within the same physical chip.
29
 *
30
 *  \dir LUFA/Drivers/USB
31
 *  \brief USB controller peripheral driver files.
32
 *
33
 *  This folder contains the complete LUFA USB stack and controller files, including the core driver and stack, as well
34
 *  as the USB class driver implementations.
35
 *
36
 *  \dir LUFA/Drivers/USB/Core
37
 *  \brief Core USB driver files.
38
 *
39
 *  This folder contains the core USB stack and controller driver files, to correctly implement USB functionality on the
40
 *  target architecture and microcontroller model. This
41
 *
42
 *  \dir LUFA/Drivers/USB/Class
43
 *  \brief USB Class helper driver files.
44
 *
45
 *  This folder contains drivers for implementing functionality of standardized USB classes. These are not used directly by the library,
46
 *  but provide a standard and library-maintained way of implementing functionality from some of the defined USB classes without extensive
47
 *  development effort. Is is recommended that these drivers be used where possible to reduce maintenance of user applications.
48
 *
49
 *  \dir LUFA/Drivers/USB/Class/Device
50
 *  \brief USB Device Class helper driver files.
51
 *
52
 *  Device mode drivers for the standard USB classes.
53
 *
54
 *  \dir LUFA/Drivers/USB/Class/Host
55
 *  \brief USB Host Class helper driver files.
56
 *
57
 *  Host mode drivers for the standard USB classes.
58
 *
59
 *  \dir LUFA/Drivers/Board
60
 *  \brief Board hardware driver files.
61
 *
62
 *  This folder contains drivers for interfacing with the physical hardware on supported commercial boards, primarily from
63
 *  the Atmel corporation. Header files in this folder should be included in user applications requiring the functionality of
64
 *  hardware placed on supported boards.
65
 *
66
 *  \dir LUFA/Drivers/Board/AVR8/ADAFRUITU4
67
 *  \brief ADAFRUITU4 board hardware driver files.
68
 *
69
 *  This folder contains drivers for hardware on the Adafruit U4 breakout board (http://ladyada.net/products/atmega32u4breakout).
70
 *  The header files in this folder should not be included directly in user applications; the similarly named dispatch header files
71
 *  located in the parent Board directory should be included instead.
72
 *  \dir LUFA/Drivers/Board/AVR8/ATAVRUSBRF01
73
 *  \brief ATAVRUSBRF01 board hardware driver files.
74
 *
75
 *  This folder contains drivers for hardware on the Atmel ATAVRUSBRF01 board, as used in several Atmel wireless demo kits. The header
76
 *  files in this folder should not be included directly in user applications; the similarly named dispatch header files located in
77
 *  the parent Board directory should be included instead.
78
 *
79
 *  \dir LUFA/Drivers/Board/AVR8/BENITO
80
 *  \brief BENITO board hardware driver files.
81
 *
82
 *  This folder contains drivers for hardware on the Benito boards (http://dorkbotpdx.org/wiki/benito). The header files in this
83
 *  folder should not be included directly in user applications; the similarly named dispatch header files located in the parent
84
 *  Board directory should be included instead.
85
 *
86
 *  \dir LUFA/Drivers/Board/AVR8/BUMBLEB
87
 *  \brief BUMBLEB board hardware driver files.
88
 *
89
 *  This folder contains drivers for hardware on the Fletchtronics Bumble-B board (http://fletchtronics.net/bumble-b). The header
90
 *  files in this folder should not be included directly in user applications; the similarly named dispatch header files located in
91
 *  the parent Board directory should be included instead.
92
 *
93
 *  \dir LUFA/Drivers/Board/AVR8/BUI
94
 *  \brief BUI board hardware driver files.
95
 *
96
 *  This folder contains drivers for hardware on the Busware BUI (http://www.busware.de/tiki-index.php?page=BUI).
97
 *  The header files in this folder should not be included directly in user applications; the similarly named dispatch header files
98
 *  located in the parent Board directory should be included instead. 
99
 *
100
 *  \dir LUFA/Drivers/Board/AVR8/BLACKCAT
101
 *  \brief BLACKCAT board hardware driver files.
102
 *
103
 *  This folder contains drivers for hardware on the TCNISO Blackcat USB JTAG (http://www.embeddedcomputers.net/products/BlackcatUSB/.
104
 *  The header files in this folder should not be included directly in user applications; the similarly named dispatch header files
105
 *  located in the parent Board directory should be included instead.
106
 *
107
 *  \dir LUFA/Drivers/Board/AVR8/CULV3
108
 *  \brief CULV3 board hardware driver files.
109
 *
110
 *  This folder contains drivers for hardware on the Busware CUL V3 (http://busware.de/tiki-index.php?page=CUL).
111
 *  The header files in this folder should not be included directly in user applications; the similarly named dispatch header files
112
 *  located in the parent Board directory should be included instead.
113
 *
114
 *  \dir LUFA/Drivers/Board/AVR8/EVK527
115
 *  \brief EVK527 board hardware driver files.
116
 *
117
 *  This folder contains drivers for hardware on the Atmel EVK527 development board. The header files in this folder should
118
 *  not be included directly in user applications; the similarly named dispatch header files located in the parent Board directory
119
 *  should be included instead.
120
 *
121
 *  \dir LUFA/Drivers/Board/AVR8/JMDBU2
122
 *  \brief JM-DB-U2 board hardware driver files.
123
 *
124
 *  This folder contains drivers for hardware on the JM-DB-U2 boards (http://u2.mattair.net/). The header files in this folder
125
 *  should not be included directly in user applications; the similarly named dispatch header files located in the parent Board
126
 *  directory should be included instead.
127
 *
128
 *  \dir LUFA/Drivers/Board/AVR8/MAXIMUS
129
 *  \brief MAXIMUS board hardware driver files.
130
 *
131
 *  This folder contains drivers for hardware on the Maximus boards (http://www.avrusb.com/). The header files in this folder
132
 *  should not be included directly in user applications; the similarly named dispatch header files located in the parent Board
133
 *  directory should be included instead.
134
 *
135
 *  \dir LUFA/Drivers/Board/AVR8/MICROSIN162
136
 *  \brief MICROSIN162 board hardware driver files.
137
 *
138
 *  This folder contains drivers for hardware on the Microsin AVR-USB162 board (http://microsin.ru/content/view/685/44/). The
139
 *  header files in this folder should not be included directly in user applications; the similarly named dispatch header files
140
 *  located in the parent Board directory should be included instead.
141
 *
142
 *  \dir LUFA/Drivers/Board/AVR8/MINIMUS
143
 *  \brief MINIMUS board hardware driver files.
144
 *
145
 *  This folder contains drivers for hardware on the Minimus boards (http://www.minimususb.com/). The header files in this folder
146
 *  should not be included directly in user applications; the similarly named dispatch header files located in the parent Board
147
 *  directory should be included instead.
148
 *
149
 *  \dir LUFA/Drivers/Board/AVR8/OLIMEX162
150
 *  \brief Olimex USB-STK-162 board hardware driver files.
151
 *
152
 *  This folder contains drivers for hardware on the Olimex AVR-USB-162 boards (http://www.olimex.com/dev/avr-usb-162.html).
153
 *  The header files in this folder should not be included directly in user applications; the similarly named dispatch header files
154
 *  located in the parent Board directory should be included instead.
155
 *
156
 *  \dir LUFA/Drivers/Board/AVR8/RZUSBSTICK
157
 *  \brief RZUSBSTICK board hardware driver files.
158
 *
159
 *  This folder contains drivers for hardware on the Atmel RZUSBSTICK board, as used in the Atmel "Raven" wireless kits. The header
160
 *  files in this folder should not be included directly in user applications; the similarly named dispatch header files located in
161
 *  the parent Board directory should be included instead.
162
 *
163
 *  \dir LUFA/Drivers/Board/AVR8/SPARKFUN8U2
164
 *  \brief SPARKFUN8U2 board hardware driver files.
165
 *
166
 *  This folder contains drivers for hardware on the Sparkfun ATMEGA8U2 breakout board (http://www.sparkfun.com/products/10277). The
167
 *  header files in this folder should not be included directly in user applications; the similarly named dispatch header files located
168
 *  in the parent Board directory should be included instead.
169
 *
170
 *  \dir LUFA/Drivers/Board/AVR8/STK525
171
 *  \brief STK525 board hardware driver files.
172
 *
173
 *  This folder contains drivers for hardware on the Atmel STK525 development board. The header files in this folder should
174
 *  not be included directly in user applications; the similarly named dispatch header files located in the parent Board directory
175
 *  should be included instead.
176
 *
177
 *  \dir LUFA/Drivers/Board/AVR8/STK526
178
 *  \brief STK526 board hardware driver files.
179
 *
180
 *  This folder contains drivers for hardware on the Atmel STK526 development board. The header files in this folder should
181
 *  not be included directly in user applications; the similarly named dispatch header files located in the parent Board directory
182
 *  should be included instead.
183
 *
184
 *  \dir LUFA/Drivers/Board/AVR8/TEENSY
185
 *  \brief TEENSY board hardware driver files.
186
 *
187
 *  This folder contains drivers for hardware on all revisions of the PJRC Teensy boards (http://www.pjrc.com/teensy/). The header
188
 *  files in this folder should not be included directly in user applications; the similarly named dispatch header files located
189
 *  in the parent Board directory should be included instead.
190
 *
191
 *  \dir LUFA/Drivers/Board/AVR8/TUL
192
 *  \brief TUL board hardware driver files.
193
 *
194
 *  This folder contains drivers for hardware on the Busware TUL (http://busware.de/tiki-index.php?page=TUL).
195
 *  The header files in this folder should not be included directly in user applications; the similarly named dispatch header files
196
 *  located in the parent Board directory should be included instead.
197
 *
198
 *  \dir LUFA/Drivers/Board/AVR8/UDIP
199
 *  \brief UDIP board hardware driver files.
200
 *
201
 *  This folder contains drivers for hardware on the Linnix UDIP boards (http://linnix.com/udip/).
202
 *  The header files in this folder should not be included directly in user applications; the similarly named dispatch header files
203
 *  located in the parent Board directory should be included instead.
204
 *
205
 *  \dir LUFA/Drivers/Board/AVR8/UNO
206
 *  \brief UNO board hardware driver files.
207
 *
208
 *  This folder contains drivers for hardware on the Arduino Uno boards (http://www.arduino.cc).
209
 *  The header files in this folder should not be included directly in user applications; the similarly named dispatch header files
210
 *  located in the parent Board directory should be included instead.
211
 *
212
 *  \dir LUFA/Drivers/Board/AVR8/USBFOO
213
 *  \brief USBFOO board hardware driver files.
214
 *
215
 *  This folder contains drivers for hardware on the USBFOO boards (http://shop.kernelconcepts.de/product_info.php?products_id=102).
216
 *  The header files in this folder should not be included directly in user applications; the similarly named dispatch header files
217
 *  located in the parent Board directory should be included instead.
218
 *
219
 *  \dir LUFA/Drivers/Board/AVR8/USBKEY
220
 *  \brief USBKEY board hardware driver files.
221
 *
222
 *  This folder contains drivers for hardware on the Atmel USBKEY demonstration board. The header files in this folder should
223
 *  not be included directly in user applications; the similarly named dispatch header files located in the parent Board directory
224
 *  should be included instead.
225
 *
226
 *  \dir LUFA/Drivers/Board/AVR8/USBTINYMKII
227
 *  \brief USBTINY-MKII board hardware driver files.
228
 *
229
 *  This folder contains drivers for hardware on all revisions of the USBTINY-MKII boards (http://tom-itx.dyndns.org:81/~webpage/).
230
 *  The header files in this folder should not be included directly in user applications; the similarly named dispatch header files
231
 *  located in the parent Board directory should be included instead.
232
 *
233
 *  \dir LUFA/Drivers/Board/AVR8/XPLAIN
234
 *  \brief XPLAIN board hardware driver files.
235
 *
236
 *  This folder contains drivers for hardware on the Atmel XPLAIN board (all hardware revisions). The header files in this folder
237
 *  should not be included directly in user applications; the similarly named dispatch header files located in the parent Board
238
 *  directory should be included instead.
239
 *
240
 *  \dir LUFA/CodeTemplates
241
 *  \brief Code templates for use in LUFA powered applications.
242
 *
243
 *  This contains code templates for board drivers, sample LUFA project makefiles and other similar templates that can be copied into
244
 *  a LUFA powered application and modified to speed up development.
245
 *
246
 *  \dir LUFA/CodeTemplates/DriverStubs
247
 *  \brief Driver stub header files for custom boards, to allow the LUFA board drivers to operate.
248
 *
249
 *  This contains stub files for the LUFA board drivers. If the LUFA board drivers are used with board hardware other than those
250
 *  directly supported by the library, the BOARD parameter of the application's makefile can be set to "USER", and these stub files
251
 *  copied to the "/Board/" directory of the application's folder. When fleshed out with working driver code for the custom board,
252
 *  the corresponding LUFA board APIs will work correctly with the non-standard board hardware.
253
 */
254