diff options
Diffstat (limited to 'LUFA/Drivers/USB/Class')
21 files changed, 88 insertions, 86 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))) diff --git a/LUFA/Drivers/USB/Class/Device/Audio.h b/LUFA/Drivers/USB/Class/Device/Audio.h index 178dead44..180b9a3b6 100644 --- a/LUFA/Drivers/USB/Class/Device/Audio.h +++ b/LUFA/Drivers/USB/Class/Device/Audio.h @@ -79,7 +79,7 @@ * * 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. + * \c AudioInterfaceInfo parameter. This stores each Audio interface's configuration and state information. */ typedef struct { @@ -126,7 +126,7 @@ * * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state. * - * \return Boolean true if the endpoints were successfully configured, false otherwise. + * \return Boolean \c true if the endpoints were successfully configured, \c false otherwise. */ bool Audio_Device_ConfigureEndpoints(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); @@ -158,7 +158,7 @@ * * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state. * - * \return Boolean true if the given Audio interface has a sample to be read, false otherwise. + * \return Boolean \c true if the given Audio interface has a sample to be read, \c false otherwise. */ static inline bool Audio_Device_IsSampleReceived(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE; @@ -179,7 +179,7 @@ * * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state. * - * \return Boolean true if the given Audio interface is ready to accept the next sample, false otherwise. + * \return Boolean \c true if the given Audio interface is ready to accept the next sample, \c false otherwise. */ static inline bool Audio_Device_IsReadyForNextSample(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE; diff --git a/LUFA/Drivers/USB/Class/Device/CDC.h b/LUFA/Drivers/USB/Class/Device/CDC.h index dbd5b0237..8d8176bee 100644 --- a/LUFA/Drivers/USB/Class/Device/CDC.h +++ b/LUFA/Drivers/USB/Class/Device/CDC.h @@ -123,10 +123,10 @@ { struct { - uint8_t HostToDevice; /**< Control line states from the host to device, as a set of CDC_CONTROL_LINE_OUT_* + uint8_t HostToDevice; /**< Control line states from the host to device, as a set of \c CDC_CONTROL_LINE_OUT_* * masks. This value is updated each time \ref CDC_Device_USBTask() is called. */ - uint8_t DeviceToHost; /**< Control line states from the device to host, as a set of CDC_CONTROL_LINE_IN_* + uint8_t DeviceToHost; /**< Control line states from the device to host, as a set of \c CDC_CONTROL_LINE_IN_* * masks - to notify the host of changes to these values, call the * \ref CDC_Device_SendControlLineStateChange() function. */ @@ -152,7 +152,7 @@ * * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state. * - * \return Boolean true if the endpoints were successfully configured, false otherwise. + * \return Boolean \c true if the endpoints were successfully configured, \c false otherwise. */ bool CDC_Device_ConfigureEndpoints(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); @@ -319,7 +319,7 @@ static int CDC_Device_getchar(FILE* Stream) ATTR_NON_NULL_PTR_ARG(1); static int CDC_Device_getchar_Blocking(FILE* Stream) ATTR_NON_NULL_PTR_ARG(1); - void CDC_Device_Event_Stub(void); + void CDC_Device_Event_Stub(void) ATTR_CONST; void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_WEAK ATTR_NON_NULL_PTR_ARG(1) ATTR_ALIAS(CDC_Device_Event_Stub); void EVENT_CDC_Device_ControLineStateChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) diff --git a/LUFA/Drivers/USB/Class/Device/HID.h b/LUFA/Drivers/USB/Class/Device/HID.h index af80f79ed..658acb4f4 100644 --- a/LUFA/Drivers/USB/Class/Device/HID.h +++ b/LUFA/Drivers/USB/Class/Device/HID.h @@ -80,7 +80,7 @@ * * 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. + * \c HIDInterfaceInfo parameter. This stores each HID interface's configuration and state information. * * \note Due to technical limitations, the HID device class driver does not utilize a separate OUT * endpoint for host->device communications. Instead, the host->device data (if any) is sent to @@ -100,18 +100,18 @@ * stored by the driver, for comparison purposes to detect report changes that * must be sent immediately to the host. This should point to a buffer big enough * to hold the largest HID input report sent from the HID interface. If this is set - * to NULL, it is up to the user to force transfers when needed in the + * to \c NULL, it is up to the user to force transfers when needed in the * \ref CALLBACK_HID_Device_CreateHIDReport() callback function. * * \note Due to the single buffer, the internal driver can only correctly compare * subsequent reports with identical report IDs. In multiple report devices, - * this buffer should be set to NULL and the decision to send reports made + * this buffer should be set to \c NULL and the decision to send reports made * by the user application instead. */ uint8_t PrevReportINBufferSize; /**< Size in bytes of the given input report buffer. This is used to create a * second buffer of the same size within the driver so that subsequent reports * can be compared. If the user app is to determine when reports are to be sent - * exclusively (i.e. \ref PrevReportINBuffer is NULL) this value must still be + * exclusively (i.e. \ref PrevReportINBuffer is \c NULL) this value must still be * set to the size of the largest report the device can issue to the host. */ } Config; /**< Config data for the USB class interface within the device. All elements in this section @@ -139,7 +139,7 @@ * * \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class configuration and state. * - * \return Boolean true if the endpoints were successfully configured, false otherwise. + * \return Boolean \c true if the endpoints were successfully configured, \c false otherwise. */ bool HID_Device_ConfigureEndpoints(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); @@ -169,8 +169,8 @@ * \param[out] ReportData Pointer to a buffer where the generated HID report should be stored. * \param[out] ReportSize Number of bytes in the generated input report, or zero if no report is to be sent. * - * \return Boolean true to force the sending of the report even if it is identical to the previous report and still within - * the idle period (useful for devices which report relative movement), false otherwise. + * \return Boolean \c true to force the sending of the report even if it is identical to the previous report and still within + * the idle period (useful for devices which report relative movement), \c false otherwise. */ bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, uint8_t* const ReportID, diff --git a/LUFA/Drivers/USB/Class/Device/MIDI.h b/LUFA/Drivers/USB/Class/Device/MIDI.h index ec700a461..54dd094e0 100644 --- a/LUFA/Drivers/USB/Class/Device/MIDI.h +++ b/LUFA/Drivers/USB/Class/Device/MIDI.h @@ -79,7 +79,7 @@ * * 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. + * \c MIDIInterfaceInfo parameter. This stores each MIDI interface's configuration and state information. */ typedef struct { @@ -116,7 +116,7 @@ * * \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state. * - * \return Boolean true if the endpoints were successfully configured, false otherwise. + * \return Boolean \c true if the endpoints were successfully configured, \c false otherwise. */ bool MIDI_Device_ConfigureEndpoints(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); @@ -161,7 +161,7 @@ * \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state. * \param[out] Event Pointer to a USB_MIDI_EventPacket_t structure where the received MIDI event is to be placed. * - * \return Boolean true if a MIDI event packet was received, false otherwise. + * \return Boolean \c true if a MIDI event packet was received, \c false otherwise. */ bool MIDI_Device_ReceiveEventPacket(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo, MIDI_EventPacket_t* const Event) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2); diff --git a/LUFA/Drivers/USB/Class/Device/MassStorage.h b/LUFA/Drivers/USB/Class/Device/MassStorage.h index cf0c33bf4..774d3e5e9 100644 --- a/LUFA/Drivers/USB/Class/Device/MassStorage.h +++ b/LUFA/Drivers/USB/Class/Device/MassStorage.h @@ -79,7 +79,7 @@ * * 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. + * \c MSInterfaceInfo parameter. This stores each Mass Storage interface's configuration and state information. */ typedef struct { @@ -126,7 +126,7 @@ * * \param[in,out] MSInterfaceInfo Pointer to a structure containing a Mass Storage Class configuration and state. * - * \return Boolean true if the endpoints were successfully configured, false otherwise. + * \return Boolean \c true if the endpoints were successfully configured, \c false otherwise. */ bool MS_Device_ConfigureEndpoints(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); @@ -151,7 +151,7 @@ * * \param[in,out] MSInterfaceInfo Pointer to a structure containing a Mass Storage Class configuration and state. * - * \return Boolean true if the SCSI command was successfully processed, false otherwise. + * \return Boolean \c true if the SCSI command was successfully processed, \c false otherwise. */ bool CALLBACK_MS_Device_SCSICommandReceived(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); diff --git a/LUFA/Drivers/USB/Class/Device/RNDIS.h b/LUFA/Drivers/USB/Class/Device/RNDIS.h index 50223c908..2bafe6c9b 100644 --- a/LUFA/Drivers/USB/Class/Device/RNDIS.h +++ b/LUFA/Drivers/USB/Class/Device/RNDIS.h @@ -80,7 +80,7 @@ * * 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. + * \c RNDISInterfaceInfo parameter. This stores each RNDIS interface's configuration and state information. */ typedef struct { @@ -135,7 +135,7 @@ * * \param[in,out] RNDISInterfaceInfo Pointer to a structure containing a RNDIS Class configuration and state. * - * \return Boolean true if the endpoints were successfully configured, false otherwise. + * \return Boolean \c true if the endpoints were successfully configured, \c false otherwise. */ bool RNDIS_Device_ConfigureEndpoints(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); diff --git a/LUFA/Drivers/USB/Class/Host/CDC.h b/LUFA/Drivers/USB/Class/Host/CDC.h index 6f41ba7ed..cc7465d3a 100644 --- a/LUFA/Drivers/USB/Class/Host/CDC.h +++ b/LUFA/Drivers/USB/Class/Host/CDC.h @@ -79,7 +79,7 @@ /** \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 + * and passed to each of the CDC class driver functions as the \c CDCInterfaceInfo parameter. This * stores each CDC interface's configuration and state information. */ typedef struct @@ -111,11 +111,11 @@ struct { - uint8_t HostToDevice; /**< Control line states from the host to device, as a set of CDC_CONTROL_LINE_OUT_* + uint8_t HostToDevice; /**< Control line states from the host to device, as a set of \c CDC_CONTROL_LINE_OUT_* * masks - to notify the device of changes to these values, call the * \ref CDC_Host_SendControlLineStateChange() function. */ - uint8_t DeviceToHost; /**< Control line states from the device to host, as a set of CDC_CONTROL_LINE_IN_* + uint8_t DeviceToHost; /**< Control line states from the device to host, as a set of \c CDC_CONTROL_LINE_IN_* * masks. This value is updated each time \ref CDC_Host_USBTask() is called. */ } ControlLineStates; /**< Current states of the virtual serial port's control lines between the device and host. */ @@ -170,7 +170,7 @@ uint16_t ConfigDescriptorSize, void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3); - /** Sets the line encoding for the attached device's virtual serial port. This should be called when the LineEncoding + /** Sets the line encoding for the attached device's virtual serial port. This should be called when the \c LineEncoding * values of the interface have been changed to push the new settings to the USB device. * * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state. @@ -181,7 +181,7 @@ /** Sends a Serial Control Line State Change notification to the device. This should be called when the virtual serial * control lines (DTR, RTS, etc.) have changed states. Line states persist until they are cleared via a second - * notification. This should be called each time the CDC class driver's ControlLineStates.HostToDevice value is updated + * notification. This should be called each time the CDC class driver's \c ControlLineStates.HostToDevice value is updated * to push the new states to the USB device. * * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state. @@ -274,10 +274,10 @@ uint8_t CDC_Host_Flush(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); /** Creates a standard character stream for the given CDC Device instance so that it can be used with all the regular - * functions in the avr-libc <stdio.h> library that accept a FILE stream as a destination (e.g. fprintf). The created + * functions in the avr-libc \c <stdio.h> library that accept a FILE stream as a destination (e.g. fprintf). The created * stream is bidirectional and can be used for both input and output functions. * - * \note The created stream can be given as stdout if desired to direct the standard output from all <stdio.h> functions + * \note The created stream can be given as stdout if desired to direct the standard output from all \c <stdio.h> functions * to the given CDC interface. * * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state. @@ -299,7 +299,7 @@ * the host of a control line state change (containing the virtual serial control line states, such as DCD) and may be hooked in the * user program by declaring a handler function with the same name and parameters listed here. The new control line states * are available in the ControlLineStates.DeviceToHost value inside the CDC host interface structure passed as a parameter, set as - * a mask of CDC_CONTROL_LINE_IN_* masks. + * a mask of \c CDC_CONTROL_LINE_IN_* masks. * * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state. */ @@ -314,7 +314,7 @@ static int CDC_Host_getchar(FILE* Stream) ATTR_NON_NULL_PTR_ARG(1); static int CDC_Host_getchar_Blocking(FILE* Stream) ATTR_NON_NULL_PTR_ARG(1); - void CDC_Host_Event_Stub(void); + void CDC_Host_Event_Stub(void) ATTR_CONST; void EVENT_CDC_Host_ControLineStateChanged(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_WEAK ATTR_NON_NULL_PTR_ARG(1) ATTR_ALIAS(CDC_Host_Event_Stub); diff --git a/LUFA/Drivers/USB/Class/Host/HID.h b/LUFA/Drivers/USB/Class/Host/HID.h index 2cf4f5a89..f0b7a6245 100644 --- a/LUFA/Drivers/USB/Class/Host/HID.h +++ b/LUFA/Drivers/USB/Class/Host/HID.h @@ -83,7 +83,7 @@ /** \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 + * and passed to each of the HID class driver functions as the \c HIDInterfaceInfo parameter. This * stores each HID interface's configuration and state information. */ typedef struct @@ -104,7 +104,7 @@ HID_ReportInfo_t* HIDParserData; /**< HID parser data to store the parsed HID report data, when boot protocol * is not used. * - * \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, + * \note When the \c HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, * this method is unavailable. */ #endif @@ -196,7 +196,7 @@ * \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the * call will fail. * - * \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, this method is unavailable. + * \note When the \c HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, this method is unavailable. * * \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class host configuration and state. * \param[in] ReportID Report ID of the received report if ControlRequest is false, set by the to the Report ID to fetch. @@ -215,7 +215,7 @@ * \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the * call will fail. * - * \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, the ReportID parameter is removed + * \note When the \c HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, the ReportID parameter is removed * from the parameter list of this function. * * \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class host configuration and state. @@ -247,13 +247,13 @@ * * \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class host configuration and state. * - * \return Boolean true if a report has been received, false otherwise. + * \return Boolean \c true if a report has been received, \c false otherwise. */ bool HID_Host_IsReportReceived(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); /** Switches the attached HID device's reporting protocol over to the Boot Report protocol mode, on supported devices. * - * \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, this method must still be called + * \note When the \c HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, this method must still be called * to explicitly place the attached device into boot protocol mode before use. * * \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class host configuration and state. @@ -271,7 +271,7 @@ * Report Parser this function references <b>must</b> be implemented in the user code. * \n\n * - * \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, this method is unavailable. + * \note When the \c HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, this method is unavailable. * * \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class host configuration and state. * diff --git a/LUFA/Drivers/USB/Class/Host/HIDParser.h b/LUFA/Drivers/USB/Class/Host/HIDParser.h index 7c18c5af0..e5b4f9b5f 100644 --- a/LUFA/Drivers/USB/Class/Host/HIDParser.h +++ b/LUFA/Drivers/USB/Class/Host/HIDParser.h @@ -77,7 +77,7 @@ /** Constant indicating the maximum stack depth of the state table. A larger state table * allows for more PUSH/POP report items to be nested, but consumes more memory. By default * this is set to 2 levels (allowing non-nested PUSH items) but this can be overridden by - * defining HID_STATETABLE_STACK_DEPTH to another value in the user project makefile, passing the + * defining \c HID_STATETABLE_STACK_DEPTH to another value in the user project makefile, passing the * define to the compiler using the -D compiler switch. */ #define HID_STATETABLE_STACK_DEPTH 2 @@ -87,7 +87,7 @@ /** Constant indicating the maximum stack depth of the usage table. A larger usage table * allows for more USAGE items to be indicated sequentially for REPORT COUNT entries of more than * one, but requires more stack space. By default this is set to 8 levels (allowing for a report - * item with a count of 8) but this can be overridden by defining HID_USAGE_STACK_DEPTH to another + * item with a count of 8) but this can be overridden by defining \c HID_USAGE_STACK_DEPTH to another * value in the user project makefile, passing the define to the compiler using the -D compiler * switch. */ @@ -98,7 +98,7 @@ /** Constant indicating the maximum number of COLLECTION items (nested or unnested) that can be * processed in the report item descriptor. A large value allows for more COLLECTION items to be * processed, but consumes more memory. By default this is set to 10 collections, but this can be - * overridden by defining HID_MAX_COLLECTIONS to another value in the user project makefile, passing + * overridden by defining \c HID_MAX_COLLECTIONS to another value in the user project makefile, passing * the define to the compiler using the -D compiler switch. */ #define HID_MAX_COLLECTIONS 10 @@ -108,7 +108,7 @@ /** Constant indicating the maximum number of report items (IN, OUT or FEATURE) that can be processed * in the report item descriptor and stored in the user HID Report Info structure. A large value allows * for more report items to be stored, but consumes more memory. By default this is set to 20 items, - * but this can be overridden by defining HID_MAX_REPORTITEMS to another value in the user project + * but this can be overridden by defining \c HID_MAX_REPORTITEMS to another value in the user project * makefile, and passing the define to the compiler using the -D compiler switch. */ #define HID_MAX_REPORTITEMS 20 @@ -118,7 +118,7 @@ /** Constant indicating the maximum number of unique report IDs that can be processed in the report item * descriptor for the report size information array in the user HID Report Info structure. A large value * allows for more report ID report sizes to be stored, but consumes more memory. By default this is set - * to 10 items, but this can be overridden by defining HID_MAX_REPORT_IDS to another value in the user project + * to 10 items, but this can be overridden by defining \c HID_MAX_REPORT_IDS to another value in the user project * makefile, and passing the define to the compiler using the -D compiler switch. Note that IN, OUT and FEATURE * items sharing the same report ID consume only one size item in the array. */ @@ -192,7 +192,7 @@ { uint8_t Type; /**< Collection type (e.g. "Generic Desktop"). */ HID_Usage_t Usage; /**< Collection usage. */ - struct CollectionPath* Parent; /**< Reference to parent collection, or NULL if root collection. */ + struct CollectionPath* Parent; /**< Reference to parent collection, or \c NULL if root collection. */ } HID_CollectionPath_t; /** \brief HID Parser Report Item Attributes Structure. @@ -216,7 +216,7 @@ typedef struct { uint16_t BitOffset; /**< Bit offset in the IN, OUT or FEATURE report of the item. */ - uint8_t ItemType; /**< Report item type, a value in HID_ReportItemTypes_t. */ + uint8_t ItemType; /**< Report item type, a value in \ref HID_ReportItemTypes_t. */ uint16_t ItemFlags; /**< Item data flags, such as constant/variable, etc. */ uint8_t ReportID; /**< Report ID this item belongs to, or 0x00 if device has only one report */ HID_CollectionPath_t* CollectionPath; /**< Collection path of the item. */ @@ -248,7 +248,7 @@ typedef struct { uint8_t TotalReportItems; /**< Total number of report items stored in the - * ReportItems array. + * \c ReportItems array. */ HID_ReportItem_t ReportItems[HID_MAX_REPORTITEMS]; /**< Report items array, including * all IN, OUT and FEATURE items. @@ -289,7 +289,7 @@ * \param[in] ReportData Buffer containing an IN or FEATURE report from an attached device. * \param[in,out] ReportItem Pointer to the report item of interest in a \ref HID_ReportInfo_t ReportItem array. * - * \returns Boolean true if the item to retrieve was located in the given report, false otherwise. + * \returns Boolean \c true if the item to retrieve was located in the given report, \c false otherwise. */ bool USB_GetHIDReportItemInfo(const uint8_t* ReportData, HID_ReportItem_t* const ReportItem) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2); @@ -325,12 +325,13 @@ /** Callback routine for the HID Report Parser. This callback <b>must</b> be implemented by the user code when * the parser is used, to determine what report IN, OUT and FEATURE item's information is stored into the user - * HID_ReportInfo_t structure. This can be used to filter only those items the application will be using, so that + * \ref HID_ReportInfo_t structure. This can be used to filter only those items the application will be using, so that * no RAM is wasted storing the attributes for report items which will never be referenced by the application. * * \param[in] CurrentItem Pointer to the current report item for user checking. * - * \return Boolean true if the item should be stored into the HID_ReportInfo_t structure, false if it should be ignored. + * \return Boolean \c true if the item should be stored into the \ref HID_ReportInfo_t structure, \c false if + * it should be ignored. */ bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_t* const CurrentItem); diff --git a/LUFA/Drivers/USB/Class/Host/MIDI.h b/LUFA/Drivers/USB/Class/Host/MIDI.h index 5cd6df703..19107779f 100644 --- a/LUFA/Drivers/USB/Class/Host/MIDI.h +++ b/LUFA/Drivers/USB/Class/Host/MIDI.h @@ -76,7 +76,7 @@ /** \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 + * and passed to each of the MIDI class driver functions as the \c MIDIInterfaceInfo parameter. This * stores each MIDI interface's configuration and state information. */ typedef struct @@ -177,7 +177,7 @@ * \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state. * \param[out] Event Pointer to a USB_MIDI_EventPacket_t structure where the received MIDI event is to be placed. * - * \return Boolean true if a MIDI event packet was received, false otherwise. + * \return Boolean \c true if a MIDI event packet was received, \c false otherwise. */ bool MIDI_Host_ReceiveEventPacket(USB_ClassInfo_MIDI_Host_t* const MIDIInterfaceInfo, MIDI_EventPacket_t* const Event) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2); diff --git a/LUFA/Drivers/USB/Class/Host/MassStorage.h b/LUFA/Drivers/USB/Class/Host/MassStorage.h index 1dc8355f3..bab20540e 100644 --- a/LUFA/Drivers/USB/Class/Host/MassStorage.h +++ b/LUFA/Drivers/USB/Class/Host/MassStorage.h @@ -80,7 +80,7 @@ /** \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 + * and passed to each of the Mass Storage class driver functions as the \c MSInterfaceInfo parameter. This * stores each Mass Storage interface's configuration and state information. */ typedef struct @@ -248,7 +248,7 @@ * * \param[in,out] MSInterfaceInfo Pointer to a structure containing a MS Class host configuration and state. * \param[in] LUNIndex LUN index within the device the command is being issued to. - * \param[in] PreventRemoval Boolean true if the device should be locked from removal, false otherwise. + * \param[in] PreventRemoval Boolean \c true if the device should be locked from removal, \c false otherwise. * * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or \ref MS_ERROR_LOGICAL_CMD_FAILED if not ready. */ diff --git a/LUFA/Drivers/USB/Class/Host/Printer.h b/LUFA/Drivers/USB/Class/Host/Printer.h index 96fbbbde0..8d0142763 100644 --- a/LUFA/Drivers/USB/Class/Host/Printer.h +++ b/LUFA/Drivers/USB/Class/Host/Printer.h @@ -76,7 +76,7 @@ /** \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 + * and passed to each of the Printer class driver functions as the \c PRNTInterfaceInfo parameter. This * stores each Printer interface's configuration and state information. */ typedef struct @@ -156,7 +156,7 @@ uint8_t PRNT_Host_SetBidirectionalMode(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); /** Retrieves the status of the virtual Printer port's inbound status lines. The result can then be masked against the - * PRNT_PORTSTATUS_* macros to determine the printer port's status. + * \c PRNT_PORTSTATUS_* macros to determine the printer port's status. * * \param[in,out] PRNTInterfaceInfo Pointer to a structure containing a Printer Class host configuration and state. * \param[out] PortStatus Location where the retrieved port status should be stored. diff --git a/LUFA/Drivers/USB/Class/Host/RNDIS.h b/LUFA/Drivers/USB/Class/Host/RNDIS.h index 3b3880daa..5587ebf7f 100644 --- a/LUFA/Drivers/USB/Class/Host/RNDIS.h +++ b/LUFA/Drivers/USB/Class/Host/RNDIS.h @@ -80,7 +80,7 @@ /** \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 + * and passed to each of the RNDIS class driver functions as the \c RNDISInterfaceInfo parameter. This * stores each RNDIS interface's configuration and state information. */ typedef struct @@ -213,7 +213,7 @@ * * \param[in,out] RNDISInterfaceInfo Pointer to a structure containing an RNDIS Class host configuration and state. * - * \return Boolean true if a packet is waiting to be read in by the host, false otherwise. + * \return Boolean \c true if a packet is waiting to be read in by the host, \c false otherwise. */ bool RNDIS_Host_IsPacketReceived(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); diff --git a/LUFA/Drivers/USB/Class/Host/StillImage.h b/LUFA/Drivers/USB/Class/Host/StillImage.h index ed01b7a5d..f64de383d 100644 --- a/LUFA/Drivers/USB/Class/Host/StillImage.h +++ b/LUFA/Drivers/USB/Class/Host/StillImage.h @@ -80,7 +80,7 @@ /** \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 + * and passed to each of the Still Image class driver functions as the \c SIInterfaceInfo parameter. This * stores each Still Image interface's configuration and state information. */ typedef struct @@ -245,7 +245,7 @@ * * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state. * - * \return Boolean true if an event is waiting to be read, false otherwise. + * \return Boolean \c true if an event is waiting to be read, \c false otherwise. */ bool SI_Host_IsEventReceived(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); |