[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"

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

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 **lupfd;
	GPollFD *pollfds;
	int i;
	int num_fds = 0;
	int ret;

	if (ctx->usb_source_present) {
		sr_err("A USB event source is already present.");
		return SR_ERR;
	}
	lupfd = libusb_get_pollfds(ctx->libusb_ctx);
	if (!lupfd || !lupfd[0]) {
		free(lupfd);
		sr_err("Failed to get libusb file descriptors.");
		return SR_ERR;
	}
	while (lupfd[num_fds])
		++num_fds;
	pollfds = g_new(GPollFD, num_fds);

	for (i = 0; i < num_fds; ++i) {
#if defined(G_OS_WIN32) && (GLIB_SIZEOF_VOID_P == 4)
		/* Avoid a warning on 32-bit Windows. */
		pollfds[i].fd = (gintptr)lupfd[i]->fd;
#else
		pollfds[i].fd = lupfd[i]->fd;
#endif
		pollfds[i].events = lupfd[i]->events;
		pollfds[i].revents = 0;
	}
	free(lupfd);
	ret = sr_session_source_add_internal(session, pollfds, num_fds,
			timeout, cb, cb_data, (gintptr)ctx->libusb_ctx);
	g_free(pollfds);

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

	return ret;
}

SR_PRIV int usb_source_remove(struct sr_session *session, struct sr_context *ctx)
{
	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
0c632d36	1	/*
50985c20	2	* This file is part of the libsigrok project.
0c632d36 UH	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>
db156e54	23	#include <memory.h>
0c632d36 UH	24	#include <glib.h>
0c632d36 UH	25	#include <libusb.h>
c1aae900	26	#include <libsigrok/libsigrok.h>
0c632d36 UH	27	#include "libsigrok-internal.h"
0c632d36 UH	28
1953564a	29	/* SR_CONF_CONN takes one of these: */
1eb0a0df	30	#define CONN_USB_VIDPID "^([0-9a-z]{4})\\.([0-9a-z]{4})$"
0c632d36 UH	31	#define CONN_USB_BUSADDR "^(\\d+)\\.(\\d+)$"
0c632d36 UH	32
3544f848	33	#define LOG_PREFIX "usb"
0c632d36	34
7ae6a758 BV	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)
0c632d36	47	{
7ae6a758	48	struct sr_usb_dev_inst *usb;
0c632d36 UH	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)) {
e7f378fd	60	if ((mstr = g_match_info_fetch(match, 1)))
0c632d36	61	vid = strtoul(mstr, NULL, 16);
0c632d36 UH	62	g_free(mstr);
0c632d36 UH	63
e7f378fd	64	if ((mstr = g_match_info_fetch(match, 2)))
0c632d36	65	pid = strtoul(mstr, NULL, 16);
0c632d36 UH	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)) {
e7f378fd	74	if ((mstr = g_match_info_fetch(match, 1)))
1eb0a0df	75	bus = strtoul(mstr, NULL, 10);
0c632d36 UH	76	g_free(mstr);
0c632d36 UH	77
e7f378fd	78	if ((mstr = g_match_info_fetch(match, 2)))
1eb0a0df	79	addr = strtoul(mstr, NULL, 10);
0c632d36 UH	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) {
e7f378fd	89	sr_err("Neither VID:PID nor bus.address was specified.");
0c632d36 UH	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))) {
d4928d71 PS	108	sr_err("Failed to get device descriptor: %s.",
d4928d71 PS	109	libusb_error_name(ret));
0c632d36 UH	110	continue;
	111	}
	112
7ae6a758	113	if (vid + pid && (des.idVendor != vid \|\| des.idProduct != pid))
0c632d36	114	continue;
0c632d36	115
7ae6a758 BV	116	b = libusb_get_bus_number(devlist[i]);
	117	a = libusb_get_device_address(devlist[i]);
	118	if (bus + addr && (b != bus \|\| a != addr))
0c632d36	119	continue;
0c632d36 UH	120
	121	sr_dbg("Found USB device (VID:PID = %04x:%04x, bus.address = "
	122	"%d.%d).", des.idVendor, des.idProduct, b, a);
	123
