Support hla_serial command for ST-LINK adapters.
[openocd.git] / src / jtag / drivers / libusb1_common.c
index c6cb494335a88fbc29b5b0d4596e4282628d7741..a29b2e9105e56eaf51f645cc2ac515d2f204384f 100644 (file)
@@ -16,7 +16,7 @@
  *   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.             *
+ *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.           *
  ***************************************************************************/
 
 #ifdef HAVE_CONFIG_H
 static struct libusb_context *jtag_libusb_context; /**< Libusb context **/
 static libusb_device **devs; /**< The usb device list **/
 
-static bool jtag_libusb_match(struct jtag_libusb_device *dev,
+static bool jtag_libusb_match(struct libusb_device_descriptor *dev_desc,
                const uint16_t vids[], const uint16_t pids[])
 {
-       struct libusb_device_descriptor dev_desc;
-
-       for (unsigned i = 0; vids[i] && pids[i]; i++) {
-               if (libusb_get_device_descriptor(dev, &dev_desc) == 0) {
-                       if (dev_desc.idVendor == vids[i] &&
-                               dev_desc.idProduct == pids[i])
-                               return true;
+       for (unsigned i = 0; vids[i]; i++) {
+               if (dev_desc->idVendor == vids[i] &&
+                       dev_desc->idProduct == pids[i]) {
+                       return true;
                }
        }
        return false;
 }
 
+/* Returns true if the string descriptor indexed by str_index in device matches string */
+static bool string_descriptor_equal(libusb_device_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 = libusb_get_string_descriptor_ascii(device, str_index,
+                       (unsigned char *)desc_string, sizeof(desc_string)-1);
+       if (retval < 0) {
+               LOG_ERROR("libusb_get_string_descriptor_ascii() 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 cnt, idx, errCode;
+       int retval = -ENODEV;
+       struct jtag_libusb_device_handle *libusb_handle = NULL;
 
        if (libusb_init(&jtag_libusb_context) < 0)
                return -ENODEV;
 
-       libusb_set_debug(jtag_libusb_context, 3);
-
        cnt = libusb_get_device_list(jtag_libusb_context, &devs);
 
        for (idx = 0; idx < cnt; idx++) {
-               if (!jtag_libusb_match(devs[idx], vids, pids))
+               struct libusb_device_descriptor dev_desc;
+
+               if (libusb_get_device_descriptor(devs[idx], &dev_desc) != 0)
                        continue;
 
-               errCode = libusb_open(devs[idx], out);
+               if (!jtag_libusb_match(&dev_desc, vids, pids))
+                       continue;
 
-               /** Free the device list **/
-               libusb_free_device_list(devs, 1);
+               errCode = libusb_open(devs[idx], &libusb_handle);
+
+               if (errCode) {
+                       LOG_ERROR("libusb_open() failed with %s",
+                                 libusb_error_name(errCode));
+                       continue;
+               }
+
+               /* Device must be open to use libusb_get_string_descriptor_ascii. */
+               if (serial != NULL &&
+                               !string_descriptor_equal(libusb_handle, dev_desc.iSerialNumber, serial)) {
+                       libusb_close(libusb_handle);
+                       continue;
+               }
 
-               if (errCode < 0)
-                       return errCode;
-               return 0;
+               /* Success. */
+               *out = libusb_handle;
+               retval = 0;
+               break;
        }
-       return -ENODEV;
+       if (cnt >= 0)
+               libusb_free_device_list(devs, 1);
+       return retval;
 }
 
 void jtag_libusb_close(jtag_libusb_device_handle *dev)
 {
        /* Close device */
-       jtag_libusb_close(dev);
+       libusb_close(dev);
 
        libusb_exit(jtag_libusb_context);
 }
 
+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 = libusb_control_transfer(dev, requestType, request, wValue, wIndex,
+                               (unsigned char *)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)
 {
        int transferred = 0;
 
@@ -90,7 +149,7 @@ int jtag_libusb_bulk_write(jtag_libusb_device_handle *dev, int ep, char *bytes,
 }
 
 int jtag_libusb_bulk_read(jtag_libusb_device_handle *dev, int ep, char *bytes,
-                         int size, int timeout)
+               int size, int timeout)
 {
        int transferred = 0;
 
@@ -100,12 +159,12 @@ int jtag_libusb_bulk_read(jtag_libusb_device_handle *dev, int ep, char *bytes,
 }
 
 int jtag_libusb_set_configuration(jtag_libusb_device_handle *devh,
-                                 int configuration)
+               int configuration)
 {
        struct jtag_libusb_device *udev = jtag_libusb_get_device(devh);
        int retCode = -99;
 
-       struct libusb_config_descriptor *config;
+       struct libusb_config_descriptor *config = NULL;
 
        libusb_get_config_descriptor(udev, configuration, &config);
        retCode = libusb_set_configuration(devh, config->bConfigurationValue);
@@ -116,8 +175,8 @@ int jtag_libusb_set_configuration(jtag_libusb_device_handle *devh,
 }
 
 int jtag_libusb_get_endpoints(struct jtag_libusb_device *udev,
-                             unsigned int *usb_read_ep,
-                             unsigned int *usb_write_ep)
+               unsigned int *usb_read_ep,
+               unsigned int *usb_write_ep)
 {
        const struct libusb_interface *inter;
        const struct libusb_interface_descriptor *interdesc;
@@ -150,3 +209,16 @@ int jtag_libusb_get_endpoints(struct jtag_libusb_device *udev,
 
        return 0;
 }
+
+int jtag_libusb_get_pid(struct jtag_libusb_device *dev, uint16_t *pid)
+{
+       struct libusb_device_descriptor dev_desc;
+
+       if (libusb_get_device_descriptor(dev, &dev_desc) == 0) {
+               *pid = dev_desc.idProduct;
+
+               return ERROR_OK;
+       }
+
+       return ERROR_FAIL;
+}

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)