eqmk
/
qmk_firmware
forked from mfulz_github/qmk_firmware
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Start update of documentation to support possible multiple architectures in the future - alter \file documentation to automatically copy in the module documentation where possible.

This commit is contained in:
Dean Camera 2011-02-20 13:08:29 +00:00
parent 1daa5e16f9
commit 5e73190582
98 changed files with 256 additions and 590 deletions

3
LUFA/CodeTemplates/DriverStubs/Buttons.h
View File

@ -43,9 +43,6 @@
#define __BUTTONS_USER_H__
/* Includes: */
#include <avr/io.h>
#include <stdbool.h>
// TODO: Add any required includes here
/* Enable C linkage for C++ Compilers: */

2
LUFA/CodeTemplates/DriverStubs/Joystick.h
View File

@ -44,8 +44,6 @@
#define __JOYSTICK_USER_H__
/* Includes: */
#include <avr/io.h>
// TODO: Add any required includes here
/* Enable C linkage for C++ Compilers: */

2
LUFA/CodeTemplates/DriverStubs/LEDs.h
View File

@ -43,8 +43,6 @@
#define __LEDS_USER_H__
/* Includes: */
#include <avr/io.h>
// TODO: Add any required includes here
/* Enable C linkage for C++ Compilers: */

4
LUFA/Common/Architectures.h
View File

@ -31,8 +31,7 @@
/** \file
* \brief Supported architecture defines.
*
* This file contains constants which can be passed to the compiler (via setting the macro ARCH) in the
* user project makefile using the -D option to configure the library drivers.
* \copydetails Group_Architectures
*
* \note Do not include this file directly, rather include the Common.h header file instead to gain this file's
* functionality.
@ -40,6 +39,7 @@
/** \ingroup Group_Common
* \defgroup Group_Architectures Hardware Architectures
* \brief Supported architecture defines.
*
* Macros for indicating the chosen hardware architecture to the library. These macros should be used when
* defining the ARCH token to the chosen hardware via the -D switch in the project makefile.

20
LUFA/Common/Attributes.h
View File

@ -29,6 +29,16 @@
*/
/** \file
* \brief AVR-GCC special function/variable attribute macros.
*
* \copydetails Group_GCCAttributes
*
* \note Do not include this file directly, rather include the Common.h header file instead to gain this file's
* functionality.
*/
/** \ingroup Group_Common
* \defgroup Group_GCCAttributes Function/Variable Attributes
* \brief AVR-GCC special function/variable attribute macros.
*
* This file contains macros for applying GCC specific attributes to functions and variables to control various
@ -39,16 +49,6 @@
* On incompatible versions of GCC or on other compilers, these macros evaluate to nothing unless they are
* critical to the code's function and thus must throw a compiler error when used.
*
* \note Do not include this file directly, rather include the Common.h header file instead to gain this file's
* functionality.
*/
/** \ingroup Group_Common
* \defgroup Group_GCCAttr Function/Variable Attributes
*
* Macros for easy access GCC function and variable attributes, which can be applied to function prototypes or
* variable attributes.
*
* @{
*/

4
LUFA/Common/BoardTypes.h
View File

@ -31,8 +31,7 @@
/** \file
* \brief Supported board hardware defines.
*
* This file contains constants which can be passed to the compiler (via setting the macro BOARD) in the
* user project makefile using the -D option to configure the library board-specific drivers.
* \copydetails Group_BoardTypes
*
* \note Do not include this file directly, rather include the Common.h header file instead to gain this file's
* functionality.
@ -40,6 +39,7 @@
/** \ingroup Group_Common
* \defgroup Group_BoardTypes Board Types
* \brief Supported board hardware defines.
*
* Macros for indicating the chosen physical board hardware to the library. These macros should be used when
* defining the BOARD token to the chosen hardware via the -D switch in the project makefile.

10
LUFA/Common/Common.h
View File

@ -31,11 +31,11 @@
/** \file
* \brief Common library convenience macros and functions.
*
* This file contains macros which are common to all library elements, and which may be useful in user code. It
* also includes other common code headers.
* \copydetails Group_Common
*/
/** \defgroup Group_Common Common Utility Headers - LUFA/Drivers/Common/Common.h
* \brief Common library convenience macros and functions.
*
* Common utility headers containing macros, functions, enums and types which are common to all
* aspects of the library.
@ -64,7 +64,8 @@
/* Includes: */
#include <stdint.h>
#include <stdbool.h>
#include <string.h>
#include "Architectures.h"
#include "Attributes.h"
#include "BoardTypes.h"
@ -75,6 +76,7 @@
#include <avr/interrupt.h>
#include <avr/pgmspace.h>
#include <avr/eeprom.h>
#include <avr/boot.h>
#include <util/atomic.h>
#include <util/delay.h>
#endif
@ -123,7 +125,7 @@
#define MIN(x, y) ((x < y) ? x : y)
#endif
#if (ARCH == ARCH_AVR8)
#if (ARCH == ARCH_AVR8) || defined(__DOXYGEN__)
/** Defines a volatile \c NOP statement which cannot be optimized out by the compiler, and thus can always
* be set as a breakpoint in the resulting code. Useful for debugging purposes, where the optimiser
* removes/reorders code to the point where break points cannot reliably be set.

9
LUFA/Drivers/Board/ADAFRUITU4/LEDs.h
View File

@ -30,8 +30,7 @@
/** \file
* \brief Board specific LED driver header for the Adafruit U4 Breakout board.
*
* Board specific LED driver header for the Adafruit U4 Breakout board (http://ladyada.net/products/atmega32u4breakout).
* \copydetails Group_LEDs_ADAFRUITU4
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
@ -39,12 +38,10 @@
/** \ingroup Group_LEDs
* \defgroup Group_LEDs_ADAFRUITU4 ADAFRUITU4
* \brief Board specific LED driver header for the Adafruit U4 Breakout board.
*
* Board specific LED driver header for the Adafruit U4 Breakout board (http://ladyada.net/products/atmega32u4breakout).
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
*
* @{
*/
@ -52,8 +49,6 @@
#define __LEDS_ADAFRUITU4_H__
/* Includes: */
#include <avr/io.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */

10
LUFA/Drivers/Board/ATAVRUSBRF01/Buttons.h
View File

@ -30,8 +30,7 @@
/** \file
* \brief Board specific Buttons driver header for the Atmel ATAVRUSBRF01.
*
* Board specific Buttons driver header for the Atmel ATAVRUSBRF01.
* \copydetails Group_Buttons_ATAVRUSBRF01
*
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver
* dispatch header located in LUFA/Drivers/Board/Buttons.h.
@ -39,12 +38,10 @@
/** \ingroup Group_Buttons
* \defgroup Group_Buttons_ATAVRUSBRF01 ATAVRUSBRF01
* \brief Board specific Buttons driver header for the Atmel ATAVRUSBRF01.
*
* Board specific Buttons driver header for the Atmel ATAVRUSBRF01.
*
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver
* dispatch header located in LUFA/Drivers/Board/Buttons.h.
*
* @{
*/
@ -52,9 +49,6 @@
#define __BUTTONS_ATAVRUSBRF01_H__
/* Includes: */
#include <avr/io.h>
#include <stdbool.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */

9
LUFA/Drivers/Board/ATAVRUSBRF01/LEDs.h
View File

@ -30,8 +30,7 @@
/** \file
* \brief Board specific LED driver header for the Atmel ATAVRUSBRF01.
*
* Board specific LED driver header for the Atmel ATAVRUSBRF01.
* \copydetails Group_LEDs_ATAVRUSBRF01
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
@ -39,12 +38,10 @@
/** \ingroup Group_LEDs
* \defgroup Group_LEDs_ATAVRUSBRF01 ATAVRUSBRF01
* \brief Board specific LED driver header for the Atmel ATAVRUSBRF01.
*
* Board specific LED driver header for the Atmel ATAVRUSBRF01.
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
*
* @{
*/
@ -52,8 +49,6 @@
#define __LEDS_ATAVRUSBRF01_H__
/* Includes: */
#include <avr/io.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */

10
LUFA/Drivers/Board/BENITO/Buttons.h
View File

@ -30,8 +30,7 @@
/** \file
* \brief Board specific Buttons driver header for the Tempusdictum Benito.
*
* Board specific Buttons driver header for the Tempusdictum Benito (http://dorkbotpdx.org/wiki/benito).
* \copydetails Group_Buttons_BENITO
*
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver
* dispatch header located in LUFA/Drivers/Board/Buttons.h.
@ -39,12 +38,10 @@
/** \ingroup Group_Buttons
* \defgroup Group_Buttons_BENITO BENITO
* \brief Board specific Buttons driver header for the Tempusdictum Benito.
*
* Board specific Buttons driver header for the Tempusdictum Benito (http://dorkbotpdx.org/wiki/benito).
*
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver
* dispatch header located in LUFA/Drivers/Board/Buttons.h.
*
* @{
*/
@ -52,9 +49,6 @@
#define __BUTTONS_BENITO_H__
/* Includes: */
#include <avr/io.h>
#include <stdbool.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */

9
LUFA/Drivers/Board/BENITO/LEDs.h
View File

@ -30,8 +30,7 @@
/** \file
* \brief Board specific LED driver header for the Tempusdictum Benito.
*
* Board specific LED driver header for the Tempusdictum Benito (http://dorkbotpdx.org/wiki/benito).
* \copydetails Group_LEDs_BENITO
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
@ -39,12 +38,10 @@
/** \ingroup Group_LEDs
* \defgroup Group_LEDs_BENITO BENITO
* \brief Board specific LED driver header for the Tempusdictum Benito.
*
* Board specific LED driver header for the Tempusdictum Benito (http://dorkbotpdx.org/wiki/benito).
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
*
* @{
*/
@ -52,7 +49,7 @@
#define __LEDS_BENITO_H__
/* Includes: */
#include <avr/io.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */
#if defined(__cplusplus)

9
LUFA/Drivers/Board/BLACKCAT/LEDs.h
View File

@ -30,8 +30,7 @@
/** \file
* \brief Board specific LED driver header for the BLACKCAT USB JTAG.
*
* Board specific LED driver header for the TCNISO Blackcat USB JTAG (http://www.embeddedcomputers.net/products/BlackcatUSB/.
* \copydetails Group_LEDs_BLACKCAT
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
@ -39,12 +38,10 @@
/** \ingroup Group_LEDs
* \defgroup Group_LEDs_BLACKCAT BLACKCAT
* \brief Board specific LED driver header for the BLACKCAT USB JTAG.
*
* Board specific LED driver header for the TCNISO Blackcat USB JTAG (http://www.embeddedcomputers.net/products/BlackcatUSB/.
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
*
* @{
*/
@ -52,8 +49,6 @@
#define __LEDS_BLACKCAT_H__
/* Includes: */
#include <avr/io.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */

