2 * This file is part of the libsigrok project.
4 * Copyright (C) 2014 Daniel Elstner <daniel.kitta@gmail.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/>.
25 #include <libsigrok/libsigrok.h>
26 #include <libsigrok-internal.h>
29 /* Supported device scan options.
31 static const uint32_t scanopts[] = {
35 /* Driver capabilities.
37 static const uint32_t drvopts[] = {
38 SR_CONF_LOGIC_ANALYZER,
41 /* Supported trigger match conditions.
43 static const int32_t trigger_matches[] = {
50 /* Names assigned to available trigger sources.
52 static const char *const trigger_source_names[] = {
53 [TRIGGER_CHANNELS] = "CH",
54 [TRIGGER_EXT_TRG] = "TRG",
57 /* Names assigned to available edge slope choices.
59 static const char *const signal_edge_names[] = {
60 [EDGE_POSITIVE] = "r",
61 [EDGE_NEGATIVE] = "f",
64 /* Create a new sigrok device instance for the indicated LWLA model.
66 static struct sr_dev_inst *dev_inst_new(const struct model_info *model)
68 struct sr_dev_inst *sdi;
69 struct dev_context *devc;
73 /* Initialize private device context. */
74 devc = g_malloc0(sizeof(struct dev_context));
76 devc->active_fpga_config = FPGA_NOCONF;
78 devc->samplerate = model->samplerates[0];
79 devc->channel_mask = (UINT64_C(1) << model->num_channels) - 1;
81 /* Create sigrok device instance. */
82 sdi = g_malloc0(sizeof(struct sr_dev_inst));
83 sdi->status = SR_ST_INACTIVE;
84 sdi->vendor = g_strdup(VENDOR_NAME);
85 sdi->model = g_strdup(model->name);
88 /* Generate list of logic channels. */
89 for (i = 0; i < model->num_channels; i++) {
90 /* The LWLA series simply number channels from CH1 to CHxx. */
91 g_snprintf(name, sizeof(name), "CH%d", i + 1);
92 sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE, name);
98 /* Create a new device instance for a libusb device if it is a SysClk LWLA
99 * device and also matches the connection specification.
101 static struct sr_dev_inst *dev_inst_new_matching(GSList *conn_matches,
105 struct sr_usb_dev_inst *usb;
106 const struct model_info *model;
107 struct sr_dev_inst *sdi;
108 struct libusb_device_descriptor des;
109 int bus, address, ret;
110 unsigned int vid, pid;
112 bus = libusb_get_bus_number(dev);
113 address = libusb_get_device_address(dev);
115 for (node = conn_matches; node != NULL; node = node->next) {
117 if (usb && usb->bus == bus && usb->address == address)
120 if (conn_matches && !node)
121 return NULL; /* no match */
123 ret = libusb_get_device_descriptor(dev, &des);
125 sr_err("Failed to get USB device descriptor: %s.",
126 libusb_error_name(ret));
132 /* Create sigrok device instance. */
133 if (vid == USB_VID_SYSCLK && pid == USB_PID_LWLA1016) {
134 model = &lwla1016_info;
135 } else if (vid == USB_VID_SYSCLK && pid == USB_PID_LWLA1034) {
136 model = &lwla1034_info;
139 sr_warn("USB device %d.%d (%04x:%04x) is not a"
140 " SysClk LWLA.", bus, address, vid, pid);
143 sdi = dev_inst_new(model);
145 sdi->inst_type = SR_INST_USB;
146 sdi->conn = sr_usb_dev_inst_new(bus, address, NULL);
151 /* Scan for SysClk LWLA devices and create a device instance for each one.
153 static GSList *scan(struct sr_dev_driver *di, GSList *options)
155 GSList *conn_devices, *devices, *node;
156 struct drv_context *drvc;
157 struct sr_dev_inst *sdi;
158 struct sr_config *src;
160 libusb_device **devlist;
168 for (node = options; node != NULL; node = node->next) {
170 if (src->key == SR_CONF_CONN) {
171 conn = g_variant_get_string(src->data, NULL);
176 /* Find devices matching the connection specification. */
177 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
180 /* List all libusb devices. */
181 num_devs = libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
183 sr_err("Failed to list USB devices: %s.",
184 libusb_error_name(num_devs));
185 g_slist_free_full(conn_devices,
186 (GDestroyNotify)&sr_usb_dev_inst_free);
190 /* Scan the USB device list for matching LWLA devices. */
191 for (i = 0; i < num_devs; i++) {
192 sdi = dev_inst_new_matching(conn_devices, devlist[i]);
194 continue; /* no match */
196 /* Register device instance with driver. */
197 devices = g_slist_append(devices, sdi);
200 libusb_free_device_list(devlist, 1);
201 g_slist_free_full(conn_devices, (GDestroyNotify)&sr_usb_dev_inst_free);
203 return std_scan_complete(di, devices);
206 /* Destroy the private device context.
208 static void clear_dev_context(void *priv)
210 struct dev_context *devc;
214 if (devc->acquisition) {
215 sr_err("Cannot clear device context during acquisition!");
216 return; /* Leak and pray. */
218 sr_dbg("Device context cleared.");
223 /* Destroy all device instances.
225 static int dev_clear(const struct sr_dev_driver *di)
227 return std_dev_clear(di, &clear_dev_context);
230 /* Drain any pending data from the USB transfer buffers on the device.
231 * This may be necessary e.g. after a crash or generally to clean up after
232 * an abnormal condition.
234 static int drain_usb(struct sr_usb_dev_inst *usb, unsigned int endpoint)
236 int drained, xfer_len, ret;
237 unsigned char buf[512];
238 const unsigned int drain_timeout_ms = 10;
243 ret = libusb_bulk_transfer(usb->devhdl, endpoint,
244 buf, sizeof(buf), &xfer_len,
247 } while (ret == LIBUSB_SUCCESS && xfer_len != 0);
249 if (ret != LIBUSB_SUCCESS && ret != LIBUSB_ERROR_TIMEOUT) {
250 sr_err("Failed to drain USB endpoint %u: %s.",
251 endpoint & (LIBUSB_ENDPOINT_IN - 1),
252 libusb_error_name(ret));
256 sr_warn("Drained %d bytes from USB endpoint %u.",
257 drained, endpoint & (LIBUSB_ENDPOINT_IN - 1));
263 /* Open and initialize device.
265 static int dev_open(struct sr_dev_inst *sdi)
267 struct drv_context *drvc;
268 struct dev_context *devc;
269 struct sr_usb_dev_inst *usb;
272 drvc = sdi->driver->context;
276 if (sdi->status != SR_ST_INACTIVE) {
277 sr_err("Device already open.");
281 /* Try the whole shebang three times, fingers crossed. */
282 for (i = 0; i < 3; i++) {
283 ret = sr_usb_open(drvc->sr_ctx->libusb_ctx, usb);
287 ret = libusb_set_configuration(usb->devhdl, USB_CONFIG);
288 if (ret != LIBUSB_SUCCESS) {
289 sr_err("Failed to set USB configuration: %s.",
290 libusb_error_name(ret));
295 ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
296 if (ret != LIBUSB_SUCCESS) {
297 sr_err("Failed to claim interface: %s.",
298 libusb_error_name(ret));
303 ret = drain_usb(usb, EP_REPLY);
308 /* This delay appears to be necessary for reliable operation. */
311 sdi->status = SR_ST_ACTIVE;
313 devc->active_fpga_config = FPGA_NOCONF;
314 devc->short_transfer_quirk = FALSE;
315 devc->state = STATE_IDLE;
317 ret = (*devc->model->apply_fpga_config)(sdi);
320 ret = (*devc->model->device_init_check)(sdi);
324 /* Rinse and repeat. */
325 sdi->status = SR_ST_INACTIVE;
329 if (ret == SR_OK && devc->short_transfer_quirk)
330 sr_warn("Short transfer quirk detected! "
331 "Memory reads will be slow.");
335 /* Shutdown and close device.
337 static int dev_close(struct sr_dev_inst *sdi)
339 struct dev_context *devc;
340 struct sr_usb_dev_inst *usb;
346 if (sdi->status == SR_ST_INACTIVE) {
347 sr_dbg("Device already closed.");
350 if (devc->acquisition) {
351 sr_err("Cannot close device during acquisition!");
352 /* Request stop, leak handle, and prepare for the worst. */
353 devc->cancel_requested = TRUE;
357 sdi->status = SR_ST_INACTIVE;
359 /* Download of the shutdown bitstream, if any. */
360 ret = (*devc->model->apply_fpga_config)(sdi);
362 sr_warn("Unable to shut down device.");
364 libusb_release_interface(usb->devhdl, USB_INTERFACE);
370 /* Check whether the device options contain a specific key.
371 * Also match against get/set/list bits if specified.
373 static int has_devopt(const struct model_info *model, uint32_t key)
377 for (i = 0; i < model->num_devopts; i++) {
378 if ((model->devopts[i] & (SR_CONF_MASK | key)) == key)
385 /* Read device configuration setting.
387 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
388 const struct sr_channel_group *cg)
390 struct dev_context *devc;
400 if (!has_devopt(devc->model, key | SR_CONF_GET))
404 case SR_CONF_SAMPLERATE:
405 *data = g_variant_new_uint64(devc->samplerate);
407 case SR_CONF_LIMIT_MSEC:
408 *data = g_variant_new_uint64(devc->limit_msec);
410 case SR_CONF_LIMIT_SAMPLES:
411 *data = g_variant_new_uint64(devc->limit_samples);
414 *data = g_variant_new_boolean(devc->cfg_rle);
416 case SR_CONF_EXTERNAL_CLOCK:
417 *data = g_variant_new_boolean(devc->cfg_clock_source
420 case SR_CONF_CLOCK_EDGE:
421 idx = devc->cfg_clock_edge;
422 if (idx >= ARRAY_SIZE(signal_edge_names))
424 *data = g_variant_new_string(signal_edge_names[idx]);
426 case SR_CONF_TRIGGER_SOURCE:
427 idx = devc->cfg_trigger_source;
428 if (idx >= ARRAY_SIZE(trigger_source_names))
430 *data = g_variant_new_string(trigger_source_names[idx]);
432 case SR_CONF_TRIGGER_SLOPE:
433 idx = devc->cfg_trigger_slope;
434 if (idx >= ARRAY_SIZE(signal_edge_names))
436 *data = g_variant_new_string(signal_edge_names[idx]);
439 /* Must not happen for a key listed in devopts. */
446 /* Helper for mapping a string-typed configuration value to an index
447 * within a table of possible values.
449 static int lookup_index(GVariant *value, const char *const *table, int len)
454 entry = g_variant_get_string(value, NULL);
458 /* Linear search is fine for very small tables. */
459 for (i = 0; i < len; i++) {
460 if (strcmp(entry, table[i]) == 0)
467 /* Write device configuration setting.
469 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
470 const struct sr_channel_group *cg)
473 struct dev_context *devc;
483 if (!has_devopt(devc->model, key | SR_CONF_SET))
487 case SR_CONF_SAMPLERATE:
488 value = g_variant_get_uint64(data);
489 if (value < devc->model->samplerates[devc->model->num_samplerates - 1]
490 || value > devc->model->samplerates[0])
491 return SR_ERR_SAMPLERATE;
492 devc->samplerate = value;
494 case SR_CONF_LIMIT_MSEC:
495 value = g_variant_get_uint64(data);
496 if (value > MAX_LIMIT_MSEC)
498 devc->limit_msec = value;
500 case SR_CONF_LIMIT_SAMPLES:
501 value = g_variant_get_uint64(data);
502 if (value > MAX_LIMIT_SAMPLES)
504 devc->limit_samples = value;
507 devc->cfg_rle = g_variant_get_boolean(data);
509 case SR_CONF_EXTERNAL_CLOCK:
510 devc->cfg_clock_source = (g_variant_get_boolean(data))
511 ? CLOCK_EXT_CLK : CLOCK_INTERNAL;
513 case SR_CONF_CLOCK_EDGE:
514 idx = lookup_index(data, signal_edge_names,
515 ARRAY_SIZE(signal_edge_names));
518 devc->cfg_clock_edge = idx;
520 case SR_CONF_TRIGGER_SOURCE:
521 idx = lookup_index(data, trigger_source_names,
522 ARRAY_SIZE(trigger_source_names));
525 devc->cfg_trigger_source = idx;
527 case SR_CONF_TRIGGER_SLOPE:
528 idx = lookup_index(data, signal_edge_names,
529 ARRAY_SIZE(signal_edge_names));
532 devc->cfg_trigger_slope = idx;
535 /* Must not happen for a key listed in devopts. */
542 /* Apply channel configuration change.
544 static int config_channel_set(const struct sr_dev_inst *sdi,
545 struct sr_channel *ch, unsigned int changes)
547 uint64_t channel_bit;
548 struct dev_context *devc;
555 if (ch->index < 0 || ch->index >= devc->model->num_channels) {
556 sr_err("Channel index %d out of range.", ch->index);
560 if ((changes & SR_CHANNEL_SET_ENABLED) != 0) {
561 channel_bit = UINT64_C(1) << ch->index;
563 /* Enable or disable logic input for this channel. */
565 devc->channel_mask |= channel_bit;
567 devc->channel_mask &= ~channel_bit;
573 /* Derive trigger masks from the session's trigger configuration.
575 static int prepare_trigger_masks(const struct sr_dev_inst *sdi)
577 uint64_t trigger_mask, trigger_values, trigger_edge_mask;
578 uint64_t level_bit, type_bit;
579 struct dev_context *devc;
580 struct sr_trigger *trigger;
581 struct sr_trigger_stage *stage;
582 struct sr_trigger_match *match;
585 enum sr_trigger_matches trg;
589 trigger = sr_session_trigger_get(sdi->session);
590 if (!trigger || !trigger->stages)
593 if (trigger->stages->next) {
594 sr_err("This device only supports 1 trigger stage.");
597 stage = trigger->stages->data;
601 trigger_edge_mask = 0;
603 for (node = stage->matches; node; node = node->next) {
606 if (!match->channel->enabled)
607 continue; /* Ignore disabled channel. */
609 idx = match->channel->index;
612 if (idx < 0 || idx >= devc->model->num_channels) {
613 sr_err("Channel index %d out of range.", idx);
614 return SR_ERR_BUG; /* Should not happen. */
616 if (trg != SR_TRIGGER_ZERO
617 && trg != SR_TRIGGER_ONE
618 && trg != SR_TRIGGER_RISING
619 && trg != SR_TRIGGER_FALLING) {
620 sr_err("Unsupported trigger match for CH%d.", idx + 1);
623 level_bit = (trg == SR_TRIGGER_ONE
624 || trg == SR_TRIGGER_RISING) ? 1 : 0;
625 type_bit = (trg == SR_TRIGGER_RISING
626 || trg == SR_TRIGGER_FALLING) ? 1 : 0;
628 trigger_mask |= UINT64_C(1) << idx;
629 trigger_values |= level_bit << idx;
630 trigger_edge_mask |= type_bit << idx;
632 devc->trigger_mask = trigger_mask;
633 devc->trigger_values = trigger_values;
634 devc->trigger_edge_mask = trigger_edge_mask;
639 /* Apply current device configuration to the hardware.
641 static int config_commit(const struct sr_dev_inst *sdi)
643 struct dev_context *devc;
648 if (sdi->status != SR_ST_ACTIVE)
649 return SR_ERR_DEV_CLOSED;
651 if (devc->acquisition) {
652 sr_err("Acquisition still in progress?");
656 ret = prepare_trigger_masks(sdi);
660 ret = (*devc->model->apply_fpga_config)(sdi);
662 sr_err("Failed to apply FPGA configuration.");
669 /* List available choices for a configuration setting.
671 static int config_list(uint32_t key, GVariant **data,
672 const struct sr_dev_inst *sdi,
673 const struct sr_channel_group *cg)
675 struct dev_context *devc;
681 if (key == SR_CONF_SCAN_OPTIONS) {
682 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
683 scanopts, ARRAY_SIZE(scanopts), sizeof(scanopts[0]));
687 if (key != SR_CONF_DEVICE_OPTIONS)
690 /* List driver capabilities. */
691 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
692 drvopts, ARRAY_SIZE(drvopts), sizeof(drvopts[0]));
698 /* List the model's device options. */
699 if (key == SR_CONF_DEVICE_OPTIONS) {
700 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
701 devc->model->devopts, devc->model->num_devopts,
702 sizeof(devc->model->devopts[0]));
706 if (!has_devopt(devc->model, key | SR_CONF_LIST))
710 case SR_CONF_SAMPLERATE:
711 g_variant_builder_init(&gvb, G_VARIANT_TYPE_VARDICT);
712 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT64,
713 devc->model->samplerates, devc->model->num_samplerates,
714 sizeof(devc->model->samplerates[0]));
715 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
716 *data = g_variant_builder_end(&gvb);
718 case SR_CONF_TRIGGER_MATCH:
719 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
720 trigger_matches, ARRAY_SIZE(trigger_matches),
721 sizeof(trigger_matches[0]));
723 case SR_CONF_TRIGGER_SOURCE:
724 *data = g_variant_new_strv(trigger_source_names,
725 ARRAY_SIZE(trigger_source_names));
727 case SR_CONF_TRIGGER_SLOPE:
728 case SR_CONF_CLOCK_EDGE:
729 *data = g_variant_new_strv(signal_edge_names,
730 ARRAY_SIZE(signal_edge_names));
733 /* Must not happen for a key listed in devopts. */
740 /* Set up the device hardware to begin capturing samples as soon as the
741 * configured trigger conditions are met, or immediately if no triggers
744 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
746 if (sdi->status != SR_ST_ACTIVE)
747 return SR_ERR_DEV_CLOSED;
749 sr_info("Starting acquisition.");
751 return lwla_start_acquisition(sdi);
754 /* Request that a running capture operation be stopped.
756 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
758 struct dev_context *devc;
762 if (sdi->status != SR_ST_ACTIVE)
763 return SR_ERR_DEV_CLOSED;
765 if (devc->state != STATE_IDLE && !devc->cancel_requested) {
766 devc->cancel_requested = TRUE;
767 sr_dbg("Stopping acquisition.");
773 /* SysClk LWLA driver descriptor.
775 static struct sr_dev_driver sysclk_lwla_driver_info = {
776 .name = "sysclk-lwla",
777 .longname = "SysClk LWLA series",
780 .cleanup = std_cleanup,
782 .dev_list = std_dev_list,
783 .dev_clear = dev_clear,
784 .config_get = config_get,
785 .config_set = config_set,
786 .config_channel_set = config_channel_set,
787 .config_commit = config_commit,
788 .config_list = config_list,
789 .dev_open = dev_open,
790 .dev_close = dev_close,
791 .dev_acquisition_start = dev_acquisition_start,
792 .dev_acquisition_stop = dev_acquisition_stop,
795 SR_REGISTER_DEV_DRIVER(sysclk_lwla_driver_info);