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
34 #define USB_INTERFACE 0
35 #define USB_CONFIGURATION 1
36 #define FX2_FIRMWARE FIRMWARE_DIR "/saleae-logic16-fx2.fw"
38 #define MAX_RENUM_DELAY_MS 3000
39 #define NUM_SIMUL_TRANSFERS 32
41 SR_PRIV struct sr_dev_driver saleae_logic16_driver_info;
42 static struct sr_dev_driver *di = &saleae_logic16_driver_info;
44 static const int32_t hwopts[] = {
48 static const int32_t hwcaps[] = {
49 SR_CONF_LOGIC_ANALYZER,
51 SR_CONF_VOLTAGE_THRESHOLD,
52 SR_CONF_TRIGGER_MATCH,
54 /* These are really implemented in the driver, not the hardware. */
55 SR_CONF_LIMIT_SAMPLES,
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",
74 enum voltage_range range;
77 } volt_thresholds[] = {
78 { VOLTAGE_RANGE_18_33_V, 0.7, 1.4 },
79 { VOLTAGE_RANGE_5_V, 1.4, 3.6 },
82 static const uint64_t samplerates[] = {
99 static int init(struct sr_context *sr_ctx)
101 return std_init(sr_ctx, di, LOG_PREFIX);
104 static gboolean check_conf_profile(libusb_device *dev)
106 struct libusb_device_descriptor des;
107 struct libusb_device_handle *hdl;
109 unsigned char strdesc[64];
114 /* Assume the FW has not been loaded, unless proven wrong. */
115 if (libusb_get_device_descriptor(dev, &des) != 0)
118 if (libusb_open(dev, &hdl) != 0)
121 if (libusb_get_string_descriptor_ascii(hdl,
122 des.iManufacturer, strdesc, sizeof(strdesc)) < 0)
124 if (strcmp((const char *)strdesc, "Saleae LLC"))
127 if (libusb_get_string_descriptor_ascii(hdl,
128 des.iProduct, strdesc, sizeof(strdesc)) < 0)
130 if (strcmp((const char *)strdesc, "Logic S/16"))
133 /* If we made it here, it must be a configured Logic16. */
142 static GSList *scan(GSList *options)
144 struct drv_context *drvc;
145 struct dev_context *devc;
146 struct sr_dev_inst *sdi;
147 struct sr_usb_dev_inst *usb;
148 struct sr_channel *ch;
149 struct sr_config *src;
150 GSList *l, *devices, *conn_devices;
151 struct libusb_device_descriptor des;
152 libusb_device **devlist;
153 int devcnt, ret, i, j;
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 if (des.idVendor != LOGIC16_VID || des.idProduct != LOGIC16_PID)
199 devcnt = g_slist_length(drvc->instances);
200 sdi = sr_dev_inst_new(devcnt, SR_ST_INITIALIZING,
201 "Saleae", "Logic16", NULL);
206 for (j = 0; channel_names[j]; j++) {
207 if (!(ch = sr_channel_new(j, SR_CHANNEL_LOGIC, TRUE,
210 sdi->channels = g_slist_append(sdi->channels, ch);
213 if (!(devc = g_try_malloc0(sizeof(struct dev_context))))
215 devc->selected_voltage_range = VOLTAGE_RANGE_18_33_V;
217 drvc->instances = g_slist_append(drvc->instances, sdi);
218 devices = g_slist_append(devices, sdi);
220 if (check_conf_profile(devlist[i])) {
221 /* Already has the firmware, so fix the new address. */
222 sr_dbg("Found a Logic16 device.");
223 sdi->status = SR_ST_INACTIVE;
224 sdi->inst_type = SR_INST_USB;
225 sdi->conn = sr_usb_dev_inst_new(
226 libusb_get_bus_number(devlist[i]),
227 libusb_get_device_address(devlist[i]), NULL);
229 if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
230 FX2_FIRMWARE) == SR_OK)
231 /* Store when this device's FW was updated. */
232 devc->fw_updated = g_get_monotonic_time();
234 sr_err("Firmware upload failed for "
235 "device %d.", devcnt);
236 sdi->inst_type = SR_INST_USB;
237 sdi->conn = sr_usb_dev_inst_new(
238 libusb_get_bus_number(devlist[i]), 0xff, NULL);
241 libusb_free_device_list(devlist, 1);
242 g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
247 static GSList *dev_list(void)
249 return ((struct drv_context *)(di->priv))->instances;
252 static int logic16_dev_open(struct sr_dev_inst *sdi)
254 libusb_device **devlist;
255 struct sr_usb_dev_inst *usb;
256 struct libusb_device_descriptor des;
257 struct drv_context *drvc;
258 int ret, skip, i, device_count;
263 if (sdi->status == SR_ST_ACTIVE)
264 /* Device is already in use. */
268 device_count = libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
269 if (device_count < 0) {
270 sr_err("Failed to get device list: %s.",
271 libusb_error_name(device_count));
275 for (i = 0; i < device_count; i++) {
276 if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
277 sr_err("Failed to get device descriptor: %s.",
278 libusb_error_name(ret));
282 if (des.idVendor != LOGIC16_VID || des.idProduct != LOGIC16_PID)
285 if (sdi->status == SR_ST_INITIALIZING) {
286 if (skip != sdi->index) {
287 /* Skip devices of this type that aren't the one we want. */
291 } else if (sdi->status == SR_ST_INACTIVE) {
293 * This device is fully enumerated, so we need to find
294 * this device by vendor, product, bus and address.
296 if (libusb_get_bus_number(devlist[i]) != usb->bus
297 || libusb_get_device_address(devlist[i]) != usb->address)
298 /* This is not the one. */
302 if (!(ret = libusb_open(devlist[i], &usb->devhdl))) {
303 if (usb->address == 0xff)
305 * First time we touch this device after FW
306 * upload, so we don't know the address yet.
308 usb->address = libusb_get_device_address(devlist[i]);
310 sr_err("Failed to open device: %s.",
311 libusb_error_name(ret));
315 ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
316 if (ret == LIBUSB_ERROR_BUSY) {
317 sr_err("Unable to claim USB interface. Another "
318 "program or driver has already claimed it.");
320 } else if (ret == LIBUSB_ERROR_NO_DEVICE) {
321 sr_err("Device has been disconnected.");
323 } else if (ret != 0) {
324 sr_err("Unable to claim interface: %s.",
325 libusb_error_name(ret));
329 if ((ret = logic16_init_device(sdi)) != SR_OK) {
330 sr_err("Failed to init device.");
334 sdi->status = SR_ST_ACTIVE;
335 sr_info("Opened device %d on %d.%d, interface %d.",
336 sdi->index, usb->bus, usb->address, USB_INTERFACE);
340 libusb_free_device_list(devlist, 1);
342 if (sdi->status != SR_ST_ACTIVE) {
344 libusb_release_interface(usb->devhdl, USB_INTERFACE);
345 libusb_close(usb->devhdl);
354 static int dev_open(struct sr_dev_inst *sdi)
356 struct dev_context *devc;
358 int64_t timediff_us, timediff_ms;
363 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
364 * milliseconds for the FX2 to renumerate.
367 if (devc->fw_updated > 0) {
368 sr_info("Waiting for device to reset.");
369 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
370 g_usleep(300 * 1000);
372 while (timediff_ms < MAX_RENUM_DELAY_MS) {
373 if ((ret = logic16_dev_open(sdi)) == SR_OK)
375 g_usleep(100 * 1000);
377 timediff_us = g_get_monotonic_time() - devc->fw_updated;
378 timediff_ms = timediff_us / 1000;
379 sr_spew("Waited %" PRIi64 "ms.", timediff_ms);
382 sr_err("Device failed to renumerate.");
385 sr_info("Device came back after %" PRIi64 "ms.", timediff_ms);
387 sr_info("Firmware upload was not needed.");
388 ret = logic16_dev_open(sdi);
392 sr_err("Unable to open device.");
396 if (devc->cur_samplerate == 0) {
397 /* Samplerate hasn't been set; default to the slowest one. */
398 devc->cur_samplerate = samplerates[0];
404 static int dev_close(struct sr_dev_inst *sdi)
406 struct sr_usb_dev_inst *usb;
409 if (usb->devhdl == NULL)
412 sr_info("Closing device %d on %d.%d interface %d.",
413 sdi->index, usb->bus, usb->address, USB_INTERFACE);
414 libusb_release_interface(usb->devhdl, USB_INTERFACE);
415 libusb_close(usb->devhdl);
417 sdi->status = SR_ST_INACTIVE;
422 static int cleanup(void)
425 struct drv_context *drvc;
427 if (!(drvc = di->priv))
428 /* Can get called on an unused driver, doesn't matter. */
432 ret = std_dev_clear(di, NULL);
439 static int config_get(int key, GVariant **data, const struct sr_dev_inst *sdi,
440 const struct sr_channel_group *cg)
442 struct dev_context *devc;
443 struct sr_usb_dev_inst *usb;
454 if (!sdi || !sdi->conn)
457 if (usb->address == 255)
458 /* Device still needs to re-enumerate after firmware
459 * upload, so we don't know its (future) address. */
461 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
462 *data = g_variant_new_string(str);
464 case SR_CONF_SAMPLERATE:
468 *data = g_variant_new_uint64(devc->cur_samplerate);
470 case SR_CONF_VOLTAGE_THRESHOLD:
475 for (i = 0; i < ARRAY_SIZE(volt_thresholds); i++) {
476 if (devc->selected_voltage_range !=
477 volt_thresholds[i].range)
479 range[0] = g_variant_new_double(volt_thresholds[i].low);
480 range[1] = g_variant_new_double(volt_thresholds[i].high);
481 *data = g_variant_new_tuple(range, 2);
493 static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi,
494 const struct sr_channel_group *cg)
496 struct dev_context *devc;
503 if (sdi->status != SR_ST_ACTIVE)
504 return SR_ERR_DEV_CLOSED;
510 case SR_CONF_SAMPLERATE:
511 devc->cur_samplerate = g_variant_get_uint64(data);
513 case SR_CONF_LIMIT_SAMPLES:
514 devc->limit_samples = g_variant_get_uint64(data);
516 case SR_CONF_VOLTAGE_THRESHOLD:
517 g_variant_get(data, "(dd)", &low, &high);
519 for (i = 0; i < ARRAY_SIZE(volt_thresholds); i++) {
520 if (fabs(volt_thresholds[i].low - low) < 0.1 &&
521 fabs(volt_thresholds[i].high - high) < 0.1) {
522 devc->selected_voltage_range =
523 volt_thresholds[i].range;
536 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
537 const struct sr_channel_group *cg)
539 GVariant *gvar, *range[2];
549 case SR_CONF_SCAN_OPTIONS:
550 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
551 hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
553 case SR_CONF_DEVICE_OPTIONS:
554 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
555 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
557 case SR_CONF_SAMPLERATE:
558 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
559 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
560 samplerates, ARRAY_SIZE(samplerates), sizeof(uint64_t));
561 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
562 *data = g_variant_builder_end(&gvb);
564 case SR_CONF_VOLTAGE_THRESHOLD:
565 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
566 for (i = 0; i < ARRAY_SIZE(volt_thresholds); i++) {
567 range[0] = g_variant_new_double(volt_thresholds[i].low);
568 range[1] = g_variant_new_double(volt_thresholds[i].high);
569 gvar = g_variant_new_tuple(range, 2);
570 g_variant_builder_add_value(&gvb, gvar);
572 *data = g_variant_builder_end(&gvb);
574 case SR_CONF_TRIGGER_MATCH:
575 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
576 soft_trigger_matches, ARRAY_SIZE(soft_trigger_matches),
586 static void abort_acquisition(struct dev_context *devc)
590 devc->sent_samples = -1;
592 for (i = devc->num_transfers - 1; i >= 0; i--) {
593 if (devc->transfers[i])
594 libusb_cancel_transfer(devc->transfers[i]);
598 static unsigned int bytes_per_ms(struct dev_context *devc)
600 return devc->cur_samplerate * devc->num_channels / 8000;
603 static size_t get_buffer_size(struct dev_context *devc)
608 * The buffer should be large enough to hold 10ms of data and
611 s = 10 * bytes_per_ms(devc);
612 return (s + 511) & ~511;
615 static unsigned int get_number_of_transfers(struct dev_context *devc)
619 /* Total buffer size should be able to hold about 500ms of data. */
620 n = 500 * bytes_per_ms(devc) / get_buffer_size(devc);
622 if (n > NUM_SIMUL_TRANSFERS)
623 return NUM_SIMUL_TRANSFERS;
628 static unsigned int get_timeout(struct dev_context *devc)
631 unsigned int timeout;
633 total_size = get_buffer_size(devc) * get_number_of_transfers(devc);
634 timeout = total_size / bytes_per_ms(devc);
635 return timeout + timeout / 4; /* Leave a headroom of 25% percent. */
638 static int configure_channels(const struct sr_dev_inst *sdi)
640 struct dev_context *devc;
641 struct sr_channel *ch;
643 uint16_t channel_bit;
647 devc->cur_channels = 0;
648 devc->num_channels = 0;
649 for (l = sdi->channels; l; l = l->next) {
650 ch = (struct sr_channel *)l->data;
651 if (ch->enabled == FALSE)
654 channel_bit = 1 << (ch->index);
656 devc->cur_channels |= channel_bit;
658 #ifdef WORDS_BIGENDIAN
660 * Output logic data should be stored in little endian format.
661 * To speed things up during conversion, do the switcharoo
664 channel_bit = 1 << (ch->index ^ 8);
667 devc->channel_masks[devc->num_channels++] = channel_bit;
673 static int receive_data(int fd, int revents, void *cb_data)
676 struct dev_context *devc;
677 struct drv_context *drvc;
678 const struct sr_dev_inst *sdi;
687 tv.tv_sec = tv.tv_usec = 0;
688 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
690 if (devc->sent_samples == -2) {
691 logic16_abort_acquisition(sdi);
692 abort_acquisition(devc);
698 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
700 struct dev_context *devc;
701 struct drv_context *drvc;
702 struct sr_usb_dev_inst *usb;
703 struct sr_trigger *trigger;
704 struct libusb_transfer *transfer;
705 unsigned int i, timeout, num_transfers;
708 size_t size, convsize;
710 if (sdi->status != SR_ST_ACTIVE)
711 return SR_ERR_DEV_CLOSED;
717 /* Configures devc->cur_channels. */
718 if (configure_channels(sdi) != SR_OK) {
719 sr_err("Failed to configure channels.");
723 devc->cb_data = cb_data;
724 devc->sent_samples = 0;
725 devc->empty_transfer_count = 0;
726 devc->cur_channel = 0;
727 memset(devc->channel_data, 0, sizeof(devc->channel_data));
729 if ((trigger = sr_session_trigger_get(sdi->session))) {
730 devc->stl = soft_trigger_logic_new(sdi, trigger);
731 devc->trigger_fired = FALSE;
733 devc->trigger_fired = TRUE;
735 timeout = get_timeout(devc);
736 num_transfers = get_number_of_transfers(devc);
737 size = get_buffer_size(devc);
738 convsize = (size / devc->num_channels + 2) * 16;
739 devc->submitted_transfers = 0;
741 devc->convbuffer_size = convsize;
742 if (!(devc->convbuffer = g_try_malloc(convsize))) {
743 sr_err("Conversion buffer malloc failed.");
744 return SR_ERR_MALLOC;
747 devc->transfers = g_try_malloc0(sizeof(*devc->transfers) * num_transfers);
748 if (!devc->transfers) {
749 sr_err("USB transfers malloc failed.");
750 g_free(devc->convbuffer);
751 return SR_ERR_MALLOC;
754 if ((ret = logic16_setup_acquisition(sdi, devc->cur_samplerate,
755 devc->cur_channels)) != SR_OK) {
756 g_free(devc->transfers);
757 g_free(devc->convbuffer);
761 devc->num_transfers = num_transfers;
762 for (i = 0; i < num_transfers; i++) {
763 if (!(buf = g_try_malloc(size))) {
764 sr_err("USB transfer buffer malloc failed.");
765 if (devc->submitted_transfers)
766 abort_acquisition(devc);
768 g_free(devc->transfers);
769 g_free(devc->convbuffer);
771 return SR_ERR_MALLOC;
773 transfer = libusb_alloc_transfer(0);
774 libusb_fill_bulk_transfer(transfer, usb->devhdl,
775 2 | LIBUSB_ENDPOINT_IN, buf, size,
776 logic16_receive_transfer, (void *)sdi, timeout);
777 if ((ret = libusb_submit_transfer(transfer)) != 0) {
778 sr_err("Failed to submit transfer: %s.",
779 libusb_error_name(ret));
780 libusb_free_transfer(transfer);
782 abort_acquisition(devc);
785 devc->transfers[i] = transfer;
786 devc->submitted_transfers++;
789 devc->ctx = drvc->sr_ctx;
791 usb_source_add(sdi->session, devc->ctx, timeout, receive_data, (void *)sdi);
793 /* Send header packet to the session bus. */
794 std_session_send_df_header(cb_data, LOG_PREFIX);
796 if ((ret = logic16_start_acquisition(sdi)) != SR_OK) {
797 abort_acquisition(devc);
804 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
810 if (sdi->status != SR_ST_ACTIVE)
811 return SR_ERR_DEV_CLOSED;
813 ret = logic16_abort_acquisition(sdi);
815 abort_acquisition(sdi->priv);
820 SR_PRIV struct sr_dev_driver saleae_logic16_driver_info = {
821 .name = "saleae-logic16",
822 .longname = "Saleae Logic16",
827 .dev_list = dev_list,
829 .config_get = config_get,
830 .config_set = config_set,
831 .config_list = config_list,
832 .dev_open = dev_open,
833 .dev_close = dev_close,
834 .dev_acquisition_start = dev_acquisition_start,
835 .dev_acquisition_stop = dev_acquisition_stop,