ahoneybun/qmk_firmware
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add file-level brief documentation.

Browse source 
Remove accidentally duplicated model-specific peripheral driver files.
This commit is contained in:
Dean Camera 2010-03-29 07:49:58 +00:00
parent ec19436d54
commit 0557676013
111 changed files with 1039 additions and 453 deletions
Download patch file Download diff file Expand all files Collapse all files

12
LUFA/ManPages/AlternativeStacks.txt
View file

@ -7,17 +7,17 @@
/**
* \page Page_AlternativeStacks Alternative USB AVR Stacks
*
* LUFA is not the only stack available for the USB AVRs, although it is perhaps the best (\see Page_WhyUseLUFA).
* LUFA is not the only stack available for the USB AVRs, although it is perhaps the best (see \ref Page_WhyUseLUFA).
* In the interests of completeness and user choice, other known USB AVR stacks are listed here.
*
* - Atmel USB AVR Stack (<i>Atmel Inc.</i>) \n
* - <b>Name:</b> Atmel USB AVR Stack (<i>Atmel Inc.</i>) \n
* <b>Cost:</b> Free \n
* <b>License:</b> Atmel Limited License (see Atmel download for details) \n
* <b>Website:</b> http://atmel.com/dyn/products/app_notes.asp?family_id=607#USB \n
* <b>Description:</b> This is the official Atmel USB AVR stack, for their 8-bit USB AVR lineup. Each series of
* USB AVR is seperated into a seperate download stack, which is both AVR-GCC and IAR compatible.
*
* - Dr. Stefan Salewski's AT90USB1287 Stack (<i>Dr. Stefan Salewski</i>) \n
* - <b>Name:</b> Dr. Stefan Salewski's AT90USB1287 Stack (<i>Dr. Stefan Salewski</i>) \n
* <b>Cost:</b> Free \n
* <b>License:</b> GPL \n
* <b>Website:</b> http://www.ssalewski.de/AT90USB_firmware.html.en \n
@ -25,13 +25,13 @@
* German Physicist. It compiles for AVR-GCC and can potentially be modified to work on other USB
* AVR models.
*
* - PJRC Teensy Stack (<i>Paul Stoffregen</i>) \n
* - <b>Name:</b> PJRC Teensy Stack (<i>Paul Stoffregen</i>) \n
* <b>Cost:</b> Free \n
* <b>License:</b> BSD \n
* <b>Website:</b> http://www.pjrc.com/teensy/usb_debug_only.html \n
* <b>Description:</b> Not so much a complete stack as a collection of USB enabled demos, this library is specifically
* designed for the PJRC Teensy line of USB AVRs, and thus may need to be modified for other USB AVR
* chips. These code samples shows the inner workings of the USB controller, without all the abstraction
* present in most other USB AVR stacks.
* chips. These minimal code samples shows the inner workings of the USB controller, without all the
* abstraction present in most other USB AVR stacks.
*/

4
LUFA/ManPages/ChangeLog.txt
View file

@ -14,7 +14,7 @@
* - Added new Relay Controller Board project (thanks to OBinou)
*
* <b>Changed:</b>
* - AVRISP programmer project now has a more robust timeout system, allowing for an increse of the software USART speed
* - AVRISP programmer project now has a more robust timeout system, allowing for an increase of the software USART speed
* for PDI and TPI programming
* - Added a timeout value to the TWI_StartTransmission() function, within which the addressed device must respond
* - Webserver project now uses the board LEDs to indicate the current IP configuration state
@ -32,7 +32,7 @@
* - Fixed ADC routines not correctly returning the last result when multiple channels were read
* - Fixed ADC routines failing to read the extended channels (Channels 8 to 13, Internal Temperature Sensor) on the
* U4 series USB AVR parts
* - Fixed LowLevel MassStorage demo broken on the U2 AVRs due to double-banked endpoints
* - Fixed LowLevel MassStorage demo broken on the U2 series USB AVRs due to unsupported double-banked endpoint modes used
* - Fixed compilation error in the AudioInput demos when MICROPHONE_BIASED_TO_HALF_RAIL is defined (thanks to C. Scott Ananian)
* - Fixed incorrect definition of HID_ALIGN_DATA() causing incorrect HID report item data alignment
* - Fixed Still Image Host class driver not resetting the transaction ID when a new session is opened, fixed driver not sending

