diff options
Diffstat (limited to 'LUFA/Drivers/USB/Class/Common')
| -rw-r--r-- | LUFA/Drivers/USB/Class/Common/Audio.h | 38 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/Class/Common/CDC.h | 2 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/Class/Common/HID.h | 16 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/Class/Common/MIDI.h | 23 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/Class/Common/MassStorage.h | 19 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/Class/Common/Printer.h | 2 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/Class/Common/RNDIS.h | 67 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/Class/Common/RNDISConstants.h | 2 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/Class/Common/StillImage.h | 6 |
9 files changed, 140 insertions, 35 deletions
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
|