X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/d0806c817cbf0c1b5c5362d1577eac6075c94dfc..31d8ebebc0796873f7c70db80a04acdcbb307ed8:/LUFA/Drivers/USB/HighLevel/ConfigDescriptor.h diff --git a/LUFA/Drivers/USB/HighLevel/ConfigDescriptor.h b/LUFA/Drivers/USB/HighLevel/ConfigDescriptor.h index 5c2b6e2de..a9b0b1423 100644 --- a/LUFA/Drivers/USB/HighLevel/ConfigDescriptor.h +++ b/LUFA/Drivers/USB/HighLevel/ConfigDescriptor.h @@ -133,9 +133,9 @@ * * \note This function is available in USB Host mode only. * - * \param BytesRem Pointer to an int storing the remaining bytes in the configuration descriptor - * \param CurrConfigLoc Pointer to the current position in the configuration descriptor - * \param 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 * @@ -183,24 +183,27 @@ /* Function Prototypes: */ /** Retrieves the configuration descriptor data or size from an attached device via a standard request. * - * \param ConfigSizePtr Pointer to a uint16_t for either storing or retrieving the configuration - * descriptor size + * \param[in] ConfigNumber Device configuration descriptor number to fetch from the device (usually set to 1 for + * single configuration devices) * - * \param BufferPtr Pointer to the buffer for storing the configuration descriptor data. If this is - * NULL, the size of the configuration descriptor will be retrieved instead and - * placed in the variable pointed to by ConfigSizePtr. If this is non-NULL, the number - * of bytes indicated by ConfigSizePtr of the configuration descriptor will be loaded - * into the buffer + * \param[in,out] ConfigSizePtr Pointer to a uint16_t for either storing or retrieving the configuration + * descriptor size + * + * \param[out] BufferPtr Pointer to the buffer for storing the configuration descriptor data. If this is + * NULL, the size of the configuration descriptor will be retrieved instead and + * placed in the variable pointed to by ConfigSizePtr. If this is non-NULL, the number + * of bytes indicated by ConfigSizePtr of the configuration descriptor will be loaded + * into the buffer */ - uint8_t USB_GetDeviceConfigDescriptor(uint16_t* const ConfigSizePtr, void* BufferPtr) - ATTR_NON_NULL_PTR_ARG(1); + uint8_t USB_GetDeviceConfigDescriptor(uint8_t ConfigNumber, uint16_t* const ConfigSizePtr, void* BufferPtr) + ATTR_NON_NULL_PTR_ARG(2); /** Skips to the next sub-descriptor inside the configuration descriptor of the specified type value. * The bytes remaining value is automatically decremented. * - * \param BytesRem Pointer to the number of bytes remaining of the configuration descriptor - * \param CurrConfigLoc Pointer to the current descriptor inside the configuration descriptor - * \param 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, uint8_t** const CurrConfigLoc, @@ -212,10 +215,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 BytesRem Pointer to the number of bytes remaining of the configuration descriptor - * \param CurrConfigLoc Pointer to the current descriptor inside the configuration descriptor - * \param Type Descriptor type value to search for - * \param 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, uint8_t** const CurrConfigLoc, @@ -227,10 +230,10 @@ * which must come after a descriptor of the second given type value. The bytes remaining value is * automatically decremented. * - * \param BytesRem Pointer to the number of bytes remaining of the configuration descriptor - * \param CurrConfigLoc Pointer to the current descriptor inside the configuration descriptor - * \param Type Descriptor type value to search for - * \param 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, uint8_t** const CurrConfigLoc, @@ -242,8 +245,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 BytesRem Pointer to the number of bytes remaining of the configuration descriptor - * \param 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, uint8_t** const CurrConfigLoc)