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,
53 /* These are really implemented in the driver, not the hardware. */
54 SR_CONF_LIMIT_SAMPLES,
58 static const char *channel_names[] = {
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_channel *ch;
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; channel_names[j]; j++) {
198 if (!(ch = sr_channel_new(j, SR_CHANNEL_LOGIC, TRUE,
201 sdi->channels = g_slist_append(sdi->channels, ch);
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(
217 libusb_get_bus_number(devlist[i]),
218 libusb_get_device_address(devlist[i]), NULL);
220 if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
221 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 for "
226 "device %d.", devcnt);
227 sdi->inst_type = SR_INST_USB;
228 sdi->conn = sr_usb_dev_inst_new(
229 libusb_get_bus_number(devlist[i]), 0xff, NULL);
232 libusb_free_device_list(devlist, 1);
233 g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
238 static GSList *dev_list(void)
240 return ((struct drv_context *)(di->priv))->instances;
243 static int logic16_dev_open(struct sr_dev_inst *sdi)
245 libusb_device **devlist;
246 struct sr_usb_dev_inst *usb;
247 struct libusb_device_descriptor des;
248 struct drv_context *drvc;
249 int ret, skip, i, device_count;
254 if (sdi->status == SR_ST_ACTIVE)
255 /* Device is already in use. */
259 device_count = libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
260 if (device_count < 0) {
261 sr_err("Failed to get device list: %s.",
262 libusb_error_name(device_count));
266 for (i = 0; i < device_count; i++) {
267 if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
268 sr_err("Failed to get device descriptor: %s.",
269 libusb_error_name(ret));
273 if (des.idVendor != LOGIC16_VID || des.idProduct != LOGIC16_PID)
276 if (sdi->status == SR_ST_INITIALIZING) {
277 if (skip != sdi->index) {
278 /* Skip devices of this type that aren't the one we want. */
282 } else if (sdi->status == SR_ST_INACTIVE) {
284 * This device is fully enumerated, so we need to find
285 * this device by vendor, product, bus and address.
287 if (libusb_get_bus_number(devlist[i]) != usb->bus
288 || libusb_get_device_address(devlist[i]) != usb->address)
289 /* This is not the one. */
293 if (!(ret = libusb_open(devlist[i], &usb->devhdl))) {
294 if (usb->address == 0xff)
296 * First time we touch this device after FW
297 * upload, so we don't know the address yet.
299 usb->address = libusb_get_device_address(devlist[i]);
301 sr_err("Failed to open device: %s.",
302 libusb_error_name(ret));
306 ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
307 if (ret == LIBUSB_ERROR_BUSY) {
308 sr_err("Unable to claim USB interface. Another "
309 "program or driver has already claimed it.");
311 } else if (ret == LIBUSB_ERROR_NO_DEVICE) {
312 sr_err("Device has been disconnected.");
314 } else if (ret != 0) {
315 sr_err("Unable to claim interface: %s.",
316 libusb_error_name(ret));
320 if ((ret = logic16_init_device(sdi)) != SR_OK) {
321 sr_err("Failed to init device.");
325 sdi->status = SR_ST_ACTIVE;
326 sr_info("Opened device %d on %d.%d, interface %d.",
327 sdi->index, usb->bus, usb->address, USB_INTERFACE);
331 libusb_free_device_list(devlist, 1);
333 if (sdi->status != SR_ST_ACTIVE) {
335 libusb_release_interface(usb->devhdl, USB_INTERFACE);
336 libusb_close(usb->devhdl);
345 static int dev_open(struct sr_dev_inst *sdi)
347 struct dev_context *devc;
349 int64_t timediff_us, timediff_ms;
354 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
355 * milliseconds for the FX2 to renumerate.
358 if (devc->fw_updated > 0) {
359 sr_info("Waiting for device to reset.");
360 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
361 g_usleep(300 * 1000);
363 while (timediff_ms < MAX_RENUM_DELAY_MS) {
364 if ((ret = logic16_dev_open(sdi)) == SR_OK)
366 g_usleep(100 * 1000);
368 timediff_us = g_get_monotonic_time() - devc->fw_updated;
369 timediff_ms = timediff_us / 1000;
370 sr_spew("Waited %" PRIi64 "ms.", timediff_ms);
373 sr_err("Device failed to renumerate.");
376 sr_info("Device came back after %" PRIi64 "ms.", timediff_ms);
378 sr_info("Firmware upload was not needed.");
379 ret = logic16_dev_open(sdi);
383 sr_err("Unable to open device.");
387 if (devc->cur_samplerate == 0) {
388 /* Samplerate hasn't been set; default to the slowest one. */
389 devc->cur_samplerate = samplerates[0];
395 static int dev_close(struct sr_dev_inst *sdi)
397 struct sr_usb_dev_inst *usb;
400 if (usb->devhdl == NULL)
403 sr_info("Closing device %d on %d.%d interface %d.",
404 sdi->index, usb->bus, usb->address, USB_INTERFACE);
405 libusb_release_interface(usb->devhdl, USB_INTERFACE);
406 libusb_close(usb->devhdl);
408 sdi->status = SR_ST_INACTIVE;
413 static int cleanup(void)
416 struct drv_context *drvc;
418 if (!(drvc = di->priv))
419 /* Can get called on an unused driver, doesn't matter. */
423 ret = std_dev_clear(di, NULL);
430 static int config_get(int key, GVariant **data, const struct sr_dev_inst *sdi,
431 const struct sr_channel_group *cg)
433 struct dev_context *devc;
434 struct sr_usb_dev_inst *usb;
445 if (!sdi || !sdi->conn)
448 if (usb->address == 255)
449 /* Device still needs to re-enumerate after firmware
450 * upload, so we don't know its (future) address. */
452 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
453 *data = g_variant_new_string(str);
455 case SR_CONF_SAMPLERATE:
459 *data = g_variant_new_uint64(devc->cur_samplerate);
461 case SR_CONF_VOLTAGE_THRESHOLD:
466 for (i = 0; i < ARRAY_SIZE(volt_thresholds); i++) {
467 if (devc->selected_voltage_range !=
468 volt_thresholds[i].range)
470 range[0] = g_variant_new_double(volt_thresholds[i].low);
471 range[1] = g_variant_new_double(volt_thresholds[i].high);
472 *data = g_variant_new_tuple(range, 2);
484 static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi,
485 const struct sr_channel_group *cg)
487 struct dev_context *devc;
494 if (sdi->status != SR_ST_ACTIVE)
495 return SR_ERR_DEV_CLOSED;
501 case SR_CONF_SAMPLERATE:
502 devc->cur_samplerate = g_variant_get_uint64(data);
504 case SR_CONF_LIMIT_SAMPLES:
505 devc->limit_samples = g_variant_get_uint64(data);
507 case SR_CONF_VOLTAGE_THRESHOLD:
508 g_variant_get(data, "(dd)", &low, &high);
510 for (i = 0; i < ARRAY_SIZE(volt_thresholds); i++) {
511 if (fabs(volt_thresholds[i].low - low) < 0.1 &&
512 fabs(volt_thresholds[i].high - high) < 0.1) {
513 devc->selected_voltage_range =
514 volt_thresholds[i].range;
527 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
528 const struct sr_channel_group *cg)
530 GVariant *gvar, *range[2];
540 case SR_CONF_SCAN_OPTIONS:
541 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
542 hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
544 case SR_CONF_DEVICE_OPTIONS:
545 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
546 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
548 case SR_CONF_SAMPLERATE:
549 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
550 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
551 samplerates, ARRAY_SIZE(samplerates), sizeof(uint64_t));
552 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
553 *data = g_variant_builder_end(&gvb);
555 case SR_CONF_VOLTAGE_THRESHOLD:
556 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
557 for (i = 0; i < ARRAY_SIZE(volt_thresholds); i++) {
558 range[0] = g_variant_new_double(volt_thresholds[i].low);
559 range[1] = g_variant_new_double(volt_thresholds[i].high);
560 gvar = g_variant_new_tuple(range, 2);
561 g_variant_builder_add_value(&gvb, gvar);
563 *data = g_variant_builder_end(&gvb);
572 static void abort_acquisition(struct dev_context *devc)
576 devc->num_samples = -1;
578 for (i = devc->num_transfers - 1; i >= 0; i--) {
579 if (devc->transfers[i])
580 libusb_cancel_transfer(devc->transfers[i]);
584 static unsigned int bytes_per_ms(struct dev_context *devc)
586 return devc->cur_samplerate * devc->num_channels / 8000;
589 static size_t get_buffer_size(struct dev_context *devc)
594 * The buffer should be large enough to hold 10ms of data and
597 s = 10 * bytes_per_ms(devc);
598 return (s + 511) & ~511;
601 static unsigned int get_number_of_transfers(struct dev_context *devc)
605 /* Total buffer size should be able to hold about 500ms of data. */
606 n = 500 * bytes_per_ms(devc) / get_buffer_size(devc);
608 if (n > NUM_SIMUL_TRANSFERS)
609 return NUM_SIMUL_TRANSFERS;
614 static unsigned int get_timeout(struct dev_context *devc)
617 unsigned int timeout;
619 total_size = get_buffer_size(devc) * get_number_of_transfers(devc);
620 timeout = total_size / bytes_per_ms(devc);
621 return timeout + timeout / 4; /* Leave a headroom of 25% percent. */
624 static int configure_channels(const struct sr_dev_inst *sdi)
626 struct dev_context *devc;
627 struct sr_channel *ch;
629 uint16_t channel_bit;
633 devc->cur_channels = 0;
634 devc->num_channels = 0;
635 for (l = sdi->channels; l; l = l->next) {
636 ch = (struct sr_channel *)l->data;
637 if (ch->enabled == FALSE)
640 channel_bit = 1 << (ch->index);
642 devc->cur_channels |= channel_bit;
644 #ifdef WORDS_BIGENDIAN
646 * Output logic data should be stored in little endian format.
647 * To speed things up during conversion, do the switcharoo
650 channel_bit = 1 << (ch->index ^ 8);
653 devc->channel_masks[devc->num_channels++] = channel_bit;
659 static int receive_data(int fd, int revents, void *cb_data)
662 struct dev_context *devc;
663 struct drv_context *drvc;
664 const struct sr_dev_inst *sdi;
673 tv.tv_sec = tv.tv_usec = 0;
674 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
676 if (devc->num_samples == -2) {
677 logic16_abort_acquisition(sdi);
678 abort_acquisition(devc);
684 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
686 struct dev_context *devc;
687 struct drv_context *drvc;
688 struct sr_usb_dev_inst *usb;
689 struct libusb_transfer *transfer;
690 unsigned int i, timeout, num_transfers;
693 size_t size, convsize;
695 if (sdi->status != SR_ST_ACTIVE)
696 return SR_ERR_DEV_CLOSED;
702 /* Configures devc->cur_channels. */
703 if (configure_channels(sdi) != SR_OK) {
704 sr_err("Failed to configure channels.");
708 devc->cb_data = cb_data;
709 devc->num_samples = 0;
710 devc->empty_transfer_count = 0;
711 devc->cur_channel = 0;
712 memset(devc->channel_data, 0, sizeof(devc->channel_data));
714 timeout = get_timeout(devc);
715 num_transfers = get_number_of_transfers(devc);
716 size = get_buffer_size(devc);
717 convsize = (size / devc->num_channels + 2) * 16;
718 devc->submitted_transfers = 0;
720 devc->convbuffer_size = convsize;
721 if (!(devc->convbuffer = g_try_malloc(convsize))) {
722 sr_err("Conversion buffer malloc failed.");
723 return SR_ERR_MALLOC;
726 devc->transfers = g_try_malloc0(sizeof(*devc->transfers) * num_transfers);
727 if (!devc->transfers) {
728 sr_err("USB transfers malloc failed.");
729 g_free(devc->convbuffer);
730 return SR_ERR_MALLOC;
733 if ((ret = logic16_setup_acquisition(sdi, devc->cur_samplerate,
734 devc->cur_channels)) != SR_OK) {
735 g_free(devc->transfers);
736 g_free(devc->convbuffer);
740 devc->num_transfers = num_transfers;
741 for (i = 0; i < num_transfers; i++) {
742 if (!(buf = g_try_malloc(size))) {
743 sr_err("USB transfer buffer malloc failed.");
744 if (devc->submitted_transfers)
745 abort_acquisition(devc);
747 g_free(devc->transfers);
748 g_free(devc->convbuffer);
750 return SR_ERR_MALLOC;
752 transfer = libusb_alloc_transfer(0);
753 libusb_fill_bulk_transfer(transfer, usb->devhdl,
754 2 | LIBUSB_ENDPOINT_IN, buf, size,
755 logic16_receive_transfer, devc, timeout);
756 if ((ret = libusb_submit_transfer(transfer)) != 0) {
757 sr_err("Failed to submit transfer: %s.",
758 libusb_error_name(ret));
759 libusb_free_transfer(transfer);
761 abort_acquisition(devc);
764 devc->transfers[i] = transfer;
765 devc->submitted_transfers++;
768 devc->ctx = drvc->sr_ctx;
770 usb_source_add(devc->ctx, timeout, receive_data, (void *)sdi);
772 /* Send header packet to the session bus. */
773 std_session_send_df_header(cb_data, LOG_PREFIX);
775 if ((ret = logic16_start_acquisition(sdi)) != SR_OK) {
776 abort_acquisition(devc);
783 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
789 if (sdi->status != SR_ST_ACTIVE)
790 return SR_ERR_DEV_CLOSED;
792 ret = logic16_abort_acquisition(sdi);
794 abort_acquisition(sdi->priv);
799 SR_PRIV struct sr_dev_driver saleae_logic16_driver_info = {
800 .name = "saleae-logic16",
801 .longname = "Saleae Logic16",
806 .dev_list = dev_list,
808 .config_get = config_get,
809 .config_set = config_set,
810 .config_list = config_list,
811 .dev_open = dev_open,
812 .dev_close = dev_close,
813 .dev_acquisition_start = dev_acquisition_start,
814 .dev_acquisition_stop = dev_acquisition_stop,