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.firmware"
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 };
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 };
101 int trigger_stage = TRIGGER_FIRED;
103 static int hw_set_configuration(int device_index, int capability, void *value);
105 /* returns 1 if the device's configuration profile match the Logic firmware's
106 * configuration, 0 otherwise
108 int check_conf_profile(libusb_device *dev)
110 struct libusb_device_descriptor des;
111 struct libusb_config_descriptor *conf_dsc = NULL;
112 const struct libusb_interface_descriptor *intf_dsc;
116 /* Assume it's not a Saleae Logic unless proven wrong. */
119 if (libusb_get_device_descriptor(dev, &des) != 0)
122 if (des.bNumConfigurations != 1)
123 /* Need exactly 1 configuration. */
126 if (libusb_get_config_descriptor(dev, 0, &conf_dsc) != 0)
129 if (conf_dsc->bNumInterfaces != 1)
130 /* Need exactly 1 interface. */
133 if (conf_dsc->interface[0].num_altsetting != 1)
134 /* Need just one alternate setting. */
137 intf_dsc = &(conf_dsc->interface[0].altsetting[0]);
138 if (intf_dsc->bNumEndpoints != 2)
139 /* Need 2 endpoints. */
142 if ((intf_dsc->endpoint[0].bEndpointAddress & 0x8f) !=
143 (1 | LIBUSB_ENDPOINT_OUT))
144 /* First endpoint should be 1 (outbound). */
147 if ((intf_dsc->endpoint[1].bEndpointAddress & 0x8f) !=
148 (2 | LIBUSB_ENDPOINT_IN))
149 /* First endpoint should be 2 (inbound). */
152 /* If we made it here, it must be a Saleae Logic. */
157 libusb_free_config_descriptor(conf_dsc);
162 static int opendev2(int device_index, struct sigrok_device_instance **sdi,
163 libusb_device *dev, struct libusb_device_descriptor *des,
168 if ((err = libusb_get_device_descriptor(dev, des))) {
169 g_warning("failed to get device descriptor: %d", err);
173 if (des->idVendor != USB_VENDOR || des->idProduct != USB_PRODUCT)
176 if (*skip != device_index) {
177 /* Skip devices of this type that aren't the one we want. */
183 * Should check the bus here, since we know that already. But what are
184 * we going to do if it doesn't match after the right number of skips?
186 if (!(err = libusb_open(dev, &((*sdi)->usb->devhdl)))) {
187 (*sdi)->usb->address = libusb_get_device_address(dev);
188 (*sdi)->status = ST_ACTIVE;
189 g_message("opened device %d on %d.%d interface %d",
190 (*sdi)->index, (*sdi)->usb->bus,
191 (*sdi)->usb->address, USB_INTERFACE);
193 g_warning("failed to open device: %d", err);
200 static int opendev3(int device_index, struct sigrok_device_instance **sdi,
201 libusb_device *dev, struct libusb_device_descriptor *des)
205 if ((err = libusb_get_device_descriptor(dev, des))) {
206 g_warning("failed to get device descriptor: %d", err);
210 if (des->idVendor != USB_VENDOR || des->idProduct != USB_PRODUCT)
213 if (libusb_get_bus_number(dev) == (*sdi)->usb->bus
214 && libusb_get_device_address(dev) == (*sdi)->usb->address) {
216 if (!(err = libusb_open(dev, &((*sdi)->usb->devhdl)))) {
217 (*sdi)->status = ST_ACTIVE;
218 g_message("opened device %d on %d.%d interface %d",
219 (*sdi)->index, (*sdi)->usb->bus,
220 (*sdi)->usb->address, USB_INTERFACE);
222 g_warning("failed to open device: %d", err);
230 struct sigrok_device_instance *sl_open_device(int device_index)
232 struct sigrok_device_instance *sdi;
233 libusb_device **devlist;
234 struct libusb_device_descriptor des;
237 if (!(sdi = get_sigrok_device_instance(device_instances, device_index)))
240 libusb_get_device_list(usb_context, &devlist);
241 if (sdi->status == ST_INITIALIZING) {
243 * This device was renumerating last time we touched it.
244 * opendev() guarantees we've waited long enough for it to
245 * have booted properly, so now we need to find it on
246 * the bus and record its new address.
249 for (i = 0; devlist[i]; i++) {
250 /* TODO: Error handling. */
251 err = opendev2(device_index, &sdi, devlist[i], &des,
254 } else if (sdi->status == ST_INACTIVE) {
256 * This device is fully enumerated, so we need to find this
257 * device by vendor, product, bus and address.
259 libusb_get_device_list(usb_context, &devlist);
260 for (i = 0; devlist[i]; i++) {
261 /* TODO: Error handling. */
262 err = opendev3(device_index, &sdi, devlist[i], &des);
265 /* Status must be ST_ACTIVE, i.e. already in use... */
268 libusb_free_device_list(devlist, 1);
270 if (sdi && sdi->status != ST_ACTIVE)
276 int upload_firmware(libusb_device *dev)
278 struct libusb_device_handle *hdl;
281 g_message("uploading firmware to device on %d.%d",
282 libusb_get_bus_number(dev), libusb_get_device_address(dev));
284 err = libusb_open(dev, &hdl);
286 g_warning("failed to open device: %d", err);
290 err = libusb_set_configuration(hdl, USB_CONFIGURATION);
292 g_warning("Unable to set configuration: %d", err);
296 if ((ezusb_reset(hdl, 1)) < 0)
299 if (ezusb_install_firmware(hdl, FIRMWARE) != 0)
302 if ((ezusb_reset(hdl, 0)) < 0)
307 /* Remember when the last firmware update was done. */
308 g_get_current_time(&firmware_updated);
313 static void close_device(struct sigrok_device_instance *sdi)
315 if (sdi->usb->devhdl == NULL)
318 g_message("closing device %d on %d.%d interface %d", sdi->index,
319 sdi->usb->bus, sdi->usb->address, USB_INTERFACE);
320 libusb_release_interface(sdi->usb->devhdl, USB_INTERFACE);
321 libusb_close(sdi->usb->devhdl);
322 sdi->usb->devhdl = NULL;
323 sdi->status = ST_INACTIVE;
326 static int configure_probes(GSList * probes)
330 int probe_bit, stage, i;
334 for (i = 0; i < NUM_TRIGGER_STAGES; i++) {
336 trigger_value[i] = 0;
340 for (l = probes; l; l = l->next) {
341 probe = (struct probe *)l->data;
342 if (probe->enabled == FALSE)
344 probe_bit = 1 << (probe->index - 1);
345 probe_mask |= probe_bit;
346 if (probe->trigger) {
348 for (tc = probe->trigger; *tc; tc++) {
349 trigger_mask[stage] |= probe_bit;
351 trigger_value[stage] |= probe_bit;
353 if (stage > NUM_TRIGGER_STAGES)
361 * We didn't configure any triggers, make sure acquisition
362 * doesn't wait for any.
364 trigger_stage = TRIGGER_FIRED;
375 static int hw_init(char *deviceinfo)
377 struct sigrok_device_instance *sdi;
378 struct libusb_device_descriptor des;
379 libusb_device **devlist;
382 if (libusb_init(&usb_context) != 0) {
383 g_warning("Failed to initialize USB.");
386 libusb_set_debug(usb_context, 3);
388 /* Find all Saleae Logic devices and upload firmware to all of them. */
390 libusb_get_device_list(usb_context, &devlist);
391 for (i = 0; devlist[i]; i++) {
392 err = libusb_get_device_descriptor(devlist[i], &des);
394 g_warning("failed to get device descriptor: %d", err);
398 if (des.idVendor != USB_VENDOR || des.idProduct != USB_PRODUCT)
399 continue; /* Not a Saleae Logic... */
401 sdi = sigrok_device_instance_new(devcnt, ST_INITIALIZING,
402 USB_VENDOR_NAME, USB_MODEL_NAME, USB_MODEL_VERSION);
405 device_instances = g_slist_append(device_instances, sdi);
407 if (check_conf_profile(devlist[i]) == 0) {
409 * Continue on the off chance that the device is in a
410 * working state. TODO: Could maybe try a USB reset,
411 * or uploading the firmware again.
413 if (upload_firmware(devlist[i]) > 0)
414 g_warning("firmware upload failed for device %d", devcnt);
416 sdi->usb = usb_device_instance_new
417 (libusb_get_bus_number(devlist[i]), 0, NULL);
419 /* Already has the firmware, so fix the new address. */
420 sdi->usb = usb_device_instance_new
421 (libusb_get_bus_number(devlist[i]),
422 libusb_get_device_address(devlist[i]),
427 libusb_free_device_list(devlist, 1);
432 static int hw_opendev(int device_index)
435 struct sigrok_device_instance *sdi;
437 unsigned int cur, upd;
439 if (firmware_updated.tv_sec > 0) {
440 /* Firmware was recently uploaded. */
441 g_get_current_time(&cur_time);
442 cur = cur_time.tv_sec * 1000 + cur_time.tv_usec / 1000;
443 upd = firmware_updated.tv_sec * 1000 +
444 firmware_updated.tv_usec / 1000;
445 timediff = cur - upd;
446 if (timediff < FIRMWARE_RENUM_DELAY) {
447 timediff = FIRMWARE_RENUM_DELAY - timediff;
448 g_message("waiting %d ms for device to reset",
450 g_usleep(timediff * 1000);
451 firmware_updated.tv_sec = 0;
455 if (!(sdi = sl_open_device(device_index))) {
456 g_warning("unable to open device");
460 err = libusb_claim_interface(sdi->usb->devhdl, USB_INTERFACE);
462 g_warning("Unable to claim interface: %d", err);
466 if (cur_samplerate == 0) {
467 /* Samplerate hasn't been set; default to the slowest one. */
468 if (hw_set_configuration(device_index, HWCAP_SAMPLERATE,
469 &supported_samplerates[0]) == SIGROK_ERR)
476 static void hw_closedev(int device_index)
478 struct sigrok_device_instance *sdi;
480 if ((sdi = get_sigrok_device_instance(device_instances, device_index)))
484 static void hw_cleanup(void)
488 /* Properly close all devices... */
489 for (l = device_instances; l; l = l->next)
490 close_device((struct sigrok_device_instance *)l->data);
492 /* ...and free all their memory. */
493 for (l = device_instances; l; l = l->next)
495 g_slist_free(device_instances);
496 device_instances = NULL;
499 libusb_exit(usb_context);
503 static void *hw_get_device_info(int device_index, int device_info_id)
505 struct sigrok_device_instance *sdi;
508 if (!(sdi = get_sigrok_device_instance(device_instances, device_index)))
511 switch (device_info_id) {
516 info = GINT_TO_POINTER(NUM_PROBES);
521 case DI_TRIGGER_TYPES:
522 info = TRIGGER_TYPES;
524 case DI_CUR_SAMPLERATE:
525 info = &cur_samplerate;
532 static int hw_get_status(int device_index)
534 struct sigrok_device_instance *sdi;
536 sdi = get_sigrok_device_instance(device_instances, device_index);
543 static int *hw_get_capabilities(void)
548 static int set_configuration_samplerate(struct sigrok_device_instance *sdi,
553 unsigned char buf[2];
555 for (i = 0; supported_samplerates[i]; i++) {
556 if (supported_samplerates[i] == samplerate)
559 if (supported_samplerates[i] == 0)
560 return SIGROK_ERR_SAMPLERATE;
562 divider = (uint8_t) (48 / (float)(samplerate / 1000000)) - 1;
564 g_message("setting samplerate to %" PRIu64 " Hz (divider %d)",
565 samplerate, divider);
568 ret = libusb_bulk_transfer(sdi->usb->devhdl, 1 | LIBUSB_ENDPOINT_OUT,
569 buf, 2, &result, 500);
571 g_warning("failed to set samplerate: %d", ret);
574 cur_samplerate = samplerate;
579 static int hw_set_configuration(int device_index, int capability, void *value)
581 struct sigrok_device_instance *sdi;
585 if (!(sdi = get_sigrok_device_instance(device_instances, device_index)))
588 if (capability == HWCAP_SAMPLERATE) {
590 ret = set_configuration_samplerate(sdi, *tmp_u64);
591 } else if (capability == HWCAP_PROBECONFIG) {
592 ret = configure_probes((GSList *) value);
593 } else if (capability == HWCAP_LIMIT_SAMPLES) {
594 limit_samples = strtoull(value, NULL, 10);
603 static int receive_data(int fd, int revents, void *user_data)
607 tv.tv_sec = tv.tv_usec = 0;
608 libusb_handle_events_timeout(usb_context, &tv);
613 void receive_transfer(struct libusb_transfer *transfer)
615 static int num_samples = 0;
616 static int empty_transfer_count = 0;
617 struct datafeed_packet packet;
619 int cur_buflen, trigger_offset, i;
620 unsigned char *cur_buf, *new_buf;
622 /* hw_stop_acquisition() is telling us to stop. */
623 if (transfer == NULL)
627 * If acquisition has already ended, just free any queued up
628 * transfer that come in.
630 if (num_samples == -1) {
631 libusb_free_transfer(transfer);
635 g_message("receive_transfer(): status %d received %d bytes",
636 transfer->status, transfer->actual_length);
638 /* Save incoming transfer before reusing the transfer struct. */
639 cur_buf = transfer->buffer;
640 cur_buflen = transfer->actual_length;
641 user_data = transfer->user_data;
643 /* Fire off a new request. */
644 new_buf = g_malloc(4096);
645 transfer->buffer = new_buf;
646 transfer->length = 4096;
647 if (libusb_submit_transfer(transfer) != 0) {
648 /* TODO: Stop session? */
652 if (cur_buflen == 0) {
653 empty_transfer_count++;
654 if (empty_transfer_count > MAX_EMPTY_TRANSFERS) {
656 * The FX2 gave up. End the acquisition, the frontend
657 * will work out that the samplecount is short.
659 packet.type = DF_END;
660 session_bus(user_data, &packet);
665 empty_transfer_count = 0;
669 if (trigger_stage >= 0) {
670 for (i = 0; i < cur_buflen; i++) {
671 if ((cur_buf[i] & trigger_mask[trigger_stage])
672 == trigger_value[trigger_stage]) {
673 /* Match on this trigger stage. */
674 trigger_buffer[trigger_stage] = cur_buf[i];
676 if (trigger_stage == NUM_TRIGGER_STAGES
677 || trigger_mask[trigger_stage] == 0) {
678 /* Match on all trigger stages, we're done */
679 trigger_offset = i + 1;
681 /* TODO: Send pre-trigger buffer to session bus. Tell the frontend we hit the trigger here. */
682 packet.type = DF_TRIGGER;
684 session_bus(user_data, &packet);
686 /* Send the samples that triggered it, since we're skipping past them. */
687 packet.type = DF_LOGIC8;
688 packet.length = trigger_stage;
689 packet.payload = trigger_buffer;
690 session_bus(user_data, &packet);
693 trigger_stage = TRIGGER_FIRED;
695 } else if (trigger_stage > 0) {
697 * We had a match before, but not in the next sample. However, we may
698 * have a match on this stage in the next bit -- trigger on 0001 will
699 * fail on seeing 00001, so we need to go back to stage 0 -- but at
700 * the next sample from the one that matched originally, which the
701 * counter increment at the end of the loop takes care of.
705 /* Oops, went back past this buffer. */
707 /* Reset trigger stage. */
713 if (trigger_stage == TRIGGER_FIRED) {
714 /* Send the incoming transfer to the session bus. */
715 packet.type = DF_LOGIC8;
716 packet.length = cur_buflen - trigger_offset;
717 packet.payload = cur_buf + trigger_offset;
718 session_bus(user_data, &packet);
721 num_samples += cur_buflen;
722 if (num_samples > limit_samples) {
723 /* End the acquisition. */
724 packet.type = DF_END;
725 session_bus(user_data, &packet);
730 * TODO: Buffer pre-trigger data in capture
731 * ratio-sized buffer.
736 static int hw_start_acquisition(int device_index, gpointer session_device_id)
738 struct sigrok_device_instance *sdi;
739 struct datafeed_packet *packet;
740 struct datafeed_header *header;
741 struct libusb_transfer *transfer;
742 const struct libusb_pollfd **lupfd;
746 if (!(sdi = get_sigrok_device_instance(device_instances, device_index)))
749 packet = g_malloc(sizeof(struct datafeed_packet));
750 header = g_malloc(sizeof(struct datafeed_header));
751 if (!packet || !header)
754 /* Start with 2K transfer, subsequently increased to 4K. */
756 for (i = 0; i < NUM_SIMUL_TRANSFERS; i++) {
757 buf = g_malloc(size);
758 transfer = libusb_alloc_transfer(0);
759 libusb_fill_bulk_transfer(transfer, sdi->usb->devhdl,
760 2 | LIBUSB_ENDPOINT_IN, buf, size,
761 receive_transfer, session_device_id, 40);
762 if (libusb_submit_transfer(transfer) != 0) {
763 /* TODO: Free them all. */
764 libusb_free_transfer(transfer);
771 lupfd = libusb_get_pollfds(usb_context);
772 for (i = 0; lupfd[i]; i++)
773 source_add(lupfd[i]->fd, lupfd[i]->events, -1, receive_data,
777 packet->type = DF_HEADER;
778 packet->length = sizeof(struct datafeed_header);
779 packet->payload = (unsigned char *)header;
780 header->feed_version = 1;
781 gettimeofday(&header->starttime, NULL);
782 header->samplerate = cur_samplerate;
783 header->protocol_id = PROTO_RAW;
784 header->num_probes = NUM_PROBES;
785 session_bus(session_device_id, packet);
792 /* This stops acquisition on ALL devices, ignoring device_index. */
793 static void hw_stop_acquisition(int device_index, gpointer session_device_id)
795 struct datafeed_packet packet;
797 packet.type = DF_END;
798 session_bus(session_device_id, &packet);
800 receive_transfer(NULL);
802 /* TODO: Need to cancel and free any queued up transfers. */
805 struct device_plugin saleae_logic_plugin_info = {
816 hw_set_configuration,
817 hw_start_acquisition,