API docs: Elaborate on "NOT_SUPPORTED" status for set_configuration()
authorMartin Thierer <mthierer@gmail.com>
Sun, 2 Aug 2020 13:08:31 +0000 (15:08 +0200)
committerChris Dickens <christopher.a.dickens@gmail.com>
Mon, 10 Aug 2020 17:54:33 +0000 (10:54 -0700)
Closes #762

Signed-off-by: Chris Dickens <christopher.a.dickens@gmail.com>
libusb/core.c
libusb/version_nano.h

index 6aa1b0b76b766a3e563da990c0008750a91bf213..69e26498fcd25d6acf512e33fc37411cf738ca6c 100644 (file)
@@ -1603,6 +1603,11 @@ int API_EXPORTED libusb_get_configuration(libusb_device_handle *dev_handle,
  * causing most USB-related device state to be reset (altsetting reset to zero,
  * endpoint halts cleared, toggles reset).
  *
+ * Not all backends support setting the configuration from user space, which
+ * will be indicated by the return code LIBUSB_ERROR_NOT_SUPPORTED. As this
+ * suggests that the platform is handling the device configuration itself,
+ * this error should generally be safe to ignore.
+ *
  * You cannot change/reset configuration if your application has claimed
  * interfaces. It is advised to set the desired configuration before claiming
  * interfaces.
@@ -1632,6 +1637,8 @@ int API_EXPORTED libusb_get_configuration(libusb_device_handle *dev_handle,
  * \returns 0 on success
  * \returns LIBUSB_ERROR_NOT_FOUND if the requested configuration does not exist
  * \returns LIBUSB_ERROR_BUSY if interfaces are currently claimed
+ * \returns LIBUSB_ERROR_NOT_SUPPORTED if setting or changing the configuration
+ * is not supported by the backend
  * \returns LIBUSB_ERROR_NO_DEVICE if the device has been disconnected
  * \returns another LIBUSB_ERROR code on other failure
  * \see libusb_set_auto_detach_kernel_driver()
index baac006cb82bbfbe5514782b4ac9ba3b30fc6173..6d12f78669adb30ed4a790722521f6ffe8ac84b1 100644 (file)
@@ -1 +1 @@
-#define LIBUSB_NANO 11526
+#define LIBUSB_NANO 11527