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/>.
23 /* mostly stolen from src/hardware/saleae-logic16/ */
31 #include <libsigrok/libsigrok.h>
32 #include "libsigrok-internal.h"
35 static const uint32_t scanopts[] = {
39 static const uint32_t drvopts[] = {
40 SR_CONF_LOGIC_ANALYZER,
43 static const uint32_t devopts[] = {
44 /* TODO: SR_CONF_CONTINUOUS, */
45 SR_CONF_CONN | SR_CONF_GET,
46 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
47 SR_CONF_LIMIT_SAMPLES | SR_CONF_SET | SR_CONF_GET | SR_CONF_LIST,
48 SR_CONF_VOLTAGE_THRESHOLD | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
49 SR_CONF_LOGIC_THRESHOLD | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
50 SR_CONF_LOGIC_THRESHOLD_CUSTOM | SR_CONF_GET | SR_CONF_SET,
51 SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
52 SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
55 static const int32_t trigger_matches[] = {
62 static const char *channel_names[] = {
63 "0", "1", "2", "3", "4", "5", "6", "7", "8",
64 "9", "10", "11", "12", "13", "14", "15",
67 static const uint64_t samplerates[] = {
85 static const float logic_threshold_value[] = {
97 static const char *logic_threshold[] = {
110 #define MAX_NUM_LOGIC_THRESHOLD_ENTRIES ARRAY_SIZE(logic_threshold)
112 #define array_length(a) (sizeof(a) / sizeof((a)[0]))
114 static GSList *scan(struct sr_dev_driver *di, GSList *options)
116 struct drv_context *drvc;
117 struct dev_context *devc;
118 struct sr_dev_inst *sdi;
119 struct sr_usb_dev_inst *usb;
120 struct sr_config *src;
123 GSList *conn_devices;
124 struct libusb_device_descriptor des;
125 libusb_device **devlist;
128 char connection_id[64];
130 unsigned int dev_addr;
135 for (l = options; l; l = l->next) {
139 conn = g_variant_get_string(src->data, NULL);
144 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
148 /* Find all LA2016 devices and upload firmware to them. */
150 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
151 for (i = 0; devlist[i]; i++) {
154 for (l = conn_devices; l; l = l->next) {
156 if (usb->bus == libusb_get_bus_number(devlist[i])
157 && usb->address == libusb_get_device_address(devlist[i]))
161 /* This device matched none of the ones that
162 * matched the conn specification. */
166 libusb_get_device_descriptor(devlist[i], &des);
168 if (usb_get_port_path(devlist[i], connection_id, sizeof(connection_id)) < 0)
171 if (des.idVendor != LA2016_VID || des.idProduct != LA2016_PID)
174 /* Already has the firmware */
175 sr_dbg("Found a LA2016 device.");
176 sdi = g_malloc0(sizeof(struct sr_dev_inst));
177 sdi->status = SR_ST_INITIALIZING;
178 sdi->connection_id = g_strdup(connection_id);
181 dev_addr = libusb_get_device_address(devlist[i]);
182 if (des.iProduct != 2) {
183 sr_info("device at '%s' has no firmware loaded!", connection_id);
185 if (la2016_upload_firmware(drvc->sr_ctx, devlist[i], des.idProduct) != SR_OK) {
186 sr_err("uC firmware upload failed!");
187 g_free(sdi->connection_id);
191 fw_updated = g_get_monotonic_time();
192 dev_addr = 0xff; /* to mark that we don't know address yet... ugly */
195 sdi->vendor = g_strdup("Kingst");
196 sdi->model = g_strdup("LA2016");
198 for (j = 0; j < ARRAY_SIZE(channel_names); j++)
199 sr_channel_new(sdi, j, SR_CHANNEL_LOGIC, TRUE, channel_names[j]);
201 devices = g_slist_append(devices, sdi);
203 devc = g_malloc0(sizeof(struct dev_context));
205 devc->fw_updated = fw_updated;
206 devc->threshold_voltage_idx = 0;
207 devc->threshold_voltage = logic_threshold_value[devc->threshold_voltage_idx];
209 sdi->status = SR_ST_INACTIVE;
210 sdi->inst_type = SR_INST_USB;
212 sdi->conn = sr_usb_dev_inst_new(
213 libusb_get_bus_number(devlist[i]),
216 libusb_free_device_list(devlist, 1);
217 g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
219 return std_scan_complete(di, devices);
222 static int la2016_dev_open(struct sr_dev_inst *sdi)
224 struct sr_dev_driver *di;
225 libusb_device **devlist;
226 struct sr_usb_dev_inst *usb;
227 struct libusb_device_descriptor des;
228 struct drv_context *drvc;
229 int ret, i, device_count;
230 char connection_id[64];
237 device_count = libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
238 if (device_count < 0) {
239 sr_err("Failed to get device list: %s.", libusb_error_name(device_count));
243 for (i = 0; i < device_count; i++) {
244 libusb_get_device_descriptor(devlist[i], &des);
246 if (des.idVendor != LA2016_VID || des.idProduct != LA2016_PID || des.iProduct != 2)
249 if ((sdi->status == SR_ST_INITIALIZING) || (sdi->status == SR_ST_INACTIVE)) {
251 * Check device by its physical USB bus/port address.
253 if (usb_get_port_path(devlist[i], connection_id, sizeof(connection_id)) < 0)
256 if (strcmp(sdi->connection_id, connection_id))
257 /* This is not the one. */
261 if (!(ret = libusb_open(devlist[i], &usb->devhdl))) {
262 if (usb->address == 0xff)
264 * First time we touch this device after FW
265 * upload, so we don't know the address yet.
267 usb->address = libusb_get_device_address(devlist[i]);
269 sr_err("Failed to open device: %s.", libusb_error_name(ret));
274 ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
275 if (ret == LIBUSB_ERROR_BUSY) {
276 sr_err("Unable to claim USB interface. Another "
277 "program or driver has already claimed it.");
280 } else if (ret == LIBUSB_ERROR_NO_DEVICE) {
281 sr_err("Device has been disconnected.");
284 } else if (ret != 0) {
285 sr_err("Unable to claim interface: %s.", libusb_error_name(ret));
290 if ((ret = la2016_init_device(sdi)) != SR_OK) {
291 sr_err("Failed to init device.");
295 sr_info("Opened device on %d.%d (logical) / %s (physical), interface %d.",
296 usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
303 libusb_free_device_list(devlist, 1);
307 libusb_release_interface(usb->devhdl, USB_INTERFACE);
308 libusb_close(usb->devhdl);
317 static int dev_open(struct sr_dev_inst *sdi)
319 struct dev_context *devc;
320 int64_t timediff_us, timediff_ms;
328 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
329 * milliseconds for the FX2 to renumerate.
332 if (devc->fw_updated > 0) {
333 sr_info("Waiting for device to reset after firmware upload.");
334 /* Takes >= 2000ms for the uC to be gone from the USB bus. */
335 reset_done = devc->fw_updated + 18 * (uint64_t)1e5; /* 1.8 seconds */
336 now = g_get_monotonic_time();
337 if (reset_done > now)
338 g_usleep(reset_done - now);
340 while (timediff_ms < MAX_RENUM_DELAY_MS) {
341 g_usleep(200 * 1000);
343 timediff_us = g_get_monotonic_time() - devc->fw_updated;
344 timediff_ms = timediff_us / 1000;
346 if ((ret = la2016_dev_open(sdi)) == SR_OK)
348 sr_spew("Waited %" PRIi64 "ms.", timediff_ms);
351 sr_err("Device failed to re-enumerate.");
354 sr_info("Device came back after %" PRIi64 "ms.", timediff_ms);
356 ret = la2016_dev_open(sdi);
359 sr_err("Unable to open device.");
366 static int dev_close(struct sr_dev_inst *sdi)
368 struct sr_usb_dev_inst *usb;
375 la2016_deinit_device(sdi);
377 sr_info("Closing device on %d.%d (logical) / %s (physical) interface %d.",
378 usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
379 libusb_release_interface(usb->devhdl, USB_INTERFACE);
380 libusb_close(usb->devhdl);
386 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
388 struct dev_context *devc;
389 struct sr_usb_dev_inst *usb;
403 if (usb->address == 255)
404 /* Device still needs to re-enumerate after firmware
405 * upload, so we don't know its (future) address. */
407 *data = g_variant_new_printf("%d.%d", usb->bus, usb->address);
409 case SR_CONF_SAMPLERATE:
410 *data = g_variant_new_uint64(devc->cur_samplerate);
412 case SR_CONF_LIMIT_SAMPLES:
413 *data = g_variant_new_uint64(devc->limit_samples);
415 case SR_CONF_CAPTURE_RATIO:
416 *data = g_variant_new_uint64(devc->capture_ratio);
418 case SR_CONF_VOLTAGE_THRESHOLD:
419 rounded = (int)(devc->threshold_voltage / 0.1) * 0.1;
420 *data = std_gvar_tuple_double(rounded, rounded + 0.1);
422 case SR_CONF_LOGIC_THRESHOLD:
423 *data = g_variant_new_string(logic_threshold[devc->threshold_voltage_idx]);
425 case SR_CONF_LOGIC_THRESHOLD_CUSTOM:
426 *data = g_variant_new_double(devc->threshold_voltage);
436 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
438 struct dev_context *devc;
447 case SR_CONF_SAMPLERATE:
448 devc->cur_samplerate = g_variant_get_uint64(data);
450 case SR_CONF_LIMIT_SAMPLES:
451 devc->limit_samples = g_variant_get_uint64(data);
453 case SR_CONF_CAPTURE_RATIO:
454 devc->capture_ratio = g_variant_get_uint64(data);
456 case SR_CONF_VOLTAGE_THRESHOLD:
457 g_variant_get(data, "(dd)", &low, &high);
458 devc->threshold_voltage = (low + high) / 2.0;
459 devc->threshold_voltage_idx = MAX_NUM_LOGIC_THRESHOLD_ENTRIES - 1; /* USER */
461 case SR_CONF_LOGIC_THRESHOLD: {
462 if ((idx = std_str_idx(data, logic_threshold, MAX_NUM_LOGIC_THRESHOLD_ENTRIES)) < 0)
464 if (idx == MAX_NUM_LOGIC_THRESHOLD_ENTRIES - 1) {
467 devc->threshold_voltage = logic_threshold_value[idx];
469 devc->threshold_voltage_idx = idx;
472 case SR_CONF_LOGIC_THRESHOLD_CUSTOM:
473 devc->threshold_voltage = g_variant_get_double(data);
482 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
485 case SR_CONF_SCAN_OPTIONS:
486 case SR_CONF_DEVICE_OPTIONS:
487 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
488 case SR_CONF_SAMPLERATE:
489 *data = std_gvar_samplerates(ARRAY_AND_SIZE(samplerates));
491 case SR_CONF_LIMIT_SAMPLES:
492 *data = std_gvar_tuple_u64(LA2016_NUM_SAMPLES_MIN, LA2016_NUM_SAMPLES_MAX);
494 case SR_CONF_VOLTAGE_THRESHOLD:
495 *data = std_gvar_min_max_step_thresholds(
496 LA2016_THR_VOLTAGE_MIN,
497 LA2016_THR_VOLTAGE_MAX, 0.1);
499 case SR_CONF_TRIGGER_MATCH:
500 *data = std_gvar_array_i32(ARRAY_AND_SIZE(trigger_matches));
502 case SR_CONF_LOGIC_THRESHOLD:
503 *data = g_variant_new_strv(logic_threshold, MAX_NUM_LOGIC_THRESHOLD_ENTRIES);
512 static void send_chunk(struct sr_dev_inst *sdi, transfer_packet_t *packets, unsigned int num_tfers)
514 struct dev_context *devc;
515 struct sr_datafeed_logic logic;
516 struct sr_datafeed_packet sr_packet;
517 transfer_packet_t *packet;
519 unsigned int max_samples, n_samples, total_samples, free_n_samples, ptotal;
520 unsigned int i, j, k;
521 int do_signal_trigger;
527 logic.data = devc->convbuffer;
529 sr_packet.type = SR_DF_LOGIC;
530 sr_packet.payload = &logic;
532 max_samples = devc->convbuffer_size / 2;
534 wp = (uint16_t*)devc->convbuffer;
536 do_signal_trigger = 0;
538 if (devc->had_triggers_configured && devc->reading_behind_trigger == 0 && devc->info.n_rep_packets_before_trigger == 0) {
539 sr_packet.type = SR_DF_TRIGGER;
540 sr_packet.payload = NULL;
541 sr_session_send(sdi, &sr_packet);
542 devc->reading_behind_trigger = 1;
544 do_signal_trigger = 0;
545 sr_packet.type = SR_DF_LOGIC;
546 sr_packet.payload = &logic;
549 for (i = 0; i < num_tfers; i++) {
550 transfer_packet_host(packets[i]);
551 packet = packets + i;
553 for (k = 0; k < array_length(packet->packet); k++) {
554 free_n_samples = max_samples - n_samples;
555 if (free_n_samples < 256 || do_signal_trigger) {
556 logic.length = n_samples * 2;
557 sr_session_send(sdi, &sr_packet);
559 wp = (uint16_t*)devc->convbuffer;
560 if (do_signal_trigger) {
561 sr_packet.type = SR_DF_TRIGGER;
562 sr_packet.payload = NULL;
563 sr_session_send(sdi, &sr_packet);
565 do_signal_trigger = 0;
566 sr_packet.type = SR_DF_LOGIC;
567 sr_packet.payload = &logic;
570 p = packet->packet + k;
571 for (j = 0; j < p->repetitions; j++)
573 n_samples += p->repetitions;
574 total_samples += p->repetitions;
575 ptotal += p->repetitions;
576 devc->total_samples += p->repetitions;
577 if (!devc->reading_behind_trigger) {
578 devc->n_reps_until_trigger --;
579 if (devc->n_reps_until_trigger == 0) {
580 devc->reading_behind_trigger = 1;
581 do_signal_trigger = 1;
582 sr_dbg(" here is trigger position after %" PRIu64 " samples, %.6fms",
584 (double)devc->total_samples / devc->cur_samplerate * 1e3);
590 logic.length = n_samples * 2;
591 sr_session_send(sdi, &sr_packet);
592 if (do_signal_trigger) {
593 sr_packet.type = SR_DF_TRIGGER;
594 sr_packet.payload = NULL;
595 sr_session_send(sdi, &sr_packet);
598 sr_dbg("send_chunk done after %d samples", total_samples);
601 static void LIBUSB_CALL receive_transfer(struct libusb_transfer *transfer)
603 struct sr_dev_inst *sdi;
604 struct dev_context *devc;
605 struct sr_usb_dev_inst *usb;
608 sdi = transfer->user_data;
612 sr_dbg("receive_transfer(): status %s received %d bytes.",
613 libusb_error_name(transfer->status), transfer->actual_length);
615 if (transfer->status == LIBUSB_TRANSFER_TIMED_OUT) {
616 sr_err("bulk transfer timeout!");
617 devc->transfer_finished = 1;
619 send_chunk(sdi, (transfer_packet_t*)transfer->buffer, transfer->actual_length / sizeof(transfer_packet_t));
621 devc->n_bytes_to_read -= transfer->actual_length;
622 if (devc->n_bytes_to_read) {
623 uint32_t to_read = devc->n_bytes_to_read;
624 if (to_read > LA2016_BULK_MAX)
625 to_read = LA2016_BULK_MAX;
626 libusb_fill_bulk_transfer(
627 transfer, usb->devhdl,
628 0x86, transfer->buffer, to_read,
629 receive_transfer, (void*)sdi, DEFAULT_TIMEOUT_MS);
631 if ((ret = libusb_submit_transfer(transfer)) == 0)
633 sr_err("Failed to submit further transfer: %s.", libusb_error_name(ret));
636 g_free(transfer->buffer);
637 libusb_free_transfer(transfer);
638 devc->transfer_finished = 1;
641 static int handle_event(int fd, int revents, void *cb_data)
643 const struct sr_dev_inst *sdi;
644 struct dev_context *devc;
645 struct drv_context *drvc;
646 struct sr_datafeed_packet packet;
654 drvc = sdi->driver->context;
656 if (devc->have_trigger == 0) {
657 if (la2016_has_triggered(sdi) == 0) {
658 sr_dbg("not yet ready for download...");
661 devc->have_trigger = 1;
662 devc->transfer_finished = 0;
663 devc->reading_behind_trigger = 0;
664 devc->total_samples = 0;
665 /* we can start retrieving data! */
666 if (la2016_start_retrieval(sdi, receive_transfer) != SR_OK) {
667 sr_err("failed to start retrieval!");
670 sr_dbg("retrieval is started...");
671 packet.type = SR_DF_FRAME_BEGIN;
672 sr_session_send(sdi, &packet);
677 tv.tv_sec = tv.tv_usec = 0;
678 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
680 if (devc->transfer_finished) {
681 sr_dbg("transfer is finished!");
682 packet.type = SR_DF_FRAME_END;
683 sr_session_send(sdi, &packet);
685 usb_source_remove(sdi->session, drvc->sr_ctx);
686 std_session_send_df_end(sdi);
688 la2016_stop_acquisition(sdi);
690 g_free(devc->convbuffer);
691 devc->convbuffer = NULL;
693 sr_dbg("transfer is now finished");
699 static void abort_acquisition(struct dev_context *devc)
702 libusb_cancel_transfer(devc->transfer);
705 static int configure_channels(const struct sr_dev_inst *sdi)
707 struct dev_context *devc;
710 devc->cur_channels = 0;
711 devc->num_channels = 0;
713 for (GSList *l = sdi->channels; l; l = l->next) {
714 struct sr_channel *ch = (struct sr_channel*)l->data;
715 if (ch->enabled == FALSE)
717 devc->cur_channels |= 1 << (ch->index);
718 devc->num_channels++;
724 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
726 struct sr_dev_driver *di;
727 struct drv_context *drvc;
728 struct dev_context *devc;
735 if (configure_channels(sdi) != SR_OK) {
736 sr_err("Failed to configure channels.");
740 devc->convbuffer_size = 4 * 1024 * 1024;
741 if (!(devc->convbuffer = g_try_malloc(devc->convbuffer_size))) {
742 sr_err("Conversion buffer malloc failed.");
743 return SR_ERR_MALLOC;
746 if ((ret = la2016_setup_acquisition(sdi)) != SR_OK) {
747 g_free(devc->convbuffer);
748 devc->convbuffer = NULL;
752 devc->ctx = drvc->sr_ctx;
754 if ((ret = la2016_start_acquisition(sdi)) != SR_OK) {
755 abort_acquisition(devc);
759 devc->have_trigger = 0;
760 usb_source_add(sdi->session, drvc->sr_ctx, 50, handle_event, (void*)sdi);
762 std_session_send_df_header(sdi);
767 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
771 ret = la2016_abort_acquisition(sdi);
772 abort_acquisition(sdi->priv);
777 static struct sr_dev_driver kingst_la2016_driver_info = {
778 .name = "kingst-la2016",
779 .longname = "Kingst LA2016",
782 .cleanup = std_cleanup,
784 .dev_list = std_dev_list,
785 .dev_clear = std_dev_clear,
786 .config_get = config_get,
787 .config_set = config_set,
788 .config_list = config_list,
789 .dev_open = dev_open,
790 .dev_close = dev_close,
791 .dev_acquisition_start = dev_acquisition_start,
792 .dev_acquisition_stop = dev_acquisition_stop,
795 SR_REGISTER_DEV_DRIVER(kingst_la2016_driver_info);