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 "saleae-logic16-fx2.fw"
39 #define MAX_RENUM_DELAY_MS 3000
40 #define NUM_SIMUL_TRANSFERS 32
42 static const uint32_t scanopts[] = {
46 static const uint32_t devopts[] = {
47 SR_CONF_LOGIC_ANALYZER,
49 SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
50 SR_CONF_CONN | SR_CONF_GET,
51 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
52 SR_CONF_VOLTAGE_THRESHOLD | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
53 SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
54 SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
57 static const int32_t soft_trigger_matches[] = {
65 static const char *channel_names[] = {
66 "0", "1", "2", "3", "4", "5", "6", "7", "8",
67 "9", "10", "11", "12", "13", "14", "15",
71 enum voltage_range range;
74 } volt_thresholds[] = {
75 { VOLTAGE_RANGE_18_33_V, 0.7, 1.4 },
76 { VOLTAGE_RANGE_5_V, 1.4, 3.6 },
79 static const uint64_t samplerates[] = {
98 static gboolean check_conf_profile(libusb_device *dev)
100 struct libusb_device_descriptor des;
101 struct libusb_device_handle *hdl;
103 unsigned char strdesc[64];
108 /* Assume the FW has not been loaded, unless proven wrong. */
109 libusb_get_device_descriptor(dev, &des);
111 if (libusb_open(dev, &hdl) != 0)
114 if (libusb_get_string_descriptor_ascii(hdl,
115 des.iManufacturer, strdesc, sizeof(strdesc)) < 0)
117 if (strcmp((const char *)strdesc, "Saleae LLC"))
120 if (libusb_get_string_descriptor_ascii(hdl,
121 des.iProduct, strdesc, sizeof(strdesc)) < 0)
123 if (strcmp((const char *)strdesc, "Logic S/16"))
126 /* If we made it here, it must be a configured Logic16. */
135 static GSList *scan(struct sr_dev_driver *di, GSList *options)
137 struct drv_context *drvc;
138 struct dev_context *devc;
139 struct sr_dev_inst *sdi;
140 struct sr_usb_dev_inst *usb;
141 struct sr_config *src;
142 GSList *l, *devices, *conn_devices;
143 struct libusb_device_descriptor des;
144 libusb_device **devlist;
147 char connection_id[64];
152 for (l = options; l; l = l->next) {
156 conn = g_variant_get_string(src->data, NULL);
161 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
165 /* Find all Logic16 devices and upload firmware to them. */
167 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
168 for (i = 0; devlist[i]; i++) {
171 for (l = conn_devices; l; l = l->next) {
173 if (usb->bus == libusb_get_bus_number(devlist[i])
174 && usb->address == libusb_get_device_address(devlist[i]))
178 /* This device matched none of the ones that
179 * matched the conn specification. */
183 libusb_get_device_descriptor(devlist[i], &des);
185 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
187 if (des.idVendor != LOGIC16_VID || des.idProduct != LOGIC16_PID)
190 sdi = g_malloc0(sizeof(struct sr_dev_inst));
191 sdi->status = SR_ST_INITIALIZING;
192 sdi->vendor = g_strdup("Saleae");
193 sdi->model = g_strdup("Logic16");
195 sdi->connection_id = g_strdup(connection_id);
197 for (j = 0; j < ARRAY_SIZE(channel_names); j++)
198 sr_channel_new(sdi, j, SR_CHANNEL_LOGIC, TRUE,
201 devc = g_malloc0(sizeof(struct dev_context));
202 devc->selected_voltage_range = VOLTAGE_RANGE_18_33_V;
204 drvc->instances = g_slist_append(drvc->instances, sdi);
205 devices = g_slist_append(devices, sdi);
207 if (check_conf_profile(devlist[i])) {
208 /* Already has the firmware, so fix the new address. */
209 sr_dbg("Found a Logic16 device.");
210 sdi->status = SR_ST_INACTIVE;
211 sdi->inst_type = SR_INST_USB;
212 sdi->conn = sr_usb_dev_inst_new(
213 libusb_get_bus_number(devlist[i]),
214 libusb_get_device_address(devlist[i]), NULL);
216 if (ezusb_upload_firmware(drvc->sr_ctx, devlist[i],
217 USB_CONFIGURATION, FX2_FIRMWARE) == SR_OK)
218 /* Store when this device's FW was updated. */
219 devc->fw_updated = g_get_monotonic_time();
221 sr_err("Firmware upload failed.");
222 sdi->inst_type = SR_INST_USB;
223 sdi->conn = sr_usb_dev_inst_new(
224 libusb_get_bus_number(devlist[i]), 0xff, NULL);
227 libusb_free_device_list(devlist, 1);
228 g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
233 static int logic16_dev_open(struct sr_dev_inst *sdi)
235 struct sr_dev_driver *di;
236 libusb_device **devlist;
237 struct sr_usb_dev_inst *usb;
238 struct libusb_device_descriptor des;
239 struct drv_context *drvc;
240 int ret, i, device_count;
241 char connection_id[64];
247 if (sdi->status == SR_ST_ACTIVE)
248 /* Device is already in use. */
251 device_count = libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
252 if (device_count < 0) {
253 sr_err("Failed to get device list: %s.",
254 libusb_error_name(device_count));
258 for (i = 0; i < device_count; i++) {
259 libusb_get_device_descriptor(devlist[i], &des);
261 if (des.idVendor != LOGIC16_VID || des.idProduct != LOGIC16_PID)
264 if ((sdi->status == SR_ST_INITIALIZING) ||
265 (sdi->status == SR_ST_INACTIVE)) {
267 * Check device by its physical USB bus/port address.
269 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
270 if (strcmp(sdi->connection_id, connection_id))
271 /* This is not the one. */
275 if (!(ret = libusb_open(devlist[i], &usb->devhdl))) {
276 if (usb->address == 0xff)
278 * First time we touch this device after FW
279 * upload, so we don't know the address yet.
281 usb->address = libusb_get_device_address(devlist[i]);
283 sr_err("Failed to open device: %s.",
284 libusb_error_name(ret));
288 ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
289 if (ret == LIBUSB_ERROR_BUSY) {
290 sr_err("Unable to claim USB interface. Another "
291 "program or driver has already claimed it.");
293 } else if (ret == LIBUSB_ERROR_NO_DEVICE) {
294 sr_err("Device has been disconnected.");
296 } else if (ret != 0) {
297 sr_err("Unable to claim interface: %s.",
298 libusb_error_name(ret));
302 if ((ret = logic16_init_device(sdi)) != SR_OK) {
303 sr_err("Failed to init device.");
307 sdi->status = SR_ST_ACTIVE;
308 sr_info("Opened device on %d.%d (logical) / %s (physical), interface %d.",
309 usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
313 libusb_free_device_list(devlist, 1);
315 if (sdi->status != SR_ST_ACTIVE) {
317 libusb_release_interface(usb->devhdl, USB_INTERFACE);
318 libusb_close(usb->devhdl);
327 static int dev_open(struct sr_dev_inst *sdi)
329 struct dev_context *devc;
331 int64_t timediff_us, timediff_ms;
336 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
337 * milliseconds for the FX2 to renumerate.
340 if (devc->fw_updated > 0) {
341 sr_info("Waiting for device to reset.");
342 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
343 g_usleep(300 * 1000);
345 while (timediff_ms < MAX_RENUM_DELAY_MS) {
346 if ((ret = logic16_dev_open(sdi)) == SR_OK)
348 g_usleep(100 * 1000);
350 timediff_us = g_get_monotonic_time() - devc->fw_updated;
351 timediff_ms = timediff_us / 1000;
352 sr_spew("Waited %" PRIi64 "ms.", timediff_ms);
355 sr_err("Device failed to renumerate.");
358 sr_info("Device came back after %" PRIi64 "ms.", timediff_ms);
360 sr_info("Firmware upload was not needed.");
361 ret = logic16_dev_open(sdi);
365 sr_err("Unable to open device.");
369 if (devc->cur_samplerate == 0) {
370 /* Samplerate hasn't been set; default to the slowest one. */
371 devc->cur_samplerate = samplerates[0];
377 static int dev_close(struct sr_dev_inst *sdi)
379 struct sr_usb_dev_inst *usb;
385 sr_info("Closing device on %d.%d (logical) / %s (physical) interface %d.",
386 usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
387 libusb_release_interface(usb->devhdl, USB_INTERFACE);
388 libusb_close(usb->devhdl);
390 sdi->status = SR_ST_INACTIVE;
395 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
396 const struct sr_channel_group *cg)
398 struct dev_context *devc;
399 struct sr_usb_dev_inst *usb;
410 if (!sdi || !sdi->conn)
413 if (usb->address == 255)
414 /* Device still needs to re-enumerate after firmware
415 * upload, so we don't know its (future) address. */
417 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
418 *data = g_variant_new_string(str);
420 case SR_CONF_SAMPLERATE:
424 *data = g_variant_new_uint64(devc->cur_samplerate);
426 case SR_CONF_CAPTURE_RATIO:
430 *data = g_variant_new_uint64(devc->capture_ratio);
432 case SR_CONF_VOLTAGE_THRESHOLD:
437 for (i = 0; i < ARRAY_SIZE(volt_thresholds); i++) {
438 if (devc->selected_voltage_range !=
439 volt_thresholds[i].range)
441 range[0] = g_variant_new_double(volt_thresholds[i].low);
442 range[1] = g_variant_new_double(volt_thresholds[i].high);
443 *data = g_variant_new_tuple(range, 2);
455 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
456 const struct sr_channel_group *cg)
458 struct dev_context *devc;
465 if (sdi->status != SR_ST_ACTIVE)
466 return SR_ERR_DEV_CLOSED;
472 case SR_CONF_SAMPLERATE:
473 devc->cur_samplerate = g_variant_get_uint64(data);
475 case SR_CONF_LIMIT_SAMPLES:
476 devc->limit_samples = g_variant_get_uint64(data);
478 case SR_CONF_CAPTURE_RATIO:
479 devc->capture_ratio = g_variant_get_uint64(data);
480 ret = (devc->capture_ratio > 100) ? SR_ERR : SR_OK;
482 case SR_CONF_VOLTAGE_THRESHOLD:
483 g_variant_get(data, "(dd)", &low, &high);
485 for (i = 0; i < ARRAY_SIZE(volt_thresholds); i++) {
486 if (fabs(volt_thresholds[i].low - low) < 0.1 &&
487 fabs(volt_thresholds[i].high - high) < 0.1) {
488 devc->selected_voltage_range =
489 volt_thresholds[i].range;
502 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
503 const struct sr_channel_group *cg)
505 GVariant *gvar, *range[2];
515 case SR_CONF_SCAN_OPTIONS:
516 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
517 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
519 case SR_CONF_DEVICE_OPTIONS:
520 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
521 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
523 case SR_CONF_SAMPLERATE:
524 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
525 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
526 samplerates, ARRAY_SIZE(samplerates), sizeof(uint64_t));
527 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
528 *data = g_variant_builder_end(&gvb);
530 case SR_CONF_VOLTAGE_THRESHOLD:
531 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
532 for (i = 0; i < ARRAY_SIZE(volt_thresholds); i++) {
533 range[0] = g_variant_new_double(volt_thresholds[i].low);
534 range[1] = g_variant_new_double(volt_thresholds[i].high);
535 gvar = g_variant_new_tuple(range, 2);
536 g_variant_builder_add_value(&gvb, gvar);
538 *data = g_variant_builder_end(&gvb);
540 case SR_CONF_TRIGGER_MATCH:
541 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
542 soft_trigger_matches, ARRAY_SIZE(soft_trigger_matches),
552 static void abort_acquisition(struct dev_context *devc)
556 devc->sent_samples = -1;
558 for (i = devc->num_transfers - 1; i >= 0; i--) {
559 if (devc->transfers[i])
560 libusb_cancel_transfer(devc->transfers[i]);
564 static unsigned int bytes_per_ms(struct dev_context *devc)
566 return devc->cur_samplerate * devc->num_channels / 8000;
569 static size_t get_buffer_size(struct dev_context *devc)
574 * The buffer should be large enough to hold 10ms of data and
577 s = 10 * bytes_per_ms(devc);
578 return (s + 511) & ~511;
581 static unsigned int get_number_of_transfers(struct dev_context *devc)
585 /* Total buffer size should be able to hold about 500ms of data. */
586 n = 500 * bytes_per_ms(devc) / get_buffer_size(devc);
588 if (n > NUM_SIMUL_TRANSFERS)
589 return NUM_SIMUL_TRANSFERS;
594 static unsigned int get_timeout(struct dev_context *devc)
597 unsigned int timeout;
599 total_size = get_buffer_size(devc) * get_number_of_transfers(devc);
600 timeout = total_size / bytes_per_ms(devc);
601 return timeout + timeout / 4; /* Leave a headroom of 25% percent. */
604 static int configure_channels(const struct sr_dev_inst *sdi)
606 struct dev_context *devc;
607 struct sr_channel *ch;
609 uint16_t channel_bit;
613 devc->cur_channels = 0;
614 devc->num_channels = 0;
615 for (l = sdi->channels; l; l = l->next) {
616 ch = (struct sr_channel *)l->data;
617 if (ch->enabled == FALSE)
620 channel_bit = 1 << (ch->index);
622 devc->cur_channels |= channel_bit;
624 #ifdef WORDS_BIGENDIAN
626 * Output logic data should be stored in little endian format.
627 * To speed things up during conversion, do the switcharoo
630 channel_bit = 1 << (ch->index ^ 8);
633 devc->channel_masks[devc->num_channels++] = channel_bit;
639 static int receive_data(int fd, int revents, void *cb_data)
642 struct dev_context *devc;
643 struct drv_context *drvc;
644 const struct sr_dev_inst *sdi;
645 struct sr_dev_driver *di;
655 tv.tv_sec = tv.tv_usec = 0;
656 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
658 if (devc->sent_samples == -2) {
659 logic16_abort_acquisition(sdi);
660 abort_acquisition(devc);
666 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
668 struct sr_dev_driver *di = sdi->driver;
669 struct dev_context *devc;
670 struct drv_context *drvc;
671 struct sr_usb_dev_inst *usb;
672 struct sr_trigger *trigger;
673 struct libusb_transfer *transfer;
674 unsigned int i, timeout, num_transfers;
677 size_t size, convsize;
679 if (sdi->status != SR_ST_ACTIVE)
680 return SR_ERR_DEV_CLOSED;
686 /* Configures devc->cur_channels. */
687 if (configure_channels(sdi) != SR_OK) {
688 sr_err("Failed to configure channels.");
692 devc->sent_samples = 0;
693 devc->empty_transfer_count = 0;
694 devc->cur_channel = 0;
695 memset(devc->channel_data, 0, sizeof(devc->channel_data));
697 if ((trigger = sr_session_trigger_get(sdi->session))) {
698 int pre_trigger_samples = 0;
699 if (devc->limit_samples > 0)
700 pre_trigger_samples = devc->capture_ratio * devc->limit_samples/100;
701 devc->stl = soft_trigger_logic_new(sdi, trigger, pre_trigger_samples);
703 return SR_ERR_MALLOC;
704 devc->trigger_fired = FALSE;
706 devc->trigger_fired = TRUE;
708 timeout = get_timeout(devc);
709 num_transfers = get_number_of_transfers(devc);
710 size = get_buffer_size(devc);
711 convsize = (size / devc->num_channels + 2) * 16;
712 devc->submitted_transfers = 0;
714 devc->convbuffer_size = convsize;
715 if (!(devc->convbuffer = g_try_malloc(convsize))) {
716 sr_err("Conversion buffer malloc failed.");
717 return SR_ERR_MALLOC;
720 devc->transfers = g_try_malloc0(sizeof(*devc->transfers) * num_transfers);
721 if (!devc->transfers) {
722 sr_err("USB transfers malloc failed.");
723 g_free(devc->convbuffer);
724 return SR_ERR_MALLOC;
727 if ((ret = logic16_setup_acquisition(sdi, devc->cur_samplerate,
728 devc->cur_channels)) != SR_OK) {
729 g_free(devc->transfers);
730 g_free(devc->convbuffer);
734 devc->num_transfers = num_transfers;
735 for (i = 0; i < num_transfers; i++) {
736 if (!(buf = g_try_malloc(size))) {
737 sr_err("USB transfer buffer malloc failed.");
738 if (devc->submitted_transfers)
739 abort_acquisition(devc);
741 g_free(devc->transfers);
742 g_free(devc->convbuffer);
744 return SR_ERR_MALLOC;
746 transfer = libusb_alloc_transfer(0);
747 libusb_fill_bulk_transfer(transfer, usb->devhdl,
748 2 | LIBUSB_ENDPOINT_IN, buf, size,
749 logic16_receive_transfer, (void *)sdi, timeout);
750 if ((ret = libusb_submit_transfer(transfer)) != 0) {
751 sr_err("Failed to submit transfer: %s.",
752 libusb_error_name(ret));
753 libusb_free_transfer(transfer);
755 abort_acquisition(devc);
758 devc->transfers[i] = transfer;
759 devc->submitted_transfers++;
762 devc->ctx = drvc->sr_ctx;
764 usb_source_add(sdi->session, devc->ctx, timeout, receive_data, (void *)sdi);
766 std_session_send_df_header(sdi, LOG_PREFIX);
768 if ((ret = logic16_start_acquisition(sdi)) != SR_OK) {
769 abort_acquisition(devc);
776 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
780 if (sdi->status != SR_ST_ACTIVE)
781 return SR_ERR_DEV_CLOSED;
783 ret = logic16_abort_acquisition(sdi);
785 abort_acquisition(sdi->priv);
790 static struct sr_dev_driver saleae_logic16_driver_info = {
791 .name = "saleae-logic16",
792 .longname = "Saleae Logic16",
795 .cleanup = std_cleanup,
797 .dev_list = std_dev_list,
799 .config_get = config_get,
800 .config_set = config_set,
801 .config_list = config_list,
802 .dev_open = dev_open,
803 .dev_close = dev_close,
804 .dev_acquisition_start = dev_acquisition_start,
805 .dev_acquisition_stop = dev_acquisition_stop,
808 SR_REGISTER_DEV_DRIVER(saleae_logic16_driver_info);