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"
36 static const uint32_t scanopts[] = {
40 static const uint32_t drvopts[] = {
41 SR_CONF_LOGIC_ANALYZER,
44 static const uint32_t devopts[] = {
45 /* TODO: SR_CONF_CONTINUOUS, */
46 SR_CONF_CONN | SR_CONF_GET,
47 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
48 SR_CONF_LIMIT_SAMPLES | SR_CONF_SET | SR_CONF_GET | SR_CONF_LIST,
49 SR_CONF_VOLTAGE_THRESHOLD | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
50 SR_CONF_LOGIC_THRESHOLD | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
51 SR_CONF_LOGIC_THRESHOLD_CUSTOM | SR_CONF_GET | SR_CONF_SET,
52 SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
53 SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
56 static const int32_t trigger_matches[] = {
63 static const char *channel_names[] = {
64 "CH0", "CH1", "CH2", "CH3", "CH4", "CH5", "CH6", "CH7",
65 "CH8", "CH9", "CH10", "CH11", "CH12", "CH13", "CH14", "CH15",
69 * The hardware uses a (model dependent) 100/200/500MHz base clock and
70 * a 16bit divider (common across all models). The range from 10kHz to
71 * 100/200/500MHz should be applicable to all devices. High rates may
72 * suffer from coarse resolution (e.g. in the "500MHz div 2" case) and
73 * may not provide the desired 1/2/5 steps. This is not an issue now,
74 * the 500MHz model is not supported yet by this driver.
77 static const uint64_t samplerates_la2016[] = {
96 static const uint64_t samplerates_la1016[] = {
114 static const float logic_threshold_value[] = {
126 static const char *logic_threshold[] = {
139 #define LOGIC_THRESHOLD_IDX_USER (ARRAY_SIZE(logic_threshold) - 1)
141 static GSList *scan(struct sr_dev_driver *di, GSList *options)
143 struct drv_context *drvc;
144 struct sr_context *ctx;
145 struct dev_context *devc;
146 struct sr_dev_inst *sdi;
147 struct sr_usb_dev_inst *usb;
148 struct sr_config *src;
151 GSList *conn_devices;
152 struct libusb_device_descriptor des;
153 libusb_device **devlist, *dev;
154 size_t dev_count, dev_idx, ch_idx;
158 uint64_t fw_uploaded;
165 for (l = options; l; l = l->next) {
169 conn = g_variant_get_string(src->data, NULL);
174 conn_devices = sr_usb_find(ctx->libusb_ctx, conn);
178 /* Find all LA2016 devices, optionally upload firmware to them. */
180 ret = libusb_get_device_list(ctx->libusb_ctx, &devlist);
182 sr_err("Cannot get device list: %s.", libusb_error_name(ret));
186 for (dev_idx = 0; dev_idx < dev_count; dev_idx++) {
187 dev = devlist[dev_idx];
188 bus = libusb_get_bus_number(dev);
189 addr = libusb_get_device_address(dev);
192 for (l = conn_devices; l; l = l->next) {
194 if (usb->bus == bus && usb->address == addr)
199 * A connection parameter was specified and
200 * this device does not match the filter.
206 libusb_get_device_descriptor(dev, &des);
207 ret = usb_get_port_path(dev, conn_id, sizeof(conn_id));
210 if (des.idVendor != LA2016_VID || des.idProduct != LA2016_PID)
213 /* USB identification matches, a device was found. */
214 sr_dbg("Found a device (USB identification).");
215 sdi = g_malloc0(sizeof(*sdi));
216 sdi->status = SR_ST_INITIALIZING;
217 sdi->connection_id = g_strdup(conn_id);
220 if (des.iProduct != LA2016_IPRODUCT_INDEX) {
221 sr_info("Device at '%s' has no firmware loaded.",
224 ret = la2016_upload_firmware(ctx, dev, des.idProduct);
226 sr_err("MCU firmware upload failed.");
227 g_free(sdi->connection_id);
231 fw_uploaded = g_get_monotonic_time();
232 /* Will re-enumerate. Mark as "unknown address yet". */
236 sdi->vendor = g_strdup("Kingst");
237 sdi->model = g_strdup("LA2016");
239 for (ch_idx = 0; ch_idx < ARRAY_SIZE(channel_names); ch_idx++) {
240 sr_channel_new(sdi, ch_idx, SR_CHANNEL_LOGIC,
241 TRUE, channel_names[ch_idx]);
244 devices = g_slist_append(devices, sdi);
246 devc = g_malloc0(sizeof(*devc));
248 devc->fw_uploaded = fw_uploaded;
249 devc->threshold_voltage_idx = 0;
250 devc->threshold_voltage = logic_threshold_value[devc->threshold_voltage_idx];
252 sdi->status = SR_ST_INACTIVE;
253 sdi->inst_type = SR_INST_USB;
255 sdi->conn = sr_usb_dev_inst_new(bus, addr, NULL);
257 libusb_free_device_list(devlist, 1);
258 g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
260 return std_scan_complete(di, devices);
263 static int la2016_dev_open(struct sr_dev_inst *sdi)
265 struct sr_dev_driver *di;
266 struct drv_context *drvc;
267 struct sr_context *ctx;
268 libusb_device **devlist, *dev;
269 struct sr_usb_dev_inst *usb;
270 struct libusb_device_descriptor des;
272 size_t device_count, dev_idx;
282 ret = libusb_get_device_list(ctx->libusb_ctx, &devlist);
284 sr_err("Cannot get device list: %s.", libusb_error_name(ret));
289 sr_warn("Device list is empty. Cannot open.");
292 for (dev_idx = 0; dev_idx < device_count; dev_idx++) {
293 dev = devlist[dev_idx];
294 libusb_get_device_descriptor(dev, &des);
296 if (des.idVendor != LA2016_VID || des.idProduct != LA2016_PID)
298 if (des.iProduct != LA2016_IPRODUCT_INDEX)
301 check_conn = sdi->status == SR_ST_INITIALIZING;
302 check_conn |= sdi->status == SR_ST_INACTIVE;
304 /* Check physical USB bus/port address. */
305 ret = usb_get_port_path(dev, conn_id, sizeof(conn_id));
308 if (strcmp(sdi->connection_id, conn_id) != 0) {
309 /* Not the device we looked up before. */
314 ret = libusb_open(dev, &usb->devhdl);
316 sr_err("Cannot open device: %s.",
317 libusb_error_name(ret));
322 if (usb->address == 0xff) {
324 * First encounter after firmware upload.
325 * Grab current address after enumeration.
327 usb->address = libusb_get_device_address(dev);
330 ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
331 if (ret == LIBUSB_ERROR_BUSY) {
332 sr_err("Cannot claim USB interface. Another program or driver using it?");
335 } else if (ret == LIBUSB_ERROR_NO_DEVICE) {
336 sr_err("Device has been disconnected.");
339 } else if (ret != 0) {
340 sr_err("Cannot claim USB interface: %s.",
341 libusb_error_name(ret));
346 if ((ret = la2016_init_device(sdi)) != SR_OK) {
347 sr_err("Cannot initialize device.");
351 sr_info("Opened device on %d.%d (logical) / %s (physical), interface %d.",
352 usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
356 libusb_free_device_list(devlist, 1);
360 libusb_release_interface(usb->devhdl, USB_INTERFACE);
361 libusb_close(usb->devhdl);
370 static int dev_open(struct sr_dev_inst *sdi)
372 struct dev_context *devc;
373 uint64_t reset_done, now, elapsed_ms;
379 * When the sigrok driver recently has uploaded MCU firmware,
380 * then wait for the FX2 to re-enumerate. Allow the USB device
381 * to vanish before it reappears. Timeouts are rough estimates
382 * after all, the imprecise time of the last check (potentially
383 * executes after the total check period) simplifies code paths
384 * with optional diagnostics. And increases the probability of
385 * successfully detecting "late/slow" devices.
387 if (devc->fw_uploaded) {
388 sr_info("Waiting for device to reset after firmware upload.");
389 now = g_get_monotonic_time();
390 reset_done = devc->fw_uploaded + RENUM_GONE_DELAY_MS * 1000;
391 if (now < reset_done)
392 g_usleep(reset_done - now);
394 now = g_get_monotonic_time();
395 elapsed_ms = (now - devc->fw_uploaded) / 1000;
396 sr_spew("Waited %" PRIu64 "ms.", elapsed_ms);
397 ret = la2016_dev_open(sdi);
399 devc->fw_uploaded = 0;
402 g_usleep(RENUM_POLL_INTERVAL_MS * 1000);
403 } while (elapsed_ms < RENUM_CHECK_PERIOD_MS);
405 sr_err("Device failed to re-enumerate.");
408 sr_info("Device came back after %" PRIi64 "ms.", elapsed_ms);
410 ret = la2016_dev_open(sdi);
414 sr_err("Cannot open device.");
421 static int dev_close(struct sr_dev_inst *sdi)
423 struct sr_usb_dev_inst *usb;
430 la2016_deinit_device(sdi);
432 sr_info("Closing device on %d.%d (logical) / %s (physical) interface %d.",
433 usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
434 libusb_release_interface(usb->devhdl, USB_INTERFACE);
435 libusb_close(usb->devhdl);
441 static int config_get(uint32_t key, GVariant **data,
442 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
444 struct dev_context *devc;
445 struct sr_usb_dev_inst *usb;
460 if (usb->address == 0xff) {
462 * Device still needs to re-enumerate after firmware
463 * upload, so we don't know its (future) address.
467 *data = g_variant_new_printf("%d.%d", usb->bus, usb->address);
469 case SR_CONF_SAMPLERATE:
470 *data = g_variant_new_uint64(devc->cur_samplerate);
472 case SR_CONF_LIMIT_SAMPLES:
473 *data = g_variant_new_uint64(devc->limit_samples);
475 case SR_CONF_CAPTURE_RATIO:
476 *data = g_variant_new_uint64(devc->capture_ratio);
478 case SR_CONF_VOLTAGE_THRESHOLD:
479 rounded = (int)(devc->threshold_voltage / 0.1) * 0.1;
480 *data = std_gvar_tuple_double(rounded, rounded + 0.1);
482 case SR_CONF_LOGIC_THRESHOLD:
483 label = logic_threshold[devc->threshold_voltage_idx];
484 *data = g_variant_new_string(label);
486 case SR_CONF_LOGIC_THRESHOLD_CUSTOM:
487 *data = g_variant_new_double(devc->threshold_voltage);
497 static int config_set(uint32_t key, GVariant *data,
498 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
500 struct dev_context *devc;
509 case SR_CONF_SAMPLERATE:
510 devc->cur_samplerate = g_variant_get_uint64(data);
512 case SR_CONF_LIMIT_SAMPLES:
513 devc->limit_samples = g_variant_get_uint64(data);
515 case SR_CONF_CAPTURE_RATIO:
516 devc->capture_ratio = g_variant_get_uint64(data);
518 case SR_CONF_VOLTAGE_THRESHOLD:
519 g_variant_get(data, "(dd)", &low, &high);
520 devc->threshold_voltage = (low + high) / 2.0;
521 devc->threshold_voltage_idx = LOGIC_THRESHOLD_IDX_USER;
523 case SR_CONF_LOGIC_THRESHOLD: {
524 idx = std_str_idx(data, ARRAY_AND_SIZE(logic_threshold));
527 if (idx != LOGIC_THRESHOLD_IDX_USER) {
528 devc->threshold_voltage = logic_threshold_value[idx];
530 devc->threshold_voltage_idx = idx;
533 case SR_CONF_LOGIC_THRESHOLD_CUSTOM:
534 devc->threshold_voltage = g_variant_get_double(data);
543 static int config_list(uint32_t key, GVariant **data,
544 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
546 struct dev_context *devc;
549 case SR_CONF_SCAN_OPTIONS:
550 case SR_CONF_DEVICE_OPTIONS:
551 return STD_CONFIG_LIST(key, data, sdi, cg,
552 scanopts, drvopts, devopts);
553 case SR_CONF_SAMPLERATE:
557 if (devc->max_samplerate == SR_MHZ(200)) {
558 *data = std_gvar_samplerates(ARRAY_AND_SIZE(samplerates_la2016));
560 *data = std_gvar_samplerates(ARRAY_AND_SIZE(samplerates_la1016));
563 case SR_CONF_LIMIT_SAMPLES:
564 *data = std_gvar_tuple_u64(LA2016_NUM_SAMPLES_MIN,
565 LA2016_NUM_SAMPLES_MAX);
567 case SR_CONF_VOLTAGE_THRESHOLD:
568 *data = std_gvar_min_max_step_thresholds(
569 LA2016_THR_VOLTAGE_MIN,
570 LA2016_THR_VOLTAGE_MAX, 0.1);
572 case SR_CONF_TRIGGER_MATCH:
573 *data = std_gvar_array_i32(ARRAY_AND_SIZE(trigger_matches));
575 case SR_CONF_LOGIC_THRESHOLD:
576 *data = g_variant_new_strv(ARRAY_AND_SIZE(logic_threshold));
585 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
587 struct sr_dev_driver *di;
588 struct drv_context *drvc;
589 struct sr_context *ctx;
590 struct dev_context *devc;
598 devc->convbuffer_size = LA2016_CONVBUFFER_SIZE;
599 devc->convbuffer = g_try_malloc(devc->convbuffer_size);
600 if (!devc->convbuffer) {
601 sr_err("Cannot allocate conversion buffer.");
602 return SR_ERR_MALLOC;
605 ret = la2016_setup_acquisition(sdi);
607 g_free(devc->convbuffer);
608 devc->convbuffer = NULL;
612 ret = la2016_start_acquisition(sdi);
614 la2016_abort_acquisition(sdi);
615 g_free(devc->convbuffer);
616 devc->convbuffer = NULL;
620 devc->completion_seen = FALSE;
621 usb_source_add(sdi->session, ctx, 50,
622 la2016_receive_data, (void *)sdi);
624 std_session_send_df_header(sdi);
629 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
633 ret = la2016_abort_acquisition(sdi);
638 static struct sr_dev_driver kingst_la2016_driver_info = {
639 .name = "kingst-la2016",
640 .longname = "Kingst LA2016",
643 .cleanup = std_cleanup,
645 .dev_list = std_dev_list,
646 .dev_clear = std_dev_clear,
647 .config_get = config_get,
648 .config_set = config_set,
649 .config_list = config_list,
650 .dev_open = dev_open,
651 .dev_close = dev_close,
652 .dev_acquisition_start = dev_acquisition_start,
653 .dev_acquisition_stop = dev_acquisition_stop,
656 SR_REGISTER_DEV_DRIVER(kingst_la2016_driver_info);