[libsigrok.git] / hardware / common / usb.c

/*
 * This file is part of the sigrok project.
 *
 * Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
 * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 */

#include <stdlib.h>
#include <glib.h>
#include <libusb.h>
#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})$"
#define CONN_USB_BUSADDR "^(\\d+)\\.(\\d+)$"

/* Some USBTMC-specific enums, as defined in the USBTMC standard. */
#define SUBCLASS_USBTMC 0x03
#define USBTMC_USB488   0x01

/* 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)

/**
 * Find USB devices according to a connection string.
 *
 * @param usb_ctx libusb context to use while scanning.
 * @param conn Connection string specifying the device(s) to match. This
 * can be of the form "<bus>.<address>", or "<vendorid>.<productid>".
 *
 * @return A GSList of struct sr_usb_dev_inst, with bus and address fields
 * matching the device that matched the connection string. The GSList and
 * its contents must be freed by the caller.
 */
SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn)
{
	struct sr_usb_dev_inst *usb;
	struct libusb_device **devlist;
	struct libusb_device_descriptor des;
	GSList *devices;
	GRegex *reg;
	GMatchInfo *match;
	int vid, pid, bus, addr, b, a, ret, i;
	char *mstr;

	vid = pid = bus = addr = 0;
	reg = g_regex_new(CONN_USB_VIDPID, 0, 0, NULL);
	if (g_regex_match(reg, conn, 0, &match)) {
		if ((mstr = g_match_info_fetch(match, 1)))
			vid = strtoul(mstr, NULL, 16);
		g_free(mstr);

		if ((mstr = g_match_info_fetch(match, 2)))
			pid = strtoul(mstr, NULL, 16);
		g_free(mstr);
		sr_dbg("Trying to find USB device with VID:PID = %04x:%04x.",
		       vid, pid);
	} else {
		g_match_info_unref(match);
		g_regex_unref(reg);
		reg = g_regex_new(CONN_USB_BUSADDR, 0, 0, NULL);
		if (g_regex_match(reg, conn, 0, &match)) {
			if ((mstr = g_match_info_fetch(match, 1)))
				bus = strtoul(mstr, NULL, 16);
			g_free(mstr);

			if ((mstr = g_match_info_fetch(match, 2)))
				addr = strtoul(mstr, NULL, 16);
			g_free(mstr);
			sr_dbg("Trying to find USB device with bus.address = "
			       "%d.%d.", bus, addr);
		}
	}
	g_match_info_unref(match);
	g_regex_unref(reg);

	if (vid + pid + bus + addr == 0) {
		sr_err("Neither VID:PID nor bus.address was specified.");
		return NULL;
	}

	if (bus > 64) {
		sr_err("Invalid bus specified: %d.", bus);
		return NULL;
	}

	if (addr > 127) {
		sr_err("Invalid address specified: %d.", addr);
		return NULL;
	}

	/* Looks like a valid USB device specification, but is it connected? */
	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;
		}

		if (vid + pid && (des.idVendor != vid || des.idProduct != pid))
			continue;

		b = libusb_get_bus_number(devlist[i]);
		a = libusb_get_device_address(devlist[i]);
		if (bus + addr && (b != bus || a != addr))
			continue;

		sr_dbg("Found USB device (VID:PID = %04x:%04x, bus.address = "
		       "%d.%d).", des.idVendor, des.idProduct, b, a);

		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_device_list(devlist, 1);

	sr_dbg("Found %d device(s).", g_slist_length(devices));
	
	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 %d.%d.", usb->bus, usb->address);

	if ((cnt = libusb_get_device_list(usb_ctx, &devlist)) < 0) {
		sr_err("Failed to retrieve device list: %s.",
		       libusb_error_name(cnt));
		return SR_ERR;
	}

	ret = SR_ERR;
	for (i = 0; i < cnt; i++) {
		if ((r = libusb_get_device_descriptor(devlist[i], &des)) < 0) {
			sr_err("Failed to get device descriptor: %s.",
			       libusb_error_name(r));
			continue;
		}

		b = libusb_get_bus_number(devlist[i]);
		a = libusb_get_device_address(devlist[i]);
		if (b != usb->bus || a != usb->address)
			continue;

		if ((r = libusb_open(devlist[i], &usb->devhdl)) < 0) {
			sr_err("Failed to open device: %s.",
			       libusb_error_name(r));
			break;
		}

		sr_dbg("Opened USB device (VID:PID = %04x:%04x, bus.address = "
		       "%d.%d).", des.idVendor, des.idProduct, b, a);

		ret = SR_OK;
		break;
	}

	libusb_free_device_list(devlist, 1);

	return ret;
}
Commit	Line	Data
0c632d36 UH	1	/*
	2	* This file is part of the sigrok 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 <glib.h>
	24	#include <libusb.h>
	25	#include "libsigrok.h"
	26	#include "libsigrok-internal.h"
	27
	28	/* SR_HWCAP_CONN takes one of these: */
	29	#define CONN_USB_VIDPID "^([0-9a-z]{1,4})\\.([0-9a-z]{1,4})$"
	30	#define CONN_USB_BUSADDR "^(\\d+)\\.(\\d+)$"
	31
