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/>.
23 static const struct fx2lafw_profile supported_fx2[] = {
26 * EE Electronics ESLA201A
29 { 0x08a9, 0x0014, "CWAV", "USBee AX", NULL,
30 FIRMWARE_DIR "/fx2lafw-cwav-usbeeax.fw",
36 { 0x08a9, 0x0015, "CWAV", "USBee DX", NULL,
37 FIRMWARE_DIR "/fx2lafw-cwav-usbeedx.fw",
38 DEV_CAPS_16BIT, NULL, NULL },
43 { 0x08a9, 0x0009, "CWAV", "USBee SX", NULL,
44 FIRMWARE_DIR "/fx2lafw-cwav-usbeesx.fw",
48 * DreamSourceLab DSLogic (before FW upload)
50 { 0x2a0e, 0x0001, "DreamSourceLab", "DSLogic", NULL,
51 FIRMWARE_DIR "/dreamsourcelab-dslogic-fx2.fw",
52 DEV_CAPS_16BIT, NULL, NULL},
55 * DreamSourceLab DSLogic (after FW upload)
57 { 0x2a0e, 0x0001, "DreamSourceLab", "DSLogic", NULL,
58 FIRMWARE_DIR "/dreamsourcelab-dslogic-fx2.fw",
59 DEV_CAPS_16BIT, "DreamSourceLab", "DSLogic"},
63 * EE Electronics ESLA100
65 * Robomotic BugLogic 3
67 { 0x0925, 0x3881, "Saleae", "Logic", NULL,
68 FIRMWARE_DIR "/fx2lafw-saleae-logic.fw",
72 * Default Cypress FX2 without EEPROM, e.g.:
74 * Braintechnology USB Interface V2.x
76 { 0x04B4, 0x8613, "Cypress", "FX2", NULL,
77 FIRMWARE_DIR "/fx2lafw-cypress-fx2.fw",
78 DEV_CAPS_16BIT, NULL, NULL },
81 * Braintechnology USB-LPS
83 { 0x16d0, 0x0498, "Braintechnology", "USB-LPS", NULL,
84 FIRMWARE_DIR "/fx2lafw-braintechnology-usb-lps.fw",
85 DEV_CAPS_16BIT, NULL, NULL },
87 { 0, 0, 0, 0, 0, 0, 0, 0, 0 }
90 static const uint32_t drvopts[] = {
91 SR_CONF_LOGIC_ANALYZER,
94 static const uint32_t scanopts[] = {
98 static const uint32_t devopts[] = {
99 SR_CONF_CONTINUOUS | SR_CONF_SET,
100 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
101 SR_CONF_CONN | SR_CONF_GET,
102 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
103 SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
104 SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
107 static const char *channel_names[] = {
108 "0", "1", "2", "3", "4", "5", "6", "7",
109 "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;
160 static struct sr_dev_driver *di = &fx2lafw_driver_info;
162 static int init(struct sr_context *sr_ctx)
164 return std_init(sr_ctx, di, LOG_PREFIX);
167 static GSList *scan(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_channel *ch;
174 struct sr_config *src;
175 const struct fx2lafw_profile *prof;
176 GSList *l, *devices, *conn_devices;
177 gboolean has_firmware;
178 struct libusb_device_descriptor des;
179 libusb_device **devlist;
180 struct libusb_device_handle *hdl;
181 int num_logic_channels, ret, i, j;
183 char manufacturer[64], product[64], serial_num[64], connection_id[64];
188 for (l = options; l; l = l->next) {
192 conn = g_variant_get_string(src->data, NULL);
197 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
201 /* Find all fx2lafw compatible devices and upload firmware to them. */
203 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
204 for (i = 0; devlist[i]; i++) {
207 for (l = conn_devices; l; l = l->next) {
209 if (usb->bus == libusb_get_bus_number(devlist[i])
210 && usb->address == libusb_get_device_address(devlist[i]))
214 /* This device matched none of the ones that
215 * matched the conn specification. */
219 if ((ret = libusb_get_device_descriptor( devlist[i], &des)) != 0) {
220 sr_warn("Failed to get device descriptor: %s.",
221 libusb_error_name(ret));
225 if ((ret = libusb_open(devlist[i], &hdl)) < 0)
228 if (des.iManufacturer == 0) {
229 manufacturer[0] = '\0';
230 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
231 des.iManufacturer, (unsigned char *) manufacturer,
232 sizeof(manufacturer))) < 0) {
233 sr_warn("Failed to get manufacturer string descriptor: %s.",
234 libusb_error_name(ret));
238 if (des.iProduct == 0) {
240 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
241 des.iProduct, (unsigned char *) product,
242 sizeof(product))) < 0) {
243 sr_warn("Failed to get product string descriptor: %s.",
244 libusb_error_name(ret));
248 if (des.iSerialNumber == 0) {
249 serial_num[0] = '\0';
250 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
251 des.iSerialNumber, (unsigned char *) serial_num,
252 sizeof(serial_num))) < 0) {
253 sr_warn("Failed to get serial number string descriptor: %s.",
254 libusb_error_name(ret));
258 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
263 for (j = 0; supported_fx2[j].vid; j++) {
264 if (des.idVendor == supported_fx2[j].vid &&
265 des.idProduct == supported_fx2[j].pid &&
266 (!supported_fx2[j].usb_manufacturer ||
267 !strcmp(manufacturer, supported_fx2[j].usb_manufacturer)) &&
268 (!supported_fx2[j].usb_manufacturer ||
269 !strcmp(product, supported_fx2[j].usb_product))) {
270 prof = &supported_fx2[j];
275 /* Skip if the device was not found. */
279 sdi = g_malloc0(sizeof(struct sr_dev_inst));
280 sdi->status = SR_ST_INITIALIZING;
281 sdi->vendor = g_strdup(prof->vendor);
282 sdi->model = g_strdup(prof->model);
283 sdi->version = g_strdup(prof->model_version);
285 sdi->serial_num = g_strdup(serial_num);
286 sdi->connection_id = g_strdup(connection_id);
288 /* Fill in channellist according to this device's profile. */
289 num_logic_channels = prof->dev_caps & DEV_CAPS_16BIT ? 16 : 8;
290 for (j = 0; j < num_logic_channels; j++) {
291 ch = sr_channel_new(j, SR_CHANNEL_LOGIC, TRUE,
293 sdi->channels = g_slist_append(sdi->channels, ch);
296 devc = fx2lafw_dev_new();
297 devc->profile = prof;
298 devc->sample_wide = (prof->dev_caps & DEV_CAPS_16BIT) != 0;
300 drvc->instances = g_slist_append(drvc->instances, sdi);
301 devices = g_slist_append(devices, sdi);
303 if (strcmp(prof->model, "DSLogic")) {
304 devc->dslogic = FALSE;
305 devc->samplerates = samplerates;
306 devc->num_samplerates = ARRAY_SIZE(samplerates);
307 has_firmware = match_manuf_prod(devlist[i],
308 "sigrok", "fx2lafw");
310 devc->dslogic = TRUE;
311 devc->samplerates = dslogic_samplerates;
312 devc->num_samplerates = ARRAY_SIZE(dslogic_samplerates);
313 has_firmware = match_manuf_prod(devlist[i],
314 "DreamSourceLab", "DSLogic");
318 /* Already has the firmware, so fix the new address. */
319 sr_dbg("Found an fx2lafw device.");
320 sdi->status = SR_ST_INACTIVE;
321 sdi->inst_type = SR_INST_USB;
322 sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
323 libusb_get_device_address(devlist[i]), NULL);
325 if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
326 prof->firmware) == SR_OK)
327 /* Store when this device's FW was updated. */
328 devc->fw_updated = g_get_monotonic_time();
330 sr_err("Firmware upload failed for "
331 "device %d.%d (logical).",
332 libusb_get_bus_number(devlist[i]),
333 libusb_get_device_address(devlist[i]));
334 sdi->inst_type = SR_INST_USB;
335 sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
339 libusb_free_device_list(devlist, 1);
340 g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
345 static GSList *dev_list(void)
347 return ((struct drv_context *)(di->priv))->instances;
350 static int dev_open(struct sr_dev_inst *sdi)
352 struct sr_usb_dev_inst *usb;
353 struct dev_context *devc;
355 int64_t timediff_us, timediff_ms;
361 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
362 * milliseconds for the FX2 to renumerate.
365 if (devc->fw_updated > 0) {
366 sr_info("Waiting for device to reset.");
367 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
368 g_usleep(300 * 1000);
370 while (timediff_ms < MAX_RENUM_DELAY_MS) {
371 if ((ret = fx2lafw_dev_open(sdi, di)) == SR_OK)
373 g_usleep(100 * 1000);
375 timediff_us = g_get_monotonic_time() - devc->fw_updated;
376 timediff_ms = timediff_us / 1000;
377 sr_spew("Waited %" PRIi64 "ms.", timediff_ms);
380 sr_err("Device failed to renumerate.");
383 sr_info("Device came back after %" PRIi64 "ms.", timediff_ms);
385 sr_info("Firmware upload was not needed.");
386 ret = fx2lafw_dev_open(sdi, di);
390 sr_err("Unable to open device.");
394 ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
397 case LIBUSB_ERROR_BUSY:
398 sr_err("Unable to claim USB interface. Another "
399 "program or driver has already claimed it.");
401 case LIBUSB_ERROR_NO_DEVICE:
402 sr_err("Device has been disconnected.");
405 sr_err("Unable to claim interface: %s.",
406 libusb_error_name(ret));
414 if ((ret = dslogic_fpga_firmware_upload(usb->devhdl,
415 DSLOGIC_FPGA_FIRMWARE)) != SR_OK)
419 if (devc->cur_samplerate == 0) {
420 /* Samplerate hasn't been set; default to the slowest one. */
421 devc->cur_samplerate = devc->samplerates[0];
427 static int dev_close(struct sr_dev_inst *sdi)
429 struct sr_usb_dev_inst *usb;
432 if (usb->devhdl == NULL)
435 sr_info("fx2lafw: Closing device on %d.%d (logical) / %s (physical) interface %d.",
436 usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
437 libusb_release_interface(usb->devhdl, USB_INTERFACE);
438 libusb_close(usb->devhdl);
440 sdi->status = SR_ST_INACTIVE;
445 static int cleanup(void)
448 struct drv_context *drvc;
450 if (!(drvc = di->priv))
453 ret = std_dev_clear(di, NULL);
461 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
462 const struct sr_channel_group *cg)
464 struct dev_context *devc;
465 struct sr_usb_dev_inst *usb;
480 if (usb->address == 255)
481 /* Device still needs to re-enumerate after firmware
482 * upload, so we don't know its (future) address. */
484 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
485 *data = g_variant_new_string(str);
487 case SR_CONF_LIMIT_SAMPLES:
488 *data = g_variant_new_uint64(devc->limit_samples);
490 case SR_CONF_SAMPLERATE:
491 *data = g_variant_new_uint64(devc->cur_samplerate);
493 case SR_CONF_CAPTURE_RATIO:
494 *data = g_variant_new_uint64(devc->capture_ratio);
503 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
504 const struct sr_channel_group *cg)
506 struct dev_context *devc;
516 if (sdi->status != SR_ST_ACTIVE)
524 case SR_CONF_SAMPLERATE:
525 arg = g_variant_get_uint64(data);
526 for (i = 0; i < ARRAY_SIZE(samplerates); i++) {
527 if (samplerates[i] == arg) {
528 devc->cur_samplerate = arg;
532 if (i == ARRAY_SIZE(samplerates))
535 case SR_CONF_LIMIT_SAMPLES:
536 devc->limit_samples = g_variant_get_uint64(data);
538 case SR_CONF_CAPTURE_RATIO:
539 devc->capture_ratio = g_variant_get_uint64(data);
540 if (devc->capture_ratio > 100) {
541 devc->capture_ratio = 0;
553 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
554 const struct sr_channel_group *cg)
556 struct dev_context *devc;
563 case SR_CONF_SCAN_OPTIONS:
564 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
565 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
567 case SR_CONF_DEVICE_OPTIONS:
569 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
570 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
572 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
573 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
575 case SR_CONF_SAMPLERATE:
579 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
580 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), devc->samplerates,
581 devc->num_samplerates, sizeof(uint64_t));
582 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
583 *data = g_variant_builder_end(&gvb);
585 case SR_CONF_TRIGGER_MATCH:
586 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
587 soft_trigger_matches, ARRAY_SIZE(soft_trigger_matches),
597 static int receive_data(int fd, int revents, void *cb_data)
600 struct drv_context *drvc;
608 tv.tv_sec = tv.tv_usec = 0;
609 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
614 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
616 struct dev_context *devc;
617 struct drv_context *drvc;
618 struct sr_usb_dev_inst *usb;
619 struct sr_trigger *trigger;
620 struct libusb_transfer *transfer;
621 unsigned int i, timeout, num_transfers;
626 if (sdi->status != SR_ST_ACTIVE)
627 return SR_ERR_DEV_CLOSED;
633 devc->cb_data = cb_data;
634 devc->sent_samples = 0;
635 devc->acq_aborted = FALSE;
636 devc->empty_transfer_count = 0;
638 if ((trigger = sr_session_trigger_get(sdi->session))) {
639 int pre_trigger_samples = 0;
640 if (devc->limit_samples > 0)
641 pre_trigger_samples = devc->capture_ratio * devc->limit_samples/100;
642 devc->stl = soft_trigger_logic_new(sdi, trigger, pre_trigger_samples);
643 if (devc->stl == NULL)
644 return SR_ERR_MALLOC;
645 devc->trigger_fired = FALSE;
647 devc->trigger_fired = TRUE;
649 timeout = fx2lafw_get_timeout(devc);
650 num_transfers = fx2lafw_get_number_of_transfers(devc);
651 size = fx2lafw_get_buffer_size(devc);
652 devc->submitted_transfers = 0;
654 devc->transfers = g_try_malloc0(sizeof(*devc->transfers) * num_transfers);
655 if (!devc->transfers) {
656 sr_err("USB transfers malloc failed.");
657 return SR_ERR_MALLOC;
660 devc->num_transfers = num_transfers;
661 for (i = 0; i < num_transfers; i++) {
662 if (!(buf = g_try_malloc(size))) {
663 sr_err("USB transfer buffer malloc failed.");
664 return SR_ERR_MALLOC;
666 transfer = libusb_alloc_transfer(0);
667 libusb_fill_bulk_transfer(transfer, usb->devhdl,
668 2 | LIBUSB_ENDPOINT_IN, buf, size,
669 fx2lafw_receive_transfer, (void *)sdi, timeout);
670 if ((ret = libusb_submit_transfer(transfer)) != 0) {
671 sr_err("Failed to submit transfer: %s.",
672 libusb_error_name(ret));
673 libusb_free_transfer(transfer);
675 fx2lafw_abort_acquisition(devc);
678 devc->transfers[i] = transfer;
679 devc->submitted_transfers++;
682 devc->ctx = drvc->sr_ctx;
684 usb_source_add(sdi->session, devc->ctx, timeout, receive_data, NULL);
686 /* Send header packet to the session bus. */
687 std_session_send_df_header(cb_data, LOG_PREFIX);
689 if ((ret = fx2lafw_command_start_acquisition(sdi)) != SR_OK) {
690 fx2lafw_abort_acquisition(devc);
697 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
701 fx2lafw_abort_acquisition(sdi->priv);
706 SR_PRIV struct sr_dev_driver fx2lafw_driver_info = {
708 .longname = "fx2lafw (generic driver for FX2 based LAs)",
713 .dev_list = dev_list,
715 .config_get = config_get,
716 .config_set = config_set,
717 .config_list = config_list,
718 .dev_open = dev_open,
719 .dev_close = dev_close,
720 .dev_acquisition_start = dev_acquisition_start,
721 .dev_acquisition_stop = dev_acquisition_stop,