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/>.
24 static const struct fx2lafw_profile supported_fx2[] = {
27 * EE Electronics ESLA201A
30 { 0x08a9, 0x0014, "CWAV", "USBee AX", NULL,
31 FIRMWARE_DIR "/fx2lafw-cwav-usbeeax.fw",
37 { 0x08a9, 0x0015, "CWAV", "USBee DX", NULL,
38 FIRMWARE_DIR "/fx2lafw-cwav-usbeedx.fw",
39 DEV_CAPS_16BIT, NULL, NULL },
44 { 0x08a9, 0x0009, "CWAV", "USBee SX", NULL,
45 FIRMWARE_DIR "/fx2lafw-cwav-usbeesx.fw",
49 * DreamSourceLab DSLogic (before FW upload)
51 { 0x2a0e, 0x0001, "DreamSourceLab", "DSLogic", NULL,
52 FIRMWARE_DIR "/dreamsourcelab-dslogic-fx2.fw",
53 DEV_CAPS_16BIT, NULL, NULL},
56 * DreamSourceLab DSLogic (after FW upload)
58 { 0x2a0e, 0x0001, "DreamSourceLab", "DSLogic", NULL,
59 FIRMWARE_DIR "/dreamsourcelab-dslogic-fx2.fw",
60 DEV_CAPS_16BIT, "DreamSourceLab", "DSLogic"},
64 * EE Electronics ESLA100
66 * Robomotic BugLogic 3
68 { 0x0925, 0x3881, "Saleae", "Logic", NULL,
69 FIRMWARE_DIR "/fx2lafw-saleae-logic.fw",
73 * Default Cypress FX2 without EEPROM, e.g.:
75 * Braintechnology USB Interface V2.x
77 { 0x04B4, 0x8613, "Cypress", "FX2", NULL,
78 FIRMWARE_DIR "/fx2lafw-cypress-fx2.fw",
79 DEV_CAPS_16BIT, NULL, NULL },
82 * Braintechnology USB-LPS
84 { 0x16d0, 0x0498, "Braintechnology", "USB-LPS", NULL,
85 FIRMWARE_DIR "/fx2lafw-braintechnology-usb-lps.fw",
86 DEV_CAPS_16BIT, NULL, NULL },
88 { 0, 0, 0, 0, 0, 0, 0, 0, 0 }
91 static const uint32_t drvopts[] = {
92 SR_CONF_LOGIC_ANALYZER,
95 static const uint32_t scanopts[] = {
99 static const uint32_t devopts[] = {
100 SR_CONF_CONTINUOUS | SR_CONF_SET,
101 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
102 SR_CONF_CONN | SR_CONF_GET,
103 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
104 SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
105 SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
108 static const char *channel_names[] = {
109 "0", "1", "2", "3", "4", "5", "6", "7",
110 "8", "9", "10", "11", "12", "13", "14", "15",
114 static const int32_t soft_trigger_matches[] = {
122 static const uint64_t samplerates[] = {
141 static const uint64_t dslogic_samplerates[] = {
160 SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
161 static struct sr_dev_driver *di = &fx2lafw_driver_info;
163 static int init(struct sr_context *sr_ctx)
165 return std_init(sr_ctx, di, LOG_PREFIX);
168 static GSList *scan(GSList *options)
170 struct drv_context *drvc;
171 struct dev_context *devc;
172 struct sr_dev_inst *sdi;
173 struct sr_usb_dev_inst *usb;
174 struct sr_channel *ch;
175 struct sr_config *src;
176 const struct fx2lafw_profile *prof;
177 GSList *l, *devices, *conn_devices;
178 gboolean has_firmware;
179 struct libusb_device_descriptor des;
180 libusb_device **devlist;
181 struct libusb_device_handle *hdl;
182 int num_logic_channels, ret, i, j;
184 char manufacturer[64], product[64], serial_num[64], connection_id[64];
189 for (l = options; l; l = l->next) {
193 conn = g_variant_get_string(src->data, NULL);
198 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
202 /* Find all fx2lafw compatible devices and upload firmware to them. */
204 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
205 for (i = 0; devlist[i]; i++) {
208 for (l = conn_devices; l; l = l->next) {
210 if (usb->bus == libusb_get_bus_number(devlist[i])
211 && usb->address == libusb_get_device_address(devlist[i]))
215 /* This device matched none of the ones that
216 * matched the conn specification. */
220 if ((ret = libusb_get_device_descriptor( devlist[i], &des)) != 0) {
221 sr_warn("Failed to get device descriptor: %s.",
222 libusb_error_name(ret));
226 if ((ret = libusb_open(devlist[i], &hdl)) < 0)
229 if (des.iManufacturer == 0) {
230 manufacturer[0] = '\0';
231 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
232 des.iManufacturer, (unsigned char *) manufacturer,
233 sizeof(manufacturer))) < 0) {
234 sr_warn("Failed to get manufacturer string descriptor: %s.",
235 libusb_error_name(ret));
239 if (des.iProduct == 0) {
241 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
242 des.iProduct, (unsigned char *) product,
243 sizeof(product))) < 0) {
244 sr_warn("Failed to get product string descriptor: %s.",
245 libusb_error_name(ret));
249 if (des.iSerialNumber == 0) {
250 serial_num[0] = '\0';
251 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
252 des.iSerialNumber, (unsigned char *) serial_num,
253 sizeof(serial_num))) < 0) {
254 sr_warn("Failed to get serial number string descriptor: %s.",
255 libusb_error_name(ret));
259 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
264 for (j = 0; supported_fx2[j].vid; j++) {
265 if (des.idVendor == supported_fx2[j].vid &&
266 des.idProduct == supported_fx2[j].pid &&
267 (!supported_fx2[j].usb_manufacturer ||
268 !strcmp(manufacturer, supported_fx2[j].usb_manufacturer)) &&
269 (!supported_fx2[j].usb_manufacturer ||
270 !strcmp(product, supported_fx2[j].usb_product))) {
271 prof = &supported_fx2[j];
276 /* Skip if the device was not found. */
280 sdi = g_malloc0(sizeof(struct sr_dev_inst));
281 sdi->status = SR_ST_INITIALIZING;
282 sdi->vendor = g_strdup(prof->vendor);
283 sdi->model = g_strdup(prof->model);
284 sdi->version = g_strdup(prof->model_version);
286 sdi->serial_num = g_strdup(serial_num);
287 sdi->connection_id = g_strdup(connection_id);
289 /* Fill in channellist according to this device's profile. */
290 num_logic_channels = prof->dev_caps & DEV_CAPS_16BIT ? 16 : 8;
291 for (j = 0; j < num_logic_channels; j++) {
292 ch = sr_channel_new(j, SR_CHANNEL_LOGIC, TRUE,
294 sdi->channels = g_slist_append(sdi->channels, ch);
297 devc = fx2lafw_dev_new();
298 devc->profile = prof;
299 devc->sample_wide = (prof->dev_caps & DEV_CAPS_16BIT) != 0;
301 drvc->instances = g_slist_append(drvc->instances, sdi);
302 devices = g_slist_append(devices, sdi);
304 if (strcmp(prof->model, "DSLogic")) {
305 devc->dslogic = FALSE;
306 devc->samplerates = samplerates;
307 devc->num_samplerates = ARRAY_SIZE(samplerates);
308 has_firmware = match_manuf_prod(devlist[i],
309 "sigrok", "fx2lafw");
311 devc->dslogic = TRUE;
312 devc->samplerates = dslogic_samplerates;
313 devc->num_samplerates = ARRAY_SIZE(dslogic_samplerates);
314 has_firmware = match_manuf_prod(devlist[i],
315 "DreamSourceLab", "DSLogic");
319 /* Already has the firmware, so fix the new address. */
320 sr_dbg("Found an fx2lafw device.");
321 sdi->status = SR_ST_INACTIVE;
322 sdi->inst_type = SR_INST_USB;
323 sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
324 libusb_get_device_address(devlist[i]), NULL);
326 if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
327 prof->firmware) == SR_OK)
328 /* Store when this device's FW was updated. */
329 devc->fw_updated = g_get_monotonic_time();
331 sr_err("Firmware upload failed for "
332 "device %d.%d (logical).",
333 libusb_get_bus_number(devlist[i]),
334 libusb_get_device_address(devlist[i]));
335 sdi->inst_type = SR_INST_USB;
336 sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
340 libusb_free_device_list(devlist, 1);
341 g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
346 static GSList *dev_list(void)
348 return ((struct drv_context *)(di->priv))->instances;
351 static int dev_open(struct sr_dev_inst *sdi)
353 struct sr_usb_dev_inst *usb;
354 struct dev_context *devc;
356 int64_t timediff_us, timediff_ms;
362 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
363 * milliseconds for the FX2 to renumerate.
366 if (devc->fw_updated > 0) {
367 sr_info("Waiting for device to reset.");
368 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
369 g_usleep(300 * 1000);
371 while (timediff_ms < MAX_RENUM_DELAY_MS) {
372 if ((ret = fx2lafw_dev_open(sdi, di)) == SR_OK)
374 g_usleep(100 * 1000);
376 timediff_us = g_get_monotonic_time() - devc->fw_updated;
377 timediff_ms = timediff_us / 1000;
378 sr_spew("Waited %" PRIi64 "ms.", timediff_ms);
381 sr_err("Device failed to renumerate.");
384 sr_info("Device came back after %" PRIi64 "ms.", timediff_ms);
386 sr_info("Firmware upload was not needed.");
387 ret = fx2lafw_dev_open(sdi, di);
391 sr_err("Unable to open device.");
395 ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
398 case LIBUSB_ERROR_BUSY:
399 sr_err("Unable to claim USB interface. Another "
400 "program or driver has already claimed it.");
402 case LIBUSB_ERROR_NO_DEVICE:
403 sr_err("Device has been disconnected.");
406 sr_err("Unable to claim interface: %s.",
407 libusb_error_name(ret));
415 if ((ret = dslogic_fpga_firmware_upload(sdi,
416 DSLOGIC_FPGA_FIRMWARE)) != SR_OK)
420 if (devc->cur_samplerate == 0) {
421 /* Samplerate hasn't been set; default to the slowest one. */
422 devc->cur_samplerate = devc->samplerates[0];
428 static int dev_close(struct sr_dev_inst *sdi)
430 struct sr_usb_dev_inst *usb;
433 if (usb->devhdl == NULL)
436 sr_info("fx2lafw: Closing device on %d.%d (logical) / %s (physical) interface %d.",
437 usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
438 libusb_release_interface(usb->devhdl, USB_INTERFACE);
439 libusb_close(usb->devhdl);
441 sdi->status = SR_ST_INACTIVE;
446 static int cleanup(void)
449 struct drv_context *drvc;
451 if (!(drvc = di->priv))
454 ret = std_dev_clear(di, NULL);
462 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
463 const struct sr_channel_group *cg)
465 struct dev_context *devc;
466 struct sr_usb_dev_inst *usb;
481 if (usb->address == 255)
482 /* Device still needs to re-enumerate after firmware
483 * upload, so we don't know its (future) address. */
485 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
486 *data = g_variant_new_string(str);
488 case SR_CONF_LIMIT_SAMPLES:
489 *data = g_variant_new_uint64(devc->limit_samples);
491 case SR_CONF_SAMPLERATE:
492 *data = g_variant_new_uint64(devc->cur_samplerate);
494 case SR_CONF_CAPTURE_RATIO:
495 *data = g_variant_new_uint64(devc->capture_ratio);
504 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
505 const struct sr_channel_group *cg)
507 struct dev_context *devc;
517 if (sdi->status != SR_ST_ACTIVE)
525 case SR_CONF_SAMPLERATE:
526 arg = g_variant_get_uint64(data);
527 for (i = 0; i < ARRAY_SIZE(samplerates); i++) {
528 if (samplerates[i] == arg) {
529 devc->cur_samplerate = arg;
533 if (i == ARRAY_SIZE(samplerates))
536 case SR_CONF_LIMIT_SAMPLES:
537 devc->limit_samples = g_variant_get_uint64(data);
539 case SR_CONF_CAPTURE_RATIO:
540 devc->capture_ratio = g_variant_get_uint64(data);
541 if (devc->capture_ratio > 100) {
542 devc->capture_ratio = 0;
554 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
555 const struct sr_channel_group *cg)
557 struct dev_context *devc;
564 case SR_CONF_SCAN_OPTIONS:
565 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
566 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
568 case SR_CONF_DEVICE_OPTIONS:
570 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
571 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
573 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
574 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
576 case SR_CONF_SAMPLERATE:
580 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
581 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), devc->samplerates,
582 devc->num_samplerates, sizeof(uint64_t));
583 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
584 *data = g_variant_builder_end(&gvb);
586 case SR_CONF_TRIGGER_MATCH:
587 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
588 soft_trigger_matches, ARRAY_SIZE(soft_trigger_matches),
598 static int receive_data(int fd, int revents, void *cb_data)
601 struct drv_context *drvc;
609 tv.tv_sec = tv.tv_usec = 0;
610 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
615 static int start_transfers(const struct sr_dev_inst *sdi)
617 struct dev_context *devc;
618 struct sr_usb_dev_inst *usb;
619 struct sr_trigger *trigger;
620 struct libusb_transfer *transfer;
621 unsigned int i, num_transfers;
622 int endpoint, timeout, ret;
629 devc->sent_samples = 0;
630 devc->acq_aborted = FALSE;
631 devc->empty_transfer_count = 0;
633 if ((trigger = sr_session_trigger_get(sdi->session))) {
634 int pre_trigger_samples = 0;
635 if (devc->limit_samples > 0)
636 pre_trigger_samples = devc->capture_ratio * devc->limit_samples/100;
637 devc->stl = soft_trigger_logic_new(sdi, trigger, pre_trigger_samples);
638 if (devc->stl == NULL)
639 return SR_ERR_MALLOC;
640 devc->trigger_fired = FALSE;
642 devc->trigger_fired = TRUE;
644 timeout = fx2lafw_get_timeout(devc);
646 num_transfers = fx2lafw_get_number_of_transfers(devc);
647 size = fx2lafw_get_buffer_size(devc);
648 devc->submitted_transfers = 0;
650 devc->transfers = g_try_malloc0(sizeof(*devc->transfers) * num_transfers);
651 if (!devc->transfers) {
652 sr_err("USB transfers malloc failed.");
653 return SR_ERR_MALLOC;
656 timeout = fx2lafw_get_timeout(devc);
657 endpoint = devc->dslogic ? 6 : 2;
658 devc->num_transfers = num_transfers;
659 for (i = 0; i < num_transfers; i++) {
660 if (!(buf = g_try_malloc(size))) {
661 sr_err("USB transfer buffer malloc failed.");
662 return SR_ERR_MALLOC;
664 transfer = libusb_alloc_transfer(0);
665 libusb_fill_bulk_transfer(transfer, usb->devhdl,
666 endpoint | LIBUSB_ENDPOINT_IN, buf, size,
667 fx2lafw_receive_transfer, (void *)sdi, timeout);
668 if ((ret = libusb_submit_transfer(transfer)) != 0) {
669 sr_err("Failed to submit transfer: %s.",
670 libusb_error_name(ret));
671 libusb_free_transfer(transfer);
673 fx2lafw_abort_acquisition(devc);
676 devc->transfers[i] = transfer;
677 devc->submitted_transfers++;
680 /* Send header packet to the session bus. */
681 std_session_send_df_header(sdi, LOG_PREFIX);
686 static void dslogic_trigger_receive(struct libusb_transfer *transfer)
688 const struct sr_dev_inst *sdi;
689 struct dslogic_trigger_pos *tpos;
691 sdi = transfer->user_data;
693 if (transfer->status == LIBUSB_TRANSFER_COMPLETED
694 && transfer->actual_length == sizeof(struct dslogic_trigger_pos)) {
695 tpos = (struct dslogic_trigger_pos *)transfer->buffer;
696 sr_dbg("tpos real_pos %.8x ram_saddr %.8x", tpos->real_pos, tpos->ram_saddr);
698 start_transfers(sdi);
701 libusb_free_transfer(transfer);
705 static int dslogic_trigger_request(const struct sr_dev_inst *sdi)
707 struct sr_usb_dev_inst *usb;
708 struct libusb_transfer *transfer;
709 struct dslogic_trigger_pos *tpos;
714 if ((ret = dslogic_stop_acquisition(sdi)) != SR_OK)
717 if ((ret = dslogic_fpga_configure(sdi)) != SR_OK)
720 if ((ret = dslogic_start_acquisition(sdi)) != SR_OK)
723 sr_dbg("Getting trigger.");
724 tpos = g_malloc(sizeof(struct dslogic_trigger_pos));
725 transfer = libusb_alloc_transfer(0);
726 libusb_fill_bulk_transfer(transfer, usb->devhdl, 6 | LIBUSB_ENDPOINT_IN,
727 (unsigned char *)tpos, sizeof(struct dslogic_trigger_pos),
728 dslogic_trigger_receive, (void *)sdi, 0);
729 if ((ret = libusb_submit_transfer(transfer)) < 0) {
730 sr_err("Failed to request trigger: %s.", libusb_error_name(ret));
731 libusb_free_transfer(transfer);
739 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
741 struct drv_context *drvc;
742 struct dev_context *devc;
745 if (sdi->status != SR_ST_ACTIVE)
746 return SR_ERR_DEV_CLOSED;
751 devc->ctx = drvc->sr_ctx;
752 devc->cb_data = cb_data;
753 devc->sent_samples = 0;
754 devc->empty_transfer_count = 0;
755 devc->acq_aborted = FALSE;
757 timeout = fx2lafw_get_timeout(devc);
758 usb_source_add(sdi->session, devc->ctx, timeout, receive_data, NULL);
761 dslogic_trigger_request(sdi);
764 if ((ret = fx2lafw_command_start_acquisition(sdi)) != SR_OK)
766 start_transfers(sdi);
772 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
776 fx2lafw_abort_acquisition(sdi->priv);
781 SR_PRIV struct sr_dev_driver fx2lafw_driver_info = {
783 .longname = "fx2lafw (generic driver for FX2 based LAs)",
788 .dev_list = dev_list,
790 .config_get = config_get,
791 .config_set = config_set,
792 .config_list = config_list,
793 .dev_open = dev_open,
794 .dev_close = dev_close,
795 .dev_acquisition_start = dev_acquisition_start,
796 .dev_acquisition_stop = dev_acquisition_stop,