diff options
Diffstat (limited to 'LUFA/Drivers/USB/Class/Common')
| -rw-r--r-- | LUFA/Drivers/USB/Class/Common/Audio.h | 31 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/Class/Common/CDC.h | 2 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/Class/Common/HID.h | 2 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/Class/Common/MIDI.h | 8 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/Class/Common/MassStorage.h | 4 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/Class/Common/RNDIS.h | 4 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/Class/Common/StillImage.h | 2 |
7 files changed, 27 insertions, 26 deletions
diff --git a/LUFA/Drivers/USB/Class/Common/Audio.h b/LUFA/Drivers/USB/Class/Common/Audio.h index f464029c1..70a8016c1 100644 --- a/LUFA/Drivers/USB/Class/Common/Audio.h +++ b/LUFA/Drivers/USB/Class/Common/Audio.h @@ -206,7 +206,7 @@ * * \param[in] freq Required audio sampling frequency in HZ */ - #define AUDIO_SAMPLE_FREQ(freq) {((uint32_t)freq & 0x00FFFF), (((uint32_t)freq >> 16) & 0x0000FF)} + #define AUDIO_SAMPLE_FREQ(freq) {.Byte1 = (freq & 0x0000FF), .Byte2 = ((freq >> 8) & 0xFF), .Byte3 = ((freq >> 16) & 0xFF)} /** Mask for the attributes parameter of an Audio class-specific Endpoint descriptor, indicating that the endpoint * accepts only filled endpoint packets of audio samples. @@ -288,12 +288,12 @@ */ 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. */ + uint16_t TerminalType; /**< Type of terminal, a \c TERMINAL_* mask. */ uint8_t AssociatedOutputTerminal; /**< ID of associated output terminal, for physically grouped terminals * 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; /**< \c 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. */ @@ -319,12 +319,12 @@ * must be \ref AUDIO_DSUBTYPE_CSInterface_InputTerminal. */ uint8_t bTerminalID; /**< ID value of this terminal unit - must be a unique value within the device. */ - uint16_t wTerminalType; /**< Type of terminal, a TERMINAL_* mask. */ + uint16_t wTerminalType; /**< Type of terminal, a \c TERMINAL_* mask. */ uint8_t bAssocTerminal; /**< ID of associated output terminal, for physically grouped terminals * such as the speaker and microphone of a phone handset. */ uint8_t bNrChannels; /**< Total number of separate audio channels within this interface (right, left, etc.) */ - uint16_t wChannelConfig; /**< CHANNEL_* masks indicating what channel layout is supported by this terminal. */ + uint16_t wChannelConfig; /**< \c CHANNEL_* masks indicating what channel layout is supported by this terminal. */ uint8_t iChannelNames; /**< Index of a string descriptor describing this channel within the device. */ uint8_t iTerminal; /**< Index of a string descriptor describing this descriptor within the device. */ @@ -346,7 +346,7 @@ */ 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. */ + uint16_t TerminalType; /**< Type of terminal, a \c TERMINAL_* mask. */ uint8_t AssociatedInputTerminal; /**< ID of associated input terminal, for physically grouped terminals * such as the speaker and microphone of a phone handset. */ @@ -375,7 +375,7 @@ * a value from the \ref Audio_CSInterface_AC_SubTypes_t enum. */ uint8_t bTerminalID; /**< ID value of this terminal unit - must be a unique value within the device. */ - uint16_t wTerminalType; /**< Type of terminal, a TERMINAL_* mask. */ + uint16_t wTerminalType; /**< Type of terminal, a \c TERMINAL_* mask. */ uint8_t bAssocTerminal; /**< ID of associated input terminal, for physically grouped terminals * such as the speaker and microphone of a phone handset. */ @@ -451,7 +451,7 @@ 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 ControlSize; /**< Size of each element in the \c 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. */ @@ -480,7 +480,7 @@ uint8_t bUnitID; /**< ID value of this feature unit - must be a unique value within the device. */ uint8_t bSourceID; /**< Source ID value of the audio source input into this feature unit. */ - uint8_t bControlSize; /**< Size of each element in the ChanelControlls array. */ + uint8_t bControlSize; /**< Size of each element in the \c ChanelControlls array. */ uint8_t bmaControls[3]; /**< Feature masks for the control channel, and each separate audio channel. */ uint8_t iFeature; /**< Index of a string descriptor describing this descriptor within the device. */ @@ -538,8 +538,9 @@ */ typedef struct { - uint16_t LowWord; /**< Low 16 bits of the 24-bit value. */ - uint8_t HighByte; /**< Upper 8 bits of the 24-bit value. */ + uint8_t Byte1; /**< Lowest 8 bits of the 24-bit value. */ + uint8_t Byte2; /**< Middle 8 bits of the 24-bit value. */ + uint8_t Byte3; /**< Upper 8 bits of the 24-bit value. */ } USB_Audio_SampleFreq_t; /** \brief Audio class-specific Format Descriptor (LUFA naming conventions). @@ -629,8 +630,8 @@ uint8_t bEndpointAddress; /**< Logical address of the endpoint within the device for the current * configuration, including direction mask. */ - uint8_t bmAttributes; /**< Endpoint attributes, comprised of a mask of the endpoint type (EP_TYPE_*) - * and attributes (ENDPOINT_ATTR_*) masks. + uint8_t bmAttributes; /**< Endpoint attributes, comprised of a mask of the endpoint type (\c EP_TYPE_*) + * and attributes (\c ENDPOINT_ATTR_*) masks. */ uint16_t wMaxPacketSize; /**< Size of the endpoint bank, in bytes. This indicates the maximum packet size * that the endpoint can receive at a time. @@ -658,7 +659,7 @@ * a value from the \ref Audio_CSEndpoint_SubTypes_t enum. */ - uint8_t Attributes; /**< Audio class-specific endpoint attributes, such as ACCEPTS_SMALL_PACKETS. */ + uint8_t Attributes; /**< Audio class-specific endpoint attributes, such as \ref AUDIO_EP_FULL_PACKETS_ONLY. */ 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. */ @@ -684,7 +685,7 @@ * a value from the \ref Audio_CSEndpoint_SubTypes_t enum. */ - uint8_t bmAttributes; /**< Audio class-specific endpoint attributes, such as ACCEPTS_SMALL_PACKETS. */ + uint8_t bmAttributes; /**< Audio class-specific endpoint attributes, such as \ref AUDIO_EP_FULL_PACKETS_ONLY. */ uint8_t bLockDelayUnits; /**< Units used for the LockDelay field, see Audio class specification. */ uint16_t wLockDelay; /**< Time required to internally lock endpoint's internal clock recovery circuitry. */ diff --git a/LUFA/Drivers/USB/Class/Common/CDC.h b/LUFA/Drivers/USB/Class/Common/CDC.h index cf4ed9a71..06efb51d4 100644 --- a/LUFA/Drivers/USB/Class/Common/CDC.h +++ b/LUFA/Drivers/USB/Class/Common/CDC.h @@ -117,7 +117,7 @@ /** Macro to define a CDC class-specific functional descriptor. CDC functional descriptors have a * uniform structure but variable sized data payloads, thus cannot be represented accurately by * 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. + * easily by specifying the size of the payload. This allows \c sizeof() to work correctly. * * \param[in] DataSize Size in bytes of the CDC functional descriptor's data payload. */ diff --git a/LUFA/Drivers/USB/Class/Common/HID.h b/LUFA/Drivers/USB/Class/Common/HID.h index e6af98843..b0b2d9c82 100644 --- a/LUFA/Drivers/USB/Class/Common/HID.h +++ b/LUFA/Drivers/USB/Class/Common/HID.h @@ -437,7 +437,7 @@ typedef struct { uint8_t Modifier; /**< Keyboard modifier byte, indicating pressed modifier keys (a combination of - * HID_KEYBOARD_MODIFER_* masks). + * \c 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. */ diff --git a/LUFA/Drivers/USB/Class/Common/MIDI.h b/LUFA/Drivers/USB/Class/Common/MIDI.h index a65cf519a..3aea6376e 100644 --- a/LUFA/Drivers/USB/Class/Common/MIDI.h +++ b/LUFA/Drivers/USB/Class/Common/MIDI.h @@ -151,7 +151,7 @@ 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 JackType; /**< Type of jack, one of the \c 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. */ @@ -174,7 +174,7 @@ uint8_t bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */ - uint8_t bJackType; /**< Type of jack, one of the JACKTYPE_* mask values. */ + uint8_t bJackType; /**< Type of jack, one of the \c JACKTYPE_* mask values. */ uint8_t bJackID; /**< ID value of this jack - must be a unique value within the device. */ uint8_t iJack; /**< Index of a string descriptor describing this descriptor within the device. */ @@ -192,7 +192,7 @@ 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 JackType; /**< Type of jack, one of the \c 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. */ @@ -219,7 +219,7 @@ uint8_t bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */ - uint8_t bJackType; /**< Type of jack, one of the JACKTYPE_* mask values. */ + uint8_t bJackType; /**< Type of jack, one of the \c JACKTYPE_* mask values. */ uint8_t bJackID; /**< ID value of this jack - must be a unique value within the device. */ uint8_t bNrInputPins; /**< Number of output channels within the jack, either physical or logical. */ diff --git a/LUFA/Drivers/USB/Class/Common/MassStorage.h b/LUFA/Drivers/USB/Class/Common/MassStorage.h index d81d68c36..761141b63 100644 --- a/LUFA/Drivers/USB/Class/Common/MassStorage.h +++ b/LUFA/Drivers/USB/Class/Common/MassStorage.h @@ -261,7 +261,7 @@ * 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 Signature; /**< Command block signature, must be \ref MS_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. */ @@ -276,7 +276,7 @@ */ typedef struct { - uint32_t Signature; /**< Status block signature, must be CSW_SIGNATURE to indicate a valid Command Status. */ + uint32_t Signature; /**< Status block signature, must be \ref MS_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 \ref MS_CommandStatusCodes_t enum. */ diff --git a/LUFA/Drivers/USB/Class/Common/RNDIS.h b/LUFA/Drivers/USB/Class/Common/RNDIS.h index 189737622..ccafeb5a7 100644 --- a/LUFA/Drivers/USB/Class/Common/RNDIS.h +++ b/LUFA/Drivers/USB/Class/Common/RNDIS.h @@ -193,7 +193,7 @@ /** Enum for the RNDIS class specific notification requests that can be issued by a RNDIS device to a host. */ enum RNDIS_ClassNotifications_t { - RNDIS_NOTIF_ResponseAvailable = 0x01, /**< Notification request value for a RNDIS Response Available notification. */ + RNDIS_NOTIF_ResponseAvailable 0x01, /**< Notification request value for a RNDIS Response Available notification. */ }; /** Enum for the NDIS hardware states. */ @@ -233,7 +233,7 @@ */ typedef struct { - uint32_t MessageType; /**< RNDIS message type, a REMOTE_NDIS_*_MSG constant */ + uint32_t MessageType; /**< RNDIS message type, a \c REMOTE_NDIS_*_MSG constant */ uint32_t MessageLength; /**< Total length of the RNDIS message, in bytes */ } RNDIS_Message_Header_t; diff --git a/LUFA/Drivers/USB/Class/Common/StillImage.h b/LUFA/Drivers/USB/Class/Common/StillImage.h index 14fe3609a..132e2aa93 100644 --- a/LUFA/Drivers/USB/Class/Common/StillImage.h +++ b/LUFA/Drivers/USB/Class/Common/StillImage.h @@ -77,7 +77,7 @@ /** 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 \c Param field of the container. */ #define PIMA_COMMAND_SIZE(Params) ((sizeof(PIMA_Container_t) - 12) + ((Params) * sizeof(uint32_t))) |