[libsigrok.git] / src / usb.c

/*
 * 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>
 *
 * 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 <memory.h>
#include <glib.h>
#include <libusb.h>
#include <libsigrok/libsigrok.h>
#include "libsigrok-internal.h"

/* 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+)$"

#define LOG_PREFIX "usb"

#if !HAVE_LIBUSB_OS_HANDLE
typedef int libusb_os_handle;
#endif

/**
 * 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, 10);
			g_free(mstr);

			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);
		}
	}
	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;
}

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;
}

SR_PRIV void sr_usb_close(struct sr_usb_dev_inst *usb)
{
	libusb_close(usb->devhdl);
	usb->devhdl = NULL;
	sr_dbg("Closed USB device %d.%d.", usb->bus, usb->address);
}

static LIBUSB_CALL void usb_pollfd_added(libusb_os_handle fd,
		short events, void *user_data)
{
	struct sr_session *session;
	gintptr tag;

	session = user_data;
	tag = (gintptr)session->ctx->libusb_ctx;
#ifdef G_OS_WIN32
	events = G_IO_IN;
#endif
	sr_session_source_poll_add(session, tag, (gintptr)fd, events);
}

static LIBUSB_CALL void usb_pollfd_removed(libusb_os_handle fd, void *user_data)
{
	struct sr_session *session;
	gintptr tag;

	session = user_data;
	tag = (gintptr)session->ctx->libusb_ctx;

	sr_session_source_poll_remove(session, tag, (gintptr)fd);
}

SR_PRIV int usb_source_add(struct sr_session *session, struct sr_context *ctx,
		int timeout, sr_receive_data_callback cb, void *cb_data)
{
	const struct libusb_pollfd **pollfds;
	gintptr tag;
	int i;
	int ret;
	int events;

	if (ctx->usb_source_present) {
		sr_err("A USB event source is already present.");
		return SR_ERR;
	}
	pollfds = libusb_get_pollfds(ctx->libusb_ctx);
	if (!pollfds) {
		sr_err("Failed to get libusb file descriptors.");
		return SR_ERR;
	}
	tag = (gintptr)ctx->libusb_ctx;
	ret = sr_session_source_add_internal(session,
			timeout, cb, cb_data, tag);

	ctx->usb_source_present = (ret == SR_OK);

	for (i = 0; ret == SR_OK && pollfds[i]; ++i) {
#ifdef G_OS_WIN32
		events = G_IO_IN;
#else
		events = pollfds[i]->events;
#endif
		ret = sr_session_source_poll_add(session, tag,
				(gintptr)pollfds[i]->fd, events);
	}
#if (LIBUSB_API_VERSION >= 0x01000104)
	libusb_free_pollfds(pollfds);
#else
	free(pollfds);
#endif
	if (ret != SR_OK)
		return ret;

	libusb_set_pollfd_notifiers(ctx->libusb_ctx,
		&usb_pollfd_added, &usb_pollfd_removed, session);

	return SR_OK;
}

SR_PRIV int usb_source_remove(struct sr_session *session, struct sr_context *ctx)
{
	ctx->usb_source_present = FALSE;

	libusb_set_pollfd_notifiers(ctx->libusb_ctx, NULL, NULL, NULL);

	return sr_session_source_remove_internal(session,
			(gintptr)ctx->libusb_ctx);
}

SR_PRIV int usb_get_port_path(libusb_device *dev, char *path, int path_len)
{
	uint8_t port_numbers[8];
	int i, n, len;

/*
 * FreeBSD requires that devices prior to calling libusb_get_port_numbers()
 * have been opened with libusb_open().
 */
#ifdef __FreeBSD__
	struct libusb_device_handle *devh;
	if (libusb_open(dev, &devh) != 0)
		return SR_ERR;
#endif
	n = libusb_get_port_numbers(dev, port_numbers, sizeof(port_numbers));
#ifdef __FreeBSD__
	libusb_close(devh);
#endif

/* Workaround FreeBSD libusb_get_port_numbers() returning 0. */
#ifdef __FreeBSD__
	if (n == 0) {
		port_numbers[0] = libusb_get_device_address(dev);
		n = 1;
	}
