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 _WIN32
 188 /* Thread used to run libusb_wait_for_event() and set a pollable event. */
 189 static gpointer usb_thread(gpointer data)
 190 {
 191         struct sr_context *ctx = data;
 192
 193         while (ctx->usb_thread_running) {
 194                 /* Acquire event waiters lock, needed for libusb_wait_for_event(). */
 195                 libusb_lock_event_waiters(ctx->libusb_ctx);
 196                 /* Wait for any libusb event. The main thread can interrupt this wait
 197                  * by calling libusb_unlock_events(). */
 198                 libusb_wait_for_event(ctx->libusb_ctx, NULL);
 199                 /* Release event waiters lock. */
 200                 libusb_unlock_event_waiters(ctx->libusb_ctx);
 201                 /* Set event that the main loop will be polling on. */
 202                 SetEvent(ctx->usb_wait_complete_event);
 203                 /* Wait for the main thread to signal us to run again. */
 204                 WaitForSingleObject(ctx->usb_wait_request_event, INFINITE);
 205                 ResetEvent(ctx->usb_wait_request_event);
 206         }
 207
 208         return NULL;
 209 }
 210
 211 /* Callback wrapper run when main g_poll() gets a USB event or timeout. */
 212 static int usb_callback(int fd, int revents, void *cb_data)
 213 {
 214         struct sr_context *ctx = cb_data;
 215         int ret;
 216
 217         /* Run registered callback to handle libusb events. */
 218         ret = ctx->usb_cb(fd, revents, ctx->usb_cb_data);
 219
 220         /* Were we triggered by an event from the wait thread, rather than by a
 221          * timeout? */
 222         int triggered_by_event = (revents & G_IO_IN);
 223
 224         /* If so, and if the USB event source has not been removed from the
 225          * session, reset the event that woke us and tell the wait thread to start
 226          * waiting for events again. */
 227         if (triggered_by_event && ctx->usb_thread_running) {
 228                 ResetEvent(ctx->usb_wait_complete_event);
 229                 SetEvent(ctx->usb_wait_request_event);
 230         }
 231
 232         return ret;
 233 }
 234 #endif
 235
 236 SR_PRIV int usb_source_add(struct sr_session *session, struct sr_context *ctx,
 237                 int timeout, sr_receive_data_callback cb, void *cb_data)
 238 {
 239         int ret;
 240
 241         if (ctx->usb_source_present) {
 242                 sr_err("A USB event source is already present.");
 243                 return SR_ERR;
 244         }
 245
 246 #ifdef _WIN32
 247         /* Create events used to signal between main and USB wait threads. */
 248         ctx->usb_wait_request_event = CreateEvent(NULL, TRUE, FALSE, NULL);
 249         ctx->usb_wait_complete_event = CreateEvent(NULL, TRUE, FALSE, NULL);
 250         /* Start USB wait thread. */
 251         ctx->usb_thread_running = TRUE;
 252         ctx->usb_thread = g_thread_new("usb", usb_thread, ctx);
 253         /* Add event, set by USB wait thread, to session poll set. */
 254         ctx->usb_pollfd.fd = ctx->usb_wait_complete_event;
 255         ctx->usb_pollfd.events = G_IO_IN;
 256         ctx->usb_pollfd.revents = 0;
 257         ctx->usb_cb = cb;
 258         ctx->usb_cb_data = cb_data;
 259         ret = sr_session_source_add_pollfd(session, &ctx->usb_pollfd,
 260                         timeout, usb_callback, ctx);
 261 #else
 262         const struct libusb_pollfd **lupfd;
 263         GPollFD *pollfds;
 264         int i;
 265         int num_fds = 0;
 266
 267         lupfd = libusb_get_pollfds(ctx->libusb_ctx);
 268         if (!lupfd || !lupfd[0]) {
 269                 free(lupfd);
 270                 sr_err("Failed to get libusb file descriptors.");
 271                 return SR_ERR;
 272         }
 273         while (lupfd[num_fds])
 274                 ++num_fds;
 275         pollfds = g_new(GPollFD, num_fds);
 276
 277         for (i = 0; i < num_fds; ++i) {
 278                 pollfds[i].fd = lupfd[i]->fd;
 279                 pollfds[i].events = lupfd[i]->events;
 280                 pollfds[i].revents = 0;
 281         }
 282         free(lupfd);
 283         ret = sr_session_source_add_internal(session, pollfds, num_fds,
 284                         timeout, cb, cb_data, (gintptr)ctx->libusb_ctx);
 285         g_free(pollfds);
 286 #endif
 287         ctx->usb_source_present = (ret == SR_OK);
 288
 289         return ret;
 290 }
 291
 292 SR_PRIV int usb_source_remove(struct sr_session *session, struct sr_context *ctx)
 293 {
 294         int ret;
 295
 296         if (!ctx->usb_source_present)
 297                 return SR_OK;
 298
 299 #ifdef _WIN32
 300         /* Signal the USB wait thread to stop, then unblock it so it does. */
 301         ctx->usb_thread_running = FALSE;
 302         SetEvent(ctx->usb_wait_request_event);
 303         libusb_unlock_events(ctx->libusb_ctx);
 304         /* Wait for USB wait thread to terminate. */
 305         g_thread_join(ctx->usb_thread);
 306         /* Remove USB event from session poll set. */
 307         ret = sr_session_source_remove_pollfd(session, &ctx->usb_pollfd);
 308         /* Close event handles that were used between threads. */
 309         CloseHandle(ctx->usb_wait_request_event);
 310         CloseHandle(ctx->usb_wait_complete_event);
 311 #else
 312         ret = sr_session_source_remove_internal(session,
 313                         (gintptr)ctx->libusb_ctx);
 314 #endif
 315         ctx->usb_source_present = FALSE;
 316
 317         return ret;
 318 }
 319
 320 SR_PRIV int usb_get_port_path(libusb_device *dev, char *path, int path_len)
 321 {
 322         uint8_t port_numbers[8];
 323         int i, n, len;
 324
 325 /*
 326  * FreeBSD requires that devices prior to calling libusb_get_port_numbers()
 327  * have been opened with libusb_open().
 328  */
 329 #ifdef __FreeBSD__
 330         struct libusb_device_handle *devh;
 331         if (libusb_open(dev, &devh) != 0)
 332                 return SR_ERR;
 333 #endif
 334         n = libusb_get_port_numbers(dev, port_numbers, sizeof(port_numbers));
 335 #ifdef __FreeBSD__
 336         libusb_close(devh);
 337 #endif
 338
 339 /* Workaround FreeBSD libusb_get_port_numbers() returning 0. */
 340 #ifdef __FreeBSD__
 341         if (n == 0) {
 342                 port_numbers[0] = libusb_get_device_address(dev);
 343                 n = 1;
 344         }
 345 #endif
 346         if (n < 1)
 347                 return SR_ERR;
 348
 349         len = snprintf(path, path_len, "usb/%d-%d",
 350                        libusb_get_bus_number(dev), port_numbers[0]);
 351
 352         for (i = 1; i < n; i++)
 353                 len += snprintf(path+len, path_len-len, ".%d", port_numbers[i]);
 354
 355         return SR_OK;
 356 }