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/>.
28 #include <libsigrok/libsigrok.h>
29 #include "libsigrok-internal.h"
32 #define LOGIC16_VID 0x21a9
33 #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;
44 static const uint32_t scanopts[] = {
48 static const uint32_t devopts[] = {
49 SR_CONF_LOGIC_ANALYZER,
51 SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
52 SR_CONF_CONN | SR_CONF_GET,
53 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
54 SR_CONF_VOLTAGE_THRESHOLD | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
55 SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
56 SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
59 static const int32_t soft_trigger_matches[] = {
67 static const char *channel_names[] = {
68 "0", "1", "2", "3", "4", "5", "6", "7", "8",
69 "9", "10", "11", "12", "13", "14", "15",
73 enum voltage_range range;
76 } volt_thresholds[] = {
77 { VOLTAGE_RANGE_18_33_V, 0.7, 1.4 },
78 { VOLTAGE_RANGE_5_V, 1.4, 3.6 },
81 static const uint64_t samplerates[] = {
98 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
100 return std_init(sr_ctx, di, LOG_PREFIX);
103 static gboolean check_conf_profile(libusb_device *dev)
105 struct libusb_device_descriptor des;
106 struct libusb_device_handle *hdl;
108 unsigned char strdesc[64];
113 /* Assume the FW has not been loaded, unless proven wrong. */
114 if (libusb_get_device_descriptor(dev, &des) != 0)
117 if (libusb_open(dev, &hdl) != 0)
120 if (libusb_get_string_descriptor_ascii(hdl,
121 des.iManufacturer, strdesc, sizeof(strdesc)) < 0)
123 if (strcmp((const char *)strdesc, "Saleae LLC"))
126 if (libusb_get_string_descriptor_ascii(hdl,
127 des.iProduct, strdesc, sizeof(strdesc)) < 0)
129 if (strcmp((const char *)strdesc, "Logic S/16"))
132 /* If we made it here, it must be a configured Logic16. */
141 static GSList *scan(struct sr_dev_driver *di, GSList *options)
143 struct drv_context *drvc;
144 struct dev_context *devc;
145 struct sr_dev_inst *sdi;
146 struct sr_usb_dev_inst *usb;
147 struct sr_config *src;
148 GSList *l, *devices, *conn_devices;
149 struct libusb_device_descriptor des;
150 libusb_device **devlist;
154 char connection_id[64];
159 for (l = options; l; l = l->next) {
163 conn = g_variant_get_string(src->data, NULL);
168 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
172 /* Find all Logic16 devices and upload firmware to them. */
174 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
175 for (i = 0; devlist[i]; i++) {
178 for (l = conn_devices; l; l = l->next) {
180 if (usb->bus == libusb_get_bus_number(devlist[i])
181 && usb->address == libusb_get_device_address(devlist[i]))
185 /* This device matched none of the ones that
186 * matched the conn specification. */
190 if ((ret = libusb_get_device_descriptor(devlist[i], &des)) != 0) {
191 sr_warn("Failed to get device descriptor: %s.",
192 libusb_error_name(ret));
196 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
198 if (des.idVendor != LOGIC16_VID || des.idProduct != LOGIC16_PID)
201 sdi = g_malloc0(sizeof(struct sr_dev_inst));
202 sdi->status = SR_ST_INITIALIZING;
203 sdi->vendor = g_strdup("Saleae");
204 sdi->model = g_strdup("Logic16");
206 sdi->connection_id = g_strdup(connection_id);
208 for (j = 0; j < ARRAY_SIZE(channel_names); j++)
209 sr_channel_new(sdi, j, SR_CHANNEL_LOGIC, TRUE,
212 devc = g_malloc0(sizeof(struct dev_context));
213 devc->selected_voltage_range = VOLTAGE_RANGE_18_33_V;
215 drvc->instances = g_slist_append(drvc->instances, sdi);
216 devices = g_slist_append(devices, sdi);
218 if (check_conf_profile(devlist[i])) {
219 /* Already has the firmware, so fix the new address. */
220 sr_dbg("Found a Logic16 device.");
221 sdi->status = SR_ST_INACTIVE;
222 sdi->inst_type = SR_INST_USB;
223 sdi->conn = sr_usb_dev_inst_new(
224 libusb_get_bus_number(devlist[i]),
225 libusb_get_device_address(devlist[i]), NULL);
227 if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
228 FX2_FIRMWARE) == SR_OK)
229 /* Store when this device's FW was updated. */
230 devc->fw_updated = g_get_monotonic_time();
232 sr_err("Firmware upload failed.");
233 sdi->inst_type = SR_INST_USB;
234 sdi->conn = sr_usb_dev_inst_new(
235 libusb_get_bus_number(devlist[i]), 0xff, NULL);
238 libusb_free_device_list(devlist, 1);
239 g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
244 static GSList *dev_list(const struct sr_dev_driver *di)
246 return ((struct drv_context *)(di->context))->instances;
249 static int logic16_dev_open(struct sr_dev_inst *sdi)
251 struct sr_dev_driver *di;
252 libusb_device **devlist;
253 struct sr_usb_dev_inst *usb;
254 struct libusb_device_descriptor des;
255 struct drv_context *drvc;
256 int ret, i, device_count;
257 char connection_id[64];
263 if (sdi->status == SR_ST_ACTIVE)
264 /* Device is already in use. */
267 device_count = libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
268 if (device_count < 0) {
269 sr_err("Failed to get device list: %s.",
270 libusb_error_name(device_count));
274 for (i = 0; i < device_count; i++) {
275 if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
276 sr_err("Failed to get device descriptor: %s.",
277 libusb_error_name(ret));
281 if (des.idVendor != LOGIC16_VID || des.idProduct != LOGIC16_PID)
284 if ((sdi->status == SR_ST_INITIALIZING) ||
285 (sdi->status == SR_ST_INACTIVE)) {
287 * Check device by its physical USB bus/port address.
289 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
290 if (strcmp(sdi->connection_id, connection_id))
291 /* This is not the one. */
295 if (!(ret = libusb_open(devlist[i], &usb->devhdl))) {
296 if (usb->address == 0xff)
298 * First time we touch this device after FW
299 * upload, so we don't know the address yet.
301 usb->address = libusb_get_device_address(devlist[i]);
303 sr_err("Failed to open device: %s.",
304 libusb_error_name(ret));
308 ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
309 if (ret == LIBUSB_ERROR_BUSY) {
310 sr_err("Unable to claim USB interface. Another "
311 "program or driver has already claimed it.");
313 } else if (ret == LIBUSB_ERROR_NO_DEVICE) {
314 sr_err("Device has been disconnected.");
316 } else if (ret != 0) {
317 sr_err("Unable to claim interface: %s.",
318 libusb_error_name(ret));
322 if ((ret = logic16_init_device(sdi)) != SR_OK) {
323 sr_err("Failed to init device.");
327 sdi->status = SR_ST_ACTIVE;
328 sr_info("Opened device on %d.%d (logical) / %s (physical), interface %d.",
329 usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
333 libusb_free_device_list(devlist, 1);
335 if (sdi->status != SR_ST_ACTIVE) {
337 libusb_release_interface(usb->devhdl, USB_INTERFACE);
338 libusb_close(usb->devhdl);
347 static int dev_open(struct sr_dev_inst *sdi)
349 struct dev_context *devc;
351 int64_t timediff_us, timediff_ms;
356 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
357 * milliseconds for the FX2 to renumerate.
360 if (devc->fw_updated > 0) {
361 sr_info("Waiting for device to reset.");
362 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
363 g_usleep(300 * 1000);
365 while (timediff_ms < MAX_RENUM_DELAY_MS) {
366 if ((ret = logic16_dev_open(sdi)) == SR_OK)
368 g_usleep(100 * 1000);
370 timediff_us = g_get_monotonic_time() - devc->fw_updated;
371 timediff_ms = timediff_us / 1000;
372 sr_spew("Waited %" PRIi64 "ms.", timediff_ms);
375 sr_err("Device failed to renumerate.");
378 sr_info("Device came back after %" PRIi64 "ms.", timediff_ms);
380 sr_info("Firmware upload was not needed.");
381 ret = logic16_dev_open(sdi);
385 sr_err("Unable to open device.");
389 if (devc->cur_samplerate == 0) {
390 /* Samplerate hasn't been set; default to the slowest one. */
391 devc->cur_samplerate = samplerates[0];
397 static int dev_close(struct sr_dev_inst *sdi)
399 struct sr_usb_dev_inst *usb;
405 sr_info("Closing device on %d.%d (logical) / %s (physical) interface %d.",
406 usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
407 libusb_release_interface(usb->devhdl, USB_INTERFACE);
408 libusb_close(usb->devhdl);
410 sdi->status = SR_ST_INACTIVE;
415 static int cleanup(const struct sr_dev_driver *di)
418 struct drv_context *drvc;
420 if (!(drvc = di->context))
421 /* Can get called on an unused driver, doesn't matter. */
424 ret = std_dev_clear(di, NULL);
430 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
431 const struct sr_channel_group *cg)
433 struct dev_context *devc;
434 struct sr_usb_dev_inst *usb;
445 if (!sdi || !sdi->conn)
448 if (usb->address == 255)
449 /* Device still needs to re-enumerate after firmware
450 * upload, so we don't know its (future) address. */
452 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
453 *data = g_variant_new_string(str);
455 case SR_CONF_SAMPLERATE:
459 *data = g_variant_new_uint64(devc->cur_samplerate);
461 case SR_CONF_CAPTURE_RATIO:
465 *data = g_variant_new_uint64(devc->capture_ratio);
467 case SR_CONF_VOLTAGE_THRESHOLD:
472 for (i = 0; i < ARRAY_SIZE(volt_thresholds); i++) {
473 if (devc->selected_voltage_range !=
474 volt_thresholds[i].range)
476 range[0] = g_variant_new_double(volt_thresholds[i].low);
477 range[1] = g_variant_new_double(volt_thresholds[i].high);
478 *data = g_variant_new_tuple(range, 2);
490 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
491 const struct sr_channel_group *cg)
493 struct dev_context *devc;
500 if (sdi->status != SR_ST_ACTIVE)
501 return SR_ERR_DEV_CLOSED;
507 case SR_CONF_SAMPLERATE:
508 devc->cur_samplerate = g_variant_get_uint64(data);
510 case SR_CONF_LIMIT_SAMPLES:
511 devc->limit_samples = g_variant_get_uint64(data);
513 case SR_CONF_CAPTURE_RATIO:
514 devc->capture_ratio = g_variant_get_uint64(data);
515 if (devc->capture_ratio > 100) {
516 devc->capture_ratio = 0;
521 case SR_CONF_VOLTAGE_THRESHOLD:
522 g_variant_get(data, "(dd)", &low, &high);
524 for (i = 0; i < ARRAY_SIZE(volt_thresholds); i++) {
525 if (fabs(volt_thresholds[i].low - low) < 0.1 &&
526 fabs(volt_thresholds[i].high - high) < 0.1) {
527 devc->selected_voltage_range =
528 volt_thresholds[i].range;
541 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
542 const struct sr_channel_group *cg)
544 GVariant *gvar, *range[2];
554 case SR_CONF_SCAN_OPTIONS:
555 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
556 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
558 case SR_CONF_DEVICE_OPTIONS:
559 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
560 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
562 case SR_CONF_SAMPLERATE:
563 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
564 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
565 samplerates, ARRAY_SIZE(samplerates), sizeof(uint64_t));
566 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
567 *data = g_variant_builder_end(&gvb);
569 case SR_CONF_VOLTAGE_THRESHOLD:
570 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
571 for (i = 0; i < ARRAY_SIZE(volt_thresholds); i++) {
572 range[0] = g_variant_new_double(volt_thresholds[i].low);
573 range[1] = g_variant_new_double(volt_thresholds[i].high);
574 gvar = g_variant_new_tuple(range, 2);
575 g_variant_builder_add_value(&gvb, gvar);
577 *data = g_variant_builder_end(&gvb);
579 case SR_CONF_TRIGGER_MATCH:
580 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
581 soft_trigger_matches, ARRAY_SIZE(soft_trigger_matches),
591 static void abort_acquisition(struct dev_context *devc)
595 devc->sent_samples = -1;
597 for (i = devc->num_transfers - 1; i >= 0; i--) {
598 if (devc->transfers[i])
599 libusb_cancel_transfer(devc->transfers[i]);
603 static unsigned int bytes_per_ms(struct dev_context *devc)
605 return devc->cur_samplerate * devc->num_channels / 8000;
608 static size_t get_buffer_size(struct dev_context *devc)
613 * The buffer should be large enough to hold 10ms of data and
616 s = 10 * bytes_per_ms(devc);
617 return (s + 511) & ~511;
620 static unsigned int get_number_of_transfers(struct dev_context *devc)
624 /* Total buffer size should be able to hold about 500ms of data. */
625 n = 500 * bytes_per_ms(devc) / get_buffer_size(devc);
627 if (n > NUM_SIMUL_TRANSFERS)
628 return NUM_SIMUL_TRANSFERS;
633 static unsigned int get_timeout(struct dev_context *devc)
636 unsigned int timeout;
638 total_size = get_buffer_size(devc) * get_number_of_transfers(devc);
639 timeout = total_size / bytes_per_ms(devc);
640 return timeout + timeout / 4; /* Leave a headroom of 25% percent. */
643 static int configure_channels(const struct sr_dev_inst *sdi)
645 struct dev_context *devc;
646 struct sr_channel *ch;
648 uint16_t channel_bit;
652 devc->cur_channels = 0;
653 devc->num_channels = 0;
654 for (l = sdi->channels; l; l = l->next) {
655 ch = (struct sr_channel *)l->data;
656 if (ch->enabled == FALSE)
659 channel_bit = 1 << (ch->index);
661 devc->cur_channels |= channel_bit;
663 #ifdef WORDS_BIGENDIAN
665 * Output logic data should be stored in little endian format.
666 * To speed things up during conversion, do the switcharoo
669 channel_bit = 1 << (ch->index ^ 8);
672 devc->channel_masks[devc->num_channels++] = channel_bit;
678 static int receive_data(int fd, int revents, void *cb_data)
681 struct dev_context *devc;
682 struct drv_context *drvc;
683 const struct sr_dev_inst *sdi;
684 struct sr_dev_driver *di;
694 tv.tv_sec = tv.tv_usec = 0;
695 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
697 if (devc->sent_samples == -2) {
698 logic16_abort_acquisition(sdi);
699 abort_acquisition(devc);
705 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
707 struct sr_dev_driver *di = sdi->driver;
708 struct dev_context *devc;
709 struct drv_context *drvc;
710 struct sr_usb_dev_inst *usb;
711 struct sr_trigger *trigger;
712 struct libusb_transfer *transfer;
713 unsigned int i, timeout, num_transfers;
716 size_t size, convsize;
718 if (sdi->status != SR_ST_ACTIVE)
719 return SR_ERR_DEV_CLOSED;
725 /* Configures devc->cur_channels. */
726 if (configure_channels(sdi) != SR_OK) {
727 sr_err("Failed to configure channels.");
731 devc->cb_data = cb_data;
732 devc->sent_samples = 0;
733 devc->empty_transfer_count = 0;
734 devc->cur_channel = 0;
735 memset(devc->channel_data, 0, sizeof(devc->channel_data));
737 if ((trigger = sr_session_trigger_get(sdi->session))) {
738 int pre_trigger_samples = 0;
739 if (devc->limit_samples > 0)
740 pre_trigger_samples = devc->capture_ratio * devc->limit_samples/100;
741 devc->stl = soft_trigger_logic_new(sdi, trigger, pre_trigger_samples);
743 return SR_ERR_MALLOC;
744 devc->trigger_fired = FALSE;
746 devc->trigger_fired = TRUE;
748 timeout = get_timeout(devc);
749 num_transfers = get_number_of_transfers(devc);
750 size = get_buffer_size(devc);
751 convsize = (size / devc->num_channels + 2) * 16;
752 devc->submitted_transfers = 0;
754 devc->convbuffer_size = convsize;
755 if (!(devc->convbuffer = g_try_malloc(convsize))) {
756 sr_err("Conversion buffer malloc failed.");
757 return SR_ERR_MALLOC;
760 devc->transfers = g_try_malloc0(sizeof(*devc->transfers) * num_transfers);
761 if (!devc->transfers) {
762 sr_err("USB transfers malloc failed.");
763 g_free(devc->convbuffer);
764 return SR_ERR_MALLOC;
767 if ((ret = logic16_setup_acquisition(sdi, devc->cur_samplerate,
768 devc->cur_channels)) != SR_OK) {
769 g_free(devc->transfers);
770 g_free(devc->convbuffer);
774 devc->num_transfers = num_transfers;
775 for (i = 0; i < num_transfers; i++) {
776 if (!(buf = g_try_malloc(size))) {
777 sr_err("USB transfer buffer malloc failed.");
778 if (devc->submitted_transfers)
779 abort_acquisition(devc);
781 g_free(devc->transfers);
782 g_free(devc->convbuffer);
784 return SR_ERR_MALLOC;
786 transfer = libusb_alloc_transfer(0);
787 libusb_fill_bulk_transfer(transfer, usb->devhdl,
788 2 | LIBUSB_ENDPOINT_IN, buf, size,
789 logic16_receive_transfer, (void *)sdi, timeout);
790 if ((ret = libusb_submit_transfer(transfer)) != 0) {
791 sr_err("Failed to submit transfer: %s.",
792 libusb_error_name(ret));
793 libusb_free_transfer(transfer);
795 abort_acquisition(devc);
798 devc->transfers[i] = transfer;
799 devc->submitted_transfers++;
802 devc->ctx = drvc->sr_ctx;
804 usb_source_add(sdi->session, devc->ctx, timeout, receive_data, (void *)sdi);
806 /* Send header packet to the session bus. */
807 std_session_send_df_header(cb_data, LOG_PREFIX);
809 if ((ret = logic16_start_acquisition(sdi)) != SR_OK) {
810 abort_acquisition(devc);
817 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
823 if (sdi->status != SR_ST_ACTIVE)
824 return SR_ERR_DEV_CLOSED;
826 ret = logic16_abort_acquisition(sdi);
828 abort_acquisition(sdi->priv);
833 SR_PRIV struct sr_dev_driver saleae_logic16_driver_info = {
834 .name = "saleae-logic16",
835 .longname = "Saleae Logic16",
840 .dev_list = dev_list,
842 .config_get = config_get,
843 .config_set = config_set,
844 .config_list = config_list,
845 .dev_open = dev_open,
846 .dev_close = dev_close,
847 .dev_acquisition_start = dev_acquisition_start,
848 .dev_acquisition_stop = dev_acquisition_stop,