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/>.
28 #include "sigrok-internal.h"
29 #include "saleae-logic.h"
31 static struct fx2_profile supported_fx2[] = {
33 { 0x0925, 0x3881, 0x0925, 0x3881, "Saleae", "Logic", NULL, 8 },
34 /* default Cypress FX2 without EEPROM */
35 { 0x04b4, 0x8613, 0x0925, 0x3881, "Cypress", "FX2", NULL, 16 },
36 { 0, 0, 0, 0, 0, 0, 0, 0 }
39 static int capabilities[] = {
40 SR_HWCAP_LOGIC_ANALYZER,
43 /* These are really implemented in the driver, not the hardware. */
44 SR_HWCAP_LIMIT_SAMPLES,
49 static uint64_t supported_samplerates[] = {
63 static struct sr_samplerates samplerates = {
67 supported_samplerates,
70 /* List of struct sr_device_instance, maintained by opendev()/closedev(). */
71 static GSList *device_instances = NULL;
72 static libusb_context *usb_context = NULL;
74 static int hw_set_configuration(int device_index, int capability, void *value);
75 static void hw_stop_acquisition(int device_index, gpointer session_device_id);
78 * Check the USB configuration to determine if this is a Saleae Logic.
80 * @return 1 if the device's configuration profile match the Logic firmware's
81 * configuration, 0 otherwise.
83 static int check_conf_profile(libusb_device *dev)
85 struct libusb_device_descriptor des;
86 struct libusb_config_descriptor *conf_dsc = NULL;
87 const struct libusb_interface_descriptor *intf_dsc;
91 /* Assume it's not a Saleae Logic unless proven wrong. */
94 if (libusb_get_device_descriptor(dev, &des) != 0)
97 if (des.bNumConfigurations != 1)
98 /* Need exactly 1 configuration. */
101 if (libusb_get_config_descriptor(dev, 0, &conf_dsc) != 0)
104 if (conf_dsc->bNumInterfaces != 1)
105 /* Need exactly 1 interface. */
108 if (conf_dsc->interface[0].num_altsetting != 1)
109 /* Need just one alternate setting. */
112 intf_dsc = &(conf_dsc->interface[0].altsetting[0]);
113 if (intf_dsc->bNumEndpoints != 2)
114 /* Need 2 endpoints. */
117 if ((intf_dsc->endpoint[0].bEndpointAddress & 0x8f) !=
118 (1 | LIBUSB_ENDPOINT_OUT))
119 /* First endpoint should be 1 (outbound). */
122 if ((intf_dsc->endpoint[1].bEndpointAddress & 0x8f) !=
123 (2 | LIBUSB_ENDPOINT_IN))
124 /* First endpoint should be 2 (inbound). */
127 /* If we made it here, it must be a Saleae Logic. */
132 libusb_free_config_descriptor(conf_dsc);
137 static int sl_open_device(int device_index)
139 libusb_device **devlist;
140 struct libusb_device_descriptor des;
141 struct sr_device_instance *sdi;
142 struct fx2_device *fx2;
145 if (!(sdi = sr_get_device_instance(device_instances, device_index)))
149 if (sdi->status == SR_ST_ACTIVE)
154 libusb_get_device_list(usb_context, &devlist);
155 for (i = 0; devlist[i]; i++) {
156 if ((err = libusb_get_device_descriptor(devlist[i], &des))) {
157 sr_warn("failed to get device descriptor: %d", err);
161 if (des.idVendor != fx2->profile->fw_vid || des.idProduct != fx2->profile->fw_pid)
164 if (sdi->status == SR_ST_INITIALIZING) {
165 if (skip != device_index) {
166 /* Skip devices of this type that aren't the one we want. */
170 } else if (sdi->status == SR_ST_INACTIVE) {
172 * This device is fully enumerated, so we need to find this
173 * device by vendor, product, bus and address.
175 if (libusb_get_bus_number(devlist[i]) != sdi->usb->bus
176 || libusb_get_device_address(devlist[i]) != sdi->usb->address)
177 /* this is not the one */
181 if (!(err = libusb_open(devlist[i], &sdi->usb->devhdl))) {
182 if (sdi->usb->address == 0xff)
184 * first time we touch this device after firmware upload,
185 * so we don't know the address yet.
187 sdi->usb->address = libusb_get_device_address(devlist[i]);
189 sdi->status = SR_ST_ACTIVE;
190 sr_info("saleae: opened device %d on %d.%d interface %d",
191 sdi->index, sdi->usb->bus,
192 sdi->usb->address, USB_INTERFACE);
194 sr_warn("failed to open device: %d", err);
197 /* if we made it here, we handled the device one way or another */
200 libusb_free_device_list(devlist, 1);
202 if (sdi->status != SR_ST_ACTIVE)
208 static void close_device(struct sr_device_instance *sdi)
210 if (sdi->usb->devhdl == NULL)
213 sr_info("saleae: closing device %d on %d.%d interface %d", sdi->index,
214 sdi->usb->bus, sdi->usb->address, USB_INTERFACE);
215 libusb_release_interface(sdi->usb->devhdl, USB_INTERFACE);
216 libusb_close(sdi->usb->devhdl);
217 sdi->usb->devhdl = NULL;
218 sdi->status = SR_ST_INACTIVE;
221 static int configure_probes(struct fx2_device *fx2, GSList *probes)
223 struct sr_probe *probe;
225 int probe_bit, stage, i;
229 for (i = 0; i < NUM_TRIGGER_STAGES; i++) {
230 fx2->trigger_mask[i] = 0;
231 fx2->trigger_value[i] = 0;
235 for (l = probes; l; l = l->next) {
236 probe = (struct sr_probe *)l->data;
237 if (probe->enabled == FALSE)
239 probe_bit = 1 << (probe->index - 1);
240 fx2->probe_mask |= probe_bit;
241 if (!(probe->trigger))
245 for (tc = probe->trigger; *tc; tc++) {
246 fx2->trigger_mask[stage] |= probe_bit;
248 fx2->trigger_value[stage] |= probe_bit;
250 if (stage > NUM_TRIGGER_STAGES)
257 * We didn't configure any triggers, make sure acquisition
258 * doesn't wait for any.
260 fx2->trigger_stage = TRIGGER_FIRED;
262 fx2->trigger_stage = 0;
267 static struct fx2_device *fx2_device_new(void)
269 struct fx2_device *fx2;
271 if (!(fx2 = g_try_malloc0(sizeof(struct fx2_device)))) {
272 sr_err("saleae: %s: saleae malloc failed", __func__);
275 fx2->trigger_stage = TRIGGER_FIRED;
285 static int hw_init(const char *deviceinfo)
287 struct sr_device_instance *sdi;
288 struct libusb_device_descriptor des;
289 struct fx2_profile *fx2_prof;
290 struct fx2_device *fx2;
291 libusb_device **devlist;
292 int err, devcnt, i, j;
294 /* Avoid compiler warnings. */
297 if (libusb_init(&usb_context) != 0) {
298 sr_warn("Failed to initialize USB.");
302 /* Find all Saleae Logic devices and upload firmware to all of them. */
304 libusb_get_device_list(usb_context, &devlist);
305 for (i = 0; devlist[i]; i++) {
307 err = libusb_get_device_descriptor(devlist[i], &des);
309 sr_warn("failed to get device descriptor: %d", err);
313 for (j = 0; supported_fx2[j].orig_vid; j++) {
314 if (des.idVendor == supported_fx2[j].orig_vid
315 && des.idProduct == supported_fx2[j].orig_pid) {
316 fx2_prof = &supported_fx2[j];
321 /* not a supported VID/PID */
324 sdi = sr_device_instance_new(devcnt, SR_ST_INITIALIZING,
325 fx2_prof->vendor, fx2_prof->model, fx2_prof->model_version);
328 fx2 = fx2_device_new();
329 fx2->profile = fx2_prof;
331 device_instances = g_slist_append(device_instances, sdi);
333 if (check_conf_profile(devlist[i])) {
334 /* Already has the firmware, so fix the new address. */
335 sdi->status = SR_ST_INACTIVE;
336 sdi->usb = sr_usb_device_instance_new
337 (libusb_get_bus_number(devlist[i]),
338 libusb_get_device_address(devlist[i]), NULL);
340 if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION, FIRMWARE) == SR_OK)
341 /* Remember when the firmware on this device was updated */
342 g_get_current_time(&fx2->fw_updated);
344 sr_warn("firmware upload failed for device %d", devcnt);
345 sdi->usb = sr_usb_device_instance_new
346 (libusb_get_bus_number(devlist[i]), 0xff, NULL);
350 libusb_free_device_list(devlist, 1);
355 static int hw_opendev(int device_index)
358 struct sr_device_instance *sdi;
359 struct fx2_device *fx2;
362 if (!(sdi = sr_get_device_instance(device_instances, device_index)))
367 * if the firmware was recently uploaded, wait up to MAX_RENUM_DELAY ms
368 * for the FX2 to renumerate
371 if (GTV_TO_MSEC(fx2->fw_updated) > 0) {
372 sr_info("saleae: waiting for device to reset");
373 /* takes at least 300ms for the FX2 to be gone from the USB bus */
376 while (timediff < MAX_RENUM_DELAY) {
377 if ((err = sl_open_device(device_index)) == SR_OK)
380 g_get_current_time(&cur_time);
381 timediff = GTV_TO_MSEC(cur_time) - GTV_TO_MSEC(fx2->fw_updated);
383 sr_info("saleae: device came back after %d ms", timediff);
385 err = sl_open_device(device_index);
389 sr_warn("unable to open device");
394 err = libusb_claim_interface(sdi->usb->devhdl, USB_INTERFACE);
396 sr_warn("Unable to claim interface: %d", err);
400 if (fx2->cur_samplerate == 0) {
401 /* Samplerate hasn't been set; default to the slowest one. */
402 if (hw_set_configuration(device_index, SR_HWCAP_SAMPLERATE,
403 &supported_samplerates[0]) == SR_ERR)
410 static int hw_closedev(int device_index)
412 struct sr_device_instance *sdi;
414 if (!(sdi = sr_get_device_instance(device_instances, device_index))) {
415 sr_err("logic: %s: sdi was NULL", __func__);
416 return SR_ERR; /* TODO: SR_ERR_ARG? */
425 static void hw_cleanup(void)
429 /* Properly close all devices... */
430 for (l = device_instances; l; l = l->next)
431 close_device((struct sr_device_instance *)l->data);
433 /* ...and free all their memory. */
434 for (l = device_instances; l; l = l->next)
436 g_slist_free(device_instances);
437 device_instances = NULL;
440 libusb_exit(usb_context);
444 static void *hw_get_device_info(int device_index, int device_info_id)
446 struct sr_device_instance *sdi;
447 struct fx2_device *fx2;
450 if (!(sdi = sr_get_device_instance(device_instances, device_index)))
454 switch (device_info_id) {
458 case SR_DI_NUM_PROBES:
459 info = GINT_TO_POINTER(fx2->profile->num_probes);
461 case SR_DI_SAMPLERATES:
464 case SR_DI_TRIGGER_TYPES:
465 info = TRIGGER_TYPES;
467 case SR_DI_CUR_SAMPLERATE:
468 info = &fx2->cur_samplerate;
475 static int hw_get_status(int device_index)
477 struct sr_device_instance *sdi;
479 sdi = sr_get_device_instance(device_instances, device_index);
483 return SR_ST_NOT_FOUND;
486 static int *hw_get_capabilities(void)
491 static int set_configuration_samplerate(struct sr_device_instance *sdi,
494 struct fx2_device *fx2;
497 unsigned char buf[2];
500 for (i = 0; supported_samplerates[i]; i++) {
501 if (supported_samplerates[i] == samplerate)
504 if (supported_samplerates[i] == 0)
505 return SR_ERR_SAMPLERATE;
507 divider = (uint8_t) (48 / (samplerate / 1000000.0)) - 1;
509 sr_info("saleae: setting samplerate to %" PRIu64 " Hz (divider %d)",
510 samplerate, divider);
513 ret = libusb_bulk_transfer(sdi->usb->devhdl, 1 | LIBUSB_ENDPOINT_OUT,
514 buf, 2, &result, 500);
516 sr_warn("failed to set samplerate: %d", ret);
519 fx2->cur_samplerate = samplerate;
520 fx2->period_ps = 1000000000000 / samplerate;
525 static int hw_set_configuration(int device_index, int capability, void *value)
527 struct sr_device_instance *sdi;
528 struct fx2_device *fx2;
532 if (!(sdi = sr_get_device_instance(device_instances, device_index)))
536 if (capability == SR_HWCAP_SAMPLERATE) {
538 ret = set_configuration_samplerate(sdi, *tmp_u64);
539 } else if (capability == SR_HWCAP_PROBECONFIG) {
540 ret = configure_probes(fx2, (GSList *) value);
541 } else if (capability == SR_HWCAP_LIMIT_SAMPLES) {
543 fx2->limit_samples = *tmp_u64;
552 static int receive_data(int fd, int revents, void *user_data)
556 /* Avoid compiler warnings. */
561 tv.tv_sec = tv.tv_usec = 0;
562 libusb_handle_events_timeout(usb_context, &tv);
567 static void receive_transfer(struct libusb_transfer *transfer)
569 /* TODO: these statics have to move to fx2_device struct */
570 static int num_samples = 0;
571 static int empty_transfer_count = 0;
572 struct sr_datafeed_packet packet;
573 struct sr_datafeed_logic logic;
574 struct fx2_device *fx2;
575 int cur_buflen, trigger_offset, i;
576 unsigned char *cur_buf, *new_buf;
578 /* hw_stop_acquisition() is telling us to stop. */
579 if (transfer == NULL)
583 * If acquisition has already ended, just free any queued up
584 * transfer that come in.
586 if (num_samples == -1) {
588 libusb_free_transfer(transfer);
592 sr_info("saleae: receive_transfer(): status %d received %d bytes",
593 transfer->status, transfer->actual_length);
595 /* Save incoming transfer before reusing the transfer struct. */
596 cur_buf = transfer->buffer;
597 cur_buflen = transfer->actual_length;
598 fx2 = transfer->user_data;
600 /* Fire off a new request. */
601 if (!(new_buf = g_try_malloc(4096))) {
602 sr_err("saleae: %s: new_buf malloc failed", __func__);
603 // return SR_ERR_MALLOC;
607 transfer->buffer = new_buf;
608 transfer->length = 4096;
609 if (libusb_submit_transfer(transfer) != 0) {
610 /* TODO: Stop session? */
614 if (cur_buflen == 0) {
615 empty_transfer_count++;
616 if (empty_transfer_count > MAX_EMPTY_TRANSFERS) {
618 * The FX2 gave up. End the acquisition, the frontend
619 * will work out that the samplecount is short.
621 hw_stop_acquisition(-1, fx2->session_data);
625 empty_transfer_count = 0;
629 if (fx2->trigger_stage >= 0) {
630 for (i = 0; i < cur_buflen; i++) {
632 if ((cur_buf[i] & fx2->trigger_mask[fx2->trigger_stage]) == fx2->trigger_value[fx2->trigger_stage]) {
633 /* Match on this trigger stage. */
634 fx2->trigger_buffer[fx2->trigger_stage] = cur_buf[i];
635 fx2->trigger_stage++;
637 if (fx2->trigger_stage == NUM_TRIGGER_STAGES || fx2->trigger_mask[fx2->trigger_stage] == 0) {
638 /* Match on all trigger stages, we're done. */
639 trigger_offset = i + 1;
642 * TODO: Send pre-trigger buffer to session bus.
643 * Tell the frontend we hit the trigger here.
645 packet.type = SR_DF_TRIGGER;
646 packet.timeoffset = (num_samples + i) * fx2->period_ps;
648 packet.payload = NULL;
649 sr_session_bus(fx2->session_data, &packet);
652 * Send the samples that triggered it, since we're
653 * skipping past them.
655 packet.type = SR_DF_LOGIC;
656 packet.timeoffset = (num_samples + i) * fx2->period_ps;
657 packet.duration = fx2->trigger_stage * fx2->period_ps;
658 packet.payload = &logic;
659 logic.length = fx2->trigger_stage;
661 logic.data = fx2->trigger_buffer;
662 sr_session_bus(fx2->session_data, &packet);
664 fx2->trigger_stage = TRIGGER_FIRED;
671 * We had a match before, but not in the next sample. However, we may
672 * have a match on this stage in the next bit -- trigger on 0001 will
673 * fail on seeing 00001, so we need to go back to stage 0 -- but at
674 * the next sample from the one that matched originally, which the
675 * counter increment at the end of the loop takes care of.
677 if (fx2->trigger_stage > 0) {
678 i -= fx2->trigger_stage;
680 i = -1; /* Oops, went back past this buffer. */
681 /* Reset trigger stage. */
682 fx2->trigger_stage = 0;
687 if (fx2->trigger_stage == TRIGGER_FIRED) {
688 /* Send the incoming transfer to the session bus. */
689 packet.type = SR_DF_LOGIC;
690 packet.timeoffset = num_samples * fx2->period_ps;
691 packet.duration = cur_buflen * fx2->period_ps;
692 packet.payload = &logic;
693 logic.length = cur_buflen - trigger_offset;
695 logic.data = cur_buf + trigger_offset;
696 sr_session_bus(fx2->session_data, &packet);
699 num_samples += cur_buflen;
700 if (fx2->limit_samples && (unsigned int) num_samples > fx2->limit_samples) {
701 hw_stop_acquisition(-1, fx2->session_data);
705 * TODO: Buffer pre-trigger data in capture
706 * ratio-sized buffer.
711 static int hw_start_acquisition(int device_index, gpointer session_data)
713 struct sr_device_instance *sdi;
714 struct sr_datafeed_packet *packet;
715 struct sr_datafeed_header *header;
716 struct fx2_device *fx2;
717 struct libusb_transfer *transfer;
718 const struct libusb_pollfd **lupfd;
722 if (!(sdi = sr_get_device_instance(device_instances, device_index)))
725 fx2->session_data = session_data;
727 if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
728 sr_err("saleae: %s: packet malloc failed", __func__);
729 return SR_ERR_MALLOC;
732 if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) {
733 sr_err("saleae: %s: header malloc failed", __func__);
734 return SR_ERR_MALLOC;
737 /* Start with 2K transfer, subsequently increased to 4K. */
739 for (i = 0; i < NUM_SIMUL_TRANSFERS; i++) {
740 if (!(buf = g_try_malloc(size))) {
741 sr_err("saleae: %s: buf malloc failed", __func__);
742 return SR_ERR_MALLOC;
744 transfer = libusb_alloc_transfer(0);
745 libusb_fill_bulk_transfer(transfer, sdi->usb->devhdl,
746 2 | LIBUSB_ENDPOINT_IN, buf, size,
747 receive_transfer, fx2, 40);
748 if (libusb_submit_transfer(transfer) != 0) {
749 /* TODO: Free them all. */
750 libusb_free_transfer(transfer);
757 lupfd = libusb_get_pollfds(usb_context);
758 for (i = 0; lupfd[i]; i++)
759 sr_source_add(lupfd[i]->fd, lupfd[i]->events, 40, receive_data,
763 packet->type = SR_DF_HEADER;
764 packet->payload = header;
765 header->feed_version = 1;
766 gettimeofday(&header->starttime, NULL);
767 header->samplerate = fx2->cur_samplerate;
768 header->num_logic_probes = fx2->profile->num_probes;
769 header->num_analog_probes = 0;
770 sr_session_bus(session_data, packet);
777 /* This stops acquisition on ALL devices, ignoring device_index. */
778 static void hw_stop_acquisition(int device_index, gpointer session_data)
780 struct sr_datafeed_packet packet;
782 /* Avoid compiler warnings. */
785 packet.type = SR_DF_END;
786 sr_session_bus(session_data, &packet);
788 receive_transfer(NULL);
790 /* TODO: Need to cancel and free any queued up transfers. */
793 struct sr_device_plugin saleae_logic_plugin_info = {
794 .name = "saleae-logic",
795 .longname = "Saleae Logic",
798 .cleanup = hw_cleanup,
799 .opendev = hw_opendev,
800 .closedev = hw_closedev,
801 .get_device_info = hw_get_device_info,
802 .get_status = hw_get_status,
803 .get_capabilities = hw_get_capabilities,
804 .set_configuration = hw_set_configuration,
805 .start_acquisition = hw_start_acquisition,
806 .stop_acquisition = hw_stop_acquisition,