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 static const uint32_t scanopts[] = {
33 static const uint32_t devopts[] = {
34 SR_CONF_LOGIC_ANALYZER,
35 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
36 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
37 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
38 SR_CONF_EXTERNAL_CLOCK | SR_CONF_GET | SR_CONF_SET,
39 SR_CONF_CLOCK_EDGE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
40 SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
41 SR_CONF_TRIGGER_SOURCE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
42 SR_CONF_TRIGGER_SLOPE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
45 static const int32_t trigger_matches[] = {
52 /* The hardware supports more samplerates than these, but these are the
53 * options hardcoded into the vendor's Windows GUI.
55 static const uint64_t samplerates[] = {
56 SR_MHZ(125), SR_MHZ(100),
57 SR_MHZ(50), SR_MHZ(20), SR_MHZ(10),
58 SR_MHZ(5), SR_MHZ(2), SR_MHZ(1),
59 SR_KHZ(500), SR_KHZ(200), SR_KHZ(100),
60 SR_KHZ(50), SR_KHZ(20), SR_KHZ(10),
61 SR_KHZ(5), SR_KHZ(2), SR_KHZ(1),
62 SR_HZ(500), SR_HZ(200), SR_HZ(100),
65 /* Names assigned to available trigger sources. Indices must match
66 * trigger_source enum values.
68 static const char *const trigger_source_names[] = { "CH", "TRG" };
70 /* Names assigned to available trigger slope choices. Indices must
71 * match the signal_edge enum values.
73 static const char *const signal_edge_names[] = { "r", "f" };
75 SR_PRIV struct sr_dev_driver sysclk_lwla_driver_info;
76 static struct sr_dev_driver *const di = &sysclk_lwla_driver_info;
78 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
80 return std_init(sr_ctx, di, LOG_PREFIX);
83 static struct sr_dev_inst *dev_inst_new(void)
85 struct sr_dev_inst *sdi;
86 struct dev_context *devc;
90 /* Allocate memory for our private driver context. */
91 devc = g_malloc0(sizeof(struct dev_context));
93 /* Register the device with libsigrok. */
94 sdi = g_malloc0(sizeof(struct sr_dev_inst));
95 sdi->status = SR_ST_INACTIVE;
96 sdi->vendor = g_strdup(VENDOR_NAME);
97 sdi->model = g_strdup(MODEL_NAME);
99 /* Enable all channels to match the default channel configuration. */
100 devc->channel_mask = ALL_CHANNELS_MASK;
101 devc->samplerate = DEFAULT_SAMPLERATE;
104 for (i = 0; i < NUM_CHANNELS; ++i) {
105 /* The LWLA series simply number channels from CH1 to CHxx. */
106 g_snprintf(name, sizeof(name), "CH%d", i + 1);
107 sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE, name);
113 static GSList *scan(struct sr_dev_driver *di, GSList *options)
115 GSList *usb_devices, *devices, *node;
116 struct drv_context *drvc;
117 struct sr_dev_inst *sdi;
118 struct sr_usb_dev_inst *usb;
119 struct sr_config *src;
125 for (node = options; node != NULL; node = node->next) {
127 if (src->key == SR_CONF_CONN) {
128 conn = g_variant_get_string(src->data, NULL);
132 usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
135 for (node = usb_devices; node != NULL; node = node->next) {
138 /* Create sigrok device instance. */
139 sdi = dev_inst_new();
141 sr_usb_dev_inst_free(usb);
145 sdi->inst_type = SR_INST_USB;
148 /* Register device instance with driver. */
149 drvc->instances = g_slist_append(drvc->instances, sdi);
150 devices = g_slist_append(devices, sdi);
153 g_slist_free(usb_devices);
158 static GSList *dev_list(const struct sr_dev_driver *di)
160 struct drv_context *drvc;
164 return drvc->instances;
167 static void clear_dev_context(void *priv)
169 struct dev_context *devc;
173 sr_dbg("Device context cleared.");
175 lwla_free_acquisition_state(devc->acquisition);
179 static int dev_clear(const struct sr_dev_driver *di)
181 return std_dev_clear(di, &clear_dev_context);
184 static int dev_open(struct sr_dev_inst *sdi)
186 struct drv_context *drvc;
187 struct sr_usb_dev_inst *usb;
193 sr_err("Driver was not initialized.");
196 if (sdi->status != SR_ST_INACTIVE) {
197 sr_err("Device already open.");
202 ret = sr_usb_open(drvc->sr_ctx->libusb_ctx, usb);
206 /* Set the configuration twice to trigger a lightweight reset.
208 ret = libusb_set_configuration(usb->devhdl, USB_CONFIG);
210 ret = libusb_set_configuration(usb->devhdl, USB_CONFIG);
212 sr_err("Failed to set USB configuration: %s.",
213 libusb_error_name(ret));
218 ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
220 sr_err("Failed to claim interface: %s.",
221 libusb_error_name(ret));
225 sdi->status = SR_ST_ACTIVE;
227 ret = lwla_init_device(sdi);
230 sdi->status = SR_ST_INACTIVE;
235 static int dev_close(struct sr_dev_inst *sdi)
237 struct sr_usb_dev_inst *usb;
238 struct dev_context *devc;
242 sr_err("Driver was not initialized.");
248 if (sdi->status == SR_ST_INACTIVE)
251 if (devc && devc->acquisition) {
252 sr_err("Attempt to close device during acquisition.");
255 sdi->status = SR_ST_INACTIVE;
257 /* Trigger download of the shutdown bitstream. */
258 ret = lwla_set_clock_config(sdi);
260 sr_err("Unable to shut down device.");
262 libusb_release_interface(usb->devhdl, USB_INTERFACE);
268 static int cleanup(const struct sr_dev_driver *di)
270 return dev_clear(di);
273 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
274 const struct sr_channel_group *cg)
276 struct dev_context *devc;
287 case SR_CONF_SAMPLERATE:
288 *data = g_variant_new_uint64(devc->samplerate);
290 case SR_CONF_LIMIT_MSEC:
291 *data = g_variant_new_uint64(devc->limit_msec);
293 case SR_CONF_LIMIT_SAMPLES:
294 *data = g_variant_new_uint64(devc->limit_samples);
296 case SR_CONF_EXTERNAL_CLOCK:
297 *data = g_variant_new_boolean(devc->cfg_clock_source
300 case SR_CONF_CLOCK_EDGE:
301 idx = devc->cfg_clock_edge;
302 if (idx >= ARRAY_SIZE(signal_edge_names))
304 *data = g_variant_new_string(signal_edge_names[idx]);
306 case SR_CONF_TRIGGER_SOURCE:
307 idx = devc->cfg_trigger_source;
308 if (idx >= ARRAY_SIZE(trigger_source_names))
310 *data = g_variant_new_string(trigger_source_names[idx]);
312 case SR_CONF_TRIGGER_SLOPE:
313 idx = devc->cfg_trigger_slope;
314 if (idx >= ARRAY_SIZE(signal_edge_names))
316 *data = g_variant_new_string(signal_edge_names[idx]);
325 /* Helper for mapping a string-typed configuration value to an index
326 * within a table of possible values.
328 static int lookup_index(GVariant *value, const char *const *table, int len)
333 entry = g_variant_get_string(value, NULL);
337 /* Linear search is fine for very small tables. */
338 for (i = 0; i < len; ++i) {
339 if (strcmp(entry, table[i]) == 0)
345 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
346 const struct sr_channel_group *cg)
349 struct dev_context *devc;
356 return SR_ERR_DEV_CLOSED;
359 case SR_CONF_SAMPLERATE:
360 value = g_variant_get_uint64(data);
361 if (value < samplerates[ARRAY_SIZE(samplerates) - 1]
362 || value > samplerates[0])
363 return SR_ERR_SAMPLERATE;
364 devc->samplerate = value;
366 case SR_CONF_LIMIT_MSEC:
367 value = g_variant_get_uint64(data);
368 if (value > MAX_LIMIT_MSEC)
370 devc->limit_msec = value;
372 case SR_CONF_LIMIT_SAMPLES:
373 value = g_variant_get_uint64(data);
374 if (value > MAX_LIMIT_SAMPLES)
376 devc->limit_samples = value;
378 case SR_CONF_EXTERNAL_CLOCK:
379 devc->cfg_clock_source = (g_variant_get_boolean(data))
380 ? CLOCK_EXT_CLK : CLOCK_INTERNAL;
382 case SR_CONF_CLOCK_EDGE:
383 idx = lookup_index(data, signal_edge_names,
384 ARRAY_SIZE(signal_edge_names));
387 devc->cfg_clock_edge = idx;
389 case SR_CONF_TRIGGER_SOURCE:
390 idx = lookup_index(data, trigger_source_names,
391 ARRAY_SIZE(trigger_source_names));
394 devc->cfg_trigger_source = idx;
396 case SR_CONF_TRIGGER_SLOPE:
397 idx = lookup_index(data, signal_edge_names,
398 ARRAY_SIZE(signal_edge_names));
401 devc->cfg_trigger_slope = idx;
410 static int config_channel_set(const struct sr_dev_inst *sdi,
411 struct sr_channel *ch, unsigned int changes)
413 uint64_t channel_bit;
414 struct dev_context *devc;
418 return SR_ERR_DEV_CLOSED;
420 if (ch->index < 0 || ch->index >= NUM_CHANNELS) {
421 sr_err("Channel index %d out of range.", ch->index);
424 channel_bit = (uint64_t)1 << ch->index;
426 if ((changes & SR_CHANNEL_SET_ENABLED) != 0) {
427 /* Enable or disable input channel for this channel. */
429 devc->channel_mask |= channel_bit;
431 devc->channel_mask &= ~channel_bit;
437 static int prepare_trigger_masks(const struct sr_dev_inst *sdi)
439 uint64_t trigger_mask;
440 uint64_t trigger_values;
441 uint64_t trigger_edge_mask;
442 uint64_t channel_bit;
443 struct dev_context *devc;
444 struct sr_trigger *trigger;
445 struct sr_trigger_stage *stage;
446 struct sr_trigger_match *match;
451 trigger = sr_session_trigger_get(sdi->session);
452 if (!trigger || !trigger->stages)
455 if (trigger->stages->next) {
456 sr_err("This device only supports 1 trigger stage.");
459 stage = trigger->stages->data;
463 trigger_edge_mask = 0;
465 for (node = stage->matches; node; node = node->next) {
468 if (!match->channel->enabled)
469 continue; /* ignore disabled channel */
471 channel_bit = (uint64_t)1 << match->channel->index;
472 trigger_mask |= channel_bit;
474 switch (match->match) {
475 case SR_TRIGGER_ZERO:
478 trigger_values |= channel_bit;
480 case SR_TRIGGER_RISING:
481 trigger_values |= channel_bit;
482 /* Fall through for edge mask. */
483 case SR_TRIGGER_FALLING:
484 trigger_edge_mask |= channel_bit;
487 sr_err("Unsupported trigger match for CH%d.",
488 match->channel->index + 1);
492 devc->trigger_mask = trigger_mask;
493 devc->trigger_values = trigger_values;
494 devc->trigger_edge_mask = trigger_edge_mask;
499 static int config_commit(const struct sr_dev_inst *sdi)
501 struct dev_context *devc;
504 if (sdi->status != SR_ST_ACTIVE)
505 return SR_ERR_DEV_CLOSED;
508 if (devc->acquisition) {
509 sr_err("Acquisition still in progress?");
512 rc = prepare_trigger_masks(sdi);
516 return lwla_set_clock_config(sdi);
519 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
520 const struct sr_channel_group *cg)
529 case SR_CONF_SCAN_OPTIONS:
530 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
531 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
533 case SR_CONF_DEVICE_OPTIONS:
534 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
535 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
537 case SR_CONF_SAMPLERATE:
538 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
539 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
540 samplerates, ARRAY_SIZE(samplerates),
542 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
543 *data = g_variant_builder_end(&gvb);
545 case SR_CONF_TRIGGER_MATCH:
546 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
547 trigger_matches, ARRAY_SIZE(trigger_matches),
550 case SR_CONF_TRIGGER_SOURCE:
551 *data = g_variant_new_strv(trigger_source_names,
552 ARRAY_SIZE(trigger_source_names));
554 case SR_CONF_TRIGGER_SLOPE:
555 case SR_CONF_CLOCK_EDGE:
556 *data = g_variant_new_strv(signal_edge_names,
557 ARRAY_SIZE(signal_edge_names));
566 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
568 struct drv_context *drvc;
569 struct dev_context *devc;
570 struct acquisition_state *acq;
575 if (sdi->status != SR_ST_ACTIVE)
576 return SR_ERR_DEV_CLOSED;
581 if (devc->acquisition) {
582 sr_err("Acquisition still in progress?");
585 acq = lwla_alloc_acquisition_state();
587 return SR_ERR_MALLOC;
589 devc->cancel_requested = FALSE;
590 devc->stopping_in_progress = FALSE;
591 devc->transfer_error = FALSE;
593 sr_info("Starting acquisition.");
595 devc->acquisition = acq;
596 ret = lwla_setup_acquisition(sdi);
598 sr_err("Failed to set up acquisition.");
599 devc->acquisition = NULL;
600 lwla_free_acquisition_state(acq);
604 ret = lwla_start_acquisition(sdi);
606 sr_err("Failed to start acquisition.");
607 devc->acquisition = NULL;
608 lwla_free_acquisition_state(acq);
611 usb_source_add(sdi->session, drvc->sr_ctx, 100, &lwla_receive_data,
612 (struct sr_dev_inst *)sdi);
614 sr_info("Waiting for data.");
616 /* Send header packet to the session bus. */
617 std_session_send_df_header(sdi, LOG_PREFIX);
622 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
624 struct dev_context *devc;
629 if (sdi->status != SR_ST_ACTIVE)
630 return SR_ERR_DEV_CLOSED;
632 if (devc->acquisition && !devc->cancel_requested) {
633 devc->cancel_requested = TRUE;
634 sr_dbg("Stopping acquisition.");
639 SR_PRIV struct sr_dev_driver sysclk_lwla_driver_info = {
640 .name = "sysclk-lwla",
641 .longname = "SysClk LWLA series",
646 .dev_list = dev_list,
647 .dev_clear = dev_clear,
648 .config_get = config_get,
649 .config_set = config_set,
650 .config_channel_set = config_channel_set,
651 .config_commit = config_commit,
652 .config_list = config_list,
653 .dev_open = dev_open,
654 .dev_close = dev_close,
655 .dev_acquisition_start = dev_acquisition_start,
656 .dev_acquisition_stop = dev_acquisition_stop,