2 * This file is part of the sigrok project.
4 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
29 #include "sigrok-internal.h"
32 static struct fx2lafw_profile supported_fx2[] = {
34 { 0x08a9, 0x0014, "CWAV", "USBee AX", NULL, 8 },
38 static int fx2lafw_capabilities[] = {
39 SR_HWCAP_LOGIC_ANALYZER,
42 /* These are really implemented in the driver, not the hardware. */
43 SR_HWCAP_LIMIT_SAMPLES,
48 static const char *fx2lafw_probe_names[] = {
60 static uint64_t fx2lafw_supported_samplerates[] = {
72 static struct sr_samplerates fx2lafw_samplerates = {
76 fx2lafw_supported_samplerates
79 static GSList *dev_insts = NULL;
80 static libusb_context *usb_context = NULL;
83 * Check the USB configuration to determine if this is an fx2lafw device.
85 * @return true if the device's configuration profile match fx2lafw
86 * configuration, flase otherwise.
88 static bool check_conf_profile(libusb_device *dev)
90 struct libusb_device_descriptor des;
91 struct libusb_config_descriptor *conf_dsc = NULL;
92 const struct libusb_interface_descriptor *intf_dsc;
96 /* Assume it's not a Saleae Logic unless proven wrong. */
99 if (libusb_get_device_descriptor(dev, &des) != 0)
102 if (des.bNumConfigurations != 1)
103 /* Need exactly 1 configuration. */
106 if (libusb_get_config_descriptor(dev, 0, &conf_dsc) != 0)
109 if (conf_dsc->bNumInterfaces != 1)
110 /* Need exactly 1 interface. */
113 if (conf_dsc->interface[0].num_altsetting != 1)
114 /* Need just one alternate setting. */
117 intf_dsc = &(conf_dsc->interface[0].altsetting[0]);
118 if (intf_dsc->bNumEndpoints != 3)
119 /* Need exactly 3 end points. */
122 if ((intf_dsc->endpoint[0].bEndpointAddress & 0x8f) !=
123 (1 | LIBUSB_ENDPOINT_OUT))
124 /* The first endpoint should be 1 (outbound). */
127 if ((intf_dsc->endpoint[1].bEndpointAddress & 0x8f) !=
128 (2 | LIBUSB_ENDPOINT_IN))
129 /* The second endpoint should be 2 (inbound). */
132 /* TODO: Check the debug channel... */
134 /* If we made it here, it must be an fx2lafw. */
139 libusb_free_config_descriptor(conf_dsc);
144 static int fx2lafw_open_dev(int dev_index)
146 libusb_device **devlist;
147 struct libusb_device_descriptor des;
148 struct sr_dev_inst *sdi;
149 struct fx2lafw_device *ctx;
152 if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
156 if (sdi->status == SR_ST_ACTIVE)
161 libusb_get_device_list(usb_context, &devlist);
162 for (i = 0; devlist[i]; i++) {
163 if ((err = libusb_get_device_descriptor(devlist[i], &des))) {
164 sr_err("fx2lafw: failed to get device descriptor: %d", err);
168 if (des.idVendor != FIRMWARE_VID
169 || des.idProduct != FIRMWARE_PID)
172 if (sdi->status == SR_ST_INITIALIZING) {
173 if (skip != dev_index) {
174 /* Skip devices of this type that aren't the one we want. */
178 } else if (sdi->status == SR_ST_INACTIVE) {
180 * This device is fully enumerated, so we need to find
181 * this device by vendor, product, bus and address.
183 if (libusb_get_bus_number(devlist[i]) != ctx->usb->bus
184 || libusb_get_device_address(devlist[i]) != ctx->usb->address)
185 /* this is not the one */
189 if (!(err = libusb_open(devlist[i], &ctx->usb->devhdl))) {
190 if (ctx->usb->address == 0xff)
192 * first time we touch this device after firmware upload,
193 * so we don't know the address yet.
195 ctx->usb->address = libusb_get_device_address(devlist[i]);
197 sdi->status = SR_ST_ACTIVE;
198 sr_info("fx2lafw: opened device %d on %d.%d interface %d",
199 sdi->index, ctx->usb->bus,
200 ctx->usb->address, USB_INTERFACE);
202 sr_err("fx2lafw: failed to open device: %d", err);
205 /* if we made it here, we handled the device one way or another */
208 libusb_free_device_list(devlist, 1);
210 if (sdi->status != SR_ST_ACTIVE)
216 static void close_dev(struct sr_dev_inst *sdi)
218 struct fx2lafw_device *ctx;
222 if (ctx->usb->devhdl == NULL)
225 sr_info("fx2lafw: closing device %d on %d.%d interface %d", sdi->index,
226 ctx->usb->bus, ctx->usb->address, USB_INTERFACE);
227 libusb_release_interface(ctx->usb->devhdl, USB_INTERFACE);
228 libusb_close(ctx->usb->devhdl);
229 ctx->usb->devhdl = NULL;
230 sdi->status = SR_ST_INACTIVE;
233 static struct fx2lafw_device* fx2lafw_device_new(void)
235 struct fx2lafw_device *fx2lafw;
237 if (!(fx2lafw = g_try_malloc0(sizeof(struct fx2lafw_device)))) {
238 sr_err("fx2lafw: %s: fx2lafw_device malloc failed", __func__);
249 static int hw_init(const char *deviceinfo)
251 struct sr_dev_inst *sdi;
252 struct libusb_device_descriptor des;
253 struct fx2lafw_profile *fx2lafw_prof;
254 struct fx2lafw_device *ctx;
255 libusb_device **devlist;
260 /* Avoid compiler warnings. */
263 if (libusb_init(&usb_context) != 0) {
264 sr_warn("Failed to initialize USB.");
268 /* Find all fx2lafw compatible devices and upload firware to all of them. */
269 libusb_get_device_list(usb_context, &devlist);
270 for (i = 0; devlist[i]; i++) {
272 if ((err = libusb_get_device_descriptor(
273 devlist[i], &des)) != 0) {
274 sr_warn("failed to get device descriptor: %d", err);
279 for (j = 0; supported_fx2[j].vid; j++) {
280 if (des.idVendor == supported_fx2[j].vid &&
281 des.idProduct == supported_fx2[j].pid) {
282 fx2lafw_prof = &supported_fx2[j];
286 /* Skip if the device was not found */
290 sdi = sr_dev_inst_new(devcnt, SR_ST_INITIALIZING,
291 fx2lafw_prof->vendor, fx2lafw_prof->model,
292 fx2lafw_prof->model_version);
296 ctx = fx2lafw_device_new();
297 ctx->profile = fx2lafw_prof;
299 device_instances = g_slist_append(dev_insts, sdi);
301 if (check_conf_profile(devlist[i])) {
302 /* Already has the firmware, so fix the new address. */
303 sr_dbg("fx2lafw: Found a fx2lafw device.");
304 sdi->status = SR_ST_INACTIVE;
305 ctx->usb = sr_usb_dev_inst_new
306 (libusb_get_bus_number(devlist[i]),
307 libusb_get_device_address(devlist[i]), NULL);
309 if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION, FIRMWARE) == SR_OK)
310 /* Remember when the firmware on this device was updated */
311 g_get_current_time(&ctx->fw_updated);
313 sr_err("fx2lafw: firmware upload failed for "
314 "device %d", devcnt);
315 ctx->usb = sr_usb_dev_inst_new
316 (libusb_get_bus_number(devlist[i]), 0xff, NULL);
321 libusb_free_device_list(devlist, 1);
326 static int hw_dev_open(int device_index)
329 struct sr_dev_inst *sdi;
330 struct fx2lafw_device *ctx;
333 if (!(sdi = sr_dev_inst_get(dev_insts, device_index)))
338 * if the firmware was recently uploaded, wait up to MAX_RENUM_DELAY ms
339 * for the FX2 to renumerate
342 if (GTV_TO_MSEC(ctx->fw_updated) > 0) {
343 sr_info("fx2lafw: waiting for device to reset");
344 /* takes at least 300ms for the FX2 to be gone from the USB bus */
345 g_usleep(300 * 1000);
347 while (timediff < MAX_RENUM_DELAY) {
348 if ((err = fx2lafw_open_dev(device_index)) == SR_OK)
350 g_usleep(100 * 1000);
351 g_get_current_time(&cur_time);
352 timediff = GTV_TO_MSEC(cur_time) - GTV_TO_MSEC(ctx->fw_updated);
354 sr_info("fx2lafw: device came back after %d ms", timediff);
356 err = fx2lafw_open_dev(device_index);
360 sr_err("fx2lafw: unable to open device");
365 err = libusb_claim_interface(ctx->usb->devhdl, USB_INTERFACE);
367 sr_err("fx2lafw: Unable to claim interface: %d", err);
374 static int hw_dev_close(int dev_index)
376 struct sr_dev_inst *sdi;
378 if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) {
379 sr_err("fx2lafw: %s: sdi was NULL", __func__);
380 return SR_ERR; /* TODO: SR_ERR_ARG? */
389 static int hw_cleanup(void)
392 struct sr_dev_inst *sdi;
393 struct fx2lafw_device *ctx;
396 for(l = dev_insts; l; l = l->next) {
397 if (!(sdi = l->data)) {
398 /* Log error, but continue cleaning up the rest. */
399 sr_err("fx2lafw: %s: sdi was NULL, continuing", __func__);
403 if (!(ctx = sdi->priv)) {
404 /* Log error, but continue cleaning up the rest. */
405 sr_err("fx2lafw: %s: sdi->priv was NULL, continuing",
412 sr_dev_inst_free(sdi);
415 g_slist_free(dev_insts);
419 libusb_exit(usb_context);
425 static void *hw_dev_info_get(int device_index, int device_info_id)
427 struct sr_dev_inst *sdi;
428 struct fx2lafw_device *ctx;
430 if (!(sdi = sr_dev_inst_get(dev_insts, device_index)))
434 switch (device_info_id) {
437 case SR_DI_NUM_PROBES:
438 return GINT_TO_POINTER(ctx->profile->num_probes);
439 case SR_DI_PROBE_NAMES:
440 return fx2lafw_probe_names;
441 case SR_DI_SAMPLERATES:
442 return &fx2lafw_samplerates;
443 case SR_DI_TRIGGER_TYPES:
444 return TRIGGER_TYPES;
450 static int hw_dev_status_get(int device_index)
452 const struct sr_dev_inst *const sdi =
453 sr_dev_inst_get(dev_insts, device_index);
456 return SR_ST_NOT_FOUND;
461 static int *hw_hwcap_get_all(void)
463 return fx2lafw_capabilities;
466 static int hw_dev_config_set(int dev_index, int capability, void *value)
474 static int hw_dev_acquisition_start(int dev_index, gpointer session_data)
481 /* This stops acquisition on ALL devices, ignoring device_index. */
482 static int hw_dev_acquisition_stop(int dev_index, gpointer session_data)
489 SR_PRIV struct sr_dev_plugin fx2lafw_plugin_info = {
491 .longname = "fx2lafw",
494 .cleanup = hw_cleanup,
495 .dev_open = hw_dev_open,
496 .dev_close = hw_dev_close,
497 .dev_info_get = hw_dev_info_get,
498 .dev_status_get = hw_dev_status_get,
499 .hwcap_get_all = hw_hwcap_get_all,
500 .dev_config_set = hw_dev_config_set,
501 .dev_acquisition_start = hw_dev_acquisition_start,
502 .dev_acquisition_stop = hw_dev_acquisition_stop,