docs: Document internal_ssplus_capability_descriptor

Also include SSP documentation fixups of commit f00f06e9
that had introduced Doxygen errors.

Closes #1545
This commit is contained in:
Fabien Sanglard
2024-11-07 22:03:52 -08:00
committed by Tormod Volden
parent 467b6a8896
commit 28a6afb690
3 changed files with 16 additions and 3 deletions

View File

@@ -1009,12 +1009,25 @@ int API_EXPORTED libusb_get_ss_usb_device_capability_descriptor(
descriptor according to section 9.6.2.5 of the USB 3.1 specification.
We don't expose it. */
struct internal_ssplus_capability_descriptor {
/** The length of the descriptor. Must be equal to LIBUSB_BT_SSPLUS_USB_DEVICE_CAPABILITY_SIZE */
uint8_t bLength;
/** The type of the descriptor */
uint8_t bDescriptorType;
/** Must be equal to LIBUSB_BT_SUPERSPEED_PLUS_CAPABILITY */
uint8_t bDevCapabilityType;
/** Unused */
uint8_t bReserved;
/** Contains the number of SublinkSpeedIDs */
uint32_t bmAttributes;
/** Contains the ssid, minRxLaneCount, and minTxLaneCount */
uint16_t wFunctionalitySupport;
/** Unused */
uint16_t wReserved;
};

View File

@@ -566,7 +566,7 @@ enum libusb_bos_type {
/** Platform descriptor */
LIBUSB_BT_PLATFORM_DESCRIPTOR = 0x05,
/* SuperSpeedPlus device capability */
/** SuperSpeedPlus device capability */
LIBUSB_BT_SUPERSPEED_PLUS_CAPABILITY = 0x0A,
};
@@ -1075,7 +1075,7 @@ struct libusb_ssplus_usb_device_capability_descriptor {
/** This field indicates the minimum transmit lane count*/
uint8_t minTxLaneCount;
/** num attrtibutes= \ref libusb_ssplus_usb_device_capability_descriptor.numSublinkSpeedAttributes= */
/** Array size is \ref libusb_ssplus_usb_device_capability_descriptor.numSublinkSpeedAttributes */
struct libusb_ssplus_sublink_attribute sublinkSpeedAttributes[];
};

View File

@@ -1 +1 @@
#define LIBUSB_NANO 11936
#define LIBUSB_NANO 11937