2 * This file is part of the libsigrok project.
4 * Copyright (C) 2013 Marcus Comstedt <marcus@mc.pp.se>
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
25 #include "libsigrok.h"
26 #include "libsigrok-internal.h"
29 #define LOGIC16_VID 0x21a9
30 #define LOGIC16_PID 0x1001
33 #define USB_INTERFACE 0
34 #define USB_CONFIGURATION 1
35 #define FX2_FIRMWARE FIRMWARE_DIR "/saleae-logic16-fx2.fw"
37 #define MAX_RENUM_DELAY_MS 3000
38 #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,
53 /* These are really implemented in the driver, not the hardware. */
54 SR_CONF_LIMIT_SAMPLES,
58 static const char *probe_names[NUM_PROBES + 1] = {
59 "0", "1", "2", "3", "4", "5", "6", "7", "8",
60 "9", "10", "11", "12", "13", "14", "15",
65 enum voltage_range range;
68 } volt_thresholds[] = {
69 { VOLTAGE_RANGE_18_33_V, 0.7, 1.4 },
70 { VOLTAGE_RANGE_5_V, 1.4, 3.6 },
73 static const uint64_t samplerates[] = {
90 static int init(struct sr_context *sr_ctx)
92 return std_init(sr_ctx, di, LOG_PREFIX);
95 static gboolean check_conf_profile(libusb_device *dev)
97 struct libusb_device_descriptor des;
98 struct libusb_device_handle *hdl;
100 unsigned char strdesc[64];
105 /* Assume the FW has not been loaded, unless proven wrong. */
106 if (libusb_get_device_descriptor(dev, &des) != 0)
109 if (libusb_open(dev, &hdl) != 0)
112 if (libusb_get_string_descriptor_ascii(hdl,
113 des.iManufacturer, strdesc, sizeof(strdesc)) < 0)
115 if (strcmp((const char *)strdesc, "Saleae LLC"))
118 if (libusb_get_string_descriptor_ascii(hdl,
119 des.iProduct, strdesc, sizeof(strdesc)) < 0)
121 if (strcmp((const char *)strdesc, "Logic S/16"))
124 /* If we made it here, it must be a configured Logic16. */
133 static GSList *scan(GSList *options)
135 struct drv_context *drvc;
136 struct dev_context *devc;
137 struct sr_dev_inst *sdi;
138 struct sr_usb_dev_inst *usb;
139 struct sr_probe *probe;
140 struct sr_config *src;
141 GSList *l, *devices, *conn_devices;
142 struct libusb_device_descriptor des;
143 libusb_device **devlist;
144 int devcnt, ret, i, j;
150 for (l = options; l; l = l->next) {
154 conn = g_variant_get_string(src->data, NULL);
159 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
163 /* Find all Logic16 devices and upload firmware to them. */
165 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
166 for (i = 0; devlist[i]; i++) {
169 for (l = conn_devices; l; l = l->next) {
171 if (usb->bus == libusb_get_bus_number(devlist[i])
172 && usb->address == libusb_get_device_address(devlist[i]))
176 /* This device matched none of the ones that
177 * matched the conn specification. */
181 if ((ret = libusb_get_device_descriptor( devlist[i], &des)) != 0) {
182 sr_warn("Failed to get device descriptor: %s.",
183 libusb_error_name(ret));
187 if (des.idVendor != LOGIC16_VID || des.idProduct != LOGIC16_PID)
190 devcnt = g_slist_length(drvc->instances);
191 sdi = sr_dev_inst_new(devcnt, SR_ST_INITIALIZING,
192 "Saleae", "Logic16", NULL);
197 for (j = 0; probe_names[j]; j++) {
198 if (!(probe = sr_probe_new(j, SR_PROBE_LOGIC, TRUE,
201 sdi->probes = g_slist_append(sdi->probes, probe);
204 if (!(devc = g_try_malloc0(sizeof(struct dev_context))))
206 devc->selected_voltage_range = VOLTAGE_RANGE_18_33_V;
208 drvc->instances = g_slist_append(drvc->instances, sdi);
209 devices = g_slist_append(devices, sdi);
211 if (check_conf_profile(devlist[i])) {
212 /* Already has the firmware, so fix the new address. */
213 sr_dbg("Found a Logic16 device.");
214 sdi->status = SR_ST_INACTIVE;
215 sdi->inst_type = SR_INST_USB;
216 sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
217 libusb_get_device_address(devlist[i]), NULL);
219 if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
220 FX2_FIRMWARE) == SR_OK)
221 /* Store when this device's FW was updated. */
222 devc->fw_updated = g_get_monotonic_time();
224 sr_err("Firmware upload failed for "
225 "device %d.", devcnt);
226 sdi->inst_type = SR_INST_USB;
227 sdi->conn = sr_usb_dev_inst_new (libusb_get_bus_number(devlist[i]),
231 libusb_free_device_list(devlist, 1);
232 g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
237 static GSList *dev_list(void)
239 struct drv_context *drvc;
243 return drvc->instances;
246 static int dev_clear(void)
248 return std_dev_clear(di, NULL);
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
282 || 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 if ((ret = saleae_logic16_init_device(sdi)) != SR_OK) {
316 sr_err("Failed to init device.");
320 sdi->status = SR_ST_ACTIVE;
321 sr_info("Opened device %d on %d.%d, "
323 sdi->index, usb->bus, usb->address,
328 libusb_free_device_list(devlist, 1);
330 if (sdi->status != SR_ST_ACTIVE)
336 static int dev_open(struct sr_dev_inst *sdi)
338 struct sr_usb_dev_inst *usb;
339 struct dev_context *devc;
341 int64_t timediff_us, timediff_ms;
347 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
348 * milliseconds for the FX2 to renumerate.
351 if (devc->fw_updated > 0) {
352 sr_info("Waiting for device to reset.");
353 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
354 g_usleep(300 * 1000);
356 while (timediff_ms < MAX_RENUM_DELAY_MS) {
357 if ((ret = logic16_dev_open(sdi)) == SR_OK)
359 g_usleep(100 * 1000);
361 timediff_us = g_get_monotonic_time() - devc->fw_updated;
362 timediff_ms = timediff_us / 1000;
363 sr_spew("Waited %" PRIi64 "ms.", timediff_ms);
366 sr_err("Device failed to renumerate.");
369 sr_info("Device came back after %" PRIi64 "ms.", timediff_ms);
371 sr_info("Firmware upload was not needed.");
372 ret = logic16_dev_open(sdi);
376 sr_err("Unable to open device.");
380 ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
383 case LIBUSB_ERROR_BUSY:
384 sr_err("Unable to claim USB interface. Another "
385 "program or driver has already claimed it.");
387 case LIBUSB_ERROR_NO_DEVICE:
388 sr_err("Device has been disconnected.");
391 sr_err("Unable to claim interface: %s.",
392 libusb_error_name(ret));
399 if (devc->cur_samplerate == 0) {
400 /* Samplerate hasn't been set; default to the slowest one. */
401 devc->cur_samplerate = samplerates[0];
407 static int dev_close(struct sr_dev_inst *sdi)
409 struct sr_usb_dev_inst *usb;
412 if (usb->devhdl == NULL)
415 sr_info("Closing device %d on %d.%d interface %d.",
416 sdi->index, usb->bus, usb->address, USB_INTERFACE);
417 libusb_release_interface(usb->devhdl, USB_INTERFACE);
418 libusb_close(usb->devhdl);
420 sdi->status = SR_ST_INACTIVE;
425 static int cleanup(void)
428 struct drv_context *drvc;
430 if (!(drvc = di->priv))
431 /* Can get called on an unused driver, doesn't matter. */
441 static int config_get(int key, GVariant **data, const struct sr_dev_inst *sdi)
443 struct dev_context *devc;
444 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) {
477 range[0] = g_variant_new_double(volt_thresholds[i].low);
478 range[1] = g_variant_new_double(volt_thresholds[i].high);
479 *data = g_variant_new_tuple(range, 2);
491 static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi)
493 struct dev_context *devc;
498 if (sdi->status != SR_ST_ACTIVE)
499 return SR_ERR_DEV_CLOSED;
505 case SR_CONF_SAMPLERATE:
506 devc->cur_samplerate = g_variant_get_uint64(data);
508 case SR_CONF_LIMIT_SAMPLES:
509 devc->limit_samples = g_variant_get_uint64(data);
511 case SR_CONF_VOLTAGE_THRESHOLD:
512 g_variant_get(data, "(dd)", &low, &high);
514 for (i = 0; i < ARRAY_SIZE(volt_thresholds); i++) {
515 if (fabs(volt_thresholds[i].low - low) < 0.1 &&
516 fabs(volt_thresholds[i].high - high) < 0.1) {
517 devc->selected_voltage_range =
518 volt_thresholds[i].range;
531 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
533 GVariant *gvar, *range[2];
542 case SR_CONF_SCAN_OPTIONS:
543 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
544 hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
546 case SR_CONF_DEVICE_OPTIONS:
547 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
548 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
550 case SR_CONF_SAMPLERATE:
551 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
552 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
553 ARRAY_SIZE(samplerates), sizeof(uint64_t));
554 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
555 *data = g_variant_builder_end(&gvb);
557 case SR_CONF_VOLTAGE_THRESHOLD:
558 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
559 for (i = 0; i < ARRAY_SIZE(volt_thresholds); i++) {
560 range[0] = g_variant_new_double(volt_thresholds[i].low);
561 range[1] = g_variant_new_double(volt_thresholds[i].high);
562 gvar = g_variant_new_tuple(range, 2);
563 g_variant_builder_add_value(&gvb, gvar);
565 *data = g_variant_builder_end(&gvb);
574 static void abort_acquisition(struct dev_context *devc)
578 devc->num_samples = -1;
580 for (i = devc->num_transfers - 1; i >= 0; i--) {
581 if (devc->transfers[i])
582 libusb_cancel_transfer(devc->transfers[i]);
586 static unsigned int bytes_per_ms(struct dev_context *devc)
588 return devc->cur_samplerate * devc->num_channels / 8000;
591 static size_t get_buffer_size(struct dev_context *devc)
596 * The buffer should be large enough to hold 10ms of data and
599 s = 10 * bytes_per_ms(devc);
600 return (s + 511) & ~511;
603 static unsigned int get_number_of_transfers(struct dev_context *devc)
607 /* Total buffer size should be able to hold about 500ms of data. */
608 n = 500 * bytes_per_ms(devc) / get_buffer_size(devc);
610 if (n > NUM_SIMUL_TRANSFERS)
611 return NUM_SIMUL_TRANSFERS;
616 static unsigned int get_timeout(struct dev_context *devc)
619 unsigned int timeout;
621 total_size = get_buffer_size(devc) * get_number_of_transfers(devc);
622 timeout = total_size / bytes_per_ms(devc);
623 return timeout + timeout / 4; /* Leave a headroom of 25% percent. */
626 static int configure_probes(const struct sr_dev_inst *sdi)
628 struct dev_context *devc;
629 struct sr_probe *probe;
635 devc->cur_channels = 0;
636 devc->num_channels = 0;
637 for (l = sdi->probes; l; l = l->next) {
638 probe = (struct sr_probe *)l->data;
639 if (probe->enabled == FALSE)
642 probe_bit = 1 << (probe->index);
644 devc->cur_channels |= probe_bit;
646 #ifdef WORDS_BIGENDIAN
647 /* Output logic data should be stored in little endian
648 format. To speed things up during conversion, do the
649 switcharoo here instead. */
651 probe_bit = 1 << (probe->index ^ 8);
654 devc->channel_masks[devc->num_channels ++] = probe_bit;
660 static int receive_data(int fd, int revents, void *cb_data)
663 struct dev_context *devc;
664 struct drv_context *drvc;
665 const struct sr_dev_inst *sdi;
674 tv.tv_sec = tv.tv_usec = 0;
675 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
677 if (devc->num_samples == -2) {
678 saleae_logic16_abort_acquisition(sdi);
679 abort_acquisition(devc);
685 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
688 struct dev_context *devc;
689 struct drv_context *drvc;
690 struct sr_usb_dev_inst *usb;
691 struct libusb_transfer *transfer;
692 const struct libusb_pollfd **lupfd;
693 unsigned int i, timeout, num_transfers;
696 size_t size, convsize;
698 if (sdi->status != SR_ST_ACTIVE)
699 return SR_ERR_DEV_CLOSED;
705 /* Configures devc->cur_channels */
706 if (configure_probes(sdi) != SR_OK) {
707 sr_err("Failed to configure probes.");
711 devc->cb_data = cb_data;
712 devc->num_samples = 0;
713 devc->empty_transfer_count = 0;
714 devc->cur_channel = 0;
715 memset(devc->channel_data, 0, sizeof(devc->channel_data));
717 timeout = get_timeout(devc);
718 num_transfers = get_number_of_transfers(devc);
719 size = get_buffer_size(devc);
720 convsize = (size / devc->num_channels + 2) * 16;
721 devc->submitted_transfers = 0;
724 devc->convbuffer_size = convsize;
725 if (!(devc->convbuffer = g_try_malloc(convsize))) {
726 sr_err("Conversion buffer malloc failed.");
727 return SR_ERR_MALLOC;
730 devc->transfers = g_try_malloc0(sizeof(*devc->transfers) * num_transfers);
731 if (!devc->transfers) {
732 sr_err("USB transfers malloc failed.");
733 g_free(devc->convbuffer);
734 return SR_ERR_MALLOC;
737 if ((ret = saleae_logic16_setup_acquisition(sdi, devc->cur_samplerate,
738 devc->cur_channels)) != SR_OK) {
739 g_free(devc->transfers);
740 g_free(devc->convbuffer);
744 devc->num_transfers = num_transfers;
745 for (i = 0; i < num_transfers; i++) {
746 if (!(buf = g_try_malloc(size))) {
747 sr_err("USB transfer buffer malloc failed.");
748 if (devc->submitted_transfers)
749 abort_acquisition(devc);
751 g_free(devc->transfers);
752 g_free(devc->convbuffer);
754 return SR_ERR_MALLOC;
756 transfer = libusb_alloc_transfer(0);
757 libusb_fill_bulk_transfer(transfer, usb->devhdl,
758 2 | LIBUSB_ENDPOINT_IN, buf, size,
759 saleae_logic16_receive_transfer, devc, timeout);
760 if ((ret = libusb_submit_transfer(transfer)) != 0) {
761 sr_err("Failed to submit transfer: %s.",
762 libusb_error_name(ret));
763 libusb_free_transfer(transfer);
765 abort_acquisition(devc);
768 devc->transfers[i] = transfer;
769 devc->submitted_transfers++;
772 lupfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
773 for (i = 0; lupfd[i]; i++);
774 if (!(devc->usbfd = g_try_malloc(sizeof(struct libusb_pollfd) * (i + 1)))) {
775 abort_acquisition(devc);
779 for (i = 0; lupfd[i]; i++) {
780 sr_source_add(lupfd[i]->fd, lupfd[i]->events,
781 timeout, receive_data, (void *)sdi);
782 devc->usbfd[i] = lupfd[i]->fd;
787 /* Send header packet to the session bus. */
788 std_session_send_df_header(cb_data, LOG_PREFIX);
790 if ((ret = saleae_logic16_start_acquisition(sdi)) != SR_OK) {
791 abort_acquisition(devc);
798 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
804 if (sdi->status != SR_ST_ACTIVE)
805 return SR_ERR_DEV_CLOSED;
807 ret = saleae_logic16_abort_acquisition(sdi);
809 abort_acquisition(sdi->priv);
814 SR_PRIV struct sr_dev_driver saleae_logic16_driver_info = {
815 .name = "saleae-logic16",
816 .longname = "Saleae Logic16",
821 .dev_list = dev_list,
822 .dev_clear = dev_clear,
823 .config_get = config_get,
824 .config_set = config_set,
825 .config_list = config_list,
826 .dev_open = dev_open,
827 .dev_close = dev_close,
828 .dev_acquisition_start = dev_acquisition_start,
829 .dev_acquisition_stop = dev_acquisition_stop,