2 * This file is part of the sigrok project.
4 * Copyright (C) 2010 Bert Vermeulen <bert@biot.com>
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/>.
29 #define USB_VENDOR 0x0925
30 #define USB_PRODUCT 0x3881
31 #define USB_VENDOR_NAME "Saleae"
32 #define USB_MODEL_NAME "Logic"
33 #define USB_MODEL_VERSION ""
35 #define USB_INTERFACE 0
36 #define USB_CONFIGURATION 1
38 #define NUM_TRIGGER_STAGES 4
39 #define TRIGGER_TYPES "01"
40 #define FIRMWARE FIRMWARE_DIR "/saleae-logic.fw"
43 #define FIRMWARE_RENUM_DELAY 2000
44 #define NUM_SIMUL_TRANSFERS 10
45 #define MAX_EMPTY_TRANSFERS (NUM_SIMUL_TRANSFERS * 2)
47 /* Software trigger implementation: positive values indicate trigger stage. */
48 #define TRIGGER_FIRED -1
50 /* There is only one model Saleae Logic, and this is what it supports: */
51 static int capabilities[] = {
55 /* These are really implemented in the driver, not the hardware. */
60 /* List of struct sigrok_device_instance, maintained by opendev()/closedev(). */
61 static GSList *device_instances = NULL;
64 * Since we can't keep track of a Saleae Logic device after upgrading the
65 * firmware -- it re-enumerates into a different device address after the
66 * upgrade -- this is like a global lock. No device will open until a proper
67 * delay after the last device was upgraded.
69 GTimeVal firmware_updated = { 0, 0 };
71 static libusb_context *usb_context = NULL;
73 static uint64_t supported_samplerates[] = {
87 static struct samplerates samplerates = {
91 supported_samplerates,
94 /* TODO: All of these should go in a device-specific struct. */
95 static uint64_t cur_samplerate = 0;
96 static uint64_t limit_samples = 0;
97 static uint8_t probe_mask = 0;
98 static uint8_t trigger_mask[NUM_TRIGGER_STAGES] = { 0 };
99 static uint8_t trigger_value[NUM_TRIGGER_STAGES] = { 0 };
100 static uint8_t trigger_buffer[NUM_TRIGGER_STAGES] = { 0 };
102 int trigger_stage = TRIGGER_FIRED;
104 static int hw_set_configuration(int device_index, int capability, void *value);
105 static void hw_stop_acquisition(int device_index, gpointer session_device_id);
108 * Check the USB configuration to determine if this is a Saleae Logic.
110 * @return 1 if the device's configuration profile match the Logic firmware's
111 * configuration, 0 otherwise.
113 int check_conf_profile(libusb_device *dev)
115 struct libusb_device_descriptor des;
116 struct libusb_config_descriptor *conf_dsc = NULL;
117 const struct libusb_interface_descriptor *intf_dsc;
121 /* Assume it's not a Saleae Logic unless proven wrong. */
124 if (libusb_get_device_descriptor(dev, &des) != 0)
127 if (des.bNumConfigurations != 1)
128 /* Need exactly 1 configuration. */
131 if (libusb_get_config_descriptor(dev, 0, &conf_dsc) != 0)
134 if (conf_dsc->bNumInterfaces != 1)
135 /* Need exactly 1 interface. */
138 if (conf_dsc->interface[0].num_altsetting != 1)
139 /* Need just one alternate setting. */
142 intf_dsc = &(conf_dsc->interface[0].altsetting[0]);
143 if (intf_dsc->bNumEndpoints != 2)
144 /* Need 2 endpoints. */
147 if ((intf_dsc->endpoint[0].bEndpointAddress & 0x8f) !=
148 (1 | LIBUSB_ENDPOINT_OUT))
149 /* First endpoint should be 1 (outbound). */
152 if ((intf_dsc->endpoint[1].bEndpointAddress & 0x8f) !=
153 (2 | LIBUSB_ENDPOINT_IN))
154 /* First endpoint should be 2 (inbound). */
157 /* If we made it here, it must be a Saleae Logic. */
162 libusb_free_config_descriptor(conf_dsc);
167 static int opendev2(int device_index, struct sigrok_device_instance **sdi,
168 libusb_device *dev, struct libusb_device_descriptor *des,
169 int *skip, uint16_t vid, uint16_t pid, int interface)
173 if ((err = libusb_get_device_descriptor(dev, des))) {
174 g_warning("failed to get device descriptor: %d", err);
178 if (des->idVendor != vid || des->idProduct != pid)
181 if (*skip != device_index) {
182 /* Skip devices of this type that aren't the one we want. */
188 * Should check the bus here, since we know that already. But what are
189 * we going to do if it doesn't match after the right number of skips?
191 if (!(err = libusb_open(dev, &((*sdi)->usb->devhdl)))) {
192 (*sdi)->usb->address = libusb_get_device_address(dev);
193 (*sdi)->status = ST_ACTIVE;
194 g_message("opened device %d on %d.%d interface %d",
195 (*sdi)->index, (*sdi)->usb->bus,
196 (*sdi)->usb->address, interface);
198 g_warning("failed to open device: %d", err);
205 static int opendev3(struct sigrok_device_instance **sdi, libusb_device *dev,
206 struct libusb_device_descriptor *des,
207 uint16_t vid, uint16_t pid, int interface)
211 if ((err = libusb_get_device_descriptor(dev, des))) {
212 g_warning("failed to get device descriptor: %d", err);
216 if (des->idVendor != vid || des->idProduct != pid)
219 if (libusb_get_bus_number(dev) == (*sdi)->usb->bus
220 && libusb_get_device_address(dev) == (*sdi)->usb->address) {
222 if (!(err = libusb_open(dev, &((*sdi)->usb->devhdl)))) {
223 (*sdi)->status = ST_ACTIVE;
224 g_message("opened device %d on %d.%d interface %d",
225 (*sdi)->index, (*sdi)->usb->bus,
226 (*sdi)->usb->address, interface);
228 g_warning("failed to open device: %d", err);
236 struct sigrok_device_instance *sl_open_device(int device_index)
238 struct sigrok_device_instance *sdi;
239 libusb_device **devlist;
240 struct libusb_device_descriptor des;
243 if (!(sdi = get_sigrok_device_instance(device_instances, device_index)))
246 libusb_get_device_list(usb_context, &devlist);
247 if (sdi->status == ST_INITIALIZING) {
249 * This device was renumerating last time we touched it.
250 * opendev() guarantees we've waited long enough for it to
251 * have booted properly, so now we need to find it on
252 * the bus and record its new address.
255 for (i = 0; devlist[i]; i++) {
256 /* TODO: Error handling. */
257 err = opendev2(device_index, &sdi, devlist[i], &des,
258 &skip, USB_VENDOR, USB_PRODUCT,
261 } else if (sdi->status == ST_INACTIVE) {
263 * This device is fully enumerated, so we need to find this
264 * device by vendor, product, bus and address.
266 libusb_get_device_list(usb_context, &devlist);
267 for (i = 0; devlist[i]; i++) {
268 /* TODO: Error handling. */
269 err = opendev3(&sdi, devlist[i], &des, USB_VENDOR,
270 USB_PRODUCT, USB_INTERFACE);
273 /* Status must be ST_ACTIVE, i.e. already in use... */
276 libusb_free_device_list(devlist, 1);
278 if (sdi && sdi->status != ST_ACTIVE)
284 int upload_firmware(libusb_device *dev)
288 ret = ezusb_upload_firmware(dev, USB_CONFIGURATION, FIRMWARE);
292 /* Remember when the last firmware update was done. */
293 g_get_current_time(&firmware_updated);
298 static void close_device(struct sigrok_device_instance *sdi)
300 if (sdi->usb->devhdl == NULL)
303 g_message("closing device %d on %d.%d interface %d", sdi->index,
304 sdi->usb->bus, sdi->usb->address, USB_INTERFACE);
305 libusb_release_interface(sdi->usb->devhdl, USB_INTERFACE);
306 libusb_close(sdi->usb->devhdl);
307 sdi->usb->devhdl = NULL;
308 sdi->status = ST_INACTIVE;
311 static int configure_probes(GSList *probes)
315 int probe_bit, stage, i;
319 for (i = 0; i < NUM_TRIGGER_STAGES; i++) {
321 trigger_value[i] = 0;
325 for (l = probes; l; l = l->next) {
326 probe = (struct probe *)l->data;
327 if (probe->enabled == FALSE)
329 probe_bit = 1 << (probe->index - 1);
330 probe_mask |= probe_bit;
331 if (probe->trigger) {
333 for (tc = probe->trigger; *tc; tc++) {
334 trigger_mask[stage] |= probe_bit;
336 trigger_value[stage] |= probe_bit;
338 if (stage > NUM_TRIGGER_STAGES)
346 * We didn't configure any triggers, make sure acquisition
347 * doesn't wait for any.
349 trigger_stage = TRIGGER_FIRED;
360 static int hw_init(char *deviceinfo)
362 struct sigrok_device_instance *sdi;
363 struct libusb_device_descriptor des;
364 libusb_device **devlist;
368 deviceinfo = deviceinfo;
370 if (libusb_init(&usb_context) != 0) {
371 g_warning("Failed to initialize USB.");
374 libusb_set_debug(usb_context, 3);
376 /* Find all Saleae Logic devices and upload firmware to all of them. */
378 libusb_get_device_list(usb_context, &devlist);
379 for (i = 0; devlist[i]; i++) {
380 err = libusb_get_device_descriptor(devlist[i], &des);
382 g_warning("failed to get device descriptor: %d", err);
386 if (des.idVendor != USB_VENDOR || des.idProduct != USB_PRODUCT)
387 continue; /* Not a Saleae Logic... */
389 sdi = sigrok_device_instance_new(devcnt, ST_INITIALIZING,
390 USB_VENDOR_NAME, USB_MODEL_NAME, USB_MODEL_VERSION);
393 device_instances = g_slist_append(device_instances, sdi);
395 if (check_conf_profile(devlist[i]) == 0) {
397 * Continue on the off chance that the device is in a
398 * working state. TODO: Could maybe try a USB reset,
399 * or uploading the firmware again.
401 if (upload_firmware(devlist[i]) > 0)
402 g_warning("firmware upload failed for "
403 "device %d", devcnt);
405 sdi->usb = usb_device_instance_new
406 (libusb_get_bus_number(devlist[i]), 0, NULL);
408 /* Already has the firmware, so fix the new address. */
409 sdi->usb = usb_device_instance_new
410 (libusb_get_bus_number(devlist[i]),
411 libusb_get_device_address(devlist[i]), NULL);
415 libusb_free_device_list(devlist, 1);
420 static int hw_opendev(int device_index)
423 struct sigrok_device_instance *sdi;
425 unsigned int cur, upd;
427 if (firmware_updated.tv_sec > 0) {
428 /* Firmware was recently uploaded. */
429 g_get_current_time(&cur_time);
430 cur = cur_time.tv_sec * 1000 + cur_time.tv_usec / 1000;
431 upd = firmware_updated.tv_sec * 1000 +
432 firmware_updated.tv_usec / 1000;
433 timediff = cur - upd;
434 if (timediff < FIRMWARE_RENUM_DELAY) {
435 timediff = FIRMWARE_RENUM_DELAY - timediff;
436 g_message("waiting %d ms for device to reset",
438 g_usleep(timediff * 1000);
439 firmware_updated.tv_sec = 0;
443 if (!(sdi = sl_open_device(device_index))) {
444 g_warning("unable to open device");
448 err = libusb_claim_interface(sdi->usb->devhdl, USB_INTERFACE);
450 g_warning("Unable to claim interface: %d", err);
454 if (cur_samplerate == 0) {
455 /* Samplerate hasn't been set; default to the slowest one. */
456 if (hw_set_configuration(device_index, HWCAP_SAMPLERATE,
457 &supported_samplerates[0]) == SIGROK_ERR)
464 static void hw_closedev(int device_index)
466 struct sigrok_device_instance *sdi;
468 if ((sdi = get_sigrok_device_instance(device_instances, device_index)))
472 static void hw_cleanup(void)
476 /* Properly close all devices... */
477 for (l = device_instances; l; l = l->next)
478 close_device((struct sigrok_device_instance *)l->data);
480 /* ...and free all their memory. */
481 for (l = device_instances; l; l = l->next)
483 g_slist_free(device_instances);
484 device_instances = NULL;
487 libusb_exit(usb_context);
491 static void *hw_get_device_info(int device_index, int device_info_id)
493 struct sigrok_device_instance *sdi;
496 if (!(sdi = get_sigrok_device_instance(device_instances, device_index)))
499 switch (device_info_id) {
504 info = GINT_TO_POINTER(NUM_PROBES);
509 case DI_TRIGGER_TYPES:
510 info = TRIGGER_TYPES;
512 case DI_CUR_SAMPLERATE:
513 info = &cur_samplerate;
520 static int hw_get_status(int device_index)
522 struct sigrok_device_instance *sdi;
524 sdi = get_sigrok_device_instance(device_instances, device_index);
531 static int *hw_get_capabilities(void)
536 static int set_configuration_samplerate(struct sigrok_device_instance *sdi,
541 unsigned char buf[2];
543 for (i = 0; supported_samplerates[i]; i++) {
544 if (supported_samplerates[i] == samplerate)
547 if (supported_samplerates[i] == 0)
548 return SIGROK_ERR_SAMPLERATE;
550 divider = (uint8_t) (48 / (samplerate / 1000000.0)) - 1;
552 g_message("setting samplerate to %" PRIu64 " Hz (divider %d)",
553 samplerate, divider);
556 ret = libusb_bulk_transfer(sdi->usb->devhdl, 1 | LIBUSB_ENDPOINT_OUT,
557 buf, 2, &result, 500);
559 g_warning("failed to set samplerate: %d", ret);
562 cur_samplerate = samplerate;
567 static int hw_set_configuration(int device_index, int capability, void *value)
569 struct sigrok_device_instance *sdi;
573 if (!(sdi = get_sigrok_device_instance(device_instances, device_index)))
576 if (capability == HWCAP_SAMPLERATE) {
578 ret = set_configuration_samplerate(sdi, *tmp_u64);
579 } else if (capability == HWCAP_PROBECONFIG) {
580 ret = configure_probes((GSList *) value);
581 } else if (capability == HWCAP_LIMIT_SAMPLES) {
582 limit_samples = strtoull(value, NULL, 10);
591 static int receive_data(int fd, int revents, void *user_data)
598 user_data = user_data;
600 tv.tv_sec = tv.tv_usec = 0;
601 libusb_handle_events_timeout(usb_context, &tv);
606 static void trigger_helper(int i, unsigned char *cur_buf,
607 struct datafeed_packet *packet, void *user_data,
610 if ((cur_buf[i] & trigger_mask[trigger_stage])
611 == trigger_value[trigger_stage]) {
612 /* Match on this trigger stage. */
613 trigger_buffer[trigger_stage] = cur_buf[i];
615 if (trigger_stage == NUM_TRIGGER_STAGES
616 || trigger_mask[trigger_stage] == 0) {
617 /* Match on all trigger stages, we're done. */
618 *trigger_offset = i + 1;
621 * TODO: Send pre-trigger buffer to session bus.
622 * Tell the frontend we hit the trigger here.
624 packet->type = DF_TRIGGER;
626 session_bus(user_data, packet);
629 * Send the samples that triggered it, since we're
630 * skipping past them.
632 packet->type = DF_LOGIC8;
633 packet->length = trigger_stage;
634 packet->payload = trigger_buffer;
635 session_bus(user_data, packet);
636 // break; // FIXME???
638 trigger_stage = TRIGGER_FIRED;
644 * We had a match before, but not in the next sample. However, we may
645 * have a match on this stage in the next bit -- trigger on 0001 will
646 * fail on seeing 00001, so we need to go back to stage 0 -- but at
647 * the next sample from the one that matched originally, which the
648 * counter increment at the end of the loop takes care of.
650 if (trigger_stage > 0) {
653 i = -1; /* Oops, went back past this buffer. */
654 /* Reset trigger stage. */
659 void receive_transfer(struct libusb_transfer *transfer)
661 static int num_samples = 0;
662 static int empty_transfer_count = 0;
663 struct datafeed_packet packet;
665 int cur_buflen, trigger_offset, i;
666 unsigned char *cur_buf, *new_buf;
668 /* hw_stop_acquisition() is telling us to stop. */
669 if (transfer == NULL)
673 * If acquisition has already ended, just free any queued up
674 * transfer that come in.
676 if (num_samples == -1) {
678 libusb_free_transfer(transfer);
682 g_message("receive_transfer(): status %d received %d bytes",
683 transfer->status, transfer->actual_length);
685 /* Save incoming transfer before reusing the transfer struct. */
686 cur_buf = transfer->buffer;
687 cur_buflen = transfer->actual_length;
688 user_data = transfer->user_data;
690 /* Fire off a new request. */
691 new_buf = g_malloc(4096);
692 transfer->buffer = new_buf;
693 transfer->length = 4096;
694 if (libusb_submit_transfer(transfer) != 0) {
695 /* TODO: Stop session? */
699 if (cur_buflen == 0) {
700 empty_transfer_count++;
701 if (empty_transfer_count > MAX_EMPTY_TRANSFERS) {
703 * The FX2 gave up. End the acquisition, the frontend
704 * will work out that the samplecount is short.
706 hw_stop_acquisition(-1, user_data);
710 empty_transfer_count = 0;
714 if (trigger_stage >= 0) {
715 for (i = 0; i < cur_buflen; i++) {
716 trigger_helper(i, cur_buf, &packet, user_data,
721 if (trigger_stage == TRIGGER_FIRED) {
722 /* Send the incoming transfer to the session bus. */
723 packet.type = DF_LOGIC8;
724 packet.length = cur_buflen - trigger_offset;
725 packet.payload = cur_buf + trigger_offset;
726 session_bus(user_data, &packet);
729 num_samples += cur_buflen;
730 if ((unsigned int)num_samples > limit_samples) {
731 hw_stop_acquisition(-1, user_data);
735 * TODO: Buffer pre-trigger data in capture
736 * ratio-sized buffer.
741 static int hw_start_acquisition(int device_index, gpointer session_device_id)
743 struct sigrok_device_instance *sdi;
744 struct datafeed_packet *packet;
745 struct datafeed_header *header;
746 struct libusb_transfer *transfer;
747 const struct libusb_pollfd **lupfd;
751 if (!(sdi = get_sigrok_device_instance(device_instances, device_index)))
754 packet = g_malloc(sizeof(struct datafeed_packet));
755 header = g_malloc(sizeof(struct datafeed_header));
756 if (!packet || !header)
759 /* Start with 2K transfer, subsequently increased to 4K. */
761 for (i = 0; i < NUM_SIMUL_TRANSFERS; i++) {
762 buf = g_malloc(size);
763 transfer = libusb_alloc_transfer(0);
764 libusb_fill_bulk_transfer(transfer, sdi->usb->devhdl,
765 2 | LIBUSB_ENDPOINT_IN, buf, size,
766 receive_transfer, session_device_id, 40);
767 if (libusb_submit_transfer(transfer) != 0) {
768 /* TODO: Free them all. */
769 libusb_free_transfer(transfer);
776 lupfd = libusb_get_pollfds(usb_context);
777 for (i = 0; lupfd[i]; i++)
778 source_add(lupfd[i]->fd, lupfd[i]->events, 40, receive_data,
782 packet->type = DF_HEADER;
783 packet->length = sizeof(struct datafeed_header);
784 packet->payload = (unsigned char *)header;
785 header->feed_version = 1;
786 gettimeofday(&header->starttime, NULL);
787 header->samplerate = cur_samplerate;
788 header->protocol_id = PROTO_RAW;
789 header->num_probes = NUM_PROBES;
790 session_bus(session_device_id, packet);
797 /* This stops acquisition on ALL devices, ignoring device_index. */
798 static void hw_stop_acquisition(int device_index, gpointer session_device_id)
800 struct datafeed_packet packet;
803 device_index = device_index;
805 packet.type = DF_END;
806 session_bus(session_device_id, &packet);
808 receive_transfer(NULL);
810 /* TODO: Need to cancel and free any queued up transfers. */
813 struct device_plugin saleae_logic_plugin_info = {
824 hw_set_configuration,
825 hw_start_acquisition,