91162629 BV	32	/* Some USBTMC-specific enums, as defined in the USBTMC standard. */
	33	#define SUBCLASS_USBTMC 0x03
	34	#define USBTMC_USB488 0x01
	35
0c632d36 UH	36	/* Message logging helpers with driver-specific prefix string. */
	37	#define DRIVER_LOG_DOMAIN "usb: "
	38	#define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args)
	39	#define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args)
	40	#define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args)
	41	#define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args)
	42	#define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args)
	43	#define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args)
	44
7ae6a758 BV	45	/**
	46	* Find USB devices according to a connection string.
	47	*
	48	* @param usb_ctx libusb context to use while scanning.
	49	* @param conn Connection string specifying the device(s) to match. This
	50	* can be of the form "<bus>.<address>", or "<vendorid>.<productid>".
	51	*
	52	* @return A GSList of struct sr_usb_dev_inst, with bus and address fields
	53	* matching the device that matched the connection string. The GSList and
	54	* its contents must be freed by the caller.
	55	*/
	56	SR_PRIV GSList sr_usb_find(libusb_context usb_ctx, const char *conn)
0c632d36	57	{
7ae6a758	58	struct sr_usb_dev_inst *usb;
0c632d36 UH	59	struct libusb_device **devlist;
	60	struct libusb_device_descriptor des;
	61	GSList *devices;
	62	GRegex *reg;
	63	GMatchInfo *match;
	64	int vid, pid, bus, addr, b, a, ret, i;
	65	char *mstr;
	66
	67	vid = pid = bus = addr = 0;
	68	reg = g_regex_new(CONN_USB_VIDPID, 0, 0, NULL);
	69	if (g_regex_match(reg, conn, 0, &match)) {
e7f378fd	70	if ((mstr = g_match_info_fetch(match, 1)))
0c632d36	71	vid = strtoul(mstr, NULL, 16);
0c632d36 UH	72	g_free(mstr);
0c632d36 UH	73
e7f378fd	74	if ((mstr = g_match_info_fetch(match, 2)))
0c632d36	75	pid = strtoul(mstr, NULL, 16);
0c632d36 UH	76	g_free(mstr);
	77	sr_dbg("Trying to find USB device with VID:PID = %04x:%04x.",
	78	vid, pid);
	79	} else {
	80	g_match_info_unref(match);
	81	g_regex_unref(reg);
	82	reg = g_regex_new(CONN_USB_BUSADDR, 0, 0, NULL);
	83	if (g_regex_match(reg, conn, 0, &match)) {
e7f378fd	84	if ((mstr = g_match_info_fetch(match, 1)))
0c632d36	85	bus = strtoul(mstr, NULL, 16);
0c632d36 UH	86	g_free(mstr);
0c632d36 UH	87
e7f378fd	88	if ((mstr = g_match_info_fetch(match, 2)))
0c632d36	89	addr = strtoul(mstr, NULL, 16);
0c632d36 UH	90	g_free(mstr);
	91	sr_dbg("Trying to find USB device with bus.address = "
	92	"%d.%d.", bus, addr);
	93	}
	94	}
	95	g_match_info_unref(match);
	96	g_regex_unref(reg);
	97
	98	if (vid + pid + bus + addr == 0) {
e7f378fd	99	sr_err("Neither VID:PID nor bus.address was specified.");
0c632d36 UH	100	return NULL;
	101	}
	102
	103	if (bus > 64) {
	104	sr_err("Invalid bus specified: %d.", bus);
	105	return NULL;
	106	}
	107
	108	if (addr > 127) {
	109	sr_err("Invalid address specified: %d.", addr);
	110	return NULL;
	111	}
	112
	113	/* Looks like a valid USB device specification, but is it connected? */
	114	devices = NULL;
	115	libusb_get_device_list(usb_ctx, &devlist);
	116	for (i = 0; devlist[i]; i++) {
	117	if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
d4928d71 PS	118	sr_err("Failed to get device descriptor: %s.",
d4928d71 PS	119	libusb_error_name(ret));
0c632d36 UH	120	continue;
	121	}
	122
7ae6a758	123	if (vid + pid && (des.idVendor != vid \|\| des.idProduct != pid))
0c632d36	124	continue;
0c632d36	125
7ae6a758 BV	126	b = libusb_get_bus_number(devlist[i]);
	127	a = libusb_get_device_address(devlist[i]);
	128	if (bus + addr && (b != bus \|\| a != addr))
0c632d36	129	continue;
0c632d36 UH	130
	131	sr_dbg("Found USB device (VID:PID = %04x:%04x, bus.address = "
	132	"%d.%d).", des.idVendor, des.idProduct, b, a);
	133
7ae6a758 BV	134	usb = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
	135	libusb_get_device_address(devlist[i]), NULL);
	136	devices = g_slist_append(devices, usb);
