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

Minor documentation updates.

Browse source
This commit is contained in:
Dean Camera 2011-03-05 10:58:35 +00:00
parent c1c94fe5a0
commit 33a81bffb9
3 changed files with 16 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

5
LUFA/ManPages/ChangeLog.txt
View file

@ -14,7 +14,7 @@
* - Added a new general RingBuff.h miscellaneous ring buffer library driver header
* - Added new GCC_FORCE_POINTER_ACCESS() macro to correct GCC's mishandling of struct pointer accesses
* - Added basic driver example use code to the library documentation
* - Added new Endpoint_Null_Stream() and Pipe_Null_stream() functions
* - Added new Endpoint_Null_Stream() and Pipe_Null_Stream() functions
* - Added new ADC_GET_CHANNEL_MASK() convenience macro
* - Added new HID report item macros (with HID_RI_ prefix) to allow for easy creation and editing of HID report descriptors
* - Added new HID_DESCRIPTOR_MOUSE, HID_DESCRIPTOR_KEYBOARD, HID_DESCRIPTOR_JOYSTICK and HID_DESCRIPTOR_VENDOR macros
@ -80,6 +80,9 @@
* error code enum (thanks to Daniel Seibert)
* - Fixed ReportID not being removed from the feature/out report data array in the HID class driver when Report IDs are used
* - Fixed incorect BUTTONS_BUTTON1 definition for the Minimus board
* - Fixed Still Image Host class driver exiting the descriptor search routine prematurely if the data pipes (but not event pipe)
* is found
* - Fixed missing call to Pipe_SetInfiniteINRequests() in the Pipe_ConfigurePipe() routine
* - Library Applications:
* - Fixed Benito project discarding incoming data from the USB virtual serial port when the USART is busy
* - Fixed broken DFU bootloader, added XPLAIN support for bootloader start when XCK jumpered to ground

14
LUFA/ManPages/LUFAvsAtmelStack.txt
View file

@ -5,11 +5,11 @@
*/
/**
* \page Page_LUFAvsAtmelStack LUFA vs the Atmel Stack
* \page Page_LUFAvsAtmelStack LUFA vs the Atmel 8-bit USB AVR Stack
*
* Atmel offers an official USB AVR stack, which may be incorporated into user projects and products. As LUFA and the Atmel
* stack aims to give roughly the same functionality to a design, it is often asked what advantages LUFA carries over the
* official Atmel USB stack. Below are just some of the advantages to choosing LUFA over the official stack.
* Atmel offers an official 8-bit USB AVR stack, which may be incorporated into user projects and products. As LUFA and the Atmel
* stack aims to give roughly the same functionality to a design, it is often asked what advantages LUFA carries over the official
* Atmel USB stack for the 8-bit USB AVRs. Below are just some of the advantages to choosing LUFA over the official Atmel stack.
*
* - <b>Licensing:</b>
* LUFA is released under a very permissive MIT license (see \ref Page_LicenseInfo), while the Atmel stack carries several
@ -42,5 +42,11 @@
* - <b>Better Library Support:</b>
* As many people are now using LUFA, there is a community being built around it. You can get answers to your LUFA related questions
* quickly by either emailing the library author (subject to author's schedule) or by posting to the official LUFA support mailing list.
*
* - <b>More Compact Code:</b>
* LUFA is written from the ground up to compile optimally, using clean code and good design. Two demos giving the same functionality -
* the LUFA Low Level API Mouse Demo vs. the Atmel AVR270 HID Mouse application note shows LUFA to be the clear size winner *.
*
* * <i>LUFA Low Level Mouse Demo: 3510 bytes, Atmel AVR270 Mouse Application Note: 4222 bytes, using an identical build environment.</i>
*/

7
LUFA/ManPages/WhyUseLUFA.txt
View file

@ -32,15 +32,12 @@
* seconds each time a new release is made.
*
* - <b>Size:</b>
* Not just requiring less code to make complex USB devices, LUFA (under most cases with the correct compile options)
* requires less FLASH space than Atmel's stack, meaning more space for the user application*.
* Not just requiring less code to make complex USB devices, LUFA is written to compile down as much as possible into
* optimal code, to occupy only a small space for its feature set.
*
* - <b>Support:</b>
* Since many people are now using LUFA in their own projects, you can take advantage of other's knowledge when you run
* into difficulties or need some advice. In addition, you can also email the library author to receive personalized
* support when you need it (subject to author's schedule).
*
* <small>* Atmel Stack Mouse Device Demo 4218 bytes, LUFA Mouse Low Level Device Demo 3526 bytes, under identical build
* environments</small>
*/