diff options
Diffstat (limited to 'LUFA/Drivers/USB/HighLevel')
| -rw-r--r-- | LUFA/Drivers/USB/HighLevel/ConfigDescriptor.h | 58 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/HighLevel/Events.h | 6 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/HighLevel/StdDescriptors.h | 28 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/HighLevel/USBTask.h | 4 |
4 files changed, 48 insertions, 48 deletions
diff --git a/LUFA/Drivers/USB/HighLevel/ConfigDescriptor.h b/LUFA/Drivers/USB/HighLevel/ConfigDescriptor.h index 90e36a4cd..14457ca2a 100644 --- a/LUFA/Drivers/USB/HighLevel/ConfigDescriptor.h +++ b/LUFA/Drivers/USB/HighLevel/ConfigDescriptor.h @@ -116,7 +116,7 @@ /** Type define for a Configuration Descriptor comparator function (function taking a pointer to an array * of type void, returning a uint8_t value). * - * \see \ref USB_GetNextDescriptorComp function for more details + * \see \ref USB_GetNextDescriptorComp function for more details. */ typedef uint8_t (* ConfigComparatorPtr_t)(void*); @@ -124,19 +124,19 @@ /** Enum for the possible return codes of the \ref USB_Host_GetDeviceConfigDescriptor() function. */ enum USB_Host_GetConfigDescriptor_ErrorCodes_t { - HOST_GETCONFIG_Successful = 0, /**< No error occurred while retrieving the configuration descriptor */ + HOST_GETCONFIG_Successful = 0, /**< No error occurred while retrieving the configuration descriptor. */ HOST_GETCONFIG_DeviceDisconnect = 1, /**< The attached device was disconnected while retrieving the configuration - * descriptor + * descriptor. */ - HOST_GETCONFIG_PipeError = 2, /**< An error occurred in the pipe while sending the request */ + HOST_GETCONFIG_PipeError = 2, /**< An error occurred in the pipe while sending the request. */ HOST_GETCONFIG_SetupStalled = 3, /**< The attached device stalled the request to retrieve the configuration - * descriptor + * descriptor. */ - HOST_GETCONFIG_SoftwareTimeOut = 4, /**< The request or data transfer timed out */ + HOST_GETCONFIG_SoftwareTimeOut = 4, /**< The request or data transfer timed out. */ HOST_GETCONFIG_BuffOverflow = 5, /**< The device's configuration descriptor is too large to fit into the allocated - * buffer + * buffer. */ - HOST_GETCONFIG_InvalidData = 6, /**< The device returned invalid configuration descriptor data */ + HOST_GETCONFIG_InvalidData = 6, /**< The device returned invalid configuration descriptor data. */ }; /** Enum for return values of a descriptor comparator function. */ @@ -161,12 +161,12 @@ * including validity and size checking to prevent a buffer overflow. * * \param[in] ConfigNumber Device configuration descriptor number to fetch from the device (usually set to 1 for - * single configuration devices) - * \param[in,out] ConfigSizePtr Pointer to a uint16_t for storing the retrieved configuration descriptor size + * single configuration devices). + * \param[in,out] ConfigSizePtr Pointer to a uint16_t for storing the retrieved configuration descriptor size. * \param[out] BufferPtr Pointer to the buffer for storing the configuration descriptor data. - * \param[out] BufferSize Size of the allocated buffer where the configuration descriptor is to be stored + * \param[out] BufferSize Size of the allocated buffer where the configuration descriptor is to be stored. * - * \return A value from the \ref USB_Host_GetConfigDescriptor_ErrorCodes_t enum + * \return A value from the \ref USB_Host_GetConfigDescriptor_ErrorCodes_t enum. */ uint8_t USB_Host_GetDeviceConfigDescriptor(uint8_t ConfigNumber, uint16_t* const ConfigSizePtr, void* BufferPtr, uint16_t BufferSize) ATTR_NON_NULL_PTR_ARG(2) ATTR_NON_NULL_PTR_ARG(3); @@ -174,9 +174,9 @@ /** Skips to the next sub-descriptor inside the configuration descriptor of the specified type value. * The bytes remaining value is automatically decremented. * - * \param[in,out] BytesRem Pointer to the number of bytes remaining of the configuration descriptor - * \param[in,out] CurrConfigLoc Pointer to the current descriptor inside the configuration descriptor - * \param[in] Type Descriptor type value to search for + * \param[in,out] BytesRem Pointer to the number of bytes remaining of the configuration descriptor. + * \param[in,out] CurrConfigLoc Pointer to the current descriptor inside the configuration descriptor. + * \param[in] Type Descriptor type value to search for. */ void USB_GetNextDescriptorOfType(uint16_t* const BytesRem, void** const CurrConfigLoc, @@ -188,10 +188,10 @@ * descriptor is reached first, the number of bytes remaining to process is set to zero and the * function exits. The bytes remaining value is automatically decremented. * - * \param[in,out] BytesRem Pointer to the number of bytes remaining of the configuration descriptor - * \param[in,out] CurrConfigLoc Pointer to the current descriptor inside the configuration descriptor - * \param[in] Type Descriptor type value to search for - * \param[in] BeforeType Descriptor type value which must not be reached before the given Type descriptor + * \param[in,out] BytesRem Pointer to the number of bytes remaining of the configuration descriptor. + * \param[in,out] CurrConfigLoc Pointer to the current descriptor inside the configuration descriptor. + * \param[in] Type Descriptor type value to search for. + * \param[in] BeforeType Descriptor type value which must not be reached before the given Type descriptor. */ void USB_GetNextDescriptorOfTypeBefore(uint16_t* const BytesRem, void** const CurrConfigLoc, @@ -203,10 +203,10 @@ * which must come after a descriptor of the second given type value. The bytes remaining value is * automatically decremented. * - * \param[in,out] BytesRem Pointer to the number of bytes remaining of the configuration descriptor - * \param[in,out] CurrConfigLoc Pointer to the current descriptor inside the configuration descriptor - * \param[in] Type Descriptor type value to search for - * \param[in] AfterType Descriptor type value which must be reached before the given Type descriptor + * \param[in,out] BytesRem Pointer to the number of bytes remaining of the configuration descriptor. + * \param[in,out] CurrConfigLoc Pointer to the current descriptor inside the configuration descriptor. + * \param[in] Type Descriptor type value to search for. + * \param[in] AfterType Descriptor type value which must be reached before the given Type descriptor. */ void USB_GetNextDescriptorOfTypeAfter(uint16_t* const BytesRem, void** const CurrConfigLoc, @@ -227,11 +227,11 @@ * * \note This function is available in USB Host mode only. * - * \param[in,out] BytesRem Pointer to an int storing the remaining bytes in the configuration descriptor - * \param[in,out] CurrConfigLoc Pointer to the current position in the configuration descriptor - * \param[in] ComparatorRoutine Name of the comparator search function to use on the configuration descriptor + * \param[in,out] BytesRem Pointer to an int storing the remaining bytes in the configuration descriptor. + * \param[in,out] CurrConfigLoc Pointer to the current position in the configuration descriptor. + * \param[in] ComparatorRoutine Name of the comparator search function to use on the configuration descriptor. * - * \return Value of one of the members of the \ref DSearch_Comp_Return_ErrorCodes_t enum + * \return Value of one of the members of the \ref DSearch_Comp_Return_ErrorCodes_t enum. * * Usage Example: * \code @@ -260,8 +260,8 @@ /** Skips over the current sub-descriptor inside the configuration descriptor, so that the pointer then points to the next sub-descriptor. The bytes remaining value is automatically decremented. * - * \param[in,out] BytesRem Pointer to the number of bytes remaining of the configuration descriptor - * \param[in,out] CurrConfigLoc Pointer to the current descriptor inside the configuration descriptor + * \param[in,out] BytesRem Pointer to the number of bytes remaining of the configuration descriptor. + * \param[in,out] CurrConfigLoc Pointer to the current descriptor inside the configuration descriptor. */ static inline void USB_GetNextDescriptor(uint16_t* const BytesRem, void** CurrConfigLoc) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2); diff --git a/LUFA/Drivers/USB/HighLevel/Events.h b/LUFA/Drivers/USB/HighLevel/Events.h index 7e82ff36d..d88c47123 100644 --- a/LUFA/Drivers/USB/HighLevel/Events.h +++ b/LUFA/Drivers/USB/HighLevel/Events.h @@ -92,7 +92,7 @@ * * \note This event only exists on USB AVR models which support dual role modes. * - * \param[in] ErrorCode Error code indicating the failure reason, a value in \ref USB_InitErrorCodes_t + * \param[in] ErrorCode Error code indicating the failure reason, a value in \ref USB_InitErrorCodes_t. */ void EVENT_USB_InitFailure(const uint8_t ErrorCode); @@ -112,7 +112,7 @@ /** Event for USB host error. This event fires when a hardware fault has occurred whilst the USB * interface is in host mode. * - * \param[in] ErrorCode Error code indicating the failure reason, a value in \ref USB_Host_ErrorCodes_t + * \param[in] ErrorCode Error code indicating the failure reason, a value in \ref USB_Host_ErrorCodes_t. * * \note This event only exists on USB AVR models which supports host mode. * \n\n @@ -155,7 +155,7 @@ * in host mode, and an attached USB device has failed to enumerate completely. * * \param[in] ErrorCode Error code indicating the failure reason, a value in - * \ref USB_Host_EnumerationErrorCodes_t + * \ref USB_Host_EnumerationErrorCodes_t. * * \param[in] SubErrorCode Sub error code indicating the reason for failure - for example, if the * ErrorCode parameter indicates a control error, this will give the error diff --git a/LUFA/Drivers/USB/HighLevel/StdDescriptors.h b/LUFA/Drivers/USB/HighLevel/StdDescriptors.h index 0b849bf19..2ff162286 100644 --- a/LUFA/Drivers/USB/HighLevel/StdDescriptors.h +++ b/LUFA/Drivers/USB/HighLevel/StdDescriptors.h @@ -219,7 +219,7 @@ * Type define for all descriptors' standard header, indicating the descriptor's length and type. This structure * uses LUFA-specific element names to make each element's purpose clearer. * - * \see \ref USB_StdDescriptor_Header_t for the version of this define with standard element names + * \see \ref USB_StdDescriptor_Header_t for the version of this define with standard element names. */ typedef struct { @@ -234,7 +234,7 @@ * Type define for all descriptors' standard header, indicating the descriptor's length and type. This structure * uses the relevant standard's given element names to ensure compatibility with the standard. * - * \see \ref USB_Descriptor_Header_t for the version of this define with non-standard LUFA specific element names + * \see \ref USB_Descriptor_Header_t for the version of this define with non-standard LUFA specific element names. */ typedef struct { @@ -249,7 +249,7 @@ * Type define for a standard Device Descriptor. This structure uses LUFA-specific element names to make each * element's purpose clearer. * - * \see \ref USB_StdDescriptor_Device_t for the version of this define with standard element names + * \see \ref USB_StdDescriptor_Device_t for the version of this define with standard element names. */ typedef struct { @@ -298,7 +298,7 @@ * Type define for a standard Device Descriptor. This structure uses the relevant standard's given element names * to ensure compatibility with the standard. * - * \see \ref USB_Descriptor_Device_t for the version of this define with non-standard LUFA specific element names + * \see \ref USB_Descriptor_Device_t for the version of this define with non-standard LUFA specific element names. */ typedef struct { @@ -346,7 +346,7 @@ * Type define for a standard Configuration Descriptor header. This structure uses LUFA-specific element names * to make each element's purpose clearer. * - * \see \ref USB_StdDescriptor_Configuration_Header_t for the version of this define with standard element names + * \see \ref USB_StdDescriptor_Configuration_Header_t for the version of this define with standard element names. */ typedef struct { @@ -375,7 +375,7 @@ * Type define for a standard Configuration Descriptor header. This structure uses the relevant standard's given element names * to ensure compatibility with the standard. * - * \see \ref USB_Descriptor_Device_t for the version of this define with non-standard LUFA specific element names + * \see \ref USB_Descriptor_Device_t for the version of this define with non-standard LUFA specific element names. */ typedef struct { @@ -403,7 +403,7 @@ * Type define for a standard Interface Descriptor. This structure uses LUFA-specific element names * to make each element's purpose clearer. * - * \see \ref USB_StdDescriptor_Interface_t for the version of this define with standard element names + * \see \ref USB_StdDescriptor_Interface_t for the version of this define with standard element names. */ typedef struct { @@ -431,7 +431,7 @@ * Type define for a standard Interface Descriptor. This structure uses the relevant standard's given element names * to ensure compatibility with the standard. * - * \see \ref USB_Descriptor_Interface_t for the version of this define with non-standard LUFA specific element names + * \see \ref USB_Descriptor_Interface_t for the version of this define with non-standard LUFA specific element names. */ typedef struct { @@ -465,7 +465,7 @@ * together at the point of enumeration, loading one generic driver for all the interfaces in the single * function. Read the ECN for more information. * - * \see \ref USB_StdDescriptor_Interface_Association_t for the version of this define with standard element names + * \see \ref USB_StdDescriptor_Interface_Association_t for the version of this define with standard element names. */ typedef struct { @@ -495,7 +495,7 @@ * function. Read the ECN for more information. * * \see \ref USB_Descriptor_Interface_Association_t for the version of this define with non-standard LUFA specific - * element names + * element names. */ typedef struct { @@ -518,7 +518,7 @@ * Type define for a standard Endpoint Descriptor. This structure uses LUFA-specific element names * to make each element's purpose clearer. * - * \see \ref USB_StdDescriptor_Endpoint_t for the version of this define with standard element names + * \see \ref USB_StdDescriptor_Endpoint_t for the version of this define with standard element names. */ typedef struct { @@ -547,7 +547,7 @@ * element names to ensure compatibility with the standard. * * \see \ref USB_Descriptor_Endpoint_t for the version of this define with non-standard LUFA specific - * element names + * element names. */ typedef struct { @@ -582,7 +582,7 @@ * * This structure uses LUFA-specific element names to make each element's purpose clearer. * - * \see \ref USB_StdDescriptor_String_t for the version of this define with standard element names + * \see \ref USB_StdDescriptor_String_t for the version of this define with standard element names. */ typedef struct { @@ -613,7 +613,7 @@ * This structure uses the relevant standard's given element names to ensure compatibility with the standard. * * \see \ref USB_Descriptor_String_t for the version of this define with with non-standard LUFA specific - * element names + * element names. */ typedef struct { diff --git a/LUFA/Drivers/USB/HighLevel/USBTask.h b/LUFA/Drivers/USB/HighLevel/USBTask.h index 1637fb416..cce7bb29e 100644 --- a/LUFA/Drivers/USB/HighLevel/USBTask.h +++ b/LUFA/Drivers/USB/HighLevel/USBTask.h @@ -107,7 +107,7 @@ * * \note This global is only present if the user application can be a USB host. * - * \see \ref USB_Host_States_t for a list of possible device states + * \see \ref USB_Host_States_t for a list of possible device states. * * \ingroup Group_Host */ @@ -140,7 +140,7 @@ * \note This variable should be treated as read-only in the user application, and never manually * changed in value except in the circumstances outlined above. * - * \see \ref USB_Device_States_t for a list of possible device states + * \see \ref USB_Device_States_t for a list of possible device states. * * \ingroup Group_Device */ |