From 0557676013f41487701a8951d3dbb4aee3117882 Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Mon, 29 Mar 2010 07:49:58 +0000 Subject: Add file-level brief documentation. Remove accidentally duplicated model-specific peripheral driver files. --- LUFA/Drivers/Board/ATAVRUSBRF01/Buttons.h | 3 +- LUFA/Drivers/Board/ATAVRUSBRF01/LEDs.h | 3 +- LUFA/Drivers/Board/BUMBLEB/Buttons.h | 5 +- LUFA/Drivers/Board/BUMBLEB/Joystick.h | 7 +- LUFA/Drivers/Board/BUMBLEB/LEDs.h | 5 +- LUFA/Drivers/Board/Buttons.h | 1 + LUFA/Drivers/Board/Dataflash.h | 1 + LUFA/Drivers/Board/EVK527/AT45DB321C.h | 3 +- LUFA/Drivers/Board/EVK527/Buttons.h | 3 +- LUFA/Drivers/Board/EVK527/Dataflash.h | 3 +- LUFA/Drivers/Board/EVK527/Joystick.h | 3 +- LUFA/Drivers/Board/EVK527/LEDs.h | 3 +- LUFA/Drivers/Board/Joystick.h | 1 + LUFA/Drivers/Board/LEDs.h | 1 + LUFA/Drivers/Board/RZUSBSTICK/LEDs.h | 3 +- LUFA/Drivers/Board/STK525/AT45DB321C.h | 3 +- LUFA/Drivers/Board/STK525/Buttons.h | 3 +- LUFA/Drivers/Board/STK525/Dataflash.h | 3 +- LUFA/Drivers/Board/STK525/Joystick.h | 3 +- LUFA/Drivers/Board/STK525/LEDs.h | 3 +- LUFA/Drivers/Board/STK526/AT45DB642D.h | 3 +- LUFA/Drivers/Board/STK526/Buttons.h | 3 +- LUFA/Drivers/Board/STK526/Dataflash.h | 3 +- LUFA/Drivers/Board/STK526/Joystick.h | 3 +- LUFA/Drivers/Board/STK526/LEDs.h | 3 +- LUFA/Drivers/Board/TEENSY/LEDs.h | 3 +- LUFA/Drivers/Board/Temperature.h | 1 + LUFA/Drivers/Board/USBKEY/AT45DB642D.h | 3 +- LUFA/Drivers/Board/USBKEY/Buttons.h | 3 +- LUFA/Drivers/Board/USBKEY/Dataflash.h | 3 +- LUFA/Drivers/Board/USBKEY/Joystick.h | 3 +- LUFA/Drivers/Board/USBKEY/LEDs.h | 3 +- LUFA/Drivers/Board/XPLAIN/AT45DB642D.h | 3 +- LUFA/Drivers/Board/XPLAIN/Dataflash.h | 3 +- LUFA/Drivers/Board/XPLAIN/LEDs.h | 3 +- LUFA/Drivers/Misc/TerminalCodes.h | 2 +- LUFA/Drivers/Peripheral/ADC.h | 1 + LUFA/Drivers/Peripheral/AVRU4U6U7/ADC.h | 1 + LUFA/Drivers/Peripheral/AVRU4U6U7/SPI.h | 189 ------------------------- LUFA/Drivers/Peripheral/AVRU4U6U7/Serial.h | 145 ------------------- LUFA/Drivers/Peripheral/AVRU4U6U7/TWI.h | 1 + LUFA/Drivers/Peripheral/SPI.h | 1 + LUFA/Drivers/Peripheral/Serial.h | 1 + LUFA/Drivers/Peripheral/SerialStream.h | 9 +- LUFA/Drivers/Peripheral/TWI.h | 1 + LUFA/Drivers/USB/Class/Audio.h | 7 + LUFA/Drivers/USB/Class/CDC.h | 9 +- LUFA/Drivers/USB/Class/Common/Audio.h | 7 + LUFA/Drivers/USB/Class/Common/CDC.h | 7 + LUFA/Drivers/USB/Class/Common/HID.h | 7 + LUFA/Drivers/USB/Class/Common/MIDI.h | 7 + LUFA/Drivers/USB/Class/Common/MassStorage.h | 7 + LUFA/Drivers/USB/Class/Common/Printer.h | 7 + LUFA/Drivers/USB/Class/Common/RNDIS.h | 7 + LUFA/Drivers/USB/Class/Common/RNDISConstants.h | 7 + LUFA/Drivers/USB/Class/Common/StillImage.h | 7 + LUFA/Drivers/USB/Class/Device/Audio.h | 7 + LUFA/Drivers/USB/Class/Device/CDC.h | 7 + LUFA/Drivers/USB/Class/Device/HID.h | 7 + LUFA/Drivers/USB/Class/Device/MIDI.h | 7 + LUFA/Drivers/USB/Class/Device/MassStorage.h | 7 + LUFA/Drivers/USB/Class/Device/RNDIS.h | 7 + LUFA/Drivers/USB/Class/HID.h | 7 + LUFA/Drivers/USB/Class/Host/CDC.h | 7 + LUFA/Drivers/USB/Class/Host/HID.h | 7 + LUFA/Drivers/USB/Class/Host/HIDParser.h | 7 +- LUFA/Drivers/USB/Class/Host/HIDReportData.h | 4 +- LUFA/Drivers/USB/Class/Host/MIDI.h | 7 + LUFA/Drivers/USB/Class/Host/MassStorage.h | 7 + LUFA/Drivers/USB/Class/Host/Printer.h | 7 + LUFA/Drivers/USB/Class/Host/RNDIS.h | 7 + LUFA/Drivers/USB/Class/Host/StillImage.c | 3 +- LUFA/Drivers/USB/Class/Host/StillImage.h | 7 + LUFA/Drivers/USB/Class/MIDI.h | 7 + LUFA/Drivers/USB/Class/MassStorage.h | 7 + LUFA/Drivers/USB/Class/Printer.h | 7 + LUFA/Drivers/USB/Class/RNDIS.h | 9 +- LUFA/Drivers/USB/Class/StillImage.h | 7 + LUFA/Drivers/USB/HighLevel/ConfigDescriptor.h | 10 +- LUFA/Drivers/USB/HighLevel/Events.h | 19 +++ LUFA/Drivers/USB/HighLevel/StdDescriptors.h | 9 ++ LUFA/Drivers/USB/HighLevel/StdRequestType.h | 11 +- LUFA/Drivers/USB/HighLevel/StreamCallbacks.h | 10 ++ LUFA/Drivers/USB/HighLevel/USBInterrupt.h | 10 ++ LUFA/Drivers/USB/HighLevel/USBMode.h | 11 ++ LUFA/Drivers/USB/HighLevel/USBTask.h | 12 +- LUFA/Drivers/USB/LowLevel/DevChapter9.h | 10 ++ LUFA/Drivers/USB/LowLevel/Device.h | 11 +- LUFA/Drivers/USB/LowLevel/Endpoint.h | 10 ++ LUFA/Drivers/USB/LowLevel/Host.h | 9 ++ LUFA/Drivers/USB/LowLevel/HostChapter9.h | 10 ++ LUFA/Drivers/USB/LowLevel/LowLevel.h | 10 ++ LUFA/Drivers/USB/LowLevel/OTG.h | 10 ++ LUFA/Drivers/USB/LowLevel/Pipe.h | 10 ++ LUFA/Drivers/USB/USB.h | 6 +- 95 files changed, 444 insertions(+), 416 deletions(-) delete mode 100644 LUFA/Drivers/Peripheral/AVRU4U6U7/SPI.h delete mode 100644 LUFA/Drivers/Peripheral/AVRU4U6U7/Serial.h (limited to 'LUFA/Drivers') diff --git a/LUFA/Drivers/Board/ATAVRUSBRF01/Buttons.h b/LUFA/Drivers/Board/ATAVRUSBRF01/Buttons.h index af95a894b..fc76871fc 100644 --- a/LUFA/Drivers/Board/ATAVRUSBRF01/Buttons.h +++ b/LUFA/Drivers/Board/ATAVRUSBRF01/Buttons.h @@ -29,8 +29,7 @@ */ /** \file - * - * Board specific Buttons driver header for the ATAVRUSBRF01. + * \brief Board specific Buttons driver header for the 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. diff --git a/LUFA/Drivers/Board/ATAVRUSBRF01/LEDs.h b/LUFA/Drivers/Board/ATAVRUSBRF01/LEDs.h index 2208f2e40..33ffab4e5 100644 --- a/LUFA/Drivers/Board/ATAVRUSBRF01/LEDs.h +++ b/LUFA/Drivers/Board/ATAVRUSBRF01/LEDs.h @@ -29,8 +29,7 @@ */ /** \file - * - * Board specific LED driver header for the ATAVRUSBRF01. + * \brief Board specific LED driver header for the 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. diff --git a/LUFA/Drivers/Board/BUMBLEB/Buttons.h b/LUFA/Drivers/Board/BUMBLEB/Buttons.h index e0a5cc5a9..a3b0c5d9c 100644 --- a/LUFA/Drivers/Board/BUMBLEB/Buttons.h +++ b/LUFA/Drivers/Board/BUMBLEB/Buttons.h @@ -29,9 +29,10 @@ */ /** \file + * \brief Board specific Buttons driver header for the BUMBLEB. * - * Board specific Buttons driver header for the BUMBLEB. 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. + * 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. diff --git a/LUFA/Drivers/Board/BUMBLEB/Joystick.h b/LUFA/Drivers/Board/BUMBLEB/Joystick.h index 5d57ec559..9fa4feda8 100644 --- a/LUFA/Drivers/Board/BUMBLEB/Joystick.h +++ b/LUFA/Drivers/Board/BUMBLEB/Joystick.h @@ -29,9 +29,10 @@ */ /** \file + * \brief Board specific joystick driver header for the BUMLEB. * - * Board specific joystick driver header for the USBKEY. 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. + * 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. @@ -40,7 +41,7 @@ /** \ingroup Group_Joystick * @defgroup Group_Joystick_BUMBLEB BUMBLEB * - * Board specific joystick driver header for the USBKEY. The BUMBLEB third-party board does not include any on-board + * Board specific joystick driver header for the BUMBLEB. 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 diff --git a/LUFA/Drivers/Board/BUMBLEB/LEDs.h b/LUFA/Drivers/Board/BUMBLEB/LEDs.h index 549bbde62..5e2fa547e 100644 --- a/LUFA/Drivers/Board/BUMBLEB/LEDs.h +++ b/LUFA/Drivers/Board/BUMBLEB/LEDs.h @@ -29,9 +29,10 @@ */ /** \file + * \brief Board specific LED driver header for the BUMBLEB. * - * Board specific LED driver header for the BUMBLEB. 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. + * 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. diff --git a/LUFA/Drivers/Board/Buttons.h b/LUFA/Drivers/Board/Buttons.h index d908fd43a..40ed384a7 100644 --- a/LUFA/Drivers/Board/Buttons.h +++ b/LUFA/Drivers/Board/Buttons.h @@ -29,6 +29,7 @@ */ /** \file + * \brief Master include file for the board digital button driver. * * This file is the master dispatch header file for the board-specific Buttons driver, for boards containing * physical pushbuttons connected to the AVR's GPIO pins. diff --git a/LUFA/Drivers/Board/Dataflash.h b/LUFA/Drivers/Board/Dataflash.h index 762142c33..d55774d87 100644 --- a/LUFA/Drivers/Board/Dataflash.h +++ b/LUFA/Drivers/Board/Dataflash.h @@ -29,6 +29,7 @@ */ /** \file + * \brief Master include file for the board dataflash IC driver. * * This file is the master dispatch header file for the board-specific dataflash driver, for boards containing * dataflash ICs for external non-volatile storage. diff --git a/LUFA/Drivers/Board/EVK527/AT45DB321C.h b/LUFA/Drivers/Board/EVK527/AT45DB321C.h index ada314d25..03caf17b0 100644 --- a/LUFA/Drivers/Board/EVK527/AT45DB321C.h +++ b/LUFA/Drivers/Board/EVK527/AT45DB321C.h @@ -29,8 +29,7 @@ */ /** \file - * - * Board specific Dataflash commands header for the AT45DB321C as mounted on the EVK527. + * \brief Board specific Dataflash commands header for the AT45DB321C as mounted on the 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/Buttons.h b/LUFA/Drivers/Board/EVK527/Buttons.h index 0150fa151..bcd2e9f0e 100644 --- a/LUFA/Drivers/Board/EVK527/Buttons.h +++ b/LUFA/Drivers/Board/EVK527/Buttons.h @@ -29,8 +29,7 @@ */ /** \file - * - * Board specific Buttons driver header for the EVK527. + * \brief Board specific Buttons driver header for the 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. diff --git a/LUFA/Drivers/Board/EVK527/Dataflash.h b/LUFA/Drivers/Board/EVK527/Dataflash.h index 25a338cec..e8e310c97 100644 --- a/LUFA/Drivers/Board/EVK527/Dataflash.h +++ b/LUFA/Drivers/Board/EVK527/Dataflash.h @@ -29,8 +29,7 @@ */ /** \file - * - * Board specific Dataflash driver header for the EVK527. + * \brief Board specific Dataflash driver header for the 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 7d208ea9f..d270d4d8f 100644 --- a/LUFA/Drivers/Board/EVK527/Joystick.h +++ b/LUFA/Drivers/Board/EVK527/Joystick.h @@ -29,8 +29,7 @@ */ /** \file - * - * Board specific joystick driver header for the EVK527. + * \brief Board specific joystick driver header for the 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. diff --git a/LUFA/Drivers/Board/EVK527/LEDs.h b/LUFA/Drivers/Board/EVK527/LEDs.h index ea7c7c2c7..36f0ce6a6 100644 --- a/LUFA/Drivers/Board/EVK527/LEDs.h +++ b/LUFA/Drivers/Board/EVK527/LEDs.h @@ -29,8 +29,7 @@ */ /** \file - * - * Board specific LED driver header for the EVK527. + * \brief Board specific LED driver header for the 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. diff --git a/LUFA/Drivers/Board/Joystick.h b/LUFA/Drivers/Board/Joystick.h index 39375a265..18993c5f7 100644 --- a/LUFA/Drivers/Board/Joystick.h +++ b/LUFA/Drivers/Board/Joystick.h @@ -29,6 +29,7 @@ */ /** \file + * \brief Master include file for the board digital joystick driver. * * This file is the master dispatch header file for the board-specific Joystick driver, for boards containing a * 5-way joystick. diff --git a/LUFA/Drivers/Board/LEDs.h b/LUFA/Drivers/Board/LEDs.h index ce4ba54f4..36ab3e4dc 100644 --- a/LUFA/Drivers/Board/LEDs.h +++ b/LUFA/Drivers/Board/LEDs.h @@ -29,6 +29,7 @@ */ /** \file + * \brief Master include file for the board LEDs driver. * * This file is the master dispatch header file for the board-specific LED driver, for boards containing user * controllable LEDs. diff --git a/LUFA/Drivers/Board/RZUSBSTICK/LEDs.h b/LUFA/Drivers/Board/RZUSBSTICK/LEDs.h index d095d6e0f..ec3fedcf6 100644 --- a/LUFA/Drivers/Board/RZUSBSTICK/LEDs.h +++ b/LUFA/Drivers/Board/RZUSBSTICK/LEDs.h @@ -29,8 +29,7 @@ */ /** \file - * - * Board specific LED driver header for the RZUSBSTICK. + * \brief Board specific LED driver header for the 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. diff --git a/LUFA/Drivers/Board/STK525/AT45DB321C.h b/LUFA/Drivers/Board/STK525/AT45DB321C.h index e29a0a5eb..31ebe3902 100644 --- a/LUFA/Drivers/Board/STK525/AT45DB321C.h +++ b/LUFA/Drivers/Board/STK525/AT45DB321C.h @@ -29,8 +29,7 @@ */ /** \file - * - * Board specific Dataflash commands header for the AT45DB321C as mounted on the STK525. + * \brief Board specific Dataflash commands header for the AT45DB321C as mounted on the 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/Buttons.h b/LUFA/Drivers/Board/STK525/Buttons.h index f3dccafd9..cf9b5b1f5 100644 --- a/LUFA/Drivers/Board/STK525/Buttons.h +++ b/LUFA/Drivers/Board/STK525/Buttons.h @@ -29,8 +29,7 @@ */ /** \file - * - * Board specific Buttons driver header for the STK525. + * \brief Board specific Buttons driver header for the 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. diff --git a/LUFA/Drivers/Board/STK525/Dataflash.h b/LUFA/Drivers/Board/STK525/Dataflash.h index f541edbb7..757923e6c 100644 --- a/LUFA/Drivers/Board/STK525/Dataflash.h +++ b/LUFA/Drivers/Board/STK525/Dataflash.h @@ -29,8 +29,7 @@ */ /** \file - * - * Board specific Dataflash driver header for the STK525. + * \brief Board specific Dataflash driver header for the 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 6358f957e..7a29ffd80 100644 --- a/LUFA/Drivers/Board/STK525/Joystick.h +++ b/LUFA/Drivers/Board/STK525/Joystick.h @@ -29,8 +29,7 @@ */ /** \file - * - * Board specific joystick driver header for the STK525. + * \brief Board specific joystick driver header for the 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. diff --git a/LUFA/Drivers/Board/STK525/LEDs.h b/LUFA/Drivers/Board/STK525/LEDs.h index b54a8c987..1f30dbe5c 100644 --- a/LUFA/Drivers/Board/STK525/LEDs.h +++ b/LUFA/Drivers/Board/STK525/LEDs.h @@ -29,8 +29,7 @@ */ /** \file - * - * Board specific LED driver header for the STK525. + * \brief Board specific LED driver header for the 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. diff --git a/LUFA/Drivers/Board/STK526/AT45DB642D.h b/LUFA/Drivers/Board/STK526/AT45DB642D.h index bf2973ef3..b03441356 100644 --- a/LUFA/Drivers/Board/STK526/AT45DB642D.h +++ b/LUFA/Drivers/Board/STK526/AT45DB642D.h @@ -29,8 +29,7 @@ */ /** \file - * - * Board specific Dataflash commands header for the AT45DB642D as mounted on the STK526. + * \brief Board specific Dataflash commands header for the AT45DB642D as mounted on the 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. diff --git a/LUFA/Drivers/Board/STK526/Buttons.h b/LUFA/Drivers/Board/STK526/Buttons.h index f480560f6..650d894d4 100644 --- a/LUFA/Drivers/Board/STK526/Buttons.h +++ b/LUFA/Drivers/Board/STK526/Buttons.h @@ -29,8 +29,7 @@ */ /** \file - * - * Board specific Buttons driver header for the STK526. + * \brief Board specific Buttons driver header for the 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. diff --git a/LUFA/Drivers/Board/STK526/Dataflash.h b/LUFA/Drivers/Board/STK526/Dataflash.h index 9d04afe4c..d3bb968e2 100644 --- a/LUFA/Drivers/Board/STK526/Dataflash.h +++ b/LUFA/Drivers/Board/STK526/Dataflash.h @@ -29,8 +29,7 @@ */ /** \file - * - * Board specific Dataflash driver header for the STK525. + * \brief Board specific Dataflash driver header for the 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 b095536aa..ed74b4756 100644 --- a/LUFA/Drivers/Board/STK526/Joystick.h +++ b/LUFA/Drivers/Board/STK526/Joystick.h @@ -29,8 +29,7 @@ */ /** \file - * - * Board specific joystick driver header for the STK526. + * \brief Board specific joystick driver header for the 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. diff --git a/LUFA/Drivers/Board/STK526/LEDs.h b/LUFA/Drivers/Board/STK526/LEDs.h index d1ac493ad..96cd7f0f7 100644 --- a/LUFA/Drivers/Board/STK526/LEDs.h +++ b/LUFA/Drivers/Board/STK526/LEDs.h @@ -29,8 +29,7 @@ */ /** \file - * - * Board specific LED driver header for the STK526. + * \brief Board specific LED driver header for the 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. diff --git a/LUFA/Drivers/Board/TEENSY/LEDs.h b/LUFA/Drivers/Board/TEENSY/LEDs.h index 755d578ed..6e58174a6 100644 --- a/LUFA/Drivers/Board/TEENSY/LEDs.h +++ b/LUFA/Drivers/Board/TEENSY/LEDs.h @@ -29,8 +29,7 @@ */ /** \file - * - * Board specific LED driver header for the PJRC Teensy series boards. + * \brief Board specific LED driver header for the PJRC Teensy boards. * * \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. diff --git a/LUFA/Drivers/Board/Temperature.h b/LUFA/Drivers/Board/Temperature.h index 7a5af367b..75f56179d 100644 --- a/LUFA/Drivers/Board/Temperature.h +++ b/LUFA/Drivers/Board/Temperature.h @@ -29,6 +29,7 @@ */ /** \file + * \brief Master include file for the board temperature sensor driver. * * Temperature sensor board driver for the USB boards which contain a temperature sensor. */ diff --git a/LUFA/Drivers/Board/USBKEY/AT45DB642D.h b/LUFA/Drivers/Board/USBKEY/AT45DB642D.h index a9f48f083..9d333067c 100644 --- a/LUFA/Drivers/Board/USBKEY/AT45DB642D.h +++ b/LUFA/Drivers/Board/USBKEY/AT45DB642D.h @@ -29,8 +29,7 @@ */ /** \file - * - * Board specific Dataflash commands header for the AT45DB642D as mounted on the USBKEY. + * \brief Board specific Dataflash commands header for the AT45DB642D as mounted on the 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. diff --git a/LUFA/Drivers/Board/USBKEY/Buttons.h b/LUFA/Drivers/Board/USBKEY/Buttons.h index db1391c8e..f54ecbe06 100644 --- a/LUFA/Drivers/Board/USBKEY/Buttons.h +++ b/LUFA/Drivers/Board/USBKEY/Buttons.h @@ -29,8 +29,7 @@ */ /** \file - * - * Board specific Buttons driver header for the USBKEY. + * \brief Board specific Buttons driver header for the 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. diff --git a/LUFA/Drivers/Board/USBKEY/Dataflash.h b/LUFA/Drivers/Board/USBKEY/Dataflash.h index 96cc3ad2d..95cd55b4e 100644 --- a/LUFA/Drivers/Board/USBKEY/Dataflash.h +++ b/LUFA/Drivers/Board/USBKEY/Dataflash.h @@ -29,8 +29,7 @@ */ /** \file - * - * Board specific Dataflash driver header for the USBKEY. + * \brief Board specific Dataflash driver header for the 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. diff --git a/LUFA/Drivers/Board/USBKEY/Joystick.h b/LUFA/Drivers/Board/USBKEY/Joystick.h index b0829914b..06cbac07a 100644 --- a/LUFA/Drivers/Board/USBKEY/Joystick.h +++ b/LUFA/Drivers/Board/USBKEY/Joystick.h @@ -29,8 +29,7 @@ */ /** \file - * - * Board specific joystick driver header for the USBKEY. + * \brief Board specific joystick driver header for the 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. diff --git a/LUFA/Drivers/Board/USBKEY/LEDs.h b/LUFA/Drivers/Board/USBKEY/LEDs.h index e1a5b2314..fc4c3c9b5 100644 --- a/LUFA/Drivers/Board/USBKEY/LEDs.h +++ b/LUFA/Drivers/Board/USBKEY/LEDs.h @@ -29,8 +29,7 @@ */ /** \file - * - * Board specific LED driver header for the USBKEY. + * \brief Board specific LED driver header for the 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. diff --git a/LUFA/Drivers/Board/XPLAIN/AT45DB642D.h b/LUFA/Drivers/Board/XPLAIN/AT45DB642D.h index 1df0b4083..20e2f01c2 100644 --- a/LUFA/Drivers/Board/XPLAIN/AT45DB642D.h +++ b/LUFA/Drivers/Board/XPLAIN/AT45DB642D.h @@ -29,8 +29,7 @@ */ /** \file - * - * Board specific Dataflash commands header for the AT45DB642D as mounted on the XPLAIN. + * \brief Board specific Dataflash commands header for the AT45DB642D as mounted on the 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/Dataflash.h b/LUFA/Drivers/Board/XPLAIN/Dataflash.h index a0e09c711..9bd0c9a06 100644 --- a/LUFA/Drivers/Board/XPLAIN/Dataflash.h +++ b/LUFA/Drivers/Board/XPLAIN/Dataflash.h @@ -29,8 +29,7 @@ */ /** \file - * - * Board specific Dataflash driver header for the XPLAIN. + * \brief Board specific Dataflash driver header for the 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 add868d20..d4696d106 100644 --- a/LUFA/Drivers/Board/XPLAIN/LEDs.h +++ b/LUFA/Drivers/Board/XPLAIN/LEDs.h @@ -29,8 +29,7 @@ */ /** \file - * - * Board specific LED driver header for the XPLAIN. + * \brief Board specific LED driver header for the 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. diff --git a/LUFA/Drivers/Misc/TerminalCodes.h b/LUFA/Drivers/Misc/TerminalCodes.h index 216d8b98b..a5f397aeb 100644 --- a/LUFA/Drivers/Misc/TerminalCodes.h +++ b/LUFA/Drivers/Misc/TerminalCodes.h @@ -29,10 +29,10 @@ */ /** \file + * \brief ANSI terminal special escape code macros. * * ANSI terminal compatible escape sequences. These escape sequences are designed to be concatenated with existing * strings to modify their display on a compatible terminal application. - * */ /** \ingroup Group_MiscDrivers diff --git a/LUFA/Drivers/Peripheral/ADC.h b/LUFA/Drivers/Peripheral/ADC.h index 982364368..e3840fe84 100644 --- a/LUFA/Drivers/Peripheral/ADC.h +++ b/LUFA/Drivers/Peripheral/ADC.h @@ -29,6 +29,7 @@ */ /** \file + * \brief Master include file for the ADC peripheral driver. * * This file is the master dispatch header file for the device-specific ADC driver, for AVRs containing an ADC. * diff --git a/LUFA/Drivers/Peripheral/AVRU4U6U7/ADC.h b/LUFA/Drivers/Peripheral/AVRU4U6U7/ADC.h index 9ab65af53..e307c4e09 100644 --- a/LUFA/Drivers/Peripheral/AVRU4U6U7/ADC.h +++ b/LUFA/Drivers/Peripheral/AVRU4U6U7/ADC.h @@ -29,6 +29,7 @@ */ /** \file + * \brief ADC peripheral driver for the U7, U6 and U4 USB AVRs. * * ADC driver for the AT90USB1287, AT90USB1286, AT90USB647, AT90USB646, ATMEGA16U4 and ATMEGA32U4 AVRs. * diff --git a/LUFA/Drivers/Peripheral/AVRU4U6U7/SPI.h b/LUFA/Drivers/Peripheral/AVRU4U6U7/SPI.h deleted file mode 100644 index 3440cc9f1..000000000 --- a/LUFA/Drivers/Peripheral/AVRU4U6U7/SPI.h +++ /dev/null @@ -1,189 +0,0 @@ -/* - LUFA Library - Copyright (C) Dean Camera, 2010. - - dean [at] fourwalledcubicle [dot] com - www.fourwalledcubicle.com -*/ - -/* - Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com) - - Permission to use, copy, modify, distribute, and sell this - software and its documentation for any purpose is hereby granted - without fee, provided that the above copyright notice appear in - all copies and that both that the copyright notice and this - permission notice and warranty disclaimer appear in supporting - documentation, and that the name of the author not be used in - advertising or publicity pertaining to distribution of the - software without specific, written prior permission. - - The author disclaim all warranties with regard to this - software, including all implied warranties of merchantability - and fitness. In no event shall the author be liable for any - special, indirect or consequential damages or any damages - whatsoever resulting from loss of use, data or profits, whether - in an action of contract, negligence or other tortious action, - arising out of or in connection with the use or performance of - this software. -*/ - -/** \file - * - * SPI driver for the 8-bit AVRs. - * - * \note This file should not be included directly. It is automatically included as needed by the SPI driver - * dispatch header located in LUFA/Drivers/Peripheral/SPI.h. - */ - -/** \ingroup Group_SPI - * @defgroup Group_SPI_AVR8 8-Bit AVR SPI Driver - * - * SPI driver for the 8-bit AVRs. - * - * \note This file should not be included directly. It is automatically included as needed by the ADC driver - * dispatch header located in LUFA/Drivers/Peripheral/SPI.h. - * - * @{ - */ - -#ifndef __SPI_AVR8_H__ -#define __SPI_AVR8_H__ - - /* Includes: */ - #include - - /* Preprocessor Checks: */ - #if !defined(__INCLUDE_FROM_SPI_H) - #error Do not include this file directly. Include LUFA/Drivers/Peripheral/SPI.h instead. - #endif - - /* Enable C linkage for C++ Compilers: */ - #if defined(__cplusplus) - extern "C" { - #endif - - /* Private Interface - For use in library only: */ - #if !defined(__DOXYGEN__) - /* Macros: */ - #define SPI_USE_DOUBLESPEED (1 << SPE) - #endif - - /* Public Interface - May be used in end-application: */ - /* Macros: */ - /** SPI prescaler mask for SPI_Init(). Divides the system clock by a factor of 2. */ - #define SPI_SPEED_FCPU_DIV_2 SPI_USE_DOUBLESPEED - - /** SPI prescaler mask for SPI_Init(). Divides the system clock by a factor of 4. */ - #define SPI_SPEED_FCPU_DIV_4 0 - - /** SPI prescaler mask for SPI_Init(). Divides the system clock by a factor of 8. */ - #define SPI_SPEED_FCPU_DIV_8 (SPI_USE_DOUBLESPEED | (1 << SPR0)) - - /** SPI prescaler mask for SPI_Init(). Divides the system clock by a factor of 16. */ - #define SPI_SPEED_FCPU_DIV_16 (1 << SPR0) - - /** SPI prescaler mask for SPI_Init(). Divides the system clock by a factor of 32. */ - #define SPI_SPEED_FCPU_DIV_32 (SPI_USE_DOUBLESPEED | (1 << SPR1)) - - /** SPI prescaler mask for SPI_Init(). Divides the system clock by a factor of 64. */ - #define SPI_SPEED_FCPU_DIV_64 (SPI_USE_DOUBLESPEED | (1 << SPR1) | (1 << SPR0)) - - /** SPI prescaler mask for SPI_Init(). Divides the system clock by a factor of 128. */ - #define SPI_SPEED_FCPU_DIV_128 ((1 << SPR1) | (1 << SPR0)) - - /** SPI clock polarity mask for SPI_Init(). Indicates that the SCK should lead on the rising edge. */ - #define SPI_SCK_LEAD_RISING (0 << CPOL) - - /** SPI clock polarity mask for SPI_Init(). Indicates that the SCK should lead on the falling edge. */ - #define SPI_SCK_LEAD_FALLING (1 << CPOL) - - /** SPI data sample mode mask for SPI_Init(). Indicates that the data should sampled on the leading edge. */ - #define SPI_SAMPLE_LEADING (0 << CPHA) - - /** SPI data sample mode mask for SPI_Init(). Indicates that the data should be sampled on the trailing edge. */ - #define SPI_SAMPLE_TRAILING (1 << CPHA) - - /** SPI mode mask for SPI_Init(). Indicates that the SPI interface should be initialized into slave mode. */ - #define SPI_MODE_SLAVE (0 << MSTR) - - /** SPI mode mask for SPI_Init(). Indicates that the SPI interface should be initialized into master mode. */ - #define SPI_MODE_MASTER (1 << MSTR) - - /* Inline Functions: */ - /** Initialises the SPI subsystem, ready for transfers. Must be called before calling any other - * SPI routines. - * - * \param[in] SPIOptions SPI Options, a mask consisting of one of each of the SPI_SPEED_*, - * SPI_SCK_*, SPI_SAMPLE_* and SPI_MODE_* masks - */ - static inline void SPI_Init(const uint8_t SPIOptions) - { - DDRB |= ((1 << 1) | (1 << 2)); - PORTB |= ((1 << 0) | (1 << 3)); - - SPCR = ((1 << SPE) | SPIOptions); - - if (SPIOptions & SPI_USE_DOUBLESPEED) - SPSR |= (1 << SPI2X); - else - SPSR &= ~(1 << SPI2X); - } - - /** Turns off the SPI driver, disabling and returning used hardware to their default configuration. */ - static inline void SPI_ShutDown(void) - { - DDRB &= ~((1 << 1) | (1 << 2)); - PORTB &= ~((1 << 0) | (1 << 3)); - - SPCR = 0; - SPSR = 0; - } - - /** Sends and receives a byte through the SPI interface, blocking until the transfer is complete. - * - * \param[in] Byte Byte to send through the SPI interface - * - * \return Response byte from the attached SPI device - */ - static inline uint8_t SPI_TransferByte(const uint8_t Byte) ATTR_ALWAYS_INLINE; - static inline uint8_t SPI_TransferByte(const uint8_t Byte) - { - SPDR = Byte; - while (!(SPSR & (1 << SPIF))); - return SPDR; - } - - /** Sends a byte through the SPI interface, blocking until the transfer is complete. The response - * byte sent to from the attached SPI device is ignored. - * - * \param[in] Byte Byte to send through the SPI interface - */ - static inline void SPI_SendByte(const uint8_t Byte) ATTR_ALWAYS_INLINE; - static inline void SPI_SendByte(const uint8_t Byte) - { - SPDR = Byte; - while (!(SPSR & (1 << SPIF))); - } - - /** Sends a dummy byte through the SPI interface, blocking until the transfer is complete. The response - * byte from the attached SPI device is returned. - * - * \return The response byte from the attached SPI device - */ - static inline uint8_t SPI_ReceiveByte(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT; - static inline uint8_t SPI_ReceiveByte(void) - { - SPDR = 0x00; - while (!(SPSR & (1 << SPIF))); - return SPDR; - } - - /* Disable C linkage for C++ Compilers: */ - #if defined(__cplusplus) - } - #endif - -#endif - -/** @} */ diff --git a/LUFA/Drivers/Peripheral/AVRU4U6U7/Serial.h b/LUFA/Drivers/Peripheral/AVRU4U6U7/Serial.h deleted file mode 100644 index 0421dea73..000000000 --- a/LUFA/Drivers/Peripheral/AVRU4U6U7/Serial.h +++ /dev/null @@ -1,145 +0,0 @@ -/* - LUFA Library - Copyright (C) Dean Camera, 2010. - - dean [at] fourwalledcubicle [dot] com - www.fourwalledcubicle.com -*/ - -/* - Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com) - - Permission to use, copy, modify, distribute, and sell this - software and its documentation for any purpose is hereby granted - without fee, provided that the above copyright notice appear in - all copies and that both that the copyright notice and this - permission notice and warranty disclaimer appear in supporting - documentation, and that the name of the author not be used in - advertising or publicity pertaining to distribution of the - software without specific, written prior permission. - - The author disclaim all warranties with regard to this - software, including all implied warranties of merchantability - and fitness. In no event shall the author be liable for any - special, indirect or consequential damages or any damages - whatsoever resulting from loss of use, data or profits, whether - in an action of contract, negligence or other tortious action, - arising out of or in connection with the use or performance of - this software. -*/ - -/** \file - * - * ADC driver for the 8-bit AVRs. - * - * \note This file should not be included directly. It is automatically included as needed by the USART driver - * dispatch header located in LUFA/Drivers/Peripheral/Serial.h. - */ - -/** \ingroup Group_Serial - * @defgroup Group_Serial_AVR8 8-Bit AVR Serial Driver - * - * Serial driver for the 8-bit AVRs. - * - * \note This file should not be included directly. It is automatically included as needed by the ADC driver - * dispatch header located in LUFA/Drivers/Peripheral/USART.h. - * - * @{ - */ - -#ifndef __SERIAL_AVR8_H__ -#define __SERIAL_AVR8_H__ - - /* Includes: */ - #include - #include - #include - - /* Preprocessor Checks: */ - #if !defined(__INCLUDE_FROM_SERIAL_H) - #error Do not include this file directly. Include LUFA/Drivers/Peripheral/Serial.h instead. - #endif - - /* Public Interface - May be used in end-application: */ - /* Macros: */ - /** Macro for calculating the baud value from a given baud rate when the U2X (double speed) bit is - * not set. - */ - #define SERIAL_UBBRVAL(baud) ((((F_CPU / 16) + (baud / 2)) / (baud)) - 1) - - /** Macro for calculating the baud value from a given baud rate when the U2X (double speed) bit is - * set. - */ - #define SERIAL_2X_UBBRVAL(baud) ((((F_CPU / 8) + (baud / 2)) / (baud)) - 1) - - /* Pseudo-Function Macros: */ - #if defined(__DOXYGEN__) - /** Indicates whether a character has been received through the USART. - * - * \return Boolean true if a character has been received, false otherwise - */ - static inline bool Serial_IsCharReceived(void); - #else - #define Serial_IsCharReceived() ((UCSR1A & (1 << RXC1)) ? true : false) - #endif - - /* Inline Functions: */ - /** Initializes the USART, ready for serial data transmission and reception. This initializes the interface to - * standard 8-bit, no parity, 1 stop bit settings suitable for most applications. - * - * \param[in] BaudRate Serial baud rate, in bits per second - * \param[in] DoubleSpeed Enables double speed mode when set, halving the sample time to double the baud rate - */ - static inline void Serial_Init(const uint32_t BaudRate, const bool DoubleSpeed) - { - UCSR1A = (DoubleSpeed ? (1 << U2X1) : 0); - UCSR1B = ((1 << TXEN1) | (1 << RXEN1)); - UCSR1C = ((1 << UCSZ11) | (1 << UCSZ10)); - - DDRD |= (1 << 3); - PORTD |= (1 << 2); - - UBRR1 = (DoubleSpeed ? SERIAL_2X_UBBRVAL(BaudRate) : SERIAL_UBBRVAL(BaudRate)); - } - - /** Turns off the USART driver, disabling and returning used hardware to their default configuration. */ - static inline void Serial_ShutDown(void) - { - UCSR1A = 0; - UCSR1B = 0; - UCSR1C = 0; - - DDRD &= ~(1 << 3); - PORTD &= ~(1 << 2); - - UBRR1 = 0; - } - - /** Transmits a given byte through the USART. - * - * \param[in] DataByte Byte to transmit through the USART - */ - static inline void Serial_TxByte(const char DataByte) - { - while (!(UCSR1A & (1 << UDRE1))); - UDR1 = DataByte; - } - - /** Receives a byte from the USART. - * - * \return Byte received from the USART - */ - static inline uint8_t Serial_RxByte(void) - { - while (!(UCSR1A & (1 << RXC1))); - return UDR1; - } - - /* Disable C linkage for C++ Compilers: */ - #if defined(__cplusplus) - } - #endif - -#endif - -/** @} */ diff --git a/LUFA/Drivers/Peripheral/AVRU4U6U7/TWI.h b/LUFA/Drivers/Peripheral/AVRU4U6U7/TWI.h index 2d8e6df1e..990b44d14 100644 --- a/LUFA/Drivers/Peripheral/AVRU4U6U7/TWI.h +++ b/LUFA/Drivers/Peripheral/AVRU4U6U7/TWI.h @@ -29,6 +29,7 @@ */ /** \file + * \brief TWI peripheral driver for the U7, U6 and U4 USB AVRs. * * Master mode TWI driver for the AT90USB1287, AT90USB1286, AT90USB647, AT90USB646, ATMEGA16U4 and ATMEGA32U4 AVRs. * diff --git a/LUFA/Drivers/Peripheral/SPI.h b/LUFA/Drivers/Peripheral/SPI.h index 6416ceae6..041c0788e 100644 --- a/LUFA/Drivers/Peripheral/SPI.h +++ b/LUFA/Drivers/Peripheral/SPI.h @@ -29,6 +29,7 @@ */ /** \file + * \brief Master include file for the SPI peripheral driver. * * Hardware SPI subsystem driver for the supported USB AVRs models. */ diff --git a/LUFA/Drivers/Peripheral/Serial.h b/LUFA/Drivers/Peripheral/Serial.h index d00f9c1c0..662d7f270 100644 --- a/LUFA/Drivers/Peripheral/Serial.h +++ b/LUFA/Drivers/Peripheral/Serial.h @@ -29,6 +29,7 @@ */ /** \file + * \brief Master include file for the USART peripheral driver. * * Driver for the USART subsystem on supported USB AVRs. */ diff --git a/LUFA/Drivers/Peripheral/SerialStream.h b/LUFA/Drivers/Peripheral/SerialStream.h index feadd0a0f..85bdf9085 100644 --- a/LUFA/Drivers/Peripheral/SerialStream.h +++ b/LUFA/Drivers/Peripheral/SerialStream.h @@ -29,11 +29,13 @@ */ /** \file + * \brief Standard avr-libc character stream driver for the USART. * * Serial stream driver for the USART subsystem on supported USB AVRs. This makes use of the functions in the - * regular USART driver, but allows the avr-libc standard stream functions (printf, puts, etc.) to work with the + * regular USART driver (see \ref Group_Serial), but allows the avr-libc standard stream functions (printf, + * puts, etc.) to work with the * USART. - **/ + */ /** \ingroup Group_PeripheralDrivers * @defgroup Group_SerialStream Serial Stream Driver - LUFA/Drivers/Peripheral/SerialStream.h @@ -44,7 +46,8 @@ * * \section Module Description * Serial stream driver for the USART subsystem on supported USB AVRs. This makes use of the functions in the - * regular USART driver, but allows the avr-libc standard stream functions (printf, puts, etc.) to work with the + * regular USART driver (see \ref Group_Serial), but allows the avr-libc standard stream functions (printf, + * puts, etc.) to work with the * USART. * * @{ diff --git a/LUFA/Drivers/Peripheral/TWI.h b/LUFA/Drivers/Peripheral/TWI.h index 29c0afe40..8e2127d47 100644 --- a/LUFA/Drivers/Peripheral/TWI.h +++ b/LUFA/Drivers/Peripheral/TWI.h @@ -29,6 +29,7 @@ */ /** \file + * \brief Master include file for the TWI peripheral driver. * * This file is the master dispatch header file for the device-specific ADC driver, for AVRs containing an ADC. * diff --git a/LUFA/Drivers/USB/Class/Audio.h b/LUFA/Drivers/USB/Class/Audio.h index c6a926337..3c7e66535 100644 --- a/LUFA/Drivers/USB/Class/Audio.h +++ b/LUFA/Drivers/USB/Class/Audio.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Master include file for the library USB Audio Class driver. + * + * This file should be included in all user projects making use of this optional class driver, instead of + * including any headers in the USB/ClassDriver/Device, USB/ClassDriver/Host or USB/ClassDriver/Common subdirectories. + */ + /** \ingroup Group_USBClassDrivers * @defgroup Group_USBClassAudio Audio Class Driver - LUFA/Drivers/Class/Audio.h * diff --git a/LUFA/Drivers/USB/Class/CDC.h b/LUFA/Drivers/USB/Class/CDC.h index cc49572b2..22e534368 100644 --- a/LUFA/Drivers/USB/Class/CDC.h +++ b/LUFA/Drivers/USB/Class/CDC.h @@ -28,8 +28,15 @@ this software. */ +/** \file + * \brief Master include file for the library USB CDC-ACM Class driver. + * + * This file should be included in all user projects making use of this optional class driver, instead of + * including any headers in the USB/ClassDriver/Device, USB/ClassDriver/Host or USB/ClassDriver/Common subdirectories. + */ + /** \ingroup Group_USBClassDrivers - * @defgroup Group_USBClassCDC CDC Class Driver - LUFA/Drivers/Class/CDC.h + * @defgroup Group_USBClassCDC CDC-ACM (Virtual Serial) Class Driver - LUFA/Drivers/Class/CDC.h * * \section Sec_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: diff --git a/LUFA/Drivers/USB/Class/Common/Audio.h b/LUFA/Drivers/USB/Class/Common/Audio.h index 5d19b6f42..a6a1b4070 100644 --- a/LUFA/Drivers/USB/Class/Common/Audio.h +++ b/LUFA/Drivers/USB/Class/Common/Audio.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Common definitions and declarations for the library USB Audio Class driver. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/Audio.h. + */ + /** \ingroup Group_USBClassAudio * @defgroup Group_USBClassAudioCommon Common Class Definitions * diff --git a/LUFA/Drivers/USB/Class/Common/CDC.h b/LUFA/Drivers/USB/Class/Common/CDC.h index 55f530ba9..bb1996b6c 100644 --- a/LUFA/Drivers/USB/Class/Common/CDC.h +++ b/LUFA/Drivers/USB/Class/Common/CDC.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Common definitions and declarations for the library USB CDC Class driver. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/CDC.h. + */ + /** \ingroup Group_USBClassCDC * @defgroup Group_USBClassCDCCommon Common Class Definitions * diff --git a/LUFA/Drivers/USB/Class/Common/HID.h b/LUFA/Drivers/USB/Class/Common/HID.h index 33a5af4ac..cf457cb86 100644 --- a/LUFA/Drivers/USB/Class/Common/HID.h +++ b/LUFA/Drivers/USB/Class/Common/HID.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Common definitions and declarations for the library USB HID Class driver. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/HID.h. + */ + /** \ingroup Group_USBClassHID * @defgroup Group_USBClassHIDCommon Common Class Definitions * diff --git a/LUFA/Drivers/USB/Class/Common/MIDI.h b/LUFA/Drivers/USB/Class/Common/MIDI.h index 755006a70..72a72de38 100644 --- a/LUFA/Drivers/USB/Class/Common/MIDI.h +++ b/LUFA/Drivers/USB/Class/Common/MIDI.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Common definitions and declarations for the library USB MIDI Class driver. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/MIDI.h. + */ + /** \ingroup Group_USBClassMIDI * @defgroup Group_USBClassMIDICommon Common Class Definitions * diff --git a/LUFA/Drivers/USB/Class/Common/MassStorage.h b/LUFA/Drivers/USB/Class/Common/MassStorage.h index 8726148a2..7f321350f 100644 --- a/LUFA/Drivers/USB/Class/Common/MassStorage.h +++ b/LUFA/Drivers/USB/Class/Common/MassStorage.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Common definitions and declarations for the library USB Mass Storage Class driver. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/MassStorage.h. + */ + /** \ingroup Group_USBClassMS * @defgroup Group_USBClassMSCommon Common Class Definitions * diff --git a/LUFA/Drivers/USB/Class/Common/Printer.h b/LUFA/Drivers/USB/Class/Common/Printer.h index 06ec0bb0b..f78cbaafa 100644 --- a/LUFA/Drivers/USB/Class/Common/Printer.h +++ b/LUFA/Drivers/USB/Class/Common/Printer.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Common definitions and declarations for the library USB Printer Class driver. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/Printer.h. + */ + /** \ingroup Group_USBClassMS * @defgroup Group_USBClassPrinterCommon Common Class Definitions * diff --git a/LUFA/Drivers/USB/Class/Common/RNDIS.h b/LUFA/Drivers/USB/Class/Common/RNDIS.h index 258604deb..b69142c98 100644 --- a/LUFA/Drivers/USB/Class/Common/RNDIS.h +++ b/LUFA/Drivers/USB/Class/Common/RNDIS.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Common definitions and declarations for the library USB RNDIS Class driver. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/RNDIS.h. + */ + /** \ingroup Group_USBClassRNDIS * @defgroup Group_USBClassRNDISCommon Common Class Definitions * diff --git a/LUFA/Drivers/USB/Class/Common/RNDISConstants.h b/LUFA/Drivers/USB/Class/Common/RNDISConstants.h index 67fa78a0d..b65040e1b 100644 --- a/LUFA/Drivers/USB/Class/Common/RNDISConstants.h +++ b/LUFA/Drivers/USB/Class/Common/RNDISConstants.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Common RNDIS class constant definitions. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/Audio.h. + */ + /** \file * * RNDIS specification related constants. For more information on these diff --git a/LUFA/Drivers/USB/Class/Common/StillImage.h b/LUFA/Drivers/USB/Class/Common/StillImage.h index e65b2dbfd..4b0faac35 100644 --- a/LUFA/Drivers/USB/Class/Common/StillImage.h +++ b/LUFA/Drivers/USB/Class/Common/StillImage.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Common definitions and declarations for the library USB Still Image Class driver. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/StillImage.h. + */ + /** \ingroup Group_USBClassSI * @defgroup Group_USBClassSICommon Common Class Definitions * diff --git a/LUFA/Drivers/USB/Class/Device/Audio.h b/LUFA/Drivers/USB/Class/Device/Audio.h index 87fab9889..9677339ca 100644 --- a/LUFA/Drivers/USB/Class/Device/Audio.h +++ b/LUFA/Drivers/USB/Class/Device/Audio.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Device mode driver for the library USB Audio Class driver. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/Audio.h. + */ + /** \ingroup Group_USBClassAudio * @defgroup Group_USBClassAudioDevice Audio Class Device Mode Driver * diff --git a/LUFA/Drivers/USB/Class/Device/CDC.h b/LUFA/Drivers/USB/Class/Device/CDC.h index 0c214441c..adf1708ce 100644 --- a/LUFA/Drivers/USB/Class/Device/CDC.h +++ b/LUFA/Drivers/USB/Class/Device/CDC.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Device mode driver for the library USB CDC Class driver. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/CDC.h. + */ + /** \ingroup Group_USBClassCDC * @defgroup Group_USBClassCDCDevice CDC Class Device Mode Driver * diff --git a/LUFA/Drivers/USB/Class/Device/HID.h b/LUFA/Drivers/USB/Class/Device/HID.h index 15b428a7b..009018437 100644 --- a/LUFA/Drivers/USB/Class/Device/HID.h +++ b/LUFA/Drivers/USB/Class/Device/HID.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Device mode driver for the library USB HID Class driver. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/HID.h. + */ + /** \ingroup Group_USBClassHID * @defgroup Group_USBClassHIDDevice HID Class Device Mode Driver * diff --git a/LUFA/Drivers/USB/Class/Device/MIDI.h b/LUFA/Drivers/USB/Class/Device/MIDI.h index 772456bc1..9eaabbc5e 100644 --- a/LUFA/Drivers/USB/Class/Device/MIDI.h +++ b/LUFA/Drivers/USB/Class/Device/MIDI.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Device mode driver for the library USB MIDI Class driver. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/MIDI.h. + */ + /** \ingroup Group_USBClassMIDI * @defgroup Group_USBClassMIDIDevice MIDI Class Device Mode Driver * diff --git a/LUFA/Drivers/USB/Class/Device/MassStorage.h b/LUFA/Drivers/USB/Class/Device/MassStorage.h index 87dcfb232..67bbfab91 100644 --- a/LUFA/Drivers/USB/Class/Device/MassStorage.h +++ b/LUFA/Drivers/USB/Class/Device/MassStorage.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Device mode driver for the library USB Mass Storage Class driver. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/MassStorage.h. + */ + /** \ingroup Group_USBClassMS * @defgroup Group_USBClassMSDevice Mass Storage Class Device Mode Driver * diff --git a/LUFA/Drivers/USB/Class/Device/RNDIS.h b/LUFA/Drivers/USB/Class/Device/RNDIS.h index 7d6b3a882..5d541f18b 100644 --- a/LUFA/Drivers/USB/Class/Device/RNDIS.h +++ b/LUFA/Drivers/USB/Class/Device/RNDIS.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Device mode driver for the library USB RNDIS Class driver. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/RNDIS.h. + */ + /** \ingroup Group_USBClassRNDIS * @defgroup Group_USBClassRNDISDevice RNDIS Class Device Mode Driver * diff --git a/LUFA/Drivers/USB/Class/HID.h b/LUFA/Drivers/USB/Class/HID.h index 5eda33b2a..3a7fe2121 100644 --- a/LUFA/Drivers/USB/Class/HID.h +++ b/LUFA/Drivers/USB/Class/HID.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Master include file for the library USB HID Class driver. + * + * This file should be included in all user projects making use of this optional class driver, instead of + * including any headers in the USB/ClassDriver/Device, USB/ClassDriver/Host or USB/ClassDriver/Common subdirectories. + */ + /** \ingroup Group_USBClassDrivers * @defgroup Group_USBClassHID HID Class Driver - LUFA/Drivers/Class/HID.h * diff --git a/LUFA/Drivers/USB/Class/Host/CDC.h b/LUFA/Drivers/USB/Class/Host/CDC.h index feb6bf87a..205bb3d57 100644 --- a/LUFA/Drivers/USB/Class/Host/CDC.h +++ b/LUFA/Drivers/USB/Class/Host/CDC.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Host mode driver for the library USB Audio Class driver. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/Audio.h. + */ + /** \ingroup Group_USBClassCDC * @defgroup Group_USBClassCDCHost CDC Class Host Mode Driver * diff --git a/LUFA/Drivers/USB/Class/Host/HID.h b/LUFA/Drivers/USB/Class/Host/HID.h index d4ea7ac63..fd0227e6c 100644 --- a/LUFA/Drivers/USB/Class/Host/HID.h +++ b/LUFA/Drivers/USB/Class/Host/HID.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Host mode driver for the library USB HID Class driver. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/HID.h. + */ + /** \ingroup Group_USBClassHID * @defgroup Group_USBClassHIDHost HID Class Host Mode Driver * diff --git a/LUFA/Drivers/USB/Class/Host/HIDParser.h b/LUFA/Drivers/USB/Class/Host/HIDParser.h index 6b6549b51..377a8217c 100644 --- a/LUFA/Drivers/USB/Class/Host/HIDParser.h +++ b/LUFA/Drivers/USB/Class/Host/HIDParser.h @@ -29,10 +29,11 @@ */ /** \file + * \brief USB Human Interface Device (HID) Class report descriptor parser. * - * USB Human Interface Device (HID) Class report descriptor processing routines. This file allows for the easy - * parsing of the complex HID report descriptor, which describes the data that the device transmits to the host. - * + * This file allows for the easy parsing of the complex HID report descriptor, which describes the data that + * the device transmits to the host. It also provides an easy API for extracting and processing the data + * elements inside a HID report sent from an attached HID device. */ /** \ingroup Group_USB diff --git a/LUFA/Drivers/USB/Class/Host/HIDReportData.h b/LUFA/Drivers/USB/Class/Host/HIDReportData.h index d3af672c3..197e62b03 100644 --- a/LUFA/Drivers/USB/Class/Host/HIDReportData.h +++ b/LUFA/Drivers/USB/Class/Host/HIDReportData.h @@ -29,9 +29,9 @@ */ /** \file + * \brief Constants for HID report item attributes. * - * Constants for HID report item attributes. Refer to the HID specification for details on each - * flag's meaning when applied to an IN, OUT or FEATURE item. + * Refer to the HID specification for details on each flag's meaning when applied to an IN, OUT or FEATURE item. */ /** \ingroup Group_HIDParser diff --git a/LUFA/Drivers/USB/Class/Host/MIDI.h b/LUFA/Drivers/USB/Class/Host/MIDI.h index 84779a0e8..e0ab9775b 100644 --- a/LUFA/Drivers/USB/Class/Host/MIDI.h +++ b/LUFA/Drivers/USB/Class/Host/MIDI.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Host mode driver for the library USB MIDI Class driver. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/MIDI.h. + */ + /** \ingroup Group_USBClassMIDI * @defgroup Group_USBClassMIDIHost MIDI Class Host Mode Driver * diff --git a/LUFA/Drivers/USB/Class/Host/MassStorage.h b/LUFA/Drivers/USB/Class/Host/MassStorage.h index 502e9021d..8868c9515 100644 --- a/LUFA/Drivers/USB/Class/Host/MassStorage.h +++ b/LUFA/Drivers/USB/Class/Host/MassStorage.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Host mode driver for the library USB Mass Storage Class driver. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/MassStorage.h. + */ + /** \ingroup Group_USBClassMS * @defgroup Group_USBClassMassStorageHost Mass Storage Class Host Mode Driver * diff --git a/LUFA/Drivers/USB/Class/Host/Printer.h b/LUFA/Drivers/USB/Class/Host/Printer.h index 25b0beb7e..dc45780c2 100644 --- a/LUFA/Drivers/USB/Class/Host/Printer.h +++ b/LUFA/Drivers/USB/Class/Host/Printer.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Host mode driver for the library USB Printer Class driver. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/Printer.h. + */ + /** \ingroup Group_USBClassPrinter * @defgroup Group_USBClassPrinterHost Printer Class Host Mode Driver * diff --git a/LUFA/Drivers/USB/Class/Host/RNDIS.h b/LUFA/Drivers/USB/Class/Host/RNDIS.h index f42ed439c..5641620b7 100644 --- a/LUFA/Drivers/USB/Class/Host/RNDIS.h +++ b/LUFA/Drivers/USB/Class/Host/RNDIS.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Host mode driver for the library USB RNDIS Class driver. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/RNDIS.h. + */ + /** \ingroup Group_USBClassRNDIS * @defgroup Group_USBClassRNDISHost RNDIS Class Host Mode Driver * diff --git a/LUFA/Drivers/USB/Class/Host/StillImage.c b/LUFA/Drivers/USB/Class/Host/StillImage.c index d116ceb74..50be7d6d2 100644 --- a/LUFA/Drivers/USB/Class/Host/StillImage.c +++ b/LUFA/Drivers/USB/Class/Host/StillImage.c @@ -151,7 +151,8 @@ uint8_t SImage_Host_SendBlockHeader(USB_ClassInfo_SI_Host_t* const SIInterfaceIn if ((USB_HostState != HOST_STATE_Configured) || !(SIInterfaceInfo->State.IsActive)) return PIPE_RWSTREAM_DeviceDisconnected; - PIMAHeader->TransactionID = SIInterfaceInfo->State.TransactionID++; + if (SIInterfaceInfo->State.IsSessionOpen) + PIMAHeader->TransactionID = SIInterfaceInfo->State.TransactionID++; Pipe_SelectPipe(SIInterfaceInfo->Config.DataOUTPipeNumber); Pipe_Unfreeze(); diff --git a/LUFA/Drivers/USB/Class/Host/StillImage.h b/LUFA/Drivers/USB/Class/Host/StillImage.h index a2101262e..8a3714498 100644 --- a/LUFA/Drivers/USB/Class/Host/StillImage.h +++ b/LUFA/Drivers/USB/Class/Host/StillImage.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Host mode driver for the library USB Still Image Class driver. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/StillImage.h. + */ + /** \ingroup Group_USBClassSI * @defgroup Group_USBClassStillImageHost Still Image Class Host Mode Driver * diff --git a/LUFA/Drivers/USB/Class/MIDI.h b/LUFA/Drivers/USB/Class/MIDI.h index 41f2916d3..b77ca543e 100644 --- a/LUFA/Drivers/USB/Class/MIDI.h +++ b/LUFA/Drivers/USB/Class/MIDI.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Master include file for the library USB MIDI Class driver. + * + * This file should be included in all user projects making use of this optional class driver, instead of + * including any headers in the USB/ClassDriver/Device, USB/ClassDriver/Host or USB/ClassDriver/Common subdirectories. + */ + /** \ingroup Group_USBClassDrivers * @defgroup Group_USBClassMIDI MIDI Class Driver - LUFA/Drivers/Class/MIDI.h * diff --git a/LUFA/Drivers/USB/Class/MassStorage.h b/LUFA/Drivers/USB/Class/MassStorage.h index ccc48f35b..8f185d811 100644 --- a/LUFA/Drivers/USB/Class/MassStorage.h +++ b/LUFA/Drivers/USB/Class/MassStorage.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Master include file for the library USB Mass Storage Class driver. + * + * This file should be included in all user projects making use of this optional class driver, instead of + * including any headers in the USB/ClassDriver/Device, USB/ClassDriver/Host or USB/ClassDriver/Common subdirectories. + */ + /** \ingroup Group_USBClassDrivers * @defgroup Group_USBClassMS Mass Storage Class Driver - LUFA/Drivers/Class/MassStorage.h * diff --git a/LUFA/Drivers/USB/Class/Printer.h b/LUFA/Drivers/USB/Class/Printer.h index 0de231d17..785bac625 100644 --- a/LUFA/Drivers/USB/Class/Printer.h +++ b/LUFA/Drivers/USB/Class/Printer.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Master include file for the library USB Printer Class driver. + * + * This file should be included in all user projects making use of this optional class driver, instead of + * including any headers in the USB/ClassDriver/Device, USB/ClassDriver/Host or USB/ClassDriver/Common subdirectories. + */ + /** \ingroup Group_USBClassDrivers * @defgroup Group_USBClassPrinter Printer Class Driver - LUFA/Drivers/Class/Printer.h * diff --git a/LUFA/Drivers/USB/Class/RNDIS.h b/LUFA/Drivers/USB/Class/RNDIS.h index 8fd6d16c8..cc2b3c09b 100644 --- a/LUFA/Drivers/USB/Class/RNDIS.h +++ b/LUFA/Drivers/USB/Class/RNDIS.h @@ -28,8 +28,15 @@ this software. */ +/** \file + * \brief Master include file for the library USB RNDIS Class driver. + * + * This file should be included in all user projects making use of this optional class driver, instead of + * including any headers in the USB/ClassDriver/Device, USB/ClassDriver/Host or USB/ClassDriver/Common subdirectories. + */ + /** \ingroup Group_USBClassDrivers - * @defgroup Group_USBClassRNDIS RNDIS Class Driver - LUFA/Drivers/Class/RNDIS.h + * @defgroup Group_USBClassRNDIS RNDIS (Networking) Class Driver - LUFA/Drivers/Class/RNDIS.h * * \section Sec_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: diff --git a/LUFA/Drivers/USB/Class/StillImage.h b/LUFA/Drivers/USB/Class/StillImage.h index 1ba5ff77e..9852e75a9 100644 --- a/LUFA/Drivers/USB/Class/StillImage.h +++ b/LUFA/Drivers/USB/Class/StillImage.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Master include file for the library USB Still Image Class driver. + * + * This file should be included in all user projects making use of this optional class driver, instead of + * including any headers in the USB/ClassDriver/Device, USB/ClassDriver/Host or USB/ClassDriver/Common subdirectories. + */ + /** \ingroup Group_USBClassDrivers * @defgroup Group_USBClassSI Still Image Class Driver - LUFA/Drivers/Class/StillImage.h * diff --git a/LUFA/Drivers/USB/HighLevel/ConfigDescriptor.h b/LUFA/Drivers/USB/HighLevel/ConfigDescriptor.h index 5e9bc7b5f..232a9d111 100644 --- a/LUFA/Drivers/USB/HighLevel/ConfigDescriptor.h +++ b/LUFA/Drivers/USB/HighLevel/ConfigDescriptor.h @@ -29,10 +29,14 @@ */ /** \file + * \brief Configuration descriptor parser API. * - * 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. + * 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. + * + * \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_Descriptors diff --git a/LUFA/Drivers/USB/HighLevel/Events.h b/LUFA/Drivers/USB/HighLevel/Events.h index ff20752c4..72c2b7fd2 100644 --- a/LUFA/Drivers/USB/HighLevel/Events.h +++ b/LUFA/Drivers/USB/HighLevel/Events.h @@ -28,6 +28,25 @@ this software. */ +/** \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). + * + * \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_Events USB Events * diff --git a/LUFA/Drivers/USB/HighLevel/StdDescriptors.h b/LUFA/Drivers/USB/HighLevel/StdDescriptors.h index 4090aaa3d..27fcfe8fa 100644 --- a/LUFA/Drivers/USB/HighLevel/StdDescriptors.h +++ b/LUFA/Drivers/USB/HighLevel/StdDescriptors.h @@ -28,6 +28,15 @@ this software. */ +/** \file + * \brief USB standard descriptor definitions. + * + * This file contains structures and macros for the easy creation of standard USB descriptors in USB device projects. + * + * \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 * diff --git a/LUFA/Drivers/USB/HighLevel/StdRequestType.h b/LUFA/Drivers/USB/HighLevel/StdRequestType.h index 0db765d28..c82387959 100644 --- a/LUFA/Drivers/USB/HighLevel/StdRequestType.h +++ b/LUFA/Drivers/USB/HighLevel/StdRequestType.h @@ -28,11 +28,20 @@ this software. */ +/** \file + * \brief USB control endpoint request definitions. + * + * This file contains structures and macros for the easy creation and parsing of standard USB control requests. + * + * \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_StdRequest Standard USB Requests * * 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. + * details (such as data direction, request recipient, etc.) can be extracted via masking. * * @{ */ diff --git a/LUFA/Drivers/USB/HighLevel/StreamCallbacks.h b/LUFA/Drivers/USB/HighLevel/StreamCallbacks.h index 777b588fb..228669e33 100644 --- a/LUFA/Drivers/USB/HighLevel/StreamCallbacks.h +++ b/LUFA/Drivers/USB/HighLevel/StreamCallbacks.h @@ -27,6 +27,16 @@ arising out of or in connection with the use or performance of this software. */ + +/** \file + * \brief USB endpoint/pipe stream callback management. + * + * This file contains definitions for the creation of optional callback routines which can be passed to the + * endpoint and/or pipe stream APIs, to abort the transfer currently in progress when a condition is met. + * + * \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_StreamCallbacks Endpoint and Pipe Stream Callbacks diff --git a/LUFA/Drivers/USB/HighLevel/USBInterrupt.h b/LUFA/Drivers/USB/HighLevel/USBInterrupt.h index f13d94559..c3f778fca 100644 --- a/LUFA/Drivers/USB/HighLevel/USBInterrupt.h +++ b/LUFA/Drivers/USB/HighLevel/USBInterrupt.h @@ -28,6 +28,16 @@ this software. */ +/** \file + * \brief USB controller interrupt service routine management. + * + * This file contains definitions required for the correct handling of low level USB service routine interrupts + * from the USB controller. + * + * \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. + */ + #ifndef __USBINTERRUPT_H__ #define __USBINTERRUPT_H__ diff --git a/LUFA/Drivers/USB/HighLevel/USBMode.h b/LUFA/Drivers/USB/HighLevel/USBMode.h index 4105bc976..d894bbad7 100644 --- a/LUFA/Drivers/USB/HighLevel/USBMode.h +++ b/LUFA/Drivers/USB/HighLevel/USBMode.h @@ -28,6 +28,17 @@ this software. */ +/** \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. + * + * \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_USBMode USB Mode Tokens * diff --git a/LUFA/Drivers/USB/HighLevel/USBTask.h b/LUFA/Drivers/USB/HighLevel/USBTask.h index 6724b87b8..0b5474241 100644 --- a/LUFA/Drivers/USB/HighLevel/USBTask.h +++ b/LUFA/Drivers/USB/HighLevel/USBTask.h @@ -27,7 +27,17 @@ arising out of or in connection with the use or performance of this software. */ - + +/** \file + * \brief Main USB service task management. + * + * This file contains the function definitions required for the main USB service task, which must be called + * from the user application to ensure that the USB connection to or from a connected USB device is maintained. + * + * \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. + */ + #ifndef __USBTASK_H__ #define __USBTASK_H__ diff --git a/LUFA/Drivers/USB/LowLevel/DevChapter9.h b/LUFA/Drivers/USB/LowLevel/DevChapter9.h index c7abbd2f4..44913dbb5 100644 --- a/LUFA/Drivers/USB/LowLevel/DevChapter9.h +++ b/LUFA/Drivers/USB/LowLevel/DevChapter9.h @@ -28,6 +28,16 @@ this software. */ +/** \file + * \brief USB device standard request management. + * + * This file contains the function prototypes neccesary for the processing of incomming standard control requests + * when the library is in USB device mode. + * + * \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. + */ + #ifndef __DEVCHAPTER9_H__ #define __DEVCHAPTER9_H__ diff --git a/LUFA/Drivers/USB/LowLevel/Device.h b/LUFA/Drivers/USB/LowLevel/Device.h index 6c8a4b213..ceb454934 100644 --- a/LUFA/Drivers/USB/LowLevel/Device.h +++ b/LUFA/Drivers/USB/LowLevel/Device.h @@ -27,7 +27,16 @@ arising out of or in connection with the use or performance of this software. */ - + +/** \file + * \brief USB device mode definitions. + * + * This file contains structures, function prototypes and macros related to USB device mode. + * + * \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_Device Device Management * diff --git a/LUFA/Drivers/USB/LowLevel/Endpoint.h b/LUFA/Drivers/USB/LowLevel/Endpoint.h index ae4086779..389d3c458 100644 --- a/LUFA/Drivers/USB/LowLevel/Endpoint.h +++ b/LUFA/Drivers/USB/LowLevel/Endpoint.h @@ -28,6 +28,16 @@ this software. */ +/** \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. + * + * \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_EndpointManagement Endpoint Management * diff --git a/LUFA/Drivers/USB/LowLevel/Host.h b/LUFA/Drivers/USB/LowLevel/Host.h index ea404f2b1..a8a5b0131 100644 --- a/LUFA/Drivers/USB/LowLevel/Host.h +++ b/LUFA/Drivers/USB/LowLevel/Host.h @@ -28,6 +28,15 @@ this software. */ +/** \file + * \brief USB host mode definitions. + * + * This file contains structures, function prototypes and macros related to USB host mode. + * + * \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_Host Host Management * diff --git a/LUFA/Drivers/USB/LowLevel/HostChapter9.h b/LUFA/Drivers/USB/LowLevel/HostChapter9.h index e2132d934..e38c67e6c 100644 --- a/LUFA/Drivers/USB/LowLevel/HostChapter9.h +++ b/LUFA/Drivers/USB/LowLevel/HostChapter9.h @@ -28,6 +28,16 @@ this software. */ +/** \file + * \brief USB host standard request management. + * + * This file contains the function prototypes neccesary for the issuing of outgoing standard control requests + * when the library is in USB host mode. + * + * \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. + */ + #ifndef __HOSTCHAPTER9_H__ #define __HOSTCHAPTER9_H__ diff --git a/LUFA/Drivers/USB/LowLevel/LowLevel.h b/LUFA/Drivers/USB/LowLevel/LowLevel.h index e99bd1f0a..04b2c460c 100644 --- a/LUFA/Drivers/USB/LowLevel/LowLevel.h +++ b/LUFA/Drivers/USB/LowLevel/LowLevel.h @@ -28,6 +28,16 @@ this software. */ +/** \file + * \brief USB low level USB controller definitions. + * + * This file contains structures, function prototypes and macros related to the low level configutation of the + * USB controller, to start, stop and reset the USB library core. + * + * \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_USBManagement USB Interface Management * diff --git a/LUFA/Drivers/USB/LowLevel/OTG.h b/LUFA/Drivers/USB/LowLevel/OTG.h index 26b2cd5c5..ef3ab38d1 100644 --- a/LUFA/Drivers/USB/LowLevel/OTG.h +++ b/LUFA/Drivers/USB/LowLevel/OTG.h @@ -28,6 +28,16 @@ this software. */ +/** \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. + * + * \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_OTG USB On The Go (OTG) Management * diff --git a/LUFA/Drivers/USB/LowLevel/Pipe.h b/LUFA/Drivers/USB/LowLevel/Pipe.h index c22c5aeb0..127cea3ab 100644 --- a/LUFA/Drivers/USB/LowLevel/Pipe.h +++ b/LUFA/Drivers/USB/LowLevel/Pipe.h @@ -28,6 +28,16 @@ this software. */ +/** \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. + * + * \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_PipeManagement Pipe Management * diff --git a/LUFA/Drivers/USB/USB.h b/LUFA/Drivers/USB/USB.h index 3bc356d8e..034fdf827 100644 --- a/LUFA/Drivers/USB/USB.h +++ b/LUFA/Drivers/USB/USB.h @@ -29,10 +29,10 @@ */ /** \file + * \brief Master include file for the library USB functionality. * - * Master include file for the library USB functionality. This file should be included in all user projects making - * use of the USB portions of the library, instead of including any headers in the USB/LowLevel or USB/HighLevel - * directories. + * This file should be included in all user projects making use of the USB portions of the library, instead of + * including any headers in the USB/LowLevel/ or USB/HighLevel/ subdirectories. */ /** @defgroup Group_USB USB - LUFA/Drivers/USB/USB.h -- cgit v1.2.3