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 /* Open and initialize device.
253 static int dev_open(struct sr_dev_inst *sdi)
255 struct drv_context *drvc;
256 struct dev_context *devc;
257 struct sr_usb_dev_inst *usb;
260 drvc = sdi->driver->context;
265 sr_err("Driver was not initialized.");
268 if (sdi->status != SR_ST_INACTIVE) {
269 sr_err("Device already open.");
273 ret = sr_usb_open(drvc->sr_ctx->libusb_ctx, usb);
277 ret = libusb_set_configuration(usb->devhdl, USB_CONFIG);
279 sr_err("Failed to set USB configuration: %s.",
280 libusb_error_name(ret));
285 ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
287 sr_err("Failed to claim interface: %s.",
288 libusb_error_name(ret));
293 sdi->status = SR_ST_ACTIVE;
295 devc->active_fpga_config = FPGA_NOCONF;
296 devc->state = STATE_IDLE;
298 ret = (*devc->model->apply_fpga_config)(sdi);
301 ret = (*devc->model->device_init_check)(sdi);
304 sdi->status = SR_ST_INACTIVE;
310 /* Shutdown and close device.
312 static int dev_close(struct sr_dev_inst *sdi)
314 struct drv_context *drvc;
315 struct dev_context *devc;
316 struct sr_usb_dev_inst *usb;
319 drvc = sdi->driver->context;
324 sr_err("Driver was not initialized.");
327 if (sdi->status == SR_ST_INACTIVE) {
328 sr_dbg("Device already closed.");
331 if (devc->acquisition) {
332 sr_err("Cannot close device during acquisition!");
333 /* Request stop, leak handle, and prepare for the worst. */
334 devc->cancel_requested = TRUE;
338 sdi->status = SR_ST_INACTIVE;
340 /* Download of the shutdown bitstream, if any. */
341 ret = (*devc->model->apply_fpga_config)(sdi);
343 sr_warn("Unable to shut down device.");
345 libusb_release_interface(usb->devhdl, USB_INTERFACE);
351 /* Check whether the device options contain a specific key.
352 * Also match against get/set/list bits if specified.
354 static int has_devopt(const struct model_info *model, uint32_t key)
358 for (i = 0; i < model->num_devopts; i++) {
359 if ((model->devopts[i] & (SR_CONF_MASK | key)) == key)
365 /* Read device configuration setting.
367 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
368 const struct sr_channel_group *cg)
370 struct dev_context *devc;
380 if (!has_devopt(devc->model, key | SR_CONF_GET))
384 case SR_CONF_SAMPLERATE:
385 *data = g_variant_new_uint64(devc->samplerate);
387 case SR_CONF_LIMIT_MSEC:
388 *data = g_variant_new_uint64(devc->limit_msec);
390 case SR_CONF_LIMIT_SAMPLES:
391 *data = g_variant_new_uint64(devc->limit_samples);
394 *data = g_variant_new_boolean(devc->cfg_rle);
396 case SR_CONF_EXTERNAL_CLOCK:
397 *data = g_variant_new_boolean(devc->cfg_clock_source
400 case SR_CONF_CLOCK_EDGE:
401 idx = devc->cfg_clock_edge;
402 if (idx >= ARRAY_SIZE(signal_edge_names))
404 *data = g_variant_new_string(signal_edge_names[idx]);
406 case SR_CONF_TRIGGER_SOURCE:
407 idx = devc->cfg_trigger_source;
408 if (idx >= ARRAY_SIZE(trigger_source_names))
410 *data = g_variant_new_string(trigger_source_names[idx]);
412 case SR_CONF_TRIGGER_SLOPE:
413 idx = devc->cfg_trigger_slope;
414 if (idx >= ARRAY_SIZE(signal_edge_names))
416 *data = g_variant_new_string(signal_edge_names[idx]);
419 /* Must not happen for a key listed in devopts. */
426 /* Helper for mapping a string-typed configuration value to an index
427 * within a table of possible values.
429 static int lookup_index(GVariant *value, const char *const *table, int len)
434 entry = g_variant_get_string(value, NULL);
438 /* Linear search is fine for very small tables. */
439 for (i = 0; i < len; ++i) {
440 if (strcmp(entry, table[i]) == 0)
446 /* Write device configuration setting.
448 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
449 const struct sr_channel_group *cg)
452 struct dev_context *devc;
462 if (!has_devopt(devc->model, key | SR_CONF_SET))
466 case SR_CONF_SAMPLERATE:
467 value = g_variant_get_uint64(data);
468 if (value < devc->model->samplerates[devc->model->num_samplerates - 1]
469 || value > devc->model->samplerates[0])
470 return SR_ERR_SAMPLERATE;
471 devc->samplerate = value;
473 case SR_CONF_LIMIT_MSEC:
474 value = g_variant_get_uint64(data);
475 if (value > MAX_LIMIT_MSEC)
477 devc->limit_msec = value;
479 case SR_CONF_LIMIT_SAMPLES:
480 value = g_variant_get_uint64(data);
481 if (value > MAX_LIMIT_SAMPLES)
483 devc->limit_samples = value;
486 devc->cfg_rle = g_variant_get_boolean(data);
488 case SR_CONF_EXTERNAL_CLOCK:
489 devc->cfg_clock_source = (g_variant_get_boolean(data))
490 ? CLOCK_EXT_CLK : CLOCK_INTERNAL;
492 case SR_CONF_CLOCK_EDGE:
493 idx = lookup_index(data, signal_edge_names,
494 ARRAY_SIZE(signal_edge_names));
497 devc->cfg_clock_edge = idx;
499 case SR_CONF_TRIGGER_SOURCE:
500 idx = lookup_index(data, trigger_source_names,
501 ARRAY_SIZE(trigger_source_names));
504 devc->cfg_trigger_source = idx;
506 case SR_CONF_TRIGGER_SLOPE:
507 idx = lookup_index(data, signal_edge_names,
508 ARRAY_SIZE(signal_edge_names));
511 devc->cfg_trigger_slope = idx;
514 /* Must not happen for a key listed in devopts. */
521 /* Apply channel configuration change.
523 static int config_channel_set(const struct sr_dev_inst *sdi,
524 struct sr_channel *ch, unsigned int changes)
526 uint64_t channel_bit;
527 struct dev_context *devc;
534 if (ch->index < 0 || ch->index >= devc->model->num_channels) {
535 sr_err("Channel index %d out of range.", ch->index);
539 if ((changes & SR_CHANNEL_SET_ENABLED) != 0) {
540 channel_bit = UINT64_C(1) << ch->index;
542 /* Enable or disable logic input for this channel. */
544 devc->channel_mask |= channel_bit;
546 devc->channel_mask &= ~channel_bit;
552 /* Derive trigger masks from the session's trigger configuration.
554 static int prepare_trigger_masks(const struct sr_dev_inst *sdi)
556 uint64_t trigger_mask;
557 uint64_t trigger_values;
558 uint64_t trigger_edge_mask;
559 uint64_t channel_bit;
560 struct dev_context *devc;
561 struct sr_trigger *trigger;
562 struct sr_trigger_stage *stage;
563 struct sr_trigger_match *match;
569 trigger = sr_session_trigger_get(sdi->session);
570 if (!trigger || !trigger->stages)
573 if (trigger->stages->next) {
574 sr_err("This device only supports 1 trigger stage.");
577 stage = trigger->stages->data;
581 trigger_edge_mask = 0;
583 for (node = stage->matches; node; node = node->next) {
586 if (!match->channel->enabled)
587 continue; /* ignore disabled channel */
589 idx = match->channel->index;
591 if (idx < 0 || idx >= devc->model->num_channels) {
592 sr_err("Channel index %d out of range.", idx);
593 return SR_ERR_BUG; /* should not happen */
595 channel_bit = UINT64_C(1) << idx;
596 trigger_mask |= channel_bit;
598 switch (match->match) {
599 case SR_TRIGGER_ZERO:
602 trigger_values |= channel_bit;
604 case SR_TRIGGER_RISING:
605 trigger_values |= channel_bit;
606 /* Fall through for edge mask. */
607 case SR_TRIGGER_FALLING:
608 trigger_edge_mask |= channel_bit;
611 sr_err("Unsupported trigger match for CH%d.", idx + 1);
615 devc->trigger_mask = trigger_mask;
616 devc->trigger_values = trigger_values;
617 devc->trigger_edge_mask = trigger_edge_mask;
622 /* Apply current device configuration to the hardware.
624 static int config_commit(const struct sr_dev_inst *sdi)
626 struct dev_context *devc;
631 if (sdi->status != SR_ST_ACTIVE)
632 return SR_ERR_DEV_CLOSED;
634 if (devc->acquisition) {
635 sr_err("Acquisition still in progress?");
639 ret = prepare_trigger_masks(sdi);
643 ret = (*devc->model->apply_fpga_config)(sdi);
645 sr_err("Failed to apply FPGA configuration.");
652 /* List available choices for a configuration setting.
654 static int config_list(uint32_t key, GVariant **data,
655 const struct sr_dev_inst *sdi,
656 const struct sr_channel_group *cg)
658 struct dev_context *devc;
664 if (key == SR_CONF_SCAN_OPTIONS) {
665 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
666 scanopts, ARRAY_SIZE(scanopts),
667 sizeof(scanopts[0]));
671 if (key != SR_CONF_DEVICE_OPTIONS)
674 /* List driver capabilities. */
675 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
676 drvopts, ARRAY_SIZE(drvopts),
683 /* List the model's device options. */
684 if (key == SR_CONF_DEVICE_OPTIONS) {
685 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
686 devc->model->devopts,
687 devc->model->num_devopts,
688 sizeof(devc->model->devopts[0]));
692 if (!has_devopt(devc->model, key | SR_CONF_LIST))
696 case SR_CONF_SAMPLERATE:
697 g_variant_builder_init(&gvb, G_VARIANT_TYPE_VARDICT);
698 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT64,
699 devc->model->samplerates,
700 devc->model->num_samplerates,
701 sizeof(devc->model->samplerates[0]));
702 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
703 *data = g_variant_builder_end(&gvb);
705 case SR_CONF_TRIGGER_MATCH:
706 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
708 ARRAY_SIZE(trigger_matches),
709 sizeof(trigger_matches[0]));
711 case SR_CONF_TRIGGER_SOURCE:
712 *data = g_variant_new_strv(trigger_source_names,
713 ARRAY_SIZE(trigger_source_names));
715 case SR_CONF_TRIGGER_SLOPE:
716 case SR_CONF_CLOCK_EDGE:
717 *data = g_variant_new_strv(signal_edge_names,
718 ARRAY_SIZE(signal_edge_names));
721 /* Must not happen for a key listed in devopts. */
728 /* Set up the device hardware to begin capturing samples as soon as the
729 * configured trigger conditions are met, or immediately if no triggers
732 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
736 if (sdi->status != SR_ST_ACTIVE)
737 return SR_ERR_DEV_CLOSED;
739 sr_info("Starting acquisition.");
741 return lwla_start_acquisition(sdi);
744 /* Request that a running capture operation be stopped.
746 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
748 struct dev_context *devc;
753 if (sdi->status != SR_ST_ACTIVE)
754 return SR_ERR_DEV_CLOSED;
756 if (devc->state != STATE_IDLE && !devc->cancel_requested) {
757 devc->cancel_requested = TRUE;
758 sr_dbg("Stopping acquisition.");
763 /* SysClk LWLA driver descriptor.
765 SR_PRIV struct sr_dev_driver sysclk_lwla_driver_info = {
766 .name = "sysclk-lwla",
767 .longname = "SysClk LWLA series",
770 .cleanup = dev_clear,
772 .dev_list = dev_list,
773 .dev_clear = dev_clear,
774 .config_get = config_get,
775 .config_set = config_set,
776 .config_channel_set = config_channel_set,
777 .config_commit = config_commit,
778 .config_list = config_list,
779 .dev_open = dev_open,
780 .dev_close = dev_close,
781 .dev_acquisition_start = dev_acquisition_start,
782 .dev_acquisition_stop = dev_acquisition_stop,