diff options
author | Tobias Klauser <tklauser@distanz.ch> | 2015-05-13 14:19:12 +0200 |
---|---|---|
committer | Chris Dickens <christopher.a.dickens@gmail.com> | 2015-05-13 20:34:12 -0700 |
commit | 260ff885cdbe793f836aef667444302c327616ab (patch) | |
tree | 36f58bdbc8607cde96d9f7cdefd79f9a9aeae011 | |
parent | c8662f893e009167f48c90a8772a07ba36f28d15 (diff) | |
download | libusb-260ff885cdbe793f836aef667444302c327616ab.tar.gz |
Misc: Fix doxygen comment for MaxPower field with respect to super-speed
The MaxPower field of a configuration descriptor is in units of 8 mA
when the device is operating in super-speed mode according to the USB
3.0 specification, section 9.6.3, table 9-12:
Maximum power consumption of the device from the
bus in this specific configuration when the device is
fully operational. Expressed in 2-mA units when the
device is operating in high-speed mode and in 8-mA
units when operating at Gen X speed.
(i.e., 50 = 100 mA when operating at high-speed and
50 = 400 mA when operating at Gen X speed).
Adjust the doxygen comment for the MaxPower member of struct
libusb_config_descriptor accordingly.
Closes #69
Signed-off-by: Tobias Klauser <tklauser@distanz.ch>
Signed-off-by: Chris Dickens <christopher.a.dickens@gmail.com>
-rw-r--r-- | libusb/libusb.h | 3 | ||||
-rw-r--r-- | libusb/version_nano.h | 2 |
2 files changed, 3 insertions, 2 deletions
diff --git a/libusb/libusb.h b/libusb/libusb.h index 0bb8e4c..9cfdc99 100644 --- a/libusb/libusb.h +++ b/libusb/libusb.h @@ -666,7 +666,8 @@ struct libusb_config_descriptor { /** Maximum power consumption of the USB device from this bus in this * configuration when the device is fully operation. Expressed in units - * of 2 mA. */ + * of 2 mA when the device is operating in high-speed mode and in units + * of 8 mA when the device is operating in super-speed mode. */ uint8_t MaxPower; /** Array of interfaces supported by this configuration. The length of diff --git a/libusb/version_nano.h b/libusb/version_nano.h index 11688fe..3022fb7 100644 --- a/libusb/version_nano.h +++ b/libusb/version_nano.h @@ -1 +1 @@ -#define LIBUSB_NANO 10982 +#define LIBUSB_NANO 10984 |