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 FIRMWARE_DIR "/fx2lafw-cwav-usbeeax.fw",
38 { 0x08a9, 0x0015, "CWAV", "USBee DX", NULL,
39 FIRMWARE_DIR "/fx2lafw-cwav-usbeedx.fw",
40 DEV_CAPS_16BIT, NULL, NULL },
45 { 0x08a9, 0x0009, "CWAV", "USBee SX", NULL,
46 FIRMWARE_DIR "/fx2lafw-cwav-usbeesx.fw",
49 /* DreamSourceLab DSLogic (before FW upload) */
50 { 0x2a0e, 0x0001, "DreamSourceLab", "DSLogic", NULL,
51 FIRMWARE_DIR "/dreamsourcelab-dslogic-fx2.fw",
52 DEV_CAPS_16BIT, NULL, NULL},
53 /* DreamSourceLab DSLogic (after FW upload) */
54 { 0x2a0e, 0x0001, "DreamSourceLab", "DSLogic", NULL,
55 FIRMWARE_DIR "/dreamsourcelab-dslogic-fx2.fw",
56 DEV_CAPS_16BIT, "DreamSourceLab", "DSLogic"},
58 /* DreamSourceLab DSCope (before FW upload) */
59 { 0x2a0e, 0x0002, "DreamSourceLab", "DSCope", NULL,
60 FIRMWARE_DIR "/dreamsourcelab-dscope-fx2.fw",
61 DEV_CAPS_16BIT, NULL, NULL},
62 /* DreamSourceLab DSCope (after FW upload) */
63 { 0x2a0e, 0x0002, "DreamSourceLab", "DSCope", NULL,
64 FIRMWARE_DIR "/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 FIRMWARE_DIR "/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 FIRMWARE_DIR "/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 FIRMWARE_DIR "/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 FIRMWARE_DIR "/fx2lafw-cypress-fx2.fw",
93 DEV_CAPS_16BIT, NULL, NULL },
96 * Braintechnology USB-LPS
98 { 0x16d0, 0x0498, "Braintechnology", "USB-LPS", NULL,
99 FIRMWARE_DIR "/fx2lafw-braintechnology-usb-lps.fw",
100 DEV_CAPS_16BIT, NULL, NULL },
102 { 0, 0, 0, 0, 0, 0, 0, 0, 0 }
105 static const uint32_t drvopts[] = {
106 SR_CONF_LOGIC_ANALYZER,
109 static const uint32_t scanopts[] = {
113 static const uint32_t devopts[] = {
114 SR_CONF_CONTINUOUS | SR_CONF_SET,
115 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
116 SR_CONF_CONN | SR_CONF_GET,
117 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
118 SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
119 SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
122 static const char *channel_names[] = {
123 "0", "1", "2", "3", "4", "5", "6", "7",
124 "8", "9", "10", "11", "12", "13", "14", "15",
127 static const int32_t soft_trigger_matches[] = {
135 static const uint64_t samplerates[] = {
154 static const uint64_t dslogic_samplerates[] = {
173 SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
175 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
177 return std_init(sr_ctx, di, LOG_PREFIX);
180 static GSList *scan(struct sr_dev_driver *di, GSList *options)
182 struct drv_context *drvc;
183 struct dev_context *devc;
184 struct sr_dev_inst *sdi;
185 struct sr_usb_dev_inst *usb;
186 struct sr_config *src;
187 const struct fx2lafw_profile *prof;
188 GSList *l, *devices, *conn_devices;
189 gboolean has_firmware;
190 struct libusb_device_descriptor des;
191 libusb_device **devlist;
192 struct libusb_device_handle *hdl;
193 int num_logic_channels, ret, i, j;
195 char manufacturer[64], product[64], serial_num[64], connection_id[64];
200 for (l = options; l; l = l->next) {
204 conn = g_variant_get_string(src->data, NULL);
209 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
213 /* Find all fx2lafw compatible devices and upload firmware to them. */
215 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
216 for (i = 0; devlist[i]; i++) {
219 for (l = conn_devices; l; l = l->next) {
221 if (usb->bus == libusb_get_bus_number(devlist[i])
222 && usb->address == libusb_get_device_address(devlist[i]))
226 /* This device matched none of the ones that
227 * matched the conn specification. */
231 if ((ret = libusb_get_device_descriptor( devlist[i], &des)) != 0) {
232 sr_warn("Failed to get device descriptor: %s.",
233 libusb_error_name(ret));
237 if ((ret = libusb_open(devlist[i], &hdl)) < 0)
240 if (des.iManufacturer == 0) {
241 manufacturer[0] = '\0';
242 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
243 des.iManufacturer, (unsigned char *) manufacturer,
244 sizeof(manufacturer))) < 0) {
245 sr_warn("Failed to get manufacturer string descriptor: %s.",
246 libusb_error_name(ret));
250 if (des.iProduct == 0) {
252 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
253 des.iProduct, (unsigned char *) product,
254 sizeof(product))) < 0) {
255 sr_warn("Failed to get product string descriptor: %s.",
256 libusb_error_name(ret));
260 if (des.iSerialNumber == 0) {
261 serial_num[0] = '\0';
262 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
263 des.iSerialNumber, (unsigned char *) serial_num,
264 sizeof(serial_num))) < 0) {
265 sr_warn("Failed to get serial number string descriptor: %s.",
266 libusb_error_name(ret));
270 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
275 for (j = 0; supported_fx2[j].vid; j++) {
276 if (des.idVendor == supported_fx2[j].vid &&
277 des.idProduct == supported_fx2[j].pid &&
278 (!supported_fx2[j].usb_manufacturer ||
279 !strcmp(manufacturer, supported_fx2[j].usb_manufacturer)) &&
280 (!supported_fx2[j].usb_manufacturer ||
281 !strcmp(product, supported_fx2[j].usb_product))) {
282 prof = &supported_fx2[j];
287 /* Skip if the device was not found. */
291 sdi = g_malloc0(sizeof(struct sr_dev_inst));
292 sdi->status = SR_ST_INITIALIZING;
293 sdi->vendor = g_strdup(prof->vendor);
294 sdi->model = g_strdup(prof->model);
295 sdi->version = g_strdup(prof->model_version);
297 sdi->serial_num = g_strdup(serial_num);
298 sdi->connection_id = g_strdup(connection_id);
300 /* Fill in channellist according to this device's profile. */
301 num_logic_channels = prof->dev_caps & DEV_CAPS_16BIT ? 16 : 8;
302 for (j = 0; j < num_logic_channels; j++)
303 sr_channel_new(sdi, j, SR_CHANNEL_LOGIC, TRUE,
306 devc = fx2lafw_dev_new();
307 devc->profile = prof;
308 devc->sample_wide = (prof->dev_caps & DEV_CAPS_16BIT) != 0;
310 drvc->instances = g_slist_append(drvc->instances, sdi);
311 devices = g_slist_append(devices, sdi);
313 if (!strcmp(prof->model, "DSLogic")
314 || !strcmp(prof->model, "DSLogic Pro")
315 || !strcmp(prof->model, "DSCope")) {
316 devc->dslogic = TRUE;
317 devc->samplerates = dslogic_samplerates;
318 devc->num_samplerates = ARRAY_SIZE(dslogic_samplerates);
319 has_firmware = match_manuf_prod(devlist[i], "DreamSourceLab", "DSLogic")
320 || match_manuf_prod(devlist[i], "DreamSourceLab", "DSCope");
322 devc->dslogic = FALSE;
323 devc->samplerates = samplerates;
324 devc->num_samplerates = ARRAY_SIZE(samplerates);
325 has_firmware = match_manuf_prod(devlist[i],
326 "sigrok", "fx2lafw");
330 /* Already has the firmware, so fix the new address. */
331 sr_dbg("Found an fx2lafw device.");
332 sdi->status = SR_ST_INACTIVE;
333 sdi->inst_type = SR_INST_USB;
334 sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
335 libusb_get_device_address(devlist[i]), NULL);
337 if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
338 prof->firmware) == SR_OK)
339 /* Store when this device's FW was updated. */
340 devc->fw_updated = g_get_monotonic_time();
342 sr_err("Firmware upload failed for "
343 "device %d.%d (logical).",
344 libusb_get_bus_number(devlist[i]),
345 libusb_get_device_address(devlist[i]));
346 sdi->inst_type = SR_INST_USB;
347 sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
351 libusb_free_device_list(devlist, 1);
352 g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
357 static GSList *dev_list(const struct sr_dev_driver *di)
359 return ((struct drv_context *)(di->context))->instances;
362 static int dev_open(struct sr_dev_inst *sdi)
364 struct sr_dev_driver *di = sdi->driver;
365 struct sr_usb_dev_inst *usb;
366 struct dev_context *devc;
367 char *fpga_firmware = NULL;
369 int64_t timediff_us, timediff_ms;
375 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
376 * milliseconds for the FX2 to renumerate.
379 if (devc->fw_updated > 0) {
380 sr_info("Waiting for device to reset.");
381 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
382 g_usleep(300 * 1000);
384 while (timediff_ms < MAX_RENUM_DELAY_MS) {
385 if ((ret = fx2lafw_dev_open(sdi, di)) == SR_OK)
387 g_usleep(100 * 1000);
389 timediff_us = g_get_monotonic_time() - devc->fw_updated;
390 timediff_ms = timediff_us / 1000;
391 sr_spew("Waited %" PRIi64 "ms.", timediff_ms);
394 sr_err("Device failed to renumerate.");
397 sr_info("Device came back after %" PRIi64 "ms.", timediff_ms);
399 sr_info("Firmware upload was not needed.");
400 ret = fx2lafw_dev_open(sdi, di);
404 sr_err("Unable to open device.");
408 ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
411 case LIBUSB_ERROR_BUSY:
412 sr_err("Unable to claim USB interface. Another "
413 "program or driver has already claimed it.");
415 case LIBUSB_ERROR_NO_DEVICE:
416 sr_err("Device has been disconnected.");
419 sr_err("Unable to claim interface: %s.",
420 libusb_error_name(ret));
428 if (!strcmp(devc->profile->model, "DSLogic")) {
429 fpga_firmware = DSLOGIC_FPGA_FIRMWARE;
430 } else if (!strcmp(devc->profile->model, "DSLogic Pro")) {
431 fpga_firmware = DSLOGIC_PRO_FPGA_FIRMWARE;
432 } else if (!strcmp(devc->profile->model, "DSCope")) {
433 fpga_firmware = DSCOPE_FPGA_FIRMWARE;
436 if ((ret = dslogic_fpga_firmware_upload(sdi,
437 fpga_firmware)) != SR_OK)
441 if (devc->cur_samplerate == 0) {
442 /* Samplerate hasn't been set; default to the slowest one. */
443 devc->cur_samplerate = devc->samplerates[0];
449 static int dev_close(struct sr_dev_inst *sdi)
451 struct sr_usb_dev_inst *usb;
457 sr_info("fx2lafw: Closing device on %d.%d (logical) / %s (physical) interface %d.",
458 usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
459 libusb_release_interface(usb->devhdl, USB_INTERFACE);
460 libusb_close(usb->devhdl);
462 sdi->status = SR_ST_INACTIVE;
467 static int cleanup(const struct sr_dev_driver *di)
470 struct drv_context *drvc;
472 if (!(drvc = di->context))
475 ret = std_dev_clear(di, NULL);
482 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
483 const struct sr_channel_group *cg)
485 struct dev_context *devc;
486 struct sr_usb_dev_inst *usb;
501 if (usb->address == 255)
502 /* Device still needs to re-enumerate after firmware
503 * upload, so we don't know its (future) address. */
505 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
506 *data = g_variant_new_string(str);
508 case SR_CONF_LIMIT_SAMPLES:
509 *data = g_variant_new_uint64(devc->limit_samples);
511 case SR_CONF_SAMPLERATE:
512 *data = g_variant_new_uint64(devc->cur_samplerate);
514 case SR_CONF_CAPTURE_RATIO:
515 *data = g_variant_new_uint64(devc->capture_ratio);
524 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
525 const struct sr_channel_group *cg)
527 struct dev_context *devc;
536 if (sdi->status != SR_ST_ACTIVE)
544 case SR_CONF_SAMPLERATE:
545 arg = g_variant_get_uint64(data);
546 for (i = 0; i < devc->num_samplerates; i++) {
547 if (devc->samplerates[i] == arg) {
548 devc->cur_samplerate = arg;
552 if (i == devc->num_samplerates)
555 case SR_CONF_LIMIT_SAMPLES:
556 devc->limit_samples = g_variant_get_uint64(data);
558 case SR_CONF_CAPTURE_RATIO:
559 devc->capture_ratio = g_variant_get_uint64(data);
560 if (devc->capture_ratio > 100) {
561 devc->capture_ratio = 0;
573 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
574 const struct sr_channel_group *cg)
576 struct dev_context *devc;
583 case SR_CONF_SCAN_OPTIONS:
584 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
585 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
587 case SR_CONF_DEVICE_OPTIONS:
589 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
590 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
592 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
593 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
595 case SR_CONF_SAMPLERATE:
599 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
600 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), devc->samplerates,
601 devc->num_samplerates, sizeof(uint64_t));
602 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
603 *data = g_variant_builder_end(&gvb);
605 case SR_CONF_TRIGGER_MATCH:
606 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
607 soft_trigger_matches, ARRAY_SIZE(soft_trigger_matches),
617 static int receive_data(int fd, int revents, void *cb_data)
620 struct drv_context *drvc;
625 drvc = (struct drv_context *)cb_data;
627 tv.tv_sec = tv.tv_usec = 0;
628 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
633 static int start_transfers(const struct sr_dev_inst *sdi)
635 struct dev_context *devc;
636 struct sr_usb_dev_inst *usb;
637 struct sr_trigger *trigger;
638 struct libusb_transfer *transfer;
639 unsigned int i, num_transfers;
640 int endpoint, timeout, ret;
647 devc->sent_samples = 0;
648 devc->acq_aborted = FALSE;
649 devc->empty_transfer_count = 0;
651 if ((trigger = sr_session_trigger_get(sdi->session))) {
652 int pre_trigger_samples = 0;
653 if (devc->limit_samples > 0)
654 pre_trigger_samples = devc->capture_ratio * devc->limit_samples/100;
655 devc->stl = soft_trigger_logic_new(sdi, trigger, pre_trigger_samples);
657 return SR_ERR_MALLOC;
658 devc->trigger_fired = FALSE;
660 devc->trigger_fired = TRUE;
662 timeout = fx2lafw_get_timeout(devc);
664 num_transfers = fx2lafw_get_number_of_transfers(devc);
665 size = fx2lafw_get_buffer_size(devc);
666 devc->submitted_transfers = 0;
668 devc->transfers = g_try_malloc0(sizeof(*devc->transfers) * num_transfers);
669 if (!devc->transfers) {
670 sr_err("USB transfers malloc failed.");
671 return SR_ERR_MALLOC;
674 timeout = fx2lafw_get_timeout(devc);
675 endpoint = devc->dslogic ? 6 : 2;
676 devc->num_transfers = num_transfers;
677 for (i = 0; i < num_transfers; i++) {
678 if (!(buf = g_try_malloc(size))) {
679 sr_err("USB transfer buffer malloc failed.");
680 return SR_ERR_MALLOC;
682 transfer = libusb_alloc_transfer(0);
683 libusb_fill_bulk_transfer(transfer, usb->devhdl,
684 endpoint | LIBUSB_ENDPOINT_IN, buf, size,
685 fx2lafw_receive_transfer, (void *)sdi, timeout);
686 if ((ret = libusb_submit_transfer(transfer)) != 0) {
687 sr_err("Failed to submit transfer: %s.",
688 libusb_error_name(ret));
689 libusb_free_transfer(transfer);
691 fx2lafw_abort_acquisition(devc);
694 devc->transfers[i] = transfer;
695 devc->submitted_transfers++;
698 /* Send header packet to the session bus. */
699 std_session_send_df_header(sdi, LOG_PREFIX);
704 static void LIBUSB_CALL dslogic_trigger_receive(struct libusb_transfer *transfer)
706 const struct sr_dev_inst *sdi;
707 struct dslogic_trigger_pos *tpos;
709 sdi = transfer->user_data;
711 if (transfer->status == LIBUSB_TRANSFER_COMPLETED
712 && transfer->actual_length == sizeof(struct dslogic_trigger_pos)) {
713 tpos = (struct dslogic_trigger_pos *)transfer->buffer;
714 sr_dbg("tpos real_pos %.8x ram_saddr %.8x", tpos->real_pos, tpos->ram_saddr);
716 start_transfers(sdi);
719 libusb_free_transfer(transfer);
723 static int dslogic_trigger_request(const struct sr_dev_inst *sdi)
725 struct sr_usb_dev_inst *usb;
726 struct libusb_transfer *transfer;
727 struct dslogic_trigger_pos *tpos;
732 if ((ret = dslogic_stop_acquisition(sdi)) != SR_OK)
735 if ((ret = dslogic_fpga_configure(sdi)) != SR_OK)
738 if ((ret = dslogic_start_acquisition(sdi)) != SR_OK)
741 sr_dbg("Getting trigger.");
742 tpos = g_malloc(sizeof(struct dslogic_trigger_pos));
743 transfer = libusb_alloc_transfer(0);
744 libusb_fill_bulk_transfer(transfer, usb->devhdl, 6 | LIBUSB_ENDPOINT_IN,
745 (unsigned char *)tpos, sizeof(struct dslogic_trigger_pos),
746 dslogic_trigger_receive, (void *)sdi, 0);
747 if ((ret = libusb_submit_transfer(transfer)) < 0) {
748 sr_err("Failed to request trigger: %s.", libusb_error_name(ret));
749 libusb_free_transfer(transfer);
757 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
759 struct sr_dev_driver *di;
760 struct drv_context *drvc;
761 struct dev_context *devc;
764 if (sdi->status != SR_ST_ACTIVE)
765 return SR_ERR_DEV_CLOSED;
771 devc->ctx = drvc->sr_ctx;
772 devc->cb_data = cb_data;
773 devc->sent_samples = 0;
774 devc->empty_transfer_count = 0;
775 devc->acq_aborted = FALSE;
777 timeout = fx2lafw_get_timeout(devc);
778 usb_source_add(sdi->session, devc->ctx, timeout, receive_data, drvc);
781 dslogic_trigger_request(sdi);
783 start_transfers(sdi);
784 if ((ret = fx2lafw_command_start_acquisition(sdi)) != SR_OK) {
785 fx2lafw_abort_acquisition(devc);
793 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
797 fx2lafw_abort_acquisition(sdi->priv);
802 SR_PRIV struct sr_dev_driver fx2lafw_driver_info = {
804 .longname = "fx2lafw (generic driver for FX2 based LAs)",
809 .dev_list = dev_list,
811 .config_get = config_get,
812 .config_set = config_set,
813 .config_list = config_list,
814 .dev_open = dev_open,
815 .dev_close = dev_close,
816 .dev_acquisition_start = dev_acquisition_start,
817 .dev_acquisition_stop = dev_acquisition_stop,