7ae6a758 BV	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);
0c632d36 UH	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
c5f1a021	141	sr_dbg("Trying to open USB device %d.%d.", usb->bus, usb->address);
0c632d36 UH	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]);
c5f1a021	159	if (b != usb->bus \|\| a != usb->address)
0c632d36	160	continue;
0c632d36 UH	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	}
6c60facc	179
67e95ed3 BV	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
102f1239 BV	187	SR_PRIV int usb_source_add(struct sr_session session, struct sr_context ctx,
102f1239 BV	188	int timeout, sr_receive_data_callback cb, void *cb_data)
6c60facc	189	{
4b9e2532 DE	190	const struct libusb_pollfd **lupfd;
	191	GPollFD *pollfds;
	192	int i;
	193	int num_fds = 0;
92248e78 DE	194	int ret;
92248e78 DE	195
6640324f ML	196	if (ctx->usb_source_present) {
	197	sr_err("A USB event source is already present.");
	198	return SR_ERR;
	199	}
6c60facc	200	lupfd = libusb_get_pollfds(ctx->libusb_ctx);
92248e78 DE	201	if (!lupfd \|\| !lupfd[0]) {
	202	free(lupfd);
	203	sr_err("Failed to get libusb file descriptors.");
	204	return SR_ERR;
	205	}
	206	while (lupfd[num_fds])
	207	++num_fds;
	208	pollfds = g_new(GPollFD, num_fds);
	209
	210	for (i = 0; i < num_fds; ++i) {
4b9e2532 DE	211	#if defined(G_OS_WIN32) && (GLIB_SIZEOF_VOID_P == 4)
	212	/* Avoid a warning on 32-bit Windows. */
	213	pollfds[i].fd = (gintptr)lupfd[i]->fd;
	214	#else
92248e78	215	pollfds[i].fd = lupfd[i]->fd;
4b9e2532	216	#endif
92248e78 DE	217	pollfds[i].events = lupfd[i]->events;
92248e78 DE	218	pollfds[i].revents = 0;
62d7945f	219	}
6c60facc	220	free(lupfd);
92248e78 DE	221	ret = sr_session_source_add_internal(session, pollfds, num_fds,
	222	timeout, cb, cb_data, (gintptr)ctx->libusb_ctx);
	223	g_free(pollfds);
4b9e2532	224
92248e78	225	ctx->usb_source_present = (ret == SR_OK);
6c60facc	226
92248e78	227	return ret;
6c60facc ML	228	}
6c60facc ML	229
102f1239	230	SR_PRIV int usb_source_remove(struct sr_session session, struct sr_context ctx)
6c60facc	231	{
5a7d8dac	232	return sr_session_source_remove_internal(session,
92248e78	233	(gintptr)ctx->libusb_ctx);
6c60facc	234	}
db156e54	235
76bc5f63	236	SR_PRIV int usb_get_port_path(libusb_device dev, char path, int path_len)
db156e54	237	{
76bc5f63 AJ	238	uint8_t port_numbers[8];
	239	int i, n, len;
	240
19643b96 UJ	241	/*
	242	* FreeBSD requires that devices prior to calling libusb_get_port_numbers()
	243	* have been opened with libusb_open().
	244	*/
	245	#ifdef __FreeBSD__
	246	struct libusb_device_handle *devh;
	247	if (libusb_open(dev, &devh) != 0)
	248	return SR_ERR;
	249	#endif
76bc5f63	250	n = libusb_get_port_numbers(dev, port_numbers, sizeof(port_numbers));
19643b96 UJ	251	#ifdef __FreeBSD__
	252	libusb_close(devh);
	253	#endif
76bc5f63	254
19643b96 UJ	255	/* Workaround FreeBSD libusb_get_port_numbers() returning 0. */
	256	#ifdef __FreeBSD__
	257	if (n == 0) {
	258	port_numbers[0] = libusb_get_device_address(dev);
	259	n = 1;
	260	}
	261	#endif
2f004b4b VP	262	if (n < 1)
	263	return SR_ERR;
	264
76bc5f63 AJ	265	len = snprintf(path, path_len, "usb/%d-%d",
76bc5f63 AJ	266	libusb_get_bus_number(dev), port_numbers[0]);
db156e54	267
76bc5f63 AJ	268	for (i = 1; i < n; i++)
76bc5f63 AJ	269	len += snprintf(path+len, path_len-len, ".%d", port_numbers[i]);
db156e54 SA	270
	271	return SR_OK;
	272	}