diff options
Diffstat (limited to 'LUFA/Drivers/USB/Class')
32 files changed, 265 insertions, 62 deletions
diff --git a/LUFA/Drivers/USB/Class/Audio.h b/LUFA/Drivers/USB/Class/Audio.h index 3c7e66535..ba6d87944 100644 --- a/LUFA/Drivers/USB/Class/Audio.h +++ b/LUFA/Drivers/USB/Class/Audio.h @@ -31,6 +31,8 @@ /** \file
* \brief Master include file for the library USB Audio Class driver.
*
+ * Master include file for the library USB Audio Class driver, for both host and device modes, where available.
+ *
* 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.
*/
diff --git a/LUFA/Drivers/USB/Class/CDC.h b/LUFA/Drivers/USB/Class/CDC.h index 22e534368..c5205aa1b 100644 --- a/LUFA/Drivers/USB/Class/CDC.h +++ b/LUFA/Drivers/USB/Class/CDC.h @@ -31,6 +31,8 @@ /** \file
* \brief Master include file for the library USB CDC-ACM Class driver.
*
+ * Master include file for the library USB CDC Class driver, for both host and device modes, where available.
+ *
* 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.
*/
diff --git a/LUFA/Drivers/USB/Class/Common/Audio.h b/LUFA/Drivers/USB/Class/Common/Audio.h index a6a1b4070..512758866 100644 --- a/LUFA/Drivers/USB/Class/Common/Audio.h +++ b/LUFA/Drivers/USB/Class/Common/Audio.h @@ -31,6 +31,8 @@ /** \file
* \brief Common definitions and declarations for the library USB Audio Class driver.
*
+ * 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.
*/
@@ -234,7 +236,9 @@ #define EP_ACCEPTS_SMALL_PACKETS (0 << 7)
/* Type Defines: */
- /** Type define for an Audio class specific interface descriptor. This follows a regular interface descriptor to
+ /** \brief Audio Class Specific Interface Descriptor.
+ *
+ * Type define for an Audio class specific interface descriptor. This follows a regular interface descriptor to
* supply extra information about the audio device's layout to the host. See the USB Audio specification for more
* details.
*/
@@ -250,7 +254,9 @@ uint8_t InterfaceNumbers[1]; /**< Interface numbers of each audio interface */
} USB_Audio_Interface_AC_t;
- /** Type define for an Audio class specific Feature Unit descriptor. This indicates to the host what features
+ /** \brief Audio Class Specific Feature Unit Descriptor.
+ *
+ * Type define for an Audio class specific Feature Unit descriptor. This indicates to the host what features
* are present in the device's audio stream for basic control, such as per-channel volume. See the USB Audio
* specification for more details.
*/
@@ -268,7 +274,9 @@ uint8_t FeatureUnitStrIndex; /**< Index of a string descriptor describing this descriptor within the device */
} USB_Audio_FeatureUnit_t;
- /** Type define for an Audio class specific input terminal descriptor. This indicates to the host that the device
+ /** \brief Audio Class Specific Input Terminal Descriptor.
+ *
+ * Type define for an Audio class specific input terminal descriptor. This indicates to the host that the device
* contains an input audio source, either from a physical terminal on the device, or a logical terminal (for example,
* a USB endpoint). See the USB Audio specification for more details.
*/
@@ -289,7 +297,9 @@ uint8_t TerminalStrIndex; /**< Index of a string descriptor describing this descriptor within the device */
} USB_Audio_InputTerminal_t;
- /** Type define for an Audio class specific output terminal descriptor. This indicates to the host that the device
+ /** \brief Audio Class Specific Output Terminal Descriptor.
+ *
+ * Type define for an Audio class specific output terminal descriptor. This indicates to the host that the device
* contains an output audio sink, either to a physical terminal on the device, or a logical terminal (for example,
* a USB endpoint). See the USB Audio specification for more details.
*/
@@ -308,7 +318,9 @@ uint8_t TerminalStrIndex; /**< Index of a string descriptor describing this descriptor within the device */
} USB_Audio_OutputTerminal_t;
- /** Type define for an Audio class specific streaming interface descriptor. This indicates to the host
+ /** \brief Audio Class Specific Streaming Audio Interface Descriptor.
+ *
+ * Type define for an Audio class specific streaming interface descriptor. This indicates to the host
* how audio streams within the device are formatted. See the USB Audio specification for more details.
*/
typedef struct
@@ -322,7 +334,9 @@ uint16_t AudioFormat; /**< Format of the audio stream, see Audio Device Formats specification */
} USB_Audio_Interface_AS_t;
- /** Type define for a 24bit audio sample frequency structure. GCC does not contain a built in 24bit datatype,
+ /** \brief 24-Bit Audio Frequency Structure.
+ *
+ * Type define for a 24bit audio sample frequency structure. GCC does not contain a built in 24bit datatype,
* this this structure is used to build up the value instead. Fill this structure with the SAMPLE_FREQ() macro.
*/
typedef struct
@@ -331,7 +345,9 @@ uint8_t HighByte; /**< Upper 8 bits of the 24-bit value */
} USB_Audio_SampleFreq_t;
- /** Type define for an Audio class specific audio format descriptor. This is used to give the host full details
+ /** \brief Audio Class Specific Format Descriptor.
+ *
+ * Type define for an Audio class specific audio format descriptor. This is used to give the host full details
* about the number of channels, the sample resolution, acceptable sample frequencies and encoding method used
* in the device's audio streams. See the USB Audio specification for more details.
*/
@@ -350,7 +366,9 @@ USB_Audio_SampleFreq_t SampleFrequencies[AUDIO_TOTAL_SAMPLE_RATES]; /**< Sample frequencies supported by the device */
} USB_Audio_Format_t;
- /** Type define for an Audio class specific endpoint descriptor. This contains a regular endpoint
+ /** \brief Audio Class Specific Streaming Endpoint Descriptor.
+ *
+ * Type define for an Audio class specific endpoint descriptor. This contains a regular endpoint
* descriptor with a few Audio-class specific extensions. See the USB Audio specification for more details.
*/
typedef struct
@@ -361,7 +379,9 @@ uint8_t SyncEndpointNumber; /**< Endpoint address to send synchronization information to, if needed (zero otherwise) */
} USB_Audio_StreamEndpoint_Std_t;
- /** Type define for an Audio class specific extended endpoint descriptor. This contains extra information
+ /** \brief Audio Class Specific Extended Endpoint Descriptor.
+ *
+ * Type define for an Audio class specific extended endpoint descriptor. This contains extra information
* on the usage of endpoints used to stream audio in and out of the USB Audio device, and follows an Audio
* class specific extended endpoint descriptor. See the USB Audio specification for more details.
*/
diff --git a/LUFA/Drivers/USB/Class/Common/CDC.h b/LUFA/Drivers/USB/Class/Common/CDC.h index bb1996b6c..cef7a4cd1 100644 --- a/LUFA/Drivers/USB/Class/Common/CDC.h +++ b/LUFA/Drivers/USB/Class/Common/CDC.h @@ -31,6 +31,8 @@ /** \file
* \brief Common definitions and declarations for the library USB CDC Class driver.
*
+ * 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.
*/
diff --git a/LUFA/Drivers/USB/Class/Common/HID.h b/LUFA/Drivers/USB/Class/Common/HID.h index cf457cb86..0c908c5b5 100644 --- a/LUFA/Drivers/USB/Class/Common/HID.h +++ b/LUFA/Drivers/USB/Class/Common/HID.h @@ -31,6 +31,8 @@ /** \file
* \brief Common definitions and declarations for the library USB HID Class driver.
*
+ * 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.
*/
@@ -143,7 +145,9 @@ REPORT_ITEM_TYPE_Feature = 2, /**< Indicates that the item is a FEATURE report type. */
};
- /** Type define for the HID class specific HID descriptor, to describe the HID device's specifications. Refer to the HID
+ /** \brief HID Class Specific HID Descriptor.
+ *
+ * Type define for the HID class specific HID descriptor, to describe the HID device's specifications. Refer to the HID
* specification for details on the structure elements.
*/
typedef struct
@@ -159,7 +163,10 @@ uint16_t HIDReportLength;
} USB_HID_Descriptor_t;
- /** Type define for a standard Boot Protocol Mouse report */
+ /** \brief Standard HID Boot Protocol Mouse Report.
+ *
+ * Type define for a standard Boot Protocol Mouse report
+ */
typedef struct
{
uint8_t Button; /**< Button mask for currently pressed buttons in the mouse */
@@ -167,7 +174,10 @@ int8_t Y; /**< Current delta Y movement on the mouse */
} USB_MouseReport_Data_t;
- /** Type define for a standard Boot Protocol Keyboard report */
+ /** \brief Standard HID Boot Protocol Keyboard Report.
+ *
+ * Type define for a standard Boot Protocol Keyboard report
+ */
typedef struct
{
uint8_t Modifier; /**< Keyboard modifier byte, indicating pressed modifier keys (a combination of
diff --git a/LUFA/Drivers/USB/Class/Common/MIDI.h b/LUFA/Drivers/USB/Class/Common/MIDI.h index 72a72de38..aa843827b 100644 --- a/LUFA/Drivers/USB/Class/Common/MIDI.h +++ b/LUFA/Drivers/USB/Class/Common/MIDI.h @@ -31,6 +31,8 @@ /** \file
* \brief Common definitions and declarations for the library USB MIDI Class driver.
*
+ * 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.
*/
@@ -97,7 +99,9 @@ #define MIDI_CHANNEL(channel) ((channel) - 1)
/* Type Defines: */
- /** Type define for an Audio class specific MIDI streaming interface descriptor. This indicates to the host
+ /** \brief MIDI Class Specific Streaming Interface Descriptor.
+ *
+ * Type define for an Audio class specific MIDI streaming interface descriptor. This indicates to the host
* how MIDI the specification compliance of the device and the total length of the Audio class specific descriptors.
* See the USB Audio specification for more details.
*/
@@ -110,7 +114,9 @@ uint16_t TotalLength; /**< Total length of the Audio class specific descriptors, including this descriptor */
} USB_MIDI_AudioInterface_AS_t;
- /** Type define for an Audio class specific MIDI IN jack. This gives information to the host on a MIDI input, either
+ /** \brief MIDI Class Specific Input Jack Descriptor.
+ *
+ * Type define for an Audio class specific MIDI IN jack. This gives information to the host on a MIDI input, either
* a physical input jack, or a logical jack (receiving input data internally, or from the host via an endpoint).
*/
typedef struct
@@ -124,7 +130,9 @@ uint8_t JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device */
} USB_MIDI_In_Jack_t;
- /** Type define for an Audio class specific MIDI OUT jack. This gives information to the host on a MIDI output, either
+ /** \brief MIDI Class Specific Output Jack Descriptor.
+ *
+ * Type define for an Audio class specific MIDI OUT jack. This gives information to the host on a MIDI output, either
* a physical output jack, or a logical jack (sending output data internally, or to the host via an endpoint).
*/
typedef struct
@@ -142,7 +150,9 @@ uint8_t JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device */
} USB_MIDI_Out_Jack_t;
- /** Type define for an Audio class specific extended MIDI jack endpoint descriptor. This contains extra information
+ /** \brief Audio Class Specific Jack Endpoint Descriptor.
+ *
+ * Type define for an Audio class specific extended MIDI jack endpoint descriptor. This contains extra information
* on the usage of MIDI endpoints used to stream MIDI events in and out of the USB Audio device, and follows an Audio
* class specific extended MIDI endpoint descriptor. See the USB Audio specification for more details.
*/
@@ -155,7 +165,10 @@ uint8_t AssociatedJackID[1]; /**< IDs of each jack inside the endpoint */
} USB_MIDI_Jack_Endpoint_t;
- /** Type define for a USB MIDI event packet, used to encapsulate sent and received MIDI messages from a USB MIDI interface. */
+ /** \brief MIDI Class Driver Event Packet.
+ *
+ * Type define for a USB MIDI event packet, used to encapsulate sent and received MIDI messages from a USB MIDI interface.
+ */
typedef struct
{
unsigned char Command : 4; /**< Upper nibble of the MIDI command being sent or received in the event packet */
diff --git a/LUFA/Drivers/USB/Class/Common/MassStorage.h b/LUFA/Drivers/USB/Class/Common/MassStorage.h index 7f321350f..b5e590ea3 100644 --- a/LUFA/Drivers/USB/Class/Common/MassStorage.h +++ b/LUFA/Drivers/USB/Class/Common/MassStorage.h @@ -31,6 +31,8 @@ /** \file
* \brief Common definitions and declarations for the library USB Mass Storage Class driver.
*
+ * 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.
*/
@@ -204,7 +206,9 @@ #define SCSI_ASENSEQ_OPERATION_IN_PROGRESS 0x07
/* Type defines: */
- /** Type define for a Command Block Wrapper, used in the Mass Storage Bulk-Only Transport protocol. */
+ /** \brief Mass Storage Class Command Block Wrapper.
+ *
+ * Type define for a Command Block Wrapper, used in the Mass Storage Bulk-Only Transport protocol. */
typedef struct
{
uint32_t Signature; /**< Command block signature, must be CBW_SIGNATURE to indicate a valid Command Block */
@@ -216,7 +220,10 @@ uint8_t SCSICommandData[16]; /**< Issued SCSI command in the Command Block */
} MS_CommandBlockWrapper_t;
- /** Type define for a Command Status Wrapper, used in the Mass Storage Bulk-Only Transport protocol. */
+ /** \brief Mass Storage Class Command Status Wrapper.
+ *
+ * Type define for a Command Status Wrapper, used in the Mass Storage Bulk-Only Transport protocol.
+ */
typedef struct
{
uint32_t Signature; /**< Status block signature, must be CSW_SIGNATURE to indicate a valid Command Status */
@@ -225,7 +232,9 @@ uint8_t Status; /**< Status code of the issued command - a value from the MassStorage_CommandStatusCodes_t enum */
} MS_CommandStatusWrapper_t;
- /** Type define for a SCSI Sense structure. Structures of this type are filled out by the
+ /** \brief Mass Storage Class SCSI Sense Structure
+ *
+ * Type define for a SCSI Sense structure. Structures of this type are filled out by the
* device via the MassStore_RequestSense() function, indicating the current sense data of the
* device (giving explicit error codes for the last issued command). For details of the
* structure contents, refer to the SCSI specifications.
@@ -251,7 +260,9 @@ uint8_t SenseKeySpecific[3];
} SCSI_Request_Sense_Response_t;
- /** Type define for a SCSI Inquiry structure. Structures of this type are filled out by the
+ /** \brief Mass Storage Class SCSI Inquiry Structure.
+ *
+ * Type define for a SCSI Inquiry structure. Structures of this type are filled out by the
* device via the MassStore_Inquiry() function, retrieving the attached device's information.
* For details of the structure contents, refer to the SCSI specifications.
*/
diff --git a/LUFA/Drivers/USB/Class/Common/Printer.h b/LUFA/Drivers/USB/Class/Common/Printer.h index f78cbaafa..b0c1416cb 100644 --- a/LUFA/Drivers/USB/Class/Common/Printer.h +++ b/LUFA/Drivers/USB/Class/Common/Printer.h @@ -31,6 +31,8 @@ /** \file
* \brief Common definitions and declarations for the library USB Printer Class driver.
*
+ * 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.
*/
diff --git a/LUFA/Drivers/USB/Class/Common/RNDIS.h b/LUFA/Drivers/USB/Class/Common/RNDIS.h index b69142c98..74e22bd56 100644 --- a/LUFA/Drivers/USB/Class/Common/RNDIS.h +++ b/LUFA/Drivers/USB/Class/Common/RNDIS.h @@ -31,6 +31,8 @@ /** \file
* \brief Common definitions and declarations for the library USB RNDIS Class driver.
*
+ * 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.
*/
@@ -110,13 +112,19 @@ };
/* Type Defines: */
- /** Type define for a physical MAC address of a device on a network */
+ /** \brief MAC Address Structure.
+ *
+ * Type define for a physical MAC address of a device on a network
+ */
typedef struct
{
uint8_t Octets[6]; /**< Individual bytes of a MAC address */
} MAC_Address_t;
- /** Type define for an Ethernet frame buffer. */
+ /** \brief RNDIS Ethernet Frame Packet Information Structure.
+ *
+ * Type define for an Ethernet frame buffer data and information structure.
+ */
typedef struct
{
uint8_t FrameData[ETHERNET_FRAME_SIZE_MAX]; /**< Ethernet frame contents */
@@ -124,14 +132,20 @@ bool FrameInBuffer; /**< Indicates if a frame is currently stored in the buffer */
} Ethernet_Frame_Info_t;
- /** Type define for a RNDIS message header, sent before RNDIS messages */
+ /** \brief RNDIS Common Message Header Structure.
+ *
+ * Type define for a RNDIS message header, sent before RNDIS messages.
+ */
typedef struct
{
uint32_t MessageType; /**< RNDIS message type, a REMOTE_NDIS_*_MSG constant */
uint32_t MessageLength; /**< Total length of the RNDIS message, in bytes */
} RNDIS_Message_Header_t;
- /** Type define for a RNDIS packet message, used to encapsulate Ethernet packets sent to and from the adapter */
+ /** \brief RNDIS Message Structure.
+ *
+ * Type define for a RNDIS packet message, used to encapsulate Ethernet packets sent to and from the adapter.
+ */
typedef struct
{
uint32_t MessageType;
@@ -147,7 +161,10 @@ uint32_t Reserved;
} RNDIS_Packet_Message_t;
- /** Type define for a RNDIS Initialize command message */
+ /** \brief RNDIS Initialization Message Structure.
+ *
+ * Type define for a RNDIS Initialize command message.
+ */
typedef struct
{
uint32_t MessageType;
@@ -159,7 +176,10 @@ uint32_t MaxTransferSize;
} RNDIS_Initialize_Message_t;
- /** Type define for a RNDIS Initialize complete response message */
+ /** \brief RNDIS Initialize Complete Message Structure.
+ *
+ * Type define for a RNDIS Initialize Complete response message.
+ */
typedef struct
{
uint32_t MessageType;
@@ -178,7 +198,10 @@ uint32_t AFListSize;
} RNDIS_Initialize_Complete_t;
- /** Type define for a RNDIS Keepalive command message */
+ /** \brief RNDIS Keep Alive Message Structure.
+ *
+ * Type define for a RNDIS Keep Alive command message.
+ */
typedef struct
{
uint32_t MessageType;
@@ -186,7 +209,10 @@ uint32_t RequestId;
} RNDIS_KeepAlive_Message_t;
- /** Type define for a RNDIS Keepalive complete message */
+ /** \brief RNDIS Keep Alive Complete Message Structure.
+ *
+ * Type define for a RNDIS Keep Alive Complete response message.
+ */
typedef struct
{
uint32_t MessageType;
@@ -195,7 +221,10 @@ uint32_t Status;
} RNDIS_KeepAlive_Complete_t;
- /** Type define for a RNDIS Reset complete message */
+ /** \brief RNDIS Reset Complete Message Structure.
+ *
+ * Type define for a RNDIS Reset Complete response message.
+ */
typedef struct
{
uint32_t MessageType;
@@ -205,7 +234,10 @@ uint32_t AddressingReset;
} RNDIS_Reset_Complete_t;
- /** Type define for a RNDIS Set command message */
+ /** \brief RNDIS OID Property Set Message Structure.
+ *
+ * Type define for a RNDIS OID Property Set command message.
+ */
typedef struct
{
uint32_t MessageType;
@@ -218,7 +250,10 @@ uint32_t DeviceVcHandle;
} RNDIS_Set_Message_t;
- /** Type define for a RNDIS Set complete response message */
+ /** \brief RNDIS OID Property Set Complete Message Structure.
+ *
+ * Type define for a RNDIS OID Property Set Complete response message.
+ */
typedef struct
{
uint32_t MessageType;
@@ -227,7 +262,10 @@ uint32_t Status;
} RNDIS_Set_Complete_t;
- /** Type define for a RNDIS Query command message */
+ /** \brief RNDIS OID Property Query Message Structure.
+ *
+ * Type define for a RNDIS OID Property Query command message.
+ */
typedef struct
{
uint32_t MessageType;
@@ -240,7 +278,10 @@ uint32_t DeviceVcHandle;
} RNDIS_Query_Message_t;
- /** Type define for a RNDIS Query complete response message */
+ /** \brief RNDIS OID Property Query Complete Message Structure.
+ *
+ * Type define for a RNDIS OID Property Query Complete response message.
+ */
typedef struct
{
uint32_t MessageType;
diff --git a/LUFA/Drivers/USB/Class/Common/RNDISConstants.h b/LUFA/Drivers/USB/Class/Common/RNDISConstants.h index b65040e1b..c940a034f 100644 --- a/LUFA/Drivers/USB/Class/Common/RNDISConstants.h +++ b/LUFA/Drivers/USB/Class/Common/RNDISConstants.h @@ -31,6 +31,8 @@ /** \file
* \brief Common RNDIS class constant definitions.
*
+ * 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.
*/
diff --git a/LUFA/Drivers/USB/Class/Common/StillImage.h b/LUFA/Drivers/USB/Class/Common/StillImage.h index 4b0faac35..1648431d6 100644 --- a/LUFA/Drivers/USB/Class/Common/StillImage.h +++ b/LUFA/Drivers/USB/Class/Common/StillImage.h @@ -31,6 +31,8 @@ /** \file
* \brief Common definitions and declarations for the library USB Still Image Class driver.
*
+ * 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.
*/
@@ -120,7 +122,9 @@ };
/* Type Defines: */
- /** Type define for a PIMA container, use to send commands and receive responses to and from an
+ /** \brief PIMA Still Image Device Command/Response Container.
+ *
+ * Type define for a PIMA container, use to send commands and receive responses to and from an
* attached Still Image device.
*/
typedef struct
diff --git a/LUFA/Drivers/USB/Class/Device/Audio.h b/LUFA/Drivers/USB/Class/Device/Audio.h index 9677339ca..053b69aab 100644 --- a/LUFA/Drivers/USB/Class/Device/Audio.h +++ b/LUFA/Drivers/USB/Class/Device/Audio.h @@ -31,6 +31,8 @@ /** \file
* \brief Device mode driver for the library USB Audio Class driver.
*
+ * 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.
*/
@@ -68,8 +70,10 @@ #endif
/* Public Interface - May be used in end-application: */
- /* Type Defines: */
- /** Class state structure. An instance of this structure should be made for each Audio interface
+ /* Type Defines: */
+ /** \brief Audio Class Device Mode Configuration and State Structure.
+ *
+ * Class state structure. An instance of this structure should be made for each Audio interface
* within the user application, and passed to each of the Audio class driver functions as the
* AudioInterfaceInfo parameter. This stores each Audio interface's configuration and state information.
*/
diff --git a/LUFA/Drivers/USB/Class/Device/CDC.h b/LUFA/Drivers/USB/Class/Device/CDC.h index adf1708ce..2c5c30afd 100644 --- a/LUFA/Drivers/USB/Class/Device/CDC.h +++ b/LUFA/Drivers/USB/Class/Device/CDC.h @@ -31,6 +31,8 @@ /** \file
* \brief Device mode driver for the library USB CDC Class driver.
*
+ * 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.
*/
@@ -87,7 +89,9 @@ /* Public Interface - May be used in end-application: */
/* Type Defines: */
- /** Class state structure. An instance of this structure should be made for each CDC interface
+ /** \brief CDC Class Device Mode Configuration and State Structure.
+ *
+ * Class state structure. An instance of this structure should be made for each CDC interface
* within the user application, and passed to each of the CDC class driver functions as the
* CDCInterfaceInfo parameter. This stores each CDC interface's configuration and state information.
*/
diff --git a/LUFA/Drivers/USB/Class/Device/HID.h b/LUFA/Drivers/USB/Class/Device/HID.h index 009018437..1ab71771f 100644 --- a/LUFA/Drivers/USB/Class/Device/HID.h +++ b/LUFA/Drivers/USB/Class/Device/HID.h @@ -31,6 +31,8 @@ /** \file
* \brief Device mode driver for the library USB HID Class driver.
*
+ * 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.
*/
@@ -69,7 +71,9 @@ /* Public Interface - May be used in end-application: */
/* Type Defines: */
- /** Class state structure. An instance of this structure should be made for each HID interface
+ /** \brief HID Class Device Mode Configuration and State Structure.
+ *
+ * Class state structure. An instance of this structure should be made for each HID interface
* within the user application, and passed to each of the HID class driver functions as the
* HIDInterfaceInfo parameter. This stores each HID interface's configuration and state information.
*
diff --git a/LUFA/Drivers/USB/Class/Device/MIDI.h b/LUFA/Drivers/USB/Class/Device/MIDI.h index 9eaabbc5e..11a05bfbb 100644 --- a/LUFA/Drivers/USB/Class/Device/MIDI.h +++ b/LUFA/Drivers/USB/Class/Device/MIDI.h @@ -31,6 +31,8 @@ /** \file
* \brief Device mode driver for the library USB MIDI Class driver.
*
+ * 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.
*/
@@ -69,7 +71,9 @@ /* Public Interface - May be used in end-application: */
/* Type Define: */
- /** Class state structure. An instance of this structure should be made for each MIDI interface
+ /** \brief MIDI Class Device Mode Configuration and State Structure.
+ *
+ * Class state structure. An instance of this structure should be made for each MIDI interface
* within the user application, and passed to each of the MIDI class driver functions as the
* MIDIInterfaceInfo parameter. This stores each MIDI interface's configuration and state information.
*/
diff --git a/LUFA/Drivers/USB/Class/Device/MassStorage.h b/LUFA/Drivers/USB/Class/Device/MassStorage.h index 67bbfab91..8eb150be9 100644 --- a/LUFA/Drivers/USB/Class/Device/MassStorage.h +++ b/LUFA/Drivers/USB/Class/Device/MassStorage.h @@ -31,6 +31,8 @@ /** \file
* \brief Device mode driver for the library USB Mass Storage Class driver.
*
+ * 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.
*/
@@ -69,7 +71,9 @@ /* Public Interface - May be used in end-application: */
/* Type Defines: */
- /** Class state structure. An instance of this structure should be made for each Mass Storage interface
+ /** \brief Mass Storage Class Device Mode Configuration and State Structure.
+ *
+ * Class state structure. An instance of this structure should be made for each Mass Storage interface
* within the user application, and passed to each of the Mass Storage class driver functions as the
* MSInterfaceInfo parameter. This stores each Mass Storage interface's configuration and state information.
*/
diff --git a/LUFA/Drivers/USB/Class/Device/RNDIS.h b/LUFA/Drivers/USB/Class/Device/RNDIS.h index 5d541f18b..5408ec70a 100644 --- a/LUFA/Drivers/USB/Class/Device/RNDIS.h +++ b/LUFA/Drivers/USB/Class/Device/RNDIS.h @@ -31,6 +31,8 @@ /** \file
* \brief Device mode driver for the library USB RNDIS Class driver.
*
+ * 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.
*/
@@ -69,7 +71,9 @@ /* Public Interface - May be used in end-application: */
/* Type Defines: */
- /** Class state structure. An instance of this structure should be made for each RNDIS interface
+ /** \brief RNDIS Class Device Mode Configuration and State Structure.
+ *
+ * Class state structure. An instance of this structure should be made for each RNDIS interface
* within the user application, and passed to each of the RNDIS class driver functions as the
* RNDISInterfaceInfo parameter. This stores each RNDIS interface's configuration and state information.
*/
diff --git a/LUFA/Drivers/USB/Class/HID.h b/LUFA/Drivers/USB/Class/HID.h index 3a7fe2121..728b01aa3 100644 --- a/LUFA/Drivers/USB/Class/HID.h +++ b/LUFA/Drivers/USB/Class/HID.h @@ -31,6 +31,8 @@ /** \file
* \brief Master include file for the library USB HID Class driver.
*
+ * Master include file for the library USB HID Class driver, for both host and device modes, where available.
+ *
* 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.
*/
diff --git a/LUFA/Drivers/USB/Class/Host/CDC.h b/LUFA/Drivers/USB/Class/Host/CDC.h index 205bb3d57..bb12c082b 100644 --- a/LUFA/Drivers/USB/Class/Host/CDC.h +++ b/LUFA/Drivers/USB/Class/Host/CDC.h @@ -29,10 +29,12 @@ */
/** \file
- * \brief Host mode driver for the library USB Audio Class driver.
+ * \brief Host mode driver for the library USB CDC Class driver.
+ *
+ * Host 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/Audio.h.
+ * dispatch header located in LUFA/Drivers/USB/Class/CDC.h.
*/
/** \ingroup Group_USBClassCDC
@@ -70,7 +72,9 @@ /* Public Interface - May be used in end-application: */
/* Type Defines: */
- /** Class state structure. An instance of this structure should be made within the user application,
+ /** \brief CDC Class Host Mode Configuration and State Structure.
+ *
+ * Class state structure. An instance of this structure should be made within the user application,
* and passed to each of the CDC class driver functions as the CDCInterfaceInfo parameter. This
* stores each CDC interface's configuration and state information.
*/
diff --git a/LUFA/Drivers/USB/Class/Host/HID.h b/LUFA/Drivers/USB/Class/Host/HID.h index fd0227e6c..29c390a1e 100644 --- a/LUFA/Drivers/USB/Class/Host/HID.h +++ b/LUFA/Drivers/USB/Class/Host/HID.h @@ -31,6 +31,8 @@ /** \file
* \brief Host mode driver for the library USB HID Class driver.
*
+ * 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.
*/
@@ -73,7 +75,9 @@ #define HID_ERROR_LOGICAL 0x80
/* Type Defines: */
- /** Class state structure. An instance of this structure should be made within the user application,
+ /** \brief HID Class Host Mode Configuration and State Structure.
+ *
+ * Class state structure. An instance of this structure should be made within the user application,
* and passed to each of the HID class driver functions as the HIDInterfaceInfo parameter. This
* stores each HID interface's configuration and state information.
*/
diff --git a/LUFA/Drivers/USB/Class/Host/HIDParser.h b/LUFA/Drivers/USB/Class/Host/HIDParser.h index 377a8217c..13f68a045 100644 --- a/LUFA/Drivers/USB/Class/Host/HIDParser.h +++ b/LUFA/Drivers/USB/Class/Host/HIDParser.h @@ -31,8 +31,8 @@ /** \file
* \brief USB Human Interface Device (HID) Class report descriptor parser.
*
- * 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
+ * This file allows for the easy parsing of complex HID report descriptors, which describes the data that
+ * a HID 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.
*/
@@ -157,28 +157,39 @@ };
/* Type Defines: */
- /** Type define for an attribute with both minimum and maximum values (e.g. Logical Min/Max). */
+ /** \brief HID Parser Report Item Min/Max Structure.
+ *
+ * Type define for an attribute with both minimum and maximum values (e.g. Logical Min/Max).
+ */
typedef struct
{
uint32_t Minimum; /**< Minimum value for the attribute. */
uint32_t Maximum; /**< Maximum value for the attribute. */
} HID_MinMax_t;
- /** Type define for the Unit attributes of a report item. */
+ /** \brief HID Parser Report Item Unit Structure.
+ *
+ * Type define for the Unit attributes of a report item.
+ */
typedef struct
{
uint32_t Type; /**< Unit type (refer to HID specifications for details). */
uint8_t Exponent; /**< Unit exponent (refer to HID specifications for details). */
} HID_Unit_t;
- /** Type define for the Usage attributes of a report item. */
+ /** \brief HID Parser Report Item Usage Structure.
+ *
+ * Type define for the Usage attributes of a report item.
+ */
typedef struct
{
uint16_t Page; /**< Usage page of the report item. */
uint16_t Usage; /**< Usage of the report item. */
} HID_Usage_t;
- /** Type define for a COLLECTION object. Contains the collection attributes and a reference to the
+ /** \brief HID Parser Report Item Collection Path Structure.
+ *
+ * Type define for a COLLECTION object. Contains the collection attributes and a reference to the
* parent collection if any.
*/
typedef struct CollectionPath
@@ -188,7 +199,10 @@ struct CollectionPath* Parent; /**< Reference to parent collection, or NULL if root collection. */
} HID_CollectionPath_t;
- /** Type define for all the data attributes of a report item, except flags. */
+ /** \brief HID Parser Report Item Attributes Structure.
+ *
+ * Type define for all the data attributes of a report item, except flags.
+ */
typedef struct
{
uint8_t BitSize; /**< Size in bits of the report item's data. */
@@ -199,7 +213,10 @@ HID_MinMax_t Physical; /**< Physical minimum and maximum of the report item. */
} HID_ReportItem_Attributes_t;
- /** Type define for a report item (IN, OUT or FEATURE) attributes and other details. */
+ /** \brief HID Parser Report Item Details Structure.
+ *
+ * Type define for a report item (IN, OUT or FEATURE) layout attributes and other details.
+ */
typedef struct
{
uint16_t BitOffset; /**< Bit offset in the IN, OUT or FEATURE report of the item. */
@@ -216,7 +233,10 @@ uint32_t PreviousValue; /**< Previous value of the report item. */
} HID_ReportItem_t;
- /** Type define for a report item size information structure */
+ /** \brief HID Parser Report Size Structure.
+ *
+ * Type define for a report item size information structure, to retain the size of a device's reports by ID.
+ */
typedef struct
{
uint8_t ReportID; /** Report ID of the report within the HID interface */
@@ -225,7 +245,10 @@ */
} HID_ReportSizeInfo_t;
- /** Type define for a complete processed HID report, including all report item data and collections. */
+ /** \brief HID Parser State Structure.
+ *
+ * Type define for a complete processed HID report, including all report item data and collections.
+ */
typedef struct
{
uint8_t TotalReportItems; /**< Total number of report items stored in the
diff --git a/LUFA/Drivers/USB/Class/Host/HIDReportData.h b/LUFA/Drivers/USB/Class/Host/HIDReportData.h index 197e62b03..4f328c964 100644 --- a/LUFA/Drivers/USB/Class/Host/HIDReportData.h +++ b/LUFA/Drivers/USB/Class/Host/HIDReportData.h @@ -31,7 +31,8 @@ /** \file
* \brief 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.
+ * HID report item constants for report item attributes. 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 e0ab9775b..0cd99bcca 100644 --- a/LUFA/Drivers/USB/Class/Host/MIDI.h +++ b/LUFA/Drivers/USB/Class/Host/MIDI.h @@ -31,6 +31,8 @@ /** \file
* \brief Host mode driver for the library USB MIDI Class driver.
*
+ * 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.
*/
@@ -67,7 +69,9 @@ /* Public Interface - May be used in end-application: */
/* Type Defines: */
- /** Class state structure. An instance of this structure should be made within the user application,
+ /** \brief MIDI Class Host Mode Configuration and State Structure.
+ *
+ * Class state structure. An instance of this structure should be made within the user application,
* and passed to each of the MIDI class driver functions as the MIDIInterfaceInfo parameter. This
* stores each MIDI interface's configuration and state information.
*/
diff --git a/LUFA/Drivers/USB/Class/Host/MassStorage.h b/LUFA/Drivers/USB/Class/Host/MassStorage.h index 8868c9515..3dbf64940 100644 --- a/LUFA/Drivers/USB/Class/Host/MassStorage.h +++ b/LUFA/Drivers/USB/Class/Host/MassStorage.h @@ -31,6 +31,8 @@ /** \file
* \brief Host mode driver for the library USB Mass Storage Class driver.
*
+ * 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.
*/
@@ -71,7 +73,9 @@ #define MS_ERROR_LOGICAL_CMD_FAILED 0x80
/* Type Defines: */
- /** Class state structure. An instance of this structure should be made within the user application,
+ /** \brief Mass Storage Class Host Mode Configuration and State Structure.
+ *
+ * Class state structure. An instance of this structure should be made within the user application,
* and passed to each of the Mass Storage class driver functions as the MSInterfaceInfo parameter. This
* stores each Mass Storage interface's configuration and state information.
*/
@@ -105,7 +109,9 @@ */
} USB_ClassInfo_MS_Host_t;
- /** SCSI capacity structure, to hold the total capacity of the device in both the number
+ /** \brief SCSI Device LUN Capacity Structure.
+ *
+ * SCSI capacity structure, to hold the total capacity of the device in both the number
* of blocks in the current LUN, and the size of each block. This structure is filled by
* the device when the MassStore_ReadCapacity() function is called.
*/
diff --git a/LUFA/Drivers/USB/Class/Host/Printer.h b/LUFA/Drivers/USB/Class/Host/Printer.h index dc45780c2..04286ca32 100644 --- a/LUFA/Drivers/USB/Class/Host/Printer.h +++ b/LUFA/Drivers/USB/Class/Host/Printer.h @@ -31,6 +31,8 @@ /** \file
* \brief Host mode driver for the library USB Printer Class driver.
*
+ * 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.
*/
@@ -67,7 +69,9 @@ /* Public Interface - May be used in end-application: */
/* Type Defines: */
- /** Class state structure. An instance of this structure should be made within the user application,
+ /** \brief Printer Class Host Mode Configuration and State Structure.
+ *
+ * Class state structure. An instance of this structure should be made within the user application,
* and passed to each of the Printer class driver functions as the PRNTInterfaceInfo parameter. This
* stores each Printer interface's configuration and state information.
*/
diff --git a/LUFA/Drivers/USB/Class/Host/RNDIS.h b/LUFA/Drivers/USB/Class/Host/RNDIS.h index 5641620b7..f64710d5b 100644 --- a/LUFA/Drivers/USB/Class/Host/RNDIS.h +++ b/LUFA/Drivers/USB/Class/Host/RNDIS.h @@ -31,6 +31,8 @@ /** \file
* \brief Host mode driver for the library USB RNDIS Class driver.
*
+ * 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.
*/
@@ -71,7 +73,9 @@ /* Public Interface - May be used in end-application: */
/* Type Defines: */
- /** Class state structure. An instance of this structure should be made within the user application,
+ /** \brief RNDIS Class Host Mode Configuration and State Structure.
+ *
+ * Class state structure. An instance of this structure should be made within the user application,
* and passed to each of the RNDIS class driver functions as the RNDISInterfaceInfo parameter. This
* stores each RNDIS interface's configuration and state information.
*/
diff --git a/LUFA/Drivers/USB/Class/Host/StillImage.h b/LUFA/Drivers/USB/Class/Host/StillImage.h index 8a3714498..4a5ccfabd 100644 --- a/LUFA/Drivers/USB/Class/Host/StillImage.h +++ b/LUFA/Drivers/USB/Class/Host/StillImage.h @@ -31,6 +31,8 @@ /** \file
* \brief Host mode driver for the library USB Still Image Class driver.
*
+ * 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.
*/
@@ -71,6 +73,12 @@ #define SI_ERROR_LOGICAL_CMD_FAILED 0x80
/* Type Defines: */
+ /** \brief Still Image Class Host Mode Configuration and State Structure.
+ *
+ * Class state structure. An instance of this structure should be made within the user application,
+ * and passed to each of the Still Image class driver functions as the SIInterfaceInfo parameter. This
+ * stores each Still Image interface's configuration and state information.
+ */
typedef struct
{
const struct
diff --git a/LUFA/Drivers/USB/Class/MIDI.h b/LUFA/Drivers/USB/Class/MIDI.h index b77ca543e..582f61c66 100644 --- a/LUFA/Drivers/USB/Class/MIDI.h +++ b/LUFA/Drivers/USB/Class/MIDI.h @@ -31,6 +31,8 @@ /** \file
* \brief Master include file for the library USB MIDI Class driver.
*
+ * Master include file for the library USB MIDI Class driver, for both host and device modes, where available.
+ *
* 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.
*/
diff --git a/LUFA/Drivers/USB/Class/MassStorage.h b/LUFA/Drivers/USB/Class/MassStorage.h index 8f185d811..50ce0e5f3 100644 --- a/LUFA/Drivers/USB/Class/MassStorage.h +++ b/LUFA/Drivers/USB/Class/MassStorage.h @@ -31,6 +31,8 @@ /** \file
* \brief Master include file for the library USB Mass Storage Class driver.
*
+ * Master include file for the library USB Mass Storage Class driver, for both host and device modes, where available.
+ *
* 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.
*/
diff --git a/LUFA/Drivers/USB/Class/Printer.h b/LUFA/Drivers/USB/Class/Printer.h index 785bac625..64206068f 100644 --- a/LUFA/Drivers/USB/Class/Printer.h +++ b/LUFA/Drivers/USB/Class/Printer.h @@ -31,6 +31,8 @@ /** \file
* \brief Master include file for the library USB Printer Class driver.
*
+ * Master include file for the library USB Printer Class driver, for both host and device modes, where available.
+ *
* 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.
*/
diff --git a/LUFA/Drivers/USB/Class/RNDIS.h b/LUFA/Drivers/USB/Class/RNDIS.h index cc2b3c09b..dfbe6b582 100644 --- a/LUFA/Drivers/USB/Class/RNDIS.h +++ b/LUFA/Drivers/USB/Class/RNDIS.h @@ -31,6 +31,8 @@ /** \file
* \brief Master include file for the library USB RNDIS Class driver.
*
+ * Master include file for the library USB RNDIS Class driver, for both host and device modes, where available.
+ *
* 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.
*/
diff --git a/LUFA/Drivers/USB/Class/StillImage.h b/LUFA/Drivers/USB/Class/StillImage.h index 9852e75a9..a7febf44c 100644 --- a/LUFA/Drivers/USB/Class/StillImage.h +++ b/LUFA/Drivers/USB/Class/StillImage.h @@ -31,6 +31,8 @@ /** \file
* \brief Master include file for the library USB Still Image Class driver.
*
+ * Master include file for the library USB Still Image Class driver, for both host and device modes, where available.
+ *
* 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.
*/
|