Rename all interface parameters to usb_interface or interface_number

Remove the use of the ambiguous "interface" where possible without
breaking the API.
'interface' is a preprocessor #define already associated with COM on Windows,
that can cause a conflict as soon as windows.h is included.

There are a few more places where interface is still used, which should
be changed for libusb-2.0

diff --git a/AUTHORS b/AUTHORS
index 15b204982c9591576fd3465eedaead7855cd1c16..8f21c07e7750e1d68c6e88c4301faef4266e3a4b 100644 (file)
--- a/AUTHORS
+++ b/AUTHORS
@@ -16,6 +16,7 @@ Ludovic Rousseau
 Martin Koegler
 Michael Plante
 Mikhail Gusarov
+Pete Batard
 Peter Stuge
 Rob Walker
 Toby Peterson

diff --git a/libusb/core.c b/libusb/core.c
index 3cae35e018d6422ca956459096a2a0876cfe4784..02ef4274ddd10ebd1d9ffc7effb14f1d85a42980 100644 (file)
--- a/libusb/core.c
+++ b/libusb/core.c
@@ -1351,7 +1351,7 @@ API_EXPORTED int libusb_reset_device(libusb_device_handle *dev)
  * perform I/O.
  *
  * \param dev a device handle
- * \param interface the interface to check
+ * \param interface_number the interface to check
  * \returns 0 if no kernel driver is active
  * \returns 1 if a kernel driver is active
  * \returns LIBUSB_ERROR_NO_DEVICE if the device has been disconnected
@@ -1359,11 +1359,11 @@ API_EXPORTED int libusb_reset_device(libusb_device_handle *dev)
  * \see libusb_detach_kernel_driver()
  */
 API_EXPORTED int libusb_kernel_driver_active(libusb_device_handle *dev,
-       int interface)
+       int interface_number)
 {
-       usbi_dbg("interface %d", interface);
+       usbi_dbg("interface %d", interface_number);
        if (usbi_backend->kernel_driver_active)
-               return usbi_backend->kernel_driver_active(dev, interface);
+               return usbi_backend->kernel_driver_active(dev, interface_number);
        else
                return LIBUSB_ERROR_NOT_SUPPORTED;
 }
