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 /* Drain any pending data from the USB transfer buffers on the device.
207 * This may be necessary e.g. after a crash or generally to clean up after
208 * an abnormal condition.
210 static int drain_usb(struct sr_usb_dev_inst *usb, unsigned int endpoint)
212 int drained, xfer_len, ret;
213 unsigned char buf[512];
214 const unsigned int drain_timeout_ms = 10;
219 ret = libusb_bulk_transfer(usb->devhdl, endpoint,
220 buf, sizeof(buf), &xfer_len,
223 } while (ret == LIBUSB_SUCCESS && xfer_len != 0);
225 if (ret != LIBUSB_SUCCESS && ret != LIBUSB_ERROR_TIMEOUT) {
226 sr_err("Failed to drain USB endpoint %u: %s.",
227 endpoint & (LIBUSB_ENDPOINT_IN - 1),
228 libusb_error_name(ret));
232 sr_warn("Drained %d bytes from USB endpoint %u.",
233 drained, endpoint & (LIBUSB_ENDPOINT_IN - 1));
239 /* Open and initialize device.
241 static int dev_open(struct sr_dev_inst *sdi)
243 struct drv_context *drvc;
244 struct dev_context *devc;
245 struct sr_usb_dev_inst *usb;
248 drvc = sdi->driver->context;
252 /* Try the whole shebang three times, fingers crossed. */
253 for (i = 0; i < 3; i++) {
254 ret = sr_usb_open(drvc->sr_ctx->libusb_ctx, usb);
258 ret = libusb_set_configuration(usb->devhdl, USB_CONFIG);
259 if (ret != LIBUSB_SUCCESS) {
260 sr_err("Failed to set USB configuration: %s.",
261 libusb_error_name(ret));
266 ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
267 if (ret != LIBUSB_SUCCESS) {
268 sr_err("Failed to claim interface: %s.",
269 libusb_error_name(ret));
274 ret = drain_usb(usb, EP_REPLY);
279 /* This delay appears to be necessary for reliable operation. */
282 devc->active_fpga_config = FPGA_NOCONF;
283 devc->short_transfer_quirk = FALSE;
284 devc->state = STATE_IDLE;
286 ret = (*devc->model->apply_fpga_config)(sdi);
289 ret = (*devc->model->device_init_check)(sdi);
293 /* Rinse and repeat. */
297 if (ret == SR_OK && devc->short_transfer_quirk)
298 sr_warn("Short transfer quirk detected! "
299 "Memory reads will be slow.");
303 /* Shutdown and close device. */
304 static int dev_close(struct sr_dev_inst *sdi)
306 struct dev_context *devc;
307 struct sr_usb_dev_inst *usb;
313 if (devc->acquisition) {
314 sr_err("Cannot close device during acquisition!");
315 /* Request stop, leak handle, and prepare for the worst. */
316 devc->cancel_requested = TRUE;
320 /* Download of the shutdown bitstream, if any. */
321 ret = (*devc->model->apply_fpga_config)(sdi);
323 sr_warn("Unable to shut down device.");
325 libusb_release_interface(usb->devhdl, USB_INTERFACE);
332 /* Check whether the device options contain a specific key.
333 * Also match against get/set/list bits if specified.
335 static int has_devopt(const struct model_info *model, uint32_t key)
339 for (i = 0; i < model->num_devopts; i++) {
340 if ((model->devopts[i] & (SR_CONF_MASK | key)) == key)
347 /* Read device configuration setting.
349 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
350 const struct sr_channel_group *cg)
352 struct dev_context *devc;
362 if (!has_devopt(devc->model, key | SR_CONF_GET))
366 case SR_CONF_SAMPLERATE:
367 *data = g_variant_new_uint64(devc->samplerate);
369 case SR_CONF_LIMIT_MSEC:
370 *data = g_variant_new_uint64(devc->limit_msec);
372 case SR_CONF_LIMIT_SAMPLES:
373 *data = g_variant_new_uint64(devc->limit_samples);
376 *data = g_variant_new_boolean(devc->cfg_rle);
378 case SR_CONF_EXTERNAL_CLOCK:
379 *data = g_variant_new_boolean(devc->cfg_clock_source
382 case SR_CONF_CLOCK_EDGE:
383 idx = devc->cfg_clock_edge;
384 if (idx >= ARRAY_SIZE(signal_edge_names))
386 *data = g_variant_new_string(signal_edge_names[idx]);
388 case SR_CONF_TRIGGER_SOURCE:
389 idx = devc->cfg_trigger_source;
390 if (idx >= ARRAY_SIZE(trigger_source_names))
392 *data = g_variant_new_string(trigger_source_names[idx]);
394 case SR_CONF_TRIGGER_SLOPE:
395 idx = devc->cfg_trigger_slope;
396 if (idx >= ARRAY_SIZE(signal_edge_names))
398 *data = g_variant_new_string(signal_edge_names[idx]);
401 /* Must not happen for a key listed in devopts. */
408 /* Helper for mapping a string-typed configuration value to an index
409 * within a table of possible values.
411 static int lookup_index(GVariant *value, const char *const *table, int len)
416 entry = g_variant_get_string(value, NULL);
420 /* Linear search is fine for very small tables. */
421 for (i = 0; i < len; i++) {
422 if (strcmp(entry, table[i]) == 0)
429 /* Write device configuration setting.
431 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
432 const struct sr_channel_group *cg)
435 struct dev_context *devc;
445 if (!has_devopt(devc->model, key | SR_CONF_SET))
449 case SR_CONF_SAMPLERATE:
450 value = g_variant_get_uint64(data);
451 if (value < devc->model->samplerates[devc->model->num_samplerates - 1]
452 || value > devc->model->samplerates[0])
453 return SR_ERR_SAMPLERATE;
454 devc->samplerate = value;
456 case SR_CONF_LIMIT_MSEC:
457 value = g_variant_get_uint64(data);
458 if (value > MAX_LIMIT_MSEC)
460 devc->limit_msec = value;
462 case SR_CONF_LIMIT_SAMPLES:
463 value = g_variant_get_uint64(data);
464 if (value > MAX_LIMIT_SAMPLES)
466 devc->limit_samples = value;
469 devc->cfg_rle = g_variant_get_boolean(data);
471 case SR_CONF_EXTERNAL_CLOCK:
472 devc->cfg_clock_source = (g_variant_get_boolean(data))
473 ? CLOCK_EXT_CLK : CLOCK_INTERNAL;
475 case SR_CONF_CLOCK_EDGE:
476 idx = lookup_index(data, signal_edge_names,
477 ARRAY_SIZE(signal_edge_names));
480 devc->cfg_clock_edge = idx;
482 case SR_CONF_TRIGGER_SOURCE:
483 idx = lookup_index(data, trigger_source_names,
484 ARRAY_SIZE(trigger_source_names));
487 devc->cfg_trigger_source = idx;
489 case SR_CONF_TRIGGER_SLOPE:
490 idx = lookup_index(data, signal_edge_names,
491 ARRAY_SIZE(signal_edge_names));
494 devc->cfg_trigger_slope = idx;
497 /* Must not happen for a key listed in devopts. */
504 /* Apply channel configuration change.
506 static int config_channel_set(const struct sr_dev_inst *sdi,
507 struct sr_channel *ch, unsigned int changes)
509 uint64_t channel_bit;
510 struct dev_context *devc;
517 if (ch->index < 0 || ch->index >= devc->model->num_channels) {
518 sr_err("Channel index %d out of range.", ch->index);
522 if ((changes & SR_CHANNEL_SET_ENABLED) != 0) {
523 channel_bit = UINT64_C(1) << ch->index;
525 /* Enable or disable logic input for this channel. */
527 devc->channel_mask |= channel_bit;
529 devc->channel_mask &= ~channel_bit;
535 /* Derive trigger masks from the session's trigger configuration.
537 static int prepare_trigger_masks(const struct sr_dev_inst *sdi)
539 uint64_t trigger_mask, trigger_values, trigger_edge_mask;
540 uint64_t level_bit, type_bit;
541 struct dev_context *devc;
542 struct sr_trigger *trigger;
543 struct sr_trigger_stage *stage;
544 struct sr_trigger_match *match;
547 enum sr_trigger_matches trg;
551 trigger = sr_session_trigger_get(sdi->session);
552 if (!trigger || !trigger->stages)
555 if (trigger->stages->next) {
556 sr_err("This device only supports 1 trigger stage.");
559 stage = trigger->stages->data;
563 trigger_edge_mask = 0;
565 for (node = stage->matches; node; node = node->next) {
568 if (!match->channel->enabled)
569 continue; /* Ignore disabled channel. */
571 idx = match->channel->index;
574 if (idx < 0 || idx >= devc->model->num_channels) {
575 sr_err("Channel index %d out of range.", idx);
576 return SR_ERR_BUG; /* Should not happen. */
578 if (trg != SR_TRIGGER_ZERO
579 && trg != SR_TRIGGER_ONE
580 && trg != SR_TRIGGER_RISING
581 && trg != SR_TRIGGER_FALLING) {
582 sr_err("Unsupported trigger match for CH%d.", idx + 1);
585 level_bit = (trg == SR_TRIGGER_ONE
586 || trg == SR_TRIGGER_RISING) ? 1 : 0;
587 type_bit = (trg == SR_TRIGGER_RISING
588 || trg == SR_TRIGGER_FALLING) ? 1 : 0;
590 trigger_mask |= UINT64_C(1) << idx;
591 trigger_values |= level_bit << idx;
592 trigger_edge_mask |= type_bit << idx;
594 devc->trigger_mask = trigger_mask;
595 devc->trigger_values = trigger_values;
596 devc->trigger_edge_mask = trigger_edge_mask;
601 /* Apply current device configuration to the hardware.
603 static int config_commit(const struct sr_dev_inst *sdi)
605 struct dev_context *devc;
610 if (devc->acquisition) {
611 sr_err("Acquisition still in progress?");
615 ret = prepare_trigger_masks(sdi);
619 ret = (*devc->model->apply_fpga_config)(sdi);
621 sr_err("Failed to apply FPGA configuration.");
628 static int config_list(uint32_t key, GVariant **data,
629 const struct sr_dev_inst *sdi,
630 const struct sr_channel_group *cg)
632 struct dev_context *devc;
636 devc = (sdi) ? sdi->priv : NULL;
639 case SR_CONF_SCAN_OPTIONS:
640 case SR_CONF_DEVICE_OPTIONS:
641 return std_opts_config_list(key, data, sdi, cg,
642 scanopts, ARRAY_SIZE(scanopts),
643 drvopts, ARRAY_SIZE(drvopts),
644 (devc) ? devc->model->devopts : NULL,
645 (devc) ? devc->model->num_devopts : 0);
648 if (!has_devopt(devc->model, key | SR_CONF_LIST))
652 case SR_CONF_SAMPLERATE:
653 g_variant_builder_init(&gvb, G_VARIANT_TYPE_VARDICT);
654 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT64,
655 devc->model->samplerates, devc->model->num_samplerates,
656 sizeof(devc->model->samplerates[0]));
657 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
658 *data = g_variant_builder_end(&gvb);
660 case SR_CONF_TRIGGER_MATCH:
661 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
662 trigger_matches, ARRAY_SIZE(trigger_matches),
663 sizeof(trigger_matches[0]));
665 case SR_CONF_TRIGGER_SOURCE:
666 *data = g_variant_new_strv(trigger_source_names,
667 ARRAY_SIZE(trigger_source_names));
669 case SR_CONF_TRIGGER_SLOPE:
670 case SR_CONF_CLOCK_EDGE:
671 *data = g_variant_new_strv(signal_edge_names,
672 ARRAY_SIZE(signal_edge_names));
675 /* Must not happen for a key listed in devopts. */
682 /* Set up the device hardware to begin capturing samples as soon as the
683 * configured trigger conditions are met, or immediately if no triggers
686 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
688 return lwla_start_acquisition(sdi);
691 /* Request that a running capture operation be stopped.
693 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
695 struct dev_context *devc;
699 if (devc->state != STATE_IDLE && !devc->cancel_requested) {
700 devc->cancel_requested = TRUE;
701 sr_dbg("Requesting cancel.");
707 /* SysClk LWLA driver descriptor.
709 static struct sr_dev_driver sysclk_lwla_driver_info = {
710 .name = "sysclk-lwla",
711 .longname = "SysClk LWLA series",
714 .cleanup = std_cleanup,
716 .dev_list = std_dev_list,
717 .dev_clear = std_dev_clear,
718 .config_get = config_get,
719 .config_set = config_set,
720 .config_channel_set = config_channel_set,
721 .config_commit = config_commit,
722 .config_list = config_list,
723 .dev_open = dev_open,
724 .dev_close = dev_close,
725 .dev_acquisition_start = dev_acquisition_start,
726 .dev_acquisition_stop = dev_acquisition_stop,
729 SR_REGISTER_DEV_DRIVER(sysclk_lwla_driver_info);