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 /* Initialize the SysClk LWLA driver.
66 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
68 return std_init(sr_ctx, di, LOG_PREFIX);
71 /* Create a new sigrok device instance for the indicated LWLA model.
73 static struct sr_dev_inst *dev_inst_new(const struct model_info *model)
75 struct sr_dev_inst *sdi;
76 struct dev_context *devc;
80 /* Initialize private device context. */
81 devc = g_malloc0(sizeof(struct dev_context));
83 devc->active_fpga_config = FPGA_NOCONF;
85 devc->samplerate = model->samplerates[0];
86 devc->channel_mask = (UINT64_C(1) << model->num_channels) - 1;
88 /* Create sigrok device instance. */
89 sdi = g_malloc0(sizeof(struct sr_dev_inst));
90 sdi->status = SR_ST_INACTIVE;
91 sdi->vendor = g_strdup(VENDOR_NAME);
92 sdi->model = g_strdup(model->name);
95 /* Generate list of logic channels. */
96 for (i = 0; i < model->num_channels; i++) {
97 /* The LWLA series simply number channels from CH1 to CHxx. */
98 g_snprintf(name, sizeof(name), "CH%d", i + 1);
99 sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE, name);
105 /* Create a new device instance for a libusb device if it is a SysClk LWLA
106 * device and also matches the connection specification.
108 static struct sr_dev_inst *dev_inst_new_matching(GSList *conn_matches,
112 struct sr_usb_dev_inst *usb;
113 const struct model_info *model;
114 struct sr_dev_inst *sdi;
115 struct libusb_device_descriptor des;
117 unsigned int vid, pid;
120 bus = libusb_get_bus_number(dev);
121 address = libusb_get_device_address(dev);
123 for (node = conn_matches; node != NULL; node = node->next) {
125 if (usb && usb->bus == bus && usb->address == address)
128 if (conn_matches && !node)
129 return NULL; /* no match */
131 ret = libusb_get_device_descriptor(dev, &des);
133 sr_err("Failed to get USB device descriptor: %s.",
134 libusb_error_name(ret));
140 /* Create sigrok device instance. */
141 if (vid == USB_VID_SYSCLK && pid == USB_PID_LWLA1016) {
142 model = &lwla1016_info;
143 } else if (vid == USB_VID_SYSCLK && pid == USB_PID_LWLA1034) {
144 model = &lwla1034_info;
147 sr_warn("USB device %d.%d (%04x:%04x) is not a"
148 " SysClk LWLA.", bus, address, vid, pid);
151 sdi = dev_inst_new(model);
153 sdi->inst_type = SR_INST_USB;
154 sdi->conn = sr_usb_dev_inst_new(bus, address, NULL);
159 /* Scan for SysClk LWLA devices and create a device instance for each one.
161 static GSList *scan(struct sr_dev_driver *di, GSList *options)
163 GSList *conn_devices, *devices, *node;
164 struct drv_context *drvc;
165 struct sr_dev_inst *sdi;
166 struct sr_config *src;
168 libusb_device **devlist;
176 for (node = options; node != NULL; node = node->next) {
178 if (src->key == SR_CONF_CONN) {
179 conn = g_variant_get_string(src->data, NULL);
184 /* Find devices matching the connection specification. */
185 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
188 /* List all libusb devices. */
189 num_devs = libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
191 sr_err("Failed to list USB devices: %s.",
192 libusb_error_name(num_devs));
193 g_slist_free_full(conn_devices,
194 (GDestroyNotify)&sr_usb_dev_inst_free);
198 /* Scan the USB device list for matching LWLA devices. */
199 for (i = 0; i < num_devs; i++) {
200 sdi = dev_inst_new_matching(conn_devices, devlist[i]);
202 continue; /* no match */
204 /* Register device instance with driver. */
206 drvc->instances = g_slist_append(drvc->instances, sdi);
207 devices = g_slist_append(devices, sdi);
210 libusb_free_device_list(devlist, 1);
211 g_slist_free_full(conn_devices, (GDestroyNotify)&sr_usb_dev_inst_free);
216 /* Return the list of devices found during scan.
218 static GSList *dev_list(const struct sr_dev_driver *di)
220 struct drv_context *drvc;
224 return drvc->instances;
227 /* Destroy the private device context.
229 static void clear_dev_context(void *priv)
231 struct dev_context *devc;
235 if (devc->acquisition) {
236 sr_err("Cannot clear device context during acquisition!");
237 return; /* leak and pray */
239 sr_dbg("Device context cleared.");
244 /* Destroy all device instances.
246 static int dev_clear(const struct sr_dev_driver *di)
248 return std_dev_clear(di, &clear_dev_context);
251 /* Drain any pending data from the USB transfer buffers on the device.
252 * This may be necessary e.g. after a crash or generally to clean up after
253 * an abnormal condition.
255 static int drain_usb(struct sr_usb_dev_inst *usb, unsigned int endpoint)
257 int drained, xfer_len;
259 unsigned char buf[512];
261 const unsigned int drain_timeout_ms = 10;
266 ret = libusb_bulk_transfer(usb->devhdl, endpoint,
267 buf, sizeof(buf), &xfer_len,
270 } while (ret == LIBUSB_SUCCESS && xfer_len != 0);
272 if (ret != LIBUSB_SUCCESS && ret != LIBUSB_ERROR_TIMEOUT) {
273 sr_err("Failed to drain USB endpoint %u: %s.",
274 endpoint & (LIBUSB_ENDPOINT_IN - 1),
275 libusb_error_name(ret));
279 sr_warn("Drained %d bytes from USB endpoint %u.",
280 drained, endpoint & (LIBUSB_ENDPOINT_IN - 1));
285 /* Open and initialize device.
287 static int dev_open(struct sr_dev_inst *sdi)
289 struct drv_context *drvc;
290 struct dev_context *devc;
291 struct sr_usb_dev_inst *usb;
295 drvc = sdi->driver->context;
300 sr_err("Driver was not initialized.");
303 if (sdi->status != SR_ST_INACTIVE) {
304 sr_err("Device already open.");
308 /* Try the whole shebang three times, fingers crossed. */
309 for (i = 0; i < 3; i++) {
310 ret = sr_usb_open(drvc->sr_ctx->libusb_ctx, usb);
314 ret = libusb_set_configuration(usb->devhdl, USB_CONFIG);
315 if (ret != LIBUSB_SUCCESS) {
316 sr_err("Failed to set USB configuration: %s.",
317 libusb_error_name(ret));
322 ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
323 if (ret != LIBUSB_SUCCESS) {
324 sr_err("Failed to claim interface: %s.",
325 libusb_error_name(ret));
330 ret = drain_usb(usb, EP_REPLY);
335 /* This delay appears to be necessary for reliable operation. */
338 sdi->status = SR_ST_ACTIVE;
340 devc->active_fpga_config = FPGA_NOCONF;
341 devc->short_transfer_quirk = FALSE;
342 devc->state = STATE_IDLE;
344 ret = (*devc->model->apply_fpga_config)(sdi);
347 ret = (*devc->model->device_init_check)(sdi);
351 /* Rinse and repeat. */
352 sdi->status = SR_ST_INACTIVE;
356 if (ret == SR_OK && devc->short_transfer_quirk)
357 sr_warn("Short transfer quirk detected! "
358 "Memory reads will be slow.");
362 /* Shutdown and close device.
364 static int dev_close(struct sr_dev_inst *sdi)
366 struct drv_context *drvc;
367 struct dev_context *devc;
368 struct sr_usb_dev_inst *usb;
371 drvc = sdi->driver->context;
376 sr_err("Driver was not initialized.");
379 if (sdi->status == SR_ST_INACTIVE) {
380 sr_dbg("Device already closed.");
383 if (devc->acquisition) {
384 sr_err("Cannot close device during acquisition!");
385 /* Request stop, leak handle, and prepare for the worst. */
386 devc->cancel_requested = TRUE;
390 sdi->status = SR_ST_INACTIVE;
392 /* Download of the shutdown bitstream, if any. */
393 ret = (*devc->model->apply_fpga_config)(sdi);
395 sr_warn("Unable to shut down device.");
397 libusb_release_interface(usb->devhdl, USB_INTERFACE);
403 /* Check whether the device options contain a specific key.
404 * Also match against get/set/list bits if specified.
406 static int has_devopt(const struct model_info *model, uint32_t key)
410 for (i = 0; i < model->num_devopts; i++) {
411 if ((model->devopts[i] & (SR_CONF_MASK | key)) == key)
417 /* Read device configuration setting.
419 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
420 const struct sr_channel_group *cg)
422 struct dev_context *devc;
432 if (!has_devopt(devc->model, key | SR_CONF_GET))
436 case SR_CONF_SAMPLERATE:
437 *data = g_variant_new_uint64(devc->samplerate);
439 case SR_CONF_LIMIT_MSEC:
440 *data = g_variant_new_uint64(devc->limit_msec);
442 case SR_CONF_LIMIT_SAMPLES:
443 *data = g_variant_new_uint64(devc->limit_samples);
446 *data = g_variant_new_boolean(devc->cfg_rle);
448 case SR_CONF_EXTERNAL_CLOCK:
449 *data = g_variant_new_boolean(devc->cfg_clock_source
452 case SR_CONF_CLOCK_EDGE:
453 idx = devc->cfg_clock_edge;
454 if (idx >= ARRAY_SIZE(signal_edge_names))
456 *data = g_variant_new_string(signal_edge_names[idx]);
458 case SR_CONF_TRIGGER_SOURCE:
459 idx = devc->cfg_trigger_source;
460 if (idx >= ARRAY_SIZE(trigger_source_names))
462 *data = g_variant_new_string(trigger_source_names[idx]);
464 case SR_CONF_TRIGGER_SLOPE:
465 idx = devc->cfg_trigger_slope;
466 if (idx >= ARRAY_SIZE(signal_edge_names))
468 *data = g_variant_new_string(signal_edge_names[idx]);
471 /* Must not happen for a key listed in devopts. */
478 /* Helper for mapping a string-typed configuration value to an index
479 * within a table of possible values.
481 static int lookup_index(GVariant *value, const char *const *table, int len)
486 entry = g_variant_get_string(value, NULL);
490 /* Linear search is fine for very small tables. */
491 for (i = 0; i < len; i++) {
492 if (strcmp(entry, table[i]) == 0)
498 /* Write device configuration setting.
500 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
501 const struct sr_channel_group *cg)
504 struct dev_context *devc;
514 if (!has_devopt(devc->model, key | SR_CONF_SET))
518 case SR_CONF_SAMPLERATE:
519 value = g_variant_get_uint64(data);
520 if (value < devc->model->samplerates[devc->model->num_samplerates - 1]
521 || value > devc->model->samplerates[0])
522 return SR_ERR_SAMPLERATE;
523 devc->samplerate = value;
525 case SR_CONF_LIMIT_MSEC:
526 value = g_variant_get_uint64(data);
527 if (value > MAX_LIMIT_MSEC)
529 devc->limit_msec = value;
531 case SR_CONF_LIMIT_SAMPLES:
532 value = g_variant_get_uint64(data);
533 if (value > MAX_LIMIT_SAMPLES)
535 devc->limit_samples = value;
538 devc->cfg_rle = g_variant_get_boolean(data);
540 case SR_CONF_EXTERNAL_CLOCK:
541 devc->cfg_clock_source = (g_variant_get_boolean(data))
542 ? CLOCK_EXT_CLK : CLOCK_INTERNAL;
544 case SR_CONF_CLOCK_EDGE:
545 idx = lookup_index(data, signal_edge_names,
546 ARRAY_SIZE(signal_edge_names));
549 devc->cfg_clock_edge = idx;
551 case SR_CONF_TRIGGER_SOURCE:
552 idx = lookup_index(data, trigger_source_names,
553 ARRAY_SIZE(trigger_source_names));
556 devc->cfg_trigger_source = idx;
558 case SR_CONF_TRIGGER_SLOPE:
559 idx = lookup_index(data, signal_edge_names,
560 ARRAY_SIZE(signal_edge_names));
563 devc->cfg_trigger_slope = idx;
566 /* Must not happen for a key listed in devopts. */
573 /* Apply channel configuration change.
575 static int config_channel_set(const struct sr_dev_inst *sdi,
576 struct sr_channel *ch, unsigned int changes)
578 uint64_t channel_bit;
579 struct dev_context *devc;
586 if (ch->index < 0 || ch->index >= devc->model->num_channels) {
587 sr_err("Channel index %d out of range.", ch->index);
591 if ((changes & SR_CHANNEL_SET_ENABLED) != 0) {
592 channel_bit = UINT64_C(1) << ch->index;
594 /* Enable or disable logic input for this channel. */
596 devc->channel_mask |= channel_bit;
598 devc->channel_mask &= ~channel_bit;
604 /* Derive trigger masks from the session's trigger configuration.
606 static int prepare_trigger_masks(const struct sr_dev_inst *sdi)
608 uint64_t trigger_mask;
609 uint64_t trigger_values;
610 uint64_t trigger_edge_mask;
611 uint64_t level_bit, type_bit;
612 struct dev_context *devc;
613 struct sr_trigger *trigger;
614 struct sr_trigger_stage *stage;
615 struct sr_trigger_match *match;
618 enum sr_trigger_matches trg;
622 trigger = sr_session_trigger_get(sdi->session);
623 if (!trigger || !trigger->stages)
626 if (trigger->stages->next) {
627 sr_err("This device only supports 1 trigger stage.");
630 stage = trigger->stages->data;
634 trigger_edge_mask = 0;
636 for (node = stage->matches; node; node = node->next) {
639 if (!match->channel->enabled)
640 continue; /* ignore disabled channel */
642 idx = match->channel->index;
645 if (idx < 0 || idx >= devc->model->num_channels) {
646 sr_err("Channel index %d out of range.", idx);
647 return SR_ERR_BUG; /* should not happen */
649 if (trg != SR_TRIGGER_ZERO
650 && trg != SR_TRIGGER_ONE
651 && trg != SR_TRIGGER_RISING
652 && trg != SR_TRIGGER_FALLING) {
653 sr_err("Unsupported trigger match for CH%d.", idx + 1);
656 level_bit = (trg == SR_TRIGGER_ONE
657 || trg == SR_TRIGGER_RISING) ? 1 : 0;
658 type_bit = (trg == SR_TRIGGER_RISING
659 || trg == SR_TRIGGER_FALLING) ? 1 : 0;
661 trigger_mask |= UINT64_C(1) << idx;
662 trigger_values |= level_bit << idx;
663 trigger_edge_mask |= type_bit << idx;
665 devc->trigger_mask = trigger_mask;
666 devc->trigger_values = trigger_values;
667 devc->trigger_edge_mask = trigger_edge_mask;
672 /* Apply current device configuration to the hardware.
674 static int config_commit(const struct sr_dev_inst *sdi)
676 struct dev_context *devc;
681 if (sdi->status != SR_ST_ACTIVE)
682 return SR_ERR_DEV_CLOSED;
684 if (devc->acquisition) {
685 sr_err("Acquisition still in progress?");
689 ret = prepare_trigger_masks(sdi);
693 ret = (*devc->model->apply_fpga_config)(sdi);
695 sr_err("Failed to apply FPGA configuration.");
702 /* List available choices for a configuration setting.
704 static int config_list(uint32_t key, GVariant **data,
705 const struct sr_dev_inst *sdi,
706 const struct sr_channel_group *cg)
708 struct dev_context *devc;
714 if (key == SR_CONF_SCAN_OPTIONS) {
715 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
716 scanopts, ARRAY_SIZE(scanopts),
717 sizeof(scanopts[0]));
721 if (key != SR_CONF_DEVICE_OPTIONS)
724 /* List driver capabilities. */
725 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
726 drvopts, ARRAY_SIZE(drvopts),
733 /* List the model's device options. */
734 if (key == SR_CONF_DEVICE_OPTIONS) {
735 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
736 devc->model->devopts,
737 devc->model->num_devopts,
738 sizeof(devc->model->devopts[0]));
742 if (!has_devopt(devc->model, key | SR_CONF_LIST))
746 case SR_CONF_SAMPLERATE:
747 g_variant_builder_init(&gvb, G_VARIANT_TYPE_VARDICT);
748 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT64,
749 devc->model->samplerates,
750 devc->model->num_samplerates,
751 sizeof(devc->model->samplerates[0]));
752 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
753 *data = g_variant_builder_end(&gvb);
755 case SR_CONF_TRIGGER_MATCH:
756 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
758 ARRAY_SIZE(trigger_matches),
759 sizeof(trigger_matches[0]));
761 case SR_CONF_TRIGGER_SOURCE:
762 *data = g_variant_new_strv(trigger_source_names,
763 ARRAY_SIZE(trigger_source_names));
765 case SR_CONF_TRIGGER_SLOPE:
766 case SR_CONF_CLOCK_EDGE:
767 *data = g_variant_new_strv(signal_edge_names,
768 ARRAY_SIZE(signal_edge_names));
771 /* Must not happen for a key listed in devopts. */
778 /* Set up the device hardware to begin capturing samples as soon as the
779 * configured trigger conditions are met, or immediately if no triggers
782 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
786 if (sdi->status != SR_ST_ACTIVE)
787 return SR_ERR_DEV_CLOSED;
789 sr_info("Starting acquisition.");
791 return lwla_start_acquisition(sdi);
794 /* Request that a running capture operation be stopped.
796 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
798 struct dev_context *devc;
803 if (sdi->status != SR_ST_ACTIVE)
804 return SR_ERR_DEV_CLOSED;
806 if (devc->state != STATE_IDLE && !devc->cancel_requested) {
807 devc->cancel_requested = TRUE;
808 sr_dbg("Stopping acquisition.");
813 /* SysClk LWLA driver descriptor.
815 SR_PRIV struct sr_dev_driver sysclk_lwla_driver_info = {
816 .name = "sysclk-lwla",
817 .longname = "SysClk LWLA series",
820 .cleanup = dev_clear,
822 .dev_list = dev_list,
823 .dev_clear = dev_clear,
824 .config_get = config_get,
825 .config_set = config_set,
826 .config_channel_set = config_channel_set,
827 .config_commit = config_commit,
828 .config_list = config_list,
829 .dev_open = dev_open,
830 .dev_close = dev_close,
831 .dev_acquisition_start = dev_acquisition_start,
832 .dev_acquisition_stop = dev_acquisition_stop,