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",
49 * EE Electronics ESLA100
51 * Robomotic BugLogic 3
53 { 0x0925, 0x3881, "Saleae", "Logic", NULL,
54 FIRMWARE_DIR "/fx2lafw-saleae-logic.fw",
58 * Default Cypress FX2 without EEPROM, e.g.:
60 * Braintechnology USB Interface V2.x
62 { 0x04B4, 0x8613, "Cypress", "FX2", NULL,
63 FIRMWARE_DIR "/fx2lafw-cypress-fx2.fw",
64 DEV_CAPS_16BIT, NULL, NULL },
67 * Braintechnology USB-LPS
69 { 0x16d0, 0x0498, "Braintechnology", "USB-LPS", NULL,
70 FIRMWARE_DIR "/fx2lafw-braintechnology-usb-lps.fw",
71 DEV_CAPS_16BIT, NULL, NULL },
73 { 0, 0, 0, 0, 0, 0, 0, 0, 0 }
76 static const uint32_t drvopts[] = {
77 SR_CONF_LOGIC_ANALYZER,
80 static const uint32_t scanopts[] = {
84 static const uint32_t devopts[] = {
85 SR_CONF_CONTINUOUS | SR_CONF_SET,
86 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
87 SR_CONF_CONN | SR_CONF_GET,
88 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
89 SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
90 SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
93 static const char *channel_names[] = {
94 "0", "1", "2", "3", "4", "5", "6", "7",
95 "8", "9", "10", "11", "12", "13", "14", "15",
99 static const int32_t soft_trigger_matches[] = {
107 static const uint64_t samplerates[] = {
126 SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
127 static struct sr_dev_driver *di = &fx2lafw_driver_info;
129 static int init(struct sr_context *sr_ctx)
131 return std_init(sr_ctx, di, LOG_PREFIX);
134 static GSList *scan(GSList *options)
136 struct drv_context *drvc;
137 struct dev_context *devc;
138 struct sr_dev_inst *sdi;
139 struct sr_usb_dev_inst *usb;
140 struct sr_channel *ch;
141 struct sr_config *src;
142 const struct fx2lafw_profile *prof;
143 GSList *l, *devices, *conn_devices;
144 struct libusb_device_descriptor des;
145 libusb_device **devlist;
146 struct libusb_device_handle *hdl;
147 int num_logic_channels, ret, i, j;
149 char manufacturer[64], product[64], serial_num[64], connection_id[64];
154 for (l = options; l; l = l->next) {
158 conn = g_variant_get_string(src->data, NULL);
163 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
167 /* Find all fx2lafw compatible devices and upload firmware to them. */
169 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
170 for (i = 0; devlist[i]; i++) {
173 for (l = conn_devices; l; l = l->next) {
175 if (usb->bus == libusb_get_bus_number(devlist[i])
176 && usb->address == libusb_get_device_address(devlist[i]))
180 /* This device matched none of the ones that
181 * matched the conn specification. */
185 if ((ret = libusb_get_device_descriptor( devlist[i], &des)) != 0) {
186 sr_warn("Failed to get device descriptor: %s.",
187 libusb_error_name(ret));
191 if ((ret = libusb_open(devlist[i], &hdl)) < 0)
194 if (des.iManufacturer == 0) {
195 manufacturer[0] = '\0';
196 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
197 des.iManufacturer, (unsigned char *) manufacturer,
198 sizeof(manufacturer))) < 0) {
199 sr_warn("Failed to get manufacturer string descriptor: %s.",
200 libusb_error_name(ret));
204 if (des.iProduct == 0) {
206 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
207 des.iProduct, (unsigned char *) product,
208 sizeof(product))) < 0) {
209 sr_warn("Failed to get product string descriptor: %s.",
210 libusb_error_name(ret));
214 if (des.iSerialNumber == 0) {
215 serial_num[0] = '\0';
216 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
217 des.iSerialNumber, (unsigned char *) serial_num,
218 sizeof(serial_num))) < 0) {
219 sr_warn("Failed to get serial number string descriptor: %s.",
220 libusb_error_name(ret));
224 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
229 for (j = 0; supported_fx2[j].vid; j++) {
230 if (des.idVendor == supported_fx2[j].vid &&
231 des.idProduct == supported_fx2[j].pid &&
232 (!supported_fx2[j].usb_manufacturer ||
233 !strcmp(manufacturer, supported_fx2[j].usb_manufacturer)) &&
234 (!supported_fx2[j].usb_manufacturer ||
235 !strcmp(product, supported_fx2[j].usb_product))) {
236 prof = &supported_fx2[j];
241 /* Skip if the device was not found. */
245 sdi = g_malloc0(sizeof(struct sr_dev_inst));
246 sdi->status = SR_ST_INITIALIZING;
247 sdi->vendor = g_strdup(prof->vendor);
248 sdi->model = g_strdup(prof->model);
249 sdi->version = g_strdup(prof->model_version);
251 sdi->serial_num = g_strdup(serial_num);
252 sdi->connection_id = g_strdup(connection_id);
254 /* Fill in channellist according to this device's profile. */
255 num_logic_channels = prof->dev_caps & DEV_CAPS_16BIT ? 16 : 8;
256 for (j = 0; j < num_logic_channels; j++) {
257 ch = sr_channel_new(j, SR_CHANNEL_LOGIC, TRUE,
259 sdi->channels = g_slist_append(sdi->channels, ch);
262 devc = fx2lafw_dev_new();
263 devc->profile = prof;
264 devc->sample_wide = (prof->dev_caps & DEV_CAPS_16BIT) != 0;
266 drvc->instances = g_slist_append(drvc->instances, sdi);
267 devices = g_slist_append(devices, sdi);
269 if (fx2lafw_check_conf_profile(devlist[i])) {
270 /* Already has the firmware, so fix the new address. */
271 sr_dbg("Found an fx2lafw device.");
272 sdi->status = SR_ST_INACTIVE;
273 sdi->inst_type = SR_INST_USB;
274 sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
275 libusb_get_device_address(devlist[i]), NULL);
277 if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
278 prof->firmware) == SR_OK)
279 /* Store when this device's FW was updated. */
280 devc->fw_updated = g_get_monotonic_time();
282 sr_err("Firmware upload failed for "
283 "device %d.%d (logical).",
284 libusb_get_bus_number(devlist[i]),
285 libusb_get_device_address(devlist[i]));
286 sdi->inst_type = SR_INST_USB;
287 sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
291 libusb_free_device_list(devlist, 1);
292 g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
297 static GSList *dev_list(void)
299 return ((struct drv_context *)(di->priv))->instances;
302 static int dev_open(struct sr_dev_inst *sdi)
304 struct sr_usb_dev_inst *usb;
305 struct dev_context *devc;
307 int64_t timediff_us, timediff_ms;
313 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
314 * milliseconds for the FX2 to renumerate.
317 if (devc->fw_updated > 0) {
318 sr_info("Waiting for device to reset.");
319 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
320 g_usleep(300 * 1000);
322 while (timediff_ms < MAX_RENUM_DELAY_MS) {
323 if ((ret = fx2lafw_dev_open(sdi, di)) == SR_OK)
325 g_usleep(100 * 1000);
327 timediff_us = g_get_monotonic_time() - devc->fw_updated;
328 timediff_ms = timediff_us / 1000;
329 sr_spew("Waited %" PRIi64 "ms.", timediff_ms);
332 sr_err("Device failed to renumerate.");
335 sr_info("Device came back after %" PRIi64 "ms.", timediff_ms);
337 sr_info("Firmware upload was not needed.");
338 ret = fx2lafw_dev_open(sdi, di);
342 sr_err("Unable to open device.");
346 ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
349 case LIBUSB_ERROR_BUSY:
350 sr_err("Unable to claim USB interface. Another "
351 "program or driver has already claimed it.");
353 case LIBUSB_ERROR_NO_DEVICE:
354 sr_err("Device has been disconnected.");
357 sr_err("Unable to claim interface: %s.",
358 libusb_error_name(ret));
365 if (devc->cur_samplerate == 0) {
366 /* Samplerate hasn't been set; default to the slowest one. */
367 devc->cur_samplerate = samplerates[0];
373 static int dev_close(struct sr_dev_inst *sdi)
375 struct sr_usb_dev_inst *usb;
378 if (usb->devhdl == NULL)
381 sr_info("fx2lafw: Closing device on %d.%d (logical) / %s (physical) interface %d.",
382 usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
383 libusb_release_interface(usb->devhdl, USB_INTERFACE);
384 libusb_close(usb->devhdl);
386 sdi->status = SR_ST_INACTIVE;
391 static int cleanup(void)
394 struct drv_context *drvc;
396 if (!(drvc = di->priv))
399 ret = std_dev_clear(di, NULL);
407 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
408 const struct sr_channel_group *cg)
410 struct dev_context *devc;
411 struct sr_usb_dev_inst *usb;
426 if (usb->address == 255)
427 /* Device still needs to re-enumerate after firmware
428 * upload, so we don't know its (future) address. */
430 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
431 *data = g_variant_new_string(str);
433 case SR_CONF_LIMIT_SAMPLES:
434 *data = g_variant_new_uint64(devc->limit_samples);
436 case SR_CONF_SAMPLERATE:
437 *data = g_variant_new_uint64(devc->cur_samplerate);
439 case SR_CONF_CAPTURE_RATIO:
440 *data = g_variant_new_uint64(devc->capture_ratio);
449 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
450 const struct sr_channel_group *cg)
452 struct dev_context *devc;
462 if (sdi->status != SR_ST_ACTIVE)
470 case SR_CONF_SAMPLERATE:
471 arg = g_variant_get_uint64(data);
472 for (i = 0; i < ARRAY_SIZE(samplerates); i++) {
473 if (samplerates[i] == arg) {
474 devc->cur_samplerate = arg;
478 if (i == ARRAY_SIZE(samplerates))
481 case SR_CONF_LIMIT_SAMPLES:
482 devc->limit_samples = g_variant_get_uint64(data);
484 case SR_CONF_CAPTURE_RATIO:
485 devc->capture_ratio = g_variant_get_uint64(data);
486 if (devc->capture_ratio > 100) {
487 devc->capture_ratio = 0;
499 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
500 const struct sr_channel_group *cg)
509 case SR_CONF_SCAN_OPTIONS:
510 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
511 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
513 case SR_CONF_DEVICE_OPTIONS:
515 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
516 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
518 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
519 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
521 case SR_CONF_SAMPLERATE:
522 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
523 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
524 ARRAY_SIZE(samplerates), sizeof(uint64_t));
525 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
526 *data = g_variant_builder_end(&gvb);
528 case SR_CONF_TRIGGER_MATCH:
529 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
530 soft_trigger_matches, ARRAY_SIZE(soft_trigger_matches),
540 static int receive_data(int fd, int revents, void *cb_data)
543 struct drv_context *drvc;
551 tv.tv_sec = tv.tv_usec = 0;
552 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
557 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
559 struct dev_context *devc;
560 struct drv_context *drvc;
561 struct sr_usb_dev_inst *usb;
562 struct sr_trigger *trigger;
563 struct libusb_transfer *transfer;
564 unsigned int i, timeout, num_transfers;
569 if (sdi->status != SR_ST_ACTIVE)
570 return SR_ERR_DEV_CLOSED;
576 devc->cb_data = cb_data;
577 devc->sent_samples = 0;
578 devc->acq_aborted = FALSE;
579 devc->empty_transfer_count = 0;
581 if ((trigger = sr_session_trigger_get(sdi->session))) {
582 int pre_trigger_samples = 0;
583 if (devc->limit_samples > 0)
584 pre_trigger_samples = devc->capture_ratio * devc->limit_samples/100;
585 devc->stl = soft_trigger_logic_new(sdi, trigger, pre_trigger_samples);
586 if (devc->stl == NULL)
587 return SR_ERR_MALLOC;
588 devc->trigger_fired = FALSE;
590 devc->trigger_fired = TRUE;
592 timeout = fx2lafw_get_timeout(devc);
593 num_transfers = fx2lafw_get_number_of_transfers(devc);
594 size = fx2lafw_get_buffer_size(devc);
595 devc->submitted_transfers = 0;
597 devc->transfers = g_try_malloc0(sizeof(*devc->transfers) * num_transfers);
598 if (!devc->transfers) {
599 sr_err("USB transfers malloc failed.");
600 return SR_ERR_MALLOC;
603 devc->num_transfers = num_transfers;
604 for (i = 0; i < num_transfers; i++) {
605 if (!(buf = g_try_malloc(size))) {
606 sr_err("USB transfer buffer malloc failed.");
607 return SR_ERR_MALLOC;
609 transfer = libusb_alloc_transfer(0);
610 libusb_fill_bulk_transfer(transfer, usb->devhdl,
611 2 | LIBUSB_ENDPOINT_IN, buf, size,
612 fx2lafw_receive_transfer, (void *)sdi, timeout);
613 if ((ret = libusb_submit_transfer(transfer)) != 0) {
614 sr_err("Failed to submit transfer: %s.",
615 libusb_error_name(ret));
616 libusb_free_transfer(transfer);
618 fx2lafw_abort_acquisition(devc);
621 devc->transfers[i] = transfer;
622 devc->submitted_transfers++;
625 devc->ctx = drvc->sr_ctx;
627 usb_source_add(sdi->session, devc->ctx, timeout, receive_data, NULL);
629 /* Send header packet to the session bus. */
630 std_session_send_df_header(cb_data, LOG_PREFIX);
632 if ((ret = fx2lafw_command_start_acquisition(sdi)) != SR_OK) {
633 fx2lafw_abort_acquisition(devc);
640 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
644 fx2lafw_abort_acquisition(sdi->priv);
649 SR_PRIV struct sr_dev_driver fx2lafw_driver_info = {
651 .longname = "fx2lafw (generic driver for FX2 based LAs)",
656 .dev_list = dev_list,
658 .config_get = config_get,
659 .config_set = config_set,
660 .config_list = config_list,
661 .dev_open = dev_open,
662 .dev_close = dev_close,
663 .dev_acquisition_start = dev_acquisition_start,
664 .dev_acquisition_stop = dev_acquisition_stop,