]> sigrok.org Git - libsigrok.git/blobdiff - hardware/common/usb.c
Centralise duplicated logging helper defines.
[libsigrok.git] / hardware / common / usb.c
index 4c0c5b031069a0e10af1de091ffba7dc9488a4ad..6e678fdb401d1d681000fc3a6e273c7374656957 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * This file is part of the sigrok project.
+ * This file is part of the libsigrok project.
  *
  * Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
  * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
 
-/* SR_HWCAP_CONN takes one of these: */
-#define CONN_USB_VIDPID  "^([0-9a-z]{1,4})\\.([0-9a-z]{1,4})$"
+/* SR_CONF_CONN takes one of these: */
+#define CONN_USB_VIDPID  "^([0-9a-z]{4})\\.([0-9a-z]{4})$"
 #define CONN_USB_BUSADDR "^(\\d+)\\.(\\d+)$"
 
-/* Message logging helpers with driver-specific prefix string. */
-#define DRIVER_LOG_DOMAIN "usb: "
-#define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args)
-#define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args)
-#define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args)
-#define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args)
-#define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args)
-#define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args)
+/* Some USBTMC-specific enums, as defined in the USBTMC standard. */
+#define SUBCLASS_USBTMC 0x03
+#define USBTMC_USB488   0x01
+
+#define LOG_PREFIX "usb"
 
 /**
  * Find USB devices according to a connection string.
@@ -63,18 +60,12 @@ SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn)
        vid = pid = bus = addr = 0;
        reg = g_regex_new(CONN_USB_VIDPID, 0, 0, NULL);
        if (g_regex_match(reg, conn, 0, &match)) {
-               /* Extract VID. */
-               if ((mstr = g_match_info_fetch(match, 1))) {
+               if ((mstr = g_match_info_fetch(match, 1)))
                        vid = strtoul(mstr, NULL, 16);
-                       sr_spew("Extracted VID 0x%04x.", vid);
-               }
                g_free(mstr);
 
-               /* Extract PID. */
-               if ((mstr = g_match_info_fetch(match, 2))) {
+               if ((mstr = g_match_info_fetch(match, 2)))
                        pid = strtoul(mstr, NULL, 16);
-                       sr_spew("Extracted PID 0x%04x.", pid);
-               }
                g_free(mstr);
                sr_dbg("Trying to find USB device with VID:PID = %04x:%04x.",
                       vid, pid);
@@ -83,18 +74,12 @@ SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn)
                g_regex_unref(reg);
                reg = g_regex_new(CONN_USB_BUSADDR, 0, 0, NULL);
                if (g_regex_match(reg, conn, 0, &match)) {
-                       /* Extract bus. */
-                       if ((mstr = g_match_info_fetch(match, 1))) {
-                               bus = strtoul(mstr, NULL, 16);
-                               sr_spew("Extracted bus %d.", bus);
-                       }
+                       if ((mstr = g_match_info_fetch(match, 1)))
+                               bus = strtoul(mstr, NULL, 10);
                        g_free(mstr);
 
-                       /* Extract address. */
-                       if ((mstr = g_match_info_fetch(match, 2))) {
-                               addr = strtoul(mstr, NULL, 16);
-                               sr_spew("Extracted address %d.", addr);
-                       }
+                       if ((mstr = g_match_info_fetch(match, 2)))
+                               addr = strtoul(mstr, NULL, 10);
                        g_free(mstr);
                        sr_dbg("Trying to find USB device with bus.address = "
                               "%d.%d.", bus, addr);
@@ -104,7 +89,7 @@ SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn)
        g_regex_unref(reg);
 
        if (vid + pid + bus + addr == 0) {
-               sr_err("Neither VID:PID nor bus.address was found.");
+               sr_err("Neither VID:PID nor bus.address was specified.");
                return NULL;
        }
 
@@ -123,7 +108,8 @@ SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn)
        libusb_get_device_list(usb_ctx, &devlist);
        for (i = 0; devlist[i]; i++) {
                if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
-                       sr_err("Failed to get device descriptor: %d.", ret);
+                       sr_err("Failed to get device descriptor: %s.",
+                              libusb_error_name(ret));
                        continue;
                }
 
@@ -149,13 +135,70 @@ SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn)
        return devices;
 }
 
