Misc: Fix doxygen comment for MaxPower field with respect to super-speed
authorTobias Klauser <tklauser@distanz.ch>
Wed, 13 May 2015 12:19:12 +0000 (14:19 +0200)
committerChris Dickens <christopher.a.dickens@gmail.com>
Thu, 14 May 2015 03:34:12 +0000 (20:34 -0700)
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>
libusb/libusb.h
libusb/version_nano.h

index 0bb8e4c..9cfdc99 100644 (file)
@@ -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
index 11688fe..3022fb7 100644 (file)
@@ -1 +1 @@
-#define LIBUSB_NANO 10982
+#define LIBUSB_NANO 10984