michi/qmk_firmware
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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