From aba7932a5c7c5f4a65f1c8558c94ed313ff3ca96 Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Mon, 21 Mar 2011 10:20:42 +0000 Subject: F_CLOCK changed to F_USB to be more descriptive, and applicable on future architecture ports. --- LUFA/ManPages/ChangeLog.txt | 5 +++-- LUFA/ManPages/ConfiguringApps.txt | 4 ++-- LUFA/ManPages/LUFAPoweredProjects.txt | 3 +++ LUFA/ManPages/MigrationInformation.txt | 4 +++- 4 files changed, 11 insertions(+), 5 deletions(-) (limited to 'LUFA/ManPages') diff --git a/LUFA/ManPages/ChangeLog.txt b/LUFA/ManPages/ChangeLog.txt index 3bb93ea8d..7b5c667e6 100644 --- a/LUFA/ManPages/ChangeLog.txt +++ b/LUFA/ManPages/ChangeLog.txt @@ -60,6 +60,7 @@ * - Removed Pipe_ClearErrorFlags(), pipe error flags are now automatically cleared when Pipe_ClearError() is called * - Endpoint_ResetFIFO() renamed to Endpoint_ResetEndpoint(), to be consistent with the Pipe_ResetPipe() function name * - Implemented on-demand PLL clock generation for the U4, U6 and U7 series USB AVRs when automatic PLL mode is specified + * - F_CLOCK changed to F_USB to be more descriptive, and applicable on future architecture ports * - Library Applications: * - Changed the XPLAINBridge software UART to use the regular timer CTC mode instead of the alternative CTC mode * via the Input Capture register, to reduce user confusion @@ -633,7 +634,7 @@ * - Pipe stream functions now automatically set the correct pipe token, so that bidirectional pipes can be used * - Pipe_ConfigurePipe() now automatically defaults IN pipes to accepting infinite IN requests, this can still be changed by calling * the existing Pipe_SetFiniteINRequests() function - * - Changed F_CLOCK entries in project makefiles to alias to F_CPU by default, as this is the most common case + * - Changed F_USB entries in project makefiles to alias to F_CPU by default, as this is the most common case * - Host mode demos now use sane terminal escape codes, so that text is always readable and events/program output is visually distinguished * from one another using foreground colours * - Internal per-device preprocessing conditions changed to per-device series rather than per-controller group for finer-grain @@ -789,7 +790,7 @@ * - Fixed KeyboardMouse demo discarding the wIndex value in the REQ_GetReport request * - USBtoSerial demo now discards all Rx data when not connected to a USB host, rather than buffering characters for transmission * next time the device is attached to a host. - * - Added new F_CLOCK compile time constant to the library and makefiles, to give the raw input clock (used to feed the PLL before any + * - Added new F_USB compile time constant to the library and makefiles, to give the raw input clock (used to feed the PLL before any * clock prescaling is performed) frequency, so that the PLL prescale mask can be determined * - Changed stream wait timeout counter to be 16-bit, so that very long timeout periods can be set for correct communications with * badly designed hosts or devices which greatly exceed the USB specification limits diff --git a/LUFA/ManPages/ConfiguringApps.txt b/LUFA/ManPages/ConfiguringApps.txt index e5ce9fd51..b56341ee2 100644 --- a/LUFA/ManPages/ConfiguringApps.txt +++ b/LUFA/ManPages/ConfiguringApps.txt @@ -22,7 +22,7 @@ * * - MCU, the target AVR processor * - BOARD, the target board hardware - * - F_CLOCK, the target raw master clock frequency, before any prescaling is performed + * - F_USB, 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 options the source code * - LUFA_PATH, the path to the LUFA library source code @@ -50,7 +50,7 @@ * * For boards with built in hardware driver support within the LUFA library, see \ref Page_DeviceSupport. * - * \section Sec_F_CLOCK The F_CLOCK Parameter + * \section Sec_F_USB The F_USB Parameter * This parameter indicates the target AVR's input clock frequency, in Hz. This is the actual clock input, before any prescaling is performed. In the * USB AVR architecture, the input clock before any prescaling is fed directly to the PLL subsystem, and thus the PLL is derived directly from the * clock input. The PLL then feeds the USB and other sections of the AVR with the correct upscaled frequencies required for those sections to function. diff --git a/LUFA/ManPages/LUFAPoweredProjects.txt b/LUFA/ManPages/LUFAPoweredProjects.txt index 34d4944b6..b81d03e65 100644 --- a/LUFA/ManPages/LUFAPoweredProjects.txt +++ b/LUFA/ManPages/LUFAPoweredProjects.txt @@ -51,6 +51,7 @@ * - Garmin GPS USB to NMEA standard serial sentence translator: http://github.com/nall/garmin-transmogrifier/tree/master * - Generic HID Device Creator: http://generichid.sourceforge.net/ * - Ghetto Drum, a MIDI drum controller: http://noisybox.net/art/gdrum/ + * - Hiduino, a USB-MIDI replacement firmware for the Arduino Uno: http://code.google.com/p/hiduino/ * - IR Remote to Keyboard decoder: http://netzhansa.blogspot.com/2010/04/our-living-room-hi-fi-setup-needs-mp3.html * - LED Panel controller: http://projects.peterpolidoro.net/caltech/panelscontroller/panelscontroller.htm * - LUFA powered DDR dance mat (French): http://logicien-parfait.fr/dokuwiki/doku.php?id=projet:ddr_repair @@ -78,10 +79,12 @@ * - Stripe Snoop, a Magnetic Card reader: http://www.ossguy.com/ss_usb/ * - Teensy SD Card .WAV file player: http://elasticsheep.com/2010/04/teensy2-usb-wav-player-part-1/ * - Touchscreen Input Device: http://capnstech.blogspot.com/2010/07/touchscreen-update.html + * - Universal USB AVR Module: http://usbavr.bplaced.net/ * - USB Interface for Playstation Portable Devices: http://forums.ps2dev.org/viewtopic.php?t=11001 * - Userial, a USB to Serial converter with SPI, I2C and other protocols: http://www.tty1.net/userial/ * - Wireless MIDI Guitar system: http://www.ise.pw.edu.pl/~wzab/wireless_guitar_system/ * - XUM1541, a Commodore 64 floppy drive to USB adapter: http://www.root.org/~nate/c64/xum1541/ + * - Zeus, a touch screen computer for music manipulation: http://www.benbengler.com/developments_zeus.html * * \section Sec_LUFACommercialProjects Projects Using LUFA (Commercial) * diff --git a/LUFA/ManPages/MigrationInformation.txt b/LUFA/ManPages/MigrationInformation.txt index c562ccdd3..cb94bad9a 100644 --- a/LUFA/ManPages/MigrationInformation.txt +++ b/LUFA/ManPages/MigrationInformation.txt @@ -32,6 +32,8 @@ * reconfiguring all Endpoints/Pipes in order each time a new Endpoint/Pipe is created. To minimise the compiled program * size, the new \c ORDERED_EP_CONFIG compile time option may be defined in the project makefile to restrict the ordering * in exchange for a smaller compiled binary size. + * - The previous F_CLOCK symbol, required in the project makefile, has been renamed to F_USB. This is due to the previous name + * being far too generic for use in future architecture ports, where multiple clock domains are used. * * Device Mode * - The Endpoint stream functions now all require a \c BytesProcessed parameter instead of the previous callback parameter. @@ -368,7 +370,7 @@ * \section Sec_Migration090401 Migrating from 090209 to 090401 * * All - * - LUFA projects must now give the raw input clock frequency (before any prescaling) as a compile time constant \c F_CLOCK, + * - LUFA projects must now give the raw input clock frequency (before any prescaling) as a compile time constant \c F_USB, * defined in the project makefile and passed to the compiler via the -D switch. * - The makefile EEPROM programming targets for FLIP and dfu-programmer no longer program in the FLASH data in addition to the * EEPROM data into the device. If both are to be programmed, both the EEPROM and FLASH programming targets must be called. -- cgit v1.2.3