From b2de4519590d06267445e1b711678511cc706e7c Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Sun, 21 Jun 2009 04:48:05 +0000 Subject: Add new temp LUFA project logo to the manual. --- LUFA/ManPages/LUFA.gif | Bin 0 -> 5474 bytes LUFA/ManPages/LUFAPoweredProjects.txt | 2 +- LUFA/ManPages/MainPage.txt | 14 ++++++++++---- LUFA/ManPages/SchedulerOverview.txt | 35 ++++++++++++++++++++++++++++++++++ 4 files changed, 46 insertions(+), 5 deletions(-) create mode 100644 LUFA/ManPages/LUFA.gif create mode 100644 LUFA/ManPages/SchedulerOverview.txt (limited to 'LUFA/ManPages') diff --git a/LUFA/ManPages/LUFA.gif b/LUFA/ManPages/LUFA.gif new file mode 100644 index 000000000..885f5b000 Binary files /dev/null and b/LUFA/ManPages/LUFA.gif differ diff --git a/LUFA/ManPages/LUFAPoweredProjects.txt b/LUFA/ManPages/LUFAPoweredProjects.txt index 1f9a317e6..eb86d611f 100644 --- a/LUFA/ManPages/LUFAPoweredProjects.txt +++ b/LUFA/ManPages/LUFAPoweredProjects.txt @@ -22,6 +22,7 @@ * - Teensy and Teensy++, two other AVR USB development boards: http://www.pjrc.com/teensy/index.html * - USBFoo, an AT90USB162 based development board: http://shop.kernelconcepts.de/product_info.php?products_id=102 * - USB10 AKA "The Ferret", a AT90USB162 development board: http://www.soc-machines.com + * - Benito #7, a no-frills USB board: http://www.dorkbotpdx.org/blog/feurig/benito_7_the_next_big_thing * * \section Sec_LUFAProjects Projects Using LUFA (Hobbyist) * @@ -29,7 +30,6 @@ * can be incorporated into many different applications. * * - Stripe Snoop, a Magnetic Card reader: http://www.ossguy.com/ss_usb/ - * - Benito #7, an AVR Programmer: http://www.dorkbotpdx.org/blog/feurig/benito_7_the_next_big_thing * - Bicycle POV: http://www.code.google.com/p/bicycleledpov/ * - USB Interface for Playstation Portable Devices: http://forums.ps2dev.org/viewtopic.php?t=11001 * - USB to Serial Bridge, via SPI and I2C: http://www.tty1.net/userial/ diff --git a/LUFA/ManPages/MainPage.txt b/LUFA/ManPages/MainPage.txt index a9cfa7641..23fa08b4c 100644 --- a/LUFA/ManPages/MainPage.txt +++ b/LUFA/ManPages/MainPage.txt @@ -5,11 +5,15 @@ */ /** - * \mainpage General Information + * \mainpage * - * Lightweight USB Framework for AVRs Library, written by Dean Camera. + * \n + * \image html LUFA.gif "The Lightweight USB Framework for AVRs" + * \n * - * Originally based on the AT90USBKEY from Atmel, it is an open-source USB library for the USB-enabled AVR + * For author and donation information, see \ref Page_Donating. + * + * Originally based on the AT90USBKEY from Atmel, LUFA is an open-source USB library for the USB-enabled AVR * microcontrollers, released under the MIT license. It now supports a large number of USB AVR models and boards. * * The library is currently in a stable release, suitable for download and incorporation into user projects for @@ -19,7 +23,6 @@ * library API more streamlined and robust. You can download AVR-GCC for free in a convenient windows package, * from the the WinAVR website. * - * \section Sec_Demos Demos, Projects 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. * @@ -34,4 +37,7 @@ * Subsections: * - \subpage Page_Licence Project License * - \subpage Page_Donating Donating to Support this Project + * + * + * Logo design by Pavla Dlab */ diff --git a/LUFA/ManPages/SchedulerOverview.txt b/LUFA/ManPages/SchedulerOverview.txt new file mode 100644 index 000000000..3aa151750 --- /dev/null +++ b/LUFA/ManPages/SchedulerOverview.txt @@ -0,0 +1,35 @@ +/** \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. + */ + +/** \page Page_SchedulerOverview LUFA Scheduler Overview + * + * THE LUFA SCHEDULER IS NOW DEPRECATED AND WILL BE REMOVED IN A FUTURE RELEASE. EXISTING CODE SHOULD CONVERT + * TO STANDARD LOOPS AS SHOWN IN THE CURRENT LIBRARY DEMOS. + * + * + * The LUFA library comes with a small, basic round-robbin scheduler which allows for small "tasks" to be executed + * continuously in sequence, and enabled/disabled at runtime. Unlike a conventional, complex RTOS scheduler, the + * LUFA scheduler is very simple in design and operation and is essentially a loop conditionally executing a series + * of functions. + * + * Each LUFA scheduler task should be written similar to an ISR; it should execute quickly (so that no one task + * hogs the processor, preventing another from running before some sort of timeout is exceeded). Unlike normal RTOS + * tasks, each LUFA scheduler task is a regular function, and thus must be designed to be called, and designed to + * return to the calling scheduler function repeatedly. Data which must be preserved between task calls should be + * declared as global or (preferably) as a static local variable inside the task. + * + * The scheduler consists of a task list, listing all the tasks which can be executed by the scheduler. Once started, + * each task is then called one after another, unless the task is stopped by another running task or interrupt. + * + * + * If desired, the LUFA scheduler does not need to be used in a LUFA powered application. A more conventional + * approach to application design can be used, or a proper scheduling RTOS inserted in the place of the LUFA scheduler. + * In the case of the former the USB task must be run manually repeatedly to maintain USB communications, and in the + * case of the latter a proper RTOS task must be set up to do the same. + * + * + * For more information on the LUFA scheduler, see the Scheduler.h file documentation. + */ -- cgit v1.2.3