libusb: add debug message on adapter not found due to wrong serial

[openocd.git] / src / jtag / drivers / libusb0_common.c

diff --git a/src/jtag/drivers/libusb0_common.c b/src/jtag/drivers/libusb0_common.c
index 32111195a9e220a1d9dd26aaad1b367cf8f31ca1..14a8b61cc42617eb740ec9a0e358e4a2bdf00aba 100644 (file)
--- a/src/jtag/drivers/libusb0_common.c
+++ b/src/jtag/drivers/libusb0_common.c
@@ -14,9 +14,7 @@
  *   GNU General Public License for more details.                          *
  *                                                                         *
  *   You should have received a copy of the GNU General Public License     *
- *   along with this program; if not, write to the                         *
- *   Free Software Foundation, Inc.,                                       *
- *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.           *
+ *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
  ***************************************************************************/
 
 #ifdef HAVE_CONFIG_H
@@ -37,9 +35,41 @@ static bool jtag_libusb_match(struct jtag_libusb_device *dev,
        return false;
 }
 
+/* Returns true if the string descriptor indexed by str_index in device matches string */
+static bool string_descriptor_equal(usb_dev_handle *device, uint8_t str_index,
+                                                                       const char *string)
+{
+       int retval;
+       bool matched;
+       char desc_string[256+1]; /* Max size of string descriptor */
+
+       if (str_index == 0)
+               return false;
+
+       retval = usb_get_string_simple(device, str_index,
+                       desc_string, sizeof(desc_string)-1);
+       if (retval < 0) {
+               LOG_ERROR("usb_get_string_simple() failed with %d", retval);
+               return false;
+       }
+
+       /* Null terminate descriptor string in case it needs to be logged. */
+       desc_string[sizeof(desc_string)-1] = '\0';
+
+       matched = strncmp(string, desc_string, sizeof(desc_string)) == 0;
+       if (!matched)
+               LOG_DEBUG("Device serial number '%s' doesn't match requested serial '%s'",
+                       desc_string, string);
+       return matched;
+}
+
 int jtag_libusb_open(const uint16_t vids[], const uint16_t pids[],
+               const char *serial,
                struct jtag_libusb_device_handle **out)
 {
+       int retval = ERROR_FAIL;
+       bool serial_mismatch = false;
+       struct jtag_libusb_device_handle *libusb_handle;
        usb_init();
 
        usb_find_busses();
@@ -52,13 +82,30 @@ int jtag_libusb_open(const uint16_t vids[], const uint16_t pids[],
                        if (!jtag_libusb_match(dev, vids, pids))
                                continue;
 
-                       *out = usb_open(dev);
-                       if (NULL == *out)
-                               return -errno;
-                       return 0;
+                       libusb_handle = usb_open(dev);
+                       if (NULL == libusb_handle) {
+                               LOG_ERROR("usb_open() failed with %s", usb_strerror());
+                               continue;
+                       }
+
+                       /* Device must be open to use libusb_get_string_descriptor_ascii. */
+                       if (serial != NULL &&
+                                       !string_descriptor_equal(libusb_handle, dev->descriptor.iSerialNumber, serial)) {
+                               serial_mismatch = true;
+                               usb_close(libusb_handle);
+                               continue;
+                       }
+                       *out = libusb_handle;
+                       retval = ERROR_OK;
+                       serial_mismatch = false;
+                       break;
                }
        }
-       return -ENODEV;
+
+       if (serial_mismatch)
+               LOG_INFO("No device matches the serial string");
+
+       return retval;
 }
 
 void jtag_libusb_close(jtag_libusb_device_handle *dev)
@@ -103,14 +150,24 @@ int jtag_libusb_set_configuration(jtag_libusb_device_handle *devh,
                        udev->config[configuration].bConfigurationValue);
 }
 
-int jtag_libusb_get_endpoints(struct jtag_libusb_device *udev,
+int jtag_libusb_choose_interface(struct jtag_libusb_device_handle *devh,
                unsigned int *usb_read_ep,
-               unsigned int *usb_write_ep)
+               unsigned int *usb_write_ep,
+               int bclass, int subclass, int protocol, int trans_type)
 {
+       struct jtag_libusb_device *udev = jtag_libusb_get_device(devh);
        struct usb_interface *iface = udev->config->interface;
        struct usb_interface_descriptor *desc = iface->altsetting;
 
+       *usb_read_ep = *usb_write_ep = 0;
+
        for (int i = 0; i < desc->bNumEndpoints; i++) {
+               if ((bclass > 0 && desc->bInterfaceClass != bclass) ||
+                   (subclass > 0 && desc->bInterfaceSubClass != subclass) ||
+                   (protocol > 0 && desc->bInterfaceProtocol != protocol) ||
+                   (trans_type > 0 && (desc->endpoint[i].bmAttributes & 0x3) != trans_type))
+                       continue;
+
                uint8_t epnum = desc->endpoint[i].bEndpointAddress;
                bool is_input = epnum & 0x80;
                LOG_DEBUG("usb ep %s %02x", is_input ? "in" : "out", epnum);
@@ -118,7 +175,22 @@ int jtag_libusb_get_endpoints(struct jtag_libusb_device *udev,
                        *usb_read_ep = epnum;
                else
                        *usb_write_ep = epnum;
+
+               if (*usb_read_ep && *usb_write_ep) {
+                       LOG_DEBUG("Claiming interface %d", (int)desc->bInterfaceNumber);
+                       usb_claim_interface(devh, (int)desc->bInterfaceNumber);
+                       return ERROR_OK;
+               }
        }
 
-       return 0;
+       return ERROR_FAIL;
+}
+
+int jtag_libusb_get_pid(struct jtag_libusb_device *dev, uint16_t *pid)
+{
+       if (!dev)
+               return ERROR_FAIL;
+
+       *pid = dev->descriptor.idProduct;
+       return ERROR_OK;
 }