2 * This file is part of the libsigrok project.
4 * Copyright (C) 2020 Florian Schmidt <schmidt_florian@gmx.de>
5 * Copyright (C) 2013 Marcus Comstedt <marcus@mc.pp.se>
6 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
7 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
9 * This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation, either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 * This driver implementation initially was derived from the
25 * src/hardware/saleae-logic16/ source code.
30 #include <libsigrok/libsigrok.h>
33 #include "libsigrok-internal.h"
37 * Default device configuration. Must be applicable to any of the
38 * supported devices (no model specific default values yet). Specific
39 * firmware implementation details unfortunately won't let us detect
40 * and keep using previously configured values.
42 #define LA2016_DFLT_SAMPLERATE SR_MHZ(100)
43 #define LA2016_DFLT_SAMPLEDEPTH (5 * 1000 * 1000)
44 #define LA2016_DFLT_CAPT_RATIO 5 /* Capture ratio, in percent. */
46 static const uint32_t scanopts[] = {
50 static const uint32_t drvopts[] = {
51 SR_CONF_LOGIC_ANALYZER,
54 static const uint32_t devopts[] = {
55 /* TODO: SR_CONF_CONTINUOUS, */
56 SR_CONF_CONN | SR_CONF_GET,
57 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
58 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
59 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
60 SR_CONF_VOLTAGE_THRESHOLD | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
61 SR_CONF_LOGIC_THRESHOLD | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
62 SR_CONF_LOGIC_THRESHOLD_CUSTOM | SR_CONF_GET | SR_CONF_SET,
63 SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
64 SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
67 static const int32_t trigger_matches[] = {
74 static const char *channel_names[] = {
75 "CH0", "CH1", "CH2", "CH3", "CH4", "CH5", "CH6", "CH7",
76 "CH8", "CH9", "CH10", "CH11", "CH12", "CH13", "CH14", "CH15",
80 * The hardware uses a (model dependent) 100/200/500MHz base clock and
81 * a 16bit divider (common across all models). The range from 10kHz to
82 * 100/200/500MHz should be applicable to all devices. High rates may
83 * suffer from coarse resolution (e.g. in the "500MHz div 2" case) and
84 * may not provide the desired 1/2/5 steps. This is not an issue now,
85 * the 500MHz model is not supported yet by this driver.
88 static const uint64_t samplerates_la2016[] = {
107 static const uint64_t samplerates_la1016[] = {
125 static const float logic_threshold_value[] = {
137 static const char *logic_threshold[] = {
150 #define LOGIC_THRESHOLD_IDX_USER (ARRAY_SIZE(logic_threshold) - 1)
152 static GSList *scan(struct sr_dev_driver *di, GSList *options)
154 struct drv_context *drvc;
155 struct sr_context *ctx;
156 struct dev_context *devc;
157 struct sr_dev_inst *sdi;
158 struct sr_usb_dev_inst *usb;
159 struct sr_config *src;
162 GSList *conn_devices;
163 struct libusb_device_descriptor des;
164 libusb_device **devlist, *dev;
165 size_t dev_count, dev_idx, ch_idx;
169 uint64_t fw_uploaded;
176 for (l = options; l; l = l->next) {
180 conn = g_variant_get_string(src->data, NULL);
185 conn_devices = sr_usb_find(ctx->libusb_ctx, conn);
189 /* Find all LA2016 devices, optionally upload firmware to them. */
191 ret = libusb_get_device_list(ctx->libusb_ctx, &devlist);
193 sr_err("Cannot get device list: %s.", libusb_error_name(ret));
197 for (dev_idx = 0; dev_idx < dev_count; dev_idx++) {
198 dev = devlist[dev_idx];
199 bus = libusb_get_bus_number(dev);
200 addr = libusb_get_device_address(dev);
203 for (l = conn_devices; l; l = l->next) {
205 if (usb->bus == bus && usb->address == addr)
210 * A connection parameter was specified and
211 * this device does not match the filter.
217 libusb_get_device_descriptor(dev, &des);
218 ret = usb_get_port_path(dev, conn_id, sizeof(conn_id));
221 if (des.idVendor != LA2016_VID || des.idProduct != LA2016_PID)
224 /* USB identification matches, a device was found. */
225 sr_dbg("Found a device (USB identification).");
226 sdi = g_malloc0(sizeof(*sdi));
227 sdi->status = SR_ST_INITIALIZING;
228 sdi->connection_id = g_strdup(conn_id);
231 if (des.iProduct != LA2016_IPRODUCT_INDEX) {
232 sr_info("Device at '%s' has no firmware loaded.",
235 ret = la2016_upload_firmware(ctx, dev, des.idProduct);
237 sr_err("MCU firmware upload failed.");
238 g_free(sdi->connection_id);
242 fw_uploaded = g_get_monotonic_time();
243 /* Will re-enumerate. Mark as "unknown address yet". */
247 sdi->vendor = g_strdup("Kingst");
248 sdi->model = g_strdup("LA2016");
250 for (ch_idx = 0; ch_idx < ARRAY_SIZE(channel_names); ch_idx++) {
251 sr_channel_new(sdi, ch_idx, SR_CHANNEL_LOGIC,
252 TRUE, channel_names[ch_idx]);
255 devices = g_slist_append(devices, sdi);
257 devc = g_malloc0(sizeof(*devc));
259 devc->fw_uploaded = fw_uploaded;
260 sr_sw_limits_init(&devc->sw_limits);
261 devc->sw_limits.limit_samples = LA2016_DFLT_SAMPLEDEPTH;
262 devc->capture_ratio = LA2016_DFLT_CAPT_RATIO;
263 devc->cur_samplerate = LA2016_DFLT_SAMPLERATE;
264 devc->threshold_voltage_idx = 0;
265 devc->threshold_voltage = logic_threshold_value[devc->threshold_voltage_idx];
267 sdi->status = SR_ST_INACTIVE;
268 sdi->inst_type = SR_INST_USB;
270 sdi->conn = sr_usb_dev_inst_new(bus, addr, NULL);
272 libusb_free_device_list(devlist, 1);
273 g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
275 return std_scan_complete(di, devices);
278 static int la2016_dev_open(struct sr_dev_inst *sdi)
280 struct sr_dev_driver *di;
281 struct drv_context *drvc;
282 struct sr_context *ctx;
283 libusb_device **devlist, *dev;
284 struct sr_usb_dev_inst *usb;
285 struct libusb_device_descriptor des;
287 size_t device_count, dev_idx;
297 ret = libusb_get_device_list(ctx->libusb_ctx, &devlist);
299 sr_err("Cannot get device list: %s.", libusb_error_name(ret));
304 sr_warn("Device list is empty. Cannot open.");
307 for (dev_idx = 0; dev_idx < device_count; dev_idx++) {
308 dev = devlist[dev_idx];
309 libusb_get_device_descriptor(dev, &des);
311 if (des.idVendor != LA2016_VID || des.idProduct != LA2016_PID)
313 if (des.iProduct != LA2016_IPRODUCT_INDEX)
316 check_conn = sdi->status == SR_ST_INITIALIZING;
317 check_conn |= sdi->status == SR_ST_INACTIVE;
319 /* Check physical USB bus/port address. */
320 ret = usb_get_port_path(dev, conn_id, sizeof(conn_id));
323 if (strcmp(sdi->connection_id, conn_id) != 0) {
324 /* Not the device we looked up before. */
329 ret = libusb_open(dev, &usb->devhdl);
331 sr_err("Cannot open device: %s.",
332 libusb_error_name(ret));
337 if (usb->address == 0xff) {
339 * First encounter after firmware upload.
340 * Grab current address after enumeration.
342 usb->address = libusb_get_device_address(dev);
345 ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
346 if (ret == LIBUSB_ERROR_BUSY) {
347 sr_err("Cannot claim USB interface. Another program or driver using it?");
350 } else if (ret == LIBUSB_ERROR_NO_DEVICE) {
351 sr_err("Device has been disconnected.");
354 } else if (ret != 0) {
355 sr_err("Cannot claim USB interface: %s.",
356 libusb_error_name(ret));
361 if ((ret = la2016_init_device(sdi)) != SR_OK) {
362 sr_err("Cannot initialize device.");
366 sr_info("Opened device on %d.%d (logical) / %s (physical), interface %d.",
367 usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
371 libusb_free_device_list(devlist, 1);
375 libusb_release_interface(usb->devhdl, USB_INTERFACE);
376 libusb_close(usb->devhdl);
385 static int dev_open(struct sr_dev_inst *sdi)
387 struct dev_context *devc;
388 uint64_t reset_done, now, elapsed_ms;
394 * When the sigrok driver recently has uploaded MCU firmware,
395 * then wait for the FX2 to re-enumerate. Allow the USB device
396 * to vanish before it reappears. Timeouts are rough estimates
397 * after all, the imprecise time of the last check (potentially
398 * executes after the total check period) simplifies code paths
399 * with optional diagnostics. And increases the probability of
400 * successfully detecting "late/slow" devices.
402 if (devc->fw_uploaded) {
403 sr_info("Waiting for device to reset after firmware upload.");
404 now = g_get_monotonic_time();
405 reset_done = devc->fw_uploaded + RENUM_GONE_DELAY_MS * 1000;
406 if (now < reset_done)
407 g_usleep(reset_done - now);
409 now = g_get_monotonic_time();
410 elapsed_ms = (now - devc->fw_uploaded) / 1000;
411 sr_spew("Waited %" PRIu64 "ms.", elapsed_ms);
412 ret = la2016_dev_open(sdi);
414 devc->fw_uploaded = 0;
417 g_usleep(RENUM_POLL_INTERVAL_MS * 1000);
418 } while (elapsed_ms < RENUM_CHECK_PERIOD_MS);
420 sr_err("Device failed to re-enumerate.");
423 sr_info("Device came back after %" PRIi64 "ms.", elapsed_ms);
425 ret = la2016_dev_open(sdi);
429 sr_err("Cannot open device.");
436 static int dev_close(struct sr_dev_inst *sdi)
438 struct sr_usb_dev_inst *usb;
445 la2016_deinit_device(sdi);
447 sr_info("Closing device on %d.%d (logical) / %s (physical) interface %d.",
448 usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
449 libusb_release_interface(usb->devhdl, USB_INTERFACE);
450 libusb_close(usb->devhdl);
456 static int config_get(uint32_t key, GVariant **data,
457 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
459 struct dev_context *devc;
460 struct sr_usb_dev_inst *usb;
475 if (usb->address == 0xff) {
477 * Device still needs to re-enumerate after firmware
478 * upload, so we don't know its (future) address.
482 *data = g_variant_new_printf("%d.%d", usb->bus, usb->address);
484 case SR_CONF_SAMPLERATE:
485 *data = g_variant_new_uint64(devc->cur_samplerate);
487 case SR_CONF_LIMIT_SAMPLES:
488 case SR_CONF_LIMIT_MSEC:
489 return sr_sw_limits_config_get(&devc->sw_limits, key, data);
490 case SR_CONF_CAPTURE_RATIO:
491 *data = g_variant_new_uint64(devc->capture_ratio);
493 case SR_CONF_VOLTAGE_THRESHOLD:
494 rounded = (int)(devc->threshold_voltage / 0.1) * 0.1;
495 *data = std_gvar_tuple_double(rounded, rounded + 0.1);
497 case SR_CONF_LOGIC_THRESHOLD:
498 label = logic_threshold[devc->threshold_voltage_idx];
499 *data = g_variant_new_string(label);
501 case SR_CONF_LOGIC_THRESHOLD_CUSTOM:
502 *data = g_variant_new_double(devc->threshold_voltage);
512 static int config_set(uint32_t key, GVariant *data,
513 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
515 struct dev_context *devc;
524 case SR_CONF_SAMPLERATE:
525 devc->cur_samplerate = g_variant_get_uint64(data);
527 case SR_CONF_LIMIT_SAMPLES:
528 case SR_CONF_LIMIT_MSEC:
529 return sr_sw_limits_config_set(&devc->sw_limits, key, data);
530 case SR_CONF_CAPTURE_RATIO:
531 devc->capture_ratio = g_variant_get_uint64(data);
533 case SR_CONF_VOLTAGE_THRESHOLD:
534 g_variant_get(data, "(dd)", &low, &high);
535 devc->threshold_voltage = (low + high) / 2.0;
536 devc->threshold_voltage_idx = LOGIC_THRESHOLD_IDX_USER;
538 case SR_CONF_LOGIC_THRESHOLD: {
539 idx = std_str_idx(data, ARRAY_AND_SIZE(logic_threshold));
542 if (idx != LOGIC_THRESHOLD_IDX_USER) {
543 devc->threshold_voltage = logic_threshold_value[idx];
545 devc->threshold_voltage_idx = idx;
548 case SR_CONF_LOGIC_THRESHOLD_CUSTOM:
549 devc->threshold_voltage = g_variant_get_double(data);
558 static int config_list(uint32_t key, GVariant **data,
559 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
561 struct dev_context *devc;
563 devc = sdi ? sdi->priv : NULL;
566 case SR_CONF_SCAN_OPTIONS:
567 case SR_CONF_DEVICE_OPTIONS:
568 return STD_CONFIG_LIST(key, data, sdi, cg,
569 scanopts, drvopts, devopts);
570 case SR_CONF_SAMPLERATE:
573 if (devc->max_samplerate == SR_MHZ(200)) {
574 *data = std_gvar_samplerates(ARRAY_AND_SIZE(samplerates_la2016));
576 *data = std_gvar_samplerates(ARRAY_AND_SIZE(samplerates_la1016));
579 case SR_CONF_LIMIT_SAMPLES:
580 *data = std_gvar_tuple_u64(LA2016_NUM_SAMPLES_MIN,
581 LA2016_NUM_SAMPLES_MAX);
583 case SR_CONF_VOLTAGE_THRESHOLD:
584 *data = std_gvar_min_max_step_thresholds(
585 LA2016_THR_VOLTAGE_MIN,
586 LA2016_THR_VOLTAGE_MAX, 0.1);
588 case SR_CONF_TRIGGER_MATCH:
589 *data = std_gvar_array_i32(ARRAY_AND_SIZE(trigger_matches));
591 case SR_CONF_LOGIC_THRESHOLD:
592 *data = g_variant_new_strv(ARRAY_AND_SIZE(logic_threshold));
601 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
603 struct sr_dev_driver *di;
604 struct drv_context *drvc;
605 struct sr_context *ctx;
606 struct dev_context *devc;
614 if (!devc->feed_queue) {
615 devc->feed_queue = feed_queue_logic_alloc(sdi,
616 LA2016_CONVBUFFER_SIZE, sizeof(uint16_t));
617 if (!devc->feed_queue) {
618 sr_err("Cannot allocate buffer for session feed.");
619 return SR_ERR_MALLOC;
623 sr_sw_limits_acquisition_start(&devc->sw_limits);
625 ret = la2016_setup_acquisition(sdi);
627 feed_queue_logic_free(devc->feed_queue);
628 devc->feed_queue = NULL;
632 ret = la2016_start_acquisition(sdi);
634 la2016_abort_acquisition(sdi);
635 feed_queue_logic_free(devc->feed_queue);
636 devc->feed_queue = NULL;
640 devc->completion_seen = FALSE;
641 usb_source_add(sdi->session, ctx, 50,
642 la2016_receive_data, (void *)sdi);
644 std_session_send_df_header(sdi);
649 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
653 ret = la2016_abort_acquisition(sdi);
658 static struct sr_dev_driver kingst_la2016_driver_info = {
659 .name = "kingst-la2016",
660 .longname = "Kingst LA2016",
663 .cleanup = std_cleanup,
665 .dev_list = std_dev_list,
666 .dev_clear = std_dev_clear,
667 .config_get = config_get,
668 .config_set = config_set,
669 .config_list = config_list,
670 .dev_open = dev_open,
671 .dev_close = dev_close,
672 .dev_acquisition_start = dev_acquisition_start,
673 .dev_acquisition_stop = dev_acquisition_stop,
676 SR_REGISTER_DEV_DRIVER(kingst_la2016_driver_info);