diff options
Diffstat (limited to 'LUFA/Drivers/USB/Class/Common')
| -rw-r--r-- | LUFA/Drivers/USB/Class/Common/Audio.h | 156 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/Class/Common/CDC.h | 52 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/Class/Common/HID.h | 40 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/Class/Common/MIDI.h | 80 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/Class/Common/MassStorage.h | 32 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/Class/Common/RNDIS.h | 24 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/Class/Common/StillImage.h | 52 |
7 files changed, 220 insertions, 216 deletions
diff --git a/LUFA/Drivers/USB/Class/Common/Audio.h b/LUFA/Drivers/USB/Class/Common/Audio.h index 7b9e9f5da..eb2e95b65 100644 --- a/LUFA/Drivers/USB/Class/Common/Audio.h +++ b/LUFA/Drivers/USB/Class/Common/Audio.h @@ -79,22 +79,22 @@ /** Descriptor header constant to indicate a Audio class endpoint descriptor. */ #define DTYPE_AudioEndpoint 0x25 - /** Audio class descriptor subtype value for a Audio class specific header descriptor. */ + /** Audio class descriptor subtype value for a Audio class-specific header descriptor. */ #define DSUBTYPE_Header 0x01 - /** Audio class descriptor subtype value for an Output Terminal Audio class specific descriptor. */ + /** Audio class descriptor subtype value for an Output Terminal Audio class-specific descriptor. */ #define DSUBTYPE_InputTerminal 0x02 - /** Audio class descriptor subtype value for an Input Terminal Audio class specific descriptor. */ + /** Audio class descriptor subtype value for an Input Terminal Audio class-specific descriptor. */ #define DSUBTYPE_OutputTerminal 0x03 - /** Audio class descriptor subtype value for a Feature Unit Audio class specific descriptor. */ + /** Audio class descriptor subtype value for a Feature Unit Audio class-specific descriptor. */ #define DSUBTYPE_FeatureUnit 0x06 - /** Audio class descriptor subtype value for a general Audio class specific descriptor. */ + /** Audio class descriptor subtype value for a general Audio class-specific descriptor. */ #define DSUBTYPE_General 0x01 - /** Audio class descriptor subtype value for an Audio class specific descriptor indicating the format of an audio stream. */ + /** Audio class descriptor subtype value for an Audio class-specific descriptor indicating the format of an audio stream. */ #define DSUBTYPE_Format 0x02 /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */ @@ -225,175 +225,175 @@ */ #define AUDIO_SAMPLE_FREQ(freq) {LowWord: ((uint32_t)freq & 0x00FFFF), HighByte: (((uint32_t)freq >> 16) & 0x0000FF)} - /** Mask for the attributes parameter of an Audio class specific Endpoint descriptor, indicating that the endpoint + /** Mask for the attributes parameter of an Audio class-specific Endpoint descriptor, indicating that the endpoint * accepts only filled endpoint packets of audio samples. */ #define EP_ACCEPTS_ONLY_FULL_PACKETS (1 << 7) - /** Mask for the attributes parameter of an Audio class specific Endpoint descriptor, indicating that the endpoint + /** Mask for the attributes parameter of an Audio class-specific Endpoint descriptor, indicating that the endpoint * will accept partially filled endpoint packets of audio samples. */ #define EP_ACCEPTS_SMALL_PACKETS (0 << 7) /* Type Defines: */ - /** \brief Audio Class Specific Interface Descriptor. + /** \brief Audio class-specific Interface Descriptor. * - * Type define for an Audio class specific interface descriptor. This follows a regular interface descriptor to + * 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. */ typedef struct { - USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length */ - uint8_t Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */ + USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */ + uint8_t Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */ - uint16_t ACSpecification; /**< Binary coded decimal value, indicating the supported Audio Class specification version */ - uint16_t TotalLength; /**< Total length of the Audio class specific descriptors, including this descriptor */ + uint16_t ACSpecification; /**< Binary coded decimal value, indicating the supported Audio Class specification version. */ + uint16_t TotalLength; /**< Total length of the Audio class-specific descriptors, including this descriptor. */ - uint8_t InCollection; /**< Total number of audio class interfaces within this device */ - uint8_t InterfaceNumbers[1]; /**< Interface numbers of each audio interface */ + uint8_t InCollection; /**< Total number of audio class interfaces within this device. */ + uint8_t InterfaceNumbers[1]; /**< Interface numbers of each audio interface. */ } USB_Audio_Interface_AC_t; - /** \brief Audio Class Specific Feature Unit Descriptor. + /** \brief Audio class-specific Feature Unit Descriptor. * - * Type define for an Audio class specific Feature Unit descriptor. This indicates to the host what features + * 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. */ typedef struct { - USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length */ - uint8_t Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */ + USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */ + uint8_t Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */ - uint8_t UnitID; /**< ID value of this feature unit - must be a unique value within the device */ - uint8_t SourceID; /**< Source ID value of the audio source input into this feature unit */ + uint8_t UnitID; /**< ID value of this feature unit - must be a unique value within the device. */ + uint8_t SourceID; /**< Source ID value of the audio source input into this feature unit. */ - uint8_t ControlSize; /**< Size of each element in the ChanelControlls array */ - uint8_t ChannelControls[3]; /**< Feature masks for the control channel, and each separate audio channel */ + uint8_t ControlSize; /**< Size of each element in the ChanelControlls array. */ + uint8_t ChannelControls[3]; /**< Feature masks for the control channel, and each separate audio channel. */ - uint8_t FeatureUnitStrIndex; /**< Index of a string descriptor describing this descriptor within the device */ + uint8_t FeatureUnitStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */ } USB_Audio_FeatureUnit_t; - /** \brief Audio Class Specific Input Terminal Descriptor. + /** \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 + * 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. */ typedef struct { - USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length */ - uint8_t Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */ + USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */ + uint8_t Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */ - uint8_t TerminalID; /**< ID value of this terminal unit - must be a unique value within the device */ - uint16_t TerminalType; /**< Type of terminal, a TERMINAL_* mask */ + uint8_t TerminalID; /**< ID value of this terminal unit - must be a unique value within the device. */ + uint16_t TerminalType; /**< Type of terminal, a TERMINAL_* mask. */ uint8_t AssociatedOutputTerminal; /**< ID of associated output terminal, for physically grouped terminals - * such as the speaker and microphone of a phone handset + * such as the speaker and microphone of a phone handset. */ uint8_t TotalChannels; /**< Total number of separate audio channels within this interface (right, left, etc.) */ - uint16_t ChannelConfig; /**< CHANNEL_* masks indicating what channel layout is supported by this terminal */ + uint16_t ChannelConfig; /**< CHANNEL_* masks indicating what channel layout is supported by this terminal. */ - uint8_t ChannelStrIndex; /**< Index of a string descriptor describing this channel within the device */ - uint8_t TerminalStrIndex; /**< Index of a string descriptor describing this descriptor within the device */ + uint8_t ChannelStrIndex; /**< Index of a string descriptor describing this channel within the device. */ + uint8_t TerminalStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */ } USB_Audio_InputTerminal_t; - /** \brief Audio Class Specific Output Terminal Descriptor. + /** \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 + * 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. */ typedef struct { - USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length */ - uint8_t Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */ + USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */ + uint8_t Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */ - uint8_t TerminalID; /**< ID value of this terminal unit - must be a unique value within the device */ - uint16_t TerminalType; /**< Type of terminal, a TERMINAL_* mask */ + uint8_t TerminalID; /**< ID value of this terminal unit - must be a unique value within the device. */ + uint16_t TerminalType; /**< Type of terminal, a TERMINAL_* mask. */ uint8_t AssociatedInputTerminal; /**< ID of associated input terminal, for physically grouped terminals - * such as the speaker and microphone of a phone handset + * such as the speaker and microphone of a phone handset. */ - uint8_t SourceID; /**< ID value of the unit this terminal's audio is sourced from */ + uint8_t SourceID; /**< ID value of the unit this terminal's audio is sourced from. */ - uint8_t TerminalStrIndex; /**< Index of a string descriptor describing this descriptor within the device */ + uint8_t TerminalStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */ } USB_Audio_OutputTerminal_t; - /** \brief Audio Class Specific Streaming Audio Interface Descriptor. + /** \brief Audio class-specific Streaming Audio Interface Descriptor. * - * Type define for an Audio class specific streaming interface descriptor. This indicates to the host + * 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 { - USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length */ - uint8_t Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */ + USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */ + uint8_t Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */ - uint8_t TerminalLink; /**< ID value of the output terminal this descriptor is describing */ + uint8_t TerminalLink; /**< ID value of the output terminal this descriptor is describing. */ - uint8_t FrameDelay; /**< Delay in frames resulting from the complete sample processing from input to output */ - uint16_t AudioFormat; /**< Format of the audio stream, see Audio Device Formats specification */ + uint8_t FrameDelay; /**< Delay in frames resulting from the complete sample processing from input to output. */ + uint16_t AudioFormat; /**< Format of the audio stream, see Audio Device Formats specification. */ } USB_Audio_Interface_AS_t; /** \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. + * this this structure is used to build up the value instead. Fill this structure with the \ref AUDIO_SAMPLE_FREQ() macro. */ typedef struct { - uint16_t LowWord; /**< Low 16 bits of the 24-bit value */ - uint8_t HighByte; /**< Upper 8 bits of the 24-bit value */ + uint16_t LowWord; /**< Low 16 bits of the 24-bit value. */ + uint8_t HighByte; /**< Upper 8 bits of the 24-bit value. */ } USB_Audio_SampleFreq_t; - /** \brief Audio Class Specific Format Descriptor. + /** \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 + * 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. */ typedef struct { - USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length */ - uint8_t Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */ + USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */ + uint8_t Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */ - uint8_t FormatType; /**< Format of the audio stream, see Audio Device Formats specification */ - uint8_t Channels; /**< Total number of discrete channels in the stream */ + uint8_t FormatType; /**< Format of the audio stream, see Audio Device Formats specification. */ + uint8_t Channels; /**< Total number of discrete channels in the stream. */ - uint8_t SubFrameSize; /**< Size in bytes of each channel's sample data in the stream */ - uint8_t BitResolution; /**< Bits of resolution of each channel's samples in the stream */ + uint8_t SubFrameSize; /**< Size in bytes of each channel's sample data in the stream. */ + uint8_t BitResolution; /**< Bits of resolution of each channel's samples in the stream. */ - uint8_t SampleFrequencyType; /**< Total number of sample frequencies supported by the device */ - USB_Audio_SampleFreq_t SampleFrequencies[AUDIO_TOTAL_SAMPLE_RATES]; /**< Sample frequencies supported by the device */ + uint8_t SampleFrequencyType; /**< Total number of sample frequencies supported by the device. */ + USB_Audio_SampleFreq_t SampleFrequencies[AUDIO_TOTAL_SAMPLE_RATES]; /**< Sample frequencies supported by the device. */ } USB_Audio_Format_t; - /** \brief Audio Class Specific Streaming Endpoint Descriptor. + /** \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. + * 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 { - USB_Descriptor_Endpoint_t Endpoint; /**< Standard endpoint descriptor describing the audio endpoint */ + USB_Descriptor_Endpoint_t Endpoint; /**< Standard endpoint descriptor describing the audio endpoint. */ - uint8_t Refresh; /**< Always set to zero */ - uint8_t SyncEndpointNumber; /**< Endpoint address to send synchronization information to, if needed (zero otherwise) */ + uint8_t Refresh; /**< Always set to zero for Audio class devices. */ + uint8_t SyncEndpointNumber; /**< Endpoint address to send synchronization information to, if needed (zero otherwise). */ } USB_Audio_StreamEndpoint_Std_t; - /** \brief Audio Class Specific Extended Endpoint Descriptor. + /** \brief Audio class-specific Extended Endpoint Descriptor. * - * Type define for an Audio class specific extended endpoint descriptor. This contains extra information + * 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. + * class-specific extended endpoint descriptor. See the USB Audio specification for more details. */ typedef struct { - USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length */ - uint8_t Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */ + USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */ + uint8_t Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */ - uint8_t Attributes; /**< Audio class specific endpoint attributes, such as ACCEPTS_SMALL_PACKETS */ + uint8_t Attributes; /**< Audio class-specific endpoint attributes, such as ACCEPTS_SMALL_PACKETS. */ - uint8_t LockDelayUnits; /**< Units used for the LockDelay field, see Audio class specification */ - uint16_t LockDelay; /**< Time required to internally lock endpoint's internal clock recovery circuitry */ + uint8_t LockDelayUnits; /**< Units used for the LockDelay field, see Audio class specification. */ + uint16_t LockDelay; /**< Time required to internally lock endpoint's internal clock recovery circuitry. */ } USB_Audio_StreamEndpoint_Spc_t; /* Disable C linkage for C++ Compilers: */ diff --git a/LUFA/Drivers/USB/Class/Common/CDC.h b/LUFA/Drivers/USB/Class/Common/CDC.h index b6ab82a81..c41907f08 100644 --- a/LUFA/Drivers/USB/Class/Common/CDC.h +++ b/LUFA/Drivers/USB/Class/Common/CDC.h @@ -66,22 +66,22 @@ #endif /* Macros: */ - /** CDC Class specific request to get the current virtual serial port configuration settings. */ + /** CDC class-specific request to get the current virtual serial port configuration settings. */ #define REQ_GetLineEncoding 0x21 - /** CDC Class specific request to set the current virtual serial port configuration settings. */ + /** CDC class-specific request to set the current virtual serial port configuration settings. */ #define REQ_SetLineEncoding 0x20 - /** CDC Class specific request to set the current virtual serial port handshake line states. */ + /** CDC class-specific request to set the current virtual serial port handshake line states. */ #define REQ_SetControlLineState 0x22 - /** CDC Class specific request to send a break to the receiver via the carrier channel. */ + /** CDC class-specific request to send a break to the receiver via the carrier channel. */ #define REQ_SendBreak 0x23 - /** CDC Class specific request to send an encapsulated command to the device. */ + /** CDC class-specific request to send an encapsulated command to the device. */ #define REQ_SendEncapsulatedCommand 0x00 - /** CDC Class specific request to retrieve an encapsulated command response from the device. */ + /** CDC class-specific request to retrieve an encapsulated command response from the device. */ #define REQ_GetEncapsulatedResponse 0x01 /** Notification type constant for a change in the virtual serial port handshake line states, for @@ -90,47 +90,47 @@ */ #define NOTIF_SerialState 0x20 - /** Mask for the DTR handshake line for use with the REQ_SetControlLineState class specific request + /** Mask for the DTR handshake line for use with the REQ_SetControlLineState class-specific request * from the host, to indicate that the DTR line state should be high. */ #define CDC_CONTROL_LINE_OUT_DTR (1 << 0) - /** Mask for the RTS handshake line for use with the REQ_SetControlLineState class specific request + /** Mask for the RTS handshake line for use with the REQ_SetControlLineState class-specific request * from the host, to indicate that theRTS line state should be high. */ #define CDC_CONTROL_LINE_OUT_RTS (1 << 1) - /** Mask for the DCD handshake line for use with the a NOTIF_SerialState class specific notification + /** Mask for the DCD handshake line for use with the a NOTIF_SerialState class-specific notification * from the device to the host, to indicate that the DCD line state is currently high. */ #define CDC_CONTROL_LINE_IN_DCD (1 << 0) - /** Mask for the DSR handshake line for use with the a NOTIF_SerialState class specific notification + /** Mask for the DSR handshake line for use with the a NOTIF_SerialState class-specific notification * from the device to the host, to indicate that the DSR line state is currently high. */ #define CDC_CONTROL_LINE_IN_DSR (1 << 1) - /** Mask for the BREAK handshake line for use with the a NOTIF_SerialState class specific notification + /** Mask for the BREAK handshake line for use with the a NOTIF_SerialState class-specific notification * from the device to the host, to indicate that the BREAK line state is currently high. */ #define CDC_CONTROL_LINE_IN_BREAK (1 << 2) - /** Mask for the RING handshake line for use with the a NOTIF_SerialState class specific notification + /** Mask for the RING handshake line for use with the a NOTIF_SerialState class-specific notification * from the device to the host, to indicate that the RING line state is currently high. */ #define CDC_CONTROL_LINE_IN_RING (1 << 3) - /** Mask for use with the a NOTIF_SerialState class specific notification from the device to the host, + /** Mask for use with the a NOTIF_SerialState class-specific notification from the device to the host, * to indicate that a framing error has occurred on the virtual serial port. */ #define CDC_CONTROL_LINE_IN_FRAMEERROR (1 << 4) - /** Mask for use with the a NOTIF_SerialState class specific notification from the device to the host, + /** Mask for use with the a NOTIF_SerialState class-specific notification from the device to the host, * to indicate that a parity error has occurred on the virtual serial port. */ #define CDC_CONTROL_LINE_IN_PARITYERROR (1 << 5) - /** Mask for use with the a NOTIF_SerialState class specific notification from the device to the host, + /** Mask for use with the a NOTIF_SerialState class-specific notification from the device to the host, * to indicate that a data overrun error has occurred on the virtual serial port. */ #define CDC_CONTROL_LINE_IN_OVERRUNERROR (1 << 6) @@ -140,7 +140,7 @@ * a single typedef struct. A macro is used instead so that functional descriptors can be created * easily by specifying the size of the payload. This allows sizeof() to work correctly. * - * \param[in] DataSize Size in bytes of the CDC functional descriptor's data payload + * \param[in] DataSize Size in bytes of the CDC functional descriptor's data payload. */ #define CDC_FUNCTIONAL_DESCRIPTOR(DataSize) \ struct \ @@ -152,21 +152,21 @@ /* Enums: */ /** Enum for the possible line encoding formats of a virtual serial port. */ - enum CDC_LineCodingFormats_t + enum CDC_LineEncodingFormats_t { - CDC_LINEENCODING_OneStopBit = 0, /**< Each frame contains one stop bit */ - CDC_LINEENCODING_OneAndAHalfStopBits = 1, /**< Each frame contains one and a half stop bits */ - CDC_LINEENCODING_TwoStopBits = 2, /**< Each frame contains two stop bits */ + CDC_LINEENCODING_OneStopBit = 0, /**< Each frame contains one stop bit. */ + CDC_LINEENCODING_OneAndAHalfStopBits = 1, /**< Each frame contains one and a half stop bits. */ + CDC_LINEENCODING_TwoStopBits = 2, /**< Each frame contains two stop bits. */ }; /** Enum for the possible line encoding parity settings of a virtual serial port. */ - enum CDC_LineCodingParity_t + enum CDC_LineEncodingParity_t { - CDC_PARITY_None = 0, /**< No parity bit mode on each frame */ - CDC_PARITY_Odd = 1, /**< Odd parity bit mode on each frame */ - CDC_PARITY_Even = 2, /**< Even parity bit mode on each frame */ - CDC_PARITY_Mark = 3, /**< Mark parity bit mode on each frame */ - CDC_PARITY_Space = 4, /**< Space parity bit mode on each frame */ + CDC_PARITY_None = 0, /**< No parity bit mode on each frame. */ + CDC_PARITY_Odd = 1, /**< Odd parity bit mode on each frame. */ + CDC_PARITY_Even = 2, /**< Even parity bit mode on each frame. */ + CDC_PARITY_Mark = 3, /**< Mark parity bit mode on each frame. */ + CDC_PARITY_Space = 4, /**< Space parity bit mode on each frame. */ }; /* Disable C linkage for C++ Compilers: */ diff --git a/LUFA/Drivers/USB/Class/Common/HID.h b/LUFA/Drivers/USB/Class/Common/HID.h index d7b6983b6..739a7ab33 100644 --- a/LUFA/Drivers/USB/Class/Common/HID.h +++ b/LUFA/Drivers/USB/Class/Common/HID.h @@ -61,22 +61,22 @@ #endif /* Macros: */ - /** HID Class Specific Request to get the current HID report from the device. */ + /** HID class-specific Request to get the current HID report from the device. */ #define REQ_GetReport 0x01 - /** HID Class Specific Request to get the current device idle count. */ + /** HID class-specific Request to get the current device idle count. */ #define REQ_GetIdle 0x02 - /** HID Class Specific Request to set the current HID report to the device. */ + /** HID class-specific Request to set the current HID report to the device. */ #define REQ_SetReport 0x09 - /** HID Class Specific Request to set the device's idle count. */ + /** HID class-specific Request to set the device's idle count. */ #define REQ_SetIdle 0x0A - /** HID Class Specific Request to get the current HID report protocol mode. */ + /** HID class-specific Request to get the current HID report protocol mode. */ #define REQ_GetProtocol 0x03 - /** HID Class Specific Request to set the current HID report protocol mode. */ + /** HID class-specific Request to set the current HID report protocol mode. */ #define REQ_SetProtocol 0x0B /** Descriptor header type value, to indicate a HID class HID descriptor. */ @@ -145,22 +145,22 @@ REPORT_ITEM_TYPE_Feature = 2, /**< Indicates that the item is a FEATURE report type. */ }; - /** \brief HID Class Specific HID Descriptor. + /** \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 + * 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 { - USB_Descriptor_Header_t Header; + USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */ - uint16_t HIDSpec; - uint8_t CountryCode; + uint16_t HIDSpec; /**< BCD encoded version that the HID descriptor and device complies to. */ + uint8_t CountryCode; /**< Country code of the localized device, or zero if universal. */ - uint8_t TotalReportDescriptors; + uint8_t TotalReportDescriptors; /**< Total number of HID report descriptors for the interface. */ - uint8_t HIDReportType; - uint16_t HIDReportLength; + uint8_t HIDReportType; /**< Type of HID report, set to \ref DTYPE_Report. */ + uint16_t HIDReportLength; /**< Length of the associated HID report descriptor, in bytes. */ } USB_HID_Descriptor_t; /** \brief Standard HID Boot Protocol Mouse Report. @@ -169,9 +169,9 @@ */ typedef struct { - uint8_t Button; /**< Button mask for currently pressed buttons in the mouse */ - int8_t X; /**< Current delta X movement of the mouse */ - int8_t Y; /**< Current delta Y movement on the mouse */ + uint8_t Button; /**< Button mask for currently pressed buttons in the mouse. */ + int8_t X; /**< Current delta X movement of the mouse. */ + int8_t Y; /**< Current delta Y movement on the mouse. */ } USB_MouseReport_Data_t; /** \brief Standard HID Boot Protocol Keyboard Report. @@ -181,10 +181,10 @@ typedef struct { uint8_t Modifier; /**< Keyboard modifier byte, indicating pressed modifier keys (a combination of - * HID_KEYBOARD_MODIFER_* masks) + * HID_KEYBOARD_MODIFER_* masks). */ - uint8_t Reserved; /**< Reserved for OEM use, always set to 0 */ - uint8_t KeyCode[6]; /**< Key codes of the currently pressed keys */ + uint8_t Reserved; /**< Reserved for OEM use, always set to 0. */ + uint8_t KeyCode[6]; /**< Key codes of the currently pressed keys. */ } USB_KeyboardReport_Data_t; /** Type define for the data type used to store HID report descriptor elements. */ diff --git a/LUFA/Drivers/USB/Class/Common/MIDI.h b/LUFA/Drivers/USB/Class/Common/MIDI.h index 3ef523c69..688ef09b3 100644 --- a/LUFA/Drivers/USB/Class/Common/MIDI.h +++ b/LUFA/Drivers/USB/Class/Common/MIDI.h @@ -70,10 +70,10 @@ #endif /* Macros: */ - /** Audio class descriptor subtype value for a Audio class specific MIDI input jack descriptor. */ + /** Audio class descriptor subtype value for a Audio class-specific MIDI input jack descriptor. */ #define DSUBTYPE_InputJack 0x02 - /** Audio class descriptor subtype value for a Audio class specific MIDI output jack descriptor. */ + /** Audio class descriptor subtype value for a Audio class-specific MIDI output jack descriptor. */ #define DSUBTYPE_OutputJack 0x03 /** Audio class descriptor jack type value for an embedded (logical) MIDI input or output jack. */ @@ -94,75 +94,77 @@ /** Convenience macro. MIDI channels are numbered from 1-10 (natural numbers) however the logical channel * addresses are zero-indexed. This converts a natural MIDI channel number into the logical channel address. * - * \param[in] channel MIDI channel number to address + * \param[in] channel MIDI channel number to address. */ #define MIDI_CHANNEL(channel) ((channel) - 1) /* Type Defines: */ - /** \brief MIDI Class Specific Streaming Interface Descriptor. + /** \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. + * 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. */ typedef struct { - USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length */ - uint8_t Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */ + USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */ + uint8_t Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */ - uint16_t AudioSpecification; /**< Binary coded decimal value, indicating the supported Audio Class specification version */ - uint16_t TotalLength; /**< Total length of the Audio class specific descriptors, including this descriptor */ + uint16_t AudioSpecification; /**< Binary coded decimal value, indicating the supported Audio Class + * specification version. + */ + uint16_t TotalLength; /**< Total length of the Audio class-specific descriptors, including this descriptor. */ } USB_MIDI_AudioInterface_AS_t; - /** \brief MIDI Class Specific Input Jack Descriptor. + /** \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 + * 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 { - USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length */ - uint8_t Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */ + USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */ + uint8_t Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */ - uint8_t JackType; /**< Type of jack, one of the JACKTYPE_* mask values */ - uint8_t JackID; /**< ID value of this jack - must be a unique value within the device */ + uint8_t JackType; /**< Type of jack, one of the JACKTYPE_* mask values. */ + uint8_t JackID; /**< ID value of this jack - must be a unique value within the device. */ - uint8_t JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device */ + uint8_t JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */ } USB_MIDI_In_Jack_t; - /** \brief MIDI Class Specific Output Jack Descriptor. + /** \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 + * 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 { - USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length */ - uint8_t Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */ + USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */ + uint8_t Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */ - uint8_t JackType; /**< Type of jack, one of the JACKTYPE_* mask values */ - uint8_t JackID; /**< ID value of this jack - must be a unique value within the device */ + uint8_t JackType; /**< Type of jack, one of the JACKTYPE_* mask values. */ + uint8_t JackID; /**< ID value of this jack - must be a unique value within the device. */ - uint8_t NumberOfPins; /**< Number of output channels within the jack, either physical or logical */ - uint8_t SourceJackID[1]; /**< ID of each output pin's source data jack */ - uint8_t SourcePinID[1]; /**< Pin number in the input jack of each output pin's source data */ + uint8_t NumberOfPins; /**< Number of output channels within the jack, either physical or logical. */ + uint8_t SourceJackID[1]; /**< ID of each output pin's source data jack. */ + uint8_t SourcePinID[1]; /**< Pin number in the input jack of each output pin's source data. */ - uint8_t JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device */ + uint8_t JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */ } USB_MIDI_Out_Jack_t; - /** \brief Audio Class Specific Jack Endpoint Descriptor. + /** \brief Audio class-specific Jack Endpoint Descriptor. * - * Type define for an Audio class specific extended MIDI jack endpoint descriptor. This contains extra information + * 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. + * class-specific extended MIDI endpoint descriptor. See the USB Audio specification for more details. */ typedef struct { - USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length */ - uint8_t Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */ + USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */ + uint8_t Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */ - uint8_t TotalEmbeddedJacks; /**< Total number of jacks inside this endpoint */ - uint8_t AssociatedJackID[1]; /**< IDs of each jack inside the endpoint */ + uint8_t TotalEmbeddedJacks; /**< Total number of jacks inside this endpoint. */ + uint8_t AssociatedJackID[1]; /**< IDs of each jack inside the endpoint. */ } USB_MIDI_Jack_Endpoint_t; /** \brief MIDI Class Driver Event Packet. @@ -171,12 +173,12 @@ */ typedef struct { - unsigned char Command : 4; /**< Upper nibble of the MIDI command being sent or received in the event packet */ - unsigned char CableNumber : 4; /**< Virtual cable number of the event being sent or received in the given MIDI interface */ + unsigned char Command : 4; /**< Upper nibble of the MIDI command being sent or received in the event packet. */ + unsigned char CableNumber : 4; /**< Virtual cable number of the event being sent or received in the given MIDI interface. */ - uint8_t Data1; /**< First byte of data in the MIDI event */ - uint8_t Data2; /**< Second byte of data in the MIDI event */ - uint8_t Data3; /**< Third byte of data in the MIDI event */ + uint8_t Data1; /**< First byte of data in the MIDI event. */ + uint8_t Data2; /**< Second byte of data in the MIDI event. */ + uint8_t Data3; /**< Third byte of data in the MIDI event. */ } MIDI_EventPacket_t; /* Disable C linkage for C++ Compilers: */ diff --git a/LUFA/Drivers/USB/Class/Common/MassStorage.h b/LUFA/Drivers/USB/Class/Common/MassStorage.h index 7bbb863dc..ade71a205 100644 --- a/LUFA/Drivers/USB/Class/Common/MassStorage.h +++ b/LUFA/Drivers/USB/Class/Common/MassStorage.h @@ -66,10 +66,10 @@ #endif /* Macros: */ - /** Mass Storage Class specific request to reset the Mass Storage interface, ready for the next command. */ + /** Mass Storage class-specific request to reset the Mass Storage interface, ready for the next command. */ #define REQ_MassStorageReset 0xFF - /** Mass Storage Class specific request to retrieve the total number of Logical Units (drives) in the SCSI device. */ + /** Mass Storage class-specific request to retrieve the total number of Logical Units (drives) in the SCSI device. */ #define REQ_GetMaxLUN 0xFE /** Magic signature for a Command Block Wrapper used in the Mass Storage Bulk-Only transport protocol. */ @@ -211,13 +211,13 @@ * 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 */ - uint32_t Tag; /**< Unique command ID value, to associate a command block wrapper with its command status wrapper */ - uint32_t DataTransferLength; /**< Length of the optional data portion of the issued command, in bytes */ - uint8_t Flags; /**< Command block flags, indicating command data direction */ - uint8_t LUN; /**< Logical Unit number this command is issued to */ - uint8_t SCSICommandLength; /**< Length of the issued SCSI command within the SCSI command data array */ - uint8_t SCSICommandData[16]; /**< Issued SCSI command in the Command Block */ + uint32_t Signature; /**< Command block signature, must be CBW_SIGNATURE to indicate a valid Command Block. */ + uint32_t Tag; /**< Unique command ID value, to associate a command block wrapper with its command status wrapper. */ + uint32_t DataTransferLength; /**< Length of the optional data portion of the issued command, in bytes. */ + uint8_t Flags; /**< Command block flags, indicating command data direction. */ + uint8_t LUN; /**< Logical Unit number this command is issued to. */ + uint8_t SCSICommandLength; /**< Length of the issued SCSI command within the SCSI command data array. */ + uint8_t SCSICommandData[16]; /**< Issued SCSI command in the Command Block. */ } MS_CommandBlockWrapper_t; /** \brief Mass Storage Class Command Status Wrapper. @@ -226,10 +226,10 @@ */ typedef struct { - uint32_t Signature; /**< Status block signature, must be CSW_SIGNATURE to indicate a valid Command Status */ - uint32_t Tag; /**< Unique command ID value, to associate a command block wrapper with its command status wrapper */ - uint32_t DataTransferResidue; /**< Number of bytes of data not processed in the SCSI command */ - uint8_t Status; /**< Status code of the issued command - a value from the MassStorage_CommandStatusCodes_t enum */ + uint32_t Signature; /**< Status block signature, must be CSW_SIGNATURE to indicate a valid Command Status. */ + uint32_t Tag; /**< Unique command ID value, to associate a command block wrapper with its command status wrapper. */ + uint32_t DataTransferResidue; /**< Number of bytes of data not processed in the SCSI command. */ + uint8_t Status; /**< Status code of the issued command - a value from the MassStorage_CommandStatusCodes_t enum. */ } MS_CommandStatusWrapper_t; /** \brief Mass Storage Class SCSI Sense Structure @@ -306,8 +306,10 @@ enum MassStorage_CommandStatusCodes_t { SCSI_Command_Pass = 0, /**< Command completed with no error */ - SCSI_Command_Fail = 1, /**< Command failed to complete - host may check the exact error via a SCSI REQUEST SENSE command */ - SCSI_Phase_Error = 2 /**< Command failed due to being invalid in the current phase */ + SCSI_Command_Fail = 1, /**< Command failed to complete - host may check the exact error via a + * SCSI REQUEST SENSE command. + */ + SCSI_Phase_Error = 2 /**< Command failed due to being invalid in the current phase. */ }; /* Disable C linkage for C++ Compilers: */ diff --git a/LUFA/Drivers/USB/Class/Common/RNDIS.h b/LUFA/Drivers/USB/Class/Common/RNDIS.h index 9424b26a2..a6549c5e3 100644 --- a/LUFA/Drivers/USB/Class/Common/RNDIS.h +++ b/LUFA/Drivers/USB/Class/Common/RNDIS.h @@ -96,25 +96,25 @@ /** Enum for the possible NDIS adapter states. */ enum RNDIS_States_t { - RNDIS_Uninitialized = 0, /**< Adapter currently uninitialized */ - RNDIS_Initialized = 1, /**< Adapter currently initialized but not ready for data transfers */ - RNDIS_Data_Initialized = 2, /**< Adapter currently initialized and ready for data transfers */ + RNDIS_Uninitialized = 0, /**< Adapter currently uninitialized. */ + RNDIS_Initialized = 1, /**< Adapter currently initialized but not ready for data transfers. */ + RNDIS_Data_Initialized = 2, /**< Adapter currently initialized and ready for data transfers. */ }; /** Enum for the NDIS hardware states. */ enum NDIS_Hardware_Status_t { - NDIS_HardwareStatus_Ready, /**< Hardware Ready to accept commands from the host */ - NDIS_HardwareStatus_Initializing, /**< Hardware busy initializing */ - NDIS_HardwareStatus_Reset, /**< Hardware reset */ - NDIS_HardwareStatus_Closing, /**< Hardware currently closing */ - NDIS_HardwareStatus_NotReady /**< Hardware not ready to accept commands from the host */ + NDIS_HardwareStatus_Ready, /**< Hardware Ready to accept commands from the host. */ + NDIS_HardwareStatus_Initializing, /**< Hardware busy initializing. */ + NDIS_HardwareStatus_Reset, /**< Hardware reset. */ + NDIS_HardwareStatus_Closing, /**< Hardware currently closing. */ + NDIS_HardwareStatus_NotReady /**< Hardware not ready to accept commands from the host. */ }; /* Type Defines: */ /** \brief MAC Address Structure. * - * Type define for a physical MAC address of a device on a network + * Type define for a physical MAC address of a device on a network. */ typedef struct { @@ -127,9 +127,9 @@ */ typedef struct { - uint8_t FrameData[ETHERNET_FRAME_SIZE_MAX]; /**< Ethernet frame contents */ - uint16_t FrameLength; /**< Length in bytes of the Ethernet frame stored in the buffer */ - bool FrameInBuffer; /**< Indicates if a frame is currently stored in the buffer */ + uint8_t FrameData[ETHERNET_FRAME_SIZE_MAX]; /**< Ethernet frame contents. */ + uint16_t FrameLength; /**< Length in bytes of the Ethernet frame stored in the buffer. */ + bool FrameInBuffer; /**< Indicates if a frame is currently stored in the buffer. */ } Ethernet_Frame_Info_t; /** \brief RNDIS Common Message Header Structure. diff --git a/LUFA/Drivers/USB/Class/Common/StillImage.h b/LUFA/Drivers/USB/Class/Common/StillImage.h index 7be75067d..434d65a1e 100644 --- a/LUFA/Drivers/USB/Class/Common/StillImage.h +++ b/LUFA/Drivers/USB/Class/Common/StillImage.h @@ -66,58 +66,58 @@ #endif /* Macros: */ - /** Length in bytes of a given Unicode string's character length + /** Length in bytes of a given Unicode string's character length. * - * \param[in] chars Total number of Unicode characters in the string + * \param[in] Chars Total number of Unicode characters in the string. * - * \return Number of bytes of the given unicode string + * \return Number of bytes of the given unicode string. */ - #define UNICODE_STRING_LENGTH(chars) ((chars) << 1) + #define UNICODE_STRING_LENGTH(Chars) ((Chars) << 1) /** Used in the DataLength field of a PIMA container, to give the total container size in bytes for * a command container. * - * \param[in] params Number of parameters which are to be sent in the Param field of the container + * \param[in] Params Number of parameters which are to be sent in the Param field of the container. */ - #define PIMA_COMMAND_SIZE(params) ((sizeof(SI_PIMA_Container_t) - 12) + \ - ((params) * sizeof(uint32_t))) + #define PIMA_COMMAND_SIZE(Params) ((sizeof(SI_PIMA_Container_t) - 12) + \ + ((Params) * sizeof(uint32_t))) /** Used in the DataLength field of a PIMA container, to give the total container size in bytes for * a data container. * - * \param[in] datalen Length in bytes of the data in the container + * \param[in] DataLen Length in bytes of the data in the container. */ - #define PIMA_DATA_SIZE(datalen) ((sizeof(SI_PIMA_Container_t) - 12) + \ - (datalen)) + #define PIMA_DATA_SIZE(DataLen) ((sizeof(SI_PIMA_Container_t) - 12) + \ + (DataLen)) /* Enums: */ /** Enum for the possible PIMA contains types. */ enum SI_PIMA_Container_Types_t { - CType_Undefined = 0, /**< Undefined container type */ - CType_CommandBlock = 1, /**< Command Block container type */ - CType_DataBlock = 2, /**< Data Block container type */ - CType_ResponseBlock = 3, /**< Response container type */ - CType_EventBlock = 4, /**< Event Block container type */ + CType_Undefined = 0, /**< Undefined container type. */ + CType_CommandBlock = 1, /**< Command Block container type. */ + CType_DataBlock = 2, /**< Data Block container type. */ + CType_ResponseBlock = 3, /**< Response container type. */ + CType_EventBlock = 4, /**< Event Block container type. */ }; /* Enums: */ /** Enums for the possible status codes of a returned Response Block from an attached PIMA compliant Still Image device. */ enum SI_PIMA_ResponseCodes_t { - PIMA_RESPONSE_OK = 1, /**< Response code indicating no error in the issued command */ + PIMA_RESPONSE_OK = 1, /**< Response code indicating no error in the issued command. */ PIMA_RESPONSE_GeneralError = 2, /**< Response code indicating a general error while processing the - * issued command + * issued command. */ PIMA_RESPONSE_SessionNotOpen = 3, /**< Response code indicating that the sent command requires an open - * session before being issued + * session before being issued. */ - PIMA_RESPONSE_InvalidTransaction = 4, /**< Response code indicating an invalid transaction occurred */ + PIMA_RESPONSE_InvalidTransaction = 4, /**< Response code indicating an invalid transaction occurred. */ PIMA_RESPONSE_OperationNotSupported = 5, /**< Response code indicating that the issued command is not supported - * by the attached device + * by the attached device. */ PIMA_RESPONSE_ParameterNotSupported = 6, /**< Response code indicating that one or more of the issued command's - * parameters are not supported by the device + * parameters are not supported by the device. */ }; @@ -129,11 +129,11 @@ */ typedef struct { - uint32_t DataLength; /**< Length of the container and data, in bytes */ - uint16_t Type; /**< Container type, a value from the PIMA_Container_Types_t enum */ - uint16_t Code; /**< Command, event or response code of the container */ - uint32_t TransactionID; /**< Unique container ID to link blocks together */ - uint32_t Params[3]; /**< Block parameters to be issued along with the block code (command blocks only) */ + uint32_t DataLength; /**< Length of the container and data, in bytes. */ + uint16_t Type; /**< Container type, a value from the \ref SI_PIMA_Container_Types_t enum. */ + uint16_t Code; /**< Command, event or response code of the container. */ + uint32_t TransactionID; /**< Unique container ID to link blocks together. */ + uint32_t Params[3]; /**< Block parameters to be issued along with the block code (command blocks only). */ } SI_PIMA_Container_t; /* Disable C linkage for C++ Compilers: */ |