From 33a81bffb9e3f856c1d3446d7292795774ae91a8 Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Sat, 5 Mar 2011 10:58:35 +0000 Subject: [PATCH] Minor documentation updates. --- LUFA/ManPages/ChangeLog.txt | 5 ++++- LUFA/ManPages/LUFAvsAtmelStack.txt | 14 ++++++++++---- LUFA/ManPages/WhyUseLUFA.txt | 7 ++----- 3 files changed, 16 insertions(+), 10 deletions(-) diff --git a/LUFA/ManPages/ChangeLog.txt b/LUFA/ManPages/ChangeLog.txt index 7aef9c3cd2..df82811458 100644 --- a/LUFA/ManPages/ChangeLog.txt +++ b/LUFA/ManPages/ChangeLog.txt @@ -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 diff --git a/LUFA/ManPages/LUFAvsAtmelStack.txt b/LUFA/ManPages/LUFAvsAtmelStack.txt index b4fce2df09..239c2772be 100644 --- a/LUFA/ManPages/LUFAvsAtmelStack.txt +++ b/LUFA/ManPages/LUFAvsAtmelStack.txt @@ -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. * * - Licensing: * LUFA is released under a very permissive MIT license (see \ref Page_LicenseInfo), while the Atmel stack carries several @@ -42,5 +42,11 @@ * - Better Library Support: * 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. + * + * - More Compact Code: + * 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 *. + * + * * LUFA Low Level Mouse Demo: 3510 bytes, Atmel AVR270 Mouse Application Note: 4222 bytes, using an identical build environment. */ diff --git a/LUFA/ManPages/WhyUseLUFA.txt b/LUFA/ManPages/WhyUseLUFA.txt index d83c76b1a1..5644be07c5 100644 --- a/LUFA/ManPages/WhyUseLUFA.txt +++ b/LUFA/ManPages/WhyUseLUFA.txt @@ -32,15 +32,12 @@ * seconds each time a new release is made. * * - Size: - * 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. * * - Support: * 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). - * - * * Atmel Stack Mouse Device Demo 4218 bytes, LUFA Mouse Low Level Device Demo 3526 bytes, under identical build - * environments */