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",
45 { 0x08a9, 0x0009, "CWAV", "USBee SX", NULL,
46 FIRMWARE_DIR "/fx2lafw-cwav-usbeesx.fw",
51 * EE Electronics ESLA100
53 * Robomotic BugLogic 3
55 { 0x0925, 0x3881, "Saleae", "Logic", NULL,
56 FIRMWARE_DIR "/fx2lafw-saleae-logic.fw",
60 * Default Cypress FX2 without EEPROM, e.g.:
62 * Braintechnology USB Interface V2.x
64 { 0x04B4, 0x8613, "Cypress", "FX2", NULL,
65 FIRMWARE_DIR "/fx2lafw-cypress-fx2.fw",
69 * Braintechnology USB-LPS
71 { 0x16d0, 0x0498, "Braintechnology", "USB-LPS", NULL,
72 FIRMWARE_DIR "/fx2lafw-braintechnology-usb-lps.fw",
75 { 0, 0, 0, 0, 0, 0, 0 }
78 static const int hwcaps[] = {
79 SR_HWCAP_LOGIC_ANALYZER,
82 /* These are really implemented in the driver, not the hardware. */
83 SR_HWCAP_LIMIT_SAMPLES,
89 * TODO: Different probe_names[] for each supported device.
91 static const char *probe_names[] = {
111 static const uint64_t supported_samplerates[] = {
131 static const struct sr_samplerates samplerates = {
135 supported_samplerates,
138 static GSList *dev_insts = NULL;
139 static libusb_context *usb_context = NULL;
141 static int hw_dev_config_set(int dev_index, int hwcap, const void *value);
142 static int hw_dev_acquisition_stop(int dev_index, void *cb_data);
145 * Check the USB configuration to determine if this is an fx2lafw device.
147 * @return TRUE if the device's configuration profile match fx2lafw
148 * configuration, FALSE otherwise.
150 static gboolean check_conf_profile(libusb_device *dev)
152 struct libusb_device_descriptor des;
153 struct libusb_device_handle *hdl;
155 unsigned char strdesc[64];
160 /* Assume the FW has not been loaded, unless proven wrong. */
161 if (libusb_get_device_descriptor(dev, &des) != 0)
164 if (libusb_open(dev, &hdl) != 0)
167 if (libusb_get_string_descriptor_ascii(hdl,
168 des.iManufacturer, strdesc, sizeof(strdesc)) < 0)
170 if (strncmp((const char *)strdesc, "sigrok", 6))
173 if (libusb_get_string_descriptor_ascii(hdl,
174 des.iProduct, strdesc, sizeof(strdesc)) < 0)
176 if (strncmp((const char *)strdesc, "fx2lafw", 7))
179 /* If we made it here, it must be an fx2lafw. */
188 static int fx2lafw_dev_open(int dev_index)
190 libusb_device **devlist;
191 struct libusb_device_descriptor des;
192 struct sr_dev_inst *sdi;
194 struct version_info vi;
198 if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
202 if (sdi->status == SR_ST_ACTIVE)
207 const int device_count = libusb_get_device_list(usb_context, &devlist);
208 if (device_count < 0) {
209 sr_err("fx2lafw: Failed to retrieve device list (%d)",
214 for (i = 0; i < device_count; i++) {
215 if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
216 sr_err("fx2lafw: Failed to get device descriptor: %d.",
221 if (des.idVendor != ctx->profile->vid
222 || des.idProduct != ctx->profile->pid)
225 if (sdi->status == SR_ST_INITIALIZING) {
226 if (skip != dev_index) {
227 /* Skip devices of this type that aren't the one we want. */
231 } else if (sdi->status == SR_ST_INACTIVE) {
233 * This device is fully enumerated, so we need to find
234 * this device by vendor, product, bus and address.
236 if (libusb_get_bus_number(devlist[i]) != ctx->usb->bus
237 || libusb_get_device_address(devlist[i]) != ctx->usb->address)
238 /* this is not the one */
242 if (!(ret = libusb_open(devlist[i], &ctx->usb->devhdl))) {
243 if (ctx->usb->address == 0xff)
245 * first time we touch this device after firmware upload,
246 * so we don't know the address yet.
248 ctx->usb->address = libusb_get_device_address(devlist[i]);
250 sr_err("fx2lafw: Failed to open device: %d.", ret);
254 ret = command_get_fw_version(ctx->usb->devhdl, &vi);
256 sr_err("fx2lafw: Failed to retrieve "
257 "firmware version information.");
261 ret = command_get_revid_version(ctx->usb->devhdl, &revid);
263 sr_err("fx2lafw: Failed to retrieve REVID.");
268 * Changes in major version mean incompatible/API changes, so
269 * bail out if we encounter an incompatible version.
270 * Different minor versions are OK, they should be compatible.
272 if (vi.major != FX2LAFW_REQUIRED_VERSION_MAJOR) {
273 sr_err("fx2lafw: Expected firmware version %d.x, "
274 "got %d.%d.", FX2LAFW_REQUIRED_VERSION_MAJOR,
279 sdi->status = SR_ST_ACTIVE;
280 sr_info("fx2lafw: Opened device %d on %d.%d "
281 "interface %d, firmware %d.%d, REVID %d.",
282 sdi->index, ctx->usb->bus, ctx->usb->address,
283 USB_INTERFACE, vi.major, vi.minor, revid);
287 libusb_free_device_list(devlist, 1);
289 if (sdi->status != SR_ST_ACTIVE)
295 static void close_dev(struct sr_dev_inst *sdi)
301 if (ctx->usb->devhdl == NULL)
304 sr_info("fx2lafw: Closing device %d on %d.%d interface %d.",
305 sdi->index, ctx->usb->bus, ctx->usb->address, USB_INTERFACE);
306 libusb_release_interface(ctx->usb->devhdl, USB_INTERFACE);
307 libusb_close(ctx->usb->devhdl);
308 ctx->usb->devhdl = NULL;
309 sdi->status = SR_ST_INACTIVE;
312 static int configure_probes(struct context *ctx, GSList *probes)
314 struct sr_probe *probe;
316 int probe_bit, stage, i;
319 for (i = 0; i < NUM_TRIGGER_STAGES; i++) {
320 ctx->trigger_mask[i] = 0;
321 ctx->trigger_value[i] = 0;
325 for (l = probes; l; l = l->next) {
326 probe = (struct sr_probe *)l->data;
327 if (probe->enabled == FALSE)
330 if (probe->index > 8)
331 ctx->sample_wide = TRUE;
333 probe_bit = 1 << (probe->index - 1);
334 if (!(probe->trigger))
338 for (tc = probe->trigger; *tc; tc++) {
339 ctx->trigger_mask[stage] |= probe_bit;
341 ctx->trigger_value[stage] |= probe_bit;
343 if (stage > NUM_TRIGGER_STAGES)
350 * We didn't configure any triggers, make sure acquisition
351 * doesn't wait for any.
353 ctx->trigger_stage = TRIGGER_FIRED;
355 ctx->trigger_stage = 0;
360 static struct context *fx2lafw_dev_new(void)
364 if (!(ctx = g_try_malloc0(sizeof(struct context)))) {
365 sr_err("fx2lafw: %s: ctx malloc failed.", __func__);
369 ctx->trigger_stage = TRIGGER_FIRED;
378 static int hw_init(const char *devinfo)
380 struct sr_dev_inst *sdi;
381 struct libusb_device_descriptor des;
382 const struct fx2lafw_profile *prof;
384 libusb_device **devlist;
389 /* Avoid compiler warnings. */
392 if (libusb_init(&usb_context) != 0) {
393 sr_warn("fx2lafw: Failed to initialize libusb.");
397 /* Find all fx2lafw compatible devices and upload firmware to them. */
398 libusb_get_device_list(usb_context, &devlist);
399 for (i = 0; devlist[i]; i++) {
401 if ((ret = libusb_get_device_descriptor(
402 devlist[i], &des)) != 0) {
403 sr_warn("fx2lafw: Failed to get device descriptor: %d.", ret);
408 for (j = 0; supported_fx2[j].vid; j++) {
409 if (des.idVendor == supported_fx2[j].vid &&
410 des.idProduct == supported_fx2[j].pid) {
411 prof = &supported_fx2[j];
415 /* Skip if the device was not found */
419 sdi = sr_dev_inst_new(devcnt, SR_ST_INITIALIZING,
420 prof->vendor, prof->model, prof->model_version);
424 ctx = fx2lafw_dev_new();
427 dev_insts = g_slist_append(dev_insts, sdi);
429 if (check_conf_profile(devlist[i])) {
430 /* Already has the firmware, so fix the new address. */
431 sr_dbg("fx2lafw: Found an fx2lafw device.");
432 sdi->status = SR_ST_INACTIVE;
433 ctx->usb = sr_usb_dev_inst_new
434 (libusb_get_bus_number(devlist[i]),
435 libusb_get_device_address(devlist[i]), NULL);
437 if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
438 prof->firmware) == SR_OK)
439 /* Remember when the firmware on this device was updated */
440 ctx->fw_updated = g_get_monotonic_time();
442 sr_err("fx2lafw: Firmware upload failed for "
443 "device %d.", devcnt);
444 ctx->usb = sr_usb_dev_inst_new
445 (libusb_get_bus_number(devlist[i]), 0xff, NULL);
450 libusb_free_device_list(devlist, 1);
455 static int hw_dev_open(int dev_index)
457 struct sr_dev_inst *sdi;
460 int64_t timediff_us, timediff_ms;
462 if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
467 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
468 * milliseconds for the FX2 to renumerate.
472 if (ctx->fw_updated > 0) {
473 sr_info("fx2lafw: Waiting for device to reset.");
474 /* takes at least 300ms for the FX2 to be gone from the USB bus */
475 g_usleep(300 * 1000);
477 while (timediff_ms < MAX_RENUM_DELAY_MS) {
478 if ((ret = fx2lafw_dev_open(dev_index)) == SR_OK)
480 g_usleep(100 * 1000);
482 timediff_us = g_get_monotonic_time() - ctx->fw_updated;
483 timediff_ms = timediff_us / G_USEC_PER_SEC;
484 sr_spew("fx2lafw: timediff: %" PRIi64 " us.",
487 sr_info("fx2lafw: Device came back after %d ms.", timediff_ms);
489 ret = fx2lafw_dev_open(dev_index);
493 sr_err("fx2lafw: Unable to open device.");
498 ret = libusb_claim_interface(ctx->usb->devhdl, USB_INTERFACE);
500 sr_err("fx2lafw: Unable to claim interface: %d.", ret);
504 if (ctx->cur_samplerate == 0) {
505 /* Samplerate hasn't been set; default to the slowest one. */
506 if (hw_dev_config_set(dev_index, SR_HWCAP_SAMPLERATE,
507 &supported_samplerates[0]) == SR_ERR)
514 static int hw_dev_close(int dev_index)
516 struct sr_dev_inst *sdi;
518 if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) {
519 sr_err("fx2lafw: %s: sdi was NULL.", __func__);
529 static int hw_cleanup(void)
532 struct sr_dev_inst *sdi;
536 for (l = dev_insts; l; l = l->next) {
537 if (!(sdi = l->data)) {
538 /* Log error, but continue cleaning up the rest. */
539 sr_err("fx2lafw: %s: sdi was NULL, continuing.",
544 if (!(ctx = sdi->priv)) {
545 /* Log error, but continue cleaning up the rest. */
546 sr_err("fx2lafw: %s: sdi->priv was NULL, continuing",
553 sr_dev_inst_free(sdi);
556 g_slist_free(dev_insts);
560 libusb_exit(usb_context);
566 static const void *hw_dev_info_get(int dev_index, int dev_info_id)
568 struct sr_dev_inst *sdi;
571 if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
575 switch (dev_info_id) {
578 case SR_DI_NUM_PROBES:
579 return GINT_TO_POINTER(
580 (ctx->profile->dev_caps & DEV_CAPS_16BIT) ?
582 case SR_DI_PROBE_NAMES:
584 case SR_DI_SAMPLERATES:
586 case SR_DI_TRIGGER_TYPES:
587 return TRIGGER_TYPES;
588 case SR_DI_CUR_SAMPLERATE:
589 return &ctx->cur_samplerate;
595 static int hw_dev_status_get(int dev_index)
597 const struct sr_dev_inst *const sdi =
598 sr_dev_inst_get(dev_insts, dev_index);
601 return SR_ST_NOT_FOUND;
606 static const int *hw_hwcap_get_all(void)
611 static int hw_dev_config_set(int dev_index, int hwcap, const void *value)
613 struct sr_dev_inst *sdi;
617 if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
621 if (hwcap == SR_HWCAP_SAMPLERATE) {
622 ctx->cur_samplerate = *(const uint64_t *)value;
624 } else if (hwcap == SR_HWCAP_PROBECONFIG) {
625 ret = configure_probes(ctx, (GSList *) value);
626 } else if (hwcap == SR_HWCAP_LIMIT_SAMPLES) {
627 ctx->limit_samples = *(const uint64_t *)value;
636 static int receive_data(int fd, int revents, void *cb_data)
640 /* Avoid compiler warnings. */
645 tv.tv_sec = tv.tv_usec = 0;
646 libusb_handle_events_timeout(usb_context, &tv);
651 static void abort_acquisition(struct context *ctx)
653 ctx->num_samples = -1;
656 static void finish_acquisition(struct context *ctx)
658 struct sr_datafeed_packet packet;
661 /* Terminate session */
662 packet.type = SR_DF_END;
663 sr_session_send(ctx->session_dev_id, &packet);
665 /* Remove fds from polling */
666 const struct libusb_pollfd **const lupfd =
667 libusb_get_pollfds(usb_context);
668 for (i = 0; lupfd[i]; i++)
669 sr_source_remove(lupfd[i]->fd);
670 free(lupfd); /* NOT g_free()! */
673 static void receive_transfer(struct libusb_transfer *transfer)
675 /* TODO: These statics have to move to the ctx struct. */
676 static int empty_transfer_count = 0;
677 struct sr_datafeed_packet packet;
678 struct sr_datafeed_logic logic;
679 struct context *ctx = transfer->user_data;
680 int trigger_offset, i;
684 * If acquisition has already ended, just free any queued up
685 * transfer that come in.
687 if (ctx->num_samples == -1) {
689 libusb_free_transfer(transfer);
691 ctx->submitted_transfers--;
692 if (ctx->submitted_transfers == 0)
693 finish_acquisition(ctx);
698 sr_info("fx2lafw: receive_transfer(): status %d received %d bytes.",
699 transfer->status, transfer->actual_length);
701 /* Save incoming transfer before reusing the transfer struct. */
702 uint8_t *const cur_buf = transfer->buffer;
703 const int sample_width = ctx->sample_wide ? 2 : 1;
704 const int cur_sample_count = transfer->actual_length / sample_width;
706 /* Fire off a new request. */
707 if (!(new_buf = g_try_malloc(4096))) {
708 sr_err("fx2lafw: %s: new_buf malloc failed.", __func__);
709 libusb_free_transfer(transfer);
710 return; /* TODO: SR_ERR_MALLOC */
713 transfer->buffer = new_buf;
714 transfer->length = 4096;
715 if (libusb_submit_transfer(transfer) != 0) {
716 /* TODO: Stop session? */
717 /* TODO: Better error message. */
718 sr_err("fx2lafw: %s: libusb_submit_transfer error.", __func__);
721 if (transfer->actual_length == 0) {
722 empty_transfer_count++;
723 if (empty_transfer_count > MAX_EMPTY_TRANSFERS) {
725 * The FX2 gave up. End the acquisition, the frontend
726 * will work out that the samplecount is short.
728 abort_acquisition(ctx);
733 empty_transfer_count = 0;
737 if (ctx->trigger_stage >= 0) {
738 for (i = 0; i < cur_sample_count; i++) {
740 const uint16_t cur_sample = ctx->sample_wide ?
741 *((const uint16_t*)cur_buf + i) :
742 *((const uint8_t*)cur_buf + i);
744 if ((cur_sample & ctx->trigger_mask[ctx->trigger_stage]) ==
745 ctx->trigger_value[ctx->trigger_stage]) {
746 /* Match on this trigger stage. */
747 ctx->trigger_buffer[ctx->trigger_stage] = cur_sample;
748 ctx->trigger_stage++;
750 if (ctx->trigger_stage == NUM_TRIGGER_STAGES ||
751 ctx->trigger_mask[ctx->trigger_stage] == 0) {
752 /* Match on all trigger stages, we're done. */
753 trigger_offset = i + 1;
756 * TODO: Send pre-trigger buffer to session bus.
757 * Tell the frontend we hit the trigger here.
759 packet.type = SR_DF_TRIGGER;
760 packet.payload = NULL;
761 sr_session_send(ctx->session_dev_id, &packet);
764 * Send the samples that triggered it, since we're
765 * skipping past them.
767 packet.type = SR_DF_LOGIC;
768 packet.payload = &logic;
769 logic.unitsize = sizeof(*ctx->trigger_buffer);
770 logic.length = ctx->trigger_stage * logic.unitsize;
771 logic.data = ctx->trigger_buffer;
772 sr_session_send(ctx->session_dev_id, &packet);
774 ctx->trigger_stage = TRIGGER_FIRED;
777 } else if (ctx->trigger_stage > 0) {
779 * We had a match before, but not in the next sample. However, we may
780 * have a match on this stage in the next bit -- trigger on 0001 will
781 * fail on seeing 00001, so we need to go back to stage 0 -- but at
782 * the next sample from the one that matched originally, which the
783 * counter increment at the end of the loop takes care of.
785 i -= ctx->trigger_stage;
787 i = -1; /* Oops, went back past this buffer. */
788 /* Reset trigger stage. */
789 ctx->trigger_stage = 0;
794 if (ctx->trigger_stage == TRIGGER_FIRED) {
795 /* Send the incoming transfer to the session bus. */
796 const int trigger_offset_bytes = trigger_offset * sample_width;
797 packet.type = SR_DF_LOGIC;
798 packet.payload = &logic;
799 logic.length = transfer->actual_length - trigger_offset_bytes;
800 logic.unitsize = sample_width;
801 logic.data = cur_buf + trigger_offset_bytes;
802 sr_session_send(ctx->session_dev_id, &packet);
804 ctx->num_samples += cur_sample_count;
805 if (ctx->limit_samples &&
806 (unsigned int)ctx->num_samples > ctx->limit_samples) {
807 abort_acquisition(ctx);
811 * TODO: Buffer pre-trigger data in capture
812 * ratio-sized buffer.
818 static int hw_dev_acquisition_start(int dev_index, void *cb_data)
820 struct sr_dev_inst *sdi;
821 struct sr_datafeed_packet *packet;
822 struct sr_datafeed_header *header;
823 struct sr_datafeed_meta_logic meta;
825 struct libusb_transfer *transfer;
826 const struct libusb_pollfd **lupfd;
830 if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
833 ctx->session_dev_id = cb_data;
834 ctx->num_samples = 0;
836 if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
837 sr_err("fx2lafw: %s: packet malloc failed.", __func__);
838 return SR_ERR_MALLOC;
841 if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) {
842 sr_err("fx2lafw: %s: header malloc failed.", __func__);
843 return SR_ERR_MALLOC;
846 /* Start with 2K transfer, subsequently increased to 4K. */
848 for (i = 0; i < NUM_SIMUL_TRANSFERS; i++) {
849 if (!(buf = g_try_malloc(size))) {
850 sr_err("fx2lafw: %s: buf malloc failed.", __func__);
851 return SR_ERR_MALLOC;
853 transfer = libusb_alloc_transfer(0);
854 libusb_fill_bulk_transfer(transfer, ctx->usb->devhdl,
855 2 | LIBUSB_ENDPOINT_IN, buf, size,
856 receive_transfer, ctx, 40);
857 if (libusb_submit_transfer(transfer) != 0) {
858 /* TODO: Free them all. */
859 libusb_free_transfer(transfer);
864 ctx->submitted_transfers++;
868 lupfd = libusb_get_pollfds(usb_context);
869 for (i = 0; lupfd[i]; i++)
870 sr_source_add(lupfd[i]->fd, lupfd[i]->events,
871 40, receive_data, NULL);
872 free(lupfd); /* NOT g_free()! */
874 packet->type = SR_DF_HEADER;
875 packet->payload = header;
876 header->feed_version = 1;
877 gettimeofday(&header->starttime, NULL);
878 sr_session_send(cb_data, packet);
880 /* Send metadata about the SR_DF_LOGIC packets to come. */
881 packet->type = SR_DF_META_LOGIC;
882 packet->payload = &meta;
883 meta.samplerate = ctx->cur_samplerate;
884 meta.num_probes = ctx->sample_wide ? 16 : 8;
885 sr_session_send(cb_data, packet);
890 if ((ret = command_start_acquisition (ctx->usb->devhdl,
891 ctx->cur_samplerate, ctx->sample_wide)) != SR_OK) {
898 /* TODO: This stops acquisition on ALL devices, ignoring dev_index. */
899 static int hw_dev_acquisition_stop(int dev_index, void *cb_data)
901 struct sr_dev_inst *sdi;
903 /* Avoid compiler warnings. */
906 if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
909 abort_acquisition(sdi->priv);
914 SR_PRIV struct sr_dev_driver fx2lafw_driver_info = {
916 .longname = "fx2lafw (generic driver for FX2 based LAs)",
919 .cleanup = hw_cleanup,
920 .dev_open = hw_dev_open,
921 .dev_close = hw_dev_close,
922 .dev_info_get = hw_dev_info_get,
923 .dev_status_get = hw_dev_status_get,
924 .hwcap_get_all = hw_hwcap_get_all,
925 .dev_config_set = hw_dev_config_set,
926 .dev_acquisition_start = hw_dev_acquisition_start,
927 .dev_acquisition_stop = hw_dev_acquisition_stop,