9
LUFA/Drivers/Board/BUI/LEDs.h
View File

@ -30,8 +30,7 @@
/** \file
* \brief Board specific LED driver header for the Busware BUI.
*
* Board specific LED driver header for the Busware BUI (http://www.busware.de/tiki-index.php?page=BUI).
* \copydetails Group_LEDs_BUI
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
@ -39,12 +38,10 @@
/** \ingroup Group_LEDs
* \defgroup Group_LEDs_BUI BUI
* \brief Board specific LED driver header for the Busware BUI.
*
* Board specific LED driver header for the Busware BUI (http://www.busware.de/tiki-index.php?page=BUI).
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
*
* @{
*/
@ -52,7 +49,7 @@
#define __LEDS_BUI_H__
/* Includes: */
#include <avr/io.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */
#if defined(__cplusplus)

13
LUFA/Drivers/Board/BUMBLEB/Buttons.h
View File

@ -30,11 +30,7 @@
/** \file
* \brief Board specific Buttons driver header for the Fletchtronics BUMBLEB.
*
* Board specific Buttons driver header for the Fletchtronics BUMBLEB (http://fletchtronics.net/bumble-b).
*
* The BUMBLEB third-party board does not include any on-board peripherals, but does have an officially recommended
* external peripheral layout for buttons, LEDs and a Joystick.
* \copydetails Group_Buttons_BUMBLEB
*
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver
* dispatch header located in LUFA/Drivers/Board/Buttons.h.
@ -42,14 +38,12 @@
/** \ingroup Group_Buttons
* \defgroup Group_Buttons_BUMBLEB BUMBLEB
* \brief Board specific Buttons driver header for the Fletchtronics BUMBLEB.
*
* Board specific buttons driver header for the Fletchtronics BUMBLEB (http://fletchtronics.net/bumble-b). The BUMBLEB
* third-party board does not include any on-board peripherals, but does have an officially recommended external peripheral
* layout for buttons, LEDs and a Joystick.
*
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver
* dispatch header located in LUFA/Drivers/Board/Buttons.h.
*
* @{
*/
@ -57,9 +51,6 @@
#define __BUTTONS_BUMBLEB_H__
/* Includes: */
#include <avr/io.h>
#include <stdbool.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */

12
LUFA/Drivers/Board/BUMBLEB/Joystick.h
View File

@ -30,11 +30,7 @@
/** \file
* \brief Board specific joystick driver header for the Fletchtronics BUMLEB.
*
* Board specific joystick driver header for the Fletchtronics BUMBLEB (http://fletchtronics.net/bumble-b).
*
* The BUMBLEB third-party board does not include any on-board peripherals, but does have an officially recommended
* external peripheral layout for buttons, LEDs and a Joystick.
* \copydetails Group_Joystick_BUMBLEB
*
* \note This file should not be included directly. It is automatically included as needed by the joystick driver
* dispatch header located in LUFA/Drivers/Board/Joystick.h.
@ -42,14 +38,12 @@
/** \ingroup Group_Joystick
* \defgroup Group_Joystick_BUMBLEB BUMBLEB
* \brief Board specific joystick driver header for the Fletchtronics BUMLEB.
*
* Board specific joystick driver header for the Fletchtronics BUMBLEB (http://fletchtronics.net/bumble-b). The BUMBLEB
* third-party board does not include any on-board peripherals, but does have an officially recommended external peripheral
* layout for buttons, LEDs and a Joystick.
*
* \note This file should not be included directly. It is automatically included as needed by the joystick driver
* dispatch header located in LUFA/Drivers/Board/Joystick.h.
*
* @{
*/
@ -57,8 +51,6 @@
#define __JOYSTICK_BUMBLEB_H__
/* Includes: */
#include <avr/io.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */

12
LUFA/Drivers/Board/BUMBLEB/LEDs.h
View File

@ -30,11 +30,7 @@
/** \file
* \brief Board specific LED driver header for the Fletchtronics BUMBLEB.
*
* Board specific LED driver header for the Fletchtronics BUMBLEB (http://fletchtronics.net/bumble-b).
*
* The BUMBLEB third-party board does not include any on-board peripherals, but does have an officially recommended
* external peripheral layout for buttons, LEDs and a Joystick.
* \copydetails Group_LEDs_BUMBLEB
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
@ -42,14 +38,12 @@
/** \ingroup Group_LEDs
* \defgroup Group_LEDs_BUMBLEB BUMBLEB
* \brief Board specific LED driver header for the Fletchtronics BUMBLEB.
*
* Board specific LED driver header for the Fletchtronics BUMBLEB (http://fletchtronics.net/bumble-b). The BUMBLEB
* third-party board does not include any on-board peripherals, but does have an officially recommended external
* peripheral layout for buttons, LEDs and a Joystick.
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
*
* @{
*/
@ -57,8 +51,6 @@
#define __LEDS_BUMBLEB_H__
/* Includes: */
#include <avr/io.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */

10
LUFA/Drivers/Board/CULV3/Buttons.h
View File

@ -30,8 +30,7 @@
/** \file
* \brief Board specific LED driver header for the Busware CULV3.
*
* Board specific LED driver header for the Busware CUL V3 (http://busware.de/tiki-index.php?page=CUL).
* \copydetails Group_LEDs_CULV3
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
@ -39,12 +38,10 @@
/** \ingroup Group_LEDs
* \defgroup Group_LEDs_CULV3 CULV3
* \brief Board specific LED driver header for the Busware CULV3.
*
* Board specific LED driver header for the Busware CUL V3 (http://busware.de/tiki-index.php?page=CUL).
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
*
* @{
*/
@ -52,9 +49,6 @@
#define __BUTTONS_CULV3_H__
/* Includes: */
#include <avr/io.h>
#include <stdbool.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */

9
LUFA/Drivers/Board/CULV3/LEDs.h
View File

@ -30,8 +30,7 @@
/** \file
* \brief Board specific LED driver header for the Busware CUL V3.
*
* Board specific LED driver header for the Busware CUL V3 (http://busware.de/tiki-index.php?page=CUL).
* \copydetails Group_LEDs_CULV3
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
@ -39,12 +38,10 @@
/** \ingroup Group_LEDs
* \defgroup Group_LEDs_CULV3 CULV3
* \brief Board specific LED driver header for the Busware CUL V3.
*
* Board specific LED driver header for the Busware CUL V3 (http://busware.de/tiki-index.php?page=CUL).
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
*
* @{
*/
@ -52,8 +49,6 @@
#define __LEDS_CULV3_H__
/* Includes: */
#include <avr/io.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */

16
LUFA/Drivers/Board/EVK527/Buttons.h
View File

@ -30,8 +30,7 @@
/** \file
* \brief Board specific Buttons driver header for the Atmel EVK527.
*
* Board specific Buttons driver header for the Atmel EVK527.
* \copydetails Group_Buttons_EVK527
*
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver
* dispatch header located in LUFA/Drivers/Board/Buttons.h.
@ -39,12 +38,10 @@
/** \ingroup Group_Buttons
* \defgroup Group_Buttons_EVK527 EVK527
* \brief Board specific Buttons driver header for the Atmel EVK527.
*
* Board specific Buttons driver header for the Atmel EVK527.
*
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver
* dispatch header located in LUFA/Drivers/Board/Buttons.h.
*
* @{
*/
@ -52,15 +49,6 @@
#define __BUTTONS_EVK527_H__
/* Includes: */
#include <avr/io.h>
#include <stdbool.h>
#include "../../../Common/Common.h"
/* Includes: */
#include <avr/io.h>
#include <stdbool.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */

7
LUFA/Drivers/Board/EVK527/Dataflash.h
View File

@ -30,8 +30,7 @@
/** \file
* \brief Board specific Dataflash driver header for the Atmel EVK527.
*
* Board specific Dataflash driver header for the Atmel EVK527.
* \copydetails Group_Dataflash_EVK527
*
* \note This file should not be included directly. It is automatically included as needed by the dataflash driver
* dispatch header located in LUFA/Drivers/Board/Dataflash.h.
@ -39,12 +38,10 @@
/** \ingroup Group_Dataflash
* \defgroup Group_Dataflash_EVK527 EVK527
* \brief Board specific Dataflash driver header for the Atmel EVK527.
*
* Board specific Dataflash driver header for the Atmel EVK527.
*
* \note This file should not be included directly. It is automatically included as needed by the dataflash driver
* dispatch header located in LUFA/Drivers/Board/Dataflash.h.
*
* @{
*/

9
LUFA/Drivers/Board/EVK527/Joystick.h
View File

@ -30,8 +30,7 @@
/** \file
* \brief Board specific joystick driver header for the Atmel EVK527.
*
* Board specific joystick driver header for the Atmel EVK527.
* \copydetails Group_Joystick_EVK527
*
* \note This file should not be included directly. It is automatically included as needed by the joystick driver
* dispatch header located in LUFA/Drivers/Board/Joystick.h.
@ -39,12 +38,10 @@
/** \ingroup Group_Joystick
* \defgroup Group_Joystick_EVK527 EVK527
* \brief Board specific joystick driver header for the Atmel EVK527.
*
* Board specific joystick driver header for the Atmel EVK527.
*
* \note This file should not be included directly. It is automatically included as needed by the joystick driver
* dispatch header located in LUFA/Drivers/Board/Joystick.h.
*
* @{
*/
@ -52,8 +49,6 @@
#define __JOYSTICK_EVK527_H__
/* Includes: */
#include <avr/io.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */

9
LUFA/Drivers/Board/EVK527/LEDs.h
View File

@ -30,8 +30,7 @@
/** \file
* \brief Board specific LED driver header for the Atmel EVK527.
*
* Board specific LED driver header for the Atmel EVK527.
* \copydetails Group_LEDs_EVK527
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
@ -39,12 +38,10 @@
/** \ingroup Group_LEDs
* \defgroup Group_LEDs_EVK527 EVK527
* \brief Board specific LED driver header for the Atmel EVK527.
*
* Board specific LED driver header for the Atmel EVK527.
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
*
* @{
*/
@ -52,8 +49,6 @@
#define __LEDS_EVK527_H__
/* Includes: */
#include <avr/io.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */

10
LUFA/Drivers/Board/JMDBU2/Buttons.h
View File

