2 * This file is part of the libsigrok project.
4 * Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
5 * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
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.
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.
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
26 #include <libsigrok/libsigrok.h>
27 #include "libsigrok-internal.h"
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+)$"
33 #define LOG_PREFIX "usb"
35 #if !HAVE_LIBUSB_OS_HANDLE
36 typedef int libusb_os_handle;
40 * Find USB devices according to a connection string.
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>".
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.
50 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn)
52 struct sr_usb_dev_inst *usb;
53 struct libusb_device **devlist;
54 struct libusb_device_descriptor des;
58 int vid, pid, bus, addr, b, a, ret, i;
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);
68 if ((mstr = g_match_info_fetch(match, 2)))
69 pid = strtoul(mstr, NULL, 16);
71 sr_dbg("Trying to find USB device with VID:PID = %04x:%04x.",
74 g_match_info_unref(match);
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);
82 if ((mstr = g_match_info_fetch(match, 2)))
83 addr = strtoul(mstr, NULL, 10);
85 sr_dbg("Trying to find USB device with bus.address = "
89 g_match_info_unref(match);
92 if (vid + pid + bus + addr == 0) {
93 sr_err("Neither VID:PID nor bus.address was specified.");
98 sr_err("Invalid bus specified: %d.", bus);
103 sr_err("Invalid address specified: %d.", addr);
107 /* Looks like a valid USB device specification, but is it connected? */
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));
117 if (vid + pid && (des.idVendor != vid || des.idProduct != pid))
120 b = libusb_get_bus_number(devlist[i]);
121 a = libusb_get_device_address(devlist[i]);
122 if (bus + addr && (b != bus || a != addr))
125 sr_dbg("Found USB device (VID:PID = %04x:%04x, bus.address = "
126 "%d.%d).", des.idVendor, des.idProduct, b, a);
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);
132 libusb_free_device_list(devlist, 1);
134 sr_dbg("Found %d device(s).", g_slist_length(devices));
139 SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb)
141 struct libusb_device **devlist;
142 struct libusb_device_descriptor des;
143 int ret, r, cnt, i, a, b;
145 sr_dbg("Trying to open USB device %d.%d.", usb->bus, usb->address);
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));
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));
161 b = libusb_get_bus_number(devlist[i]);
162 a = libusb_get_device_address(devlist[i]);
163 if (b != usb->bus || a != usb->address)
166 if ((r = libusb_open(devlist[i], &usb->devhdl)) < 0) {
167 sr_err("Failed to open device: %s.",
168 libusb_error_name(r));
172 sr_dbg("Opened USB device (VID:PID = %04x:%04x, bus.address = "
173 "%d.%d).", des.idVendor, des.idProduct, b, a);
179 libusb_free_device_list(devlist, 1);
184 SR_PRIV void sr_usb_close(struct sr_usb_dev_inst *usb)
186 libusb_close(usb->devhdl);
188 sr_dbg("Closed USB device %d.%d.", usb->bus, usb->address);
191 static LIBUSB_CALL void usb_pollfd_added(libusb_os_handle fd,
192 short events, void *user_data)
194 struct sr_session *session;
198 tag = (gintptr)session->ctx->libusb_ctx;
202 sr_session_source_poll_add(session, tag, (gintptr)fd, events);
205 static LIBUSB_CALL void usb_pollfd_removed(libusb_os_handle fd, void *user_data)
207 struct sr_session *session;
211 tag = (gintptr)session->ctx->libusb_ctx;
213 sr_session_source_poll_remove(session, tag, (gintptr)fd);
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)
219 const struct libusb_pollfd **pollfds;
225 if (ctx->usb_source_present) {
226 sr_err("A USB event source is already present.");
229 pollfds = libusb_get_pollfds(ctx->libusb_ctx);
231 sr_err("Failed to get libusb file descriptors.");
234 tag = (gintptr)ctx->libusb_ctx;
235 ret = sr_session_source_add_internal(session,
236 timeout, cb, cb_data, tag);
238 ctx->usb_source_present = (ret == SR_OK);
240 for (i = 0; ret == SR_OK && pollfds[i]; ++i) {
244 events = pollfds[i]->events;
246 ret = sr_session_source_poll_add(session, tag,
247 (gintptr)pollfds[i]->fd, events);
249 #if (LIBUSB_API_VERSION >= 0x01000104)
250 libusb_free_pollfds(pollfds);
257 libusb_set_pollfd_notifiers(ctx->libusb_ctx,
258 &usb_pollfd_added, &usb_pollfd_removed, session);
263 SR_PRIV int usb_source_remove(struct sr_session *session, struct sr_context *ctx)
265 ctx->usb_source_present = FALSE;
267 libusb_set_pollfd_notifiers(ctx->libusb_ctx, NULL, NULL, NULL);
269 return sr_session_source_remove_internal(session,
270 (gintptr)ctx->libusb_ctx);
273 SR_PRIV int usb_get_port_path(libusb_device *dev, char *path, int path_len)
275 uint8_t port_numbers[8];
279 * FreeBSD requires that devices prior to calling libusb_get_port_numbers()
280 * have been opened with libusb_open().
283 struct libusb_device_handle *devh;
284 if (libusb_open(dev, &devh) != 0)
287 n = libusb_get_port_numbers(dev, port_numbers, sizeof(port_numbers));
292 /* Workaround FreeBSD libusb_get_port_numbers() returning 0. */
295 port_numbers[0] = libusb_get_device_address(dev);
302 len = snprintf(path, path_len, "usb/%d-%d",
303 libusb_get_bus_number(dev), port_numbers[0]);
305 for (i = 1; i < n; i++)
306 len += snprintf(path+len, path_len-len, ".%d", port_numbers[i]);