2 * This file is part of the libsigrok project.
4 * Copyright (C) 2013 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/>.
25 static const struct fx2lafw_profile supported_fx2[] = {
28 * EE Electronics ESLA201A
31 { 0x08a9, 0x0014, "CWAV", "USBee AX", NULL,
32 "fx2lafw-cwav-usbeeax.fw",
38 { 0x08a9, 0x0015, "CWAV", "USBee DX", NULL,
39 "fx2lafw-cwav-usbeedx.fw",
40 DEV_CAPS_16BIT, NULL, NULL },
45 { 0x08a9, 0x0009, "CWAV", "USBee SX", NULL,
46 "fx2lafw-cwav-usbeesx.fw",
49 /* DreamSourceLab DSLogic (before FW upload) */
50 { 0x2a0e, 0x0001, "DreamSourceLab", "DSLogic", NULL,
51 "dreamsourcelab-dslogic-fx2.fw",
52 DEV_CAPS_16BIT, NULL, NULL},
53 /* DreamSourceLab DSLogic (after FW upload) */
54 { 0x2a0e, 0x0001, "DreamSourceLab", "DSLogic", NULL,
55 "dreamsourcelab-dslogic-fx2.fw",
56 DEV_CAPS_16BIT, "DreamSourceLab", "DSLogic"},
58 /* DreamSourceLab DSCope (before FW upload) */
59 { 0x2a0e, 0x0002, "DreamSourceLab", "DSCope", NULL,
60 "dreamsourcelab-dscope-fx2.fw",
61 DEV_CAPS_16BIT, NULL, NULL},
62 /* DreamSourceLab DSCope (after FW upload) */
63 { 0x2a0e, 0x0002, "DreamSourceLab", "DSCope", NULL,
64 "dreamsourcelab-dscope-fx2.fw",
65 DEV_CAPS_16BIT, "DreamSourceLab", "DSCope"},
67 /* DreamSourceLab DSLogic Pro (before FW upload) */
68 { 0x2a0e, 0x0003, "DreamSourceLab", "DSLogic Pro", NULL,
69 "dreamsourcelab-dslogic-pro-fx2.fw",
70 DEV_CAPS_16BIT, NULL, NULL},
71 /* DreamSourceLab DSLogic Pro (after FW upload) */
72 { 0x2a0e, 0x0003, "DreamSourceLab", "DSLogic Pro", NULL,
73 "dreamsourcelab-dslogic-pro-fx2.fw",
74 DEV_CAPS_16BIT, "DreamSourceLab", "DSLogic"},
78 * EE Electronics ESLA100
80 * Robomotic BugLogic 3
82 { 0x0925, 0x3881, "Saleae", "Logic", NULL,
83 "fx2lafw-saleae-logic.fw",
87 * Default Cypress FX2 without EEPROM, e.g.:
89 * Braintechnology USB Interface V2.x
91 { 0x04B4, 0x8613, "Cypress", "FX2", NULL,
92 "fx2lafw-cypress-fx2.fw",
93 DEV_CAPS_16BIT, NULL, NULL },
96 * Braintechnology USB-LPS
98 { 0x16d0, 0x0498, "Braintechnology", "USB-LPS", NULL,
99 "fx2lafw-braintechnology-usb-lps.fw",
100 DEV_CAPS_16BIT, NULL, NULL },
103 * sigrok FX2 based 8-channel logic analyzer
105 { 0x1d50, 0x608c, "sigrok", "FX2 LA (8ch)", NULL,
106 "fx2lafw-sigrok-fx2-8ch.fw",
110 * sigrok FX2 based 16-channel logic analyzer
112 { 0x1d50, 0x608d, "sigrok", "FX2 LA (16ch)", NULL,
113 "fx2lafw-sigrok-fx2-16ch.fw",
114 DEV_CAPS_16BIT, NULL, NULL },
116 { 0, 0, 0, 0, 0, 0, 0, 0, 0 }
119 static const uint32_t drvopts[] = {
120 SR_CONF_LOGIC_ANALYZER,
123 static const uint32_t scanopts[] = {
127 static const uint32_t devopts[] = {
128 SR_CONF_CONTINUOUS | SR_CONF_SET,
129 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
130 SR_CONF_CONN | SR_CONF_GET,
131 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
132 SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
133 SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
136 static const char *channel_names[] = {
137 "0", "1", "2", "3", "4", "5", "6", "7",
138 "8", "9", "10", "11", "12", "13", "14", "15",
141 static const int32_t soft_trigger_matches[] = {
149 static const uint64_t samplerates[] = {
168 static const uint64_t dslogic_samplerates[] = {
187 SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
189 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
191 return std_init(sr_ctx, di, LOG_PREFIX);
194 static GSList *scan(struct sr_dev_driver *di, GSList *options)
196 struct drv_context *drvc;
197 struct dev_context *devc;
198 struct sr_dev_inst *sdi;
199 struct sr_usb_dev_inst *usb;
200 struct sr_config *src;
201 const struct fx2lafw_profile *prof;
202 GSList *l, *devices, *conn_devices;
203 gboolean has_firmware;
204 struct libusb_device_descriptor des;
205 libusb_device **devlist;
206 struct libusb_device_handle *hdl;
207 int num_logic_channels, ret, i, j;
209 char manufacturer[64], product[64], serial_num[64], connection_id[64];
214 for (l = options; l; l = l->next) {
218 conn = g_variant_get_string(src->data, NULL);
223 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
227 /* Find all fx2lafw compatible devices and upload firmware to them. */
229 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
230 for (i = 0; devlist[i]; i++) {
233 for (l = conn_devices; l; l = l->next) {
235 if (usb->bus == libusb_get_bus_number(devlist[i])
236 && usb->address == libusb_get_device_address(devlist[i]))
240 /* This device matched none of the ones that
241 * matched the conn specification. */
245 libusb_get_device_descriptor( devlist[i], &des);
247 if ((ret = libusb_open(devlist[i], &hdl)) < 0)
250 if (des.iManufacturer == 0) {
251 manufacturer[0] = '\0';
252 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
253 des.iManufacturer, (unsigned char *) manufacturer,
254 sizeof(manufacturer))) < 0) {
255 sr_warn("Failed to get manufacturer string descriptor: %s.",
256 libusb_error_name(ret));
260 if (des.iProduct == 0) {
262 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
263 des.iProduct, (unsigned char *) product,
264 sizeof(product))) < 0) {
265 sr_warn("Failed to get product string descriptor: %s.",
266 libusb_error_name(ret));
270 if (des.iSerialNumber == 0) {
271 serial_num[0] = '\0';
272 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
273 des.iSerialNumber, (unsigned char *) serial_num,
274 sizeof(serial_num))) < 0) {
275 sr_warn("Failed to get serial number string descriptor: %s.",
276 libusb_error_name(ret));
280 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
285 for (j = 0; supported_fx2[j].vid; j++) {
286 if (des.idVendor == supported_fx2[j].vid &&
287 des.idProduct == supported_fx2[j].pid &&
288 (!supported_fx2[j].usb_manufacturer ||
289 !strcmp(manufacturer, supported_fx2[j].usb_manufacturer)) &&
290 (!supported_fx2[j].usb_manufacturer ||
291 !strcmp(product, supported_fx2[j].usb_product))) {
292 prof = &supported_fx2[j];
297 /* Skip if the device was not found. */
301 sdi = g_malloc0(sizeof(struct sr_dev_inst));
302 sdi->status = SR_ST_INITIALIZING;
303 sdi->vendor = g_strdup(prof->vendor);
304 sdi->model = g_strdup(prof->model);
305 sdi->version = g_strdup(prof->model_version);
307 sdi->serial_num = g_strdup(serial_num);
308 sdi->connection_id = g_strdup(connection_id);
310 /* Fill in channellist according to this device's profile. */
311 num_logic_channels = prof->dev_caps & DEV_CAPS_16BIT ? 16 : 8;
312 for (j = 0; j < num_logic_channels; j++)
313 sr_channel_new(sdi, j, SR_CHANNEL_LOGIC, TRUE,
316 devc = fx2lafw_dev_new();
317 devc->profile = prof;
318 devc->sample_wide = (prof->dev_caps & DEV_CAPS_16BIT) != 0;
320 drvc->instances = g_slist_append(drvc->instances, sdi);
321 devices = g_slist_append(devices, sdi);
323 if (!strcmp(prof->model, "DSLogic")
324 || !strcmp(prof->model, "DSLogic Pro")
325 || !strcmp(prof->model, "DSCope")) {
326 devc->dslogic = TRUE;
327 devc->samplerates = dslogic_samplerates;
328 devc->num_samplerates = ARRAY_SIZE(dslogic_samplerates);
329 has_firmware = match_manuf_prod(devlist[i], "DreamSourceLab", "DSLogic")
330 || match_manuf_prod(devlist[i], "DreamSourceLab", "DSCope");
332 devc->dslogic = FALSE;
333 devc->samplerates = samplerates;
334 devc->num_samplerates = ARRAY_SIZE(samplerates);
335 has_firmware = match_manuf_prod(devlist[i],
336 "sigrok", "fx2lafw");
340 /* Already has the firmware, so fix the new address. */
341 sr_dbg("Found an fx2lafw device.");
342 sdi->status = SR_ST_INACTIVE;
343 sdi->inst_type = SR_INST_USB;
344 sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
345 libusb_get_device_address(devlist[i]), NULL);
347 if (ezusb_upload_firmware(drvc->sr_ctx, devlist[i],
348 USB_CONFIGURATION, prof->firmware) == SR_OK)
349 /* Store when this device's FW was updated. */
350 devc->fw_updated = g_get_monotonic_time();
352 sr_err("Firmware upload failed for "
353 "device %d.%d (logical).",
354 libusb_get_bus_number(devlist[i]),
355 libusb_get_device_address(devlist[i]));
356 sdi->inst_type = SR_INST_USB;
357 sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
361 libusb_free_device_list(devlist, 1);
362 g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
367 static GSList *dev_list(const struct sr_dev_driver *di)
369 return ((struct drv_context *)(di->context))->instances;
372 static int dev_open(struct sr_dev_inst *sdi)
374 struct sr_dev_driver *di = sdi->driver;
375 struct sr_usb_dev_inst *usb;
376 struct dev_context *devc;
377 char *fpga_firmware = NULL;
379 int64_t timediff_us, timediff_ms;
385 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
386 * milliseconds for the FX2 to renumerate.
389 if (devc->fw_updated > 0) {
390 sr_info("Waiting for device to reset.");
391 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
392 g_usleep(300 * 1000);
394 while (timediff_ms < MAX_RENUM_DELAY_MS) {
395 if ((ret = fx2lafw_dev_open(sdi, di)) == SR_OK)
397 g_usleep(100 * 1000);
399 timediff_us = g_get_monotonic_time() - devc->fw_updated;
400 timediff_ms = timediff_us / 1000;
401 sr_spew("Waited %" PRIi64 "ms.", timediff_ms);
404 sr_err("Device failed to renumerate.");
407 sr_info("Device came back after %" PRIi64 "ms.", timediff_ms);
409 sr_info("Firmware upload was not needed.");
410 ret = fx2lafw_dev_open(sdi, di);
414 sr_err("Unable to open device.");
418 ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
421 case LIBUSB_ERROR_BUSY:
422 sr_err("Unable to claim USB interface. Another "
423 "program or driver has already claimed it.");
425 case LIBUSB_ERROR_NO_DEVICE:
426 sr_err("Device has been disconnected.");
429 sr_err("Unable to claim interface: %s.",
430 libusb_error_name(ret));
438 if (!strcmp(devc->profile->model, "DSLogic")) {
439 fpga_firmware = DSLOGIC_FPGA_FIRMWARE;
440 } else if (!strcmp(devc->profile->model, "DSLogic Pro")) {
441 fpga_firmware = DSLOGIC_PRO_FPGA_FIRMWARE;
442 } else if (!strcmp(devc->profile->model, "DSCope")) {
443 fpga_firmware = DSCOPE_FPGA_FIRMWARE;
446 if ((ret = dslogic_fpga_firmware_upload(sdi,
447 fpga_firmware)) != SR_OK)
451 if (devc->cur_samplerate == 0) {
452 /* Samplerate hasn't been set; default to the slowest one. */
453 devc->cur_samplerate = devc->samplerates[0];
459 static int dev_close(struct sr_dev_inst *sdi)
461 struct sr_usb_dev_inst *usb;
467 sr_info("fx2lafw: Closing device on %d.%d (logical) / %s (physical) interface %d.",
468 usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
469 libusb_release_interface(usb->devhdl, USB_INTERFACE);
470 libusb_close(usb->devhdl);
472 sdi->status = SR_ST_INACTIVE;
477 static int cleanup(const struct sr_dev_driver *di)
480 struct drv_context *drvc;
482 if (!(drvc = di->context))
485 ret = std_dev_clear(di, NULL);
492 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
493 const struct sr_channel_group *cg)
495 struct dev_context *devc;
496 struct sr_usb_dev_inst *usb;
511 if (usb->address == 255)
512 /* Device still needs to re-enumerate after firmware
513 * upload, so we don't know its (future) address. */
515 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
516 *data = g_variant_new_string(str);
518 case SR_CONF_LIMIT_SAMPLES:
519 *data = g_variant_new_uint64(devc->limit_samples);
521 case SR_CONF_SAMPLERATE:
522 *data = g_variant_new_uint64(devc->cur_samplerate);
524 case SR_CONF_CAPTURE_RATIO:
525 *data = g_variant_new_uint64(devc->capture_ratio);
534 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
535 const struct sr_channel_group *cg)
537 struct dev_context *devc;
546 if (sdi->status != SR_ST_ACTIVE)
554 case SR_CONF_SAMPLERATE:
555 arg = g_variant_get_uint64(data);
556 for (i = 0; i < devc->num_samplerates; i++) {
557 if (devc->samplerates[i] == arg) {
558 devc->cur_samplerate = arg;
562 if (i == devc->num_samplerates)
565 case SR_CONF_LIMIT_SAMPLES:
566 devc->limit_samples = g_variant_get_uint64(data);
568 case SR_CONF_CAPTURE_RATIO:
569 devc->capture_ratio = g_variant_get_uint64(data);
570 if (devc->capture_ratio > 100) {
571 devc->capture_ratio = 0;
583 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
584 const struct sr_channel_group *cg)
586 struct dev_context *devc;
593 case SR_CONF_SCAN_OPTIONS:
594 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
595 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
597 case SR_CONF_DEVICE_OPTIONS:
599 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
600 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
602 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
603 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
605 case SR_CONF_SAMPLERATE:
609 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
610 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), devc->samplerates,
611 devc->num_samplerates, sizeof(uint64_t));
612 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
613 *data = g_variant_builder_end(&gvb);
615 case SR_CONF_TRIGGER_MATCH:
616 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
617 soft_trigger_matches, ARRAY_SIZE(soft_trigger_matches),
627 static int receive_data(int fd, int revents, void *cb_data)
630 struct drv_context *drvc;
635 drvc = (struct drv_context *)cb_data;
637 tv.tv_sec = tv.tv_usec = 0;
638 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
643 static int start_transfers(const struct sr_dev_inst *sdi)
645 struct dev_context *devc;
646 struct sr_usb_dev_inst *usb;
647 struct sr_trigger *trigger;
648 struct libusb_transfer *transfer;
649 unsigned int i, num_transfers;
650 int endpoint, timeout, ret;
657 devc->sent_samples = 0;
658 devc->acq_aborted = FALSE;
659 devc->empty_transfer_count = 0;
661 if ((trigger = sr_session_trigger_get(sdi->session))) {
662 int pre_trigger_samples = 0;
663 if (devc->limit_samples > 0)
664 pre_trigger_samples = devc->capture_ratio * devc->limit_samples/100;
665 devc->stl = soft_trigger_logic_new(sdi, trigger, pre_trigger_samples);
667 return SR_ERR_MALLOC;
668 devc->trigger_fired = FALSE;
670 devc->trigger_fired = TRUE;
672 num_transfers = fx2lafw_get_number_of_transfers(devc);
673 size = fx2lafw_get_buffer_size(devc);
674 devc->submitted_transfers = 0;
676 devc->transfers = g_try_malloc0(sizeof(*devc->transfers) * num_transfers);
677 if (!devc->transfers) {
678 sr_err("USB transfers malloc failed.");
679 return SR_ERR_MALLOC;
682 timeout = fx2lafw_get_timeout(devc);
683 endpoint = devc->dslogic ? 6 : 2;
684 devc->num_transfers = num_transfers;
685 for (i = 0; i < num_transfers; i++) {
686 if (!(buf = g_try_malloc(size))) {
687 sr_err("USB transfer buffer malloc failed.");
688 return SR_ERR_MALLOC;
690 transfer = libusb_alloc_transfer(0);
691 libusb_fill_bulk_transfer(transfer, usb->devhdl,
692 endpoint | LIBUSB_ENDPOINT_IN, buf, size,
693 fx2lafw_receive_transfer, (void *)sdi, timeout);
694 if ((ret = libusb_submit_transfer(transfer)) != 0) {
695 sr_err("Failed to submit transfer: %s.",
696 libusb_error_name(ret));
697 libusb_free_transfer(transfer);
699 fx2lafw_abort_acquisition(devc);
702 devc->transfers[i] = transfer;
703 devc->submitted_transfers++;
706 /* Send header packet to the session bus. */
707 std_session_send_df_header(sdi, LOG_PREFIX);
712 static void LIBUSB_CALL dslogic_trigger_receive(struct libusb_transfer *transfer)
714 const struct sr_dev_inst *sdi;
715 struct dslogic_trigger_pos *tpos;
717 sdi = transfer->user_data;
719 if (transfer->status == LIBUSB_TRANSFER_COMPLETED
720 && transfer->actual_length == sizeof(struct dslogic_trigger_pos)) {
721 tpos = (struct dslogic_trigger_pos *)transfer->buffer;
722 sr_dbg("tpos real_pos %.8x ram_saddr %.8x", tpos->real_pos, tpos->ram_saddr);
724 start_transfers(sdi);
727 libusb_free_transfer(transfer);
731 static int dslogic_trigger_request(const struct sr_dev_inst *sdi)
733 struct sr_usb_dev_inst *usb;
734 struct libusb_transfer *transfer;
735 struct dslogic_trigger_pos *tpos;
740 if ((ret = dslogic_stop_acquisition(sdi)) != SR_OK)
743 if ((ret = dslogic_fpga_configure(sdi)) != SR_OK)
746 if ((ret = dslogic_start_acquisition(sdi)) != SR_OK)
749 sr_dbg("Getting trigger.");
750 tpos = g_malloc(sizeof(struct dslogic_trigger_pos));
751 transfer = libusb_alloc_transfer(0);
752 libusb_fill_bulk_transfer(transfer, usb->devhdl, 6 | LIBUSB_ENDPOINT_IN,
753 (unsigned char *)tpos, sizeof(struct dslogic_trigger_pos),
754 dslogic_trigger_receive, (void *)sdi, 0);
755 if ((ret = libusb_submit_transfer(transfer)) < 0) {
756 sr_err("Failed to request trigger: %s.", libusb_error_name(ret));
757 libusb_free_transfer(transfer);
765 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
767 struct sr_dev_driver *di;
768 struct drv_context *drvc;
769 struct dev_context *devc;
772 if (sdi->status != SR_ST_ACTIVE)
773 return SR_ERR_DEV_CLOSED;
779 devc->ctx = drvc->sr_ctx;
780 devc->cb_data = cb_data;
781 devc->sent_samples = 0;
782 devc->empty_transfer_count = 0;
783 devc->acq_aborted = FALSE;
785 timeout = fx2lafw_get_timeout(devc);
786 usb_source_add(sdi->session, devc->ctx, timeout, receive_data, drvc);
789 dslogic_trigger_request(sdi);
791 start_transfers(sdi);
792 if ((ret = fx2lafw_command_start_acquisition(sdi)) != SR_OK) {
793 fx2lafw_abort_acquisition(devc);
801 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
805 fx2lafw_abort_acquisition(sdi->priv);
810 SR_PRIV struct sr_dev_driver fx2lafw_driver_info = {
812 .longname = "fx2lafw (generic driver for FX2 based LAs)",
817 .dev_list = dev_list,
819 .config_get = config_get,
820 .config_set = config_set,
821 .config_list = config_list,
822 .dev_open = dev_open,
823 .dev_close = dev_close,
824 .dev_acquisition_start = dev_acquisition_start,
825 .dev_acquisition_stop = dev_acquisition_stop,