@ -30,8 +30,7 @@
/** \file
* \brief Board specific Buttons driver header for the Mattairtech JM-DB-U2.
*
* Board specific Buttons driver header for the Mattairtech JM-DB-U2 (http://u2.mattair.net/index.html).
* \copydetails Group_Buttons_JMDBU2
*
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver
* dispatch header located in LUFA/Drivers/Board/Buttons.h.
@ -39,12 +38,10 @@
/** \ingroup Group_Buttons
* \defgroup Group_Buttons_JMDBU2 JMDBU2
* \brief Board specific Buttons driver header for the Mattairtech JM-DB-U2.
*
* Board specific Buttons driver header for the Mattairtech JM-DB-U2 (http://u2.mattair.net/index.html).
*
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver
* dispatch header located in LUFA/Drivers/Board/Buttons.h.
*
* @{
*/
@ -52,9 +49,6 @@
#define __BUTTONS_JMDBU2_H__
/* Includes: */
#include <avr/io.h>
#include <stdbool.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */

9
LUFA/Drivers/Board/JMDBU2/LEDs.h
View File

@ -30,8 +30,7 @@
/** \file
* \brief Board specific LED driver header for the Mattairtech JM-DB-U2.
*
* Board specific LED driver header for the Mattairtech JM-DB-U2 (http://u2.mattair.net/index.html).
* \copydetails Group_LEDs_JMDBU2
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
@ -39,12 +38,10 @@
/** \ingroup Group_LEDs
* \defgroup Group_LEDs_JMDBU2 JMDBU2
* \brief Board specific LED driver header for the Mattairtech JM-DB-U2.
*
* Board specific LED driver header for the Mattairtech JM-DB-U2 (http://u2.mattair.net/index.html).
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
*
* @{
*/
@ -52,8 +49,6 @@
#define __LEDS_JMDBU2_H__
/* Includes: */
#include <avr/io.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */

9
LUFA/Drivers/Board/MAXIMUS/LEDs.h
View File

@ -30,8 +30,7 @@
/** \file
* \brief Board specific LED driver header for the Maximus.
*
* Board specific LED driver header for the Maximus (http://www.avrusb.com/).
* \copydetails Group_LEDs_MAXIMUS
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
@ -39,12 +38,10 @@
/** \ingroup Group_LEDs
* \defgroup Group_LEDs_MAXIMUS MAXIMUS
* \brief Board specific LED driver header for the Maximus.
*
* Board specific LED driver header for the Maximus (http://www.avrusb.com/).
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
*
* @{
*/
@ -52,8 +49,6 @@
#define __LEDS_MAXIMUS_H__
/* Includes: */
#include <avr/io.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */

10
LUFA/Drivers/Board/MICROSIN162/Buttons.h
View File

@ -30,8 +30,7 @@
/** \file
* \brief Board specific Buttons driver header for the Microsin AVR-USB162 board.
*
* Board specific Buttons driver header for the Microsin AVR-USB162 board (http://microsin.ru/content/view/685/44/).
* \copydetails Group_Buttons_MICROSIN162
*
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver
* dispatch header located in LUFA/Drivers/Board/Buttons.h.
@ -39,12 +38,10 @@
/** \ingroup Group_Buttons
* \defgroup Group_Buttons_MICROSIN162 MICROSIN162
* \brief Board specific Buttons driver header for the Microsin AVR-USB162 board.
*
* Board specific Buttons driver header for the Microsin AVR-USB162 board (http://microsin.ru/content/view/685/44/).
*
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver
* dispatch header located in LUFA/Drivers/Board/Buttons.h.
*
* @{
*/
@ -52,9 +49,6 @@
#define __BUTTONS_MICROSIN162_H__
/* Includes: */
#include <avr/io.h>
#include <stdbool.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */

9
LUFA/Drivers/Board/MICROSIN162/LEDs.h
View File

@ -30,8 +30,7 @@
/** \file
* \brief Board specific LED driver header for the Microsin AVR-USB162 board.
*
* Board specific LED driver header for the Microsin AVR-USB162 board (http://microsin.ru/content/view/685/44/).
* \copydetails Group_LEDs_MICROSIN162
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
@ -39,12 +38,10 @@
/** \ingroup Group_LEDs
* \defgroup Group_LEDs_MICROSIN162 MICROSIN162
* \brief Board specific LED driver header for the Microsin AVR-USB162 board.
*
* Board specific LED driver header for the Microsin AVR-USB162 board (http://microsin.ru/content/view/685/44/).
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
*
* @{
*/
@ -52,8 +49,6 @@
#define __LEDS_MICROSIN162_H__
/* Includes: */
#include <avr/io.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */

10
LUFA/Drivers/Board/MINIMUS/Buttons.h
View File

@ -30,8 +30,7 @@
/** \file
* \brief Board specific Buttons driver header for the MINIMUS.
*
* Board specific Buttons driver header for the MINIMUS.
* \copydetails Group_Buttons_MINIMUS
*
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver
* dispatch header located in LUFA/Drivers/Board/Buttons.h.
@ -39,12 +38,10 @@
/** \ingroup Group_Buttons
* \defgroup Group_Buttons_MINIMUS MINIMUS
* \brief Board specific Buttons driver header for the MINIMUS.
*
* Board specific Buttons driver header for the MINIMUS.
*
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver
* dispatch header located in LUFA/Drivers/Board/Buttons.h.
*
* @{
*/
@ -52,9 +49,6 @@
#define __BUTTONS_MINIMUS_H__
/* Includes: */
#include <avr/io.h>
#include <stdbool.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */

9
LUFA/Drivers/Board/MINIMUS/LEDs.h
View File

@ -30,8 +30,7 @@
/** \file
* \brief Board specific LED driver header for the MINIMUS.
*
* Board specific LED driver header for the Minimus USB (http://www.minimususb.com/).
* \copydetails Group_LEDs_MINIMUS
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
@ -39,12 +38,10 @@
/** \ingroup Group_LEDs
* \defgroup Group_LEDs_MINIMUS MINIMUS
* \brief Board specific LED driver header for the MINIMUS.
*
* Board specific LED driver header for the Minimus USB (http://www.minimususb.com/).
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
*
* @{
*/
@ -52,8 +49,6 @@
#define __LEDS_MINIMUS_H__
/* Includes: */
#include <avr/io.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */

10
LUFA/Drivers/Board/OLIMEX162/Buttons.h
View File

@ -30,8 +30,7 @@
/** \file
* \brief Board specific Buttons driver header for the Olimex AVR-USB-162 Development Board.
*
* Board specific Buttons driver header for the Olimex AVR-USB-162 Development Board (http://www.olimex.com/dev/avr-usb-162.html).
* \copydetails Group_Buttons_OLIMEX162
*
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver
* dispatch header located in LUFA/Drivers/Board/Buttons.h.
@ -39,12 +38,10 @@
/** \ingroup Group_Buttons
* \defgroup Group_Buttons_OLIMEX162 OLIMEX162
* \brief Board specific Buttons driver header for the Olimex AVR-USB-162 Development Board.
*
* Board specific Buttons driver header for the Olimex AVR-USB-162 Development Board (http://www.olimex.com/dev/avr-usb-162.html).
*
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver
* dispatch header located in LUFA/Drivers/Board/Buttons.h.
*
* @{
*/
@ -52,9 +49,6 @@
#define __BUTTONS_OLIMEX162_H__
/* Includes: */
#include <avr/io.h>
#include <stdbool.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */

9
LUFA/Drivers/Board/OLIMEX162/LEDs.h
View File

@ -30,8 +30,7 @@
/** \file
* \brief Board specific LED driver header for the Olimex AVR-USB-162.
*
* Board specific LED driver header for the Olimex AVR-USB-162 (http://www.olimex.com/dev/avr-usb-162.html).
* \copydetails Group_LEDs_OLIMEX162
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
@ -39,12 +38,10 @@
/** \ingroup Group_LEDs
* \defgroup Group_LEDs_OLIMEX162 OLIMEX162
* \brief Board specific LED driver header for the Olimex AVR-USB-162.
*
* Board specific LED driver header for the Olimex AVR-USB-162 (http://www.olimex.com/dev/avr-usb-162.html).
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
*
* @{
*/
@ -52,8 +49,6 @@
#define __LEDS_OLIMEX162_H__
/* Includes: */
#include <avr/io.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */

9
LUFA/Drivers/Board/RZUSBSTICK/LEDs.h
View File

@ -30,8 +30,7 @@
/** \file
* \brief Board specific LED driver header for the Atmel RZUSBSTICK.
*
* Board specific LED driver header for the Atmel RZUSBSTICK.
* \copydetails Group_LEDs_RZUSBSTICK
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
@ -39,12 +38,10 @@
/** \ingroup Group_LEDs
* \defgroup Group_LEDs_RZUSBSTICK RZUSBSTICK
* \brief Board specific LED driver header for the Atmel RZUSBSTICK.
*
* Board specific LED driver header for the Atmel RZUSBSTICK.
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
*
* @{
*/
@ -52,8 +49,6 @@
#define __LEDS_RZUSBSTICK_H__
/* Includes: */
#include <avr/io.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */

11
LUFA/Drivers/Board/SPARKFUN8U2/LEDs.h
View File

@ -30,8 +30,7 @@
/** \file
* \brief Board specific LED driver header for the Sparkfun ATMEGA8U2 breakout board.
*
* Board specific LED driver header for the Sparkfun ATMEGA8U2 breakout board (http://www.sparkfun.com/products/10277).
* \copydetails Group_LEDs_SPARKFUN8U2
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
@ -39,11 +38,9 @@
/** \ingroup Group_LEDs
* \defgroup Group_LEDs_SPARKFUN8U2 SPARKFUN8U2
* \brief Board specific LED driver header for the Sparkfun ATMEGA8U2 breakout board.
*
* Board specific LED driver header for the Sparkfun ATMEGA8U2 breakout board (http://www.sparkfun.com/products/10277).
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
* Board specific LED driver header for the Sparkfun ATMEGA8U2 breakout board (http://www.sparkfun.com/products/10277).
*
* @{
*/
@ -52,8 +49,6 @@
#define __LEDS_SPARKFUN8U2_H__
/* Includes: */
#include <avr/io.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */

16
LUFA/Drivers/Board/STK525/Buttons.h
View File

@ -30,8 +30,7 @@
/** \file
* \brief Board specific Buttons driver header for the Atmel STK525.
*
* Board specific Buttons driver header for the Atmel STK525.
* \copydetails Group_Buttons_STK525
*
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver
* dispatch header located in LUFA/Drivers/Board/Buttons.h.
@ -39,12 +38,10 @@
/** \ingroup Group_Buttons
* \defgroup Group_Buttons_STK525 STK525
* \brief Board specific Buttons driver header for the Atmel STK525.
*
* Board specific Buttons driver header for the Atmel STK525.
*
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver
* dispatch header located in LUFA/Drivers/Board/Buttons.h.
*
* @{
*/
@ -52,15 +49,6 @@
#define __BUTTONS_STK525_H__
/* Includes: */
#include <avr/io.h>
#include <stdbool.h>
#include "../../../Common/Common.h"
/* Includes: */
#include <avr/io.h>
#include <stdbool.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */

