From 2acae9b0a302aba795e3b403916eba37192200fc Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Fri, 27 Mar 2009 08:45:39 +0000 Subject: [PATCH] Add new page to the documentation listing existing LUFA powered projects, fix up some inaccuracies in the documentation. --- LUFA.pnproj | 2 +- LUFA/ChangeLog.txt | 2 +- LUFA/DirectorySummaries.txt | 7 +++++++ LUFA/GettingStarted.txt | 3 ++- LUFA/LUFAPoweredProjects.txt | 31 +++++++++++++++++++++++++++++++ LUFA/MigrationInformation.txt | 4 ++-- 6 files changed, 44 insertions(+), 5 deletions(-) create mode 100644 LUFA/LUFAPoweredProjects.txt diff --git a/LUFA.pnproj b/LUFA.pnproj index 4970ca3813..1f1c346a66 100644 --- a/LUFA.pnproj +++ b/LUFA.pnproj @@ -1 +1 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/LUFA/ChangeLog.txt b/LUFA/ChangeLog.txt index 07847baf16..04bfdc00bb 100644 --- a/LUFA/ChangeLog.txt +++ b/LUFA/ChangeLog.txt @@ -28,7 +28,7 @@ * - Added ATTR_ALWAYS_INLINE attribute to several key inlined library components, to ensure they are inlined in all circumstances * - Removed SetSystemClockPrescaler() macro, the clock_prescale_set() avr-libc macro has been corrected in recent avr-libc versions * - Fixed incorrect/missing control status stage transfers on demos, bootloaders and applications (thanks to Nate Lawson) - * - The NO_CLEARSET_FEATURE_REQUEST compile time token has been renamed to NO_FEATURELESS_CONTROL_ONLY_DEVICE, and its function expanded + * - The NO_CLEARSET_FEATURE_REQUEST compile time token has been renamed to FEATURELESS_CONTROL_ONLY_DEVICE, and its function expanded * to also remove parts of the Get Status chapter 9 request to further reduce code usage * - Makefile updated to include output giving the currently selected BOARD parameter value * - Board Dataflash driver now allows for dataflash ICs which use different shifts for setting the current page/byte address (thanks diff --git a/LUFA/DirectorySummaries.txt b/LUFA/DirectorySummaries.txt index 1abf3d494d..eba413e2ca 100644 --- a/LUFA/DirectorySummaries.txt +++ b/LUFA/DirectorySummaries.txt @@ -109,6 +109,13 @@ * files in this folder should not be included directly in user applications; the similarly named dispatch header files located in * the parent Board directory should be included instead. * + * \dir Drivers/Board/ATAVRUSBRF01 + * \brief ATAVRUSBRF01 board hardware driver files. + * + * This folder contains drivers for hardware on the Atmel ATAVRUSBRF01 board, as used in several Atmel wireless demo kits. The header + * files in this folder should not be included directly in user applications; the similarly named dispatch header files located in + * the parent Board directory should be included instead. + * * \dir DriverStubs * \brief Driver stub header files for custom boards, to allow the LUFA board drivers to operate. * diff --git a/LUFA/GettingStarted.txt b/LUFA/GettingStarted.txt index a88a82533e..efd5ce2cda 100644 --- a/LUFA/GettingStarted.txt +++ b/LUFA/GettingStarted.txt @@ -34,7 +34,8 @@ * * - MCU, the target AVR processor. * - BOARD, the target board hardware - * - F_CPU, the target AVR master clock frequency + * - F_CLOCK, the target raw master clock frequency, before any prescaling is performed + * - F_CPU, the target AVR CPU master clock frequency, after any prescaling * - CDEFS, the C preprocessor defines which configure the source code * * These values should be changed to reflect the build hardware. diff --git a/LUFA/LUFAPoweredProjects.txt b/LUFA/LUFAPoweredProjects.txt new file mode 100644 index 0000000000..519c7cad6a --- /dev/null +++ b/LUFA/LUFAPoweredProjects.txt @@ -0,0 +1,31 @@ +/** \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 LUFAPoweredProjects User Projects Powered by LUFA + * + * LUFA is currently in use all around the world, in many applications both commercial and non-commercial. Below is a + * list of known public LUFA powered projects, which all use the LUFA library in some way. Feel free to visit each project's + * home page for more information on each project. + * + * If you have a project that you would like to add to this list, please contact my via the details on the main page of this + * documentation. + * + * + * Benito #7, an AVR Programmer: http://www.dorkbotpdx.org/blog/feurig/benito_7_the_next_big_thing \n + * Stripe Snoop, a Magnetic Card reader: http://www.ossguy.com/ss_usb/ \n + * USB10 AKA "The Ferret", a USB162 development board: http://www.soc-machines.com \n + * Bicycle POV: http://www.code.google.com/p/bicycleledpov/ \n + * Digital Survey Instruments Magnetometer and Pointer: http://www.digitalsurveyinstruments.com/ \n + * ARPS Locator: http://la3t.hamradio.no/lab//?id=tracker_en \n + * Lightweight CC110x USB dongle for 868MHz Protocols: http://busware.de/tiki-index.php?page=CUL \n + * AVROpendous, an open design/source AT90USB162 development board: http://avropendous.org/ \n + * USB Interface for Playstation Portable Devices: http://forums.ps2dev.org/viewtopic.php?t=11001 \n + * USB to Serial Bridge, via SPI and I2C: http://www.tty1.net/userial/ \n + * Teensy, another tiny AT90USB162 development board: http://www.pjrc.com/teensy/index.html \n + * SEGA Megadrive/Genesis Development Cartridge: http://www.spritesmind.net/_GenDev/forum/viewtopic.php?t=464 \n + * CAMTRIG, a remote Camera Trigger device: http://code.astraw.com/projects/motmot/camtrig \n + * + */ \ No newline at end of file diff --git a/LUFA/MigrationInformation.txt b/LUFA/MigrationInformation.txt index a04b1b0538..59dc24bd3c 100644 --- a/LUFA/MigrationInformation.txt +++ b/LUFA/MigrationInformation.txt @@ -31,9 +31,9 @@ * - Custom board Dataflash drivers now require the implementation of Dataflash_SelectChipFromPage() and Dataflash_SendAddressBytes(). * * Device Mode - * - The NO_CLEARSET_FEATURE_REQUEST compile time token has been renamed to NO_FEATURELESS_CONTROL_ONLY_DEVICE, and its function expanded + * - The NO_CLEARSET_FEATURE_REQUEST compile time token has been renamed to FEATURELESS_CONTROL_ONLY_DEVICE, and its function expanded * to also remove parts of the Get Status chapter 9 request to further reduce code usage. On all applications currently using the - * NO_CLEARSET_FEATURE_REQUEST compile time token, it can be replaced with the NO_FEATURELESS_CONTROL_ONLY_DEVICE token with no further + * NO_CLEARSET_FEATURE_REQUEST compile time token, it can be replaced with the FEATURELESS_CONTROL_ONLY_DEVICE token with no further * modifications required. * * \section Sec_Migration090209 Migrating from 081217 to 090209