diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2011-02-20 13:08:29 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2011-02-20 13:08:29 +0000 |
| commit | 5e7319058268e021ae39ca4b9fcabaec0060117b (patch) | |
| tree | f40fe1525f2053746540498041f1e8a819277bd7 /LUFA/Drivers | |
| parent | 1daa5e16f9a395fb2943906a715adb35b8106988 (diff) | |
| download | lufa-5e7319058268e021ae39ca4b9fcabaec0060117b.tar.gz lufa-5e7319058268e021ae39ca4b9fcabaec0060117b.tar.bz2 lufa-5e7319058268e021ae39ca4b9fcabaec0060117b.zip | |
Start update of documentation to support possible multiple architectures in the future - alter \file documentation to automatically copy in the module documentation where possible.
Diffstat (limited to 'LUFA/Drivers')
89 files changed, 228 insertions, 560 deletions
diff --git a/LUFA/Drivers/Board/ADAFRUITU4/LEDs.h b/LUFA/Drivers/Board/ADAFRUITU4/LEDs.h index 3f6a6cca4..9f5097f17 100644 --- a/LUFA/Drivers/Board/ADAFRUITU4/LEDs.h +++ b/LUFA/Drivers/Board/ADAFRUITU4/LEDs.h @@ -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: */
diff --git a/LUFA/Drivers/Board/ATAVRUSBRF01/Buttons.h b/LUFA/Drivers/Board/ATAVRUSBRF01/Buttons.h index 568c0cb7d..daefcdea9 100644 --- a/LUFA/Drivers/Board/ATAVRUSBRF01/Buttons.h +++ b/LUFA/Drivers/Board/ATAVRUSBRF01/Buttons.h @@ -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: */ diff --git a/LUFA/Drivers/Board/ATAVRUSBRF01/LEDs.h b/LUFA/Drivers/Board/ATAVRUSBRF01/LEDs.h index 044042f09..10456f1cd 100644 --- a/LUFA/Drivers/Board/ATAVRUSBRF01/LEDs.h +++ b/LUFA/Drivers/Board/ATAVRUSBRF01/LEDs.h @@ -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: */ diff --git a/LUFA/Drivers/Board/BENITO/Buttons.h b/LUFA/Drivers/Board/BENITO/Buttons.h index 4e3d08820..141f1ed4d 100644 --- a/LUFA/Drivers/Board/BENITO/Buttons.h +++ b/LUFA/Drivers/Board/BENITO/Buttons.h @@ -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: */ diff --git a/LUFA/Drivers/Board/BENITO/LEDs.h b/LUFA/Drivers/Board/BENITO/LEDs.h index 51593ec9e..00e0907cb 100644 --- a/LUFA/Drivers/Board/BENITO/LEDs.h +++ b/LUFA/Drivers/Board/BENITO/LEDs.h @@ -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) diff --git a/LUFA/Drivers/Board/BLACKCAT/LEDs.h b/LUFA/Drivers/Board/BLACKCAT/LEDs.h index e5c250cc4..8b322bcf7 100644 --- a/LUFA/Drivers/Board/BLACKCAT/LEDs.h +++ b/LUFA/Drivers/Board/BLACKCAT/LEDs.h @@ -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: */
diff --git a/LUFA/Drivers/Board/BUI/LEDs.h b/LUFA/Drivers/Board/BUI/LEDs.h index fa1a8b0c4..f17cf24c2 100644 --- a/LUFA/Drivers/Board/BUI/LEDs.h +++ b/LUFA/Drivers/Board/BUI/LEDs.h @@ -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) diff --git a/LUFA/Drivers/Board/BUMBLEB/Buttons.h b/LUFA/Drivers/Board/BUMBLEB/Buttons.h index 015ecf6d5..b4bab86cd 100644 --- a/LUFA/Drivers/Board/BUMBLEB/Buttons.h +++ b/LUFA/Drivers/Board/BUMBLEB/Buttons.h @@ -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: */ diff --git a/LUFA/Drivers/Board/BUMBLEB/Joystick.h b/LUFA/Drivers/Board/BUMBLEB/Joystick.h index 336863c38..28b09b49e 100644 --- a/LUFA/Drivers/Board/BUMBLEB/Joystick.h +++ b/LUFA/Drivers/Board/BUMBLEB/Joystick.h @@ -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: */ diff --git a/LUFA/Drivers/Board/BUMBLEB/LEDs.h b/LUFA/Drivers/Board/BUMBLEB/LEDs.h index 349ef38c6..c5ecfe87f 100644 --- a/LUFA/Drivers/Board/BUMBLEB/LEDs.h +++ b/LUFA/Drivers/Board/BUMBLEB/LEDs.h @@ -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: */ diff --git a/LUFA/Drivers/Board/CULV3/Buttons.h b/LUFA/Drivers/Board/CULV3/Buttons.h index fd98c775f..53bf57a0f 100644 --- a/LUFA/Drivers/Board/CULV3/Buttons.h +++ b/LUFA/Drivers/Board/CULV3/Buttons.h @@ -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: */ diff --git a/LUFA/Drivers/Board/CULV3/LEDs.h b/LUFA/Drivers/Board/CULV3/LEDs.h index c9d20b692..c2af7401a 100644 --- a/LUFA/Drivers/Board/CULV3/LEDs.h +++ b/LUFA/Drivers/Board/CULV3/LEDs.h @@ -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: */ diff --git a/LUFA/Drivers/Board/EVK527/Buttons.h b/LUFA/Drivers/Board/EVK527/Buttons.h index f9b3da12e..98c8ce644 100644 --- a/LUFA/Drivers/Board/EVK527/Buttons.h +++ b/LUFA/Drivers/Board/EVK527/Buttons.h @@ -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: */ diff --git a/LUFA/Drivers/Board/EVK527/Dataflash.h b/LUFA/Drivers/Board/EVK527/Dataflash.h index 40608473a..d9f20d52d 100644 --- a/LUFA/Drivers/Board/EVK527/Dataflash.h +++ b/LUFA/Drivers/Board/EVK527/Dataflash.h @@ -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. - * * @{ */ diff --git a/LUFA/Drivers/Board/EVK527/Joystick.h b/LUFA/Drivers/Board/EVK527/Joystick.h index c0255f459..be8f35aa3 100644 --- a/LUFA/Drivers/Board/EVK527/Joystick.h +++ b/LUFA/Drivers/Board/EVK527/Joystick.h @@ -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: */ diff --git a/LUFA/Drivers/Board/EVK527/LEDs.h b/LUFA/Drivers/Board/EVK527/LEDs.h index 5f4670fa7..f8bfc1289 100644 --- a/LUFA/Drivers/Board/EVK527/LEDs.h +++ b/LUFA/Drivers/Board/EVK527/LEDs.h @@ -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: */ diff --git a/LUFA/Drivers/Board/JMDBU2/Buttons.h b/LUFA/Drivers/Board/JMDBU2/Buttons.h index b5272ae75..4f3581654 100644 --- a/LUFA/Drivers/Board/JMDBU2/Buttons.h +++ b/LUFA/Drivers/Board/JMDBU2/Buttons.h @@ -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: */ diff --git a/LUFA/Drivers/Board/JMDBU2/LEDs.h b/LUFA/Drivers/Board/JMDBU2/LEDs.h index a15e9f35c..3c9bdc3b4 100644 --- a/LUFA/Drivers/Board/JMDBU2/LEDs.h +++ b/LUFA/Drivers/Board/JMDBU2/LEDs.h @@ -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: */ diff --git a/LUFA/Drivers/Board/MAXIMUS/LEDs.h b/LUFA/Drivers/Board/MAXIMUS/LEDs.h index c3ead686b..5297d77ed 100644 --- a/LUFA/Drivers/Board/MAXIMUS/LEDs.h +++ b/LUFA/Drivers/Board/MAXIMUS/LEDs.h @@ -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: */
diff --git a/LUFA/Drivers/Board/MICROSIN162/Buttons.h b/LUFA/Drivers/Board/MICROSIN162/Buttons.h index a4d1637e5..f41d28192 100644 --- a/LUFA/Drivers/Board/MICROSIN162/Buttons.h +++ b/LUFA/Drivers/Board/MICROSIN162/Buttons.h @@ -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: */
diff --git a/LUFA/Drivers/Board/MICROSIN162/LEDs.h b/LUFA/Drivers/Board/MICROSIN162/LEDs.h index 8926e33fc..2fa39fd64 100644 --- a/LUFA/Drivers/Board/MICROSIN162/LEDs.h +++ b/LUFA/Drivers/Board/MICROSIN162/LEDs.h @@ -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: */
diff --git a/LUFA/Drivers/Board/MINIMUS/Buttons.h b/LUFA/Drivers/Board/MINIMUS/Buttons.h index 9b3016fa3..518db8810 100644 --- a/LUFA/Drivers/Board/MINIMUS/Buttons.h +++ b/LUFA/Drivers/Board/MINIMUS/Buttons.h @@ -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: */
diff --git a/LUFA/Drivers/Board/MINIMUS/LEDs.h b/LUFA/Drivers/Board/MINIMUS/LEDs.h index 524e62853..f921918da 100644 --- a/LUFA/Drivers/Board/MINIMUS/LEDs.h +++ b/LUFA/Drivers/Board/MINIMUS/LEDs.h @@ -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: */
diff --git a/LUFA/Drivers/Board/OLIMEX162/Buttons.h b/LUFA/Drivers/Board/OLIMEX162/Buttons.h index e52dadf14..33fee1678 100644 --- a/LUFA/Drivers/Board/OLIMEX162/Buttons.h +++ b/LUFA/Drivers/Board/OLIMEX162/Buttons.h @@ -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: */ diff --git a/LUFA/Drivers/Board/OLIMEX162/LEDs.h b/LUFA/Drivers/Board/OLIMEX162/LEDs.h index d13418a3c..971c08a26 100644 --- a/LUFA/Drivers/Board/OLIMEX162/LEDs.h +++ b/LUFA/Drivers/Board/OLIMEX162/LEDs.h @@ -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: */ diff --git a/LUFA/Drivers/Board/RZUSBSTICK/LEDs.h b/LUFA/Drivers/Board/RZUSBSTICK/LEDs.h index adaa9cd9a..af8ff8cef 100644 --- a/LUFA/Drivers/Board/RZUSBSTICK/LEDs.h +++ b/LUFA/Drivers/Board/RZUSBSTICK/LEDs.h @@ -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: */ diff --git a/LUFA/Drivers/Board/SPARKFUN8U2/LEDs.h b/LUFA/Drivers/Board/SPARKFUN8U2/LEDs.h index 2a3961edb..1d5291311 100644 --- a/LUFA/Drivers/Board/SPARKFUN8U2/LEDs.h +++ b/LUFA/Drivers/Board/SPARKFUN8U2/LEDs.h @@ -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: */
diff --git a/LUFA/Drivers/Board/STK525/Buttons.h b/LUFA/Drivers/Board/STK525/Buttons.h index f18c2a1a8..7e079f9a4 100644 --- a/LUFA/Drivers/Board/STK525/Buttons.h +++ b/LUFA/Drivers/Board/STK525/Buttons.h @@ -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: */ diff --git a/LUFA/Drivers/Board/STK525/Dataflash.h b/LUFA/Drivers/Board/STK525/Dataflash.h index 089170994..687b194bd 100644 --- a/LUFA/Drivers/Board/STK525/Dataflash.h +++ b/LUFA/Drivers/Board/STK525/Dataflash.h @@ -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. - * * @{ */ diff --git a/LUFA/Drivers/Board/STK525/Joystick.h b/LUFA/Drivers/Board/STK525/Joystick.h index 2baedb0b9..c1dd3623e 100644 --- a/LUFA/Drivers/Board/STK525/Joystick.h +++ b/LUFA/Drivers/Board/STK525/Joystick.h @@ -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: */ diff --git a/LUFA/Drivers/Board/STK525/LEDs.h b/LUFA/Drivers/Board/STK525/LEDs.h index cacd3195f..98cbb2fff 100644 --- a/LUFA/Drivers/Board/STK525/LEDs.h +++ b/LUFA/Drivers/Board/STK525/LEDs.h @@ -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: */ diff --git a/LUFA/Drivers/Board/STK526/Buttons.h b/LUFA/Drivers/Board/STK526/Buttons.h index afbb3fab5..2f8b06485 100644 --- a/LUFA/Drivers/Board/STK526/Buttons.h +++ b/LUFA/Drivers/Board/STK526/Buttons.h @@ -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: */ diff --git a/LUFA/Drivers/Board/STK526/Dataflash.h b/LUFA/Drivers/Board/STK526/Dataflash.h index b5c33340a..626946a0e 100644 --- a/LUFA/Drivers/Board/STK526/Dataflash.h +++ b/LUFA/Drivers/Board/STK526/Dataflash.h @@ -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. - * * @{ */ diff --git a/LUFA/Drivers/Board/STK526/Joystick.h b/LUFA/Drivers/Board/STK526/Joystick.h index 6d54545e8..96063846d 100644 --- a/LUFA/Drivers/Board/STK526/Joystick.h +++ b/LUFA/Drivers/Board/STK526/Joystick.h @@ -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: */ diff --git a/LUFA/Drivers/Board/STK526/LEDs.h b/LUFA/Drivers/Board/STK526/LEDs.h index 3ec9bd394..d8ccab1ec 100644 --- a/LUFA/Drivers/Board/STK526/LEDs.h +++ b/LUFA/Drivers/Board/STK526/LEDs.h @@ -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: */ diff --git a/LUFA/Drivers/Board/TEENSY/LEDs.h b/LUFA/Drivers/Board/TEENSY/LEDs.h index 551cdc2c6..9ff3506f0 100644 --- a/LUFA/Drivers/Board/TEENSY/LEDs.h +++ b/LUFA/Drivers/Board/TEENSY/LEDs.h @@ -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: */ diff --git a/LUFA/Drivers/Board/UDIP/Buttons.h b/LUFA/Drivers/Board/UDIP/Buttons.h index 6a232bd1b..d1fd4192b 100644 --- a/LUFA/Drivers/Board/UDIP/Buttons.h +++ b/LUFA/Drivers/Board/UDIP/Buttons.h @@ -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: */ diff --git a/LUFA/Drivers/Board/UDIP/LEDs.h b/LUFA/Drivers/Board/UDIP/LEDs.h index 6f0e56971..8c5fe7d51 100644 --- a/LUFA/Drivers/Board/UDIP/LEDs.h +++ b/LUFA/Drivers/Board/UDIP/LEDs.h @@ -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: */ diff --git a/LUFA/Drivers/Board/UNO/LEDs.h b/LUFA/Drivers/Board/UNO/LEDs.h index 0b5413d90..8f709df23 100644 --- a/LUFA/Drivers/Board/UNO/LEDs.h +++ b/LUFA/Drivers/Board/UNO/LEDs.h @@ -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) diff --git a/LUFA/Drivers/Board/USBFOO/Buttons.h b/LUFA/Drivers/Board/USBFOO/Buttons.h index 8f79a92e9..da3f5e1a8 100644 --- a/LUFA/Drivers/Board/USBFOO/Buttons.h +++ b/LUFA/Drivers/Board/USBFOO/Buttons.h @@ -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: */ diff --git a/LUFA/Drivers/Board/USBFOO/LEDS.h b/LUFA/Drivers/Board/USBFOO/LEDS.h index 07346e498..d82b76a49 100644 --- a/LUFA/Drivers/Board/USBFOO/LEDS.h +++ b/LUFA/Drivers/Board/USBFOO/LEDS.h @@ -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: */ diff --git a/LUFA/Drivers/Board/USBKEY/Buttons.h b/LUFA/Drivers/Board/USBKEY/Buttons.h index 2018cb0c3..e495318ec 100644 --- a/LUFA/Drivers/Board/USBKEY/Buttons.h +++ b/LUFA/Drivers/Board/USBKEY/Buttons.h @@ -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: */ diff --git a/LUFA/Drivers/Board/USBKEY/Dataflash.h b/LUFA/Drivers/Board/USBKEY/Dataflash.h index 26711178f..19040cf5c 100644 --- a/LUFA/Drivers/Board/USBKEY/Dataflash.h +++ b/LUFA/Drivers/Board/USBKEY/Dataflash.h @@ -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. - * * @{ */ diff --git a/LUFA/Drivers/Board/USBKEY/Joystick.h b/LUFA/Drivers/Board/USBKEY/Joystick.h index 90cbf7f69..8ca5bc45f 100644 --- a/LUFA/Drivers/Board/USBKEY/Joystick.h +++ b/LUFA/Drivers/Board/USBKEY/Joystick.h @@ -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: */ diff --git a/LUFA/Drivers/Board/USBKEY/LEDs.h b/LUFA/Drivers/Board/USBKEY/LEDs.h index 31722319e..25cfabdf4 100644 --- a/LUFA/Drivers/Board/USBKEY/LEDs.h +++ b/LUFA/Drivers/Board/USBKEY/LEDs.h @@ -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: */ diff --git a/LUFA/Drivers/Board/USBTINYMKII/Buttons.h b/LUFA/Drivers/Board/USBTINYMKII/Buttons.h index b5493ab2d..06f98feaf 100644 --- a/LUFA/Drivers/Board/USBTINYMKII/Buttons.h +++ b/LUFA/Drivers/Board/USBTINYMKII/Buttons.h @@ -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: */ diff --git a/LUFA/Drivers/Board/USBTINYMKII/LEDs.h b/LUFA/Drivers/Board/USBTINYMKII/LEDs.h index 65f1117e2..4abc1879a 100644 --- a/LUFA/Drivers/Board/USBTINYMKII/LEDs.h +++ b/LUFA/Drivers/Board/USBTINYMKII/LEDs.h @@ -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) diff --git a/LUFA/Drivers/Board/XPLAIN/Dataflash.h b/LUFA/Drivers/Board/XPLAIN/Dataflash.h index d5c7527a1..069512aec 100644 --- a/LUFA/Drivers/Board/XPLAIN/Dataflash.h +++ b/LUFA/Drivers/Board/XPLAIN/Dataflash.h @@ -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. - * * @{ */ diff --git a/LUFA/Drivers/Board/XPLAIN/LEDs.h b/LUFA/Drivers/Board/XPLAIN/LEDs.h index 953c77e1a..75d4a7bc9 100644 --- a/LUFA/Drivers/Board/XPLAIN/LEDs.h +++ b/LUFA/Drivers/Board/XPLAIN/LEDs.h @@ -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: */ diff --git a/LUFA/Drivers/Misc/AT45DB321C.h b/LUFA/Drivers/Misc/AT45DB321C.h index 083268ddc..725738bcf 100644 --- a/LUFA/Drivers/Misc/AT45DB321C.h +++ b/LUFA/Drivers/Misc/AT45DB321C.h @@ -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.
*
diff --git a/LUFA/Drivers/Misc/AT45DB642D.h b/LUFA/Drivers/Misc/AT45DB642D.h index 923a3b7c4..98041167e 100644 --- a/LUFA/Drivers/Misc/AT45DB642D.h +++ b/LUFA/Drivers/Misc/AT45DB642D.h @@ -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.
*
diff --git a/LUFA/Drivers/Misc/RingBuffer.h b/LUFA/Drivers/Misc/RingBuffer.h index 8ca5d2a0a..ea82651fd 100644 --- a/LUFA/Drivers/Misc/RingBuffer.h +++ b/LUFA/Drivers/Misc/RingBuffer.h @@ -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: */
diff --git a/LUFA/Drivers/USB/Class/Common/Audio.h b/LUFA/Drivers/USB/Class/Common/Audio.h index be899bb2f..ab6428022 100644 --- a/LUFA/Drivers/USB/Class/Common/Audio.h +++ b/LUFA/Drivers/USB/Class/Common/Audio.h @@ -53,8 +53,6 @@ /* Includes: */ #include "../../Core/StdDescriptors.h" - #include <string.h> - /* Enable C linkage for C++ Compilers: */ #if defined(__cplusplus) extern "C" { diff --git a/LUFA/Drivers/USB/Class/Common/CDC.h b/LUFA/Drivers/USB/Class/Common/CDC.h index 5a4c2c21c..cfaebb858 100644 --- a/LUFA/Drivers/USB/Class/Common/CDC.h +++ b/LUFA/Drivers/USB/Class/Common/CDC.h @@ -53,8 +53,6 @@ /* Includes: */ #include "../../Core/StdDescriptors.h" - #include <string.h> - /* Enable C linkage for C++ Compilers: */ #if defined(__cplusplus) extern "C" { diff --git a/LUFA/Drivers/USB/Class/Common/HID.h b/LUFA/Drivers/USB/Class/Common/HID.h index 7b0c34d9f..f9684ed25 100644 --- a/LUFA/Drivers/USB/Class/Common/HID.h +++ b/LUFA/Drivers/USB/Class/Common/HID.h @@ -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. diff --git a/LUFA/Drivers/USB/Class/Common/HIDParser.h b/LUFA/Drivers/USB/Class/Common/HIDParser.h index 98544a05d..7ae6bb243 100644 --- a/LUFA/Drivers/USB/Class/Common/HIDParser.h +++ b/LUFA/Drivers/USB/Class/Common/HIDParser.h @@ -70,8 +70,6 @@ #include "HIDReportData.h" #include "../Common/HID.h" - - #include <string.h> /* Enable C linkage for C++ Compilers: */ #if defined(__cplusplus) diff --git a/LUFA/Drivers/USB/Class/Common/MIDI.h b/LUFA/Drivers/USB/Class/Common/MIDI.h index c72ca5afe..d2e884a97 100644 --- a/LUFA/Drivers/USB/Class/Common/MIDI.h +++ b/LUFA/Drivers/USB/Class/Common/MIDI.h @@ -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" { diff --git a/LUFA/Drivers/USB/Class/Common/MassStorage.h b/LUFA/Drivers/USB/Class/Common/MassStorage.h index 1acd68212..ae22f5312 100644 --- a/LUFA/Drivers/USB/Class/Common/MassStorage.h +++ b/LUFA/Drivers/USB/Class/Common/MassStorage.h @@ -53,8 +53,6 @@ /* Includes: */ #include "../../Core/StdDescriptors.h" - #include <string.h> - /* Enable C linkage for C++ Compilers: */ #if defined(__cplusplus) extern "C" { diff --git a/LUFA/Drivers/USB/Class/Common/Printer.h b/LUFA/Drivers/USB/Class/Common/Printer.h index 092cd8f03..3d52be306 100644 --- a/LUFA/Drivers/USB/Class/Common/Printer.h +++ b/LUFA/Drivers/USB/Class/Common/Printer.h @@ -53,8 +53,6 @@ /* Includes: */ #include "../../Core/StdDescriptors.h" - #include <string.h> - /* Enable C linkage for C++ Compilers: */ #if defined(__cplusplus) extern "C" { diff --git a/LUFA/Drivers/USB/Class/Common/RNDIS.h b/LUFA/Drivers/USB/Class/Common/RNDIS.h index cb806ec56..64f080ae3 100644 --- a/LUFA/Drivers/USB/Class/Common/RNDIS.h +++ b/LUFA/Drivers/USB/Class/Common/RNDIS.h @@ -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" { diff --git a/LUFA/Drivers/USB/Class/Common/StillImage.h b/LUFA/Drivers/USB/Class/Common/StillImage.h index 7ef04d8cb..e440265b1 100644 --- a/LUFA/Drivers/USB/Class/Common/StillImage.h +++ b/LUFA/Drivers/USB/Class/Common/StillImage.h @@ -53,8 +53,6 @@ /* Includes: */ #include "../../Core/StdDescriptors.h" - #include <string.h> - /* Enable C linkage for C++ Compilers: */ #if defined(__cplusplus) extern "C" { diff --git a/LUFA/Drivers/USB/Class/Device/Audio.h b/LUFA/Drivers/USB/Class/Device/Audio.h index d82beabc6..cf63c65b0 100644 --- a/LUFA/Drivers/USB/Class/Device/Audio.h +++ b/LUFA/Drivers/USB/Class/Device/Audio.h @@ -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" { diff --git a/LUFA/Drivers/USB/Class/Device/CDC.h b/LUFA/Drivers/USB/Class/Device/CDC.h index bf388819f..9eb7b48fc 100644 --- a/LUFA/Drivers/USB/Class/Device/CDC.h +++ b/LUFA/Drivers/USB/Class/Device/CDC.h @@ -75,7 +75,6 @@ #include "../Common/CDC.h" #include <stdio.h> - #include <string.h> /* Enable C linkage for C++ Compilers: */ #if defined(__cplusplus) diff --git a/LUFA/Drivers/USB/Class/Device/HID.h b/LUFA/Drivers/USB/Class/Device/HID.h index 545baddf3..133e4f5d8 100644 --- a/LUFA/Drivers/USB/Class/Device/HID.h +++ b/LUFA/Drivers/USB/Class/Device/HID.h @@ -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" { diff --git a/LUFA/Drivers/USB/Class/Device/MIDI.h b/LUFA/Drivers/USB/Class/Device/MIDI.h index 4016d8a9a..137513676 100644 --- a/LUFA/Drivers/USB/Class/Device/MIDI.h +++ b/LUFA/Drivers/USB/Class/Device/MIDI.h @@ -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" { diff --git a/LUFA/Drivers/USB/Class/Device/MassStorage.h b/LUFA/Drivers/USB/Class/Device/MassStorage.h index aceeb6261..3ad259d86 100644 --- a/LUFA/Drivers/USB/Class/Device/MassStorage.h +++ b/LUFA/Drivers/USB/Class/Device/MassStorage.h @@ -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" { diff --git a/LUFA/Drivers/USB/Class/Device/RNDIS.h b/LUFA/Drivers/USB/Class/Device/RNDIS.h index cdc6fbad0..f53a8e01f 100644 --- a/LUFA/Drivers/USB/Class/Device/RNDIS.h +++ b/LUFA/Drivers/USB/Class/Device/RNDIS.h @@ -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" { diff --git a/LUFA/Drivers/USB/Class/Host/CDC.h b/LUFA/Drivers/USB/Class/Host/CDC.h index bba94fe81..8e799709e 100644 --- a/LUFA/Drivers/USB/Class/Host/CDC.h +++ b/LUFA/Drivers/USB/Class/Host/CDC.h @@ -58,7 +58,6 @@ #include "../Common/CDC.h" #include <stdio.h> - #include <string.h> /* Enable C linkage for C++ Compilers: */ #if defined(__cplusplus) diff --git a/LUFA/Drivers/USB/Class/Host/RNDIS.h b/LUFA/Drivers/USB/Class/Host/RNDIS.h index 68aa347ec..376cc5925 100644 --- a/LUFA/Drivers/USB/Class/Host/RNDIS.h +++ b/LUFA/Drivers/USB/Class/Host/RNDIS.h @@ -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" { diff --git a/LUFA/Drivers/USB/Core/AVR8/Device.h b/LUFA/Drivers/USB/Core/AVR8/Device.h index 30088f1d9..d1ced57d4 100644 --- a/LUFA/Drivers/USB/Core/AVR8/Device.h +++ b/LUFA/Drivers/USB/Core/AVR8/Device.h @@ -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: */ diff --git a/LUFA/Drivers/USB/Core/AVR8/Endpoint.h b/LUFA/Drivers/USB/Core/AVR8/Endpoint.h index 1feadd3c8..2a0774792 100644 --- a/LUFA/Drivers/USB/Core/AVR8/Endpoint.h +++ b/LUFA/Drivers/USB/Core/AVR8/Endpoint.h @@ -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. */ diff --git a/LUFA/Drivers/USB/Core/AVR8/Host.h b/LUFA/Drivers/USB/Core/AVR8/Host.h index def17ee70..0c50a39c3 100644 --- a/LUFA/Drivers/USB/Core/AVR8/Host.h +++ b/LUFA/Drivers/USB/Core/AVR8/Host.h @@ -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. * * @{ */ diff --git a/LUFA/Drivers/USB/Core/AVR8/OTG.h b/LUFA/Drivers/USB/Core/AVR8/OTG.h index cc0cc3da1..a79033753 100644 --- a/LUFA/Drivers/USB/Core/AVR8/OTG.h +++ b/LUFA/Drivers/USB/Core/AVR8/OTG.h @@ -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. * * @{ */ diff --git a/LUFA/Drivers/USB/Core/AVR8/Pipe.h b/LUFA/Drivers/USB/Core/AVR8/Pipe.h index 3f62ec5d1..ff09f43e4 100644 --- a/LUFA/Drivers/USB/Core/AVR8/Pipe.h +++ b/LUFA/Drivers/USB/Core/AVR8/Pipe.h @@ -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. */ diff --git a/LUFA/Drivers/USB/Core/AVR8/USBController.h b/LUFA/Drivers/USB/Core/AVR8/USBController.h index 292b39369..77e92cb27 100644 --- a/LUFA/Drivers/USB/Core/AVR8/USBController.h +++ b/LUFA/Drivers/USB/Core/AVR8/USBController.h @@ -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) diff --git a/LUFA/Drivers/USB/Core/AVR8/USBInterrupt.h b/LUFA/Drivers/USB/Core/AVR8/USBInterrupt.h index 3cb0b66be..c681f86fb 100644 --- a/LUFA/Drivers/USB/Core/AVR8/USBInterrupt.h +++ b/LUFA/Drivers/USB/Core/AVR8/USBInterrupt.h @@ -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) diff --git a/LUFA/Drivers/USB/Core/ConfigDescriptor.h b/LUFA/Drivers/USB/Core/ConfigDescriptor.h index 2f0ac8e02..e469987b3 100644 --- a/LUFA/Drivers/USB/Core/ConfigDescriptor.h +++ b/LUFA/Drivers/USB/Core/ConfigDescriptor.h @@ -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. * * @{ */ diff --git a/LUFA/Drivers/USB/Core/Device.h b/LUFA/Drivers/USB/Core/Device.h index 8c85451ac..6fa88d3a3 100644 --- a/LUFA/Drivers/USB/Core/Device.h +++ b/LUFA/Drivers/USB/Core/Device.h @@ -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
/** @} */
diff --git a/LUFA/Drivers/USB/Core/Endpoint.h b/LUFA/Drivers/USB/Core/Endpoint.h index 302c368e4..656f40cdb 100644 --- a/LUFA/Drivers/USB/Core/Endpoint.h +++ b/LUFA/Drivers/USB/Core/Endpoint.h @@ -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.
*/
diff --git a/LUFA/Drivers/USB/Core/EndpointStream.h b/LUFA/Drivers/USB/Core/EndpointStream.h index 4d4f33a20..a8fd4bc93 100644 --- a/LUFA/Drivers/USB/Core/EndpointStream.h +++ b/LUFA/Drivers/USB/Core/EndpointStream.h @@ -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.
diff --git a/LUFA/Drivers/USB/Core/Events.h b/LUFA/Drivers/USB/Core/Events.h index 4a3a1a160..c0a322b26 100644 --- a/LUFA/Drivers/USB/Core/Events.h +++ b/LUFA/Drivers/USB/Core/Events.h @@ -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 diff --git a/LUFA/Drivers/USB/Core/Host.h b/LUFA/Drivers/USB/Core/Host.h index 8a6ac438d..6a09b4055 100644 --- a/LUFA/Drivers/USB/Core/Host.h +++ b/LUFA/Drivers/USB/Core/Host.h @@ -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.
diff --git a/LUFA/Drivers/USB/Core/OTG.h b/LUFA/Drivers/USB/Core/OTG.h index 3b41a0fe6..bb54e18bd 100644 --- a/LUFA/Drivers/USB/Core/OTG.h +++ b/LUFA/Drivers/USB/Core/OTG.h @@ -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
diff --git a/LUFA/Drivers/USB/Core/Pipe.h b/LUFA/Drivers/USB/Core/Pipe.h index 2ab14fc6c..4edeba92e 100644 --- a/LUFA/Drivers/USB/Core/Pipe.h +++ b/LUFA/Drivers/USB/Core/Pipe.h @@ -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.
*/
diff --git a/LUFA/Drivers/USB/Core/PipeStream.h b/LUFA/Drivers/USB/Core/PipeStream.h index 86c544ebe..5c3ab9d45 100644 --- a/LUFA/Drivers/USB/Core/PipeStream.h +++ b/LUFA/Drivers/USB/Core/PipeStream.h @@ -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.
diff --git a/LUFA/Drivers/USB/Core/StdDescriptors.h b/LUFA/Drivers/USB/Core/StdDescriptors.h index ed4ecf91e..d08d08348 100644 --- a/LUFA/Drivers/USB/Core/StdDescriptors.h +++ b/LUFA/Drivers/USB/Core/StdDescriptors.h @@ -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. diff --git a/LUFA/Drivers/USB/Core/StdRequestType.h b/LUFA/Drivers/USB/Core/StdRequestType.h index a8c3f0913..83bec4f2a 100644 --- a/LUFA/Drivers/USB/Core/StdRequestType.h +++ b/LUFA/Drivers/USB/Core/StdRequestType.h @@ -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. diff --git a/LUFA/Drivers/USB/Core/USBController.h b/LUFA/Drivers/USB/Core/USBController.h index 475aeb1bd..dfd2ce1d5 100644 --- a/LUFA/Drivers/USB/Core/USBController.h +++ b/LUFA/Drivers/USB/Core/USBController.h @@ -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.
*
diff --git a/LUFA/Drivers/USB/Core/USBMode.h b/LUFA/Drivers/USB/Core/USBMode.h index 58f9927dc..ff95ce3d5 100644 --- a/LUFA/Drivers/USB/Core/USBMode.h +++ b/LUFA/Drivers/USB/Core/USBMode.h @@ -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. + * + * 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 + * 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. * * @{ |