2 * This file is part of the libsigrok project.
4 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
5 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
26 static const struct dslogic_profile supported_device[] = {
27 /* DreamSourceLab DSLogic */
28 { 0x2a0e, 0x0001, "DreamSourceLab", "DSLogic", NULL,
29 "dreamsourcelab-dslogic-fx2.fw",
30 0, "DreamSourceLab", "DSLogic"},
31 /* DreamSourceLab DSCope */
32 { 0x2a0e, 0x0002, "DreamSourceLab", "DSCope", NULL,
33 "dreamsourcelab-dscope-fx2.fw",
34 0, "DreamSourceLab", "DSCope"},
35 /* DreamSourceLab DSLogic Pro */
36 { 0x2a0e, 0x0003, "DreamSourceLab", "DSLogic Pro", NULL,
37 "dreamsourcelab-dslogic-pro-fx2.fw",
38 0, "DreamSourceLab", "DSLogic"},
39 /* DreamSourceLab DSLogic Plus */
40 { 0x2a0e, 0x0020, "DreamSourceLab", "DSLogic Plus", NULL,
41 "dreamsourcelab-dslogic-plus-fx2.fw",
42 0, "DreamSourceLab", "DSLogic"},
43 /* DreamSourceLab DSLogic Basic */
44 { 0x2a0e, 0x0021, "DreamSourceLab", "DSLogic Basic", NULL,
45 "dreamsourcelab-dslogic-basic-fx2.fw",
46 0, "DreamSourceLab", "DSLogic"},
51 static const uint32_t drvopts[] = {
52 SR_CONF_LOGIC_ANALYZER,
55 static const uint32_t scanopts[] = {
59 static const uint32_t devopts[] = {
60 SR_CONF_CONTINUOUS | SR_CONF_SET | SR_CONF_GET,
61 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
62 SR_CONF_VOLTAGE_THRESHOLD | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
63 SR_CONF_CONN | SR_CONF_GET,
64 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
65 SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
66 SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
67 SR_CONF_EXTERNAL_CLOCK | SR_CONF_GET | SR_CONF_SET,
68 SR_CONF_CLOCK_EDGE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
71 /* Names assigned to available edge slope choices. */
72 static const char *const signal_edge_names[] = {
73 [DS_EDGE_RISING] = "rising",
74 [DS_EDGE_FALLING] = "falling",
81 } volt_thresholds[] = {
82 { DS_VOLTAGE_RANGE_18_33_V, 0.7, 1.4 },
83 { DS_VOLTAGE_RANGE_5_V, 1.4, 3.6 },
86 static const uint64_t samplerates[] = {
105 static gboolean is_plausible(const struct libusb_device_descriptor *des)
109 for (i = 0; supported_device[i].vid; i++) {
110 if (des->idVendor != supported_device[i].vid)
112 if (des->idProduct == supported_device[i].pid)
119 static GSList *scan(struct sr_dev_driver *di, GSList *options)
121 struct drv_context *drvc;
122 struct dev_context *devc;
123 struct sr_dev_inst *sdi;
124 struct sr_usb_dev_inst *usb;
125 struct sr_channel *ch;
126 struct sr_channel_group *cg;
127 struct sr_config *src;
128 const struct dslogic_profile *prof;
129 GSList *l, *devices, *conn_devices;
130 gboolean has_firmware;
131 struct libusb_device_descriptor des;
132 libusb_device **devlist;
133 struct libusb_device_handle *hdl;
136 char manufacturer[64], product[64], serial_num[64], connection_id[64];
137 char channel_name[16];
142 for (l = options; l; l = l->next) {
146 conn = g_variant_get_string(src->data, NULL);
151 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
155 /* Find all dslogic compatible devices and upload firmware to them. */
157 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
158 for (i = 0; devlist[i]; i++) {
161 for (l = conn_devices; l; l = l->next) {
163 if (usb->bus == libusb_get_bus_number(devlist[i])
164 && usb->address == libusb_get_device_address(devlist[i]))
168 /* This device matched none of the ones that
169 * matched the conn specification. */
173 libusb_get_device_descriptor( devlist[i], &des);
175 if (!is_plausible(&des))
178 if ((ret = libusb_open(devlist[i], &hdl)) < 0) {
179 sr_warn("Failed to open potential device with "
180 "VID:PID %04x:%04x: %s.", des.idVendor,
181 des.idProduct, libusb_error_name(ret));
185 if (des.iManufacturer == 0) {
186 manufacturer[0] = '\0';
187 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
188 des.iManufacturer, (unsigned char *) manufacturer,
189 sizeof(manufacturer))) < 0) {
190 sr_warn("Failed to get manufacturer string descriptor: %s.",
191 libusb_error_name(ret));
195 if (des.iProduct == 0) {
197 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
198 des.iProduct, (unsigned char *) product,
199 sizeof(product))) < 0) {
200 sr_warn("Failed to get product string descriptor: %s.",
201 libusb_error_name(ret));
205 if (des.iSerialNumber == 0) {
206 serial_num[0] = '\0';
207 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
208 des.iSerialNumber, (unsigned char *) serial_num,
209 sizeof(serial_num))) < 0) {
210 sr_warn("Failed to get serial number string descriptor: %s.",
211 libusb_error_name(ret));
215 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
220 for (j = 0; supported_device[j].vid; j++) {
221 if (des.idVendor == supported_device[j].vid &&
222 des.idProduct == supported_device[j].pid &&
223 (!strcmp(manufacturer, supported_device[j].usb_manufacturer)) &&
224 (!strcmp(product, "USB-based Instrument") ||
225 !strcmp(product, supported_device[j].usb_product))) {
226 prof = &supported_device[j];
231 /* Skip if the device was not found. */
235 sdi = g_malloc0(sizeof(struct sr_dev_inst));
236 sdi->status = SR_ST_INITIALIZING;
237 sdi->vendor = g_strdup(prof->vendor);
238 sdi->model = g_strdup(prof->model);
239 sdi->version = g_strdup(prof->model_version);
240 sdi->serial_num = g_strdup(serial_num);
241 sdi->connection_id = g_strdup(connection_id);
243 /* Logic channels, all in one channel group. */
244 cg = g_malloc0(sizeof(struct sr_channel_group));
245 cg->name = g_strdup("Logic");
246 for (j = 0; j < 16; j++) {
247 sprintf(channel_name, "%d", j);
248 ch = sr_channel_new(sdi, j, SR_CHANNEL_LOGIC,
250 cg->channels = g_slist_append(cg->channels, ch);
252 sdi->channel_groups = g_slist_append(NULL, cg);
254 devc = dslogic_dev_new();
255 devc->profile = prof;
257 devices = g_slist_append(devices, sdi);
259 devc->samplerates = samplerates;
260 devc->num_samplerates = ARRAY_SIZE(samplerates);
261 has_firmware = usb_match_manuf_prod(devlist[i], "DreamSourceLab", "DSLogic")
262 || usb_match_manuf_prod(devlist[i], "DreamSourceLab", "DSCope");
265 /* Already has the firmware, so fix the new address. */
266 sr_dbg("Found an dslogic device.");
267 sdi->status = SR_ST_INACTIVE;
268 sdi->inst_type = SR_INST_USB;
269 sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
270 libusb_get_device_address(devlist[i]), NULL);
272 if (ezusb_upload_firmware(drvc->sr_ctx, devlist[i],
273 USB_CONFIGURATION, prof->firmware) == SR_OK)
274 /* Store when this device's FW was updated. */
275 devc->fw_updated = g_get_monotonic_time();
277 sr_err("Firmware upload failed for "
278 "device %d.%d (logical).",
279 libusb_get_bus_number(devlist[i]),
280 libusb_get_device_address(devlist[i]));
281 sdi->inst_type = SR_INST_USB;
282 sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
286 libusb_free_device_list(devlist, 1);
287 g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
289 return std_scan_complete(di, devices);
292 static void clear_dev_context(void *priv)
294 struct dev_context *devc;
300 static int dev_clear(const struct sr_dev_driver *di)
302 return std_dev_clear(di, clear_dev_context);
305 static int dev_open(struct sr_dev_inst *sdi)
307 struct sr_dev_driver *di = sdi->driver;
308 struct sr_usb_dev_inst *usb;
309 struct dev_context *devc;
311 int64_t timediff_us, timediff_ms;
317 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
318 * milliseconds for the FX2 to renumerate.
321 if (devc->fw_updated > 0) {
322 sr_info("Waiting for device to reset.");
323 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
324 g_usleep(300 * 1000);
326 while (timediff_ms < MAX_RENUM_DELAY_MS) {
327 if ((ret = dslogic_dev_open(sdi, di)) == SR_OK)
329 g_usleep(100 * 1000);
331 timediff_us = g_get_monotonic_time() - devc->fw_updated;
332 timediff_ms = timediff_us / 1000;
333 sr_spew("Waited %" PRIi64 "ms.", timediff_ms);
336 sr_err("Device failed to renumerate.");
339 sr_info("Device came back after %" PRIi64 "ms.", timediff_ms);
341 sr_info("Firmware upload was not needed.");
342 ret = dslogic_dev_open(sdi, di);
346 sr_err("Unable to open device.");
350 ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
353 case LIBUSB_ERROR_BUSY:
354 sr_err("Unable to claim USB interface. Another "
355 "program or driver has already claimed it.");
357 case LIBUSB_ERROR_NO_DEVICE:
358 sr_err("Device has been disconnected.");
361 sr_err("Unable to claim interface: %s.",
362 libusb_error_name(ret));
370 if ((ret = dslogic_fpga_firmware_upload(sdi)) != SR_OK)
373 if (devc->cur_samplerate == 0) {
374 /* Samplerate hasn't been set; default to the slowest one. */
375 devc->cur_samplerate = devc->samplerates[0];
381 static int dev_close(struct sr_dev_inst *sdi)
383 struct sr_usb_dev_inst *usb;
390 sr_info("dslogic: Closing device on %d.%d (logical) / %s (physical) interface %d.",
391 usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
392 libusb_release_interface(usb->devhdl, USB_INTERFACE);
393 libusb_close(usb->devhdl);
395 sdi->status = SR_ST_INACTIVE;
400 static int config_get(uint32_t key, GVariant **data,
401 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
403 struct dev_context *devc;
404 struct sr_usb_dev_inst *usb;
421 if (usb->address == 255)
422 /* Device still needs to re-enumerate after firmware
423 * upload, so we don't know its (future) address. */
425 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
426 *data = g_variant_new_string(str);
428 case SR_CONF_VOLTAGE_THRESHOLD:
429 for (i = 0; i < ARRAY_SIZE(volt_thresholds); i++) {
430 if (volt_thresholds[i].range != devc->voltage_threshold)
432 range[0] = g_variant_new_double(volt_thresholds[i].low);
433 range[1] = g_variant_new_double(volt_thresholds[i].high);
434 *data = g_variant_new_tuple(range, 2);
438 case SR_CONF_LIMIT_SAMPLES:
439 *data = g_variant_new_uint64(devc->limit_samples);
441 case SR_CONF_SAMPLERATE:
442 *data = g_variant_new_uint64(devc->cur_samplerate);
444 case SR_CONF_CAPTURE_RATIO:
445 *data = g_variant_new_uint64(devc->capture_ratio);
447 case SR_CONF_EXTERNAL_CLOCK:
448 *data = g_variant_new_boolean(devc->external_clock);
450 case SR_CONF_CONTINUOUS:
451 *data = g_variant_new_boolean(devc->continuous_mode);
453 case SR_CONF_CLOCK_EDGE:
454 i = devc->clock_edge;
455 if (i >= ARRAY_SIZE(signal_edge_names))
457 *data = g_variant_new_string(signal_edge_names[0]);
467 * Helper for mapping a string-typed configuration value to an index
468 * within a table of possible values.
470 static int lookup_index(GVariant *value, const char *const *table, int len)
475 entry = g_variant_get_string(value, NULL);
479 /* Linear search is fine for very small tables. */
480 for (i = 0; i < len; i++) {
481 if (strcmp(entry, table[i]) == 0)
488 static int config_set(uint32_t key, GVariant *data,
489 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
491 struct dev_context *devc;
501 if (sdi->status != SR_ST_ACTIVE)
509 case SR_CONF_SAMPLERATE:
510 arg = g_variant_get_uint64(data);
511 for (i = 0; i < devc->num_samplerates; i++) {
512 if (devc->samplerates[i] == arg) {
513 devc->cur_samplerate = arg;
517 if (i == devc->num_samplerates)
520 case SR_CONF_LIMIT_SAMPLES:
521 devc->limit_samples = g_variant_get_uint64(data);
523 case SR_CONF_CAPTURE_RATIO:
524 devc->capture_ratio = g_variant_get_uint64(data);
525 ret = (devc->capture_ratio > 100) ? SR_ERR : SR_OK;
527 case SR_CONF_VOLTAGE_THRESHOLD:
528 g_variant_get(data, "(dd)", &low, &high);
530 for (i = 0; (unsigned int)i < ARRAY_SIZE(volt_thresholds); i++) {
531 if (fabs(volt_thresholds[i].low - low) < 0.1 &&
532 fabs(volt_thresholds[i].high - high) < 0.1) {
533 devc->voltage_threshold = volt_thresholds[i].range;
537 ret = dslogic_fpga_firmware_upload(sdi);
539 case SR_CONF_EXTERNAL_CLOCK:
540 devc->external_clock = g_variant_get_boolean(data);
542 case SR_CONF_CONTINUOUS:
543 devc->continuous_mode = g_variant_get_boolean(data);
545 case SR_CONF_CLOCK_EDGE:
546 i = lookup_index(data, signal_edge_names,
547 ARRAY_SIZE(signal_edge_names));
550 devc->clock_edge = i;
559 static int config_list(uint32_t key, GVariant **data,
560 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
562 struct dev_context *devc;
563 GVariant *gvar, *range[2];
570 case SR_CONF_SCAN_OPTIONS:
571 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
572 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
574 case SR_CONF_DEVICE_OPTIONS:
576 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
577 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
580 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
581 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
584 case SR_CONF_VOLTAGE_THRESHOLD:
588 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
589 for (i = 0; i < ARRAY_SIZE(volt_thresholds); i++) {
590 range[0] = g_variant_new_double(volt_thresholds[i].low);
591 range[1] = g_variant_new_double(volt_thresholds[i].high);
592 gvar = g_variant_new_tuple(range, 2);
593 g_variant_builder_add_value(&gvb, gvar);
595 *data = g_variant_builder_end(&gvb);
597 case SR_CONF_SAMPLERATE:
599 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
600 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), devc->samplerates,
601 devc->num_samplerates, sizeof(uint64_t));
602 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
603 *data = g_variant_builder_end(&gvb);
605 case SR_CONF_CLOCK_EDGE:
606 *data = g_variant_new_strv(signal_edge_names,
607 ARRAY_SIZE(signal_edge_names));
616 static int receive_data(int fd, int revents, void *cb_data)
619 struct drv_context *drvc;
624 drvc = (struct drv_context *)cb_data;
626 tv.tv_sec = tv.tv_usec = 0;
627 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
632 static int start_transfers(const struct sr_dev_inst *sdi)
634 struct dev_context *devc;
635 struct sr_usb_dev_inst *usb;
636 struct libusb_transfer *transfer;
637 unsigned int i, num_transfers;
645 devc->sent_samples = 0;
646 devc->acq_aborted = FALSE;
647 devc->empty_transfer_count = 0;
648 devc->trigger_fired = TRUE;
650 num_transfers = dslogic_get_number_of_transfers(devc);
652 if (devc->cur_samplerate == SR_MHZ(100))
654 else if (devc->cur_samplerate == SR_MHZ(200))
656 else if (devc->cur_samplerate == SR_MHZ(400))
659 size = dslogic_get_buffer_size(devc);
660 devc->submitted_transfers = 0;
662 devc->transfers = g_try_malloc0(sizeof(*devc->transfers) * num_transfers);
663 if (!devc->transfers) {
664 sr_err("USB transfers malloc failed.");
665 return SR_ERR_MALLOC;
668 timeout = dslogic_get_timeout(devc);
669 devc->num_transfers = num_transfers;
670 for (i = 0; i < num_transfers; i++) {
671 if (!(buf = g_try_malloc(size))) {
672 sr_err("USB transfer buffer malloc failed.");
673 return SR_ERR_MALLOC;
675 transfer = libusb_alloc_transfer(0);
676 libusb_fill_bulk_transfer(transfer, usb->devhdl,
677 6 | LIBUSB_ENDPOINT_IN, buf, size,
678 dslogic_receive_transfer, (void *)sdi, timeout);
679 sr_info("submitting transfer: %d", i);
680 if ((ret = libusb_submit_transfer(transfer)) != 0) {
681 sr_err("Failed to submit transfer: %s.",
682 libusb_error_name(ret));
683 libusb_free_transfer(transfer);
685 dslogic_abort_acquisition(devc);
688 devc->transfers[i] = transfer;
689 devc->submitted_transfers++;
692 std_session_send_df_header(sdi);
697 static void LIBUSB_CALL trigger_receive(struct libusb_transfer *transfer)
699 const struct sr_dev_inst *sdi;
700 struct dslogic_trigger_pos *tpos;
701 struct dev_context *devc;
703 sdi = transfer->user_data;
705 if (transfer->status == LIBUSB_TRANSFER_CANCELLED) {
706 sr_dbg("Trigger transfer canceled.");
707 /* Terminate session. */
708 std_session_send_df_end(sdi);
709 usb_source_remove(sdi->session, devc->ctx);
710 devc->num_transfers = 0;
711 g_free(devc->transfers);
712 } else if (transfer->status == LIBUSB_TRANSFER_COMPLETED
713 && transfer->actual_length == sizeof(struct dslogic_trigger_pos)) {
714 tpos = (struct dslogic_trigger_pos *)transfer->buffer;
715 sr_info("tpos real_pos %d ram_saddr %d cnt %d", tpos->real_pos,
716 tpos->ram_saddr, tpos->remain_cnt);
717 devc->trigger_pos = tpos->real_pos;
719 start_transfers(sdi);
721 libusb_free_transfer(transfer);
724 static int trigger_request(const struct sr_dev_inst *sdi)
726 struct sr_usb_dev_inst *usb;
727 struct libusb_transfer *transfer;
728 struct dslogic_trigger_pos *tpos;
729 struct dev_context *devc;
735 if ((ret = dslogic_stop_acquisition(sdi)) != SR_OK)
738 if ((ret = dslogic_fpga_configure(sdi)) != SR_OK)
741 /* If this is a DSLogic Pro, set the voltage threshold. */
742 if (!strcmp(devc->profile->model, "DSLogic Pro")){
743 if (devc->voltage_threshold == DS_VOLTAGE_RANGE_18_33_V) {
744 dslogic_set_vth(sdi, 1.4);
746 dslogic_set_vth(sdi, 3.3);
750 if ((ret = dslogic_start_acquisition(sdi)) != SR_OK)
753 sr_dbg("Getting trigger.");
754 tpos = g_malloc(sizeof(struct dslogic_trigger_pos));
755 transfer = libusb_alloc_transfer(0);
756 libusb_fill_bulk_transfer(transfer, usb->devhdl, 6 | LIBUSB_ENDPOINT_IN,
757 (unsigned char *)tpos, sizeof(struct dslogic_trigger_pos),
758 trigger_receive, (void *)sdi, 0);
759 if ((ret = libusb_submit_transfer(transfer)) < 0) {
760 sr_err("Failed to request trigger: %s.", libusb_error_name(ret));
761 libusb_free_transfer(transfer);
766 devc->transfers = g_try_malloc0(sizeof(*devc->transfers));
767 if (!devc->transfers) {
768 sr_err("USB trigger_pos transfer malloc failed.");
769 return SR_ERR_MALLOC;
771 devc->num_transfers = 1;
772 devc->submitted_transfers++;
773 devc->transfers[0] = transfer;
778 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
780 struct sr_dev_driver *di;
781 struct drv_context *drvc;
782 struct dev_context *devc;
785 if (sdi->status != SR_ST_ACTIVE)
786 return SR_ERR_DEV_CLOSED;
792 devc->ctx = drvc->sr_ctx;
793 devc->sent_samples = 0;
794 devc->empty_transfer_count = 0;
795 devc->acq_aborted = FALSE;
797 timeout = dslogic_get_timeout(devc);
798 usb_source_add(sdi->session, devc->ctx, timeout, receive_data, drvc);
800 trigger_request(sdi);
805 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
807 dslogic_stop_acquisition(sdi);
809 dslogic_abort_acquisition(sdi->priv);
814 static struct sr_dev_driver dslogic_driver_info = {
816 .longname = "DreamSourceLabs DSLogic",
819 .cleanup = std_cleanup,
821 .dev_list = std_dev_list,
822 .dev_clear = dev_clear,
823 .config_get = config_get,
824 .config_set = config_set,
825 .config_list = config_list,
826 .dev_open = dev_open,
827 .dev_close = dev_close,
828 .dev_acquisition_start = dev_acquisition_start,
829 .dev_acquisition_stop = dev_acquisition_stop,
832 SR_REGISTER_DEV_DRIVER(dslogic_driver_info);