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",
113 static const int32_t soft_trigger_matches[] = {
121 static const uint64_t samplerates[] = {
140 static const uint64_t dslogic_samplerates[] = {
159 SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
161 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
163 return std_init(sr_ctx, di, LOG_PREFIX);
166 static GSList *scan(struct sr_dev_driver *di, GSList *options)
168 struct drv_context *drvc;
169 struct dev_context *devc;
170 struct sr_dev_inst *sdi;
171 struct sr_usb_dev_inst *usb;
172 struct sr_config *src;
173 const struct fx2lafw_profile *prof;
174 GSList *l, *devices, *conn_devices;
175 gboolean has_firmware;
176 struct libusb_device_descriptor des;
177 libusb_device **devlist;
178 struct libusb_device_handle *hdl;
179 int num_logic_channels, ret, i, j;
181 char manufacturer[64], product[64], serial_num[64], connection_id[64];
186 for (l = options; l; l = l->next) {
190 conn = g_variant_get_string(src->data, NULL);
195 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
199 /* Find all fx2lafw compatible devices and upload firmware to them. */
201 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
202 for (i = 0; devlist[i]; i++) {
205 for (l = conn_devices; l; l = l->next) {
207 if (usb->bus == libusb_get_bus_number(devlist[i])
208 && usb->address == libusb_get_device_address(devlist[i]))
212 /* This device matched none of the ones that
213 * matched the conn specification. */
217 if ((ret = libusb_get_device_descriptor( devlist[i], &des)) != 0) {
218 sr_warn("Failed to get device descriptor: %s.",
219 libusb_error_name(ret));
223 if ((ret = libusb_open(devlist[i], &hdl)) < 0)
226 if (des.iManufacturer == 0) {
227 manufacturer[0] = '\0';
228 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
229 des.iManufacturer, (unsigned char *) manufacturer,
230 sizeof(manufacturer))) < 0) {
231 sr_warn("Failed to get manufacturer string descriptor: %s.",
232 libusb_error_name(ret));
236 if (des.iProduct == 0) {
238 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
239 des.iProduct, (unsigned char *) product,
240 sizeof(product))) < 0) {
241 sr_warn("Failed to get product string descriptor: %s.",
242 libusb_error_name(ret));
246 if (des.iSerialNumber == 0) {
247 serial_num[0] = '\0';
248 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
249 des.iSerialNumber, (unsigned char *) serial_num,
250 sizeof(serial_num))) < 0) {
251 sr_warn("Failed to get serial number string descriptor: %s.",
252 libusb_error_name(ret));
256 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
261 for (j = 0; supported_fx2[j].vid; j++) {
262 if (des.idVendor == supported_fx2[j].vid &&
263 des.idProduct == supported_fx2[j].pid &&
264 (!supported_fx2[j].usb_manufacturer ||
265 !strcmp(manufacturer, supported_fx2[j].usb_manufacturer)) &&
266 (!supported_fx2[j].usb_manufacturer ||
267 !strcmp(product, supported_fx2[j].usb_product))) {
268 prof = &supported_fx2[j];
273 /* Skip if the device was not found. */
277 sdi = g_malloc0(sizeof(struct sr_dev_inst));
278 sdi->status = SR_ST_INITIALIZING;
279 sdi->vendor = g_strdup(prof->vendor);
280 sdi->model = g_strdup(prof->model);
281 sdi->version = g_strdup(prof->model_version);
283 sdi->serial_num = g_strdup(serial_num);
284 sdi->connection_id = g_strdup(connection_id);
286 /* Fill in channellist according to this device's profile. */
287 num_logic_channels = prof->dev_caps & DEV_CAPS_16BIT ? 16 : 8;
288 for (j = 0; j < num_logic_channels; j++)
289 sr_channel_new(sdi, j, SR_CHANNEL_LOGIC, TRUE,
292 devc = fx2lafw_dev_new();
293 devc->profile = prof;
294 devc->sample_wide = (prof->dev_caps & DEV_CAPS_16BIT) != 0;
296 drvc->instances = g_slist_append(drvc->instances, sdi);
297 devices = g_slist_append(devices, sdi);
299 if (strcmp(prof->model, "DSLogic")) {
300 devc->dslogic = FALSE;
301 devc->samplerates = samplerates;
302 devc->num_samplerates = ARRAY_SIZE(samplerates);
303 has_firmware = match_manuf_prod(devlist[i],
304 "sigrok", "fx2lafw");
306 devc->dslogic = TRUE;
307 devc->samplerates = dslogic_samplerates;
308 devc->num_samplerates = ARRAY_SIZE(dslogic_samplerates);
309 has_firmware = match_manuf_prod(devlist[i],
310 "DreamSourceLab", "DSLogic");
314 /* Already has the firmware, so fix the new address. */
315 sr_dbg("Found an fx2lafw device.");
316 sdi->status = SR_ST_INACTIVE;
317 sdi->inst_type = SR_INST_USB;
318 sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
319 libusb_get_device_address(devlist[i]), NULL);
321 if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
322 prof->firmware) == SR_OK)
323 /* Store when this device's FW was updated. */
324 devc->fw_updated = g_get_monotonic_time();
326 sr_err("Firmware upload failed for "
327 "device %d.%d (logical).",
328 libusb_get_bus_number(devlist[i]),
329 libusb_get_device_address(devlist[i]));
330 sdi->inst_type = SR_INST_USB;
331 sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
335 libusb_free_device_list(devlist, 1);
336 g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
341 static GSList *dev_list(const struct sr_dev_driver *di)
343 return ((struct drv_context *)(di->priv))->instances;
346 static int dev_open(struct sr_dev_inst *sdi)
348 struct sr_dev_driver *di = sdi->driver;
349 struct sr_usb_dev_inst *usb;
350 struct dev_context *devc;
352 int64_t timediff_us, timediff_ms;
358 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
359 * milliseconds for the FX2 to renumerate.
362 if (devc->fw_updated > 0) {
363 sr_info("Waiting for device to reset.");
364 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
365 g_usleep(300 * 1000);
367 while (timediff_ms < MAX_RENUM_DELAY_MS) {
368 if ((ret = fx2lafw_dev_open(sdi, di)) == SR_OK)
370 g_usleep(100 * 1000);
372 timediff_us = g_get_monotonic_time() - devc->fw_updated;
373 timediff_ms = timediff_us / 1000;
374 sr_spew("Waited %" PRIi64 "ms.", timediff_ms);
377 sr_err("Device failed to renumerate.");
380 sr_info("Device came back after %" PRIi64 "ms.", timediff_ms);
382 sr_info("Firmware upload was not needed.");
383 ret = fx2lafw_dev_open(sdi, di);
387 sr_err("Unable to open device.");
391 ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
394 case LIBUSB_ERROR_BUSY:
395 sr_err("Unable to claim USB interface. Another "
396 "program or driver has already claimed it.");
398 case LIBUSB_ERROR_NO_DEVICE:
399 sr_err("Device has been disconnected.");
402 sr_err("Unable to claim interface: %s.",
403 libusb_error_name(ret));
411 if ((ret = dslogic_fpga_firmware_upload(sdi,
412 DSLOGIC_FPGA_FIRMWARE)) != SR_OK)
416 if (devc->cur_samplerate == 0) {
417 /* Samplerate hasn't been set; default to the slowest one. */
418 devc->cur_samplerate = devc->samplerates[0];
424 static int dev_close(struct sr_dev_inst *sdi)
426 struct sr_usb_dev_inst *usb;
429 if (usb->devhdl == NULL)
432 sr_info("fx2lafw: Closing device on %d.%d (logical) / %s (physical) interface %d.",
433 usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
434 libusb_release_interface(usb->devhdl, USB_INTERFACE);
435 libusb_close(usb->devhdl);
437 sdi->status = SR_ST_INACTIVE;
442 static int cleanup(const struct sr_dev_driver *di)
445 struct drv_context *drvc;
447 if (!(drvc = di->priv))
450 ret = std_dev_clear(di, NULL);
457 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
458 const struct sr_channel_group *cg)
460 struct dev_context *devc;
461 struct sr_usb_dev_inst *usb;
476 if (usb->address == 255)
477 /* Device still needs to re-enumerate after firmware
478 * upload, so we don't know its (future) address. */
480 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
481 *data = g_variant_new_string(str);
483 case SR_CONF_LIMIT_SAMPLES:
484 *data = g_variant_new_uint64(devc->limit_samples);
486 case SR_CONF_SAMPLERATE:
487 *data = g_variant_new_uint64(devc->cur_samplerate);
489 case SR_CONF_CAPTURE_RATIO:
490 *data = g_variant_new_uint64(devc->capture_ratio);
499 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
500 const struct sr_channel_group *cg)
502 struct dev_context *devc;
512 if (sdi->status != SR_ST_ACTIVE)
520 case SR_CONF_SAMPLERATE:
521 arg = g_variant_get_uint64(data);
522 for (i = 0; i < ARRAY_SIZE(samplerates); i++) {
523 if (samplerates[i] == arg) {
524 devc->cur_samplerate = arg;
528 if (i == ARRAY_SIZE(samplerates))
531 case SR_CONF_LIMIT_SAMPLES:
532 devc->limit_samples = g_variant_get_uint64(data);
534 case SR_CONF_CAPTURE_RATIO:
535 devc->capture_ratio = g_variant_get_uint64(data);
536 if (devc->capture_ratio > 100) {
537 devc->capture_ratio = 0;
549 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
550 const struct sr_channel_group *cg)
552 struct dev_context *devc;
559 case SR_CONF_SCAN_OPTIONS:
560 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
561 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
563 case SR_CONF_DEVICE_OPTIONS:
565 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
566 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
568 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
569 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
571 case SR_CONF_SAMPLERATE:
575 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
576 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), devc->samplerates,
577 devc->num_samplerates, sizeof(uint64_t));
578 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
579 *data = g_variant_builder_end(&gvb);
581 case SR_CONF_TRIGGER_MATCH:
582 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
583 soft_trigger_matches, ARRAY_SIZE(soft_trigger_matches),
593 static int receive_data(int fd, int revents, void *cb_data)
596 struct drv_context *drvc;
601 drvc = (struct drv_context *)cb_data;
603 tv.tv_sec = tv.tv_usec = 0;
604 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
609 static int start_transfers(const struct sr_dev_inst *sdi)
611 struct dev_context *devc;
612 struct sr_usb_dev_inst *usb;
613 struct sr_trigger *trigger;
614 struct libusb_transfer *transfer;
615 unsigned int i, num_transfers;
616 int endpoint, timeout, ret;
623 devc->sent_samples = 0;
624 devc->acq_aborted = FALSE;
625 devc->empty_transfer_count = 0;
627 if ((trigger = sr_session_trigger_get(sdi->session))) {
628 int pre_trigger_samples = 0;
629 if (devc->limit_samples > 0)
630 pre_trigger_samples = devc->capture_ratio * devc->limit_samples/100;
631 devc->stl = soft_trigger_logic_new(sdi, trigger, pre_trigger_samples);
632 if (devc->stl == NULL)
633 return SR_ERR_MALLOC;
634 devc->trigger_fired = FALSE;
636 devc->trigger_fired = TRUE;
638 timeout = fx2lafw_get_timeout(devc);
640 num_transfers = fx2lafw_get_number_of_transfers(devc);
641 size = fx2lafw_get_buffer_size(devc);
642 devc->submitted_transfers = 0;
644 devc->transfers = g_try_malloc0(sizeof(*devc->transfers) * num_transfers);
645 if (!devc->transfers) {
646 sr_err("USB transfers malloc failed.");
647 return SR_ERR_MALLOC;
650 timeout = fx2lafw_get_timeout(devc);
651 endpoint = devc->dslogic ? 6 : 2;
652 devc->num_transfers = num_transfers;
653 for (i = 0; i < num_transfers; i++) {
654 if (!(buf = g_try_malloc(size))) {
655 sr_err("USB transfer buffer malloc failed.");
656 return SR_ERR_MALLOC;
658 transfer = libusb_alloc_transfer(0);
659 libusb_fill_bulk_transfer(transfer, usb->devhdl,
660 endpoint | LIBUSB_ENDPOINT_IN, buf, size,
661 fx2lafw_receive_transfer, (void *)sdi, timeout);
662 if ((ret = libusb_submit_transfer(transfer)) != 0) {
663 sr_err("Failed to submit transfer: %s.",
664 libusb_error_name(ret));
665 libusb_free_transfer(transfer);
667 fx2lafw_abort_acquisition(devc);
670 devc->transfers[i] = transfer;
671 devc->submitted_transfers++;
674 /* Send header packet to the session bus. */
675 std_session_send_df_header(sdi, LOG_PREFIX);
680 static void dslogic_trigger_receive(struct libusb_transfer *transfer)
682 const struct sr_dev_inst *sdi;
683 struct dslogic_trigger_pos *tpos;
685 sdi = transfer->user_data;
687 if (transfer->status == LIBUSB_TRANSFER_COMPLETED
688 && transfer->actual_length == sizeof(struct dslogic_trigger_pos)) {
689 tpos = (struct dslogic_trigger_pos *)transfer->buffer;
690 sr_dbg("tpos real_pos %.8x ram_saddr %.8x", tpos->real_pos, tpos->ram_saddr);
692 start_transfers(sdi);
695 libusb_free_transfer(transfer);
699 static int dslogic_trigger_request(const struct sr_dev_inst *sdi)
701 struct sr_usb_dev_inst *usb;
702 struct libusb_transfer *transfer;
703 struct dslogic_trigger_pos *tpos;
708 if ((ret = dslogic_stop_acquisition(sdi)) != SR_OK)
711 if ((ret = dslogic_fpga_configure(sdi)) != SR_OK)
714 if ((ret = dslogic_start_acquisition(sdi)) != SR_OK)
717 sr_dbg("Getting trigger.");
718 tpos = g_malloc(sizeof(struct dslogic_trigger_pos));
719 transfer = libusb_alloc_transfer(0);
720 libusb_fill_bulk_transfer(transfer, usb->devhdl, 6 | LIBUSB_ENDPOINT_IN,
721 (unsigned char *)tpos, sizeof(struct dslogic_trigger_pos),
722 dslogic_trigger_receive, (void *)sdi, 0);
723 if ((ret = libusb_submit_transfer(transfer)) < 0) {
724 sr_err("Failed to request trigger: %s.", libusb_error_name(ret));
725 libusb_free_transfer(transfer);
733 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
735 struct sr_dev_driver *di;
736 struct drv_context *drvc;
737 struct dev_context *devc;
740 if (sdi->status != SR_ST_ACTIVE)
741 return SR_ERR_DEV_CLOSED;
747 devc->ctx = drvc->sr_ctx;
748 devc->cb_data = cb_data;
749 devc->sent_samples = 0;
750 devc->empty_transfer_count = 0;
751 devc->acq_aborted = FALSE;
753 timeout = fx2lafw_get_timeout(devc);
754 usb_source_add(sdi->session, devc->ctx, timeout, receive_data, drvc);
757 dslogic_trigger_request(sdi);
760 if ((ret = fx2lafw_command_start_acquisition(sdi)) != SR_OK)
762 start_transfers(sdi);
768 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
772 fx2lafw_abort_acquisition(sdi->priv);
777 SR_PRIV struct sr_dev_driver fx2lafw_driver_info = {
779 .longname = "fx2lafw (generic driver for FX2 based LAs)",
784 .dev_list = dev_list,
786 .config_get = config_get,
787 .config_set = config_set,
788 .config_list = config_list,
789 .dev_open = dev_open,
790 .dev_close = dev_close,
791 .dev_acquisition_start = dev_acquisition_start,
792 .dev_acquisition_stop = dev_acquisition_stop,