libusb: add debug message on adapter not found due to wrong serial
[openocd.git] / src / jtag / drivers / libusb0_common.c
index 8ed60df942db9326082d1b31ead667770f51992d..14a8b61cc42617eb740ec9a0e358e4a2bdf00aba 100644 (file)
@@ -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.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
  ***************************************************************************/
 
 #ifdef HAVE_CONFIG_H
@@ -28,7 +26,7 @@
 static bool jtag_libusb_match(struct jtag_libusb_device *dev,
                const uint16_t vids[], const uint16_t pids[])
 {
-       for (unsigned i = 0; vids[i] && pids[i]; i++) {
+       for (unsigned i = 0; vids[i]; i++) {
                if (dev->descriptor.idVendor == vids[i] &&
                        dev->descriptor.idProduct == pids[i]) {
                        return true;
@@ -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();
@@ -48,39 +78,71 @@ int jtag_libusb_open(const uint16_t vids[], const uint16_t pids[],
        struct usb_bus *busses = usb_get_busses();
        for (struct usb_bus *bus = busses; bus; bus = bus->next) {
                for (struct usb_device *dev = bus->devices;
-                    dev; dev = dev->next) {
+                               dev; dev = dev->next) {
                        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)
 {
        /* Close device */
-       jtag_libusb_close(dev);
+       usb_close(dev);
+}
+
+int jtag_libusb_control_transfer(jtag_libusb_device_handle *dev, uint8_t requestType,
+               uint8_t request, uint16_t wValue, uint16_t wIndex, char *bytes,
+               uint16_t size, unsigned int timeout)
+{
+       int transferred = 0;
+
+       transferred = usb_control_msg(dev, requestType, request, wValue, wIndex,
+                               bytes, size, timeout);
+
+       if (transferred < 0)
+               transferred = 0;
+
+       return transferred;
 }
 
 int jtag_libusb_bulk_write(jtag_libusb_device_handle *dev, int ep, char *bytes,
-                                               int size, int timeout)
+               int size, int timeout)
 {
        return usb_bulk_write(dev, ep, bytes, size, timeout);
 }
 
 int jtag_libusb_bulk_read(jtag_libusb_device_handle *dev, int ep, char *bytes,
-                                          int size, int timeout)
+               int size, int timeout)
 {
        return usb_bulk_read(dev, ep, bytes, size, timeout);
 }
 
 int jtag_libusb_set_configuration(jtag_libusb_device_handle *devh,
-                                 int configuration)
+               int configuration)
 {
        struct jtag_libusb_device *udev = jtag_libusb_get_device(devh);
 
@@ -88,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,
-                                                  unsigned int *usb_read_ep,
-                                                  unsigned int *usb_write_ep)
+int jtag_libusb_choose_interface(struct jtag_libusb_device_handle *devh,
+               unsigned int *usb_read_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);
@@ -103,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;
 }

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read https://review.openocd.org/login/?link to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)