src/usb.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
   5  * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  20  */
  21
  22 #include <stdlib.h>
  23 #include <memory.h>
  24 #include <glib.h>
  25 #include <libusb.h>
  26 #include <libsigrok/libsigrok.h>
  27 #include "libsigrok-internal.h"
  28
  29 /* SR_CONF_CONN takes one of these: */
  30 #define CONN_USB_VIDPID  "^([0-9a-z]{4})\\.([0-9a-z]{4})$"
  31 #define CONN_USB_BUSADDR "^(\\d+)\\.(\\d+)$"
  32
  33 #define LOG_PREFIX "usb"
  34
  35 /**
  36  * Find USB devices according to a connection string.
  37  *
  38  * @param usb_ctx libusb context to use while scanning.
  39  * @param conn Connection string specifying the device(s) to match. This
  40  * can be of the form "<bus>.<address>", or "<vendorid>.<productid>".
  41  *
  42  * @return A GSList of struct sr_usb_dev_inst, with bus and address fields
  43  * matching the device that matched the connection string. The GSList and
  44  * its contents must be freed by the caller.
  45  */
  46 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn)
  47 {
  48         struct sr_usb_dev_inst *usb;
  49         struct libusb_device **devlist;
  50         struct libusb_device_descriptor des;
  51         GSList *devices;
  52         GRegex *reg;
  53         GMatchInfo *match;
  54         int vid, pid, bus, addr, b, a, ret, i;
  55         char *mstr;
  56
  57         vid = pid = bus = addr = 0;
  58         reg = g_regex_new(CONN_USB_VIDPID, 0, 0, NULL);
  59         if (g_regex_match(reg, conn, 0, &match)) {
  60                 if ((mstr = g_match_info_fetch(match, 1)))
  61                         vid = strtoul(mstr, NULL, 16);
  62                 g_free(mstr);
  63
  64                 if ((mstr = g_match_info_fetch(match, 2)))
  65                         pid = strtoul(mstr, NULL, 16);
  66                 g_free(mstr);
  67                 sr_dbg("Trying to find USB device with VID:PID = %04x:%04x.",
  68                        vid, pid);
  69         } else {
  70                 g_match_info_unref(match);
  71                 g_regex_unref(reg);
  72                 reg = g_regex_new(CONN_USB_BUSADDR, 0, 0, NULL);
  73                 if (g_regex_match(reg, conn, 0, &match)) {
  74                         if ((mstr = g_match_info_fetch(match, 1)))
  75                                 bus = strtoul(mstr, NULL, 10);
  76                         g_free(mstr);
  77
  78                         if ((mstr = g_match_info_fetch(match, 2)))
  79                                 addr = strtoul(mstr, NULL, 10);
  80                         g_free(mstr);
  81                         sr_dbg("Trying to find USB device with bus.address = "
  82                                "%d.%d.", bus, addr);
  83                 }
  84         }
  85         g_match_info_unref(match);
  86         g_regex_unref(reg);
  87
  88         if (vid + pid + bus + addr == 0) {
  89                 sr_err("Neither VID:PID nor bus.address was specified.");
  90                 return NULL;
  91         }
  92
  93         if (bus > 64) {
  94                 sr_err("Invalid bus specified: %d.", bus);
  95                 return NULL;
  96         }
  97
  98         if (addr > 127) {
  99                 sr_err("Invalid address specified: %d.", addr);
 100                 return NULL;
 101         }
 102
 103         /* Looks like a valid USB device specification, but is it connected? */
 104         devices = NULL;
 105         libusb_get_device_list(usb_ctx, &devlist);
 106         for (i = 0; devlist[i]; i++) {
 107                 if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
 108                         sr_err("Failed to get device descriptor: %s.",
 109                                libusb_error_name(ret));
 110                         continue;
 111                 }
 112
 113                 if (vid + pid && (des.idVendor != vid || des.idProduct != pid))
 114                         continue;
 115
 116                 b = libusb_get_bus_number(devlist[i]);
 117                 a = libusb_get_device_address(devlist[i]);
 118                 if (bus + addr && (b != bus || a != addr))
 119                         continue;
 120
 121                 sr_dbg("Found USB device (VID:PID = %04x:%04x, bus.address = "
 122                        "%d.%d).", des.idVendor, des.idProduct, b, a);
 123
 124                 usb = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
 125                                 libusb_get_device_address(devlist[i]), NULL);
 126                 devices = g_slist_append(devices, usb);
 127         }
 128         libusb_free_device_list(devlist, 1);
 129
 130         sr_dbg("Found %d device(s).", g_slist_length(devices));
 131
 132         return devices;
 133 }
 134
 135 SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb)
 136 {
 137         struct libusb_device **devlist;
 138         struct libusb_device_descriptor des;
 139         int ret, r, cnt, i, a, b;
 140
 141         sr_dbg("Trying to open USB device %d.%d.", usb->bus, usb->address);
 142
 143         if ((cnt = libusb_get_device_list(usb_ctx, &devlist)) < 0) {
 144                 sr_err("Failed to retrieve device list: %s.",
 145                        libusb_error_name(cnt));
 146                 return SR_ERR;
 147         }
 148
 149         ret = SR_ERR;
 150         for (i = 0; i < cnt; i++) {
 151                 if ((r = libusb_get_device_descriptor(devlist[i], &des)) < 0) {
 152                         sr_err("Failed to get device descriptor: %s.",
 153                                libusb_error_name(r));
 154                         continue;
 155                 }
 156
 157                 b = libusb_get_bus_number(devlist[i]);
 158                 a = libusb_get_device_address(devlist[i]);
 159                 if (b != usb->bus || a != usb->address)
 160                         continue;
 161
 162                 if ((r = libusb_open(devlist[i], &usb->devhdl)) < 0) {
 163                         sr_err("Failed to open device: %s.",
 164                                libusb_error_name(r));
 165                         break;
 166                 }
 167
 168                 sr_dbg("Opened USB device (VID:PID = %04x:%04x, bus.address = "
 169                        "%d.%d).", des.idVendor, des.idProduct, b, a);
 170
 171                 ret = SR_OK;
 172                 break;
 173         }
 174
 175         libusb_free_device_list(devlist, 1);
 176
 177         return ret;
 178 }
 179
 180 SR_PRIV void sr_usb_close(struct sr_usb_dev_inst *usb)
 181 {
 182         libusb_close(usb->devhdl);
 183         usb->devhdl = NULL;
 184         sr_dbg("Closed USB device %d.%d.", usb->bus, usb->address);
 185 }
 186
 187 #ifdef G_OS_WIN32
 188 /*
 189  * USB callback wrapper run when the main loop is idle.
 190  */
 191 static int usb_callback(int fd, int revents, void *cb_data)
 192 {
 193         int64_t start_time, stop_time, due, timeout;
 194         struct timeval tv;
 195         struct sr_context *ctx;
 196         int ret;
 197
 198         (void)fd;
 199         (void)revents;
 200         ctx = cb_data;
 201
 202         start_time = g_get_monotonic_time();
 203         due = ctx->usb_due;
 204
 205         if (due > start_time) {
 206                 timeout = due - start_time;
 207                 tv.tv_sec  = timeout / G_USEC_PER_SEC;
 208                 tv.tv_usec = timeout % G_USEC_PER_SEC;
 209
 210                 sr_spew("libusb_handle_events enter: %g ms timeout",
 211                         1e-3 * timeout);
 212
 213                 ret = libusb_handle_events_timeout_completed(ctx->libusb_ctx,
 214                                 (ctx->usb_timeout < 0) ? NULL : &tv, NULL);
 215                 if (ret != 0) {
 216                         /* Warn but still invoke the callback, to give
 217                          * the driver a chance to deal with the problem.
 218                          */
 219                         sr_warn("Error handling libusb event (%s)",
 220                                 libusb_error_name(ret));
 221                 }
 222                 stop_time = g_get_monotonic_time();
 223
 224                 sr_spew("libusb_handle_events leave: %g ms elapsed",
 225                         1e-3 * (stop_time - start_time));
 226                 /*
 227                  * The event source may have been removed by the driver's
 228                  * libusb transfer callback. Skip the callback in that case.
 229                  */
 230                 if (!ctx->usb_source_present)
 231                         return TRUE;
 232         } else {
 233                 /* Timeout already expired on entry.
 234                  */
 235                 stop_time = start_time;
 236
 237                 sr_spew("libusb_handle_events skipped");
 238         }
 239
 240         if (ctx->usb_timeout >= 0)
 241                 ctx->usb_due = stop_time + ctx->usb_timeout;
 242         /*
 243          * Run the registered callback to execute any follow-up activity
 244          * to libusb's event handling.
 245          */
 246         return ctx->usb_cb(-1, (stop_time < due) ? G_IO_IN : 0,
 247                         ctx->usb_cb_data);
 248 }
 249 #endif
 250
 251 SR_PRIV int usb_source_add(struct sr_session *session, struct sr_context *ctx,
 252                 int timeout, sr_receive_data_callback cb, void *cb_data)
 253 {
 254         int ret;
 255
 256         if (ctx->usb_source_present) {
 257                 sr_err("A USB event source is already present.");
 258                 return SR_ERR;
 259         }
 260
 261 #ifdef G_OS_WIN32
 262         if (timeout >= 0) {
 263                 ctx->usb_timeout = INT64_C(1000) * timeout;
 264                 ctx->usb_due = g_get_monotonic_time() + ctx->usb_timeout;
 265         } else {
 266                 ctx->usb_timeout = -1;
 267                 ctx->usb_due = INT64_MAX;
 268         }
 269         ctx->usb_cb = cb;
 270         ctx->usb_cb_data = cb_data;
 271         /*
 272          * TODO: Install an idle source which will fire permanently, and block
 273          * in a wrapper callback until any libusb events have been processed.
 274          * This will have to do for now, until we implement a proper way to
 275          * deal with libusb events on Windows.
 276          */
 277         ret = sr_session_source_add_internal(session, NULL, 0,
 278                         0, &usb_callback, ctx, (gintptr)ctx->libusb_ctx);
 279 #else
 280         const struct libusb_pollfd **lupfd;
 281         GPollFD *pollfds;
 282         int i;
 283         int num_fds = 0;
 284
 285         lupfd = libusb_get_pollfds(ctx->libusb_ctx);
 286         if (!lupfd || !lupfd[0]) {
 287                 free(lupfd);
 288                 sr_err("Failed to get libusb file descriptors.");
 289                 return SR_ERR;
 290         }
 291         while (lupfd[num_fds])
 292                 ++num_fds;
 293         pollfds = g_new(GPollFD, num_fds);
 294
 295         for (i = 0; i < num_fds; ++i) {
 296                 pollfds[i].fd = lupfd[i]->fd;
 297                 pollfds[i].events = lupfd[i]->events;
 298                 pollfds[i].revents = 0;
 299         }
 300         free(lupfd);
 301         ret = sr_session_source_add_internal(session, pollfds, num_fds,
 302                         timeout, cb, cb_data, (gintptr)ctx->libusb_ctx);
 303         g_free(pollfds);
 304 #endif
 305         ctx->usb_source_present = (ret == SR_OK);
 306
 307         return ret;
 308 }
 309
 310 SR_PRIV int usb_source_remove(struct sr_session *session, struct sr_context *ctx)
 311 {
 312         return sr_session_source_remove_internal(session,
 313                         (gintptr)ctx->libusb_ctx);
 314 }
 315
 316 SR_PRIV int usb_get_port_path(libusb_device *dev, char *path, int path_len)
 317 {
 318         uint8_t port_numbers[8];
 319         int i, n, len;
 320
 321 /*
 322  * FreeBSD requires that devices prior to calling libusb_get_port_numbers()
 323  * have been opened with libusb_open().
 324  */
 325 #ifdef __FreeBSD__
 326         struct libusb_device_handle *devh;
 327         if (libusb_open(dev, &devh) != 0)
 328                 return SR_ERR;
 329 #endif
 330         n = libusb_get_port_numbers(dev, port_numbers, sizeof(port_numbers));
 331 #ifdef __FreeBSD__
 332         libusb_close(devh);
 333 #endif
 334
 335 /* Workaround FreeBSD libusb_get_port_numbers() returning 0. */
 336 #ifdef __FreeBSD__
 337         if (n == 0) {
 338                 port_numbers[0] = libusb_get_device_address(dev);
 339                 n = 1;
 340         }
 341 #endif
 342         if (n < 1)
 343                 return SR_ERR;
 344
 345         len = snprintf(path, path_len, "usb/%d-%d",
 346                        libusb_get_bus_number(dev), port_numbers[0]);
 347
 348         for (i = 1; i < n; i++)
 349                 len += snprintf(path+len, path_len-len, ".%d", port_numbers[i]);
 350
 351         return SR_OK;
 352 }