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/>.
28 #include "sigrok-internal.h"
32 static const struct fx2lafw_profile supported_fx2[] = {
35 * EE Electronics ESLA201A
37 { 0x08a9, 0x0014, "CWAV", "USBee AX", NULL,
38 FIRMWARE_DIR "/fx2lafw-cwav-usbeeax.fw", 8 },
43 { 0x08a9, 0x0009, "CWAV", "USBee SX", NULL,
44 FIRMWARE_DIR "/fx2lafw-cwav-usbeesx.fw", 8 },
48 * EE Electronics ESLA100
51 { 0x0925, 0x3881, "Saleae", "Logic", NULL,
52 FIRMWARE_DIR "/fx2lafw-saleae-logic.fw", 8 },
55 * Default Cypress FX2 without EEPROM
57 { 0x04B4, 0x8613, "Cypress", "FX2", NULL,
58 FIRMWARE_DIR "/fx2lafw-cypress-fx2.fw", 8 },
60 { 0, 0, 0, 0, 0, 0, 0 }
63 static int hwcaps[] = {
64 SR_HWCAP_LOGIC_ANALYZER,
67 /* These are really implemented in the driver, not the hardware. */
68 SR_HWCAP_LIMIT_SAMPLES,
74 * TODO: Different probe_names[] for each supported device.
76 static const char *probe_names[] = {
88 static uint64_t supported_samplerates[] = {
104 static struct sr_samplerates samplerates = {
108 supported_samplerates,
111 static GSList *dev_insts = NULL;
112 static libusb_context *usb_context = NULL;
114 static int hw_dev_config_set(int dev_index, int hwcap, void *value);
115 static int hw_dev_acquisition_stop(int dev_index, void *cb_data);
118 * Check the USB configuration to determine if this is an fx2lafw device.
120 * @return TRUE if the device's configuration profile match fx2lafw
121 * configuration, FALSE otherwise.
123 static gboolean check_conf_profile(libusb_device *dev)
125 struct libusb_device_descriptor des;
126 struct libusb_device_handle *hdl;
128 unsigned char strdesc[64];
133 /* Assume the FW has not been loaded, unless proven wrong. */
134 if (libusb_get_device_descriptor(dev, &des) != 0)
137 if (libusb_open(dev, &hdl) != 0)
140 if (libusb_get_string_descriptor_ascii(hdl,
141 des.iManufacturer, strdesc, sizeof(strdesc)) < 0)
143 if (strncmp((const char *)strdesc, "sigrok", 6))
146 if (libusb_get_string_descriptor_ascii(hdl,
147 des.iProduct, strdesc, sizeof(strdesc)) < 0)
149 if (strncmp((const char *)strdesc, "fx2lafw", 7))
152 /* If we made it here, it must be an fx2lafw. */
161 static int fx2lafw_dev_open(int dev_index)
163 libusb_device **devlist;
164 struct libusb_device_descriptor des;
165 struct sr_dev_inst *sdi;
167 struct version_info vi;
170 if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
174 if (sdi->status == SR_ST_ACTIVE)
179 const int device_count = libusb_get_device_list(usb_context, &devlist);
180 if (device_count < 0) {
181 sr_err("fx2lafw: Failed to retrieve device list (%d)",
186 for (i = 0; i < device_count; i++) {
187 if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
188 sr_err("fx2lafw: Failed to get device descriptor: %d.",
193 if (des.idVendor != ctx->profile->vid
194 || des.idProduct != ctx->profile->pid)
197 if (sdi->status == SR_ST_INITIALIZING) {
198 if (skip != dev_index) {
199 /* Skip devices of this type that aren't the one we want. */
203 } else if (sdi->status == SR_ST_INACTIVE) {
205 * This device is fully enumerated, so we need to find
206 * this device by vendor, product, bus and address.
208 if (libusb_get_bus_number(devlist[i]) != ctx->usb->bus
209 || libusb_get_device_address(devlist[i]) != ctx->usb->address)
210 /* this is not the one */
214 if (!(ret = libusb_open(devlist[i], &ctx->usb->devhdl))) {
215 if (ctx->usb->address == 0xff)
217 * first time we touch this device after firmware upload,
218 * so we don't know the address yet.
220 ctx->usb->address = libusb_get_device_address(devlist[i]);
222 sr_err("fx2lafw: Failed to open device: %d.", ret);
226 ret = command_get_fw_version(ctx->usb->devhdl, &vi);
228 sr_err("fx2lafw: Failed to retrieve "
229 "firmware version information.");
233 if (vi.major != FX2LAFW_VERSION_MAJOR ||
234 vi.minor != FX2LAFW_VERSION_MINOR) {
235 sr_err("fx2lafw: Expected firmware version %d.%02d "
236 "got %d.%02d.", FX2LAFW_VERSION_MAJOR,
237 FX2LAFW_VERSION_MINOR, vi.major, vi.minor);
241 sdi->status = SR_ST_ACTIVE;
242 sr_info("fx2lafw: Opened device %d on %d.%d "
243 "interface %d, firmware version %d.%02d",
244 sdi->index, ctx->usb->bus, ctx->usb->address,
245 USB_INTERFACE, vi.major, vi.minor);
249 libusb_free_device_list(devlist, 1);
251 if (sdi->status != SR_ST_ACTIVE)
257 static void close_dev(struct sr_dev_inst *sdi)
263 if (ctx->usb->devhdl == NULL)
266 sr_info("fx2lafw: Closing device %d on %d.%d interface %d.",
267 sdi->index, ctx->usb->bus, ctx->usb->address, USB_INTERFACE);
268 libusb_release_interface(ctx->usb->devhdl, USB_INTERFACE);
269 libusb_close(ctx->usb->devhdl);
270 ctx->usb->devhdl = NULL;
271 sdi->status = SR_ST_INACTIVE;
274 static int configure_probes(struct context *ctx, GSList *probes)
276 struct sr_probe *probe;
278 int probe_bit, stage, i;
281 for (i = 0; i < NUM_TRIGGER_STAGES; i++) {
282 ctx->trigger_mask[i] = 0;
283 ctx->trigger_value[i] = 0;
287 for (l = probes; l; l = l->next) {
288 probe = (struct sr_probe *)l->data;
289 if (probe->enabled == FALSE)
291 probe_bit = 1 << (probe->index - 1);
292 if (!(probe->trigger))
296 for (tc = probe->trigger; *tc; tc++) {
297 ctx->trigger_mask[stage] |= probe_bit;
299 ctx->trigger_value[stage] |= probe_bit;
301 if (stage > NUM_TRIGGER_STAGES)
308 * We didn't configure any triggers, make sure acquisition
309 * doesn't wait for any.
311 ctx->trigger_stage = TRIGGER_FIRED;
313 ctx->trigger_stage = 0;
318 static struct context *fx2lafw_dev_new(void)
322 if (!(ctx = g_try_malloc0(sizeof(struct context)))) {
323 sr_err("fx2lafw: %s: ctx malloc failed.", __func__);
327 ctx->trigger_stage = TRIGGER_FIRED;
336 static int hw_init(const char *devinfo)
338 struct sr_dev_inst *sdi;
339 struct libusb_device_descriptor des;
340 const struct fx2lafw_profile *prof;
342 libusb_device **devlist;
347 /* Avoid compiler warnings. */
350 if (libusb_init(&usb_context) != 0) {
351 sr_warn("fx2lafw: Failed to initialize libusb.");
355 /* Find all fx2lafw compatible devices and upload firware to them. */
356 libusb_get_device_list(usb_context, &devlist);
357 for (i = 0; devlist[i]; i++) {
359 if ((ret = libusb_get_device_descriptor(
360 devlist[i], &des)) != 0) {
361 sr_warn("fx2lafw: Failed to get device descriptor: %d.", ret);
366 for (j = 0; supported_fx2[j].vid; j++) {
367 if (des.idVendor == supported_fx2[j].vid &&
368 des.idProduct == supported_fx2[j].pid) {
369 prof = &supported_fx2[j];
373 /* Skip if the device was not found */
377 sdi = sr_dev_inst_new(devcnt, SR_ST_INITIALIZING,
378 prof->vendor, prof->model, prof->model_version);
382 ctx = fx2lafw_dev_new();
385 dev_insts = g_slist_append(dev_insts, sdi);
387 if (check_conf_profile(devlist[i])) {
388 /* Already has the firmware, so fix the new address. */
389 sr_dbg("fx2lafw: Found an fx2lafw device.");
390 sdi->status = SR_ST_INACTIVE;
391 ctx->usb = sr_usb_dev_inst_new
392 (libusb_get_bus_number(devlist[i]),
393 libusb_get_device_address(devlist[i]), NULL);
395 if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
396 prof->firmware) == SR_OK)
397 /* Remember when the firmware on this device was updated */
398 g_get_current_time(&ctx->fw_updated);
400 sr_err("fx2lafw: Firmware upload failed for "
401 "device %d.", devcnt);
402 ctx->usb = sr_usb_dev_inst_new
403 (libusb_get_bus_number(devlist[i]), 0xff, NULL);
408 libusb_free_device_list(devlist, 1);
413 static int hw_dev_open(int dev_index)
416 struct sr_dev_inst *sdi;
420 if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
425 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY ms
426 * for the FX2 to renumerate.
429 if (GTV_TO_MSEC(ctx->fw_updated) > 0) {
430 sr_info("fx2lafw: Waiting for device to reset.");
431 /* takes at least 300ms for the FX2 to be gone from the USB bus */
432 g_usleep(300 * 1000);
434 while (timediff < MAX_RENUM_DELAY) {
435 if ((ret = fx2lafw_dev_open(dev_index)) == SR_OK)
437 g_usleep(100 * 1000);
438 g_get_current_time(&cur_time);
439 timediff = GTV_TO_MSEC(cur_time) - GTV_TO_MSEC(ctx->fw_updated);
441 sr_info("fx2lafw: Device came back after %d ms.", timediff);
443 ret = fx2lafw_dev_open(dev_index);
447 sr_err("fx2lafw: Unable to open device.");
452 ret = libusb_claim_interface(ctx->usb->devhdl, USB_INTERFACE);
454 sr_err("fx2lafw: Unable to claim interface: %d.", ret);
458 if (ctx->cur_samplerate == 0) {
459 /* Samplerate hasn't been set; default to the slowest one. */
460 if (hw_dev_config_set(dev_index, SR_HWCAP_SAMPLERATE,
461 &supported_samplerates[0]) == SR_ERR)
468 static int hw_dev_close(int dev_index)
470 struct sr_dev_inst *sdi;
472 if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) {
473 sr_err("fx2lafw: %s: sdi was NULL.", __func__);
483 static int hw_cleanup(void)
486 struct sr_dev_inst *sdi;
490 for (l = dev_insts; l; l = l->next) {
491 if (!(sdi = l->data)) {
492 /* Log error, but continue cleaning up the rest. */
493 sr_err("fx2lafw: %s: sdi was NULL, continuing.",
498 if (!(ctx = sdi->priv)) {
499 /* Log error, but continue cleaning up the rest. */
500 sr_err("fx2lafw: %s: sdi->priv was NULL, continuing",
507 sr_dev_inst_free(sdi);
510 g_slist_free(dev_insts);
514 libusb_exit(usb_context);
520 static void *hw_dev_info_get(int dev_index, int dev_info_id)
522 struct sr_dev_inst *sdi;
525 if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
529 switch (dev_info_id) {
532 case SR_DI_NUM_PROBES:
533 return GINT_TO_POINTER(ctx->profile->num_probes);
534 case SR_DI_PROBE_NAMES:
536 case SR_DI_SAMPLERATES:
538 case SR_DI_TRIGGER_TYPES:
539 return TRIGGER_TYPES;
540 case SR_DI_CUR_SAMPLERATE:
541 return &ctx->cur_samplerate;
547 static int hw_dev_status_get(int dev_index)
549 const struct sr_dev_inst *const sdi =
550 sr_dev_inst_get(dev_insts, dev_index);
553 return SR_ST_NOT_FOUND;
558 static int *hw_hwcap_get_all(void)
563 static int hw_dev_config_set(int dev_index, int hwcap, void *value)
565 struct sr_dev_inst *sdi;
569 if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
573 if (hwcap == SR_HWCAP_SAMPLERATE) {
574 ctx->cur_samplerate = *(uint64_t *)value;
576 } else if (hwcap == SR_HWCAP_PROBECONFIG) {
577 ret = configure_probes(ctx, (GSList *) value);
578 } else if (hwcap == SR_HWCAP_LIMIT_SAMPLES) {
579 ctx->limit_samples = *(uint64_t *)value;
588 static int receive_data(int fd, int revents, void *cb_data)
592 /* Avoid compiler warnings. */
597 tv.tv_sec = tv.tv_usec = 0;
598 libusb_handle_events_timeout(usb_context, &tv);
603 static void abort_acquisition(struct context *ctx)
605 ctx->num_samples = -1;
608 static void finish_acquisition(struct context *ctx)
610 struct sr_datafeed_packet packet;
613 /* Terminate session */
614 packet.type = SR_DF_END;
615 sr_session_send(ctx->session_dev_id, &packet);
617 /* Remove fds from polling */
618 const struct libusb_pollfd **const lupfd =
619 libusb_get_pollfds(usb_context);
620 for (i = 0; lupfd[i]; i++)
621 sr_source_remove(lupfd[i]->fd);
622 free(lupfd); /* NOT g_free()! */
625 static void receive_transfer(struct libusb_transfer *transfer)
627 /* TODO: These statics have to move to the ctx struct. */
628 static int empty_transfer_count = 0;
629 struct sr_datafeed_packet packet;
630 struct sr_datafeed_logic logic;
631 struct context *ctx = transfer->user_data;
632 int cur_buflen, trigger_offset, i;
633 unsigned char *cur_buf, *new_buf;
636 * If acquisition has already ended, just free any queued up
637 * transfer that come in.
639 if (ctx->num_samples == -1) {
641 libusb_free_transfer(transfer);
643 ctx->submitted_transfers--;
644 if (ctx->submitted_transfers == 0)
645 finish_acquisition(ctx);
650 sr_info("fx2lafw: receive_transfer(): status %d received %d bytes.",
651 transfer->status, transfer->actual_length);
653 /* Save incoming transfer before reusing the transfer struct. */
654 cur_buf = transfer->buffer;
655 cur_buflen = transfer->actual_length;
657 /* Fire off a new request. */
658 if (!(new_buf = g_try_malloc(4096))) {
659 sr_err("fx2lafw: %s: new_buf malloc failed.", __func__);
660 return; /* TODO: SR_ERR_MALLOC */
663 transfer->buffer = new_buf;
664 transfer->length = 4096;
665 if (libusb_submit_transfer(transfer) != 0) {
666 /* TODO: Stop session? */
667 /* TODO: Better error message. */
668 sr_err("fx2lafw: %s: libusb_submit_transfer error.", __func__);
671 if (cur_buflen == 0) {
672 empty_transfer_count++;
673 if (empty_transfer_count > MAX_EMPTY_TRANSFERS) {
675 * The FX2 gave up. End the acquisition, the frontend
676 * will work out that the samplecount is short.
678 abort_acquisition(ctx);
682 empty_transfer_count = 0;
686 if (ctx->trigger_stage >= 0) {
687 for (i = 0; i < cur_buflen; i++) {
689 if ((cur_buf[i] & ctx->trigger_mask[ctx->trigger_stage]) == ctx->trigger_value[ctx->trigger_stage]) {
690 /* Match on this trigger stage. */
691 ctx->trigger_buffer[ctx->trigger_stage] = cur_buf[i];
692 ctx->trigger_stage++;
694 if (ctx->trigger_stage == NUM_TRIGGER_STAGES || ctx->trigger_mask[ctx->trigger_stage] == 0) {
695 /* Match on all trigger stages, we're done. */
696 trigger_offset = i + 1;
699 * TODO: Send pre-trigger buffer to session bus.
700 * Tell the frontend we hit the trigger here.
702 packet.type = SR_DF_TRIGGER;
703 packet.payload = NULL;
704 sr_session_send(ctx->session_dev_id, &packet);
707 * Send the samples that triggered it, since we're
708 * skipping past them.
710 packet.type = SR_DF_LOGIC;
711 packet.payload = &logic;
712 logic.length = ctx->trigger_stage;
714 logic.data = ctx->trigger_buffer;
715 sr_session_send(ctx->session_dev_id, &packet);
717 ctx->trigger_stage = TRIGGER_FIRED;
724 * We had a match before, but not in the next sample. However, we may
725 * have a match on this stage in the next bit -- trigger on 0001 will
726 * fail on seeing 00001, so we need to go back to stage 0 -- but at
727 * the next sample from the one that matched originally, which the
728 * counter increment at the end of the loop takes care of.
730 if (ctx->trigger_stage > 0) {
731 i -= ctx->trigger_stage;
733 i = -1; /* Oops, went back past this buffer. */
734 /* Reset trigger stage. */
735 ctx->trigger_stage = 0;
740 if (ctx->trigger_stage == TRIGGER_FIRED) {
741 /* Send the incoming transfer to the session bus. */
742 packet.type = SR_DF_LOGIC;
743 packet.payload = &logic;
744 logic.length = cur_buflen - trigger_offset;
746 logic.data = cur_buf + trigger_offset;
747 sr_session_send(ctx->session_dev_id, &packet);
750 ctx->num_samples += cur_buflen;
751 if (ctx->limit_samples &&
752 (unsigned int)ctx->num_samples > ctx->limit_samples) {
753 abort_acquisition(ctx);
757 * TODO: Buffer pre-trigger data in capture
758 * ratio-sized buffer.
763 static int hw_dev_acquisition_start(int dev_index, void *cb_data)
765 struct sr_dev_inst *sdi;
766 struct sr_datafeed_packet *packet;
767 struct sr_datafeed_header *header;
769 struct libusb_transfer *transfer;
770 const struct libusb_pollfd **lupfd;
774 if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
777 ctx->session_dev_id = cb_data;
778 ctx->num_samples = 0;
780 if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
781 sr_err("fx2lafw: %s: packet malloc failed.", __func__);
782 return SR_ERR_MALLOC;
785 if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) {
786 sr_err("fx2lafw: %s: header malloc failed.", __func__);
787 return SR_ERR_MALLOC;
790 /* Start with 2K transfer, subsequently increased to 4K. */
792 for (i = 0; i < NUM_SIMUL_TRANSFERS; i++) {
793 if (!(buf = g_try_malloc(size))) {
794 sr_err("fx2lafw: %s: buf malloc failed.", __func__);
795 return SR_ERR_MALLOC;
797 transfer = libusb_alloc_transfer(0);
798 libusb_fill_bulk_transfer(transfer, ctx->usb->devhdl,
799 2 | LIBUSB_ENDPOINT_IN, buf, size,
800 receive_transfer, ctx, 40);
801 if (libusb_submit_transfer(transfer) != 0) {
802 /* TODO: Free them all. */
803 libusb_free_transfer(transfer);
808 ctx->submitted_transfers++;
812 lupfd = libusb_get_pollfds(usb_context);
813 for (i = 0; lupfd[i]; i++)
814 sr_source_add(lupfd[i]->fd, lupfd[i]->events,
815 40, receive_data, NULL);
816 free(lupfd); /* NOT g_free()! */
818 packet->type = SR_DF_HEADER;
819 packet->payload = header;
820 header->feed_version = 1;
821 gettimeofday(&header->starttime, NULL);
822 header->samplerate = ctx->cur_samplerate;
823 header->num_logic_probes = ctx->profile->num_probes;
824 sr_session_send(cb_data, packet);
828 if ((ret = command_start_acquisition (ctx->usb->devhdl,
829 ctx->cur_samplerate)) != SR_OK) {
836 /* TODO: This stops acquisition on ALL devices, ignoring dev_index. */
837 static int hw_dev_acquisition_stop(int dev_index, void *cb_data)
839 struct sr_dev_inst *sdi;
841 /* Avoid compiler warnings. */
844 if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
847 abort_acquisition(sdi->priv);
852 SR_PRIV struct sr_dev_driver fx2lafw_driver_info = {
854 .longname = "fx2lafw (generic driver for FX2 based LAs)",
857 .cleanup = hw_cleanup,
858 .dev_open = hw_dev_open,
859 .dev_close = hw_dev_close,
860 .dev_info_get = hw_dev_info_get,
861 .dev_status_get = hw_dev_status_get,
862 .hwcap_get_all = hw_hwcap_get_all,
863 .dev_config_set = hw_dev_config_set,
864 .dev_acquisition_start = hw_dev_acquisition_start,
865 .dev_acquisition_stop = hw_dev_acquisition_stop,