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 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,
58 static const int32_t soft_trigger_matches[] = {
66 static const char *channel_names[] = {
67 "0", "1", "2", "3", "4", "5", "6", "7", "8",
68 "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_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(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_channel *ch;
148 struct sr_config *src;
149 GSList *l, *devices, *conn_devices;
150 struct libusb_device_descriptor des;
151 libusb_device **devlist;
152 int devcnt, ret, i, j;
158 for (l = options; l; l = l->next) {
162 conn = g_variant_get_string(src->data, NULL);
167 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
171 /* Find all Logic16 devices and upload firmware to them. */
173 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
174 for (i = 0; devlist[i]; i++) {
177 for (l = conn_devices; l; l = l->next) {
179 if (usb->bus == libusb_get_bus_number(devlist[i])
180 && usb->address == libusb_get_device_address(devlist[i]))
184 /* This device matched none of the ones that
185 * matched the conn specification. */
189 if ((ret = libusb_get_device_descriptor(devlist[i], &des)) != 0) {
190 sr_warn("Failed to get device descriptor: %s.",
191 libusb_error_name(ret));
195 if (des.idVendor != LOGIC16_VID || des.idProduct != LOGIC16_PID)
198 devcnt = g_slist_length(drvc->instances);
199 sdi = sr_dev_inst_new(devcnt, SR_ST_INITIALIZING,
200 "Saleae", "Logic16", NULL);
205 for (j = 0; channel_names[j]; j++) {
206 if (!(ch = sr_channel_new(j, SR_CHANNEL_LOGIC, TRUE,
209 sdi->channels = g_slist_append(sdi->channels, ch);
212 if (!(devc = g_try_malloc0(sizeof(struct dev_context))))
214 devc->selected_voltage_range = VOLTAGE_RANGE_18_33_V;
216 drvc->instances = g_slist_append(drvc->instances, sdi);
217 devices = g_slist_append(devices, sdi);
219 if (check_conf_profile(devlist[i])) {
220 /* Already has the firmware, so fix the new address. */
221 sr_dbg("Found a Logic16 device.");
222 sdi->status = SR_ST_INACTIVE;
223 sdi->inst_type = SR_INST_USB;
224 sdi->conn = sr_usb_dev_inst_new(
225 libusb_get_bus_number(devlist[i]),
226 libusb_get_device_address(devlist[i]), NULL);
228 if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
229 FX2_FIRMWARE) == SR_OK)
230 /* Store when this device's FW was updated. */
231 devc->fw_updated = g_get_monotonic_time();
233 sr_err("Firmware upload failed for "
234 "device %d.", devcnt);
235 sdi->inst_type = SR_INST_USB;
236 sdi->conn = sr_usb_dev_inst_new(
237 libusb_get_bus_number(devlist[i]), 0xff, NULL);
240 libusb_free_device_list(devlist, 1);
241 g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
246 static GSList *dev_list(void)
248 return ((struct drv_context *)(di->priv))->instances;
251 static int logic16_dev_open(struct sr_dev_inst *sdi)
253 libusb_device **devlist;
254 struct sr_usb_dev_inst *usb;
255 struct libusb_device_descriptor des;
256 struct drv_context *drvc;
257 int ret, skip, i, device_count;
262 if (sdi->status == SR_ST_ACTIVE)
263 /* 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 if (skip != sdi->index) {
286 /* Skip devices of this type that aren't the one we want. */
290 } else if (sdi->status == SR_ST_INACTIVE) {
292 * This device is fully enumerated, so we need to find
293 * this device by vendor, product, bus and address.
295 if (libusb_get_bus_number(devlist[i]) != usb->bus
296 || libusb_get_device_address(devlist[i]) != usb->address)
297 /* This is not the one. */
301 if (!(ret = libusb_open(devlist[i], &usb->devhdl))) {
302 if (usb->address == 0xff)
304 * First time we touch this device after FW
305 * upload, so we don't know the address yet.
307 usb->address = libusb_get_device_address(devlist[i]);
309 sr_err("Failed to open device: %s.",
310 libusb_error_name(ret));
314 ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
315 if (ret == LIBUSB_ERROR_BUSY) {
316 sr_err("Unable to claim USB interface. Another "
317 "program or driver has already claimed it.");
319 } else if (ret == LIBUSB_ERROR_NO_DEVICE) {
320 sr_err("Device has been disconnected.");
322 } else if (ret != 0) {
323 sr_err("Unable to claim interface: %s.",
324 libusb_error_name(ret));
328 if ((ret = logic16_init_device(sdi)) != SR_OK) {
329 sr_err("Failed to init device.");
333 sdi->status = SR_ST_ACTIVE;
334 sr_info("Opened device %d on %d.%d, interface %d.",
335 sdi->index, usb->bus, usb->address, USB_INTERFACE);
339 libusb_free_device_list(devlist, 1);
341 if (sdi->status != SR_ST_ACTIVE) {
343 libusb_release_interface(usb->devhdl, USB_INTERFACE);
344 libusb_close(usb->devhdl);
353 static int dev_open(struct sr_dev_inst *sdi)
355 struct dev_context *devc;
357 int64_t timediff_us, timediff_ms;
362 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
363 * milliseconds for the FX2 to renumerate.
366 if (devc->fw_updated > 0) {
367 sr_info("Waiting for device to reset.");
368 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
369 g_usleep(300 * 1000);
371 while (timediff_ms < MAX_RENUM_DELAY_MS) {
372 if ((ret = logic16_dev_open(sdi)) == SR_OK)
374 g_usleep(100 * 1000);
376 timediff_us = g_get_monotonic_time() - devc->fw_updated;
377 timediff_ms = timediff_us / 1000;
378 sr_spew("Waited %" PRIi64 "ms.", timediff_ms);
381 sr_err("Device failed to renumerate.");
384 sr_info("Device came back after %" PRIi64 "ms.", timediff_ms);
386 sr_info("Firmware upload was not needed.");
387 ret = logic16_dev_open(sdi);
391 sr_err("Unable to open device.");
395 if (devc->cur_samplerate == 0) {
396 /* Samplerate hasn't been set; default to the slowest one. */
397 devc->cur_samplerate = samplerates[0];
403 static int dev_close(struct sr_dev_inst *sdi)
405 struct sr_usb_dev_inst *usb;
408 if (usb->devhdl == NULL)
411 sr_info("Closing device %d on %d.%d interface %d.",
412 sdi->index, usb->bus, usb->address, USB_INTERFACE);
413 libusb_release_interface(usb->devhdl, USB_INTERFACE);
414 libusb_close(usb->devhdl);
416 sdi->status = SR_ST_INACTIVE;
421 static int cleanup(void)
424 struct drv_context *drvc;
426 if (!(drvc = di->priv))
427 /* Can get called on an unused driver, doesn't matter. */
431 ret = std_dev_clear(di, NULL);
438 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
439 const struct sr_channel_group *cg)
441 struct dev_context *devc;
442 struct sr_usb_dev_inst *usb;
453 if (!sdi || !sdi->conn)
456 if (usb->address == 255)
457 /* Device still needs to re-enumerate after firmware
458 * upload, so we don't know its (future) address. */
460 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
461 *data = g_variant_new_string(str);
463 case SR_CONF_SAMPLERATE:
467 *data = g_variant_new_uint64(devc->cur_samplerate);
469 case SR_CONF_VOLTAGE_THRESHOLD:
474 for (i = 0; i < ARRAY_SIZE(volt_thresholds); i++) {
475 if (devc->selected_voltage_range !=
476 volt_thresholds[i].range)
478 range[0] = g_variant_new_double(volt_thresholds[i].low);
479 range[1] = g_variant_new_double(volt_thresholds[i].high);
480 *data = g_variant_new_tuple(range, 2);
492 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
493 const struct sr_channel_group *cg)
495 struct dev_context *devc;
502 if (sdi->status != SR_ST_ACTIVE)
503 return SR_ERR_DEV_CLOSED;
509 case SR_CONF_SAMPLERATE:
510 devc->cur_samplerate = g_variant_get_uint64(data);
512 case SR_CONF_LIMIT_SAMPLES:
513 devc->limit_samples = g_variant_get_uint64(data);
515 case SR_CONF_VOLTAGE_THRESHOLD:
516 g_variant_get(data, "(dd)", &low, &high);
518 for (i = 0; i < ARRAY_SIZE(volt_thresholds); i++) {
519 if (fabs(volt_thresholds[i].low - low) < 0.1 &&
520 fabs(volt_thresholds[i].high - high) < 0.1) {
521 devc->selected_voltage_range =
522 volt_thresholds[i].range;
535 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
536 const struct sr_channel_group *cg)
538 GVariant *gvar, *range[2];
548 case SR_CONF_SCAN_OPTIONS:
549 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
550 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
552 case SR_CONF_DEVICE_OPTIONS:
553 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
554 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
556 case SR_CONF_SAMPLERATE:
557 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
558 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
559 samplerates, ARRAY_SIZE(samplerates), sizeof(uint64_t));
560 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
561 *data = g_variant_builder_end(&gvb);
563 case SR_CONF_VOLTAGE_THRESHOLD:
564 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
565 for (i = 0; i < ARRAY_SIZE(volt_thresholds); i++) {
566 range[0] = g_variant_new_double(volt_thresholds[i].low);
567 range[1] = g_variant_new_double(volt_thresholds[i].high);
568 gvar = g_variant_new_tuple(range, 2);
569 g_variant_builder_add_value(&gvb, gvar);
571 *data = g_variant_builder_end(&gvb);
573 case SR_CONF_TRIGGER_MATCH:
574 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
575 soft_trigger_matches, ARRAY_SIZE(soft_trigger_matches),
585 static void abort_acquisition(struct dev_context *devc)
589 devc->sent_samples = -1;
591 for (i = devc->num_transfers - 1; i >= 0; i--) {
592 if (devc->transfers[i])
593 libusb_cancel_transfer(devc->transfers[i]);
597 static unsigned int bytes_per_ms(struct dev_context *devc)
599 return devc->cur_samplerate * devc->num_channels / 8000;
602 static size_t get_buffer_size(struct dev_context *devc)
607 * The buffer should be large enough to hold 10ms of data and
610 s = 10 * bytes_per_ms(devc);
611 return (s + 511) & ~511;
614 static unsigned int get_number_of_transfers(struct dev_context *devc)
618 /* Total buffer size should be able to hold about 500ms of data. */
619 n = 500 * bytes_per_ms(devc) / get_buffer_size(devc);
621 if (n > NUM_SIMUL_TRANSFERS)
622 return NUM_SIMUL_TRANSFERS;
627 static unsigned int get_timeout(struct dev_context *devc)
630 unsigned int timeout;
632 total_size = get_buffer_size(devc) * get_number_of_transfers(devc);
633 timeout = total_size / bytes_per_ms(devc);
634 return timeout + timeout / 4; /* Leave a headroom of 25% percent. */
637 static int configure_channels(const struct sr_dev_inst *sdi)
639 struct dev_context *devc;
640 struct sr_channel *ch;
642 uint16_t channel_bit;
646 devc->cur_channels = 0;
647 devc->num_channels = 0;
648 for (l = sdi->channels; l; l = l->next) {
649 ch = (struct sr_channel *)l->data;
650 if (ch->enabled == FALSE)
653 channel_bit = 1 << (ch->index);
655 devc->cur_channels |= channel_bit;
657 #ifdef WORDS_BIGENDIAN
659 * Output logic data should be stored in little endian format.
660 * To speed things up during conversion, do the switcharoo
663 channel_bit = 1 << (ch->index ^ 8);
666 devc->channel_masks[devc->num_channels++] = channel_bit;
672 static int receive_data(int fd, int revents, void *cb_data)
675 struct dev_context *devc;
676 struct drv_context *drvc;
677 const struct sr_dev_inst *sdi;
686 tv.tv_sec = tv.tv_usec = 0;
687 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
689 if (devc->sent_samples == -2) {
690 logic16_abort_acquisition(sdi);
691 abort_acquisition(devc);
697 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
699 struct dev_context *devc;
700 struct drv_context *drvc;
701 struct sr_usb_dev_inst *usb;
702 struct sr_trigger *trigger;
703 struct libusb_transfer *transfer;
704 unsigned int i, timeout, num_transfers;
707 size_t size, convsize;
709 if (sdi->status != SR_ST_ACTIVE)
710 return SR_ERR_DEV_CLOSED;
716 /* Configures devc->cur_channels. */
717 if (configure_channels(sdi) != SR_OK) {
718 sr_err("Failed to configure channels.");
722 devc->cb_data = cb_data;
723 devc->sent_samples = 0;
724 devc->empty_transfer_count = 0;
725 devc->cur_channel = 0;
726 memset(devc->channel_data, 0, sizeof(devc->channel_data));
728 if ((trigger = sr_session_trigger_get(sdi->session))) {
729 devc->stl = soft_trigger_logic_new(sdi, trigger);
730 devc->trigger_fired = FALSE;
732 devc->trigger_fired = TRUE;
734 timeout = get_timeout(devc);
735 num_transfers = get_number_of_transfers(devc);
736 size = get_buffer_size(devc);
737 convsize = (size / devc->num_channels + 2) * 16;
738 devc->submitted_transfers = 0;
740 devc->convbuffer_size = convsize;
741 if (!(devc->convbuffer = g_try_malloc(convsize))) {
742 sr_err("Conversion buffer malloc failed.");
743 return SR_ERR_MALLOC;
746 devc->transfers = g_try_malloc0(sizeof(*devc->transfers) * num_transfers);
747 if (!devc->transfers) {
748 sr_err("USB transfers malloc failed.");
749 g_free(devc->convbuffer);
750 return SR_ERR_MALLOC;
753 if ((ret = logic16_setup_acquisition(sdi, devc->cur_samplerate,
754 devc->cur_channels)) != SR_OK) {
755 g_free(devc->transfers);
756 g_free(devc->convbuffer);
760 devc->num_transfers = num_transfers;
761 for (i = 0; i < num_transfers; i++) {
762 if (!(buf = g_try_malloc(size))) {
763 sr_err("USB transfer buffer malloc failed.");
764 if (devc->submitted_transfers)
765 abort_acquisition(devc);
767 g_free(devc->transfers);
768 g_free(devc->convbuffer);
770 return SR_ERR_MALLOC;
772 transfer = libusb_alloc_transfer(0);
773 libusb_fill_bulk_transfer(transfer, usb->devhdl,
774 2 | LIBUSB_ENDPOINT_IN, buf, size,
775 logic16_receive_transfer, (void *)sdi, timeout);
776 if ((ret = libusb_submit_transfer(transfer)) != 0) {
777 sr_err("Failed to submit transfer: %s.",
778 libusb_error_name(ret));
779 libusb_free_transfer(transfer);
781 abort_acquisition(devc);
784 devc->transfers[i] = transfer;
785 devc->submitted_transfers++;
788 devc->ctx = drvc->sr_ctx;
790 usb_source_add(sdi->session, devc->ctx, timeout, receive_data, (void *)sdi);
792 /* Send header packet to the session bus. */
793 std_session_send_df_header(cb_data, LOG_PREFIX);
795 if ((ret = logic16_start_acquisition(sdi)) != SR_OK) {
796 abort_acquisition(devc);
803 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
809 if (sdi->status != SR_ST_ACTIVE)
810 return SR_ERR_DEV_CLOSED;
812 ret = logic16_abort_acquisition(sdi);
814 abort_acquisition(sdi->priv);
819 SR_PRIV struct sr_dev_driver saleae_logic16_driver_info = {
820 .name = "saleae-logic16",
821 .longname = "Saleae Logic16",
826 .dev_list = dev_list,
828 .config_get = config_get,
829 .config_set = config_set,
830 .config_list = config_list,
831 .dev_open = dev_open,
832 .dev_close = dev_close,
833 .dev_acquisition_start = dev_acquisition_start,
834 .dev_acquisition_stop = dev_acquisition_stop,