1
LUFA/ManPages/FutureChanges.txt
View file

@ -33,6 +33,7 @@
* -# Finish MIDI class Bootloader
* -# Finish SideShow demo
* -# Finish StandaloneProgrammer project
* -# Finish MIDIToneGenerator project
* - Ports
* -# AVR32 UC3B series microcontrollers
* -# Atmel ARM7 series microcontrollers

3
LUFA/ManPages/LibraryApps.txt
View file

@ -107,6 +107,9 @@
* - <b>USBtoSerial</b> - USB to USART Serial Converter project
* - <b>Webserver</b> - RNDIS Host Webserver with DHCP client, powered by uIP TCP/IP stack project and FatFS library
* - <b>XPLAINBridge</b> - XPLAIN alternative PDI Programmer/USB to Serial Bridge firmware project
* - <b>Incomplete</b>
* - <b>MIDIToneGenerator</b> - Incomplete MIDI Tone Generator application, to convert MIDI note messages into audio tones
* - <b>StandaloneProgrammer</b> - Incomplete Standalone AVR Programmer application, to program AVRs directly from a Mass Storage disk
*
* </small>
*/

6
LUFA/ManPages/Licence.txt
View file

@ -12,9 +12,9 @@
* 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 (<b>Note: Please do NOT pay this in advance through the
* donation link shown on \ref Page_Donating - contact author for payment details.</b>).
* is attributed to Dean Camera) demos without public disclosure within an organisation, in
* addition to three free hours of consultation with the library author, and priority support.
* Please contact the author for more information via the address shown on on \ref Page_Resources.
*
* \verbatim
* Permission to use, copy, modify, and distribute this software

14
LUFA/ManPages/MainPage.txt
View file

@ -7,15 +7,15 @@
/**
* \mainpage
*
* \n
* \image html LUFA.png
* <div align="center"><small><i>Logo design by <b>Ryo Yamauchi</b></i></small></div>
* \n
*
* <b>LUFA is donationware. For author and donation information, see \ref Page_Donating.</b>
*
* LUFA is an open-source USB library for the USB-enabled AVR microcontrollers, released under the MIT license. It supports
* a large number of USB AVR models and boards (see \ref Page_DeviceSupport). It is designed to provide an easy to use, feature
* rich framework for the development of USB peripherals and hosts.
* LUFA is an open-source USB library for the USB-enabled AVR microcontrollers, released under the MIT license (see \ref Page_Licence).
* It supports a large number of USB AVR models and boards (see \ref Page_DeviceSupport). It is designed to provide an easy to use,
* feature rich framework for the development of USB peripherals and hosts.
*
* LUFA focuses on the microcontroller side of USB development only; it includes no host USB driver development facilities. While
* custom USB devices can be made with LUFA, the included demos all use the inbuilt OS drivers for each USB class for simplicity.
@ -34,12 +34,10 @@
* and open source LUFA powered projects.
*
* <b>Subsections:</b>
* - \subpage Page_WhyUseLUFA Why Use LUFA?
* - \subpage Page_WhyUseLUFA What are the advantages of using LUFA?
* - \subpage Page_LUFAvsAtmelStack How does LUFA compare to the Atmel USB AVR stack?
* - \subpage Page_AlternativeStacks Alternative USB AVR Stacks
* - \subpage Page_Licence Project licence
* - \subpage Page_Licence Project source licence and commercial use information
* - \subpage Page_Donating Donating to support this project
* - \subpage Page_LibraryApps Overview of included Demos, Bootloaders and Projects
*
* <small><i>Logo design by <b>Ryo Yamauchi</b></i></small>
*/