0c632d36 UH	137	}
	138	libusb_free_device_list(devlist, 1);
	139
	140	sr_dbg("Found %d device(s).", g_slist_length(devices));
	141
	142	return devices;
	143	}
	144
91162629 BV	145	/**
	146	* Find USB devices supporting the USBTMC class
	147	*
	148	* @param usb_ctx libusb context to use while scanning.
	149	*
	150	* @return A GSList of struct sr_usb_dev_inst, with bus and address fields
	151	* indicating devices with USBTMC support.
	152	*/
	153	SR_PRIV GSList sr_usb_find_usbtmc(libusb_context usb_ctx)
	154	{
	155	struct sr_usb_dev_inst *usb;
	156	struct libusb_device **devlist;
	157	struct libusb_device_descriptor des;
	158	struct libusb_config_descriptor *confdes;
	159	const struct libusb_interface_descriptor *intfdes;
	160	GSList *devices;
	161	int confidx, intfidx, ret, i;
	162
	163	devices = NULL;
	164	libusb_get_device_list(usb_ctx, &devlist);
	165	for (i = 0; devlist[i]; i++) {
	166	if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
	167	sr_err("Failed to get device descriptor: %s.",
	168	libusb_error_name(ret));
	169	continue;
	170	}
	171
	172	for (confidx = 0; confidx < des.bNumConfigurations; confidx++) {
	173	if (libusb_get_config_descriptor(devlist[i], confidx, &confdes) != 0) {
	174	sr_err("Failed to get configuration descriptor.");
	175	break;
	176	}
	177	for (intfidx = 0; intfidx < confdes->bNumInterfaces; intfidx++) {
	178	intfdes = confdes->interface[intfidx].altsetting;
	179	if (intfdes->bInterfaceClass != LIBUSB_CLASS_APPLICATION
	180	\|\| intfdes->bInterfaceSubClass != SUBCLASS_USBTMC
	181	\|\| intfdes->bInterfaceProtocol != USBTMC_USB488)
	182	continue;
	183	sr_dbg("Found USBTMC device (VID:PID = %04x:%04x, bus.address = "
	184	"%d.%d).", des.idVendor, des.idProduct,
	185	libusb_get_bus_number(devlist[i]),
	186	libusb_get_device_address(devlist[i]));
	187
	188	usb = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
	189	libusb_get_device_address(devlist[i]), NULL);
	190	devices = g_slist_append(devices, usb);
	191	}
d8e3685c	192	libusb_free_config_descriptor(confdes);
91162629 BV	193	}
	194	}
	195	libusb_free_device_list(devlist, 1);
	196
	197	sr_dbg("Found %d device(s).", g_slist_length(devices));
	198
	199	return devices;
	200	}
	201
0c632d36 UH	202	SR_PRIV int sr_usb_open(libusb_context usb_ctx, struct sr_usb_dev_inst usb)
	203	{
	204	struct libusb_device **devlist;
	205	struct libusb_device_descriptor des;
	206	int ret, r, cnt, i, a, b;
	207
c5f1a021	208	sr_dbg("Trying to open USB device %d.%d.", usb->bus, usb->address);
0c632d36 UH	209
	210	if ((cnt = libusb_get_device_list(usb_ctx, &devlist)) < 0) {
	211	sr_err("Failed to retrieve device list: %s.",
	212	libusb_error_name(cnt));
	213	return SR_ERR;
	214	}
	215
	216	ret = SR_ERR;
	217	for (i = 0; i < cnt; i++) {
	218	if ((r = libusb_get_device_descriptor(devlist[i], &des)) < 0) {
	219	sr_err("Failed to get device descriptor: %s.",
	220	libusb_error_name(r));
	221	continue;
	222	}
	223
	224	b = libusb_get_bus_number(devlist[i]);
	225	a = libusb_get_device_address(devlist[i]);
c5f1a021	226	if (b != usb->bus \|\| a != usb->address)
0c632d36	227	continue;
0c632d36 UH	228
	229	if ((r = libusb_open(devlist[i], &usb->devhdl)) < 0) {
	230	sr_err("Failed to open device: %s.",
	231	libusb_error_name(r));
	232	break;
	233	}
	234
	235	sr_dbg("Opened USB device (VID:PID = %04x:%04x, bus.address = "
	236	"%d.%d).", des.idVendor, des.idProduct, b, a);
	237
	238	ret = SR_OK;
	239	break;
	240	}
	241
	242	libusb_free_device_list(devlist, 1);
	243
	244	return ret;
	245	}