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 drvopts[] = {
47 SR_CONF_LOGIC_ANALYZER,
50 static const uint32_t devopts[] = {
52 SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
53 SR_CONF_CONN | SR_CONF_GET,
54 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
55 SR_CONF_VOLTAGE_THRESHOLD | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
56 SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
57 SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
60 static const int32_t trigger_matches[] = {
68 static const char *channel_names[] = {
69 "0", "1", "2", "3", "4", "5", "6", "7", "8",
70 "9", "10", "11", "12", "13", "14", "15",
74 enum voltage_range range;
75 } volt_thresholds_ranges[] = {
76 { VOLTAGE_RANGE_18_33_V, },
77 { VOLTAGE_RANGE_5_V, },
80 static const double volt_thresholds[][2] = {
85 static const uint64_t samplerates[] = {
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 libusb_get_device_descriptor(dev, &des);
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;
153 char connection_id[64];
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 libusb_get_device_descriptor(devlist[i], &des);
191 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
193 if (des.idVendor != LOGIC16_VID || des.idProduct != LOGIC16_PID)
196 sdi = g_malloc0(sizeof(struct sr_dev_inst));
197 sdi->status = SR_ST_INITIALIZING;
198 sdi->vendor = g_strdup("Saleae");
199 sdi->model = g_strdup("Logic16");
200 sdi->connection_id = g_strdup(connection_id);
202 for (j = 0; j < ARRAY_SIZE(channel_names); j++)
203 sr_channel_new(sdi, j, SR_CHANNEL_LOGIC, TRUE,
206 devc = g_malloc0(sizeof(struct dev_context));
207 devc->selected_voltage_range = VOLTAGE_RANGE_18_33_V;
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(
217 libusb_get_bus_number(devlist[i]),
218 libusb_get_device_address(devlist[i]), NULL);
220 if (ezusb_upload_firmware(drvc->sr_ctx, devlist[i],
221 USB_CONFIGURATION, FX2_FIRMWARE) == SR_OK)
222 /* Store when this device's FW was updated. */
223 devc->fw_updated = g_get_monotonic_time();
225 sr_err("Firmware upload failed.");
226 sdi->inst_type = SR_INST_USB;
227 sdi->conn = sr_usb_dev_inst_new(
228 libusb_get_bus_number(devlist[i]), 0xff, NULL);
231 libusb_free_device_list(devlist, 1);
232 g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
234 return std_scan_complete(di, devices);
237 static int logic16_dev_open(struct sr_dev_inst *sdi)
239 struct sr_dev_driver *di;
240 libusb_device **devlist;
241 struct sr_usb_dev_inst *usb;
242 struct libusb_device_descriptor des;
243 struct drv_context *drvc;
244 int ret = SR_ERR, i, device_count;
245 char connection_id[64];
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));
289 ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
290 if (ret == LIBUSB_ERROR_BUSY) {
291 sr_err("Unable to claim USB interface. Another "
292 "program or driver has already claimed it.");
295 } else if (ret == LIBUSB_ERROR_NO_DEVICE) {
296 sr_err("Device has been disconnected.");
299 } else if (ret != 0) {
300 sr_err("Unable to claim interface: %s.",
301 libusb_error_name(ret));
306 if ((ret = logic16_init_device(sdi)) != SR_OK) {
307 sr_err("Failed to init device.");
311 sr_info("Opened device on %d.%d (logical) / %s (physical), interface %d.",
312 usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
319 libusb_free_device_list(devlist, 1);
323 libusb_release_interface(usb->devhdl, USB_INTERFACE);
324 libusb_close(usb->devhdl);
333 static int dev_open(struct sr_dev_inst *sdi)
335 struct dev_context *devc;
337 int64_t timediff_us, timediff_ms;
342 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
343 * milliseconds for the FX2 to renumerate.
346 if (devc->fw_updated > 0) {
347 sr_info("Waiting for device to reset.");
348 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
349 g_usleep(300 * 1000);
351 while (timediff_ms < MAX_RENUM_DELAY_MS) {
352 if ((ret = logic16_dev_open(sdi)) == SR_OK)
354 g_usleep(100 * 1000);
356 timediff_us = g_get_monotonic_time() - devc->fw_updated;
357 timediff_ms = timediff_us / 1000;
358 sr_spew("Waited %" PRIi64 "ms.", timediff_ms);
361 sr_err("Device failed to renumerate.");
364 sr_info("Device came back after %" PRIi64 "ms.", timediff_ms);
366 sr_info("Firmware upload was not needed.");
367 ret = logic16_dev_open(sdi);
371 sr_err("Unable to open device.");
375 if (devc->cur_samplerate == 0) {
376 /* Samplerate hasn't been set; default to the slowest one. */
377 devc->cur_samplerate = samplerates[0];
383 static int dev_close(struct sr_dev_inst *sdi)
385 struct sr_usb_dev_inst *usb;
392 sr_info("Closing device on %d.%d (logical) / %s (physical) interface %d.",
393 usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
394 libusb_release_interface(usb->devhdl, USB_INTERFACE);
395 libusb_close(usb->devhdl);
401 static int config_get(uint32_t key, GVariant **data,
402 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
404 struct dev_context *devc;
405 struct sr_usb_dev_inst *usb;
414 if (!sdi || !sdi->conn)
417 if (usb->address == 255)
418 /* Device still needs to re-enumerate after firmware
419 * upload, so we don't know its (future) address. */
421 *data = g_variant_new_printf("%d.%d", usb->bus, usb->address);
423 case SR_CONF_SAMPLERATE:
427 *data = g_variant_new_uint64(devc->cur_samplerate);
429 case SR_CONF_CAPTURE_RATIO:
433 *data = g_variant_new_uint64(devc->capture_ratio);
435 case SR_CONF_VOLTAGE_THRESHOLD:
440 for (i = 0; i < ARRAY_SIZE(volt_thresholds); i++) {
441 if (devc->selected_voltage_range !=
442 volt_thresholds_ranges[i].range)
444 *data = std_gvar_tuple_double(volt_thresholds[i][0], volt_thresholds[i][1]);
456 static int config_set(uint32_t key, GVariant *data,
457 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
459 struct dev_context *devc;
468 case SR_CONF_SAMPLERATE:
469 devc->cur_samplerate = g_variant_get_uint64(data);
471 case SR_CONF_LIMIT_SAMPLES:
472 devc->limit_samples = g_variant_get_uint64(data);
474 case SR_CONF_CAPTURE_RATIO:
475 devc->capture_ratio = g_variant_get_uint64(data);
476 ret = (devc->capture_ratio > 100) ? SR_ERR : SR_OK;
478 case SR_CONF_VOLTAGE_THRESHOLD:
479 if ((idx = std_double_tuple_idx(data, ARRAY_AND_SIZE(volt_thresholds))) < 0)
481 devc->selected_voltage_range = volt_thresholds_ranges[idx].range;
490 static int config_list(uint32_t key, GVariant **data,
491 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
494 case SR_CONF_SCAN_OPTIONS:
495 case SR_CONF_DEVICE_OPTIONS:
496 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
497 case SR_CONF_SAMPLERATE:
498 *data = std_gvar_samplerates(ARRAY_AND_SIZE(samplerates));
500 case SR_CONF_VOLTAGE_THRESHOLD:
501 *data = std_gvar_thresholds(ARRAY_AND_SIZE(volt_thresholds));
503 case SR_CONF_TRIGGER_MATCH:
504 *data = std_gvar_array_i32(ARRAY_AND_SIZE(trigger_matches));
513 static void abort_acquisition(struct dev_context *devc)
517 devc->sent_samples = -1;
519 for (i = devc->num_transfers - 1; i >= 0; i--) {
520 if (devc->transfers[i])
521 libusb_cancel_transfer(devc->transfers[i]);
525 static unsigned int bytes_per_ms(struct dev_context *devc)
527 return devc->cur_samplerate * devc->num_channels / 8000;
530 static size_t get_buffer_size(struct dev_context *devc)
535 * The buffer should be large enough to hold 10ms of data and
538 s = 10 * bytes_per_ms(devc);
539 return (s + 511) & ~511;
542 static unsigned int get_number_of_transfers(struct dev_context *devc)
546 /* Total buffer size should be able to hold about 500ms of data. */
547 n = 500 * bytes_per_ms(devc) / get_buffer_size(devc);
549 if (n > NUM_SIMUL_TRANSFERS)
550 return NUM_SIMUL_TRANSFERS;
555 static unsigned int get_timeout(struct dev_context *devc)
558 unsigned int timeout;
560 total_size = get_buffer_size(devc) * get_number_of_transfers(devc);
561 timeout = total_size / bytes_per_ms(devc);
562 return timeout + timeout / 4; /* Leave a headroom of 25% percent. */
565 static int configure_channels(const struct sr_dev_inst *sdi)
567 struct dev_context *devc;
568 struct sr_channel *ch;
570 uint16_t channel_bit;
574 devc->cur_channels = 0;
575 devc->num_channels = 0;
576 for (l = sdi->channels; l; l = l->next) {
577 ch = (struct sr_channel *)l->data;
578 if (ch->enabled == FALSE)
581 channel_bit = 1 << (ch->index);
583 devc->cur_channels |= channel_bit;
585 #ifdef WORDS_BIGENDIAN
587 * Output logic data should be stored in little endian format.
588 * To speed things up during conversion, do the switcharoo
591 channel_bit = 1 << (ch->index ^ 8);
594 devc->channel_masks[devc->num_channels++] = channel_bit;
600 static int receive_data(int fd, int revents, void *cb_data)
603 struct dev_context *devc;
604 struct drv_context *drvc;
605 const struct sr_dev_inst *sdi;
606 struct sr_dev_driver *di;
616 tv.tv_sec = tv.tv_usec = 0;
617 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
619 if (devc->sent_samples == -2) {
620 logic16_abort_acquisition(sdi);
621 abort_acquisition(devc);
627 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
629 struct sr_dev_driver *di = sdi->driver;
630 struct dev_context *devc;
631 struct drv_context *drvc;
632 struct sr_usb_dev_inst *usb;
633 struct sr_trigger *trigger;
634 struct libusb_transfer *transfer;
635 unsigned int i, timeout, num_transfers;
638 size_t size, convsize;
644 /* Configures devc->cur_channels. */
645 if (configure_channels(sdi) != SR_OK) {
646 sr_err("Failed to configure channels.");
650 devc->sent_samples = 0;
651 devc->empty_transfer_count = 0;
652 devc->cur_channel = 0;
653 memset(devc->channel_data, 0, sizeof(devc->channel_data));
655 if ((trigger = sr_session_trigger_get(sdi->session))) {
656 int pre_trigger_samples = 0;
657 if (devc->limit_samples > 0)
658 pre_trigger_samples = devc->capture_ratio * devc->limit_samples/100;
659 devc->stl = soft_trigger_logic_new(sdi, trigger, pre_trigger_samples);
661 return SR_ERR_MALLOC;
662 devc->trigger_fired = FALSE;
664 devc->trigger_fired = TRUE;
666 timeout = get_timeout(devc);
667 num_transfers = get_number_of_transfers(devc);
668 size = get_buffer_size(devc);
669 convsize = (size / devc->num_channels + 2) * 16;
670 devc->submitted_transfers = 0;
672 devc->convbuffer_size = convsize;
673 if (!(devc->convbuffer = g_try_malloc(convsize))) {
674 sr_err("Conversion buffer malloc failed.");
675 return SR_ERR_MALLOC;
678 devc->transfers = g_try_malloc0(sizeof(*devc->transfers) * num_transfers);
679 if (!devc->transfers) {
680 sr_err("USB transfers malloc failed.");
681 g_free(devc->convbuffer);
682 return SR_ERR_MALLOC;
685 if ((ret = logic16_setup_acquisition(sdi, devc->cur_samplerate,
686 devc->cur_channels)) != SR_OK) {
687 g_free(devc->transfers);
688 g_free(devc->convbuffer);
692 devc->num_transfers = num_transfers;
693 for (i = 0; i < num_transfers; i++) {
694 if (!(buf = g_try_malloc(size))) {
695 sr_err("USB transfer buffer malloc failed.");
696 if (devc->submitted_transfers)
697 abort_acquisition(devc);
699 g_free(devc->transfers);
700 g_free(devc->convbuffer);
702 return SR_ERR_MALLOC;
704 transfer = libusb_alloc_transfer(0);
705 libusb_fill_bulk_transfer(transfer, usb->devhdl,
706 2 | LIBUSB_ENDPOINT_IN, buf, size,
707 logic16_receive_transfer, (void *)sdi, timeout);
708 if ((ret = libusb_submit_transfer(transfer)) != 0) {
709 sr_err("Failed to submit transfer: %s.",
710 libusb_error_name(ret));
711 libusb_free_transfer(transfer);
713 abort_acquisition(devc);
716 devc->transfers[i] = transfer;
717 devc->submitted_transfers++;
720 devc->ctx = drvc->sr_ctx;
722 usb_source_add(sdi->session, devc->ctx, timeout, receive_data, (void *)sdi);
724 std_session_send_df_header(sdi);
726 if ((ret = logic16_start_acquisition(sdi)) != SR_OK) {
727 abort_acquisition(devc);
734 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
738 ret = logic16_abort_acquisition(sdi);
740 abort_acquisition(sdi->priv);
745 static struct sr_dev_driver saleae_logic16_driver_info = {
746 .name = "saleae-logic16",
747 .longname = "Saleae Logic16",
750 .cleanup = std_cleanup,
752 .dev_list = std_dev_list,
753 .dev_clear = std_dev_clear,
754 .config_get = config_get,
755 .config_set = config_set,
756 .config_list = config_list,
757 .dev_open = dev_open,
758 .dev_close = dev_close,
759 .dev_acquisition_start = dev_acquisition_start,
760 .dev_acquisition_stop = dev_acquisition_stop,
763 SR_REGISTER_DEV_DRIVER(saleae_logic16_driver_info);