ahoneybun/qmk_firmware
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add file-level brief documentation.

Browse source 
Remove accidentally duplicated model-specific peripheral driver files.
This commit is contained in:
Dean Camera 2010-03-29 07:49:58 +00:00
parent ec19436d54
commit 0557676013
111 changed files with 1039 additions and 453 deletions
Download patch file Download diff file Expand all files Collapse all files

7
LUFA/Drivers/USB/Class/Audio.h
View file

@ -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
*

9
LUFA/Drivers/USB/Class/CDC.h
View file

@ -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:

7
LUFA/Drivers/USB/Class/Common/Audio.h
View file

@ -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
*

7
LUFA/Drivers/USB/Class/Common/CDC.h
View file

@ -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
*

7
LUFA/Drivers/USB/Class/Common/HID.h
View file

@ -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
*

7
LUFA/Drivers/USB/Class/Common/MIDI.h
View file

@ -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
*

7
LUFA/Drivers/USB/Class/Common/MassStorage.h
View file

@ -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
*

7
LUFA/Drivers/USB/Class/Common/Printer.h
View file

@ -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
*

7
LUFA/Drivers/USB/Class/Common/RNDIS.h
View file

@ -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
*

7
LUFA/Drivers/USB/Class/Common/RNDISConstants.h
View file

@ -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

7
LUFA/Drivers/USB/Class/Common/StillImage.h
View file

@ -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
*

7
LUFA/Drivers/USB/Class/Device/Audio.h
View file

@ -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
*

7
LUFA/Drivers/USB/Class/Device/CDC.h
View file

@ -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
*

7
LUFA/Drivers/USB/Class/Device/HID.h
View file

@ -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
*

7
LUFA/Drivers/USB/Class/Device/MIDI.h
View file

@ -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
*

7
LUFA/Drivers/USB/Class/Device/MassStorage.h
View file

@ -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
*

7
LUFA/Drivers/USB/Class/Device/RNDIS.h
View file

@ -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
*

7
LUFA/Drivers/USB/Class/HID.h
View file

@ -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
*

7
LUFA/Drivers/USB/Class/Host/CDC.h
View file

@ -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
*

7
LUFA/Drivers/USB/Class/Host/HID.h
View file

@ -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
*

7
LUFA/Drivers/USB/Class/Host/HIDParser.h
View file

@ -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

4
LUFA/Drivers/USB/Class/Host/HIDReportData.h
View file

@ -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

7
LUFA/Drivers/USB/Class/Host/MIDI.h
View file

@ -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
*

7
LUFA/Drivers/USB/Class/Host/MassStorage.h
View file

@ -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
*

7
LUFA/Drivers/USB/Class/Host/Printer.h
View file

@ -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
*

7
LUFA/Drivers/USB/Class/Host/RNDIS.h
View file

@ -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
*

3
LUFA/Drivers/USB/Class/Host/StillImage.c
View file

@ -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();

7
LUFA/Drivers/USB/Class/Host/StillImage.h
View file

@ -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
*

7
LUFA/Drivers/USB/Class/MIDI.h
View file

@ -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
*

7
LUFA/Drivers/USB/Class/MassStorage.h
View file

@ -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
*

7
LUFA/Drivers/USB/Class/Printer.h
View file

@ -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
*

9
LUFA/Drivers/USB/Class/RNDIS.h
View file

@ -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:

7
LUFA/Drivers/USB/Class/StillImage.h
View file

@ -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
*