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"
36 * Find USB devices according to a connection string.
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>".
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.
46 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn)
48 struct sr_usb_dev_inst *usb;
49 struct libusb_device **devlist;
50 struct libusb_device_descriptor des;
54 int vid, pid, bus, addr, b, a, ret, i;
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)) {
60 if ((mstr = g_match_info_fetch(match, 1)))
61 vid = strtoul(mstr, NULL, 16);
64 if ((mstr = g_match_info_fetch(match, 2)))
65 pid = strtoul(mstr, NULL, 16);
67 sr_dbg("Trying to find USB device with VID:PID = %04x:%04x.",
70 g_match_info_unref(match);
72 reg = g_regex_new(CONN_USB_BUSADDR, 0, 0, NULL);
73 if (g_regex_match(reg, conn, 0, &match)) {
74 if ((mstr = g_match_info_fetch(match, 1)))
75 bus = strtoul(mstr, NULL, 10);
78 if ((mstr = g_match_info_fetch(match, 2)))
79 addr = strtoul(mstr, NULL, 10);
81 sr_dbg("Trying to find USB device with bus.address = "
85 g_match_info_unref(match);
88 if (vid + pid + bus + addr == 0) {
89 sr_err("Neither VID:PID nor bus.address was specified.");
94 sr_err("Invalid bus specified: %d.", bus);
99 sr_err("Invalid address specified: %d.", addr);
103 /* Looks like a valid USB device specification, but is it connected? */
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))) {
108 sr_err("Failed to get device descriptor: %s.",
109 libusb_error_name(ret));
113 if (vid + pid && (des.idVendor != vid || des.idProduct != pid))
116 b = libusb_get_bus_number(devlist[i]);
117 a = libusb_get_device_address(devlist[i]);
118 if (bus + addr && (b != bus || a != addr))
121 sr_dbg("Found USB device (VID:PID = %04x:%04x, bus.address = "
122 "%d.%d).", des.idVendor, des.idProduct, b, a);
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);
128 libusb_free_device_list(devlist, 1);
130 sr_dbg("Found %d device(s).", g_slist_length(devices));
135 SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb)
137 struct libusb_device **devlist;
138 struct libusb_device_descriptor des;
139 int ret, r, cnt, i, a, b;
141 sr_dbg("Trying to open USB device %d.%d.", usb->bus, usb->address);
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));
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));
157 b = libusb_get_bus_number(devlist[i]);
158 a = libusb_get_device_address(devlist[i]);
159 if (b != usb->bus || a != usb->address)
162 if ((r = libusb_open(devlist[i], &usb->devhdl)) < 0) {
163 sr_err("Failed to open device: %s.",
164 libusb_error_name(r));
168 sr_dbg("Opened USB device (VID:PID = %04x:%04x, bus.address = "
169 "%d.%d).", des.idVendor, des.idProduct, b, a);
175 libusb_free_device_list(devlist, 1);
181 /* Thread used to run libusb_wait_for_event() and set a pollable event. */
182 static gpointer usb_thread(gpointer data)
184 struct sr_context *ctx = data;
186 while (ctx->usb_thread_running) {
187 /* Acquire event waiters lock, needed for libusb_wait_for_event(). */
188 libusb_lock_event_waiters(ctx->libusb_ctx);
189 /* Wait for any libusb event. The main thread can interrupt this wait
190 * by calling libusb_unlock_events(). */
191 libusb_wait_for_event(ctx->libusb_ctx, NULL);
192 /* Release event waiters lock. */
193 libusb_unlock_event_waiters(ctx->libusb_ctx);
194 /* Set event that the main loop will be polling on. */
195 SetEvent(ctx->usb_wait_complete_event);
196 /* Wait for the main thread to signal us to run again. */
197 WaitForSingleObject(ctx->usb_wait_request_event, INFINITE);
198 ResetEvent(ctx->usb_wait_request_event);
204 /* Callback wrapper run when main g_poll() gets a USB event or timeout. */
205 static int usb_callback(int fd, int revents, void *cb_data)
207 struct sr_context *ctx = cb_data;
210 /* Run registered callback to handle libusb events. */
211 ret = ctx->usb_cb(fd, revents, ctx->usb_cb_data);
213 /* Were we triggered by an event from the wait thread, rather than by a
215 int triggered_by_event = (revents & G_IO_IN);
217 /* If so, and if the USB event source has not been removed from the
218 * session, reset the event that woke us and tell the wait thread to start
219 * waiting for events again. */
220 if (triggered_by_event && ctx->usb_thread_running) {
221 ResetEvent(ctx->usb_wait_complete_event);
222 SetEvent(ctx->usb_wait_request_event);
229 SR_PRIV int usb_source_add(struct sr_session *session, struct sr_context *ctx,
230 int timeout, sr_receive_data_callback cb, void *cb_data)
232 if (ctx->usb_source_present) {
233 sr_err("A USB event source is already present.");
238 /* Create events used to signal between main and USB wait threads. */
239 ctx->usb_wait_request_event = CreateEvent(NULL, TRUE, FALSE, NULL);
240 ctx->usb_wait_complete_event = CreateEvent(NULL, TRUE, FALSE, NULL);
241 /* Start USB wait thread. */
242 ctx->usb_thread_running = TRUE;
243 ctx->usb_thread = g_thread_new("usb", usb_thread, ctx);
244 /* Add event, set by USB wait thread, to session poll set. */
245 ctx->usb_pollfd.fd = ctx->usb_wait_complete_event;
246 ctx->usb_pollfd.events = G_IO_IN;
248 ctx->usb_cb_data = cb_data;
249 sr_session_source_add_pollfd(session, &ctx->usb_pollfd, timeout,
252 const struct libusb_pollfd **lupfd;
255 lupfd = libusb_get_pollfds(ctx->libusb_ctx);
256 for (i = 0; lupfd[i]; i++)
257 sr_session_source_add(session, lupfd[i]->fd, lupfd[i]->events,
258 timeout, cb, cb_data);
261 ctx->usb_source_present = TRUE;
266 SR_PRIV int usb_source_remove(struct sr_session *session, struct sr_context *ctx)
268 if (!ctx->usb_source_present)
272 /* Signal the USB wait thread to stop, then unblock it so it does. */
273 ctx->usb_thread_running = FALSE;
274 SetEvent(ctx->usb_wait_request_event);
275 libusb_unlock_events(ctx->libusb_ctx);
276 /* Wait for USB wait thread to terminate. */
277 g_thread_join(ctx->usb_thread);
278 /* Remove USB event from session poll set. */
279 sr_session_source_remove_pollfd(session, &ctx->usb_pollfd);
280 /* Close event handles that were used between threads. */
281 CloseHandle(ctx->usb_wait_request_event);
282 CloseHandle(ctx->usb_wait_complete_event);
284 const struct libusb_pollfd **lupfd;
287 lupfd = libusb_get_pollfds(ctx->libusb_ctx);
288 for (i = 0; lupfd[i]; i++)
289 sr_session_source_remove(session, lupfd[i]->fd);
292 ctx->usb_source_present = FALSE;
297 SR_PRIV int usb_get_port_path(libusb_device *dev, char *path, int path_len)
299 uint8_t port_numbers[8];
303 * FreeBSD requires that devices prior to calling libusb_get_port_numbers()
304 * have been opened with libusb_open().
307 struct libusb_device_handle *devh;
308 if (libusb_open(dev, &devh) != 0)
311 n = libusb_get_port_numbers(dev, port_numbers, sizeof(port_numbers));
316 /* Workaround FreeBSD libusb_get_port_numbers() returning 0. */
319 port_numbers[0] = libusb_get_device_address(dev);
326 len = snprintf(path, path_len, "usb/%d-%d",
327 libusb_get_bus_number(dev), port_numbers[0]);
329 for (i = 1; i < n; i++)
330 len += snprintf(path+len, path_len-len, ".%d", port_numbers[i]);