#endif
	if (n < 1)
		return SR_ERR;

	len = snprintf(path, path_len, "usb/%d-%d",
	               libusb_get_bus_number(dev), port_numbers[0]);

	for (i = 1; i < n; i++)
		len += snprintf(path+len, path_len-len, ".%d", port_numbers[i]);

	return SR_OK;
}
Commit	Line	Data
	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	#if !HAVE_LIBUSB_OS_HANDLE
	36	typedef int libusb_os_handle;
	37	#endif
	38
	39	/**
	40	* Find USB devices according to a connection string.
	41	*
	42	* @param usb_ctx libusb context to use while scanning.
	43	* @param conn Connection string specifying the device(s) to match. This
	44	* can be of the form "<bus>.<address>", or "<vendorid>.<productid>".
	45	*
	46	* @return A GSList of struct sr_usb_dev_inst, with bus and address fields
	47	* matching the device that matched the connection string. The GSList and
	48	* its contents must be freed by the caller.
	49	*/
	50	SR_PRIV GSList sr_usb_find(libusb_context usb_ctx, const char *conn)
	51	{
	52	struct sr_usb_dev_inst *usb;
	53	struct libusb_device **devlist;
	54	struct libusb_device_descriptor des;
	55	GSList *devices;
	56	GRegex *reg;
	57	GMatchInfo *match;
	58	int vid, pid, bus, addr, b, a, ret, i;
	59	char *mstr;
	60
	61	vid = pid = bus = addr = 0;
	62	reg = g_regex_new(CONN_USB_VIDPID, 0, 0, NULL);
	63	if (g_regex_match(reg, conn, 0, &match)) {
	64	if ((mstr = g_match_info_fetch(match, 1)))
	65	vid = strtoul(mstr, NULL, 16);
	66	g_free(mstr);
	67
	68	if ((mstr = g_match_info_fetch(match, 2)))
	69	pid = strtoul(mstr, NULL, 16);
	70	g_free(mstr);
	71	sr_dbg("Trying to find USB device with VID:PID = %04x:%04x.",
	72	vid, pid);
	73	} else {
	74	g_match_info_unref(match);
	75	g_regex_unref(reg);
	76	reg = g_regex_new(CONN_USB_BUSADDR, 0, 0, NULL);
	77	if (g_regex_match(reg, conn, 0, &match)) {
	78	if ((mstr = g_match_info_fetch(match, 1)))
	79	bus = strtoul(mstr, NULL, 10);
	80	g_free(mstr);
	81
	82	if ((mstr = g_match_info_fetch(match, 2)))
	83	addr = strtoul(mstr, NULL, 10);
	84	g_free(mstr);
	85	sr_dbg("Trying to find USB device with bus.address = "
	86	"%d.%d.", bus, addr);
	87	}
	88	}
	89	g_match_info_unref(match);
	90	g_regex_unref(reg);
	91
	92	if (vid + pid + bus + addr == 0) {
	93	sr_err("Neither VID:PID nor bus.address was specified.");
	94	return NULL;
	95	}
	96
	97	if (bus > 64) {
	98	sr_err("Invalid bus specified: %d.", bus);
	99	return NULL;
	100	}
	101
	102	if (addr > 127) {
	103	sr_err("Invalid address specified: %d.", addr);
	104	return NULL;
	105	}
	106
	107	/* Looks like a valid USB device specification, but is it connected? */
	108	devices = NULL;
	109	libusb_get_device_list(usb_ctx, &devlist);
	110	for (i = 0; devlist[i]; i++) {
	111	if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
	112	sr_err("Failed to get device descriptor: %s.",
	113	libusb_error_name(ret));
	114	continue;
	115	}
	116
	117	if (vid + pid && (des.idVendor != vid \|\| des.idProduct != pid))
	118	continue;
	119
	120	b = libusb_get_bus_number(devlist[i]);
	121	a = libusb_get_device_address(devlist[i]);
	122	if (bus + addr && (b != bus \|\| a != addr))
	123	continue;
	124
	125	sr_dbg("Found USB device (VID:PID = %04x:%04x, bus.address = "
	126	"%d.%d).", des.idVendor, des.idProduct, b, a);
	127
	128	usb = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
	129	libusb_get_device_address(devlist[i]), NULL);
	130	devices = g_slist_append(devices, usb);
	131	}
	132	libusb_free_device_list(devlist, 1);
	133
	134	sr_dbg("Found %d device(s).", g_slist_length(devices));
	135
	136	return devices;
	137	}
	138
	139	SR_PRIV int sr_usb_open(libusb_context usb_ctx, struct sr_usb_dev_inst usb)
	140	{
	141	struct libusb_device **devlist;
	142	struct libusb_device_descriptor des;
	143	int ret, r, cnt, i, a, b;
	144
	145	sr_dbg("Trying to open USB device %d.%d.", usb->bus, usb->address);
	146
	147	if ((cnt = libusb_get_device_list(usb_ctx, &devlist)) < 0) {
	148	sr_err("Failed to retrieve device list: %s.",
	149	libusb_error_name(cnt));
	150	return SR_ERR;
	151	}
	152
	153	ret = SR_ERR;
	154	for (i = 0; i < cnt; i++) {
	155	if ((r = libusb_get_device_descriptor(devlist[i], &des)) < 0) {
	156	sr_err("Failed to get device descriptor: %s.",
	157	libusb_error_name(r));
	158	continue;
	159	}
	160
	161	b = libusb_get_bus_number(devlist[i]);
	162	a = libusb_get_device_address(devlist[i]);
	163	if (b != usb->bus \|\| a != usb->address)
	164	continue;
	165
	166	if ((r = libusb_open(devlist[i], &usb->devhdl)) < 0) {
	167	sr_err("Failed to open device: %s.",
	168	libusb_error_name(r));
	169	break;
	170	}
	171
	172	sr_dbg("Opened USB device (VID:PID = %04x:%04x, bus.address = "
	173	"%d.%d).", des.idVendor, des.idProduct, b, a);
	174
	175	ret = SR_OK;
	176	break;
	177	}
	178
	179	libusb_free_device_list(devlist, 1);
	180
	181	return ret;
	182	}
	183
	184	SR_PRIV void sr_usb_close(struct sr_usb_dev_inst *usb)
	185	{
	186	libusb_close(usb->devhdl);
	187	usb->devhdl = NULL;
	188	sr_dbg("Closed USB device %d.%d.", usb->bus, usb->address);
	189	}
	190
	191	static LIBUSB_CALL void usb_pollfd_added(libusb_os_handle fd,
	192	short events, void *user_data)
	193	{
	194	struct sr_session *session;
	195	gintptr tag;
	196
	197	session = user_data;
	198	tag = (gintptr)session->ctx->libusb_ctx;
	199	#ifdef G_OS_WIN32
	200	events = G_IO_IN;
	201	#endif
	202	sr_session_source_poll_add(session, tag, (gintptr)fd, events);
	203	}
	204
	205	static LIBUSB_CALL void usb_pollfd_removed(libusb_os_handle fd, void *user_data)
	206	{
	207	struct sr_session *session;
	208	gintptr tag;
	209
	210	session = user_data;
	211	tag = (gintptr)session->ctx->libusb_ctx;
	212
	213	sr_session_source_poll_remove(session, tag, (gintptr)fd);
	214	}
	215
	216	SR_PRIV int usb_source_add(struct sr_session session, struct sr_context ctx,
	217	int timeout, sr_receive_data_callback cb, void *cb_data)
	218	{
	219	const struct libusb_pollfd **pollfds;
	220	gintptr tag;
	221	int i;
	222	int ret;
	223	int events;
	224
	225	if (ctx->usb_source_present) {
	226	sr_err("A USB event source is already present.");
	227	return SR_ERR;
	228	}
	229	pollfds = libusb_get_pollfds(ctx->libusb_ctx);
	230	if (!pollfds) {
	231	sr_err("Failed to get libusb file descriptors.");
	232	return SR_ERR;
	233	}
	234	tag = (gintptr)ctx->libusb_ctx;
	235	ret = sr_session_source_add_internal(session,
	236	timeout, cb, cb_data, tag);
	237
	238	ctx->usb_source_present = (ret == SR_OK);
	239
	240	for (i = 0; ret == SR_OK && pollfds[i]; ++i) {
	241	#ifdef G_OS_WIN32
	242	events = G_IO_IN;
	243	#else
	244	events = pollfds[i]->events;
	245	#endif
	246	ret = sr_session_source_poll_add(session, tag,
	247	(gintptr)pollfds[i]->fd, events);
	248	}
	249	#if (LIBUSB_API_VERSION >= 0x01000104)
	250	libusb_free_pollfds(pollfds);
	251	#else
	252	free(pollfds);
	253	#endif
	254	if (ret != SR_OK)
	255	return ret;
	256
	257	libusb_set_pollfd_notifiers(ctx->libusb_ctx,
	258	&usb_pollfd_added, &usb_pollfd_removed, session);
	259
	260	return SR_OK;
	261	}
	262
	263	SR_PRIV int usb_source_remove(struct sr_session session, struct sr_context ctx)
	264	{
	265	ctx->usb_source_present = FALSE;
	266
	267	libusb_set_pollfd_notifiers(ctx->libusb_ctx, NULL, NULL, NULL);
	268
	269	return sr_session_source_remove_internal(session,
	270	(gintptr)ctx->libusb_ctx);
	271	}
	272
	273	SR_PRIV int usb_get_port_path(libusb_device dev, char path, int path_len)
	274	{
	275	uint8_t port_numbers[8];
	276	int i, n, len;
	277
	278	/*
	279	* FreeBSD requires that devices prior to calling libusb_get_port_numbers()
	280	* have been opened with libusb_open().
	281	*/
	282	#ifdef __FreeBSD__
	283	struct libusb_device_handle *devh;
	284	if (libusb_open(dev, &devh) != 0)
	285	return SR_ERR;
	286	#endif
	287	n = libusb_get_port_numbers(dev, port_numbers, sizeof(port_numbers));
	288	#ifdef __FreeBSD__
	289	libusb_close(devh);
	290	#endif
	291
	292	/* Workaround FreeBSD libusb_get_port_numbers() returning 0. */
	293	#ifdef __FreeBSD__
	294	if (n == 0) {
	295	port_numbers[0] = libusb_get_device_address(dev);
	296	n = 1;
	297	}
	298	#endif
	299	if (n < 1)
	300	return SR_ERR;
	301
	302	len = snprintf(path, path_len, "usb/%d-%d",
	303	libusb_get_bus_number(dev), port_numbers[0]);
	304
	305	for (i = 1; i < n; i++)
	306	len += snprintf(path+len, path_len-len, ".%d", port_numbers[i]);
	307
	308	return SR_OK;
	309	}