@@ -1373,7 +1373,7 @@ API_EXPORTED int libusb_kernel_driver_active(libusb_device_handle *dev,
  * able to claim the interface and perform I/O.
  *
  * \param dev a device handle
- * \param interface the interface to detach the driver from
+ * \param interface_number the interface to detach the driver from
  * \returns 0 on success
  * \returns LIBUSB_ERROR_NOT_FOUND if no kernel driver was active
  * \returns LIBUSB_ERROR_INVALID_PARAM if the interface does not exist
@@ -1382,11 +1382,11 @@ API_EXPORTED int libusb_kernel_driver_active(libusb_device_handle *dev,
  * \see libusb_kernel_driver_active()
  */
 API_EXPORTED int libusb_detach_kernel_driver(libusb_device_handle *dev,
-       int interface)
+       int interface_number)
 {
-       usbi_dbg("interface %d", interface);
+       usbi_dbg("interface %d", interface_number);
        if (usbi_backend->detach_kernel_driver)
-               return usbi_backend->detach_kernel_driver(dev, interface);
+               return usbi_backend->detach_kernel_driver(dev, interface_number);
        else
                return LIBUSB_ERROR_NOT_SUPPORTED;
 }
@@ -1396,7 +1396,7 @@ API_EXPORTED int libusb_detach_kernel_driver(libusb_device_handle *dev,
  * using libusb_detach_kernel_driver().
  *
  * \param dev a device handle
- * \param interface the interface to attach the driver from
+ * \param interface_number the interface to attach the driver from
  * \returns 0 on success
  * \returns LIBUSB_ERROR_NOT_FOUND if no kernel driver was active
  * \returns LIBUSB_ERROR_INVALID_PARAM if the interface does not exist
@@ -1407,11 +1407,11 @@ API_EXPORTED int libusb_detach_kernel_driver(libusb_device_handle *dev,
  * \see libusb_kernel_driver_active()
  */
 API_EXPORTED int libusb_attach_kernel_driver(libusb_device_handle *dev,
-       int interface)
+       int interface_number)
 {
-       usbi_dbg("interface %d", interface);
+       usbi_dbg("interface %d", interface_number);
        if (usbi_backend->attach_kernel_driver)
-               return usbi_backend->attach_kernel_driver(dev, interface);
+               return usbi_backend->attach_kernel_driver(dev, interface_number);
        else
                return LIBUSB_ERROR_NOT_SUPPORTED;
 }

diff --git a/libusb/descriptor.c b/libusb/descriptor.c
index 8f2d8e02d8cb8ab0f29907f887028418046b3b08..4384e3a0aff1211b71fdbe9b2a3f42ea3c32fdd0 100644 (file)
--- a/libusb/descriptor.c
+++ b/libusb/descriptor.c
@@ -154,16 +154,16 @@ static int parse_endpoint(struct libusb_context *ctx,
        return parsed;
 }
 
-static void clear_interface(struct libusb_interface *interface)
+static void clear_interface(struct libusb_interface *usb_interface)
 {
        int i;
        int j;
 
-       if (interface->altsetting) {
-               for (i = 0; i < interface->num_altsetting; i++) {
+       if (usb_interface->altsetting) {
+               for (i = 0; i < usb_interface->num_altsetting; i++) {
                        struct libusb_interface_descriptor *ifp =
                                (struct libusb_interface_descriptor *)
-                               interface->altsetting + i;
+                               usb_interface->altsetting + i;
                        if (ifp->extra)
                                free((void *) ifp->extra);
                        if (ifp->endpoint) {
@@ -173,14 +173,14 @@ static void clear_interface(struct libusb_interface *interface)
                                free((void *) ifp->endpoint);
                        }
                }
-               free((void *) interface->altsetting);
-               interface->altsetting = NULL;
+               free((void *) usb_interface->altsetting);
+               usb_interface->altsetting = NULL;
        }
-       
+
 }
 
 static int parse_interface(libusb_context *ctx,
-       struct libusb_interface *interface, unsigned char *buffer, int size,
+       struct libusb_interface *usb_interface, unsigned char *buffer, int size,
        int host_endian)
 {
        int i;
@@ -192,22 +192,22 @@ static int parse_interface(libusb_context *ctx,
        struct libusb_interface_descriptor *ifp;
        unsigned char *begin;
 
-       interface->num_altsetting = 0;
+       usb_interface->num_altsetting = 0;
 
        while (size >= INTERFACE_DESC_LENGTH) {
                struct libusb_interface_descriptor *altsetting =
-                       (struct libusb_interface_descriptor *) interface->altsetting;
+                       (struct libusb_interface_descriptor *) usb_interface->altsetting;
                altsetting = realloc(altsetting,
                        sizeof(struct libusb_interface_descriptor) *
-                       (interface->num_altsetting + 1));
+                       (usb_interface->num_altsetting + 1));
                if (!altsetting) {
                        r = LIBUSB_ERROR_NO_MEM;
                        goto err;
                }
-               interface->altsetting = altsetting;
+               usb_interface->altsetting = altsetting;
 
-               ifp = altsetting + interface->num_altsetting;
-               interface->num_altsetting++;
+               ifp = altsetting + usb_interface->num_altsetting;
+               usb_interface->num_altsetting++;
                usbi_parse_descriptor(buffer, "bbbbbbbbb", ifp, 0);
                ifp->extra = NULL;
                ifp->extra_length = 0;
@@ -309,7 +309,7 @@ static int parse_interface(libusb_context *ctx,
 
        return parsed;
 err:
-       clear_interface(interface);
+       clear_interface(usb_interface);
        return r;
 }
 
@@ -335,7 +335,7 @@ static int parse_configuration(struct libusb_context *ctx,
        int size;
        int tmp;
        struct usb_descriptor_header header;
-       struct libusb_interface *interface;
+       struct libusb_interface *usb_interface;
 
        usbi_parse_descriptor(buffer, "bbwbbbbb", config, host_endian);
        size = config->wTotalLength;
@@ -346,12 +346,12 @@ static int parse_configuration(struct libusb_context *ctx,
        }
 
        tmp = config->bNumInterfaces * sizeof(struct libusb_interface);
-       interface = malloc(tmp);
-       config->interface = interface;
+       usb_interface = malloc(tmp);
+       config->interface = usb_interface;
        if (!config->interface)
                return LIBUSB_ERROR_NO_MEM;
 
-       memset(interface, 0, tmp);
+       memset(usb_interface, 0, tmp);
        buffer += config->bLength;
        size -= config->bLength;
 
@@ -405,7 +405,7 @@ static int parse_configuration(struct libusb_context *ctx,
                        }
                }
 
-               r = parse_interface(ctx, interface + i, buffer, size, host_endian);
+               r = parse_interface(ctx, usb_interface + i, buffer, size, host_endian);
                if (r < 0)
                        goto err;
 
@@ -663,7 +663,7 @@ API_EXPORTED void libusb_free_config_descriptor(
 /** \ingroup desc
  * Retrieve a string descriptor in C style ASCII.
  *
- * Wrapper around libusb_get_string_descriptor(). Uses the first language 
+ * Wrapper around libusb_get_string_descriptor(). Uses the first language
  * supported by the device.
  *
  * \param dev a device handle

diff --git a/libusb/libusb.h b/libusb/libusb.h
index 18ec0cd2a78ccdb318c232901dbc94d39386fe96..623c6bc3e17049e14cba2e26e5a9dc14a5ee57a3 100644 (file)
--- a/libusb/libusb.h
+++ b/libusb/libusb.h
@@ -807,8 +807,8 @@ void libusb_close(libusb_device_handle *dev_handle);
 libusb_device *libusb_get_device(libusb_device_handle *dev_handle);
 
 int libusb_set_configuration(libusb_device_handle *dev, int configuration);
-int libusb_claim_interface(libusb_device_handle *dev, int iface);
-int libusb_release_interface(libusb_device_handle *dev, int iface);
+int libusb_claim_interface(libusb_device_handle *dev, int interface_number);
+int libusb_release_interface(libusb_device_handle *dev, int interface_number);
 
 libusb_device_handle *libusb_open_device_with_vid_pid(libusb_context *ctx,
        uint16_t vendor_id, uint16_t product_id);
@@ -818,9 +818,9 @@ int libusb_set_interface_alt_setting(libusb_device_handle *dev,
 int libusb_clear_halt(libusb_device_handle *dev, unsigned char endpoint);
 int libusb_reset_device(libusb_device_handle *dev);
 
-int libusb_kernel_driver_active(libusb_device_handle *dev, int interface);
-int libusb_detach_kernel_driver(libusb_device_handle *dev, int interface);
-int libusb_attach_kernel_driver(libusb_device_handle *dev, int interface);
+int libusb_kernel_driver_active(libusb_device_handle *dev, int interface_number);
+int libusb_detach_kernel_driver(libusb_device_handle *dev, int interface_number);
+int libusb_attach_kernel_driver(libusb_device_handle *dev, int interface_number);
 
 /* async I/O */
 

diff --git a/libusb/libusbi.h b/libusb/libusbi.h
index 74466c2388e4d6fae8a922a7465beff0d53c437e..3cf9882fcae199079e97097342eb39672ea8089d 100644 (file)
--- a/libusb/libusbi.h
+++ b/libusb/libusbi.h
@@ -581,7 +581,7 @@ struct usbi_os_backend {
         *   was opened
         * - another LIBUSB_ERROR code on other failure
         */
-       int (*claim_interface)(struct libusb_device_handle *handle, int iface);
+       int (*claim_interface)(struct libusb_device_handle *handle, int interface_number);
 
        /* Release a previously claimed interface.
         *
@@ -598,7 +598,7 @@ struct usbi_os_backend {
         *   was opened
         * - another LIBUSB_ERROR code on other failure
         */
-       int (*release_interface)(struct libusb_device_handle *handle, int iface);
+       int (*release_interface)(struct libusb_device_handle *handle, int interface_number);
 
        /* Set the alternate setting for an interface.
         *
@@ -615,7 +615,7 @@ struct usbi_os_backend {
         * - another LIBUSB_ERROR code on other failure
         */
        int (*set_interface_altsetting)(struct libusb_device_handle *handle,
-               int iface, int altsetting);
+               int interface_number, int altsetting);
 
        /* Clear a halt/stall condition on an endpoint.
         *
@@ -662,7 +662,7 @@ struct usbi_os_backend {
         * - another LIBUSB_ERROR code on other failure
         */
        int (*kernel_driver_active)(struct libusb_device_handle *handle,
-               int interface);
+               int interface_number);
 
        /* Detach a kernel driver from an interface. Optional.
         *
@@ -678,7 +678,7 @@ struct usbi_os_backend {
         * - another LIBUSB_ERROR code on other failure
         */
        int (*detach_kernel_driver)(struct libusb_device_handle *handle,
-               int interface);
+               int interface_number);
 
        /* Attach a kernel driver to an interface. Optional.
         *
@@ -695,7 +695,7 @@ struct usbi_os_backend {
         * - another LIBUSB_ERROR code on other failure
         */
        int (*attach_kernel_driver)(struct libusb_device_handle *handle,
-               int interface);
+               int interface_number);
 
        /* Destroy a device. Optional.
         *