src/jtag/drivers/libusb1_common.c

   1 /***************************************************************************
   2  *   Copyright (C) 2009 by Zachary T Welch <zw@superlucidity.net>          *
   3  *                                                                         *
   4  *   Copyright (C) 2011 by Mauro Gamba <maurillo71@gmail.com>              *
   5  *                                                                         *
   6  *   This program is free software; you can redistribute it and/or modify  *
   7  *   it under the terms of the GNU General Public License as published by  *
   8  *   the Free Software Foundation; either version 2 of the License, or     *
   9  *   (at your option) any later version.                                   *
  10  *                                                                         *
  11  *   This program is distributed in the hope that it will be useful,       *
  12  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  13  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  14  *   GNU General Public License for more details.                          *
  15  *                                                                         *
  16  *   You should have received a copy of the GNU General Public License     *
  17  *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
  18  ***************************************************************************/
  19
  20 #ifdef HAVE_CONFIG_H
  21 #include "config.h"
  22 #endif
  23 #include <jtag/drivers/jtag_usb_common.h>
  24 #include "libusb1_common.h"
  25 #include "log.h"
  26
  27 /*
  28  * comment from libusb:
  29  * As per the USB 3.0 specs, the current maximum limit for the depth is 7.
  30  */
  31 #define MAX_USB_PORTS   7
  32
  33 static struct libusb_context *jtag_libusb_context; /**< Libusb context **/
  34 static libusb_device **devs; /**< The usb device list **/
  35
  36 static int jtag_libusb_error(int err)
  37 {
  38         switch (err) {
  39         case LIBUSB_SUCCESS:
  40                 return ERROR_OK;
  41         case LIBUSB_ERROR_TIMEOUT:
  42                 return ERROR_TIMEOUT_REACHED;
  43         case LIBUSB_ERROR_IO:
  44         case LIBUSB_ERROR_INVALID_PARAM:
  45         case LIBUSB_ERROR_ACCESS:
  46         case LIBUSB_ERROR_NO_DEVICE:
  47         case LIBUSB_ERROR_NOT_FOUND:
  48         case LIBUSB_ERROR_BUSY:
  49         case LIBUSB_ERROR_OVERFLOW:
  50         case LIBUSB_ERROR_PIPE:
  51         case LIBUSB_ERROR_INTERRUPTED:
  52         case LIBUSB_ERROR_NO_MEM:
  53         case LIBUSB_ERROR_NOT_SUPPORTED:
  54         case LIBUSB_ERROR_OTHER:
  55                 return ERROR_FAIL;
  56         default:
  57                 return ERROR_FAIL;
  58         }
  59 }
  60
  61 static bool jtag_libusb_match(struct libusb_device_descriptor *dev_desc,
  62                 const uint16_t vids[], const uint16_t pids[])
  63 {
  64         for (unsigned i = 0; vids[i]; i++) {
  65                 if (dev_desc->idVendor == vids[i] &&
  66                         dev_desc->idProduct == pids[i]) {
  67                         return true;
  68                 }
  69         }
  70         return false;
  71 }
  72
  73 #ifdef HAVE_LIBUSB_GET_PORT_NUMBERS
  74 static bool jtag_libusb_location_equal(libusb_device *device)
  75 {
  76         uint8_t port_path[MAX_USB_PORTS];
  77         uint8_t dev_bus;
  78         int path_len;
  79
  80         path_len = libusb_get_port_numbers(device, port_path, MAX_USB_PORTS);
  81         if (path_len == LIBUSB_ERROR_OVERFLOW) {
  82                 LOG_WARNING("cannot determine path to usb device! (more than %i ports in path)\n",
  83                         MAX_USB_PORTS);
  84                 return false;
  85         }
  86         dev_bus = libusb_get_bus_number(device);
  87
  88         return jtag_usb_location_equal(dev_bus, port_path, path_len);
  89 }
  90 #else /* HAVE_LIBUSB_GET_PORT_NUMBERS */
  91 static bool jtag_libusb_location_equal(libusb_device *device)
  92 {
  93         return true;
  94 }
  95 #endif /* HAVE_LIBUSB_GET_PORT_NUMBERS */
  96
  97
  98 /* Returns true if the string descriptor indexed by str_index in device matches string */
  99 static bool string_descriptor_equal(libusb_device_handle *device, uint8_t str_index,
 100                                                                         const char *string)
 101 {
 102         int retval;
 103         bool matched;
 104         char desc_string[256+1]; /* Max size of string descriptor */
 105
 106         if (str_index == 0)
 107                 return false;
 108
 109         retval = libusb_get_string_descriptor_ascii(device, str_index,
 110                         (unsigned char *)desc_string, sizeof(desc_string)-1);
 111         if (retval < 0) {
 112                 LOG_ERROR("libusb_get_string_descriptor_ascii() failed with %d", retval);
 113                 return false;
 114         }
 115
 116         /* Null terminate descriptor string in case it needs to be logged. */
 117         desc_string[sizeof(desc_string)-1] = '\0';
 118
 119         matched = strncmp(string, desc_string, sizeof(desc_string)) == 0;
 120         if (!matched)
 121                 LOG_DEBUG("Device serial number '%s' doesn't match requested serial '%s'",
 122                         desc_string, string);
 123         return matched;
 124 }
 125
 126 int jtag_libusb_open(const uint16_t vids[], const uint16_t pids[],
 127                 const char *serial,
 128                 struct libusb_device_handle **out)
 129 {
 130         int cnt, idx, errCode;
 131         int retval = ERROR_FAIL;
 132         bool serial_mismatch = false;
 133         struct libusb_device_handle *libusb_handle = NULL;
 134
 135         if (libusb_init(&jtag_libusb_context) < 0)
 136                 return ERROR_FAIL;
 137
 138         cnt = libusb_get_device_list(jtag_libusb_context, &devs);
 139
 140         for (idx = 0; idx < cnt; idx++) {
 141                 struct libusb_device_descriptor dev_desc;
 142
 143                 if (libusb_get_device_descriptor(devs[idx], &dev_desc) != 0)
 144                         continue;
 145
 146                 if (!jtag_libusb_match(&dev_desc, vids, pids))
 147                         continue;
 148
 149                 if (jtag_usb_get_location() && !jtag_libusb_location_equal(devs[idx]))
 150                         continue;
 151
 152                 errCode = libusb_open(devs[idx], &libusb_handle);
 153
 154                 if (errCode) {
 155                         LOG_ERROR("libusb_open() failed with %s",
 156                                   libusb_error_name(errCode));
 157                         continue;
 158                 }
 159
 160                 /* Device must be open to use libusb_get_string_descriptor_ascii. */
 161                 if (serial != NULL &&
 162                                 !string_descriptor_equal(libusb_handle, dev_desc.iSerialNumber, serial)) {
 163                         serial_mismatch = true;
 164                         libusb_close(libusb_handle);
 165                         continue;
 166                 }
 167
 168                 /* Success. */
 169                 *out = libusb_handle;
 170                 retval = ERROR_OK;
 171                 serial_mismatch = false;
 172                 break;
 173         }
 174         if (cnt >= 0)
 175                 libusb_free_device_list(devs, 1);
 176
 177         if (serial_mismatch)
 178                 LOG_INFO("No device matches the serial string");
 179
 180         return retval;
 181 }
 182
 183 void jtag_libusb_close(struct libusb_device_handle *dev)
 184 {
 185         /* Close device */
 186         libusb_close(dev);
 187
 188         libusb_exit(jtag_libusb_context);
 189 }
 190
 191 int jtag_libusb_control_transfer(struct libusb_device_handle *dev, uint8_t requestType,
 192                 uint8_t request, uint16_t wValue, uint16_t wIndex, char *bytes,
 193                 uint16_t size, unsigned int timeout)
 194 {
 195         int transferred = 0;
 196
 197         transferred = libusb_control_transfer(dev, requestType, request, wValue, wIndex,
 198                                 (unsigned char *)bytes, size, timeout);
 199
 200         if (transferred < 0)
 201                 transferred = 0;
 202
 203         return transferred;
 204 }
 205
 206 int jtag_libusb_bulk_write(struct libusb_device_handle *dev, int ep, char *bytes,
 207                            int size, int timeout, int *transferred)
 208 {
 209         int ret;
 210
 211         *transferred = 0;
 212
 213         ret = libusb_bulk_transfer(dev, ep, (unsigned char *)bytes, size,
 214                                    transferred, timeout);
 215         if (ret != LIBUSB_SUCCESS) {
 216                 LOG_ERROR("libusb_bulk_write error: %s", libusb_error_name(ret));
 217                 return jtag_libusb_error(ret);
 218         }
 219
 220         return ERROR_OK;
 221 }
 222
 223 int jtag_libusb_bulk_read(struct libusb_device_handle *dev, int ep, char *bytes,
 224                           int size, int timeout, int *transferred)
 225 {
 226         int ret;
 227
 228         *transferred = 0;
 229
 230         ret = libusb_bulk_transfer(dev, ep, (unsigned char *)bytes, size,
 231                                    transferred, timeout);
 232         if (ret != LIBUSB_SUCCESS) {
 233                 LOG_ERROR("libusb_bulk_read error: %s", libusb_error_name(ret));
 234                 return jtag_libusb_error(ret);
 235         }
 236
 237         return ERROR_OK;
 238 }
 239
 240 int jtag_libusb_set_configuration(struct libusb_device_handle *devh,
 241                 int configuration)
 242 {
 243         struct libusb_device *udev = libusb_get_device(devh);
 244         int retCode = -99;
 245
 246         struct libusb_config_descriptor *config = NULL;
 247         int current_config = -1;
 248
 249         retCode = libusb_get_configuration(devh, &current_config);
 250         if (retCode != 0)
 251                 return retCode;
 252
 253         retCode = libusb_get_config_descriptor(udev, configuration, &config);
 254         if (retCode != 0 || config == NULL)
 255                 return retCode;
 256
 257         /* Only change the configuration if it is not already set to the
 258            same one. Otherwise this issues a lightweight reset and hangs
 259            LPC-Link2 with JLink firmware. */
 260         if (current_config != config->bConfigurationValue)
 261                 retCode = libusb_set_configuration(devh, config->bConfigurationValue);
 262
 263         libusb_free_config_descriptor(config);
 264
 265         return retCode;
 266 }
 267
 268 int jtag_libusb_choose_interface(struct libusb_device_handle *devh,
 269                 unsigned int *usb_read_ep,
 270                 unsigned int *usb_write_ep,
 271                 int bclass, int subclass, int protocol, int trans_type)
 272 {
 273         struct libusb_device *udev = libusb_get_device(devh);
 274         const struct libusb_interface *inter;
 275         const struct libusb_interface_descriptor *interdesc;
 276         const struct libusb_endpoint_descriptor *epdesc;
 277         struct libusb_config_descriptor *config;
 278
 279         *usb_read_ep = *usb_write_ep = 0;
 280
 281         libusb_get_config_descriptor(udev, 0, &config);
 282         for (int i = 0; i < (int)config->bNumInterfaces; i++) {
 283                 inter = &config->interface[i];
 284
 285                 interdesc = &inter->altsetting[0];
 286                 for (int k = 0;
 287                      k < (int)interdesc->bNumEndpoints; k++) {
 288                         if ((bclass > 0 && interdesc->bInterfaceClass != bclass) ||
 289                             (subclass > 0 && interdesc->bInterfaceSubClass != subclass) ||
 290                             (protocol > 0 && interdesc->bInterfaceProtocol != protocol))
 291                                 continue;
 292
 293                         epdesc = &interdesc->endpoint[k];
 294                         if (trans_type > 0 && (epdesc->bmAttributes & 0x3) != trans_type)
 295                                 continue;
 296
 297                         uint8_t epnum = epdesc->bEndpointAddress;
 298                         bool is_input = epnum & 0x80;
 299                         LOG_DEBUG("usb ep %s %02x",
 300                                   is_input ? "in" : "out", epnum);
 301
 302                         if (is_input)
 303                                 *usb_read_ep = epnum;
 304                         else
 305                                 *usb_write_ep = epnum;
 306
 307                         if (*usb_read_ep && *usb_write_ep) {
 308                                 LOG_DEBUG("Claiming interface %d", (int)interdesc->bInterfaceNumber);
 309                                 libusb_claim_interface(devh, (int)interdesc->bInterfaceNumber);
 310                                 libusb_free_config_descriptor(config);
 311                                 return ERROR_OK;
 312                         }
 313                 }
 314         }
 315         libusb_free_config_descriptor(config);
 316
 317         return ERROR_FAIL;
 318 }
 319
 320 int jtag_libusb_get_pid(struct libusb_device *dev, uint16_t *pid)
 321 {
 322         struct libusb_device_descriptor dev_desc;
 323
 324         if (libusb_get_device_descriptor(dev, &dev_desc) == 0) {
 325                 *pid = dev_desc.idProduct;
 326
 327                 return ERROR_OK;
 328         }
 329
 330         return ERROR_FAIL;
 331 }