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 "fx2lafw-cwav-usbeeax.fw",
33 DEV_CAPS_AX_ANALOG, NULL, NULL},
38 { 0x08a9, 0x0015, "CWAV", "USBee DX", NULL,
39 "fx2lafw-cwav-usbeedx.fw",
40 DEV_CAPS_16BIT, NULL, NULL },
45 { 0x08a9, 0x0009, "CWAV", "USBee SX", NULL,
46 "fx2lafw-cwav-usbeesx.fw",
52 { 0x08a9, 0x0005, "CWAV", "USBee ZX", NULL,
53 "fx2lafw-cwav-usbeezx.fw",
58 * EE Electronics ESLA100
60 * Robomotic BugLogic 3
62 { 0x0925, 0x3881, "Saleae", "Logic", NULL,
63 "fx2lafw-saleae-logic.fw",
67 * Default Cypress FX2 without EEPROM, e.g.:
69 * Braintechnology USB Interface V2.x
71 { 0x04B4, 0x8613, "Cypress", "FX2", NULL,
72 "fx2lafw-cypress-fx2.fw",
73 DEV_CAPS_16BIT, NULL, NULL },
76 * Braintechnology USB-LPS
78 { 0x16d0, 0x0498, "Braintechnology", "USB-LPS", NULL,
79 "fx2lafw-braintechnology-usb-lps.fw",
80 DEV_CAPS_16BIT, NULL, NULL },
83 * sigrok FX2 based 8-channel logic analyzer
85 { 0x1d50, 0x608c, "sigrok", "FX2 LA (8ch)", NULL,
86 "fx2lafw-sigrok-fx2-8ch.fw",
90 * sigrok FX2 based 16-channel logic analyzer
92 { 0x1d50, 0x608d, "sigrok", "FX2 LA (16ch)", NULL,
93 "fx2lafw-sigrok-fx2-16ch.fw",
94 DEV_CAPS_16BIT, NULL, NULL },
99 static const uint32_t drvopts[] = {
100 SR_CONF_LOGIC_ANALYZER,
103 static const uint32_t scanopts[] = {
107 static const uint32_t devopts[] = {
109 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
110 SR_CONF_CONN | SR_CONF_GET,
111 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
112 SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
113 SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
116 static const int32_t soft_trigger_matches[] = {
124 static const uint64_t samplerates[] = {
143 static gboolean is_plausible(const struct libusb_device_descriptor *des)
147 for (i = 0; supported_fx2[i].vid; i++) {
148 if (des->idVendor != supported_fx2[i].vid)
150 if (des->idProduct == supported_fx2[i].pid)
157 static GSList *scan(struct sr_dev_driver *di, GSList *options)
159 struct drv_context *drvc;
160 struct dev_context *devc;
161 struct sr_dev_inst *sdi;
162 struct sr_usb_dev_inst *usb;
163 struct sr_channel *ch;
164 struct sr_channel_group *cg;
165 struct sr_config *src;
166 const struct fx2lafw_profile *prof;
167 GSList *l, *devices, *conn_devices;
168 gboolean has_firmware;
169 struct libusb_device_descriptor des;
170 libusb_device **devlist;
171 struct libusb_device_handle *hdl;
173 int num_logic_channels = 0, num_analog_channels = 0;
175 char manufacturer[64], product[64], serial_num[64], connection_id[64];
176 char channel_name[16];
181 for (l = options; l; l = l->next) {
185 conn = g_variant_get_string(src->data, NULL);
190 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
194 /* Find all fx2lafw compatible devices and upload firmware to them. */
196 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
197 for (i = 0; devlist[i]; i++) {
200 for (l = conn_devices; l; l = l->next) {
202 if (usb->bus == libusb_get_bus_number(devlist[i])
203 && usb->address == libusb_get_device_address(devlist[i]))
207 /* This device matched none of the ones that
208 * matched the conn specification. */
212 libusb_get_device_descriptor( devlist[i], &des);
214 if (!is_plausible(&des))
217 if ((ret = libusb_open(devlist[i], &hdl)) < 0) {
218 sr_warn("Failed to open potential device with "
219 "VID:PID %04x:%04x: %s.", des.idVendor,
220 des.idProduct, libusb_error_name(ret));
224 if (des.iManufacturer == 0) {
225 manufacturer[0] = '\0';
226 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
227 des.iManufacturer, (unsigned char *) manufacturer,
228 sizeof(manufacturer))) < 0) {
229 sr_warn("Failed to get manufacturer string descriptor: %s.",
230 libusb_error_name(ret));
234 if (des.iProduct == 0) {
236 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
237 des.iProduct, (unsigned char *) product,
238 sizeof(product))) < 0) {
239 sr_warn("Failed to get product string descriptor: %s.",
240 libusb_error_name(ret));
244 if (des.iSerialNumber == 0) {
245 serial_num[0] = '\0';
246 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
247 des.iSerialNumber, (unsigned char *) serial_num,
248 sizeof(serial_num))) < 0) {
249 sr_warn("Failed to get serial number string descriptor: %s.",
250 libusb_error_name(ret));
254 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
259 for (j = 0; supported_fx2[j].vid; j++) {
260 if (des.idVendor == supported_fx2[j].vid &&
261 des.idProduct == supported_fx2[j].pid &&
262 (!supported_fx2[j].usb_manufacturer ||
263 !strcmp(manufacturer, supported_fx2[j].usb_manufacturer)) &&
264 (!supported_fx2[j].usb_product ||
265 !strcmp(product, supported_fx2[j].usb_product))) {
266 prof = &supported_fx2[j];
271 /* Skip if the device was not found. */
275 sdi = g_malloc0(sizeof(struct sr_dev_inst));
276 sdi->status = SR_ST_INITIALIZING;
277 sdi->vendor = g_strdup(prof->vendor);
278 sdi->model = g_strdup(prof->model);
279 sdi->version = g_strdup(prof->model_version);
280 sdi->serial_num = g_strdup(serial_num);
281 sdi->connection_id = g_strdup(connection_id);
283 /* Fill in channellist according to this device's profile. */
284 num_logic_channels = prof->dev_caps & DEV_CAPS_16BIT ? 16 : 8;
285 num_analog_channels = prof->dev_caps & DEV_CAPS_AX_ANALOG ? 1 : 0;
287 /* Logic channels, all in one channel group. */
288 cg = g_malloc0(sizeof(struct sr_channel_group));
289 cg->name = g_strdup("Logic");
290 for (j = 0; j < num_logic_channels; j++) {
291 sprintf(channel_name, "D%d", j);
292 ch = sr_channel_new(sdi, j, SR_CHANNEL_LOGIC,
294 cg->channels = g_slist_append(cg->channels, ch);
296 sdi->channel_groups = g_slist_append(NULL, cg);
298 for (j = 0; j < num_analog_channels; j++) {
299 snprintf(channel_name, 16, "A%d", j);
300 ch = sr_channel_new(sdi, j + num_logic_channels,
301 SR_CHANNEL_ANALOG, TRUE, channel_name);
303 /* Every analog channel gets its own channel group. */
304 cg = g_malloc0(sizeof(struct sr_channel_group));
305 cg->name = g_strdup(channel_name);
306 cg->channels = g_slist_append(NULL, ch);
307 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
310 devc = fx2lafw_dev_new();
311 devc->profile = prof;
313 devices = g_slist_append(devices, sdi);
315 devc->samplerates = samplerates;
316 devc->num_samplerates = ARRAY_SIZE(samplerates);
317 has_firmware = usb_match_manuf_prod(devlist[i],
318 "sigrok", "fx2lafw");
321 /* Already has the firmware, so fix the new address. */
322 sr_dbg("Found an fx2lafw device.");
323 sdi->status = SR_ST_INACTIVE;
324 sdi->inst_type = SR_INST_USB;
325 sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
326 libusb_get_device_address(devlist[i]), NULL);
328 if (ezusb_upload_firmware(drvc->sr_ctx, devlist[i],
329 USB_CONFIGURATION, prof->firmware) == SR_OK)
330 /* Store when this device's FW was updated. */
331 devc->fw_updated = g_get_monotonic_time();
333 sr_err("Firmware upload failed for "
334 "device %d.%d (logical).",
335 libusb_get_bus_number(devlist[i]),
336 libusb_get_device_address(devlist[i]));
337 sdi->inst_type = SR_INST_USB;
338 sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
342 libusb_free_device_list(devlist, 1);
343 g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
345 return std_scan_complete(di, devices);
348 static void clear_dev_context(void *priv)
350 struct dev_context *devc;
353 g_slist_free(devc->enabled_analog_channels);
357 static int dev_clear(const struct sr_dev_driver *di)
359 return std_dev_clear(di, clear_dev_context);
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;
368 int64_t timediff_us, timediff_ms;
374 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
375 * milliseconds for the FX2 to renumerate.
378 if (devc->fw_updated > 0) {
379 sr_info("Waiting for device to reset.");
380 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
381 g_usleep(300 * 1000);
383 while (timediff_ms < MAX_RENUM_DELAY_MS) {
384 if ((ret = fx2lafw_dev_open(sdi, di)) == SR_OK)
386 g_usleep(100 * 1000);
388 timediff_us = g_get_monotonic_time() - devc->fw_updated;
389 timediff_ms = timediff_us / 1000;
390 sr_spew("Waited %" PRIi64 "ms.", timediff_ms);
393 sr_err("Device failed to renumerate.");
396 sr_info("Device came back after %" PRIi64 "ms.", timediff_ms);
398 sr_info("Firmware upload was not needed.");
399 ret = fx2lafw_dev_open(sdi, di);
403 sr_err("Unable to open device.");
407 ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
410 case LIBUSB_ERROR_BUSY:
411 sr_err("Unable to claim USB interface. Another "
412 "program or driver has already claimed it.");
414 case LIBUSB_ERROR_NO_DEVICE:
415 sr_err("Device has been disconnected.");
418 sr_err("Unable to claim interface: %s.",
419 libusb_error_name(ret));
426 if (devc->cur_samplerate == 0) {
427 /* Samplerate hasn't been set; default to the slowest one. */
428 devc->cur_samplerate = devc->samplerates[0];
434 static int dev_close(struct sr_dev_inst *sdi)
436 struct sr_usb_dev_inst *usb;
443 sr_info("fx2lafw: Closing device on %d.%d (logical) / %s (physical) interface %d.",
444 usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
445 libusb_release_interface(usb->devhdl, USB_INTERFACE);
446 libusb_close(usb->devhdl);
448 sdi->status = SR_ST_INACTIVE;
453 static int config_get(uint32_t key, GVariant **data,
454 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
456 struct dev_context *devc;
457 struct sr_usb_dev_inst *usb;
472 if (usb->address == 255)
473 /* Device still needs to re-enumerate after firmware
474 * upload, so we don't know its (future) address. */
476 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
477 *data = g_variant_new_string(str);
479 case SR_CONF_LIMIT_SAMPLES:
480 *data = g_variant_new_uint64(devc->limit_samples);
482 case SR_CONF_SAMPLERATE:
483 *data = g_variant_new_uint64(devc->cur_samplerate);
485 case SR_CONF_CAPTURE_RATIO:
486 *data = g_variant_new_uint64(devc->capture_ratio);
495 static int config_set(uint32_t key, GVariant *data,
496 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
498 struct dev_context *devc;
507 if (sdi->status != SR_ST_ACTIVE)
515 case SR_CONF_SAMPLERATE:
516 arg = g_variant_get_uint64(data);
517 for (i = 0; i < devc->num_samplerates; i++) {
518 if (devc->samplerates[i] == arg) {
519 devc->cur_samplerate = arg;
523 if (i == devc->num_samplerates)
526 case SR_CONF_LIMIT_SAMPLES:
527 devc->limit_samples = g_variant_get_uint64(data);
529 case SR_CONF_CAPTURE_RATIO:
530 devc->capture_ratio = g_variant_get_uint64(data);
531 ret = (devc->capture_ratio > 100) ? SR_ERR : SR_OK;
540 static int config_list(uint32_t key, GVariant **data,
541 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
543 struct dev_context *devc;
550 case SR_CONF_SCAN_OPTIONS:
551 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
552 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
554 case SR_CONF_DEVICE_OPTIONS:
556 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
557 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
560 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
561 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
564 case SR_CONF_SAMPLERATE:
566 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
567 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), devc->samplerates,
568 devc->num_samplerates, sizeof(uint64_t));
569 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
570 *data = g_variant_builder_end(&gvb);
572 case SR_CONF_TRIGGER_MATCH:
573 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
574 soft_trigger_matches, ARRAY_SIZE(soft_trigger_matches),
584 static int receive_data(int fd, int revents, void *cb_data)
587 struct drv_context *drvc;
592 drvc = (struct drv_context *)cb_data;
594 tv.tv_sec = tv.tv_usec = 0;
595 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
600 static int start_transfers(const struct sr_dev_inst *sdi)
602 struct dev_context *devc;
603 struct sr_usb_dev_inst *usb;
604 struct sr_trigger *trigger;
605 struct libusb_transfer *transfer;
606 unsigned int i, num_transfers;
614 devc->sent_samples = 0;
615 devc->acq_aborted = FALSE;
616 devc->empty_transfer_count = 0;
618 if ((trigger = sr_session_trigger_get(sdi->session))) {
619 int pre_trigger_samples = 0;
620 if (devc->limit_samples > 0)
621 pre_trigger_samples = devc->capture_ratio * devc->limit_samples/100;
622 devc->stl = soft_trigger_logic_new(sdi, trigger, pre_trigger_samples);
624 return SR_ERR_MALLOC;
625 devc->trigger_fired = FALSE;
627 devc->trigger_fired = TRUE;
629 num_transfers = fx2lafw_get_number_of_transfers(devc);
631 size = fx2lafw_get_buffer_size(devc);
632 devc->submitted_transfers = 0;
634 devc->transfers = g_try_malloc0(sizeof(*devc->transfers) * num_transfers);
635 if (!devc->transfers) {
636 sr_err("USB transfers malloc failed.");
637 return SR_ERR_MALLOC;
640 timeout = fx2lafw_get_timeout(devc);
641 devc->num_transfers = num_transfers;
642 for (i = 0; i < num_transfers; i++) {
643 if (!(buf = g_try_malloc(size))) {
644 sr_err("USB transfer buffer malloc failed.");
645 return SR_ERR_MALLOC;
647 transfer = libusb_alloc_transfer(0);
648 libusb_fill_bulk_transfer(transfer, usb->devhdl,
649 2 | LIBUSB_ENDPOINT_IN, buf, size,
650 fx2lafw_receive_transfer, (void *)sdi, timeout);
651 sr_info("submitting transfer: %d", i);
652 if ((ret = libusb_submit_transfer(transfer)) != 0) {
653 sr_err("Failed to submit transfer: %s.",
654 libusb_error_name(ret));
655 libusb_free_transfer(transfer);
657 fx2lafw_abort_acquisition(devc);
660 devc->transfers[i] = transfer;
661 devc->submitted_transfers++;
665 * If this device has analog channels and at least one of them is
666 * enabled, use mso_send_data_proc() to properly handle the analog
667 * data. Otherwise use la_send_data_proc().
669 if (g_slist_length(devc->enabled_analog_channels) > 0)
670 devc->send_data_proc = mso_send_data_proc;
672 devc->send_data_proc = la_send_data_proc;
674 std_session_send_df_header(sdi);
679 static int configure_channels(const struct sr_dev_inst *sdi)
681 struct dev_context *devc;
684 struct sr_channel *ch;
685 uint32_t channel_mask = 0, num_analog = 0;
689 g_slist_free(devc->enabled_analog_channels);
690 devc->enabled_analog_channels = NULL;
692 for (l = sdi->channels, p = 0; l; l = l->next, p++) {
694 if ((p <= NUM_CHANNELS) && (ch->type == SR_CHANNEL_ANALOG)
697 devc->enabled_analog_channels =
698 g_slist_append(devc->enabled_analog_channels, ch);
700 channel_mask |= ch->enabled << p;
705 * Use wide sampling if either any of the LA channels 8..15 is enabled,
706 * and/or at least one analog channel is enabled.
708 devc->sample_wide = channel_mask > 0xff || num_analog > 0;
713 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
715 struct sr_dev_driver *di;
716 struct drv_context *drvc;
717 struct dev_context *devc;
721 if (sdi->status != SR_ST_ACTIVE)
722 return SR_ERR_DEV_CLOSED;
728 devc->ctx = drvc->sr_ctx;
729 devc->sent_samples = 0;
730 devc->empty_transfer_count = 0;
731 devc->acq_aborted = FALSE;
733 if (configure_channels(sdi) != SR_OK) {
734 sr_err("Failed to configure channels.");
738 timeout = fx2lafw_get_timeout(devc);
739 usb_source_add(sdi->session, devc->ctx, timeout, receive_data, drvc);
741 size = fx2lafw_get_buffer_size(devc);
742 /* Prepare for analog sampling. */
743 if (g_slist_length(devc->enabled_analog_channels) > 0) {
744 /* We need a buffer half the size of a transfer. */
745 devc->logic_buffer = g_try_malloc(size / 2);
746 devc->analog_buffer = g_try_malloc(
747 sizeof(float) * size / 2);
749 start_transfers(sdi);
750 if ((ret = fx2lafw_command_start_acquisition(sdi)) != SR_OK) {
751 fx2lafw_abort_acquisition(devc);
758 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
760 fx2lafw_abort_acquisition(sdi->priv);
765 static struct sr_dev_driver fx2lafw_driver_info = {
767 .longname = "fx2lafw (generic driver for FX2 based LAs)",
770 .cleanup = std_cleanup,
772 .dev_list = std_dev_list,
773 .dev_clear = dev_clear,
774 .config_get = config_get,
775 .config_set = config_set,
776 .config_list = config_list,
777 .dev_open = dev_open,
778 .dev_close = dev_close,
779 .dev_acquisition_start = dev_acquisition_start,
780 .dev_acquisition_stop = dev_acquisition_stop,
783 SR_REGISTER_DEV_DRIVER(fx2lafw_driver_info);