7
LUFA/Drivers/Board/STK525/Dataflash.h
View File

@ -30,8 +30,7 @@
/** \file
* \brief Board specific Dataflash driver header for the Atmel STK525.
*
* Board specific Dataflash driver header for the Atmel STK525.
* \copydetails Group_Dataflash_STK525
*
* \note This file should not be included directly. It is automatically included as needed by the dataflash driver
* dispatch header located in LUFA/Drivers/Board/Dataflash.h.
@ -39,12 +38,10 @@
/** \ingroup Group_Dataflash
* \defgroup Group_Dataflash_STK525 STK525
* \brief Board specific Dataflash driver header for the Atmel STK525.
*
* Board specific Dataflash driver header for the Atmel STK525.
*
* \note This file should not be included directly. It is automatically included as needed by the dataflash driver
* dispatch header located in LUFA/Drivers/Board/Dataflash.h.
*
* @{
*/

9
LUFA/Drivers/Board/STK525/Joystick.h
View File

@ -30,8 +30,7 @@
/** \file
* \brief Board specific joystick driver header for the Atmel STK525.
*
* Board specific joystick driver header for the Atmel STK525.
* \copydetails Group_Joystick_STK525
*
* \note This file should not be included directly. It is automatically included as needed by the joystick driver
* dispatch header located in LUFA/Drivers/Board/Joystick.h.
@ -39,12 +38,10 @@
/** \ingroup Group_Joystick
* \defgroup Group_Joystick_STK525 STK525
* \brief Board specific joystick driver header for the Atmel STK525.
*
* Board specific joystick driver header for the Atmel STK525.
*
* \note This file should not be included directly. It is automatically included as needed by the joystick driver
* dispatch header located in LUFA/Drivers/Board/Joystick.h.
*
* @{
*/
@ -52,8 +49,6 @@
#define __JOYSTICK_STK525_H__
/* Includes: */
#include <avr/io.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */

9
LUFA/Drivers/Board/STK525/LEDs.h
View File

@ -30,8 +30,7 @@
/** \file
* \brief Board specific LED driver header for the Atmel STK525.
*
* Board specific LED driver header for the Atmel STK525.
* \copydetails Group_LEDs_STK525
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
@ -39,12 +38,10 @@
/** \ingroup Group_LEDs
* \defgroup Group_LEDs_STK525 STK525
* \brief Board specific LED driver header for the Atmel STK525.
*
* Board specific LED driver header for the Atmel STK525.
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
*
* @{
*/
@ -52,8 +49,6 @@
#define __LEDS_STK525_H__
/* Includes: */
#include <avr/io.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */

16
LUFA/Drivers/Board/STK526/Buttons.h
View File

@ -30,8 +30,7 @@
/** \file
* \brief Board specific Buttons driver header for the Atmel STK526.
*
* Board specific Buttons driver header for the Atmel STK526.
* \copydetails Group_Buttons_STK526
*
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver
* dispatch header located in LUFA/Drivers/Board/Buttons.h.
@ -39,12 +38,10 @@
/** \ingroup Group_Buttons
* \defgroup Group_Buttons_STK526 STK526
* \brief Board specific Buttons driver header for the Atmel STK526.
*
* Board specific Buttons driver header for the Atmel STK526.
*
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver
* dispatch header located in LUFA/Drivers/Board/Buttons.h.
*
* @{
*/
@ -52,15 +49,6 @@
#define __BUTTONS_STK526_H__
/* Includes: */
#include <avr/io.h>
#include <stdbool.h>
#include "../../../Common/Common.h"
/* Includes: */
#include <avr/io.h>
#include <stdbool.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */

7
LUFA/Drivers/Board/STK526/Dataflash.h
View File

@ -30,8 +30,7 @@
/** \file
* \brief Board specific Dataflash driver header for the Atmel STK525.
*
* Board specific Dataflash driver header for the Atmel STK525.
* \copydetails Group_Dataflash_STK526
*
* \note This file should not be included directly. It is automatically included as needed by the dataflash driver
* dispatch header located in LUFA/Drivers/Board/Dataflash.h.
@ -39,12 +38,10 @@
/** \ingroup Group_Dataflash
* \defgroup Group_Dataflash_STK526 STK526
* \brief Board specific Dataflash driver header for the Atmel STK525.
*
* Board specific Dataflash driver header for the Atmel STK525.
*
* \note This file should not be included directly. It is automatically included as needed by the dataflash driver
* dispatch header located in LUFA/Drivers/Board/Dataflash.h.
*
* @{
*/

9
LUFA/Drivers/Board/STK526/Joystick.h
View File

@ -30,8 +30,7 @@
/** \file
* \brief Board specific joystick driver header for the Atmel STK526.
*
* Board specific joystick driver header for the Atmel STK526.
* \copydetails Group_Joystick_STK526
*
* \note This file should not be included directly. It is automatically included as needed by the joystick driver
* dispatch header located in LUFA/Drivers/Board/Joystick.h.
@ -39,12 +38,10 @@
/** \ingroup Group_Joystick
* \defgroup Group_Joystick_STK526 STK526
* \brief Board specific joystick driver header for the Atmel STK526.
*
* Board specific joystick driver header for the Atmel STK526.
*
* \note This file should not be included directly. It is automatically included as needed by the joystick driver
* dispatch header located in LUFA/Drivers/Board/Joystick.h.
*
* @{
*/
@ -52,8 +49,6 @@
#define __JOYSTICK_STK526_H__
/* Includes: */
#include <avr/io.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */

9
LUFA/Drivers/Board/STK526/LEDs.h
View File

@ -30,8 +30,7 @@
/** \file
* \brief Board specific LED driver header for the Atmel STK526.
*
* Board specific LED driver header for the Atmel STK526.
* \copydetails Group_LEDs_STK526
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
@ -39,12 +38,10 @@
/** \ingroup Group_LEDs
* \defgroup Group_LEDs_STK526 STK526
* \brief Board specific LED driver header for the Atmel STK526.
*
* Board specific LED driver header for the Atmel STK526.
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
*
* @{
*/
@ -52,8 +49,6 @@
#define __LEDS_STK526_H__
/* Includes: */
#include <avr/io.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */

9
LUFA/Drivers/Board/TEENSY/LEDs.h
View File

@ -30,8 +30,7 @@
/** \file
* \brief Board specific LED driver header for the PJRC Teensy boards.
*
* Board specific LED driver header for the PJRC Teensy boards (http://www.pjrc.com/teensy/index.html).
* \copydetails Group_LEDs_TEENSY
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
@ -39,12 +38,10 @@
/** \ingroup Group_LEDs
* \defgroup Group_LEDs_TEENSY TEENSY
* \brief Board specific LED driver header for the PJRC Teensy boards.
*
* Board specific LED driver header for the PJRC Teensy boards (http://www.pjrc.com/teensy/index.html).
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
*
* @{
*/
@ -52,8 +49,6 @@
#define __LEDS_TEENSY_H__
/* Includes: */
#include <avr/io.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */

10
LUFA/Drivers/Board/UDIP/Buttons.h
View File

@ -30,8 +30,7 @@
/** \file
* \brief Board specific Buttons driver header for the UDIP.
*
* Board specific Buttons driver header for the Linnix UDIP (http://linnix.com/udip/).
* \copydetails Group_Buttons_UDIP
*
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver
* dispatch header located in LUFA/Drivers/Board/Buttons.h.
@ -39,12 +38,10 @@
/** \ingroup Group_Buttons
* \defgroup Group_Buttons_UDIP UDIP
* \brief Board specific Buttons driver header for the UDIP.
*
* Board specific Buttons driver header for the Linnix UDIP (http://linnix.com/udip/).
*
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver
* dispatch header located in LUFA/Drivers/Board/Buttons.h.
*
* @{
*/
@ -52,9 +49,6 @@
#define __BUTTONS_UDIP_H__
/* Includes: */
#include <avr/io.h>
#include <stdbool.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */

9
LUFA/Drivers/Board/UDIP/LEDs.h
View File

@ -30,8 +30,7 @@
/** \file
* \brief Board specific LED driver header for the Linnix UDIP.
*
* Board specific LED driver header for the Linnix UDIP (http://linnix.com/udip/).
* \copydetails Group_LEDs_UDIP
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
@ -39,12 +38,10 @@
/** \ingroup Group_LEDs
* \defgroup Group_LEDs_UDIP UDIP
* \brief Board specific LED driver header for the Linnix UDIP.
*
* Board specific LED driver header for the Linnix UDIP (http://linnix.com/udip/).
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
*
* @{
*/
@ -52,8 +49,6 @@
#define __LEDS_UDIP_H__
/* Includes: */
#include <avr/io.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */

9
LUFA/Drivers/Board/UNO/LEDs.h
View File

@ -30,8 +30,7 @@
/** \file
* \brief Board specific LED driver header for the Arduino Uno.
*
* Board specific LED driver header for the Arduino Uno (http://arduino.cc/en/Main/ArduinoBoardUno).
* \copydetails Group_LEDs_UNO
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
@ -39,12 +38,10 @@
/** \ingroup Group_LEDs
* \defgroup Group_LEDs_UNO UNO
* \brief Board specific LED driver header for the Arduino Uno.
*
* Board specific LED driver header for the Arduino Uno (http://arduino.cc/en/Main/ArduinoBoardUno).
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
*
* @{
*/
@ -52,7 +49,7 @@
#define __LEDS_UNO_H__
/* Includes: */
#include <avr/io.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */
#if defined(__cplusplus)

10
LUFA/Drivers/Board/USBFOO/Buttons.h
View File

@ -30,8 +30,7 @@
/** \file
* \brief Board specific Buttons driver header for the Kernel Concepts USBFOO.
*
* Board specific Buttons driver header for the Kernel Concepts USBFOO (http://shop.kernelconcepts.de/product_info.php?products_id=102).
* \copydetails Group_Buttons_USBFOO
*
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver
* dispatch header located in LUFA/Drivers/Board/Buttons.h.
@ -39,12 +38,10 @@
/** \ingroup Group_Buttons
* \defgroup Group_Buttons_USBFOO USBFOO
* \brief Board specific Buttons driver header for the Kernel Concepts USBFOO.
*
* Board specific Buttons driver header for the Kernel Concepts USBFOO (http://shop.kernelconcepts.de/product_info.php?products_id=102).
*
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver
* dispatch header located in LUFA/Drivers/Board/Buttons.h.
*
* @{
*/
@ -52,9 +49,6 @@
#define __BUTTONS_USBFOO_H__
/* Includes: */
#include <avr/io.h>
#include <stdbool.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */

9
LUFA/Drivers/Board/USBFOO/LEDS.h
View File

