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;
162 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
164 return std_init(sr_ctx, di, LOG_PREFIX);
167 static GSList *scan(struct sr_dev_driver *di, GSList *options)
169 struct drv_context *drvc;
170 struct dev_context *devc;
171 struct sr_dev_inst *sdi;
172 struct sr_usb_dev_inst *usb;
173 struct sr_config *src;
174 const struct fx2lafw_profile *prof;
175 GSList *l, *devices, *conn_devices;
176 gboolean has_firmware;
177 struct libusb_device_descriptor des;
178 libusb_device **devlist;
179 struct libusb_device_handle *hdl;
180 int num_logic_channels, ret, i, j;
182 char manufacturer[64], product[64], serial_num[64], connection_id[64];
187 for (l = options; l; l = l->next) {
191 conn = g_variant_get_string(src->data, NULL);
196 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
200 /* Find all fx2lafw compatible devices and upload firmware to them. */
202 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
203 for (i = 0; devlist[i]; i++) {
206 for (l = conn_devices; l; l = l->next) {
208 if (usb->bus == libusb_get_bus_number(devlist[i])
209 && usb->address == libusb_get_device_address(devlist[i]))
213 /* This device matched none of the ones that
214 * matched the conn specification. */
218 if ((ret = libusb_get_device_descriptor( devlist[i], &des)) != 0) {
219 sr_warn("Failed to get device descriptor: %s.",
220 libusb_error_name(ret));
224 if ((ret = libusb_open(devlist[i], &hdl)) < 0)
227 if (des.iManufacturer == 0) {
228 manufacturer[0] = '\0';
229 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
230 des.iManufacturer, (unsigned char *) manufacturer,
231 sizeof(manufacturer))) < 0) {
232 sr_warn("Failed to get manufacturer string descriptor: %s.",
233 libusb_error_name(ret));
237 if (des.iProduct == 0) {
239 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
240 des.iProduct, (unsigned char *) product,
241 sizeof(product))) < 0) {
242 sr_warn("Failed to get product string descriptor: %s.",
243 libusb_error_name(ret));
247 if (des.iSerialNumber == 0) {
248 serial_num[0] = '\0';
249 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
250 des.iSerialNumber, (unsigned char *) serial_num,
251 sizeof(serial_num))) < 0) {
252 sr_warn("Failed to get serial number string descriptor: %s.",
253 libusb_error_name(ret));
257 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
262 for (j = 0; supported_fx2[j].vid; j++) {
263 if (des.idVendor == supported_fx2[j].vid &&
264 des.idProduct == supported_fx2[j].pid &&
265 (!supported_fx2[j].usb_manufacturer ||
266 !strcmp(manufacturer, supported_fx2[j].usb_manufacturer)) &&
267 (!supported_fx2[j].usb_manufacturer ||
268 !strcmp(product, supported_fx2[j].usb_product))) {
269 prof = &supported_fx2[j];
274 /* Skip if the device was not found. */
278 sdi = g_malloc0(sizeof(struct sr_dev_inst));
279 sdi->status = SR_ST_INITIALIZING;
280 sdi->vendor = g_strdup(prof->vendor);
281 sdi->model = g_strdup(prof->model);
282 sdi->version = g_strdup(prof->model_version);
284 sdi->serial_num = g_strdup(serial_num);
285 sdi->connection_id = g_strdup(connection_id);
287 /* Fill in channellist according to this device's profile. */
288 num_logic_channels = prof->dev_caps & DEV_CAPS_16BIT ? 16 : 8;
289 for (j = 0; j < num_logic_channels; j++)
290 sr_channel_new(sdi, j, SR_CHANNEL_LOGIC, TRUE,
293 devc = fx2lafw_dev_new();
294 devc->profile = prof;
295 devc->sample_wide = (prof->dev_caps & DEV_CAPS_16BIT) != 0;
297 drvc->instances = g_slist_append(drvc->instances, sdi);
298 devices = g_slist_append(devices, sdi);
300 if (strcmp(prof->model, "DSLogic")) {
301 devc->dslogic = FALSE;
302 devc->samplerates = samplerates;
303 devc->num_samplerates = ARRAY_SIZE(samplerates);
304 has_firmware = match_manuf_prod(devlist[i],
305 "sigrok", "fx2lafw");
307 devc->dslogic = TRUE;
308 devc->samplerates = dslogic_samplerates;
309 devc->num_samplerates = ARRAY_SIZE(dslogic_samplerates);
310 has_firmware = match_manuf_prod(devlist[i],
311 "DreamSourceLab", "DSLogic");
315 /* Already has the firmware, so fix the new address. */
316 sr_dbg("Found an fx2lafw device.");
317 sdi->status = SR_ST_INACTIVE;
318 sdi->inst_type = SR_INST_USB;
319 sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
320 libusb_get_device_address(devlist[i]), NULL);
322 if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
323 prof->firmware) == SR_OK)
324 /* Store when this device's FW was updated. */
325 devc->fw_updated = g_get_monotonic_time();
327 sr_err("Firmware upload failed for "
328 "device %d.%d (logical).",
329 libusb_get_bus_number(devlist[i]),
330 libusb_get_device_address(devlist[i]));
331 sdi->inst_type = SR_INST_USB;
332 sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
336 libusb_free_device_list(devlist, 1);
337 g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
342 static GSList *dev_list(const struct sr_dev_driver *di)
344 return ((struct drv_context *)(di->priv))->instances;
347 static int dev_open(struct sr_dev_inst *sdi)
349 struct sr_dev_driver *di = sdi->driver;
350 struct sr_usb_dev_inst *usb;
351 struct dev_context *devc;
353 int64_t timediff_us, timediff_ms;
359 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
360 * milliseconds for the FX2 to renumerate.
363 if (devc->fw_updated > 0) {
364 sr_info("Waiting for device to reset.");
365 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
366 g_usleep(300 * 1000);
368 while (timediff_ms < MAX_RENUM_DELAY_MS) {
369 if ((ret = fx2lafw_dev_open(sdi, di)) == SR_OK)
371 g_usleep(100 * 1000);
373 timediff_us = g_get_monotonic_time() - devc->fw_updated;
374 timediff_ms = timediff_us / 1000;
375 sr_spew("Waited %" PRIi64 "ms.", timediff_ms);
378 sr_err("Device failed to renumerate.");
381 sr_info("Device came back after %" PRIi64 "ms.", timediff_ms);
383 sr_info("Firmware upload was not needed.");
384 ret = fx2lafw_dev_open(sdi, di);
388 sr_err("Unable to open device.");
392 ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
395 case LIBUSB_ERROR_BUSY:
396 sr_err("Unable to claim USB interface. Another "
397 "program or driver has already claimed it.");
399 case LIBUSB_ERROR_NO_DEVICE:
400 sr_err("Device has been disconnected.");
403 sr_err("Unable to claim interface: %s.",
404 libusb_error_name(ret));
412 if ((ret = dslogic_fpga_firmware_upload(sdi,
413 DSLOGIC_FPGA_FIRMWARE)) != SR_OK)
417 if (devc->cur_samplerate == 0) {
418 /* Samplerate hasn't been set; default to the slowest one. */
419 devc->cur_samplerate = devc->samplerates[0];
425 static int dev_close(struct sr_dev_inst *sdi)
427 struct sr_usb_dev_inst *usb;
430 if (usb->devhdl == NULL)
433 sr_info("fx2lafw: Closing device on %d.%d (logical) / %s (physical) interface %d.",
434 usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
435 libusb_release_interface(usb->devhdl, USB_INTERFACE);
436 libusb_close(usb->devhdl);
438 sdi->status = SR_ST_INACTIVE;
443 static int cleanup(const struct sr_dev_driver *di)
446 struct drv_context *drvc;
448 if (!(drvc = di->priv))
451 ret = std_dev_clear(di, NULL);
458 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
459 const struct sr_channel_group *cg)
461 struct dev_context *devc;
462 struct sr_usb_dev_inst *usb;
477 if (usb->address == 255)
478 /* Device still needs to re-enumerate after firmware
479 * upload, so we don't know its (future) address. */
481 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
482 *data = g_variant_new_string(str);
484 case SR_CONF_LIMIT_SAMPLES:
485 *data = g_variant_new_uint64(devc->limit_samples);
487 case SR_CONF_SAMPLERATE:
488 *data = g_variant_new_uint64(devc->cur_samplerate);
490 case SR_CONF_CAPTURE_RATIO:
491 *data = g_variant_new_uint64(devc->capture_ratio);
500 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
501 const struct sr_channel_group *cg)
503 struct dev_context *devc;
513 if (sdi->status != SR_ST_ACTIVE)
521 case SR_CONF_SAMPLERATE:
522 arg = g_variant_get_uint64(data);
523 for (i = 0; i < ARRAY_SIZE(samplerates); i++) {
524 if (samplerates[i] == arg) {
525 devc->cur_samplerate = arg;
529 if (i == ARRAY_SIZE(samplerates))
532 case SR_CONF_LIMIT_SAMPLES:
533 devc->limit_samples = g_variant_get_uint64(data);
535 case SR_CONF_CAPTURE_RATIO:
536 devc->capture_ratio = g_variant_get_uint64(data);
537 if (devc->capture_ratio > 100) {
538 devc->capture_ratio = 0;
550 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
551 const struct sr_channel_group *cg)
553 struct dev_context *devc;
560 case SR_CONF_SCAN_OPTIONS:
561 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
562 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
564 case SR_CONF_DEVICE_OPTIONS:
566 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
567 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
569 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
570 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
572 case SR_CONF_SAMPLERATE:
576 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
577 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), devc->samplerates,
578 devc->num_samplerates, sizeof(uint64_t));
579 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
580 *data = g_variant_builder_end(&gvb);
582 case SR_CONF_TRIGGER_MATCH:
583 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
584 soft_trigger_matches, ARRAY_SIZE(soft_trigger_matches),
594 static int receive_data(int fd, int revents, void *cb_data)
597 struct drv_context *drvc;
602 drvc = (struct drv_context *)cb_data;
604 tv.tv_sec = tv.tv_usec = 0;
605 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
610 static int start_transfers(const struct sr_dev_inst *sdi)
612 struct dev_context *devc;
613 struct sr_usb_dev_inst *usb;
614 struct sr_trigger *trigger;
615 struct libusb_transfer *transfer;
616 unsigned int i, num_transfers;
617 int endpoint, timeout, ret;
624 devc->sent_samples = 0;
625 devc->acq_aborted = FALSE;
626 devc->empty_transfer_count = 0;
628 if ((trigger = sr_session_trigger_get(sdi->session))) {
629 int pre_trigger_samples = 0;
630 if (devc->limit_samples > 0)
631 pre_trigger_samples = devc->capture_ratio * devc->limit_samples/100;
632 devc->stl = soft_trigger_logic_new(sdi, trigger, pre_trigger_samples);
633 if (devc->stl == NULL)
634 return SR_ERR_MALLOC;
635 devc->trigger_fired = FALSE;
637 devc->trigger_fired = TRUE;
639 timeout = fx2lafw_get_timeout(devc);
641 num_transfers = fx2lafw_get_number_of_transfers(devc);
642 size = fx2lafw_get_buffer_size(devc);
643 devc->submitted_transfers = 0;
645 devc->transfers = g_try_malloc0(sizeof(*devc->transfers) * num_transfers);
646 if (!devc->transfers) {
647 sr_err("USB transfers malloc failed.");
648 return SR_ERR_MALLOC;
651 timeout = fx2lafw_get_timeout(devc);
652 endpoint = devc->dslogic ? 6 : 2;
653 devc->num_transfers = num_transfers;
654 for (i = 0; i < num_transfers; i++) {
655 if (!(buf = g_try_malloc(size))) {
656 sr_err("USB transfer buffer malloc failed.");
657 return SR_ERR_MALLOC;
659 transfer = libusb_alloc_transfer(0);
660 libusb_fill_bulk_transfer(transfer, usb->devhdl,
661 endpoint | LIBUSB_ENDPOINT_IN, buf, size,
662 fx2lafw_receive_transfer, (void *)sdi, timeout);
663 if ((ret = libusb_submit_transfer(transfer)) != 0) {
664 sr_err("Failed to submit transfer: %s.",
665 libusb_error_name(ret));
666 libusb_free_transfer(transfer);
668 fx2lafw_abort_acquisition(devc);
671 devc->transfers[i] = transfer;
672 devc->submitted_transfers++;
675 /* Send header packet to the session bus. */
676 std_session_send_df_header(sdi, LOG_PREFIX);
681 static void dslogic_trigger_receive(struct libusb_transfer *transfer)
683 const struct sr_dev_inst *sdi;
684 struct dslogic_trigger_pos *tpos;
686 sdi = transfer->user_data;
688 if (transfer->status == LIBUSB_TRANSFER_COMPLETED
689 && transfer->actual_length == sizeof(struct dslogic_trigger_pos)) {
690 tpos = (struct dslogic_trigger_pos *)transfer->buffer;
691 sr_dbg("tpos real_pos %.8x ram_saddr %.8x", tpos->real_pos, tpos->ram_saddr);
693 start_transfers(sdi);
696 libusb_free_transfer(transfer);
700 static int dslogic_trigger_request(const struct sr_dev_inst *sdi)
702 struct sr_usb_dev_inst *usb;
703 struct libusb_transfer *transfer;
704 struct dslogic_trigger_pos *tpos;
709 if ((ret = dslogic_stop_acquisition(sdi)) != SR_OK)
712 if ((ret = dslogic_fpga_configure(sdi)) != SR_OK)
715 if ((ret = dslogic_start_acquisition(sdi)) != SR_OK)
718 sr_dbg("Getting trigger.");
719 tpos = g_malloc(sizeof(struct dslogic_trigger_pos));
720 transfer = libusb_alloc_transfer(0);
721 libusb_fill_bulk_transfer(transfer, usb->devhdl, 6 | LIBUSB_ENDPOINT_IN,
722 (unsigned char *)tpos, sizeof(struct dslogic_trigger_pos),
723 dslogic_trigger_receive, (void *)sdi, 0);
724 if ((ret = libusb_submit_transfer(transfer)) < 0) {
725 sr_err("Failed to request trigger: %s.", libusb_error_name(ret));
726 libusb_free_transfer(transfer);
734 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
736 struct sr_dev_driver *di;
737 struct drv_context *drvc;
738 struct dev_context *devc;
741 if (sdi->status != SR_ST_ACTIVE)
742 return SR_ERR_DEV_CLOSED;
748 devc->ctx = drvc->sr_ctx;
749 devc->cb_data = cb_data;
750 devc->sent_samples = 0;
751 devc->empty_transfer_count = 0;
752 devc->acq_aborted = FALSE;
754 timeout = fx2lafw_get_timeout(devc);
755 usb_source_add(sdi->session, devc->ctx, timeout, receive_data, drvc);
758 dslogic_trigger_request(sdi);
761 if ((ret = fx2lafw_command_start_acquisition(sdi)) != SR_OK)
763 start_transfers(sdi);
769 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
773 fx2lafw_abort_acquisition(sdi->priv);
778 SR_PRIV struct sr_dev_driver fx2lafw_driver_info = {
780 .longname = "fx2lafw (generic driver for FX2 based LAs)",
785 .dev_list = dev_list,
787 .config_get = config_get,
788 .config_set = config_set,
789 .config_list = config_list,
790 .dev_open = dev_open,
791 .dev_close = dev_close,
792 .dev_acquisition_start = dev_acquisition_start,
793 .dev_acquisition_stop = dev_acquisition_stop,