Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
Erik Strand
lufa
Commits
328ed71c
Commit
328ed71c
authored
May 29, 2010
by
Dean Camera
Browse files
Fix spacing of the function parameter descriptions in the Doxygen documentation.
parent
c1daecf1
Changes
21
Hide whitespace changes
Inline
Side-by-side
LUFA/Common/Common.h
View file @
328ed71c
...
@@ -118,7 +118,7 @@
...
@@ -118,7 +118,7 @@
*
*
* \ingroup Group_BitManip
* \ingroup Group_BitManip
*
*
* \param[in] Byte
Byte of data whose bits are to be reversed
* \param[in] Byte Byte of data whose bits are to be reversed
*/
*/
static
inline
uint8_t
BitReverse
(
uint8_t
Byte
)
ATTR_WARN_UNUSED_RESULT
ATTR_CONST
;
static
inline
uint8_t
BitReverse
(
uint8_t
Byte
)
ATTR_WARN_UNUSED_RESULT
ATTR_CONST
;
static
inline
uint8_t
BitReverse
(
uint8_t
Byte
)
static
inline
uint8_t
BitReverse
(
uint8_t
Byte
)
...
@@ -134,7 +134,7 @@
...
@@ -134,7 +134,7 @@
*
*
* \ingroup Group_BitManip
* \ingroup Group_BitManip
*
*
* \param[in] Word
Word of data whose bytes are to be swapped
* \param[in] Word Word of data whose bytes are to be swapped
*/
*/
static
inline
uint16_t
SwapEndian_16
(
uint16_t
Word
)
ATTR_WARN_UNUSED_RESULT
ATTR_CONST
;
static
inline
uint16_t
SwapEndian_16
(
uint16_t
Word
)
ATTR_WARN_UNUSED_RESULT
ATTR_CONST
;
static
inline
uint16_t
SwapEndian_16
(
uint16_t
Word
)
static
inline
uint16_t
SwapEndian_16
(
uint16_t
Word
)
...
@@ -146,7 +146,7 @@
...
@@ -146,7 +146,7 @@
*
*
* \ingroup Group_BitManip
* \ingroup Group_BitManip
*
*
* \param[in] DWord
Double word of data whose bytes are to be swapped
* \param[in] DWord Double word of data whose bytes are to be swapped
*/
*/
static
inline
uint32_t
SwapEndian_32
(
uint32_t
DWord
)
ATTR_WARN_UNUSED_RESULT
ATTR_CONST
;
static
inline
uint32_t
SwapEndian_32
(
uint32_t
DWord
)
ATTR_WARN_UNUSED_RESULT
ATTR_CONST
;
static
inline
uint32_t
SwapEndian_32
(
uint32_t
DWord
)
static
inline
uint32_t
SwapEndian_32
(
uint32_t
DWord
)
...
@@ -161,8 +161,8 @@
...
@@ -161,8 +161,8 @@
*
*
* \ingroup Group_BitManip
* \ingroup Group_BitManip
*
*
* \param[in,out] Data Pointer to a number containing an even number of bytes to be reversed
* \param[in,out] Data
Pointer to a number containing an even number of bytes to be reversed
* \param[in] Bytes Length of the data in bytes
* \param[in]
Bytes Length of the data in bytes
*/
*/
static
inline
void
SwapEndian_n
(
void
*
Data
,
uint8_t
Bytes
);
static
inline
void
SwapEndian_n
(
void
*
Data
,
uint8_t
Bytes
);
static
inline
void
SwapEndian_n
(
void
*
Data
,
uint8_t
Bytes
)
static
inline
void
SwapEndian_n
(
void
*
Data
,
uint8_t
Bytes
)
...
...
LUFA/Drivers/Board/LEDs.h
View file @
328ed71c
...
@@ -167,7 +167,7 @@
...
@@ -167,7 +167,7 @@
/** Toggles all LEDs in the LED mask, leaving all others in their current states.
/** Toggles all LEDs in the LED mask, leaving all others in their current states.
*
*
* \param[in] LEDMask Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file)
* \param[in] LEDMask
Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file)
*/
*/
static
inline
void
LEDs_ToggleLEDs
(
const
uint8_t
LEDMask
);
static
inline
void
LEDs_ToggleLEDs
(
const
uint8_t
LEDMask
);
...
...
LUFA/Drivers/Peripheral/AVRU4U6U7/TWI.h
View file @
328ed71c
...
@@ -110,7 +110,7 @@
...
@@ -110,7 +110,7 @@
/** Receives a byte from the currently addressed device on the TWI bus.
/** Receives a byte from the currently addressed device on the TWI bus.
*
*
* \param[in] Byte Location where the read byte is to be stored
* \param[in] Byte
Location where the read byte is to be stored
* \param[in] LastByte Indicates if the byte should be ACKed if false, NAKed if true
* \param[in] LastByte Indicates if the byte should be ACKed if false, NAKed if true
*
*
* \return Boolean true if the byte reception sucessfully completed, false otherwise
* \return Boolean true if the byte reception sucessfully completed, false otherwise
...
...
LUFA/Drivers/Peripheral/SPI.h
View file @
328ed71c
...
@@ -153,7 +153,7 @@
...
@@ -153,7 +153,7 @@
/** Sends a byte through the SPI interface, blocking until the transfer is complete. The response
/** Sends a byte through the SPI interface, blocking until the transfer is complete. The response
* byte sent to from the attached SPI device is ignored.
* byte sent to from the attached SPI device is ignored.
*
*
* \param[in] Byte Byte to send through the SPI interface
* \param[in] Byte
Byte to send through the SPI interface
*/
*/
static
inline
void
SPI_SendByte
(
const
uint8_t
Byte
)
ATTR_ALWAYS_INLINE
;
static
inline
void
SPI_SendByte
(
const
uint8_t
Byte
)
ATTR_ALWAYS_INLINE
;
static
inline
void
SPI_SendByte
(
const
uint8_t
Byte
)
static
inline
void
SPI_SendByte
(
const
uint8_t
Byte
)
...
...
LUFA/Drivers/USB/Class/Device/CDC.h
View file @
328ed71c
...
@@ -206,9 +206,9 @@
...
@@ -206,9 +206,9 @@
* \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or
* \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or
* the call will fail.
* the call will fail.
*
*
* \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state
* \param[in,out]
CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state
* \param[in]
Data
Pointer to the string to send to the host
* \param[in]
Data
Pointer to the string to send to the host
* \param[in]
Length
Size in bytes of the string to send to the host
* \param[in]
Length
Size in bytes of the string to send to the host
*
*
* \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum
* \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum
*/
*/
...
@@ -224,7 +224,7 @@
...
@@ -224,7 +224,7 @@
* the call will fail.
* the call will fail.
*
*
* \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state
* \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state
* \param[in]
Data
Byte of data to send to the host
* \param[in]
Data
Byte of data to send to the host
*
*
* \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum
* \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum
*/
*/
...
@@ -290,7 +290,7 @@
...
@@ -290,7 +290,7 @@
* to the given CDC interface.
* to the given CDC interface.
*
*
* \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state
* \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state
* \param[in,out] Stream Pointer to a FILE structure where the created stream should be placed
* \param[in,out] Stream
Pointer to a FILE structure where the created stream should be placed
*/
*/
void
CDC_Device_CreateStream
(
USB_ClassInfo_CDC_Device_t
*
CDCInterfaceInfo
,
FILE
*
Stream
);
void
CDC_Device_CreateStream
(
USB_ClassInfo_CDC_Device_t
*
CDCInterfaceInfo
,
FILE
*
Stream
);
...
@@ -298,7 +298,7 @@
...
@@ -298,7 +298,7 @@
* the transfer. While blocking, the USB and CDC service tasks are called repeatedly to maintain USB communications.
* the transfer. While blocking, the USB and CDC service tasks are called repeatedly to maintain USB communications.
*
*
* \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state
* \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state
* \param[in,out] Stream Pointer to a FILE structure where the created stream should be placed
* \param[in,out] Stream
Pointer to a FILE structure where the created stream should be placed
*/
*/
void
CDC_Device_CreateBlockingStream
(
USB_ClassInfo_CDC_Device_t
*
CDCInterfaceInfo
,
FILE
*
Stream
);
void
CDC_Device_CreateBlockingStream
(
USB_ClassInfo_CDC_Device_t
*
CDCInterfaceInfo
,
FILE
*
Stream
);
...
...
LUFA/Drivers/USB/Class/Device/HID.h
View file @
328ed71c
...
@@ -153,12 +153,12 @@
...
@@ -153,12 +153,12 @@
* user is responsible for the creation of the next HID input report to be sent to the host.
* user is responsible for the creation of the next HID input report to be sent to the host.
*
*
* \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class configuration and state
* \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class configuration and state
* \param[in,out] ReportID If preset to a non-zero value, this is the report ID being requested by the host. If zero,
this should
* \param[in,out] ReportID
If preset to a non-zero value, this is the report ID being requested by the host. If zero,
* be set to the report ID of the generated HID input report (if any). If multiple
reports are not sent via the
*
this should
be set to the report ID of the generated HID input report (if any). If multiple
* given HID interface, this parameter should be ignored.
*
reports are not sent via the
given HID interface, this parameter should be ignored.
* \param[in] ReportType Type of HID report to generate, either \ref REPORT_ITEM_TYPE_In or \ref REPORT_ITEM_TYPE_Feature
* \param[in]
ReportType
Type of HID report to generate, either \ref REPORT_ITEM_TYPE_In or \ref REPORT_ITEM_TYPE_Feature
* \param[out] ReportData Pointer to a buffer where the generated HID report should be stored
* \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
* \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
* \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
* the idle period (useful for devices which report relative movement), false otherwise
...
@@ -172,11 +172,11 @@
...
@@ -172,11 +172,11 @@
* the user is responsible for the processing of the received HID output report from the host.
* the user is responsible for the processing of the received HID output report from the host.
*
*
* \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class configuration and state
* \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class configuration and state
* \param[in] ReportID Report ID of the received output report. If multiple reports are not received via the given HID
* \param[in]
ReportID
Report ID of the received output report. If multiple reports are not received via the given HID
* interface, this parameter should be ignored.
*
interface, this parameter should be ignored.
* \param[in] ReportType Type of received HID report, either \ref REPORT_ITEM_TYPE_Out or \ref REPORT_ITEM_TYPE_Feature
* \param[in]
ReportType
Type of received HID report, either \ref REPORT_ITEM_TYPE_Out or \ref REPORT_ITEM_TYPE_Feature
* \param[in] ReportData Pointer to a buffer where the received HID report is stored.
* \param[in]
ReportData
Pointer to a buffer where the received HID report is stored.
* \param[in] ReportSize Size in bytes of the received report from the host.
* \param[in]
ReportSize
Size in bytes of the received report from the host.
*/
*/
void
CALLBACK_HID_Device_ProcessHIDReport
(
USB_ClassInfo_HID_Device_t
*
const
HIDInterfaceInfo
,
const
uint8_t
ReportID
,
void
CALLBACK_HID_Device_ProcessHIDReport
(
USB_ClassInfo_HID_Device_t
*
const
HIDInterfaceInfo
,
const
uint8_t
ReportID
,
const
uint8_t
ReportType
,
const
void
*
ReportData
,
const
uint16_t
ReportSize
)
ATTR_NON_NULL_PTR_ARG
(
1
)
const
uint8_t
ReportType
,
const
void
*
ReportData
,
const
uint16_t
ReportSize
)
ATTR_NON_NULL_PTR_ARG
(
1
)
...
...
LUFA/Drivers/USB/Class/Device/MIDI.h
View file @
328ed71c
...
@@ -120,7 +120,7 @@
...
@@ -120,7 +120,7 @@
* the call will fail.
* the call will fail.
*
*
* \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state
* \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state
* \param[in] Event Pointer to a populated USB_MIDI_EventPacket_t structure containing the MIDI event to send
* \param[in]
Event
Pointer to a populated USB_MIDI_EventPacket_t structure containing the MIDI event to send
*
*
* \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum
* \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum
*/
*/
...
@@ -144,7 +144,7 @@
...
@@ -144,7 +144,7 @@
* the call will fail.
* the call will fail.
*
*
* \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state
* \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
* \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 true if a MIDI event packet was received, false otherwise
*/
*/
...
...
LUFA/Drivers/USB/Class/Host/CDC.h
View file @
328ed71c
...
@@ -161,9 +161,9 @@
...
@@ -161,9 +161,9 @@
* This should be called once after the stack has enumerated the attached device, while the host state machine is in
* This should be called once after the stack has enumerated the attached device, while the host state machine is in
* the Addressed state.
* the Addressed state.
*
*
* \param[in,out] CDCInterfaceInfo Pointer to a structure containing an CDC Class host configuration and state
* \param[in,out] CDCInterfaceInfo
Pointer to a structure containing an CDC Class host configuration and state
* \param[in] ConfigDescriptorSize Length of the attached device's Configuration Descriptor
* \param[in]
ConfigDescriptorSize
Length of the attached device's Configuration Descriptor
* \param[in] DeviceConfigDescriptor Pointer to a buffer containing the attached device's Configuration Descriptor
* \param[in]
DeviceConfigDescriptor Pointer to a buffer containing the attached device's Configuration Descriptor
*
*
* \return A value from the \ref CDCHost_EnumerationFailure_ErrorCodes_t enum
* \return A value from the \ref CDCHost_EnumerationFailure_ErrorCodes_t enum
*/
*/
...
@@ -209,8 +209,8 @@
...
@@ -209,8 +209,8 @@
* call will fail.
* call will fail.
*
*
* \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state
* \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state
* \param[in]
Data
Pointer to the string to send to the device
* \param[in]
Data
Pointer to the string to send to the device
* \param[in] Length Size in bytes of the string to send to the device
* \param[in]
Length
Size in bytes of the string to send to the device
*
*
* \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum
* \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum
*/
*/
...
@@ -226,7 +226,7 @@
...
@@ -226,7 +226,7 @@
* call will fail.
* call will fail.
*
*
* \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state
* \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state
* \param[in]
Data
Byte of data to send to the device
* \param[in]
Data
Byte of data to send to the device
*
*
* \return A value from the \ref Pipe_WaitUntilReady_ErrorCodes_t enum
* \return A value from the \ref Pipe_WaitUntilReady_ErrorCodes_t enum
*/
*/
...
@@ -275,7 +275,7 @@
...
@@ -275,7 +275,7 @@
* to the given CDC interface.
* to the given CDC interface.
*
*
* \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state
* \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state
* \param[in,out] Stream Pointer to a FILE structure where the created stream should be placed
* \param[in,out] Stream
Pointer to a FILE structure where the created stream should be placed
*/
*/
void
CDC_Host_CreateStream
(
USB_ClassInfo_CDC_Host_t
*
CDCInterfaceInfo
,
FILE
*
Stream
);
void
CDC_Host_CreateStream
(
USB_ClassInfo_CDC_Host_t
*
CDCInterfaceInfo
,
FILE
*
Stream
);
...
@@ -283,7 +283,7 @@
...
@@ -283,7 +283,7 @@
* the transfer. While blocking, the USB and CDC service tasks are called repeatedly to maintain USB communications.
* the transfer. While blocking, the USB and CDC service tasks are called repeatedly to maintain USB communications.
*
*
* \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state
* \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state
* \param[in,out] Stream Pointer to a FILE structure where the created stream should be placed
* \param[in,out] Stream
Pointer to a FILE structure where the created stream should be placed
*/
*/
void
CDC_Host_CreateBlockingStream
(
USB_ClassInfo_CDC_Host_t
*
CDCInterfaceInfo
,
FILE
*
Stream
);
void
CDC_Host_CreateBlockingStream
(
USB_ClassInfo_CDC_Host_t
*
CDCInterfaceInfo
,
FILE
*
Stream
);
...
...
LUFA/Drivers/USB/Class/Host/HID.h
View file @
328ed71c
...
@@ -155,9 +155,9 @@
...
@@ -155,9 +155,9 @@
* \note Once the device pipes are configured, the HID device's reporting protocol <b>must</b> be set via a call
* \note Once the device pipes are configured, the HID device's reporting protocol <b>must</b> be set via a call
* to either the \ref HID_Host_SetBootProtocol() or \ref HID_Host_SetReportProtocol() function.
* to either the \ref HID_Host_SetBootProtocol() or \ref HID_Host_SetReportProtocol() function.
*
*
* \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class host configuration and state
* \param[in,out] HIDInterfaceInfo
Pointer to a structure containing a HID Class host configuration and state
* \param[in] ConfigDescriptorSize Length of the attached device's Configuration Descriptor
* \param[in]
ConfigDescriptorSize
Length of the attached device's Configuration Descriptor
* \param[in] DeviceConfigDescriptor Pointer to a buffer containing the attached device's Configuration Descriptor
* \param[in]
DeviceConfigDescriptor Pointer to a buffer containing the attached device's Configuration Descriptor
*
*
* \return A value from the \ref HIDHost_EnumerationFailure_ErrorCodes_t enum
* \return A value from the \ref HIDHost_EnumerationFailure_ErrorCodes_t enum
*/
*/
...
@@ -175,7 +175,7 @@
...
@@ -175,7 +175,7 @@
* can generate.
* can generate.
*
*
* \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class host configuration and state
* \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class host configuration and state
* \param[in] Buffer Buffer to store the received report into
* \param[in]
Buffer
Buffer to store the received report into
*
*
* \return An error code from the \ref Pipe_Stream_RW_ErrorCodes_t enum
* \return An error code from the \ref Pipe_Stream_RW_ErrorCodes_t enum
*/
*/
...
@@ -192,8 +192,8 @@
...
@@ -192,8 +192,8 @@
* \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, this method is unavailable.
* \note When the 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,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
* \param[in]
ReportID
Report ID of the received report if ControlRequest is false, set by the to the Report ID to fetch
* \param[in] Buffer Buffer to store the received report into
* \param[in]
Buffer
Buffer to store the received report into
*
*
* \return A value from the \ref USB_Host_SendControlErrorCodes_t enum
* \return A value from the \ref USB_Host_SendControlErrorCodes_t enum
*/
*/
...
@@ -212,10 +212,10 @@
...
@@ -212,10 +212,10 @@
* from the parameter list of this function.
* from the parameter list of this function.
*
*
* \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class host configuration and state
* \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class host configuration and state
* \param[in] ReportID Report ID of the report to send to the device, or 0 if the device does not use report IDs
* \param[in]
ReportID
Report ID of the report to send to the device, or 0 if the device does not use report IDs
* \param[in] ReportType Type of report to issue to the device, either \ref REPORT_ITEM_TYPE_Out or \ref REPORT_ITEM_TYPE_Feature
* \param[in]
ReportType
Type of report to issue to the device, either \ref REPORT_ITEM_TYPE_Out or \ref REPORT_ITEM_TYPE_Feature
* \param[in] Buffer Buffer containing the report to send to the attached device
* \param[in]
Buffer
Buffer containing the report to send to the attached device
* \param[in] ReportSize Report size in bytes to send to the attached device
* \param[in]
ReportSize
Report size in bytes to send to the attached device
*
*
* \return An error code from the \ref USB_Host_SendControlErrorCodes_t enum if the DeviceUsesOUTPipe flag is set in
* \return An error code from the \ref USB_Host_SendControlErrorCodes_t enum if the DeviceUsesOUTPipe flag is set in
* the interface's state structure, a value from the \ref Pipe_Stream_RW_ErrorCodes_t enum otherwise
* the interface's state structure, a value from the \ref Pipe_Stream_RW_ErrorCodes_t enum otherwise
...
...
LUFA/Drivers/USB/Class/Host/HIDParser.h
View file @
328ed71c
...
@@ -134,7 +134,7 @@
...
@@ -134,7 +134,7 @@
* leftwards until the data's sign bit is in the correct position.
* leftwards until the data's sign bit is in the correct position.
*
*
* \param[in] reportitem HID Report Item whose retrieved value is to be aligned
* \param[in] reportitem HID Report Item whose retrieved value is to be aligned
* \param[in] type Data type to align the HID report item's value to
* \param[in] type
Data type to align the HID report item's value to
*
*
* \return Left-aligned data of the given report item's pre-retrived value for the given datatype
* \return Left-aligned data of the given report item's pre-retrived value for the given datatype
*/
*/
...
@@ -272,8 +272,8 @@
...
@@ -272,8 +272,8 @@
/** Function to process a given HID report returned from an attached device, and store it into a given
/** Function to process a given HID report returned from an attached device, and store it into a given
* \ref HID_ReportInfo_t structure.
* \ref HID_ReportInfo_t structure.
*
*
* \param[in] ReportData Buffer containing the device's HID report table
* \param[in]
ReportData Buffer containing the device's HID report table
* \param[in] ReportSize Size in bytes of the HID report table
* \param[in]
ReportSize Size in bytes of the HID report table
* \param[out] ParserData Pointer to a \ref HID_ReportInfo_t instance for the parser output
* \param[out] ParserData Pointer to a \ref HID_ReportInfo_t instance for the parser output
*
*
* \return A value in the \ref HID_Parse_ErrorCodes_t enum
* \return A value in the \ref HID_Parse_ErrorCodes_t enum
...
@@ -287,7 +287,7 @@
...
@@ -287,7 +287,7 @@
* When called, this copies the report item's Value element to it's PreviousValue element for easy
* When called, this copies the report item's Value element to it's PreviousValue element for easy
* checking to see if an item's value has changed before processing a report.
* checking to see if an item's value has changed before processing a report.
*
*
* \param[in] ReportData Buffer containing an IN or FEATURE report from an attached device
* \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
* \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 true if the item to retrieve was located in the given report, false otherwise
...
@@ -306,7 +306,7 @@
...
@@ -306,7 +306,7 @@
* If the device has multiple HID reports, the first byte in the report is set to the report ID of the given item.
* If the device has multiple HID reports, the first byte in the report is set to the report ID of the given item.
*
*
* \param[out] ReportData Buffer holding the current OUT or FEATURE report data
* \param[out] ReportData Buffer holding the current OUT or FEATURE report data
* \param[in] ReportItem Pointer to the report item of interest in a \ref HID_ReportInfo_t ReportItem array
* \param[in]
ReportItem Pointer to the report item of interest in a \ref HID_ReportInfo_t ReportItem array
*/
*/
void
USB_SetHIDReportItemInfo
(
uint8_t
*
ReportData
,
HID_ReportItem_t
*
const
ReportItem
)
void
USB_SetHIDReportItemInfo
(
uint8_t
*
ReportData
,
HID_ReportItem_t
*
const
ReportItem
)
ATTR_NON_NULL_PTR_ARG
(
1
)
ATTR_NON_NULL_PTR_ARG
(
2
);
ATTR_NON_NULL_PTR_ARG
(
1
)
ATTR_NON_NULL_PTR_ARG
(
2
);
...
@@ -314,7 +314,7 @@
...
@@ -314,7 +314,7 @@
/** Retrieves the size of a given HID report in bytes from it's Report ID.
/** Retrieves the size of a given HID report in bytes from it's Report ID.
*
*
* \param[in] ParserData Pointer to a \ref HID_ReportInfo_t instance containing the parser output
* \param[in] ParserData Pointer to a \ref HID_ReportInfo_t instance containing the parser output
* \param[in] ReportID Report ID of the report whose size is to be retrieved
* \param[in] ReportID
Report ID of the report whose size is to be retrieved
* \param[in] ReportType Type of the report whose size is to be determined, a valued from the
* \param[in] ReportType Type of the report whose size is to be determined, a valued from the
* \ref HID_ReportItemTypes_t enum
* \ref HID_ReportItemTypes_t enum
*
*
...
...
LUFA/Drivers/USB/Class/Host/MIDI.h
View file @
328ed71c
...
@@ -119,9 +119,9 @@
...
@@ -119,9 +119,9 @@
* This should be called once after the stack has enumerated the attached device, while the host state machine is in
* This should be called once after the stack has enumerated the attached device, while the host state machine is in
* the Addressed state.
* the Addressed state.
*
*
* \param[in,out] MIDIInterfaceInfo Pointer to a structure containing an MIDI Class host configuration and state
* \param[in,out] MIDIInterfaceInfo
Pointer to a structure containing an MIDI Class host configuration and state
* \param[in] ConfigDescriptorSize Length of the attached device's Configuration Descriptor
* \param[in]
ConfigDescriptorSize
Length of the attached device's Configuration Descriptor
* \param[in] DeviceConfigDescriptor Pointer to a buffer containing the attached device's Configuration Descriptor
* \param[in]
DeviceConfigDescriptor Pointer to a buffer containing the attached device's Configuration Descriptor
*
*
* \return A value from the \ref MIDIHost_EnumerationFailure_ErrorCodes_t enum
* \return A value from the \ref MIDIHost_EnumerationFailure_ErrorCodes_t enum
*/
*/
...
@@ -134,7 +134,7 @@
...
@@ -134,7 +134,7 @@
* call will fail.
* call will fail.
*
*
* \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state
* \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state
* \param[in] Event Pointer to a populated USB_MIDI_EventPacket_t structure containing the MIDI event to send
* \param[in]
Event
Pointer to a populated USB_MIDI_EventPacket_t structure containing the MIDI event to send
*
*
* \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum
* \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum
*/
*/
...
@@ -158,7 +158,7 @@
...
@@ -158,7 +158,7 @@
* call will fail.
* call will fail.
*
*
* \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state
* \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
* \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 true if a MIDI event packet was received, false otherwise
*/
*/
...
...
LUFA/Drivers/USB/Class/Host/MassStorage.h
View file @
328ed71c
...
@@ -137,9 +137,9 @@
...
@@ -137,9 +137,9 @@
* is found within the device. This should be called once after the stack has enumerated the attached device, while
* is found within the device. This should be called once after the stack has enumerated the attached device, while
* the host state machine is in the Addressed state.
* the host state machine is in the Addressed state.
*
*
* \param[in,out] MSInterfaceInfo Pointer to a structure containing an MS Class host configuration and state
* \param[in,out] MSInterfaceInfo
Pointer to a structure containing an MS Class host configuration and state
* \param[in] ConfigDescriptorSize Length of the attached device's Configuration Descriptor
* \param[in]
ConfigDescriptorSize
Length of the attached device's Configuration Descriptor
* \param[in] DeviceConfigDescriptor Pointer to a buffer containing the attached device's Configuration Descriptor
* \param[in]
DeviceConfigDescriptor Pointer to a buffer containing the attached device's Configuration Descriptor
*
*
* \return A value from the \ref MSHost_EnumerationFailure_ErrorCodes_t enum
* \return A value from the \ref MSHost_EnumerationFailure_ErrorCodes_t enum
*/
*/
...
@@ -164,7 +164,7 @@
...
@@ -164,7 +164,7 @@
* if the device STALLs the request.
* if the device STALLs the request.
*
*
* \param[in,out] MSInterfaceInfo Pointer to a structure containing a MS Class host configuration and state
* \param[in,out] MSInterfaceInfo Pointer to a structure containing a MS Class host configuration and state
* \param[out] MaxLUNIndex Pointer to a location where the highest LUN index value should be stored
* \param[out]
MaxLUNIndex
Pointer to a location where the highest LUN index value should be stored
*
*
* \return A value from the \ref USB_Host_SendControlErrorCodes_t enum
* \return A value from the \ref USB_Host_SendControlErrorCodes_t enum
*/
*/
...
@@ -178,8 +178,8 @@
...
@@ -178,8 +178,8 @@
* call will fail.
* call will fail.
*
*
* \param[in,out] MSInterfaceInfo Pointer to a structure containing a MS Class host configuration and state
* \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]
LUNIndex
LUN index within the device the command is being issued to
* \param[out] InquiryData Location where the read inquiry data should be stored
* \param[out]
InquiryData
Location where the read inquiry data should be stored
*
*
* \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED
* \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED
*/
*/
...
@@ -190,7 +190,7 @@
...
@@ -190,7 +190,7 @@
/** Sends a TEST UNIT READY command to the device, to determine if it is ready to accept other SCSI commands.
/** Sends a TEST UNIT READY command to the device, to determine if it is ready to accept other SCSI commands.
*
*
* \param[in,out] MSInterfaceInfo Pointer to a structure containing a MS Class host configuration and state
* \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]
LUNIndex
LUN index within the device the command is being issued to
*
*
* \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
* \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
*/
*/
...
@@ -203,8 +203,8 @@
...
@@ -203,8 +203,8 @@
* call will fail.
* call will fail.
*
*
* \param[in,out] MSInterfaceInfo Pointer to a structure containing a MS Class host configuration and state
* \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]
LUNIndex
LUN index within the device the command is being issued to
* \param[out] DeviceCapacity Pointer to the location where the capacity information should be stored
* \param[out]
DeviceCapacity
Pointer to the location where the capacity information should be stored
*
*
* \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
* \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
*/
*/
...
@@ -219,8 +219,8 @@
...
@@ -219,8 +219,8 @@
* call will fail.
* call will fail.
*
*
* \param[in,out] MSInterfaceInfo Pointer to a structure containing a MS Class host configuration and state
* \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]
LUNIndex
LUN index within the device the command is being issued to
* \param[out] SenseData Pointer to the location where the sense information should be stored
* \param[out]
SenseData
Pointer to the location where the sense information should be stored
*
*
* \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
* \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
*/
*/
...
@@ -235,8 +235,8 @@
...
@@ -235,8 +235,8 @@
* call will fail.
* call will fail.
*
*
* \param[in,out] MSInterfaceInfo Pointer to a structure containing a MS Class host configuration and state
* \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]
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 true if the device should be locked from removal, false otherwise
*
*
* \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
* \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
*/
*/
...
@@ -249,11 +249,11 @@
...
@@ -249,11 +249,11 @@
* call will fail.
* call will fail.
*
*
* \param[in,out] MSInterfaceInfo Pointer to a structure containing a MS Class host configuration and state
* \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]
LUNIndex
LUN index within the device the command is being issued to
* \param[in] BlockAddress Starting block address within the device to read from
* \param[in]
BlockAddress
Starting block address within the device to read from
* \param[in] Blocks Total number of blocks to read
* \param[in]
Blocks
Total number of blocks to read
* \param[in] BlockSize Size in bytes of each block within the device
* \param[in]
BlockSize
Size in bytes of each block within the device
* \param[out] BlockBuffer Pointer to where the read data from the device should be stored
* \param[out]
BlockBuffer
Pointer to where the read data from the device should be stored
*
*
* \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
* \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
*/
*/
...
@@ -267,11 +267,11 @@
...
@@ -267,11 +267,11 @@
* call will fail.
* call will fail.
*
*
* \param[in,out] MSInterfaceInfo Pointer to a structure containing a MS Class host configuration and state
* \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]
LUNIndex
LUN index within the device the command is being issued to
* \param[in] BlockAddress Starting block address within the device to write to
* \param[in]
BlockAddress
Starting block address within the device to write to
* \param[in] Blocks Total number of blocks to read
* \param[in]
Blocks
Total number of blocks to read
* \param[in] BlockSize Size in bytes of each block within the device
* \param[in]
BlockSize
Size in bytes of each block within the device
* \param[in] BlockBuffer Pointer to where the data to write should be sourced from
* \param[in]
BlockBuffer
Pointer to where the data to write should be sourced from
*
*