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  * Copyright (C) 2015 Daniel Elstner <daniel.kitta@gmail.com>
   7  *
   8  * This program is free software: you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation, either version 3 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20  */
  21
  22 #include <config.h>
  23 #include <stdlib.h>
  24 #include <memory.h>
  25 #include <glib.h>
  26 #include <libusb.h>
  27 #include <libsigrok/libsigrok.h>
  28 #include "libsigrok-internal.h"
  29
  30 /* SR_CONF_CONN takes one of these: */
  31 #define CONN_USB_VIDPID  "^([0-9a-z]{4})\\.([0-9a-z]{4})$"
  32 #define CONN_USB_BUSADDR "^(\\d+)\\.(\\d+)$"
  33
  34 #define LOG_PREFIX "usb"
  35
  36 #if !HAVE_LIBUSB_OS_HANDLE
  37 typedef int libusb_os_handle;
  38 #endif
  39
  40 /** Custom GLib event source for libusb I/O.
  41  * @internal
  42  */
  43 struct usb_source {
  44         GSource base;
  45
  46         int64_t timeout_us;
  47         int64_t due_us;
  48
  49         /* Needed to keep track of installed sources */
  50         struct sr_session *session;
  51
  52         struct libusb_context *usb_ctx;
  53         GPtrArray *pollfds;
  54 };
  55
  56 /** USB event source prepare() method.
  57  */
  58 static gboolean usb_source_prepare(GSource *source, int *timeout)
  59 {
  60         int64_t now_us, usb_due_us;
  61         struct usb_source *usource;
  62         struct timeval usb_timeout;
  63         int remaining_ms;
  64         int ret;
  65
  66         usource = (struct usb_source *)source;
  67
  68         ret = libusb_get_next_timeout(usource->usb_ctx, &usb_timeout);
  69         if (G_UNLIKELY(ret < 0)) {
  70                 sr_err("Failed to get libusb timeout: %s",
  71                         libusb_error_name(ret));
  72         }
  73         now_us = g_source_get_time(source);
  74
  75         if (usource->due_us == 0) {
  76                 /* First-time initialization of the expiration time */
  77                 usource->due_us = now_us + usource->timeout_us;
  78         }
  79         if (ret == 1) {
  80                 usb_due_us = (int64_t)usb_timeout.tv_sec * G_USEC_PER_SEC
  81                                 + usb_timeout.tv_usec + now_us;
  82                 if (usb_due_us < usource->due_us)
  83                         usource->due_us = usb_due_us;
  84         }
  85         if (usource->due_us != INT64_MAX)
  86                 remaining_ms = (MAX(0, usource->due_us - now_us) + 999) / 1000;
  87         else
  88                 remaining_ms = -1;
  89
  90         *timeout = remaining_ms;
  91
  92         return (remaining_ms == 0);
  93 }
  94
  95 /** USB event source check() method.
  96  */
  97 static gboolean usb_source_check(GSource *source)
  98 {
  99         struct usb_source *usource;
 100         GPollFD *pollfd;
 101         unsigned int revents;
 102         unsigned int i;
 103
 104         usource = (struct usb_source *)source;
 105         revents = 0;
 106
 107         for (i = 0; i < usource->pollfds->len; i++) {
 108                 pollfd = g_ptr_array_index(usource->pollfds, i);
 109                 revents |= pollfd->revents;
 110         }
 111         return (revents != 0 || (usource->due_us != INT64_MAX
 112                         && usource->due_us <= g_source_get_time(source)));
 113 }
 114
 115 /** USB event source dispatch() method.
 116  */
 117 static gboolean usb_source_dispatch(GSource *source,
 118                 GSourceFunc callback, void *user_data)
 119 {
 120         struct usb_source *usource;
 121         GPollFD *pollfd;
 122         unsigned int revents;
 123         unsigned int i;
 124         gboolean keep;
 125
 126         usource = (struct usb_source *)source;
 127         revents = 0;
 128         /*
 129          * This is somewhat arbitrary, but drivers use revents to distinguish
 130          * actual I/O from timeouts. When we remove the user timeout from the
 131          * driver API, this will no longer be needed.
 132          */
 133         for (i = 0; i < usource->pollfds->len; i++) {
 134                 pollfd = g_ptr_array_index(usource->pollfds, i);
 135                 revents |= pollfd->revents;
 136         }
 137         if (revents != 0)
 138                 sr_spew("%s: revents 0x%.2X", __func__, revents);
 139         else
 140                 sr_spew("%s: timed out", __func__);
 141
 142         if (!callback) {
 143                 sr_err("Callback not set, cannot dispatch event.");
 144                 return G_SOURCE_REMOVE;
 145         }
 146         keep = (*(sr_receive_data_callback)callback)(-1, revents, user_data);
 147
 148         if (G_LIKELY(keep) && G_LIKELY(!g_source_is_destroyed(source))) {
 149                 if (usource->timeout_us >= 0)
 150                         usource->due_us = g_source_get_time(source)
 151                                         + usource->timeout_us;
 152                 else
 153                         usource->due_us = INT64_MAX;
 154         }
 155         return keep;
 156 }
 157
 158 /** USB event source finalize() method.
 159  */
 160 static void usb_source_finalize(GSource *source)
 161 {
 162         struct usb_source *usource;
 163
 164         usource = (struct usb_source *)source;
 165
 166         sr_spew("%s", __func__);
 167
 168         libusb_set_pollfd_notifiers(usource->usb_ctx, NULL, NULL, NULL);
 169
 170         g_ptr_array_unref(usource->pollfds);
 171         usource->pollfds = NULL;
 172
 173         sr_session_source_destroyed(usource->session,
 174                         usource->usb_ctx, source);
 175 }
 176
 177 /** Callback invoked when a new libusb FD should be added to the poll set.
 178  */
 179 static LIBUSB_CALL void usb_pollfd_added(libusb_os_handle fd,
 180                 short events, void *user_data)
 181 {
 182         struct usb_source *usource;
 183         GPollFD *pollfd;
 184
 185         usource = user_data;
 186
 187         pollfd = g_slice_new(GPollFD);
 188 #ifdef G_OS_WIN32
 189         events = G_IO_IN;
 190 #endif
 191         pollfd->fd = (gintptr)fd;
 192         pollfd->events = events;
 193         pollfd->revents = 0;
 194
 195         g_ptr_array_add(usource->pollfds, pollfd);
 196         g_source_add_poll((GSource *)usource, pollfd);
 197 }
 198
 199 /** Callback invoked when a libusb FD should be removed from the poll set.
 200  */
 201 static LIBUSB_CALL void usb_pollfd_removed(libusb_os_handle fd, void *user_data)
 202 {
 203         struct usb_source *usource;
 204         GPollFD *pollfd;
 205         unsigned int i;
 206
 207         usource = user_data;
 208
 209         /* It's likely that the removed poll FD is at the end.
 210          */
 211         for (i = usource->pollfds->len; G_LIKELY(i > 0); i--) {
 212                 pollfd = g_ptr_array_index(usource->pollfds, i - 1);
 213
 214                 if ((libusb_os_handle)pollfd->fd == fd) {
 215                         g_source_remove_poll((GSource *)usource, pollfd);
 216                         g_ptr_array_remove_index_fast(usource->pollfds, i - 1);
 217                         return;
 218                 }
 219         }
 220         sr_err("FD to be removed (%" G_GINTPTR_FORMAT
 221                 ") not found in event source poll set.", (gintptr)fd);
 222 }
 223
 224 /** Destroy notify callback for FDs maintained by the USB event source.
 225  */
 226 static void usb_source_free_pollfd(void *data)
 227 {
 228         g_slice_free(GPollFD, data);
 229 }
 230
 231 /** Create an event source for libusb I/O.
 232  *
 233  * TODO: The combination of the USB I/O source with a user timeout is
 234  * conceptually broken. The user timeout supplied here is completely
 235  * unrelated to I/O -- the actual I/O timeout is set when submitting
 236  * a USB transfer.
 237  * The sigrok drivers generally use the timeout to poll device state.
 238  * Usually, this polling can be sensibly done only when there is no
 239  * active USB transfer -- i.e. it's actually mutually exclusive with
 240  * waiting for transfer completion.
 241  * Thus, the user timeout should be removed from the USB event source
 242  * API at some point. Instead, drivers should install separate timer
 243  * event sources for their polling needs.
 244  *
 245  * @param session The session the event source belongs to.
 246  * @param usb_ctx The libusb context for which to handle events.
 247  * @param timeout_ms The timeout interval in ms, or -1 to wait indefinitely.
 248  * @return A new event source object, or NULL on failure.
 249  */
 250 static GSource *usb_source_new(struct sr_session *session,
 251                 struct libusb_context *usb_ctx, int timeout_ms)
 252 {
 253         static GSourceFuncs usb_source_funcs = {
 254                 .prepare  = &usb_source_prepare,
 255                 .check    = &usb_source_check,
 256                 .dispatch = &usb_source_dispatch,
 257                 .finalize = &usb_source_finalize
 258         };
 259         GSource *source;
 260         struct usb_source *usource;
 261         const struct libusb_pollfd **upollfds, **upfd;
 262
 263         upollfds = libusb_get_pollfds(usb_ctx);
 264         if (!upollfds) {
 265                 sr_err("Failed to get libusb file descriptors.");
 266                 return NULL;
 267         }
 268         source = g_source_new(&usb_source_funcs, sizeof(struct usb_source));
 269         usource = (struct usb_source *)source;
 270
 271         g_source_set_name(source, "usb");
 272
 273         if (timeout_ms >= 0) {
 274                 usource->timeout_us = 1000 * (int64_t)timeout_ms;
 275                 usource->due_us = 0;
 276         } else {
 277                 usource->timeout_us = -1;
 278                 usource->due_us = INT64_MAX;
 279         }
 280         usource->session = session;
 281         usource->usb_ctx = usb_ctx;
 282         usource->pollfds = g_ptr_array_new_full(8, &usb_source_free_pollfd);
 283
 284         for (upfd = upollfds; *upfd != NULL; upfd++)
 285                 usb_pollfd_added((*upfd)->fd, (*upfd)->events, usource);
 286
 287 #if (LIBUSB_API_VERSION >= 0x01000104)
 288         libusb_free_pollfds(upollfds);
 289 #else
 290         free(upollfds);
 291 #endif
 292         libusb_set_pollfd_notifiers(usb_ctx,
 293                 &usb_pollfd_added, &usb_pollfd_removed, usource);
 294
 295         return source;
 296 }
 297
 298 /**
 299  * Find USB devices according to a connection string.
 300  *
 301  * @param usb_ctx libusb context to use while scanning.
 302  * @param conn Connection string specifying the device(s) to match. This
 303  * can be of the form "<bus>.<address>", or "<vendorid>.<productid>".
 304  *
 305  * @return A GSList of struct sr_usb_dev_inst, with bus and address fields
 306  * matching the device that matched the connection string. The GSList and
 307  * its contents must be freed by the caller.
 308  */
 309 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn)
 310 {
 311         struct sr_usb_dev_inst *usb;
 312         struct libusb_device **devlist;
 313         struct libusb_device_descriptor des;
 314         GSList *devices;
 315         GRegex *reg;
 316         GMatchInfo *match;
 317         int vid, pid, bus, addr, b, a, ret, i;
 318         char *mstr;
 319
 320         vid = pid = bus = addr = 0;
 321         reg = g_regex_new(CONN_USB_VIDPID, 0, 0, NULL);
 322         if (g_regex_match(reg, conn, 0, &match)) {
 323                 if ((mstr = g_match_info_fetch(match, 1)))
 324                         vid = strtoul(mstr, NULL, 16);
 325                 g_free(mstr);
 326
 327                 if ((mstr = g_match_info_fetch(match, 2)))
 328                         pid = strtoul(mstr, NULL, 16);
 329                 g_free(mstr);
 330                 sr_dbg("Trying to find USB device with VID:PID = %04x:%04x.",
 331                        vid, pid);
 332         } else {
 333                 g_match_info_unref(match);
 334                 g_regex_unref(reg);
 335                 reg = g_regex_new(CONN_USB_BUSADDR, 0, 0, NULL);
 336                 if (g_regex_match(reg, conn, 0, &match)) {
 337                         if ((mstr = g_match_info_fetch(match, 1)))
 338                                 bus = strtoul(mstr, NULL, 10);
 339                         g_free(mstr);
 340
 341                         if ((mstr = g_match_info_fetch(match, 2)))
 342                                 addr = strtoul(mstr, NULL, 10);
 343                         g_free(mstr);
 344                         sr_dbg("Trying to find USB device with bus.address = "
 345                                "%d.%d.", bus, addr);
 346                 }
 347         }
 348         g_match_info_unref(match);
 349         g_regex_unref(reg);
 350
 351         if (vid + pid + bus + addr == 0) {
 352                 sr_err("Neither VID:PID nor bus.address was specified.");
 353                 return NULL;
 354         }
 355
 356         if (bus > 64) {
 357                 sr_err("Invalid bus specified: %d.", bus);
 358                 return NULL;
 359         }
 360
 361         if (addr > 127) {
 362                 sr_err("Invalid address specified: %d.", addr);
 363                 return NULL;
 364         }
 365
 366         /* Looks like a valid USB device specification, but is it connected? */
 367         devices = NULL;
 368         libusb_get_device_list(usb_ctx, &devlist);
 369         for (i = 0; devlist[i]; i++) {
 370                 if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
 371                         sr_err("Failed to get device descriptor: %s.",
 372                                libusb_error_name(ret));
 373                         continue;
 374                 }
 375
 376                 if (vid + pid && (des.idVendor != vid || des.idProduct != pid))
 377                         continue;
 378
 379                 b = libusb_get_bus_number(devlist[i]);
 380                 a = libusb_get_device_address(devlist[i]);
 381                 if (bus + addr && (b != bus || a != addr))
 382                         continue;
 383
 384                 sr_dbg("Found USB device (VID:PID = %04x:%04x, bus.address = "
 385                        "%d.%d).", des.idVendor, des.idProduct, b, a);
 386
 387                 usb = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
 388                                 libusb_get_device_address(devlist[i]), NULL);
 389                 devices = g_slist_append(devices, usb);
 390         }
 391         libusb_free_device_list(devlist, 1);
 392
 393         sr_dbg("Found %d device(s).", g_slist_length(devices));
 394
 395         return devices;
 396 }
 397
 398 SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb)
 399 {
 400         struct libusb_device **devlist;
 401         struct libusb_device_descriptor des;
 402         int ret, r, cnt, i, a, b;
 403
 404         sr_dbg("Trying to open USB device %d.%d.", usb->bus, usb->address);
 405
 406         if ((cnt = libusb_get_device_list(usb_ctx, &devlist)) < 0) {
 407                 sr_err("Failed to retrieve device list: %s.",
 408                        libusb_error_name(cnt));
 409                 return SR_ERR;
 410         }
 411
 412         ret = SR_ERR;
 413         for (i = 0; i < cnt; i++) {
 414                 if ((r = libusb_get_device_descriptor(devlist[i], &des)) < 0) {
 415                         sr_err("Failed to get device descriptor: %s.",
 416                                libusb_error_name(r));
 417                         continue;
 418                 }
 419
 420                 b = libusb_get_bus_number(devlist[i]);
 421                 a = libusb_get_device_address(devlist[i]);
 422                 if (b != usb->bus || a != usb->address)
 423                         continue;
 424
 425                 if ((r = libusb_open(devlist[i], &usb->devhdl)) < 0) {
 426                         sr_err("Failed to open device: %s.",
 427                                libusb_error_name(r));
 428                         break;
 429                 }
 430
 431                 sr_dbg("Opened USB device (VID:PID = %04x:%04x, bus.address = "
 432                        "%d.%d).", des.idVendor, des.idProduct, b, a);
 433
 434                 ret = SR_OK;
 435                 break;
 436         }
 437
 438         libusb_free_device_list(devlist, 1);
 439
 440         return ret;
 441 }
 442
 443 SR_PRIV void sr_usb_close(struct sr_usb_dev_inst *usb)
 444 {
 445         libusb_close(usb->devhdl);
 446         usb->devhdl = NULL;
 447         sr_dbg("Closed USB device %d.%d.", usb->bus, usb->address);
 448 }
 449
 450 SR_PRIV int usb_source_add(struct sr_session *session, struct sr_context *ctx,
 451                 int timeout, sr_receive_data_callback cb, void *cb_data)
 452 {
 453         GSource *source;
 454         int ret;
 455
 456         source = usb_source_new(session, ctx->libusb_ctx, timeout);
 457         if (!source)
 458                 return SR_ERR;
 459
 460         g_source_set_callback(source, (GSourceFunc)cb, cb_data, NULL);
 461
 462         ret = sr_session_source_add_internal(session, ctx->libusb_ctx, source);
 463         g_source_unref(source);
 464
 465         return ret;
 466 }
 467
 468 SR_PRIV int usb_source_remove(struct sr_session *session, struct sr_context *ctx)
 469 {
 470         return sr_session_source_remove_internal(session, ctx->libusb_ctx);
 471 }
 472
 473 SR_PRIV int usb_get_port_path(libusb_device *dev, char *path, int path_len)
 474 {
 475         uint8_t port_numbers[8];
 476         int i, n, len;
 477
 478 /*
 479  * FreeBSD requires that devices prior to calling libusb_get_port_numbers()
 480  * have been opened with libusb_open().
 481  */
 482 #ifdef __FreeBSD__
 483         struct libusb_device_handle *devh;
 484         if (libusb_open(dev, &devh) != 0)
 485                 return SR_ERR;
 486 #endif
 487         n = libusb_get_port_numbers(dev, port_numbers, sizeof(port_numbers));
 488 #ifdef __FreeBSD__
 489         libusb_close(devh);
 490 #endif
 491
 492 /* Workaround FreeBSD libusb_get_port_numbers() returning 0. */
 493 #ifdef __FreeBSD__
 494         if (n == 0) {
 495                 port_numbers[0] = libusb_get_device_address(dev);
 496                 n = 1;
 497         }
 498 #endif
 499         if (n < 1)
 500                 return SR_ERR;
 501
 502         len = snprintf(path, path_len, "usb/%d-%d",
 503                        libusb_get_bus_number(dev), port_numbers[0]);
 504
 505         for (i = 1; i < n; i++)
 506                 len += snprintf(path+len, path_len-len, ".%d", port_numbers[i]);
 507
 508         return SR_OK;
 509 }