@ -30,8 +30,7 @@
/** \file
* \brief Board specific LED driver header for the Kernel Concepts USBFOO.
*
* Board specific LED driver header for the Kernel Concepts USBFOO (http://shop.kernelconcepts.de/product_info.php?products_id=102).
* \copydetails Group_LEDs_USBFOO
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
@ -39,12 +38,10 @@
/** \ingroup Group_LEDs
* \defgroup Group_LEDs_USBFOO USBFOO
* \brief Board specific LED driver header for the Kernel Concepts USBFOO.
*
* Board specific LED driver header for the Kernel Concepts USBFOO (http://shop.kernelconcepts.de/product_info.php?products_id=102).
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
*
* @{
*/
@ -52,8 +49,6 @@
#define __LEDS_USBFOO_H__
/* Includes: */
#include <avr/io.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */

10
LUFA/Drivers/Board/USBKEY/Buttons.h
View File

@ -30,8 +30,7 @@
/** \file
* \brief Board specific Buttons driver header for the Atmel USBKEY.
*
* Board specific Buttons driver header for the Atmel USBKEY.
* \copydetails Group_Buttons_USBKEY
*
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver
* dispatch header located in LUFA/Drivers/Board/Buttons.h.
@ -39,12 +38,10 @@
/** \ingroup Group_Buttons
* \defgroup Group_Buttons_USBKEY USBKEY
* \brief Board specific Buttons driver header for the Atmel USBKEY.
*
* Board specific Buttons driver header for the Atmel USBKEY.
*
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver
* dispatch header located in LUFA/Drivers/Board/Buttons.h.
*
* @{
*/
@ -52,9 +49,6 @@
#define __BUTTONS_USBKEY_H__
/* Includes: */
#include <avr/io.h>
#include <stdbool.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */

7
LUFA/Drivers/Board/USBKEY/Dataflash.h
View File

@ -30,8 +30,7 @@
/** \file
* \brief Board specific Dataflash driver header for the Atmel USBKEY.
*
* Board specific Dataflash driver header for the Atmel USBKEY.
* \copydetails Group_Dataflash_USBKEY
*
* \note This file should not be included directly. It is automatically included as needed by the dataflash driver
* dispatch header located in LUFA/Drivers/Board/Dataflash.h.
@ -39,12 +38,10 @@
/** \ingroup Group_Dataflash
* \defgroup Group_Dataflash_USBKEY USBKEY
* \brief Board specific Dataflash driver header for the Atmel USBKEY.
*
* Board specific Dataflash driver header for the Atmel USBKEY board.
*
* \note This file should not be included directly. It is automatically included as needed by the dataflash driver
* dispatch header located in LUFA/Drivers/Board/Dataflash.h.
*
* @{
*/

9
LUFA/Drivers/Board/USBKEY/Joystick.h
View File

@ -30,8 +30,7 @@
/** \file
* \brief Board specific joystick driver header for the Atmel USBKEY.
*
* Board specific joystick driver header for the Atmel USBKEY.
* \copydetails Group_Joystick_USBKEY
*
* \note This file should not be included directly. It is automatically included as needed by the joystick driver
* dispatch header located in LUFA/Drivers/Board/Joystick.h.
@ -39,12 +38,10 @@
/** \ingroup Group_Joystick
* \defgroup Group_Joystick_USBKEY USBKEY
* \brief Board specific joystick driver header for the Atmel USBKEY.
*
* Board specific joystick driver header for the Atmel USBKEY.
*
* \note This file should not be included directly. It is automatically included as needed by the joystick driver
* dispatch header located in LUFA/Drivers/Board/Joystick.h.
*
* @{
*/
@ -52,8 +49,6 @@
#define __JOYSTICK_USBKEY_H__
/* Includes: */
#include <avr/io.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */

9
LUFA/Drivers/Board/USBKEY/LEDs.h
View File

@ -30,8 +30,7 @@
/** \file
* \brief Board specific LED driver header for the Atmel USBKEY.
*
* Board specific LED driver header for the Atmel USBKEY.
* \copydetails Group_LEDs_USBKEY
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
@ -39,12 +38,10 @@
/** \ingroup Group_LEDs
* \defgroup Group_LEDs_USBKEY USBKEY
* \brief Board specific LED driver header for the Atmel USBKEY.
*
* Board specific LED driver header for the Atmel USBKEY.
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
*
* @{
*/
@ -52,8 +49,6 @@
#define __LEDS_USBKEY_H__
/* Includes: */
#include <avr/io.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */

10
LUFA/Drivers/Board/USBTINYMKII/Buttons.h
View File

@ -30,8 +30,7 @@
/** \file
* \brief Board specific Buttons driver header for Tom's USBTINY MKII.
*
* Board specific Buttons driver header for Tom's USBTINY MKII (http://tom-itx.dyndns.org:81/~webpage/).
* \copydetails Group_Buttons_USBTINYMKII
*
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver
* dispatch header located in LUFA/Drivers/Board/Buttons.h.
@ -39,12 +38,10 @@
/** \ingroup Group_Buttons
* \defgroup Group_Buttons_USBTINYMKII USBTINYMKII
* \brief Board specific Buttons driver header for Tom's USBTINY MKII.
*
* Board specific Buttons driver header for Tom's USBTINY MKII (http://tom-itx.dyndns.org:81/~webpage/).
*
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver
* dispatch header located in LUFA/Drivers/Board/Buttons.h.
*
* @{
*/
@ -52,9 +49,6 @@
#define __BUTTONS_USBTINYMKII_H__
/* Includes: */
#include <avr/io.h>
#include <stdbool.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */

9
LUFA/Drivers/Board/USBTINYMKII/LEDs.h
View File

@ -30,8 +30,7 @@
/** \file
* \brief Board specific LED driver header for Tom's USBTINY MKII.
*
* Board specific LED driver header for Tom's USBTINY MKII (http://tom-itx.dyndns.org:81/~webpage/).
* \copydetails Group_LEDs_USBTINYMKII
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
@ -39,12 +38,10 @@
/** \ingroup Group_LEDs
* \defgroup Group_LEDs_USBTINYMKII USBTINYMKII
* \brief Board specific LED driver header for Tom's USBTINY MKII.
*
* Board specific LED driver header for Tom's USBTINY MKII (http://tom-itx.dyndns.org:81/~webpage/).
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
*
* @{
*/
@ -52,7 +49,7 @@
#define __LEDS_USBTINYMKII_H__
/* Includes: */
#include <avr/io.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */
#if defined(__cplusplus)

7
LUFA/Drivers/Board/XPLAIN/Dataflash.h
View File

@ -30,8 +30,7 @@
/** \file
* \brief Board specific Dataflash driver header for the Atmel XPLAIN.
*
* Board specific Dataflash driver header for the Atmel XPLAIN.
* \copydetails Group_Dataflash_XPLAIN
*
* \note This file should not be included directly. It is automatically included as needed by the dataflash driver
* dispatch header located in LUFA/Drivers/Board/Dataflash.h.
@ -39,12 +38,10 @@
/** \ingroup Group_Dataflash
* \defgroup Group_Dataflash_XPLAIN XPLAIN
* \brief Board specific Dataflash driver header for the Atmel XPLAIN.
*
* Board specific Dataflash driver header for the Atmel XPLAIN.
*
* \note This file should not be included directly. It is automatically included as needed by the dataflash driver
* dispatch header located in LUFA/Drivers/Board/Dataflash.h.
*
* @{
*/

9
LUFA/Drivers/Board/XPLAIN/LEDs.h
View File

@ -30,8 +30,7 @@
/** \file
* \brief Board specific LED driver header for the Atmel XPLAIN.
*
* Board specific LED driver header for the Atmel XPLAIN.
* \copydetails Group_LEDs_XPLAIN
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
@ -39,12 +38,10 @@
/** \ingroup Group_LEDs
* \defgroup Group_LEDs_XPLAIN XPLAIN
* \brief Board specific LED driver header for the Atmel XPLAIN.
*
* Board specific LED driver header for the Atmel XPLAIN.
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
*
* @{
*/
@ -52,8 +49,6 @@
#define __LEDS_XPLAIN_H__
/* Includes: */
#include <avr/io.h>
#include "../../../Common/Common.h"
/* Enable C linkage for C++ Compilers: */

8
LUFA/Drivers/Misc/AT45DB321C.h
View File

@ -29,13 +29,13 @@
*/
/** \file
* \brief Dataflash command constants for the the Atmel AT45DB321C Dataflash IC
*
* Dataflash command constants for the Atmel AT45DB321C Dataflash IC.
* \brief Command constants for the Atmel AT45DB321C Dataflash.
* \copydetails Group_AT45DB321C
*/
/** \ingroup Group_MiscDrivers
* \defgroup Group_AT45DB321C AT45DB321C Commands
* \defgroup Group_AT45DB321C Atmel AT45DB321C Dataflash Commands
* \brief Command constants for the Atmel AT45DB321C Dataflash.
*
* Dataflash command constants for the Atmel AT45DB321C Dataflash IC.
*

8
LUFA/Drivers/Misc/AT45DB642D.h
View File

@ -29,13 +29,13 @@
*/
/** \file
* \brief Dataflash command constants for the the Atmel AT45DB642D Dataflash IC
*
* Dataflash command constants for the Atmel AT45DB642D Dataflash IC.
* \brief Command constants for the Atmel AT45DB642D Dataflash.
* \copydetails Group_AT45DB642D
*/
/** \ingroup Group_MiscDrivers
* \defgroup Group_AT45DB642D AT45DB642D Commands
* \defgroup Group_AT45DB642D Atmel AT45DB642D Dataflash Commands
* \brief Command constants for the Atmel AT45DB642D Dataflash.
*
* Dataflash command constants for the Atmel AT45DB642D Dataflash IC.
*

4
LUFA/Drivers/Misc/RingBuffer.h
View File

@ -93,10 +93,6 @@
#define __RING_BUFFER_H__
/* Includes: */
#include <util/atomic.h>
#include <stdint.h>
#include <stdbool.h>
#include "../../Common/Common.h"
/* Type Defines: */

2
LUFA/Drivers/USB/Class/Common/Audio.h
View File

