MainPage.txt 4.82 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
/** \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.
 */

/**
 *  \mainpage About the LUFA (Formerly MyUSB) Library
 *
 *  Lightweight USB Framework for AVRs Library, written by Dean Camera.
 *
 *  \section Sec_About About this library
 *
 *  Originally based on the AT90USBKEY from Atmel, it is an open-source, driver for the USB-enabled AVR
15
16
17
 *  microcontrollers, released under the MIT license.
 *
 *  Currently supported AVR models:
18
 *   - AT90USB1286 (USB Device Only)
19
20
 *   - AT90USB1287 (USB Host and Device)
 *   - AT90USB646 (USB Device Only)
21
 *   - AT90USB647 (USB Host and Device)
22
 *   - AT90USB82 (USB Device Only)
23
 *   - AT90USB162 (USB Device Only)
24
25
 *   - ATMEGA16U4 (USB Device Only)
 *   - ATMEGA32U4 (USB Device Only)
26
 *   - ATMEGA32U6 (USB Device Only)
27
28
29
30
31
32
33
34
 *
 *  Currently supported Atmel boards:
 *   - AT90USBKEY
 *   - STK525
 *   - STK526
 *   - RZUSBSTICK
 *   - ATAVRUSBRF01
 *   - Custom User Boards
35
36
37
38
39
40
41
42
 *
 *  The library is currently in a stable release, suitable for download and incorporation into user projects for
 *  both host and device modes. For information about the project progression, check out my blog.
 *
 *  LUFA is written specifically for the free AVR-GCC compiler, and uses several GCC-only extensions to make the
 *  library API more streamlined and robust. You can download AVR-GCC for free in a convenient windows package, 
 *  from the the WinAVR website.
 *
43
 *
44
45
46
47
48
49
50
51
52
53
54
55
 *  \section Sec_Links Library Links
 *  Project Homepage: http://www.fourwalledcubicle.com/LUFA.php \n
 *  Development Blog: http://www.fourwalledcubicle.com/blog \n
 *  Discussion Group: http://groups.google.com/group/myusb-support-list \n
 *  SVN Access, Bug Reports and Feature Requests: http://code.google.com/p/lufa-lib/ \n
 *  Author's Website: http://www.fourwalledcubicle.com \n
 *
 *  WinAVR Website: http://winavr.sourceforge.net \n
 *  avr-libc Website: http://www.nongnu.org/avr-libc/ \n
 *
 *  USB-IF Website: http://www.usb.org \n
 *
56
 *
57
58
59
 *  \section Sec_License License
 *  The LUFA library is currently released under the MIT licence, included below.
 *
60
61
62
63
64
65
 *  Commercial entities can opt out of the public disclosure clause in this license
 *  for a one-time US$1500 payment. This provides a non-exclusive modified MIT licensed which
 *  allows for the free use of the LUFA library, bootloaders and (where the sole copyright
 *  is attributed to Dean Camera) demos without public disclosure within an organisation. Please
 *  contact the author for more information.
 *
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 *  \verbatim
 *  Permission to use, copy, modify, and distribute this software
 *  and its documentation for any purpose and without fee is hereby
 *  granted, provided that the above copyright notice appear in all
 *  copies and that both that the copyright notice and this
 *  permission notice and warranty disclaimer appear in supporting
 *  documentation, and that the name of the author not be used in
 *  advertising or publicity pertaining to distribution of the
 *  software without specific, written prior permission.
 *
 *  The author disclaim all warranties with regard to this
 *  software, including all implied warranties of merchantability
 *  and fitness.  In no event shall the author be liable for any
 *  special, indirect or consequential damages or any damages
 *  whatsoever resulting from loss of use, data or profits, whether
 *  in an action of contract, negligence or other tortious action,
 *  arising out of or in connection with the use or performance of
 *  this software.
 *  \endverbatim
 *
86
 *
87
88
89
90
 *  \section Sec_Demos Demos and Bootloaders
 *  The LUFA library ships with several different host and device demos, located in the /Demos/ subdirectory.
 *  If this directory is missing, please re-download the project from the project homepage.
 *
91
92
93
94
 *  Also included with the library are three fully functional bootloaders, located in the /Bootloaders/ subdirectory.
 *  The DFU class bootloader is compatible with Atmel's FLIP software or the open source dfu-programmer project, the
 *  CDC class (AVR109 protocol) is compatible with such open source software as AVRDUDE and AVR-OSP, and the TeensyLoader
 *  HID class bootloader is compatible with the software from PJRC (http://www.pjrc.com/teensy/index.html).
95
 *
96
 *
97
 *  \section Sec_Donations Donate
98
99
100
101
 *  I am a 20 year old University student studying for a double degree in Computer Science and Electronics Engineering.
 *  The development and support of this library requires much effort from myself. Please consider donating a small amount
 *  to myself to support this and my future Open Source projects. You can donate any amount via PayPal on my website, 
 *  http://www.fourwalledcubicle.com . All donations are greatly appreciated.
102
 */
103