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/>.
21 #include "libsigrok.h"
22 #include "libsigrok-internal.h"
28 static const uint32_t scanopts[] = {
32 static const uint32_t devopts[] = {
33 SR_CONF_LOGIC_ANALYZER,
34 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
35 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
36 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
37 SR_CONF_EXTERNAL_CLOCK | SR_CONF_GET | SR_CONF_SET,
38 SR_CONF_CLOCK_EDGE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
39 SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
40 SR_CONF_TRIGGER_SOURCE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
41 SR_CONF_TRIGGER_SLOPE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
44 static const int32_t trigger_matches[] = {
51 /* The hardware supports more samplerates than these, but these are the
52 * options hardcoded into the vendor's Windows GUI.
54 static const uint64_t samplerates[] = {
55 SR_MHZ(125), SR_MHZ(100),
56 SR_MHZ(50), SR_MHZ(20), SR_MHZ(10),
57 SR_MHZ(5), SR_MHZ(2), SR_MHZ(1),
58 SR_KHZ(500), SR_KHZ(200), SR_KHZ(100),
59 SR_KHZ(50), SR_KHZ(20), SR_KHZ(10),
60 SR_KHZ(5), SR_KHZ(2), SR_KHZ(1),
61 SR_HZ(500), SR_HZ(200), SR_HZ(100),
64 /* Names assigned to available trigger sources. Indices must match
65 * trigger_source enum values.
67 static const char *const trigger_source_names[] = { "CH", "TRG" };
69 /* Names assigned to available trigger slope choices. Indices must
70 * match the signal_edge enum values.
72 static const char *const signal_edge_names[] = { "r", "f" };
74 SR_PRIV struct sr_dev_driver sysclk_lwla_driver_info;
75 static struct sr_dev_driver *const di = &sysclk_lwla_driver_info;
77 static int init(struct sr_context *sr_ctx)
79 return std_init(sr_ctx, di, LOG_PREFIX);
82 static GSList *gen_channel_list(int num_channels)
85 struct sr_channel *ch;
91 for (i = num_channels; i > 0; --i) {
92 /* The LWLA series simply number channels from CH1 to CHxx. */
93 g_snprintf(name, sizeof(name), "CH%d", i);
95 ch = sr_channel_new(i - 1, SR_CHANNEL_LOGIC, TRUE, name);
96 list = g_slist_prepend(list, ch);
102 static struct sr_dev_inst *dev_inst_new(void)
104 struct sr_dev_inst *sdi;
105 struct dev_context *devc;
107 /* Allocate memory for our private driver context. */
108 devc = g_try_new0(struct dev_context, 1);
110 sr_err("Device context malloc failed.");
114 /* Register the device with libsigrok. */
115 sdi = g_malloc0(sizeof(struct sr_dev_inst));
116 sdi->status = SR_ST_INACTIVE;
117 sdi->vendor = g_strdup(VENDOR_NAME);
118 sdi->model = g_strdup(MODEL_NAME);
120 /* Enable all channels to match the default channel configuration. */
121 devc->channel_mask = ALL_CHANNELS_MASK;
122 devc->samplerate = DEFAULT_SAMPLERATE;
125 sdi->channels = gen_channel_list(NUM_CHANNELS);
130 static GSList *scan(GSList *options)
132 GSList *usb_devices, *devices, *node;
133 struct drv_context *drvc;
134 struct sr_dev_inst *sdi;
135 struct sr_usb_dev_inst *usb;
136 struct sr_config *src;
142 for (node = options; node != NULL; node = node->next) {
144 if (src->key == SR_CONF_CONN) {
145 conn = g_variant_get_string(src->data, NULL);
149 usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
152 for (node = usb_devices; node != NULL; node = node->next) {
155 /* Create sigrok device instance. */
156 sdi = dev_inst_new();
158 sr_usb_dev_inst_free(usb);
162 sdi->inst_type = SR_INST_USB;
165 /* Register device instance with driver. */
166 drvc->instances = g_slist_append(drvc->instances, sdi);
167 devices = g_slist_append(devices, sdi);
170 g_slist_free(usb_devices);
175 static GSList *dev_list(void)
177 struct drv_context *drvc;
181 return drvc->instances;
184 static void clear_dev_context(void *priv)
186 struct dev_context *devc;
190 sr_dbg("Device context cleared.");
192 lwla_free_acquisition_state(devc->acquisition);
196 static int dev_clear(void)
198 return std_dev_clear(di, &clear_dev_context);
201 static int dev_open(struct sr_dev_inst *sdi)
203 struct drv_context *drvc;
204 struct sr_usb_dev_inst *usb;
210 sr_err("Driver was not initialized.");
216 ret = sr_usb_open(drvc->sr_ctx->libusb_ctx, usb);
220 ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
222 sr_err("Failed to claim interface: %s.",
223 libusb_error_name(ret));
227 sdi->status = SR_ST_INITIALIZING;
229 ret = lwla_init_device(sdi);
232 sdi->status = SR_ST_ACTIVE;
237 static int dev_close(struct sr_dev_inst *sdi)
239 struct sr_usb_dev_inst *usb;
242 sr_err("Driver was not initialized.");
250 sdi->status = SR_ST_INACTIVE;
252 /* Trigger download of the shutdown bitstream. */
253 if (lwla_set_clock_config(sdi) != SR_OK)
254 sr_err("Unable to shut down device.");
256 libusb_release_interface(usb->devhdl, USB_INTERFACE);
257 libusb_close(usb->devhdl);
264 static int cleanup(void)
269 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
270 const struct sr_channel_group *cg)
272 struct dev_context *devc;
283 case SR_CONF_SAMPLERATE:
284 *data = g_variant_new_uint64(devc->samplerate);
286 case SR_CONF_LIMIT_MSEC:
287 *data = g_variant_new_uint64(devc->limit_msec);
289 case SR_CONF_LIMIT_SAMPLES:
290 *data = g_variant_new_uint64(devc->limit_samples);
292 case SR_CONF_EXTERNAL_CLOCK:
293 *data = g_variant_new_boolean(devc->cfg_clock_source
296 case SR_CONF_CLOCK_EDGE:
297 idx = devc->cfg_clock_edge;
298 if (idx >= G_N_ELEMENTS(signal_edge_names))
300 *data = g_variant_new_string(signal_edge_names[idx]);
302 case SR_CONF_TRIGGER_SOURCE:
303 idx = devc->cfg_trigger_source;
304 if (idx >= G_N_ELEMENTS(trigger_source_names))
306 *data = g_variant_new_string(trigger_source_names[idx]);
308 case SR_CONF_TRIGGER_SLOPE:
309 idx = devc->cfg_trigger_slope;
310 if (idx >= G_N_ELEMENTS(signal_edge_names))
312 *data = g_variant_new_string(signal_edge_names[idx]);
321 /* Helper for mapping a string-typed configuration value to an index
322 * within a table of possible values.
324 static int lookup_index(GVariant *value, const char *const *table, int len)
329 entry = g_variant_get_string(value, NULL);
333 /* Linear search is fine for very small tables. */
334 for (i = 0; i < len; ++i) {
335 if (strcmp(entry, table[i]) == 0)
341 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
342 const struct sr_channel_group *cg)
345 struct dev_context *devc;
352 return SR_ERR_DEV_CLOSED;
355 case SR_CONF_SAMPLERATE:
356 value = g_variant_get_uint64(data);
357 if (value < samplerates[G_N_ELEMENTS(samplerates) - 1]
358 || value > samplerates[0])
359 return SR_ERR_SAMPLERATE;
360 devc->samplerate = value;
362 case SR_CONF_LIMIT_MSEC:
363 value = g_variant_get_uint64(data);
364 if (value > MAX_LIMIT_MSEC)
366 devc->limit_msec = value;
368 case SR_CONF_LIMIT_SAMPLES:
369 value = g_variant_get_uint64(data);
370 if (value > MAX_LIMIT_SAMPLES)
372 devc->limit_samples = value;
374 case SR_CONF_EXTERNAL_CLOCK:
375 devc->cfg_clock_source = (g_variant_get_boolean(data))
376 ? CLOCK_EXT_CLK : CLOCK_INTERNAL;
378 case SR_CONF_CLOCK_EDGE:
379 idx = lookup_index(data, signal_edge_names,
380 G_N_ELEMENTS(signal_edge_names));
383 devc->cfg_clock_edge = idx;
385 case SR_CONF_TRIGGER_SOURCE:
386 idx = lookup_index(data, trigger_source_names,
387 G_N_ELEMENTS(trigger_source_names));
390 devc->cfg_trigger_source = idx;
392 case SR_CONF_TRIGGER_SLOPE:
393 idx = lookup_index(data, signal_edge_names,
394 G_N_ELEMENTS(signal_edge_names));
397 devc->cfg_trigger_slope = idx;
406 static int config_channel_set(const struct sr_dev_inst *sdi,
407 struct sr_channel *ch, unsigned int changes)
409 uint64_t channel_bit;
410 struct dev_context *devc;
414 return SR_ERR_DEV_CLOSED;
416 if (ch->index < 0 || ch->index >= NUM_CHANNELS) {
417 sr_err("Channel index %d out of range.", ch->index);
420 channel_bit = (uint64_t)1 << ch->index;
422 if ((changes & SR_CHANNEL_SET_ENABLED) != 0) {
423 /* Enable or disable input channel for this channel. */
425 devc->channel_mask |= channel_bit;
427 devc->channel_mask &= ~channel_bit;
433 static int config_commit(const struct sr_dev_inst *sdi)
435 if (sdi->status != SR_ST_ACTIVE) {
436 sr_err("Device not ready (status %d).", (int)sdi->status);
440 return lwla_set_clock_config(sdi);
443 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
444 const struct sr_channel_group *cg)
453 case SR_CONF_SCAN_OPTIONS:
454 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
455 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
457 case SR_CONF_DEVICE_OPTIONS:
458 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
459 devopts, G_N_ELEMENTS(devopts), sizeof(uint32_t));
461 case SR_CONF_SAMPLERATE:
462 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
463 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
464 samplerates, G_N_ELEMENTS(samplerates),
466 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
467 *data = g_variant_builder_end(&gvb);
469 case SR_CONF_TRIGGER_MATCH:
470 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
471 trigger_matches, ARRAY_SIZE(trigger_matches),
474 case SR_CONF_TRIGGER_SOURCE:
475 *data = g_variant_new_strv(trigger_source_names,
476 G_N_ELEMENTS(trigger_source_names));
478 case SR_CONF_TRIGGER_SLOPE:
479 case SR_CONF_CLOCK_EDGE:
480 *data = g_variant_new_strv(signal_edge_names,
481 G_N_ELEMENTS(signal_edge_names));
490 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
492 struct drv_context *drvc;
493 struct dev_context *devc;
494 struct acquisition_state *acq;
499 if (sdi->status != SR_ST_ACTIVE)
500 return SR_ERR_DEV_CLOSED;
505 if (devc->acquisition) {
506 sr_err("Acquisition still in progress?");
509 acq = lwla_alloc_acquisition_state();
511 return SR_ERR_MALLOC;
513 devc->stopping_in_progress = FALSE;
514 devc->transfer_error = FALSE;
516 sr_info("Starting acquisition.");
518 devc->acquisition = acq;
519 lwla_convert_trigger(sdi);
520 ret = lwla_setup_acquisition(sdi);
522 sr_err("Failed to set up acquisition.");
523 devc->acquisition = NULL;
524 lwla_free_acquisition_state(acq);
528 ret = lwla_start_acquisition(sdi);
530 sr_err("Failed to start acquisition.");
531 devc->acquisition = NULL;
532 lwla_free_acquisition_state(acq);
535 usb_source_add(sdi->session, drvc->sr_ctx, 100, &lwla_receive_data,
536 (struct sr_dev_inst *)sdi);
538 sr_info("Waiting for data.");
540 /* Send header packet to the session bus. */
541 std_session_send_df_header(sdi, LOG_PREFIX);
546 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
550 if (sdi->status != SR_ST_ACTIVE)
551 return SR_ERR_DEV_CLOSED;
553 sr_dbg("Stopping acquisition.");
555 sdi->status = SR_ST_STOPPING;
560 SR_PRIV struct sr_dev_driver sysclk_lwla_driver_info = {
561 .name = "sysclk-lwla",
562 .longname = "SysClk LWLA series",
567 .dev_list = dev_list,
568 .dev_clear = dev_clear,
569 .config_get = config_get,
570 .config_set = config_set,
571 .config_channel_set = config_channel_set,
572 .config_commit = config_commit,
573 .config_list = config_list,
574 .dev_open = dev_open,
575 .dev_close = dev_close,
576 .dev_acquisition_start = dev_acquisition_start,
577 .dev_acquisition_stop = dev_acquisition_stop,