+/**
+ * Find USB devices supporting the USBTMC class
+ *
+ * @param usb_ctx libusb context to use while scanning.
+ *
+ * @return A GSList of struct sr_usb_dev_inst, with bus and address fields
+ * indicating devices with USBTMC support.
+ */
+SR_PRIV GSList *sr_usb_find_usbtmc(libusb_context *usb_ctx)
+{
+       struct sr_usb_dev_inst *usb;
+       struct libusb_device **devlist;
+       struct libusb_device_descriptor des;
+       struct libusb_config_descriptor *confdes;
+       const struct libusb_interface_descriptor *intfdes;
+       GSList *devices;
+       int confidx, intfidx, ret, i;
+
+       devices = NULL;
+       libusb_get_device_list(usb_ctx, &devlist);
+       for (i = 0; devlist[i]; i++) {
+               if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
+                       sr_err("Failed to get device descriptor: %s.",
+                              libusb_error_name(ret));
+                       continue;
+               }
+
+               for (confidx = 0; confidx < des.bNumConfigurations; confidx++) {
+                       if (libusb_get_config_descriptor(devlist[i], confidx, &confdes) != 0) {
+                               sr_err("Failed to get configuration descriptor.");
+                               break;
+                       }
+                       for (intfidx = 0; intfidx < confdes->bNumInterfaces; intfidx++) {
+                               intfdes = confdes->interface[intfidx].altsetting;
+                               if (intfdes->bInterfaceClass != LIBUSB_CLASS_APPLICATION
+                                               || intfdes->bInterfaceSubClass != SUBCLASS_USBTMC
+                                               || intfdes->bInterfaceProtocol != USBTMC_USB488)
+                                       continue;
+                               sr_dbg("Found USBTMC device (VID:PID = %04x:%04x, bus.address = "
+                                          "%d.%d).", des.idVendor, des.idProduct,
+                                          libusb_get_bus_number(devlist[i]),
+                                          libusb_get_device_address(devlist[i]));
+
+                               usb = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
+                                               libusb_get_device_address(devlist[i]), NULL);
+                               devices = g_slist_append(devices, usb);
+                       }
+                       libusb_free_config_descriptor(confdes);
+               }
+       }
+       libusb_free_device_list(devlist, 1);
+
+       sr_dbg("Found %d device(s).", g_slist_length(devices));
+
+       return devices;
+}
+
 SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb)
 {
        struct libusb_device **devlist;
        struct libusb_device_descriptor des;
        int ret, r, cnt, i, a, b;
 
-       sr_dbg("Trying to open USB device.");
+       sr_dbg("Trying to open USB device %d.%d.", usb->bus, usb->address);
 
        if ((cnt = libusb_get_device_list(usb_ctx, &devlist)) < 0) {
                sr_err("Failed to retrieve device list: %s.",
@@ -173,11 +216,8 @@ SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb)
 
                b = libusb_get_bus_number(devlist[i]);
                a = libusb_get_device_address(devlist[i]);
-
-               if (b != usb->bus || a != usb->address) {
-                       sr_spew("bus.address = %d.%d does not match.", b, a);
+               if (b != usb->bus || a != usb->address)
                        continue;
-               }
 
                if ((r = libusb_open(devlist[i], &usb->devhdl)) < 0) {
                        sr_err("Failed to open device: %s.",
@@ -196,3 +236,95 @@ SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb)
 
        return ret;
 }
+
+#ifdef _WIN32
+SR_PRIV gpointer usb_thread(gpointer data)
+{
+       struct sr_context *ctx = data;
+
+       while (ctx->usb_thread_running) {
+               g_mutex_lock(&ctx->usb_mutex);
+               libusb_wait_for_event(ctx->libusb_ctx, NULL);
+               SetEvent(ctx->usb_event);
+               g_mutex_unlock(&ctx->usb_mutex);
+               g_thread_yield();
+       }
+
+       return NULL;
+}
+
+SR_PRIV int usb_callback(int fd, int revents, void *cb_data)
+{
+       struct sr_context *ctx = cb_data;
+       int ret;
+
+       g_mutex_lock(&ctx->usb_mutex);
+       ret = ctx->usb_cb(fd, revents, ctx->usb_cb_data);
+
+       if (ctx->usb_thread_running) {
+               ResetEvent(ctx->usb_event);
+               g_mutex_unlock(&ctx->usb_mutex);
+       }
+
+       return ret;
+}
+#endif
+
+SR_PRIV int usb_source_add(struct sr_context *ctx, int timeout,
+               sr_receive_data_callback_t cb, void *cb_data)
+{
+       if (ctx->usb_source_present) {
+               sr_err("A USB event source is already present.");
+               return SR_ERR;
+       }
+
+#ifdef _WIN32
+       ctx->usb_event = CreateEvent(NULL, TRUE, FALSE, NULL);
+       g_mutex_init(&ctx->usb_mutex);
+       ctx->usb_thread_running = TRUE;
+       ctx->usb_thread = g_thread_new("usb", usb_thread, ctx);
+       ctx->usb_pollfd.fd = ctx->usb_event;
+       ctx->usb_pollfd.events = G_IO_IN;
+       ctx->usb_cb = cb;
+       ctx->usb_cb_data = cb_data;
+       sr_session_source_add_pollfd(&ctx->usb_pollfd, timeout, usb_callback, ctx);
+#else
+       const struct libusb_pollfd **lupfd;
+       unsigned int i;
+
+       lupfd = libusb_get_pollfds(ctx->libusb_ctx);
+       for (i = 0; lupfd[i]; i++)
+               sr_source_add(lupfd[i]->fd, lupfd[i]->events, timeout, cb, cb_data);
+       free(lupfd);
+#endif
+       ctx->usb_source_present = TRUE;
+
+       return SR_OK;
+}
+
+SR_PRIV int usb_source_remove(struct sr_context *ctx)
+{
+       if (!ctx->usb_source_present)
+               return SR_OK;
+
+#ifdef _WIN32
+       ctx->usb_thread_running = FALSE;
+       g_mutex_unlock(&ctx->usb_mutex);
+       libusb_unlock_events(ctx->libusb_ctx);
+       g_thread_join(ctx->usb_thread);
+       g_mutex_clear(&ctx->usb_mutex);
+       sr_session_source_remove_pollfd(&ctx->usb_pollfd);
+       CloseHandle(ctx->usb_event);
+#else
+       const struct libusb_pollfd **lupfd;
+       unsigned int i;
+
+       lupfd = libusb_get_pollfds(ctx->libusb_ctx);
+       for (i = 0; lupfd[i]; i++)
+               sr_source_remove(lupfd[i]->fd);
+       free(lupfd);
+#endif
+       ctx->usb_source_present = FALSE;
+
+       return SR_OK;
+}