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/>.
25 static const struct dslogic_profile supported_device[] = {
26 /* DreamSourceLab DSLogic */
27 { 0x2a0e, 0x0001, "DreamSourceLab", "DSLogic", NULL,
28 "dreamsourcelab-dslogic-fx2.fw",
29 0, "DreamSourceLab", "DSLogic", 256 * 1024 * 1024},
30 /* DreamSourceLab DSCope */
31 { 0x2a0e, 0x0002, "DreamSourceLab", "DSCope", NULL,
32 "dreamsourcelab-dscope-fx2.fw",
33 0, "DreamSourceLab", "DSCope", 256 * 1024 * 1024},
34 /* DreamSourceLab DSLogic Pro */
35 { 0x2a0e, 0x0003, "DreamSourceLab", "DSLogic Pro", NULL,
36 "dreamsourcelab-dslogic-pro-fx2.fw",
37 0, "DreamSourceLab", "DSLogic", 256 * 1024 * 1024},
38 /* DreamSourceLab DSLogic Plus */
39 { 0x2a0e, 0x0020, "DreamSourceLab", "DSLogic Plus", NULL,
40 "dreamsourcelab-dslogic-plus-fx2.fw",
41 0, "DreamSourceLab", "DSLogic", 256 * 1024 * 1024},
42 /* DreamSourceLab DSLogic Basic */
43 { 0x2a0e, 0x0021, "DreamSourceLab", "DSLogic Basic", NULL,
44 "dreamsourcelab-dslogic-basic-fx2.fw",
45 0, "DreamSourceLab", "DSLogic", 256 * 1024},
50 static const uint32_t drvopts[] = {
51 SR_CONF_LOGIC_ANALYZER,
54 static const uint32_t scanopts[] = {
58 static const uint32_t devopts[] = {
59 SR_CONF_CONTINUOUS | SR_CONF_SET | SR_CONF_GET,
60 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
61 SR_CONF_VOLTAGE_THRESHOLD | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
62 SR_CONF_CONN | SR_CONF_GET,
63 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
64 SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
65 SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
66 SR_CONF_EXTERNAL_CLOCK | SR_CONF_GET | SR_CONF_SET,
67 SR_CONF_CLOCK_EDGE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
70 /* Names assigned to available edge slope choices. */
71 static const char *const signal_edge_names[] = {
72 [DS_EDGE_RISING] = "rising",
73 [DS_EDGE_FALLING] = "falling",
79 } voltage_thresholds[] = {
84 static const uint64_t samplerates[] = {
103 static gboolean is_plausible(const struct libusb_device_descriptor *des)
107 for (i = 0; supported_device[i].vid; i++) {
108 if (des->idVendor != supported_device[i].vid)
110 if (des->idProduct == supported_device[i].pid)
117 static GSList *scan(struct sr_dev_driver *di, GSList *options)
119 struct drv_context *drvc;
120 struct dev_context *devc;
121 struct sr_dev_inst *sdi;
122 struct sr_usb_dev_inst *usb;
123 struct sr_channel *ch;
124 struct sr_channel_group *cg;
125 struct sr_config *src;
126 const struct dslogic_profile *prof;
127 GSList *l, *devices, *conn_devices;
128 gboolean has_firmware;
129 struct libusb_device_descriptor des;
130 libusb_device **devlist;
131 struct libusb_device_handle *hdl;
134 char manufacturer[64], product[64], serial_num[64], connection_id[64];
135 char channel_name[16];
140 for (l = options; l; l = l->next) {
144 conn = g_variant_get_string(src->data, NULL);
149 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
153 /* Find all DSLogic compatible devices and upload firmware to them. */
155 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
156 for (i = 0; devlist[i]; i++) {
159 for (l = conn_devices; l; l = l->next) {
161 if (usb->bus == libusb_get_bus_number(devlist[i])
162 && usb->address == libusb_get_device_address(devlist[i]))
166 /* This device matched none of the ones that
167 * matched the conn specification. */
171 libusb_get_device_descriptor(devlist[i], &des);
173 if (!is_plausible(&des))
176 if ((ret = libusb_open(devlist[i], &hdl)) < 0) {
177 sr_warn("Failed to open potential device with "
178 "VID:PID %04x:%04x: %s.", des.idVendor,
179 des.idProduct, libusb_error_name(ret));
183 if (des.iManufacturer == 0) {
184 manufacturer[0] = '\0';
185 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
186 des.iManufacturer, (unsigned char *) manufacturer,
187 sizeof(manufacturer))) < 0) {
188 sr_warn("Failed to get manufacturer string descriptor: %s.",
189 libusb_error_name(ret));
193 if (des.iProduct == 0) {
195 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
196 des.iProduct, (unsigned char *) product,
197 sizeof(product))) < 0) {
198 sr_warn("Failed to get product string descriptor: %s.",
199 libusb_error_name(ret));
203 if (des.iSerialNumber == 0) {
204 serial_num[0] = '\0';
205 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
206 des.iSerialNumber, (unsigned char *) serial_num,
207 sizeof(serial_num))) < 0) {
208 sr_warn("Failed to get serial number string descriptor: %s.",
209 libusb_error_name(ret));
213 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
218 for (j = 0; supported_device[j].vid; j++) {
219 if (des.idVendor == supported_device[j].vid &&
220 des.idProduct == supported_device[j].pid) {
221 prof = &supported_device[j];
226 /* Skip if the device was not found. */
230 sdi = g_malloc0(sizeof(struct sr_dev_inst));
231 sdi->status = SR_ST_INITIALIZING;
232 sdi->vendor = g_strdup(prof->vendor);
233 sdi->model = g_strdup(prof->model);
234 sdi->version = g_strdup(prof->model_version);
235 sdi->serial_num = g_strdup(serial_num);
236 sdi->connection_id = g_strdup(connection_id);
238 /* Logic channels, all in one channel group. */
239 cg = g_malloc0(sizeof(struct sr_channel_group));
240 cg->name = g_strdup("Logic");
241 for (j = 0; j < 16; j++) {
242 sprintf(channel_name, "%d", j);
243 ch = sr_channel_new(sdi, j, SR_CHANNEL_LOGIC,
245 cg->channels = g_slist_append(cg->channels, ch);
247 sdi->channel_groups = g_slist_append(NULL, cg);
249 devc = dslogic_dev_new();
250 devc->profile = prof;
252 devices = g_slist_append(devices, sdi);
254 devc->samplerates = samplerates;
255 devc->num_samplerates = ARRAY_SIZE(samplerates);
256 has_firmware = usb_match_manuf_prod(devlist[i], "DreamSourceLab", "USB-based Instrument");
259 /* Already has the firmware, so fix the new address. */
260 sr_dbg("Found a DSLogic device.");
261 sdi->status = SR_ST_INACTIVE;
262 sdi->inst_type = SR_INST_USB;
263 sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
264 libusb_get_device_address(devlist[i]), NULL);
266 if (ezusb_upload_firmware(drvc->sr_ctx, devlist[i],
267 USB_CONFIGURATION, prof->firmware) == SR_OK)
268 /* Store when this device's FW was updated. */
269 devc->fw_updated = g_get_monotonic_time();
271 sr_err("Firmware upload failed for "
272 "device %d.%d (logical).",
273 libusb_get_bus_number(devlist[i]),
274 libusb_get_device_address(devlist[i]));
275 sdi->inst_type = SR_INST_USB;
276 sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
280 libusb_free_device_list(devlist, 1);
281 g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
283 return std_scan_complete(di, devices);
286 static void clear_dev_context(void *priv)
288 struct dev_context *devc;
294 static int dev_clear(const struct sr_dev_driver *di)
296 return std_dev_clear(di, clear_dev_context);
299 static int dev_open(struct sr_dev_inst *sdi)
301 struct sr_dev_driver *di = sdi->driver;
302 struct sr_usb_dev_inst *usb;
303 struct dev_context *devc;
305 int64_t timediff_us, timediff_ms;
311 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
312 * milliseconds for the FX2 to renumerate.
315 if (devc->fw_updated > 0) {
316 sr_info("Waiting for device to reset.");
317 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
318 g_usleep(300 * 1000);
320 while (timediff_ms < MAX_RENUM_DELAY_MS) {
321 if ((ret = dslogic_dev_open(sdi, di)) == SR_OK)
323 g_usleep(100 * 1000);
325 timediff_us = g_get_monotonic_time() - devc->fw_updated;
326 timediff_ms = timediff_us / 1000;
327 sr_spew("Waited %" PRIi64 "ms.", timediff_ms);
330 sr_err("Device failed to renumerate.");
333 sr_info("Device came back after %" PRIi64 "ms.", timediff_ms);
335 sr_info("Firmware upload was not needed.");
336 ret = dslogic_dev_open(sdi, di);
340 sr_err("Unable to open device.");
344 ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
347 case LIBUSB_ERROR_BUSY:
348 sr_err("Unable to claim USB interface. Another "
349 "program or driver has already claimed it.");
351 case LIBUSB_ERROR_NO_DEVICE:
352 sr_err("Device has been disconnected.");
355 sr_err("Unable to claim interface: %s.",
356 libusb_error_name(ret));
364 if ((ret = dslogic_fpga_firmware_upload(sdi)) != SR_OK)
367 if (devc->cur_samplerate == 0) {
368 /* Samplerate hasn't been set; default to the slowest one. */
369 devc->cur_samplerate = devc->samplerates[0];
372 if (devc->cur_threshold == 0.0)
373 devc->cur_threshold = 1.5;
378 static int dev_close(struct sr_dev_inst *sdi)
380 struct sr_usb_dev_inst *usb;
387 sr_info("Closing device on %d.%d (logical) / %s (physical) interface %d.",
388 usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
389 libusb_release_interface(usb->devhdl, USB_INTERFACE);
390 libusb_close(usb->devhdl);
396 static int config_get(uint32_t key, GVariant **data,
397 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
399 struct dev_context *devc;
400 struct sr_usb_dev_inst *usb;
402 unsigned int i, voltage_range;
417 if (usb->address == 255)
418 /* Device still needs to re-enumerate after firmware
419 * upload, so we don't know its (future) address. */
421 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
422 *data = g_variant_new_string(str);
424 case SR_CONF_VOLTAGE_THRESHOLD:
425 if (!strcmp(devc->profile->model, "DSLogic")) {
428 for (i = 0; i < ARRAY_SIZE(voltage_thresholds); i++)
429 if (voltage_thresholds[i].low == devc->cur_threshold) {
434 range[0] = g_variant_new_double(
435 voltage_thresholds[voltage_range].low);
436 range[1] = g_variant_new_double(
437 voltage_thresholds[voltage_range].high);
439 range[0] = g_variant_new_double(devc->cur_threshold);
440 range[1] = g_variant_new_double(devc->cur_threshold);
442 *data = g_variant_new_tuple(range, 2);
444 case SR_CONF_LIMIT_SAMPLES:
445 *data = g_variant_new_uint64(devc->limit_samples);
447 case SR_CONF_SAMPLERATE:
448 *data = g_variant_new_uint64(devc->cur_samplerate);
450 case SR_CONF_CAPTURE_RATIO:
451 *data = g_variant_new_uint64(devc->capture_ratio);
453 case SR_CONF_EXTERNAL_CLOCK:
454 *data = g_variant_new_boolean(devc->external_clock);
456 case SR_CONF_CONTINUOUS:
457 *data = g_variant_new_boolean(devc->continuous_mode);
459 case SR_CONF_CLOCK_EDGE:
460 i = devc->clock_edge;
461 if (i >= ARRAY_SIZE(signal_edge_names))
463 *data = g_variant_new_string(signal_edge_names[0]);
473 * Helper for mapping a string-typed configuration value to an index
474 * within a table of possible values.
476 static int lookup_index(GVariant *value, const char *const *table, int len)
481 entry = g_variant_get_string(value, NULL);
485 /* Linear search is fine for very small tables. */
486 for (i = 0; i < len; i++) {
487 if (strcmp(entry, table[i]) == 0)
494 static int config_set(uint32_t key, GVariant *data,
495 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
497 struct dev_context *devc;
512 case SR_CONF_SAMPLERATE:
513 arg = g_variant_get_uint64(data);
514 for (i = 0; i < devc->num_samplerates; i++) {
515 if (devc->samplerates[i] == arg) {
516 devc->cur_samplerate = arg;
520 if (i == devc->num_samplerates)
523 case SR_CONF_LIMIT_SAMPLES:
524 devc->limit_samples = g_variant_get_uint64(data);
526 case SR_CONF_CAPTURE_RATIO:
527 devc->capture_ratio = g_variant_get_uint64(data);
528 ret = (devc->capture_ratio > 100) ? SR_ERR : SR_OK;
530 case SR_CONF_VOLTAGE_THRESHOLD:
531 g_variant_get(data, "(dd)", &low, &high);
532 if (!strcmp(devc->profile->model, "DSLogic")) {
533 for (i = 0; (unsigned int)i < ARRAY_SIZE(voltage_thresholds); i++) {
534 if (fabs(voltage_thresholds[i].low - low) < 0.1 &&
535 fabs(voltage_thresholds[i].high - high) < 0.1) {
536 devc->cur_threshold =
537 voltage_thresholds[i].low;
541 ret = dslogic_fpga_firmware_upload(sdi);
543 ret = dslogic_set_voltage_threshold(sdi, (low + high) / 2.0);
546 case SR_CONF_EXTERNAL_CLOCK:
547 devc->external_clock = g_variant_get_boolean(data);
549 case SR_CONF_CONTINUOUS:
550 devc->continuous_mode = g_variant_get_boolean(data);
552 case SR_CONF_CLOCK_EDGE:
553 i = lookup_index(data, signal_edge_names,
554 ARRAY_SIZE(signal_edge_names));
557 devc->clock_edge = i;
566 static int config_list(uint32_t key, GVariant **data,
567 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
569 struct dev_context *devc = NULL;
570 GVariant *gvar, *range[2];
578 case SR_CONF_SCAN_OPTIONS:
579 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
580 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
582 case SR_CONF_DEVICE_OPTIONS:
584 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
585 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
588 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
589 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
592 case SR_CONF_VOLTAGE_THRESHOLD:
595 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
596 if (devc && !strcmp(devc->profile->model, "DSLogic")) {
597 for (i = 0; i < ARRAY_SIZE(voltage_thresholds); i++) {
598 range[0] = g_variant_new_double(voltage_thresholds[i].low);
599 range[1] = g_variant_new_double(voltage_thresholds[i].high);
600 gvar = g_variant_new_tuple(range, 2);
601 g_variant_builder_add_value(&gvb, gvar);
604 for (v = 0.0; v <= 5.0; v += 0.1) {
605 range[0] = g_variant_new_double(v);
606 range[1] = g_variant_new_double(v);
607 gvar = g_variant_new_tuple(range, 2);
608 g_variant_builder_add_value(&gvb, gvar);
611 *data = g_variant_builder_end(&gvb);
613 case SR_CONF_SAMPLERATE:
615 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
616 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), devc->samplerates,
617 devc->num_samplerates, sizeof(uint64_t));
618 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
619 *data = g_variant_builder_end(&gvb);
621 case SR_CONF_CLOCK_EDGE:
622 *data = g_variant_new_strv(signal_edge_names,
623 ARRAY_SIZE(signal_edge_names));
632 static struct sr_dev_driver dreamsourcelab_dslogic_driver_info = {
633 .name = "dreamsourcelab-dslogic",
634 .longname = "DreamSourceLab DSLogic",
637 .cleanup = std_cleanup,
639 .dev_list = std_dev_list,
640 .dev_clear = dev_clear,
641 .config_get = config_get,
642 .config_set = config_set,
643 .config_list = config_list,
644 .dev_open = dev_open,
645 .dev_close = dev_close,
646 .dev_acquisition_start = dslogic_acquisition_start,
647 .dev_acquisition_stop = dslogic_acquisition_stop,
650 SR_REGISTER_DEV_DRIVER(dreamsourcelab_dslogic_driver_info);