@ -53,8 +53,6 @@
/* Includes: */
#include "../../Core/StdDescriptors.h"
#include <string.h>
/* Enable C linkage for C++ Compilers: */
#if defined(__cplusplus)
extern "C" {

2
LUFA/Drivers/USB/Class/Common/CDC.h
View File

@ -53,8 +53,6 @@
/* Includes: */
#include "../../Core/StdDescriptors.h"
#include <string.h>
/* Enable C linkage for C++ Compilers: */
#if defined(__cplusplus)
extern "C" {

2
LUFA/Drivers/USB/Class/Common/HID.h
View File

@ -54,8 +54,6 @@
#include "../../Core/StdDescriptors.h"
#include "HIDParser.h"
#include <string.h>
/* Preprocessor Checks: */
#if !defined(__INCLUDE_FROM_HID_DRIVER)
#error Do not include this file directly. Include LUFA/Drivers/USB.h instead.

2
LUFA/Drivers/USB/Class/Common/HIDParser.h
View File

@ -70,8 +70,6 @@
#include "HIDReportData.h"
#include "../Common/HID.h"
#include <string.h>
/* Enable C linkage for C++ Compilers: */
#if defined(__cplusplus)

2
LUFA/Drivers/USB/Class/Common/MIDI.h
View File

@ -57,8 +57,6 @@
#include "../../Core/StdDescriptors.h"
#include "Audio.h"
#include <string.h>
/* Enable C linkage for C++ Compilers: */
#if defined(__cplusplus)
extern "C" {

2
LUFA/Drivers/USB/Class/Common/MassStorage.h
View File

@ -53,8 +53,6 @@
/* Includes: */
#include "../../Core/StdDescriptors.h"
#include <string.h>
/* Enable C linkage for C++ Compilers: */
#if defined(__cplusplus)
extern "C" {

2
LUFA/Drivers/USB/Class/Common/Printer.h
View File

@ -53,8 +53,6 @@
/* Includes: */
#include "../../Core/StdDescriptors.h"
#include <string.h>
/* Enable C linkage for C++ Compilers: */
#if defined(__cplusplus)
extern "C" {

2
LUFA/Drivers/USB/Class/Common/RNDIS.h
View File

@ -57,8 +57,6 @@
#include "../../Core/StdDescriptors.h"
#include "CDC.h"
#include <string.h>
/* Enable C linkage for C++ Compilers: */
#if defined(__cplusplus)
extern "C" {

2
LUFA/Drivers/USB/Class/Common/StillImage.h
View File

@ -53,8 +53,6 @@
/* Includes: */
#include "../../Core/StdDescriptors.h"
#include <string.h>
/* Enable C linkage for C++ Compilers: */
#if defined(__cplusplus)
extern "C" {

2
LUFA/Drivers/USB/Class/Device/Audio.h
View File

@ -57,8 +57,6 @@
#include "../../USB.h"
#include "../Common/Audio.h"
#include <string.h>
/* Enable C linkage for C++ Compilers: */
#if defined(__cplusplus)
extern "C" {

1
LUFA/Drivers/USB/Class/Device/CDC.h
View File

@ -75,7 +75,6 @@
#include "../Common/CDC.h"
#include <stdio.h>
#include <string.h>
/* Enable C linkage for C++ Compilers: */
#if defined(__cplusplus)

2
LUFA/Drivers/USB/Class/Device/HID.h
View File

@ -57,8 +57,6 @@
#include "../../USB.h"
#include "../Common/HID.h"
#include <string.h>
/* Enable C linkage for C++ Compilers: */
#if defined(__cplusplus)
extern "C" {

2
LUFA/Drivers/USB/Class/Device/MIDI.h
View File

@ -57,8 +57,6 @@
#include "../../USB.h"
#include "../Common/MIDI.h"
#include <string.h>
/* Enable C linkage for C++ Compilers: */
#if defined(__cplusplus)
extern "C" {

2
LUFA/Drivers/USB/Class/Device/MassStorage.h
View File

@ -57,8 +57,6 @@
#include "../../USB.h"
#include "../Common/MassStorage.h"
#include <string.h>
/* Enable C linkage for C++ Compilers: */
#if defined(__cplusplus)
extern "C" {

2
LUFA/Drivers/USB/Class/Device/RNDIS.h
View File

@ -57,8 +57,6 @@
#include "../../USB.h"
#include "../Common/RNDIS.h"
#include <string.h>
/* Enable C linkage for C++ Compilers: */
#if defined(__cplusplus)
extern "C" {

1
LUFA/Drivers/USB/Class/Host/CDC.h
View File

@ -58,7 +58,6 @@
#include "../Common/CDC.h"
#include <stdio.h>
#include <string.h>
/* Enable C linkage for C++ Compilers: */
#if defined(__cplusplus)

3
LUFA/Drivers/USB/Class/Host/RNDIS.h
View File

@ -58,9 +58,6 @@
#include "../../USB.h"
#include "../Common/RNDIS.h"
#include <stdio.h>
#include <string.h>
/* Enable C linkage for C++ Compilers: */
#if defined(__cplusplus)
extern "C" {

55
LUFA/Drivers/USB/Core/AVR8/Device.h
View File

@ -29,9 +29,8 @@
*/
/** \file
* \brief USB device mode definitions (AVR8)
*
* This file contains structures, function prototypes and macros related to USB device mode.
* \brief USB Device definitions for the AVR8 microcontrollers.
* \copydetails Group_Device_AVR8
*
* \note This file should not be included directly. It is automatically included as needed by the USB driver
* dispatch header located in LUFA/Drivers/USB/USB.h.
@ -39,9 +38,9 @@
/** \ingroup Group_Device
* \defgroup Group_Device_AVR8 Device Management (AVR8)
* \brief USB Device definitions for the AVR8 microcontrollers.
*
* USB Device mode related macros and enums. This module contains macros and enums which are used when
* the USB controller is initialized in device mode.
* Architecture specific USB Device definitions for the Atmel 8-bit AVR microcontrollers.
*
* @{
*/
@ -55,17 +54,15 @@
#include "../USBInterrupt.h"
#include "../Endpoint.h"
#include <avr/boot.h>
/* Preprocessor Checks: */
#if (defined(USE_RAM_DESCRIPTORS) && defined(USE_EEPROM_DESCRIPTORS))
#error USE_RAM_DESCRIPTORS and USE_EEPROM_DESCRIPTORS are mutually exclusive.
#endif
#if !defined(__INCLUDE_FROM_USB_DRIVER)
#error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
#endif
#if (defined(USE_RAM_DESCRIPTORS) && defined(USE_EEPROM_DESCRIPTORS))
#error USE_RAM_DESCRIPTORS and USE_EEPROM_DESCRIPTORS are mutually exclusive.
#endif
/* Public Interface - May be used in end-application: */
/* Macros: */
/** \name USB Device Mode Option Masks */
@ -125,7 +122,7 @@
* the \ref USB_OPT_MANUAL_PLL option enabled, the user must ensure that the PLL is running
* before attempting to call this function.
*
* \see \ref Group_Descriptors for more information on the RMWAKEUP feature and device descriptors.
* \see \ref Group_StdDescriptors for more information on the RMWAKEUP feature and device descriptors.
*/
void USB_Device_SendRemoteWakeup(void);
@ -192,40 +189,6 @@
}
#endif
/* Function Prototypes: */
/** Function to retrieve a given descriptor's size and memory location from the given descriptor type value,
* index and language ID. This function MUST be overridden in the user application (added with full, identical
* prototype and name so that the library can call it to retrieve descriptor data.
*
* \param[in] wValue The type of the descriptor to retrieve in the upper byte, and the index in the
* lower byte (when more than one descriptor of the given type exists, such as the
* case of string descriptors). The type may be one of the standard types defined
* in the DescriptorTypes_t enum, or may be a class-specific descriptor type value.
* \param[in] wIndex The language ID of the string to return if the \c wValue type indicates
* \ref DTYPE_String, otherwise zero for standard descriptors, or as defined in a
* class-specific standards.
* \param[out] DescriptorAddress Pointer to the descriptor in memory. This should be set by the routine to
* the address of the descriptor.
* \param[out] MemoryAddressSpace A value from the \ref USB_DescriptorMemorySpaces_t enum to indicate the memory
* space in which the descriptor is stored. This parameter does not exist when one
* of the \c USE_*_DESCRIPTORS compile time options is used.
*
* \note By default, the library expects all descriptors to be located in flash memory via the \c PROGMEM attribute.
* If descriptors should be located in RAM or EEPROM instead (to speed up access in the case of RAM, or to
* allow the descriptors to be changed dynamically at runtime) either the \c USE_RAM_DESCRIPTORS or the
* \c USE_EEPROM_DESCRIPTORS tokens may be defined in the project makefile and passed to the compiler by the -D
* switch.
*
* \return Size in bytes of the descriptor if it exists, zero or \ref NO_DESCRIPTOR otherwise.
*/
uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
const uint8_t wIndex,
const void** const DescriptorAddress
#if !defined(USE_FLASH_DESCRIPTORS) && !defined(USE_EEPROM_DESCRIPTORS) && !defined(USE_RAM_DESCRIPTORS)
, uint8_t* MemoryAddressSpace
#endif
) ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);
/* Private Interface - For use in library only: */
#if !defined(__DOXYGEN__)
/* Inline Functions: */

7
LUFA/Drivers/USB/Core/AVR8/Endpoint.h
View File

@ -29,10 +29,8 @@
*/
/** \file
* \brief USB device endpoint management definitions.
*
* This file contains structures, function prototypes and macros related to the management of the device's
* data endpoints when the library is initialized in USB device mode.
* \brief USB Endpoint definitions for the AVR8 microcontrollers.
* \copydetails Group_EndpointManagement_AVR8
*
* \note This file should not be included directly. It is automatically included as needed by the USB driver
* dispatch header located in LUFA/Drivers/USB/USB.h.
@ -40,6 +38,7 @@
/** \ingroup Group_EndpointRW
* \defgroup Group_EndpointRW_AVR8 Endpoint Data Reading and Writing (AVR8)
* \brief USB Endpoint definitions for the AVR8 microcontrollers.
*
* Functions, macros, variables, enums and types related to data reading and writing from and to endpoints.
*/

9
LUFA/Drivers/USB/Core/AVR8/Host.h
View File

@ -29,9 +29,8 @@
*/
/** \file
* \brief USB host mode definitions (AVR8)
*
* This file contains structures, function prototypes and macros related to USB host mode.
* \brief USB Host definitions for the AVR8 microcontrollers.
* \copydetails Group_Host_AVR8
*
* \note This file should not be included directly. It is automatically included as needed by the USB driver
* dispatch header located in LUFA/Drivers/USB/USB.h.
@ -39,9 +38,9 @@
/** \ingroup Group_Host
* \defgroup Group_Host_AVR8 Host Management (AVR8)
* \brief USB Host definitions for the AVR8 microcontrollers.
*
* USB Host mode related macros and enums. This module contains macros and enums which are used when
* the USB controller is initialized in host mode.
* Architecture specific USB Host definitions for the Atmel 8-bit AVR microcontrollers.
*
* @{
*/

11
LUFA/Drivers/USB/Core/AVR8/OTG.h
View File

@ -29,10 +29,8 @@
*/
/** \file
* \brief USB OTG mode definitions (AVR8)
*
* This file contains structures, function prototypes and macros related to USB OTG mode, where two USB devices
* may be linked directly together and exchange host/device roles as needed.
* \brief USB OTG definitions for the AVR8 microcontrollers.
* \copydetails Group_OTG_AVR8
*
* \note This file should not be included directly. It is automatically included as needed by the USB driver
* dispatch header located in LUFA/Drivers/USB/USB.h.
@ -40,10 +38,9 @@
/** \ingroup Group_OTG
* \defgroup Group_OTG_AVR8 USB On The Go (OTG) Management (AVR8)
* \brief USB OTG definitions for the AVR8 microcontrollers.
*
* This module contains macros for embedded USB hosts with dual role On The Go capabilities, for managing role
* exchange. OTG is a way for two USB dual role devices to talk to one another directly without fixed device/host
* roles.
* Architecture specific USB OTG definitions for the Atmel 8-bit AVR microcontrollers.
*
* @{
*/

7
LUFA/Drivers/USB/Core/AVR8/Pipe.h
View File

@ -29,10 +29,8 @@
*/
/** \file
* \brief USB host pipe management definitions.
*
* This file contains structures, function prototypes and macros related to the management of the device's
* data pipes when the library is initialized in USB host mode.
* \brief USB Pipe definitions for the AVR8 microcontrollers.
* \copydetails Group_PipeManagement_AVR8
*
* \note This file should not be included directly. It is automatically included as needed by the USB driver
* dispatch header located in LUFA/Drivers/USB/USB.h.
@ -40,6 +38,7 @@
/** \ingroup Group_PipeRW
* \defgroup Group_PipeRW_AVR8 Pipe Data Reading and Writing (AVR8)
* \brief USB Pipe definitions for the AVR8 microcontrollers.
*
* Functions, macros, variables, enums and types related to data reading and writing from and to pipes.
*/

9
LUFA/Drivers/USB/Core/AVR8/USBController.h
View File

@ -29,10 +29,8 @@
*/
/** \file
* \brief USB low level USB controller definitions (AVR8)
*
* This file contains structures, function prototypes and macros related to the low level configuration of the
* USB controller, to start, stop and reset the USB library core.
* \brief USB Controller definitions for the AVR8 microcontrollers.
* \copydetails Group_USBManagement_AVR8
*
* \note This file should not be included directly. It is automatically included as needed by the USB driver
* dispatch header located in LUFA/Drivers/USB/USB.h.
@ -40,6 +38,7 @@
/** \ingroup Group_USBManagement
* \defgroup Group_USBManagement_AVR8 USB Interface Management (AVR8)
* \brief USB Controller definitions for the AVR8 microcontrollers.
*
* Functions, macros, variables, enums and types related to the setup and management of the USB interface.
*
@ -82,7 +81,7 @@
#endif
#if !defined(F_CLOCK)
#error F_CLOCK is not defined. You must define F_CLOCK to the frequency of the unprescaled input clock in your project makefile.
#error F_CLOCK is not defined. You must define F_CLOCK to the frequency of the unprescaled USB controller clock in your project makefile.
#endif
#if (F_CLOCK == 8000000)

12
LUFA/Drivers/USB/Core/AVR8/USBInterrupt.h
View File

@ -29,7 +29,7 @@
*/
/** \file
* \brief USB controller interrupt service routine management (AVR8)
* \brief USB Controller Interrupt definitions for the AVR8 microcontrollers.
*
* This file contains definitions required for the correct handling of low level USB service routine interrupts
* from the USB controller.
@ -63,11 +63,11 @@
#define USB_INT_IsEnabled(int) ((USB_INT_GET_EN_REG(int) & USB_INT_GET_EN_MASK(int)) ? true : false)
#define USB_INT_HasOccurred(int) ((USB_INT_GET_INT_REG(int) & USB_INT_GET_INT_MASK(int)) ? true : false)
#define USB_INT_GET_EN_REG(a, b, c, d) a
#define USB_INT_GET_EN_MASK(a, b, c, d) b
#define USB_INT_GET_INT_REG(a, b, c, d) c
#define USB_INT_GET_INT_MASK(a, b, c, d) d
#define USB_INT_GET_EN_REG(EnableReg, EnableMask, FlagReg, FlagMask) EnableReg
#define USB_INT_GET_EN_MASK(EnableReg, EnableMask, FlagReg, FlagMask) EnableMask
#define USB_INT_GET_INT_REG(EnableReg, EnableMask, FlagReg, FlagMask) FlagReg
#define USB_INT_GET_INT_MASK(EnableReg, EnableMask, FlagReg, FlagMask) FlagMask
#define USB_INT_VBUS USBCON, (1 << VBUSTE) , USBINT, (1 << VBUSTI)
#define USB_INT_IDTI USBCON, (1 << IDTE) , USBINT, (1 << IDTI)
#define USB_INT_WAKEUPI UDIEN , (1 << WAKEUPE), UDINT , (1 << WAKEUPI)

12
LUFA/Drivers/USB/Core/ConfigDescriptor.h
View File

@ -29,11 +29,8 @@
*/
/** \file
* \brief Configuration descriptor parser API.
*
* This section of the library gives a friendly API which can be used in host applications to easily
* parse an attached device's configuration descriptor so that endpoint, interface and other descriptor
* data can be extracted and used as needed.
* \brief USB Configuration Descriptor definitions.
* \copydetails Group_ConfigDescriptorParser
*
* \note This file should not be included directly. It is automatically included as needed by the USB driver
* dispatch header located in LUFA/Drivers/USB/USB.h.
@ -41,8 +38,11 @@
/** \ingroup Group_Descriptors
* \defgroup Group_ConfigDescriptorParser Configuration Descriptor Parser
* \brief USB Configuration Descriptor definitions.
*
* Functions, macros, variables, enums and types related to the parsing of Configuration Descriptors.
* This section of the library gives a friendly API which can be used in host applications to easily
* parse an attached device's configuration descriptor so that endpoint, interface and other descriptor
* data can be extracted and used as needed.
*
* @{
*/

42
LUFA/Drivers/USB/Core/Device.h
View File

@ -29,10 +29,8 @@
*/
/** \file
* \brief Common USB device mode definitions.
*
* This file contains common structures, function prototypes and macros related to USB device mode for all
* architectures.
* \brief Common USB Device definitions for all architectures.
* \copydetails Group_Device
*
* \note This file should not be included directly. It is automatically included as needed by the USB driver
* dispatch header located in LUFA/Drivers/USB/USB.h.
@ -40,6 +38,7 @@
/** \ingroup Group_USB
* \defgroup Group_Device Device Management
* \brief Common USB Device definitions for all architectures.
*
* USB Device mode related definitions common to all architectures. This module contains definitions which
* are used when the USB controller is initialized in device mode.
@ -65,6 +64,41 @@
#error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
#endif
/* Public Interface - May be used in end-application: */
/* Function Prototypes: */
/** Function to retrieve a given descriptor's size and memory location from the given descriptor type value,
* index and language ID. This function MUST be overridden in the user application (added with full, identical
* prototype and name so that the library can call it to retrieve descriptor data.
*
* \param[in] wValue The type of the descriptor to retrieve in the upper byte, and the index in the
* lower byte (when more than one descriptor of the given type exists, such as the
* case of string descriptors). The type may be one of the standard types defined
* in the DescriptorTypes_t enum, or may be a class-specific descriptor type value.
* \param[in] wIndex The language ID of the string to return if the \c wValue type indicates
* \ref DTYPE_String, otherwise zero for standard descriptors, or as defined in a
* class-specific standards.
* \param[out] DescriptorAddress Pointer to the descriptor in memory. This should be set by the routine to
* the address of the descriptor.
* \param[out] MemoryAddressSpace A value from the \ref USB_DescriptorMemorySpaces_t enum to indicate the memory
* space in which the descriptor is stored. This parameter does not exist when one
* of the \c USE_*_DESCRIPTORS compile time options is used.
*
* \note By default, the library expects all descriptors to be located in flash memory via the \c PROGMEM attribute.
* If descriptors should be located in RAM or EEPROM instead (to speed up access in the case of RAM, or to
* allow the descriptors to be changed dynamically at runtime) either the \c USE_RAM_DESCRIPTORS or the
* \c USE_EEPROM_DESCRIPTORS tokens may be defined in the project makefile and passed to the compiler by the -D
* switch.
*
* \return Size in bytes of the descriptor if it exists, zero or \ref NO_DESCRIPTOR otherwise.
*/
uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
const uint8_t wIndex,
const void** const DescriptorAddress
#if !defined(USE_FLASH_DESCRIPTORS) && !defined(USE_EEPROM_DESCRIPTORS) && !defined(USE_RAM_DESCRIPTORS)
, uint8_t* MemoryAddressSpace
#endif
) ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);
#endif
/** @} */

7
LUFA/Drivers/USB/Core/Endpoint.h
View File

@ -29,10 +29,8 @@
*/
/** \file
* \brief USB device endpoint management definitions.
*
* This file contains structures, function prototypes and macros related to the management of the device's
* data endpoints when the library is initialized in USB device mode.
* \brief Common USB Endpoint definitions for all architectures.
* \copydetails Group_EndpointManagement
*
* \note This file should not be included directly. It is automatically included as needed by the USB driver
* dispatch header located in LUFA/Drivers/USB/USB.h.
@ -40,6 +38,7 @@
/** \ingroup Group_EndpointManagement
* \defgroup Group_EndpointRW Endpoint Data Reading and Writing
* \brief Common USB Endpoint definitions for all architectures.
*
* Functions, macros, variables, enums and types related to data reading and writing from and to endpoints.
*/

7
LUFA/Drivers/USB/Core/EndpointStream.h
View File

@ -29,10 +29,8 @@
*/
/** \file
* \brief USB device endpoint stream function definitions.
*
* This file contains structures, function prototypes and macros related to the sending and receiving of
* arbitrary data streams through the device's data endpoints when the library is initialized in USB device mode.
* \brief Endpoint data stream transmission and reception management.
* \copydetails Group_EndpointStreamRW
*
* \note This file should not be included directly. It is automatically included as needed by the USB driver
* dispatch header located in LUFA/Drivers/USB/USB.h.
@ -40,6 +38,7 @@
/** \ingroup Group_EndpointRW
* \defgroup Group_EndpointStreamRW Read/Write of Multi-Byte Streams
* \brief Endpoint data stream transmission and reception management.
*
* Functions, macros, variables, enums and types related to data reading and writing of data streams from
* and to endpoints.

16
LUFA/Drivers/USB/Core/Events.h
View File

@ -29,19 +29,8 @@
*/
/** \file
* \brief USB controller events manager.
*
* This file contains macros and functions relating to the management of library events, which are small
* pieces of code similar to ISRs which are run when a given condition is met. Each event can be fired from
* multiple places in the user or library code, which may or may not be inside an ISR, thus each handler
* should be written to be as small and fast as possible to prevent possible problems.
*
* Events can be hooked by the user application by declaring a handler function with the same name and parameters
* listed here. If an event with no user-associated handler is fired within the library, it by default maps to an
* internal empty stub function.
*
* Each event must only have one associated event handler, but can be raised by multiple sources by calling the
* event handler function (with any required event parameters).
* \brief USB Event management definitions.
* \copydetails Group_Events
*
* \note This file should not be included directly. It is automatically included as needed by the USB driver
* dispatch header located in LUFA/Drivers/USB/USB.h.
@ -49,6 +38,7 @@
/** \ingroup Group_USB
* \defgroup Group_Events USB Events
* \brief USB Event management definitions.
*
* This module contains macros and functions relating to the management of library events, which are small
* pieces of code similar to ISRs which are run when a given condition is met. Each event can be fired from

7
LUFA/Drivers/USB/Core/Host.h
View File

@ -29,10 +29,8 @@
*/
/** \file
* \brief USB host mode definitions.
*
* USB Host mode related macros and enums. This module contains macros and enums which are used when
* the USB controller is initialized in host mode.
* \brief Common USB Host definitions for all architectures.
* \copydetails Group_Host
*
* \note This file should not be included directly. It is automatically included as needed by the USB driver
* dispatch header located in LUFA/Drivers/USB/USB.h.
@ -40,6 +38,7 @@
/** \ingroup Group_USB
* \defgroup Group_Host Host Management
* \brief Common USB Host definitions for all architectures.
*
* USB Host mode related macros and enums. This module contains macros and enums which are used when
* the USB controller is initialized in host mode.

7
LUFA/Drivers/USB/Core/OTG.h
View File

@ -29,10 +29,8 @@
*/
/** \file
* \brief USB OTG mode definitions.
*
* This file contains structures, function prototypes and macros related to USB OTG mode, where two USB devices
* may be linked directly together and exchange host/device roles as needed.
* \brief Common USB OTG definitions for all architectures.
* \copydetails Group_OTG
*
* \note This file should not be included directly. It is automatically included as needed by the USB driver
* dispatch header located in LUFA/Drivers/USB/USB.h.
@ -40,6 +38,7 @@
/** \ingroup Group_USB
* \defgroup Group_OTG USB On The Go (OTG) Management
* \brief Common USB OTG definitions for all architectures.
*
* This module contains macros for embedded USB hosts with dual role On The Go capabilities, for managing role
* exchange. OTG is a way for two USB dual role devices to talk to one another directly without fixed device/host

7
LUFA/Drivers/USB/Core/Pipe.h
View File

@ -29,10 +29,8 @@
*/
/** \file
* \brief USB host pipe management definitions.
*
* This file contains structures, function prototypes and macros related to the management of the device's
* data pipes when the library is initialized in USB host mode.
* \brief Common USB Pipe definitions for all architectures.
* \copydetails Group_PipeManagement
*
* \note This file should not be included directly. It is automatically included as needed by the USB driver
* dispatch header located in LUFA/Drivers/USB/USB.h.
@ -40,6 +38,7 @@
/** \ingroup Group_PipeManagement
* \defgroup Group_PipeRW Pipe Data Reading and Writing
* \brief Common USB Pipe definitions for all architectures.
*
* Functions, macros, variables, enums and types related to data reading and writing from and to pipes.
*/

7
LUFA/Drivers/USB/Core/PipeStream.h
View File

@ -29,10 +29,8 @@
*/
/** \file
* \brief USB host pipe stream function definitions.
*
* This file contains structures, function prototypes and macros related to the sending and receiving of
* arbitrary data streams through the device's data pipes when the library is initialized in USB host mode.
* \brief Pipe data stream transmission and reception management.
* \copydetails Group_PipeStreamRW
*
* \note This file should not be included directly. It is automatically included as needed by the USB driver
* dispatch header located in LUFA/Drivers/USB/USB.h.
@ -40,6 +38,7 @@
/** \ingroup Group_PipeRW
* \defgroup Group_PipeStreamRW Read/Write of Multi-Byte Streams
* \brief Pipe data stream transmission and reception management.
*
* Functions, macros, variables, enums and types related to data reading and writing of data streams from
* and to pipes.

8
LUFA/Drivers/USB/Core/StdDescriptors.h
View File

@ -29,16 +29,16 @@
*/
/** \file
* \brief USB standard descriptor definitions.
*
* This file contains structures and macros for the easy creation of standard USB descriptors in USB device projects.
* \brief Common USB Descriptor definitions for all architectures.
* \copydetails Group_StdDescriptors
*
* \note This file should not be included directly. It is automatically included as needed by the USB driver
* dispatch header located in LUFA/Drivers/USB/USB.h.
*/
/** \ingroup Group_USB
* \defgroup Group_Descriptors USB Descriptors
* \defgroup Group_StdDescriptors USB Descriptors
* \brief Common USB Descriptor definitions for all architectures.
*
* Standard USB device descriptor defines and retrieval routines, for USB devices. This module contains
* structures and macros for the easy creation of standard USB descriptors in USB device projects.

4
LUFA/Drivers/USB/Core/StdRequestType.h
View File

@ -30,8 +30,7 @@
/** \file
* \brief USB control endpoint request definitions.
*
* This file contains structures and macros for the easy creation and parsing of standard USB control requests.
* \copydetails Group_StdRequest
*
* \note This file should not be included directly. It is automatically included as needed by the USB driver
* dispatch header located in LUFA/Drivers/USB/USB.h.
@ -39,6 +38,7 @@
/** \ingroup Group_USB
* \defgroup Group_StdRequest Standard USB Requests
* \brief USB control endpoint request definitions.
*
* This module contains definitions for the various control request parameters, so that the request
* details (such as data direction, request recipient, etc.) can be extracted via masking.

7
LUFA/Drivers/USB/Core/USBController.h
View File

@ -29,10 +29,8 @@
*/
/** \file
* \brief USB low level USB controller definitions.
*
* This file contains structures, function prototypes and macros related to the low level configuration of the
* USB controller, to start, stop and reset the USB library core.
* \brief Common USB Controller definitions for all architectures.
* \copydetails Group_USBManagement
*
* \note This file should not be included directly. It is automatically included as needed by the USB driver
* dispatch header located in LUFA/Drivers/USB/USB.h.
@ -40,6 +38,7 @@
/** \ingroup Group_USB
* \defgroup Group_USBManagement USB Interface Management
* \brief Common USB Controller definitions for all architectures.
*
* Functions, macros, variables, enums and types related to the setup and management of the USB interface.
*

19
LUFA/Drivers/USB/Core/USBMode.h
View File

@ -29,11 +29,8 @@
*/
/** \file
* \brief USB mode and capability macros.
*
* This file defines macros indicating the type of USB controller the library is being compiled for, and its
* capabilities. These macros may then be referenced in the user application to selectively enable or disable
* code sections depending on if they are defined or not.
* \brief USB mode and feature support definitions.
* \copydetails Group_USBMode
*
* \note This file should not be included directly. It is automatically included as needed by the USB driver
* dispatch header located in LUFA/Drivers/USB/USB.h.
@ -41,11 +38,15 @@
/** \ingroup Group_USB
* \defgroup Group_USBMode USB Mode Tokens
* \brief USB mode and feature support definitions.
*
* After the inclusion of the master USB driver header, one or more of the following
* tokens may be defined, to allow the user code to conditionally enable or disable
* code based on the USB controller family and allowable USB modes. These tokens may
* be tested against to eliminate code relating to a USB mode which is not enabled for
* This file defines macros indicating the type of USB controller the library is being compiled for, and its
* capabilities. These macros may then be referenced in the user application to selectively enable or disable
* code sections depending on if they are defined or not.
*
* After the inclusion of the master USB driver header, one or more of the following tokens may be defined, to
* allow the user code to conditionally enable or disable code based on the USB controller family and allowable
* USB modes. These tokens may be tested against to eliminate code relating to a USB mode which is not enabled for
* the given compilation.
*
* @{

8
LUFA/ManPages/CompileTimeTokens.txt
View File

@ -120,17 +120,17 @@
* \section Sec_SummaryUSBDeviceTokens USB Device Mode Driver Related Tokens
* This section describes compile tokens which affect USB driver stack of the LUFA library when used in Device mode.
*
* <b>USE_RAM_DESCRIPTORS</b> - ( \ref Group_Descriptors ) \n
* <b>USE_RAM_DESCRIPTORS</b> - ( \ref Group_StdDescriptors ) \n
* Define this token to indicate to the USB driver that all device descriptors are stored in RAM, rather than being located in any one
* of the AVR's memory spaces. RAM descriptors may be desirable in applications where the descriptors need to be modified at runtime.
*
* <b>USE_FLASH_DESCRIPTORS</b> - ( \ref Group_Descriptors ) \n
* <b>USE_FLASH_DESCRIPTORS</b> - ( \ref Group_StdDescriptors ) \n
* Similar to USE_RAM_DESCRIPTORS, but all descriptors are stored in the AVR's FLASH memory rather than RAM.
*
* <b>USE_EEPROM_DESCRIPTORS</b> - ( \ref Group_Descriptors ) \n
* <b>USE_EEPROM_DESCRIPTORS</b> - ( \ref Group_StdDescriptors ) \n
* Similar to USE_RAM_DESCRIPTORS, but all descriptors are stored in the AVR's EEPROM memory rather than RAM.
*
* <b>NO_INTERNAL_SERIAL</b> - ( \ref Group_Descriptors ) \n
* <b>NO_INTERNAL_SERIAL</b> - ( \ref Group_StdDescriptors ) \n
* Some AVR models contain a unique 20-digit serial number which can be used as the device serial number, while in device mode. This
* allows the host to uniquely identify the device regardless of if it is moved between USB ports on the same computer, allowing
* allocated resources (such as drivers, COM Port number allocations) to be preserved. This is not needed in many apps, and so the

5
LUFA/ManPages/SoftwareBootloaderJump.txt
View File

@ -12,12 +12,15 @@
* hardware). This might be required because the device does not have any physical user input, or simply
* just to streamline the device upgrade process on the host PC.
*
* The following C code snippet may be used to enter the bootloader upon request by the user application.
* The following C code snippets may be used to enter the bootloader upon request by the user application.
* By using the watchdog to physically reset the controller, it is ensured that all system hardware is
* completely reset to their defaults before the bootloader is run. This is important; since bootloaders
* are written to occupy a very limited space, they usually make assumptions about the register states based
* on the default values after a hard-reset of the chip.
*
* \section Sec_SoftareBootAVR8 AVR8 Architecture
* The following software bootloader jump code is written for the AVR8 architecture.
*
* \code
* #include <avr/wdt.h>
* #include <avr/io.h>