2 * This file is part of the sigrok project.
4 * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
5 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
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 3 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, see <http://www.gnu.org/licenses/>.
28 #include "sigrok-internal.h"
32 static const struct fx2lafw_profile supported_fx2[] = {
35 * EE Electronics ESLA201A
38 { 0x08a9, 0x0014, "CWAV", "USBee AX", NULL,
39 FIRMWARE_DIR "/fx2lafw-cwav-usbeeax.fw", 8 },
44 { 0x08a9, 0x0009, "CWAV", "USBee SX", NULL,
45 FIRMWARE_DIR "/fx2lafw-cwav-usbeesx.fw", 8 },
49 * EE Electronics ESLA100
51 * Robomotic BugLogic 3
53 { 0x0925, 0x3881, "Saleae", "Logic", NULL,
54 FIRMWARE_DIR "/fx2lafw-saleae-logic.fw", 8 },
57 * Default Cypress FX2 without EEPROM, e.g.:
59 * Braintechnology USB Interface V2.x
61 { 0x04B4, 0x8613, "Cypress", "FX2", NULL,
62 FIRMWARE_DIR "/fx2lafw-cypress-fx2.fw", 8 },
65 * Braintechnology USB-LPS
67 { 0x16d0, 0x0498, "Braintechnology", "USB-LPS", NULL,
68 FIRMWARE_DIR "/fx2lafw-braintechnology-usb-lps.fw", 8 },
70 { 0, 0, 0, 0, 0, 0, 0 }
73 static const int hwcaps[] = {
74 SR_HWCAP_LOGIC_ANALYZER,
77 /* These are really implemented in the driver, not the hardware. */
78 SR_HWCAP_LIMIT_SAMPLES,
84 * TODO: Different probe_names[] for each supported device.
86 static const char *probe_names[] = {
98 static const uint64_t supported_samplerates[] = {
118 static const struct sr_samplerates samplerates = {
122 supported_samplerates,
125 static GSList *dev_insts = NULL;
126 static libusb_context *usb_context = NULL;
128 static int hw_dev_config_set(int dev_index, int hwcap, const void *value);
129 static int hw_dev_acquisition_stop(int dev_index, void *cb_data);
132 * Check the USB configuration to determine if this is an fx2lafw device.
134 * @return TRUE if the device's configuration profile match fx2lafw
135 * configuration, FALSE otherwise.
137 static gboolean check_conf_profile(libusb_device *dev)
139 struct libusb_device_descriptor des;
140 struct libusb_device_handle *hdl;
142 unsigned char strdesc[64];
147 /* Assume the FW has not been loaded, unless proven wrong. */
148 if (libusb_get_device_descriptor(dev, &des) != 0)
151 if (libusb_open(dev, &hdl) != 0)
154 if (libusb_get_string_descriptor_ascii(hdl,
155 des.iManufacturer, strdesc, sizeof(strdesc)) < 0)
157 if (strncmp((const char *)strdesc, "sigrok", 6))
160 if (libusb_get_string_descriptor_ascii(hdl,
161 des.iProduct, strdesc, sizeof(strdesc)) < 0)
163 if (strncmp((const char *)strdesc, "fx2lafw", 7))
166 /* If we made it here, it must be an fx2lafw. */
175 static int fx2lafw_dev_open(int dev_index)
177 libusb_device **devlist;
178 struct libusb_device_descriptor des;
179 struct sr_dev_inst *sdi;
181 struct version_info vi;
185 if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
189 if (sdi->status == SR_ST_ACTIVE)
194 const int device_count = libusb_get_device_list(usb_context, &devlist);
195 if (device_count < 0) {
196 sr_err("fx2lafw: Failed to retrieve device list (%d)",
201 for (i = 0; i < device_count; i++) {
202 if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
203 sr_err("fx2lafw: Failed to get device descriptor: %d.",
208 if (des.idVendor != ctx->profile->vid
209 || des.idProduct != ctx->profile->pid)
212 if (sdi->status == SR_ST_INITIALIZING) {
213 if (skip != dev_index) {
214 /* Skip devices of this type that aren't the one we want. */
218 } else if (sdi->status == SR_ST_INACTIVE) {
220 * This device is fully enumerated, so we need to find
221 * this device by vendor, product, bus and address.
223 if (libusb_get_bus_number(devlist[i]) != ctx->usb->bus
224 || libusb_get_device_address(devlist[i]) != ctx->usb->address)
225 /* this is not the one */
229 if (!(ret = libusb_open(devlist[i], &ctx->usb->devhdl))) {
230 if (ctx->usb->address == 0xff)
232 * first time we touch this device after firmware upload,
233 * so we don't know the address yet.
235 ctx->usb->address = libusb_get_device_address(devlist[i]);
237 sr_err("fx2lafw: Failed to open device: %d.", ret);
241 ret = command_get_fw_version(ctx->usb->devhdl, &vi);
243 sr_err("fx2lafw: Failed to retrieve "
244 "firmware version information.");
248 ret = command_get_revid_version(ctx->usb->devhdl, &revid);
250 sr_err("fx2lafw: Failed to retrieve REVID.");
255 * Changes in major version mean incompatible/API changes, so
256 * bail out if we encounter an incompatible version.
257 * Different minor versions are OK, they should be compatible.
259 if (vi.major != FX2LAFW_REQUIRED_VERSION_MAJOR) {
260 sr_err("fx2lafw: Expected firmware version %d.x, "
261 "got %d.%d.", FX2LAFW_REQUIRED_VERSION_MAJOR,
266 sdi->status = SR_ST_ACTIVE;
267 sr_info("fx2lafw: Opened device %d on %d.%d "
268 "interface %d, firmware %d.%d, REVID %d.",
269 sdi->index, ctx->usb->bus, ctx->usb->address,
270 USB_INTERFACE, vi.major, vi.minor, revid);
274 libusb_free_device_list(devlist, 1);
276 if (sdi->status != SR_ST_ACTIVE)
282 static void close_dev(struct sr_dev_inst *sdi)
288 if (ctx->usb->devhdl == NULL)
291 sr_info("fx2lafw: Closing device %d on %d.%d interface %d.",
292 sdi->index, ctx->usb->bus, ctx->usb->address, USB_INTERFACE);
293 libusb_release_interface(ctx->usb->devhdl, USB_INTERFACE);
294 libusb_close(ctx->usb->devhdl);
295 ctx->usb->devhdl = NULL;
296 sdi->status = SR_ST_INACTIVE;
299 static int configure_probes(struct context *ctx, GSList *probes)
301 struct sr_probe *probe;
303 int probe_bit, stage, i;
306 for (i = 0; i < NUM_TRIGGER_STAGES; i++) {
307 ctx->trigger_mask[i] = 0;
308 ctx->trigger_value[i] = 0;
312 for (l = probes; l; l = l->next) {
313 probe = (struct sr_probe *)l->data;
314 if (probe->enabled == FALSE)
316 probe_bit = 1 << (probe->index - 1);
317 if (!(probe->trigger))
321 for (tc = probe->trigger; *tc; tc++) {
322 ctx->trigger_mask[stage] |= probe_bit;
324 ctx->trigger_value[stage] |= probe_bit;
326 if (stage > NUM_TRIGGER_STAGES)
333 * We didn't configure any triggers, make sure acquisition
334 * doesn't wait for any.
336 ctx->trigger_stage = TRIGGER_FIRED;
338 ctx->trigger_stage = 0;
343 static struct context *fx2lafw_dev_new(void)
347 if (!(ctx = g_try_malloc0(sizeof(struct context)))) {
348 sr_err("fx2lafw: %s: ctx malloc failed.", __func__);
352 ctx->trigger_stage = TRIGGER_FIRED;
361 static int hw_init(const char *devinfo)
363 struct sr_dev_inst *sdi;
364 struct libusb_device_descriptor des;
365 const struct fx2lafw_profile *prof;
367 libusb_device **devlist;
372 /* Avoid compiler warnings. */
375 if (libusb_init(&usb_context) != 0) {
376 sr_warn("fx2lafw: Failed to initialize libusb.");
380 /* Find all fx2lafw compatible devices and upload firmware to them. */
381 libusb_get_device_list(usb_context, &devlist);
382 for (i = 0; devlist[i]; i++) {
384 if ((ret = libusb_get_device_descriptor(
385 devlist[i], &des)) != 0) {
386 sr_warn("fx2lafw: Failed to get device descriptor: %d.", ret);
391 for (j = 0; supported_fx2[j].vid; j++) {
392 if (des.idVendor == supported_fx2[j].vid &&
393 des.idProduct == supported_fx2[j].pid) {
394 prof = &supported_fx2[j];
398 /* Skip if the device was not found */
402 sdi = sr_dev_inst_new(devcnt, SR_ST_INITIALIZING,
403 prof->vendor, prof->model, prof->model_version);
407 ctx = fx2lafw_dev_new();
410 dev_insts = g_slist_append(dev_insts, sdi);
412 if (check_conf_profile(devlist[i])) {
413 /* Already has the firmware, so fix the new address. */
414 sr_dbg("fx2lafw: Found an fx2lafw device.");
415 sdi->status = SR_ST_INACTIVE;
416 ctx->usb = sr_usb_dev_inst_new
417 (libusb_get_bus_number(devlist[i]),
418 libusb_get_device_address(devlist[i]), NULL);
420 if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
421 prof->firmware) == SR_OK)
422 /* Remember when the firmware on this device was updated */
423 ctx->fw_updated = g_get_monotonic_time();
425 sr_err("fx2lafw: Firmware upload failed for "
426 "device %d.", devcnt);
427 ctx->usb = sr_usb_dev_inst_new
428 (libusb_get_bus_number(devlist[i]), 0xff, NULL);
433 libusb_free_device_list(devlist, 1);
438 static int hw_dev_open(int dev_index)
440 struct sr_dev_inst *sdi;
443 int64_t timediff_us, timediff_ms;
445 if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
450 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
451 * milliseconds for the FX2 to renumerate.
455 if (ctx->fw_updated > 0) {
456 sr_info("fx2lafw: Waiting for device to reset.");
457 /* takes at least 300ms for the FX2 to be gone from the USB bus */
458 g_usleep(300 * 1000);
460 while (timediff_ms < MAX_RENUM_DELAY_MS) {
461 if ((ret = fx2lafw_dev_open(dev_index)) == SR_OK)
463 g_usleep(100 * 1000);
465 timediff_us = g_get_monotonic_time() - ctx->fw_updated;
466 timediff_ms = timediff_us / G_USEC_PER_SEC;
467 sr_spew("fx2lafw: timediff: %" PRIi64 " us.",
470 sr_info("fx2lafw: Device came back after %d ms.", timediff_ms);
472 ret = fx2lafw_dev_open(dev_index);
476 sr_err("fx2lafw: Unable to open device.");
481 ret = libusb_claim_interface(ctx->usb->devhdl, USB_INTERFACE);
483 sr_err("fx2lafw: Unable to claim interface: %d.", ret);
487 if (ctx->cur_samplerate == 0) {
488 /* Samplerate hasn't been set; default to the slowest one. */
489 if (hw_dev_config_set(dev_index, SR_HWCAP_SAMPLERATE,
490 &supported_samplerates[0]) == SR_ERR)
497 static int hw_dev_close(int dev_index)
499 struct sr_dev_inst *sdi;
501 if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) {
502 sr_err("fx2lafw: %s: sdi was NULL.", __func__);
512 static int hw_cleanup(void)
515 struct sr_dev_inst *sdi;
519 for (l = dev_insts; l; l = l->next) {
520 if (!(sdi = l->data)) {
521 /* Log error, but continue cleaning up the rest. */
522 sr_err("fx2lafw: %s: sdi was NULL, continuing.",
527 if (!(ctx = sdi->priv)) {
528 /* Log error, but continue cleaning up the rest. */
529 sr_err("fx2lafw: %s: sdi->priv was NULL, continuing",
536 sr_dev_inst_free(sdi);
539 g_slist_free(dev_insts);
543 libusb_exit(usb_context);
549 static const void *hw_dev_info_get(int dev_index, int dev_info_id)
551 struct sr_dev_inst *sdi;
554 if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
558 switch (dev_info_id) {
561 case SR_DI_NUM_PROBES:
562 return GINT_TO_POINTER(ctx->profile->num_probes);
563 case SR_DI_PROBE_NAMES:
565 case SR_DI_SAMPLERATES:
567 case SR_DI_TRIGGER_TYPES:
568 return TRIGGER_TYPES;
569 case SR_DI_CUR_SAMPLERATE:
570 return &ctx->cur_samplerate;
576 static int hw_dev_status_get(int dev_index)
578 const struct sr_dev_inst *const sdi =
579 sr_dev_inst_get(dev_insts, dev_index);
582 return SR_ST_NOT_FOUND;
587 static const int *hw_hwcap_get_all(void)
592 static int hw_dev_config_set(int dev_index, int hwcap, const void *value)
594 struct sr_dev_inst *sdi;
598 if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
602 if (hwcap == SR_HWCAP_SAMPLERATE) {
603 ctx->cur_samplerate = *(const uint64_t *)value;
605 } else if (hwcap == SR_HWCAP_PROBECONFIG) {
606 ret = configure_probes(ctx, (GSList *) value);
607 } else if (hwcap == SR_HWCAP_LIMIT_SAMPLES) {
608 ctx->limit_samples = *(const uint64_t *)value;
617 static int receive_data(int fd, int revents, void *cb_data)
621 /* Avoid compiler warnings. */
626 tv.tv_sec = tv.tv_usec = 0;
627 libusb_handle_events_timeout(usb_context, &tv);
632 static void abort_acquisition(struct context *ctx)
634 ctx->num_samples = -1;
637 static void finish_acquisition(struct context *ctx)
639 struct sr_datafeed_packet packet;
642 /* Terminate session */
643 packet.type = SR_DF_END;
644 sr_session_send(ctx->session_dev_id, &packet);
646 /* Remove fds from polling */
647 const struct libusb_pollfd **const lupfd =
648 libusb_get_pollfds(usb_context);
649 for (i = 0; lupfd[i]; i++)
650 sr_source_remove(lupfd[i]->fd);
651 free(lupfd); /* NOT g_free()! */
654 static void receive_transfer(struct libusb_transfer *transfer)
656 /* TODO: These statics have to move to the ctx struct. */
657 static int empty_transfer_count = 0;
658 struct sr_datafeed_packet packet;
659 struct sr_datafeed_logic logic;
660 struct context *ctx = transfer->user_data;
661 int cur_buflen, trigger_offset, i;
662 unsigned char *cur_buf, *new_buf;
665 * If acquisition has already ended, just free any queued up
666 * transfer that come in.
668 if (ctx->num_samples == -1) {
670 libusb_free_transfer(transfer);
672 ctx->submitted_transfers--;
673 if (ctx->submitted_transfers == 0)
674 finish_acquisition(ctx);
679 sr_info("fx2lafw: receive_transfer(): status %d received %d bytes.",
680 transfer->status, transfer->actual_length);
682 /* Save incoming transfer before reusing the transfer struct. */
683 cur_buf = transfer->buffer;
684 cur_buflen = transfer->actual_length;
686 /* Fire off a new request. */
687 if (!(new_buf = g_try_malloc(4096))) {
688 sr_err("fx2lafw: %s: new_buf malloc failed.", __func__);
689 return; /* TODO: SR_ERR_MALLOC */
692 transfer->buffer = new_buf;
693 transfer->length = 4096;
694 if (libusb_submit_transfer(transfer) != 0) {
695 /* TODO: Stop session? */
696 /* TODO: Better error message. */
697 sr_err("fx2lafw: %s: libusb_submit_transfer error.", __func__);
700 if (cur_buflen == 0) {
701 empty_transfer_count++;
702 if (empty_transfer_count > MAX_EMPTY_TRANSFERS) {
704 * The FX2 gave up. End the acquisition, the frontend
705 * will work out that the samplecount is short.
707 abort_acquisition(ctx);
711 empty_transfer_count = 0;
715 if (ctx->trigger_stage >= 0) {
716 for (i = 0; i < cur_buflen; i++) {
718 if ((cur_buf[i] & ctx->trigger_mask[ctx->trigger_stage]) == ctx->trigger_value[ctx->trigger_stage]) {
719 /* Match on this trigger stage. */
720 ctx->trigger_buffer[ctx->trigger_stage] = cur_buf[i];
721 ctx->trigger_stage++;
723 if (ctx->trigger_stage == NUM_TRIGGER_STAGES || ctx->trigger_mask[ctx->trigger_stage] == 0) {
724 /* Match on all trigger stages, we're done. */
725 trigger_offset = i + 1;
728 * TODO: Send pre-trigger buffer to session bus.
729 * Tell the frontend we hit the trigger here.
731 packet.type = SR_DF_TRIGGER;
732 packet.payload = NULL;
733 sr_session_send(ctx->session_dev_id, &packet);
736 * Send the samples that triggered it, since we're
737 * skipping past them.
739 packet.type = SR_DF_LOGIC;
740 packet.payload = &logic;
741 logic.length = ctx->trigger_stage;
743 logic.data = ctx->trigger_buffer;
744 sr_session_send(ctx->session_dev_id, &packet);
746 ctx->trigger_stage = TRIGGER_FIRED;
753 * We had a match before, but not in the next sample. However, we may
754 * have a match on this stage in the next bit -- trigger on 0001 will
755 * fail on seeing 00001, so we need to go back to stage 0 -- but at
756 * the next sample from the one that matched originally, which the
757 * counter increment at the end of the loop takes care of.
759 if (ctx->trigger_stage > 0) {
760 i -= ctx->trigger_stage;
762 i = -1; /* Oops, went back past this buffer. */
763 /* Reset trigger stage. */
764 ctx->trigger_stage = 0;
769 if (ctx->trigger_stage == TRIGGER_FIRED) {
770 /* Send the incoming transfer to the session bus. */
771 packet.type = SR_DF_LOGIC;
772 packet.payload = &logic;
773 logic.length = cur_buflen - trigger_offset;
775 logic.data = cur_buf + trigger_offset;
776 sr_session_send(ctx->session_dev_id, &packet);
779 ctx->num_samples += cur_buflen;
780 if (ctx->limit_samples &&
781 (unsigned int)ctx->num_samples > ctx->limit_samples) {
782 abort_acquisition(ctx);
786 * TODO: Buffer pre-trigger data in capture
787 * ratio-sized buffer.
792 static int hw_dev_acquisition_start(int dev_index, void *cb_data)
794 struct sr_dev_inst *sdi;
795 struct sr_datafeed_packet *packet;
796 struct sr_datafeed_header *header;
797 struct sr_datafeed_meta_logic meta;
799 struct libusb_transfer *transfer;
800 const struct libusb_pollfd **lupfd;
804 if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
807 ctx->session_dev_id = cb_data;
808 ctx->num_samples = 0;
810 if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
811 sr_err("fx2lafw: %s: packet malloc failed.", __func__);
812 return SR_ERR_MALLOC;
815 if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) {
816 sr_err("fx2lafw: %s: header malloc failed.", __func__);
817 return SR_ERR_MALLOC;
820 /* Start with 2K transfer, subsequently increased to 4K. */
822 for (i = 0; i < NUM_SIMUL_TRANSFERS; i++) {
823 if (!(buf = g_try_malloc(size))) {
824 sr_err("fx2lafw: %s: buf malloc failed.", __func__);
825 return SR_ERR_MALLOC;
827 transfer = libusb_alloc_transfer(0);
828 libusb_fill_bulk_transfer(transfer, ctx->usb->devhdl,
829 2 | LIBUSB_ENDPOINT_IN, buf, size,
830 receive_transfer, ctx, 40);
831 if (libusb_submit_transfer(transfer) != 0) {
832 /* TODO: Free them all. */
833 libusb_free_transfer(transfer);
838 ctx->submitted_transfers++;
842 lupfd = libusb_get_pollfds(usb_context);
843 for (i = 0; lupfd[i]; i++)
844 sr_source_add(lupfd[i]->fd, lupfd[i]->events,
845 40, receive_data, NULL);
846 free(lupfd); /* NOT g_free()! */
848 packet->type = SR_DF_HEADER;
849 packet->payload = header;
850 header->feed_version = 1;
851 gettimeofday(&header->starttime, NULL);
852 sr_session_send(cb_data, packet);
854 /* Send metadata about the SR_DF_LOGIC packets to come. */
855 packet->type = SR_DF_META_LOGIC;
856 packet->payload = &meta;
857 meta.samplerate = ctx->cur_samplerate;
858 meta.num_probes = ctx->profile->num_probes;
859 sr_session_send(cb_data, packet);
864 if ((ret = command_start_acquisition (ctx->usb->devhdl,
865 ctx->cur_samplerate)) != SR_OK) {
872 /* TODO: This stops acquisition on ALL devices, ignoring dev_index. */
873 static int hw_dev_acquisition_stop(int dev_index, void *cb_data)
875 struct sr_dev_inst *sdi;
877 /* Avoid compiler warnings. */
880 if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
883 abort_acquisition(sdi->priv);
888 SR_PRIV struct sr_dev_driver fx2lafw_driver_info = {
890 .longname = "fx2lafw (generic driver for FX2 based LAs)",
893 .cleanup = hw_cleanup,
894 .dev_open = hw_dev_open,
895 .dev_close = hw_dev_close,
896 .dev_info_get = hw_dev_info_get,
897 .dev_status_get = hw_dev_status_get,
898 .hwcap_get_all = hw_hwcap_get_all,
899 .dev_config_set = hw_dev_config_set,
900 .dev_acquisition_start = hw_dev_acquisition_start,
901 .dev_acquisition_stop = hw_dev_acquisition_stop,