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/>.
27 #include "sigrok-internal.h"
31 static const struct fx2lafw_profile supported_fx2[] = {
33 * EE Electronics ESLA201A
35 { 0x08a9, 0x0014, "CWAV", "USBee AX", NULL,
36 FIRMWARE_DIR "/fx2lafw-cwav-usbeeax.fw", 8 },
37 { 0, 0, 0, 0, 0, 0, 0 }
40 static int fx2lafw_capabilities[] = {
41 SR_HWCAP_LOGIC_ANALYZER,
44 /* These are really implemented in the driver, not the hardware. */
45 SR_HWCAP_LIMIT_SAMPLES,
50 static const char *fx2lafw_probe_names[] = {
62 static uint64_t fx2lafw_supported_samplerates[] = {
74 static struct sr_samplerates fx2lafw_samplerates = {
78 fx2lafw_supported_samplerates,
81 static GSList *dev_insts = NULL;
82 static libusb_context *usb_context = NULL;
84 static int hw_dev_config_set(int dev_index, int hwcap, void *value);
85 static int hw_dev_acquisition_stop(int dev_index, void *session_dev_id);
88 * Check the USB configuration to determine if this is an fx2lafw device.
90 * @return TRUE if the device's configuration profile match fx2lafw
91 * configuration, FALSE otherwise.
93 static gboolean check_conf_profile(libusb_device *dev)
95 struct libusb_device_descriptor des;
96 struct libusb_config_descriptor *conf_dsc = NULL;
97 const struct libusb_interface_descriptor *intf_dsc;
101 /* Assume it's not a Saleae Logic unless proven wrong. */
104 if (libusb_get_device_descriptor(dev, &des) != 0)
107 if (des.bNumConfigurations != 1)
108 /* Need exactly 1 configuration. */
111 if (libusb_get_config_descriptor(dev, 0, &conf_dsc) != 0)
114 if (conf_dsc->bNumInterfaces != 1)
115 /* Need exactly 1 interface. */
118 if (conf_dsc->interface[0].num_altsetting != 1)
119 /* Need just one alternate setting. */
122 intf_dsc = &(conf_dsc->interface[0].altsetting[0]);
123 if (intf_dsc->bNumEndpoints != 2)
124 /* Need exactly 2 end points. */
127 if ((intf_dsc->endpoint[0].bEndpointAddress & 0x8f) !=
128 (2 | LIBUSB_ENDPOINT_IN)) // 0x82
129 /* The first 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;
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 != ctx->profile->vid
169 || des.idProduct != ctx->profile->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)
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 context *fx2lafw_device_new(void)
237 if (!(ctx = g_try_malloc0(sizeof(struct context)))) {
238 sr_err("fx2lafw: %s: ctx malloc failed", __func__);
249 static int hw_init(const char *deviceinfo)
251 struct sr_dev_inst *sdi;
252 struct libusb_device_descriptor des;
253 const struct fx2lafw_profile *fx2lafw_prof;
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 dev_insts = 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,
310 fx2lafw_prof->firmware) == SR_OK)
311 /* Remember when the firmware on this device was updated */
312 g_get_current_time(&ctx->fw_updated);
314 sr_err("fx2lafw: firmware upload failed for "
315 "device %d", devcnt);
316 ctx->usb = sr_usb_dev_inst_new
317 (libusb_get_bus_number(devlist[i]), 0xff, NULL);
322 libusb_free_device_list(devlist, 1);
327 static int hw_dev_open(int dev_index)
330 struct sr_dev_inst *sdi;
334 if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
339 * if the firmware was recently uploaded, wait up to MAX_RENUM_DELAY ms
340 * for the FX2 to renumerate
343 if (GTV_TO_MSEC(ctx->fw_updated) > 0) {
344 sr_info("fx2lafw: waiting for device to reset");
345 /* takes at least 300ms for the FX2 to be gone from the USB bus */
346 g_usleep(300 * 1000);
348 while (timediff < MAX_RENUM_DELAY) {
349 if ((err = fx2lafw_open_dev(dev_index)) == SR_OK)
351 g_usleep(100 * 1000);
352 g_get_current_time(&cur_time);
353 timediff = GTV_TO_MSEC(cur_time) - GTV_TO_MSEC(ctx->fw_updated);
355 sr_info("fx2lafw: device came back after %d ms", timediff);
357 err = fx2lafw_open_dev(dev_index);
361 sr_err("fx2lafw: unable to open device");
366 err = libusb_claim_interface(ctx->usb->devhdl, USB_INTERFACE);
368 sr_err("fx2lafw: Unable to claim interface: %d", err);
372 if (ctx->cur_samplerate == 0) {
373 /* Samplerate hasn't been set; default to the slowest one. */
374 if (hw_dev_config_set(dev_index, SR_HWCAP_SAMPLERATE,
375 &fx2lafw_supported_samplerates[0]) == SR_ERR)
382 static int hw_dev_close(int dev_index)
384 struct sr_dev_inst *sdi;
386 if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) {
387 sr_err("fx2lafw: %s: sdi was NULL", __func__);
397 static int hw_cleanup(void)
400 struct sr_dev_inst *sdi;
404 for(l = dev_insts; l; l = l->next) {
405 if (!(sdi = l->data)) {
406 /* Log error, but continue cleaning up the rest. */
407 sr_err("fx2lafw: %s: sdi was NULL, continuing", __func__);
411 if (!(ctx = sdi->priv)) {
412 /* Log error, but continue cleaning up the rest. */
413 sr_err("fx2lafw: %s: sdi->priv was NULL, continuing",
420 sr_dev_inst_free(sdi);
423 g_slist_free(dev_insts);
427 libusb_exit(usb_context);
433 static void *hw_dev_info_get(int dev_index, int dev_info_id)
435 struct sr_dev_inst *sdi;
438 if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
442 switch (dev_info_id) {
445 case SR_DI_NUM_PROBES:
446 return GINT_TO_POINTER(ctx->profile->num_probes);
447 case SR_DI_PROBE_NAMES:
448 return fx2lafw_probe_names;
449 case SR_DI_SAMPLERATES:
450 return &fx2lafw_samplerates;
451 case SR_DI_TRIGGER_TYPES:
452 return TRIGGER_TYPES;
453 case SR_DI_CUR_SAMPLERATE:
454 return &ctx->cur_samplerate;
460 static int hw_dev_status_get(int dev_index)
462 const struct sr_dev_inst *const sdi =
463 sr_dev_inst_get(dev_insts, dev_index);
466 return SR_ST_NOT_FOUND;
471 static int *hw_hwcap_get_all(void)
473 return fx2lafw_capabilities;
476 static int hw_dev_config_set(int dev_index, int hwcap, void *value)
478 struct sr_dev_inst *sdi;
482 if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
486 if (hwcap == SR_HWCAP_SAMPLERATE) {
487 ctx->cur_samplerate = *(uint64_t *)value;
489 } else if (hwcap == SR_HWCAP_PROBECONFIG) {
491 } else if (hwcap == SR_HWCAP_LIMIT_SAMPLES) {
492 ctx->limit_samples = *(uint64_t *)value;
501 static int receive_data(int fd, int revents, void *cb_data)
505 /* Avoid compiler warnings. */
510 tv.tv_sec = tv.tv_usec = 0;
511 libusb_handle_events_timeout(usb_context, &tv);
516 static void abort_acquisition(struct context *ctx)
518 struct sr_datafeed_packet packet;
520 packet.type = SR_DF_END;
521 sr_session_send(ctx->session_dev_id, &packet);
523 ctx->num_samples = -1;
525 /* TODO: Need to cancel and free any queued up transfers. */
528 static void receive_transfer(struct libusb_transfer *transfer)
530 /* TODO: These statics have to move to the ctx struct. */
531 static int empty_transfer_count = 0;
532 struct sr_datafeed_packet packet;
533 struct sr_datafeed_logic logic;
534 struct context *ctx = transfer->user_data;
536 unsigned char *cur_buf, *new_buf;
539 * If acquisition has already ended, just free any queued up
540 * transfer that come in.
542 if (ctx->num_samples == -1) {
544 libusb_free_transfer(transfer);
548 sr_info("fx2lafw: receive_transfer(): status %d received %d bytes",
549 transfer->status, transfer->actual_length);
551 /* Save incoming transfer before reusing the transfer struct. */
552 cur_buf = transfer->buffer;
553 cur_buflen = transfer->actual_length;
554 ctx = transfer->user_data;
556 /* Fire off a new request. */
557 if (!(new_buf = g_try_malloc(4096))) {
558 sr_err("fx2lafw: %s: new_buf malloc failed", __func__);
559 return; /* TODO: SR_ERR_MALLOC */
562 transfer->buffer = new_buf;
563 transfer->length = 4096;
564 if (libusb_submit_transfer(transfer) != 0) {
565 /* TODO: Stop session? */
566 /* TODO: Better error message. */
567 sr_err("fx2lafw: %s: libusb_submit_transfer error", __func__);
570 if (cur_buflen == 0) {
571 empty_transfer_count++;
572 if (empty_transfer_count > MAX_EMPTY_TRANSFERS) {
574 * The FX2 gave up. End the acquisition, the frontend
575 * will work out that the samplecount is short.
577 abort_acquisition(ctx);
581 empty_transfer_count = 0;
584 /* Send the incoming transfer to the session bus. */
585 packet.type = SR_DF_LOGIC;
586 packet.payload = &logic;
587 logic.length = cur_buflen;
589 logic.data = cur_buf;
590 sr_session_send(ctx->session_dev_id, &packet);
593 ctx->num_samples += cur_buflen;
594 if (ctx->limit_samples &&
595 (unsigned int) ctx->num_samples > ctx->limit_samples) {
596 abort_acquisition(ctx);
600 static int hw_dev_acquisition_start(int dev_index, void *cb_data)
602 struct sr_dev_inst *sdi;
603 struct sr_datafeed_packet *packet;
604 struct sr_datafeed_header *header;
606 struct libusb_transfer *transfer;
607 const struct libusb_pollfd **lupfd;
611 if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
614 ctx->session_dev_id = cb_data;
615 ctx->num_samples = 0;
617 if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
618 sr_err("fx2lafw: %s: packet malloc failed", __func__);
619 return SR_ERR_MALLOC;
622 if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) {
623 sr_err("fx2lafw: %s: header malloc failed", __func__);
624 return SR_ERR_MALLOC;
627 /* Start with 2K transfer, subsequently increased to 4K. */
629 for (i = 0; i < NUM_SIMUL_TRANSFERS; i++) {
630 if (!(buf = g_try_malloc(size))) {
631 sr_err("fx2lafw: %s: buf malloc failed", __func__);
632 return SR_ERR_MALLOC;
634 transfer = libusb_alloc_transfer(0);
635 libusb_fill_bulk_transfer(transfer, ctx->usb->devhdl,
636 2 | LIBUSB_ENDPOINT_IN, buf, size,
637 receive_transfer, ctx, 40);
638 if (libusb_submit_transfer(transfer) != 0) {
639 /* TODO: Free them all. */
640 libusb_free_transfer(transfer);
647 lupfd = libusb_get_pollfds(usb_context);
648 for (i = 0; lupfd[i]; i++)
649 sr_source_add(lupfd[i]->fd, lupfd[i]->events,
650 40, receive_data, NULL);
651 free(lupfd); /* NOT g_free()! */
653 packet->type = SR_DF_HEADER;
654 packet->payload = header;
655 header->feed_version = 1;
656 gettimeofday(&header->starttime, NULL);
657 header->samplerate = ctx->cur_samplerate;
658 header->num_logic_probes = ctx->profile->num_probes;
659 sr_session_send(cb_data, packet);
663 if ((err = command_start_acquisition (ctx->usb->devhdl,
664 ctx->cur_samplerate)) != SR_OK) {
671 /* TODO: This stops acquisition on ALL devices, ignoring dev_index. */
672 static int hw_dev_acquisition_stop(int dev_index, void *cb_data)
674 struct sr_dev_inst *sdi;
676 /* unused parameter */
679 if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
682 abort_acquisition(sdi->priv);
687 SR_PRIV struct sr_dev_driver fx2lafw_driver_info = {
689 .longname = "fx2lafw",
692 .cleanup = hw_cleanup,
693 .dev_open = hw_dev_open,
694 .dev_close = hw_dev_close,
695 .dev_info_get = hw_dev_info_get,
696 .dev_status_get = hw_dev_status_get,
697 .hwcap_get_all = hw_hwcap_get_all,
698 .dev_config_set = hw_dev_config_set,
699 .dev_acquisition_start = hw_dev_acquisition_start,
700 .dev_acquisition_stop = hw_dev_acquisition_stop,