2 * This file is part of the libsigrok project.
4 * Copyright (C) 2013 Marcus Comstedt <marcus@mc.pp.se>
5 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
6 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
8 * This program is free software: you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation, either version 3 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
27 #include "libsigrok.h"
28 #include "libsigrok-internal.h"
31 #define LOGIC16_VID 0x21a9
32 #define LOGIC16_PID 0x1001
35 #define USB_INTERFACE 0
36 #define USB_CONFIGURATION 1
37 #define FX2_FIRMWARE FIRMWARE_DIR "/saleae-logic16-fx2.fw"
39 #define MAX_RENUM_DELAY_MS 3000
40 #define NUM_SIMUL_TRANSFERS 32
42 SR_PRIV struct sr_dev_driver saleae_logic16_driver_info;
43 static struct sr_dev_driver *di = &saleae_logic16_driver_info;
45 static const int32_t hwopts[] = {
49 static const int32_t hwcaps[] = {
50 SR_CONF_LOGIC_ANALYZER,
52 SR_CONF_VOLTAGE_THRESHOLD,
54 /* These are really implemented in the driver, not the hardware. */
55 SR_CONF_LIMIT_SAMPLES,
59 static const char *probe_names[NUM_PROBES + 1] = {
60 "0", "1", "2", "3", "4", "5", "6", "7", "8",
61 "9", "10", "11", "12", "13", "14", "15",
66 enum voltage_range range;
69 } volt_thresholds[] = {
70 { VOLTAGE_RANGE_18_33_V, 0.7, 1.4 },
71 { VOLTAGE_RANGE_5_V, 1.4, 3.6 },
74 static const uint64_t samplerates[] = {
91 static int init(struct sr_context *sr_ctx)
93 return std_init(sr_ctx, di, LOG_PREFIX);
96 static gboolean check_conf_profile(libusb_device *dev)
98 struct libusb_device_descriptor des;
99 struct libusb_device_handle *hdl;
101 unsigned char strdesc[64];
106 /* Assume the FW has not been loaded, unless proven wrong. */
107 if (libusb_get_device_descriptor(dev, &des) != 0)
110 if (libusb_open(dev, &hdl) != 0)
113 if (libusb_get_string_descriptor_ascii(hdl,
114 des.iManufacturer, strdesc, sizeof(strdesc)) < 0)
116 if (strcmp((const char *)strdesc, "Saleae LLC"))
119 if (libusb_get_string_descriptor_ascii(hdl,
120 des.iProduct, strdesc, sizeof(strdesc)) < 0)
122 if (strcmp((const char *)strdesc, "Logic S/16"))
125 /* If we made it here, it must be a configured Logic16. */
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_probe *probe;
141 struct sr_config *src;
142 GSList *l, *devices, *conn_devices;
143 struct libusb_device_descriptor des;
144 libusb_device **devlist;
145 int devcnt, ret, i, j;
151 for (l = options; l; l = l->next) {
155 conn = g_variant_get_string(src->data, NULL);
160 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
164 /* Find all Logic16 devices and upload firmware to them. */
166 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
167 for (i = 0; devlist[i]; i++) {
170 for (l = conn_devices; l; l = l->next) {
172 if (usb->bus == libusb_get_bus_number(devlist[i])
173 && usb->address == libusb_get_device_address(devlist[i]))
177 /* This device matched none of the ones that
178 * matched the conn specification. */
182 if ((ret = libusb_get_device_descriptor(devlist[i], &des)) != 0) {
183 sr_warn("Failed to get device descriptor: %s.",
184 libusb_error_name(ret));
188 if (des.idVendor != LOGIC16_VID || des.idProduct != LOGIC16_PID)
191 devcnt = g_slist_length(drvc->instances);
192 sdi = sr_dev_inst_new(devcnt, SR_ST_INITIALIZING,
193 "Saleae", "Logic16", NULL);
198 for (j = 0; probe_names[j]; j++) {
199 if (!(probe = sr_probe_new(j, SR_PROBE_LOGIC, TRUE,
202 sdi->probes = g_slist_append(sdi->probes, probe);
205 if (!(devc = g_try_malloc0(sizeof(struct dev_context))))
207 devc->selected_voltage_range = VOLTAGE_RANGE_18_33_V;
209 drvc->instances = g_slist_append(drvc->instances, sdi);
210 devices = g_slist_append(devices, sdi);
212 if (check_conf_profile(devlist[i])) {
213 /* Already has the firmware, so fix the new address. */
214 sr_dbg("Found a Logic16 device.");
215 sdi->status = SR_ST_INACTIVE;
216 sdi->inst_type = SR_INST_USB;
217 sdi->conn = sr_usb_dev_inst_new(
218 libusb_get_bus_number(devlist[i]),
219 libusb_get_device_address(devlist[i]), NULL);
221 if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
222 FX2_FIRMWARE) == SR_OK)
223 /* Store when this device's FW was updated. */
224 devc->fw_updated = g_get_monotonic_time();
226 sr_err("Firmware upload failed for "
227 "device %d.", devcnt);
228 sdi->inst_type = SR_INST_USB;
229 sdi->conn = sr_usb_dev_inst_new(
230 libusb_get_bus_number(devlist[i]), 0xff, NULL);
233 libusb_free_device_list(devlist, 1);
234 g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
239 static GSList *dev_list(void)
241 return ((struct drv_context *)(di->priv))->instances;
244 static int dev_clear(void)
246 return std_dev_clear(di, NULL);
249 static int logic16_dev_open(struct sr_dev_inst *sdi)
251 libusb_device **devlist;
252 struct sr_usb_dev_inst *usb;
253 struct libusb_device_descriptor des;
254 struct drv_context *drvc;
255 int ret, skip, i, device_count;
260 if (sdi->status == SR_ST_ACTIVE)
261 /* Device is already in use. */
265 device_count = libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
266 if (device_count < 0) {
267 sr_err("Failed to get device list: %s.",
268 libusb_error_name(device_count));
272 for (i = 0; i < device_count; i++) {
273 if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
274 sr_err("Failed to get device descriptor: %s.",
275 libusb_error_name(ret));
279 if (des.idVendor != LOGIC16_VID || des.idProduct != LOGIC16_PID)
282 if (sdi->status == SR_ST_INITIALIZING) {
283 if (skip != sdi->index) {
284 /* Skip devices of this type that aren't the one we want. */
288 } else if (sdi->status == SR_ST_INACTIVE) {
290 * This device is fully enumerated, so we need to find
291 * this device by vendor, product, bus and address.
293 if (libusb_get_bus_number(devlist[i]) != usb->bus
294 || libusb_get_device_address(devlist[i]) != usb->address)
295 /* This is not the one. */
299 if (!(ret = libusb_open(devlist[i], &usb->devhdl))) {
300 if (usb->address == 0xff)
302 * First time we touch this device after FW
303 * upload, so we don't know the address yet.
305 usb->address = libusb_get_device_address(devlist[i]);
307 sr_err("Failed to open device: %s.",
308 libusb_error_name(ret));
312 if ((ret = logic16_init_device(sdi)) != SR_OK) {
313 sr_err("Failed to init device.");
317 sdi->status = SR_ST_ACTIVE;
318 sr_info("Opened device %d on %d.%d, interface %d.",
319 sdi->index, usb->bus, usb->address, USB_INTERFACE);
323 libusb_free_device_list(devlist, 1);
325 if (sdi->status != SR_ST_ACTIVE)
331 static int dev_open(struct sr_dev_inst *sdi)
333 struct sr_usb_dev_inst *usb;
334 struct dev_context *devc;
336 int64_t timediff_us, timediff_ms;
342 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
343 * milliseconds for the FX2 to renumerate.
346 if (devc->fw_updated > 0) {
347 sr_info("Waiting for device to reset.");
348 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
349 g_usleep(300 * 1000);
351 while (timediff_ms < MAX_RENUM_DELAY_MS) {
352 if ((ret = logic16_dev_open(sdi)) == SR_OK)
354 g_usleep(100 * 1000);
356 timediff_us = g_get_monotonic_time() - devc->fw_updated;
357 timediff_ms = timediff_us / 1000;
358 sr_spew("Waited %" PRIi64 "ms.", timediff_ms);
361 sr_err("Device failed to renumerate.");
364 sr_info("Device came back after %" PRIi64 "ms.", timediff_ms);
366 sr_info("Firmware upload was not needed.");
367 ret = logic16_dev_open(sdi);
371 sr_err("Unable to open device.");
375 ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
378 case LIBUSB_ERROR_BUSY:
379 sr_err("Unable to claim USB interface. Another "
380 "program or driver has already claimed it.");
382 case LIBUSB_ERROR_NO_DEVICE:
383 sr_err("Device has been disconnected.");
386 sr_err("Unable to claim interface: %s.",
387 libusb_error_name(ret));
394 if (devc->cur_samplerate == 0) {
395 /* Samplerate hasn't been set; default to the slowest one. */
396 devc->cur_samplerate = samplerates[0];
402 static int dev_close(struct sr_dev_inst *sdi)
404 struct sr_usb_dev_inst *usb;
407 if (usb->devhdl == NULL)
410 sr_info("Closing device %d on %d.%d interface %d.",
411 sdi->index, usb->bus, usb->address, USB_INTERFACE);
412 libusb_release_interface(usb->devhdl, USB_INTERFACE);
413 libusb_close(usb->devhdl);
415 sdi->status = SR_ST_INACTIVE;
420 static int cleanup(void)
423 struct drv_context *drvc;
425 if (!(drvc = di->priv))
426 /* Can get called on an unused driver, doesn't matter. */
436 static int config_get(int key, GVariant **data, const struct sr_dev_inst *sdi)
438 struct dev_context *devc;
439 struct sr_usb_dev_inst *usb;
448 if (!sdi || !sdi->conn)
451 if (usb->address == 255)
452 /* Device still needs to re-enumerate after firmware
453 * upload, so we don't know its (future) address. */
455 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
456 *data = g_variant_new_string(str);
458 case SR_CONF_SAMPLERATE:
462 *data = g_variant_new_uint64(devc->cur_samplerate);
464 case SR_CONF_VOLTAGE_THRESHOLD:
469 for (i = 0; i < ARRAY_SIZE(volt_thresholds); i++) {
470 if (devc->selected_voltage_range !=
471 volt_thresholds[i].range)
473 range[0] = g_variant_new_double(volt_thresholds[i].low);
474 range[1] = g_variant_new_double(volt_thresholds[i].high);
475 *data = g_variant_new_tuple(range, 2);
487 static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi)
489 struct dev_context *devc;
494 if (sdi->status != SR_ST_ACTIVE)
495 return SR_ERR_DEV_CLOSED;
501 case SR_CONF_SAMPLERATE:
502 devc->cur_samplerate = g_variant_get_uint64(data);
504 case SR_CONF_LIMIT_SAMPLES:
505 devc->limit_samples = g_variant_get_uint64(data);
507 case SR_CONF_VOLTAGE_THRESHOLD:
508 g_variant_get(data, "(dd)", &low, &high);
510 for (i = 0; i < ARRAY_SIZE(volt_thresholds); i++) {
511 if (fabs(volt_thresholds[i].low - low) < 0.1 &&
512 fabs(volt_thresholds[i].high - high) < 0.1) {
513 devc->selected_voltage_range =
514 volt_thresholds[i].range;
527 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
529 GVariant *gvar, *range[2];
538 case SR_CONF_SCAN_OPTIONS:
539 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
540 hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
542 case SR_CONF_DEVICE_OPTIONS:
543 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
544 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
546 case SR_CONF_SAMPLERATE:
547 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
548 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
549 samplerates, ARRAY_SIZE(samplerates), sizeof(uint64_t));
550 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
551 *data = g_variant_builder_end(&gvb);
553 case SR_CONF_VOLTAGE_THRESHOLD:
554 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
555 for (i = 0; i < ARRAY_SIZE(volt_thresholds); i++) {
556 range[0] = g_variant_new_double(volt_thresholds[i].low);
557 range[1] = g_variant_new_double(volt_thresholds[i].high);
558 gvar = g_variant_new_tuple(range, 2);
559 g_variant_builder_add_value(&gvb, gvar);
561 *data = g_variant_builder_end(&gvb);
570 static void abort_acquisition(struct dev_context *devc)
574 devc->num_samples = -1;
576 for (i = devc->num_transfers - 1; i >= 0; i--) {
577 if (devc->transfers[i])
578 libusb_cancel_transfer(devc->transfers[i]);
582 static unsigned int bytes_per_ms(struct dev_context *devc)
584 return devc->cur_samplerate * devc->num_channels / 8000;
587 static size_t get_buffer_size(struct dev_context *devc)
592 * The buffer should be large enough to hold 10ms of data and
595 s = 10 * bytes_per_ms(devc);
596 return (s + 511) & ~511;
599 static unsigned int get_number_of_transfers(struct dev_context *devc)
603 /* Total buffer size should be able to hold about 500ms of data. */
604 n = 500 * bytes_per_ms(devc) / get_buffer_size(devc);
606 if (n > NUM_SIMUL_TRANSFERS)
607 return NUM_SIMUL_TRANSFERS;
612 static unsigned int get_timeout(struct dev_context *devc)
615 unsigned int timeout;
617 total_size = get_buffer_size(devc) * get_number_of_transfers(devc);
618 timeout = total_size / bytes_per_ms(devc);
619 return timeout + timeout / 4; /* Leave a headroom of 25% percent. */
622 static int configure_probes(const struct sr_dev_inst *sdi)
624 struct dev_context *devc;
625 struct sr_probe *probe;
631 devc->cur_channels = 0;
632 devc->num_channels = 0;
633 for (l = sdi->probes; l; l = l->next) {
634 probe = (struct sr_probe *)l->data;
635 if (probe->enabled == FALSE)
638 probe_bit = 1 << (probe->index);
640 devc->cur_channels |= probe_bit;
642 #ifdef WORDS_BIGENDIAN
644 * Output logic data should be stored in little endian format.
645 * To speed things up during conversion, do the switcharoo
648 probe_bit = 1 << (probe->index ^ 8);
651 devc->channel_masks[devc->num_channels++] = probe_bit;
657 static int receive_data(int fd, int revents, void *cb_data)
660 struct dev_context *devc;
661 struct drv_context *drvc;
662 const struct sr_dev_inst *sdi;
671 tv.tv_sec = tv.tv_usec = 0;
672 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
674 if (devc->num_samples == -2) {
675 logic16_abort_acquisition(sdi);
676 abort_acquisition(devc);
682 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
684 struct dev_context *devc;
685 struct drv_context *drvc;
686 struct sr_usb_dev_inst *usb;
687 struct libusb_transfer *transfer;
688 const struct libusb_pollfd **lupfd;
689 unsigned int i, timeout, num_transfers;
692 size_t size, convsize;
694 if (sdi->status != SR_ST_ACTIVE)
695 return SR_ERR_DEV_CLOSED;
701 /* Configures devc->cur_channels. */
702 if (configure_probes(sdi) != SR_OK) {
703 sr_err("Failed to configure probes.");
707 devc->cb_data = cb_data;
708 devc->num_samples = 0;
709 devc->empty_transfer_count = 0;
710 devc->cur_channel = 0;
711 memset(devc->channel_data, 0, sizeof(devc->channel_data));
713 timeout = get_timeout(devc);
714 num_transfers = get_number_of_transfers(devc);
715 size = get_buffer_size(devc);
716 convsize = (size / devc->num_channels + 2) * 16;
717 devc->submitted_transfers = 0;
720 devc->convbuffer_size = convsize;
721 if (!(devc->convbuffer = g_try_malloc(convsize))) {
722 sr_err("Conversion buffer malloc failed.");
723 return SR_ERR_MALLOC;
726 devc->transfers = g_try_malloc0(sizeof(*devc->transfers) * num_transfers);
727 if (!devc->transfers) {
728 sr_err("USB transfers malloc failed.");
729 g_free(devc->convbuffer);
730 return SR_ERR_MALLOC;
733 if ((ret = logic16_setup_acquisition(sdi, devc->cur_samplerate,
734 devc->cur_channels)) != SR_OK) {
735 g_free(devc->transfers);
736 g_free(devc->convbuffer);
740 devc->num_transfers = num_transfers;
741 for (i = 0; i < num_transfers; i++) {
742 if (!(buf = g_try_malloc(size))) {
743 sr_err("USB transfer buffer malloc failed.");
744 if (devc->submitted_transfers)
745 abort_acquisition(devc);
747 g_free(devc->transfers);
748 g_free(devc->convbuffer);
750 return SR_ERR_MALLOC;
752 transfer = libusb_alloc_transfer(0);
753 libusb_fill_bulk_transfer(transfer, usb->devhdl,
754 2 | LIBUSB_ENDPOINT_IN, buf, size,
755 logic16_receive_transfer, devc, timeout);
756 if ((ret = libusb_submit_transfer(transfer)) != 0) {
757 sr_err("Failed to submit transfer: %s.",
758 libusb_error_name(ret));
759 libusb_free_transfer(transfer);
761 abort_acquisition(devc);
764 devc->transfers[i] = transfer;
765 devc->submitted_transfers++;
768 lupfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
769 for (i = 0; lupfd[i]; i++);
770 devc->usbfd = g_try_malloc(sizeof(struct libusb_pollfd) * (i + 1));
772 abort_acquisition(devc);
776 for (i = 0; lupfd[i]; i++) {
777 sr_source_add(lupfd[i]->fd, lupfd[i]->events,
778 timeout, receive_data, (void *)sdi);
779 devc->usbfd[i] = lupfd[i]->fd;
784 /* Send header packet to the session bus. */
785 std_session_send_df_header(cb_data, LOG_PREFIX);
787 if ((ret = logic16_start_acquisition(sdi)) != SR_OK) {
788 abort_acquisition(devc);
795 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
801 if (sdi->status != SR_ST_ACTIVE)
802 return SR_ERR_DEV_CLOSED;
804 ret = logic16_abort_acquisition(sdi);
806 abort_acquisition(sdi->priv);
811 SR_PRIV struct sr_dev_driver saleae_logic16_driver_info = {
812 .name = "saleae-logic16",
813 .longname = "Saleae Logic16",
818 .dev_list = dev_list,
819 .dev_clear = dev_clear,
820 .config_get = config_get,
821 .config_set = config_set,
822 .config_list = config_list,
823 .dev_open = dev_open,
824 .dev_close = dev_close,
825 .dev_acquisition_start = dev_acquisition_start,
826 .dev_acquisition_stop = dev_acquisition_stop,