2 * This file is part of the libsigrok project.
4 * Copyright (C) 2015 Christer Ekholm <christerekholm@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/>.
23 /* Max time in ms before we want to check on USB events */
26 #define RANGE(ch) (((float)vdivs[devc->voltage[ch]][0] / vdivs[devc->voltage[ch]][1]) * VDIV_MULTIPLIER)
28 static const uint32_t scanopts[] = {
32 static const uint32_t drvopts[] = {
36 static const uint32_t devopts[] = {
37 SR_CONF_CONN | SR_CONF_GET,
38 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
39 SR_CONF_NUM_VDIV | SR_CONF_GET,
40 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
41 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
44 static const uint32_t devopts_cg[] = {
45 SR_CONF_VDIV | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
46 SR_CONF_COUPLING | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
49 static const char *channel_names[] = {
53 static const char *coupling[] = {
57 static const struct hantek_6xxx_profile dev_profiles[] = {
59 0x04b4, 0x6022, 0x04b5, 0x6022,
60 "Hantek", "6022BE", "hantek-6022be.fw",
63 0x8102, 0x8102, 0x1D50, 0x608E,
64 "Sainsmart", "DDS120", "sainsmart-dds120.fw",
69 static const uint64_t samplerates[] = {
73 static const uint64_t vdivs[][2] = {
77 SR_PRIV struct sr_dev_driver hantek_6xxx_driver_info;
79 static int read_channel(const struct sr_dev_inst *sdi, uint32_t amount);
81 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data);
83 static struct sr_dev_inst *hantek_6xxx_dev_new(const struct hantek_6xxx_profile *prof)
85 struct sr_dev_inst *sdi;
86 struct sr_channel *ch;
87 struct sr_channel_group *cg;
88 struct drv_context *drvc;
89 struct dev_context *devc;
92 sdi = g_malloc0(sizeof(struct sr_dev_inst));
93 sdi->status = SR_ST_INITIALIZING;
94 sdi->vendor = g_strdup(prof->vendor);
95 sdi->model = g_strdup(prof->model);
96 sdi->driver = &hantek_6xxx_driver_info;
98 for (i = 0; i < ARRAY_SIZE(channel_names); i++) {
99 ch = sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, TRUE, channel_names[i]);
100 cg = g_malloc0(sizeof(struct sr_channel_group));
101 cg->name = g_strdup(channel_names[i]);
102 cg->channels = g_slist_append(cg->channels, ch);
103 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
106 devc = g_malloc0(sizeof(struct dev_context));
108 for (i = 0; i < NUM_CHANNELS; i++) {
109 devc->ch_enabled[i] = TRUE;
110 devc->voltage[i] = DEFAULT_VOLTAGE;
111 devc->coupling[i] = DEFAULT_COUPLING;
114 devc->sample_buf = NULL;
115 devc->sample_buf_write = 0;
116 devc->sample_buf_size = 0;
118 devc->profile = prof;
119 devc->dev_state = IDLE;
120 devc->samplerate = DEFAULT_SAMPLERATE;
123 drvc = sdi->driver->context;
124 drvc->instances = g_slist_append(drvc->instances, sdi);
129 static int configure_channels(const struct sr_dev_inst *sdi)
131 struct dev_context *devc;
134 struct sr_channel *ch;
137 g_slist_free(devc->enabled_channels);
138 devc->enabled_channels = NULL;
139 memset(devc->ch_enabled, 0, sizeof(devc->ch_enabled));
141 for (l = sdi->channels, p = 0; l; l = l->next, p++) {
143 if (p < NUM_CHANNELS) {
144 devc->ch_enabled[p] = ch->enabled;
145 devc->enabled_channels = g_slist_append(devc->enabled_channels, ch);
152 static void clear_dev_context(void *priv)
154 struct dev_context *devc;
157 g_slist_free(devc->enabled_channels);
161 static int dev_clear(const struct sr_dev_driver *di)
163 return std_dev_clear(di, clear_dev_context);
166 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
168 return std_init(sr_ctx, di, LOG_PREFIX);
171 static GSList *scan(struct sr_dev_driver *di, GSList *options)
173 struct drv_context *drvc;
174 struct dev_context *devc;
175 struct sr_dev_inst *sdi;
176 struct sr_usb_dev_inst *usb;
177 struct sr_config *src;
178 const struct hantek_6xxx_profile *prof;
179 GSList *l, *devices, *conn_devices;
180 struct libusb_device_descriptor des;
181 libusb_device **devlist;
184 char connection_id[64];
191 for (l = options; l; l = l->next) {
193 if (src->key == SR_CONF_CONN) {
194 conn = g_variant_get_string(src->data, NULL);
199 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
203 /* Find all Hantek 60xx devices and upload firmware to all of them. */
204 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
205 for (i = 0; devlist[i]; i++) {
208 for (l = conn_devices; l; l = l->next) {
210 if (usb->bus == libusb_get_bus_number(devlist[i])
211 && usb->address == libusb_get_device_address(devlist[i]))
215 /* This device matched none of the ones that
216 * matched the conn specification. */
220 libusb_get_device_descriptor(devlist[i], &des);
222 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
225 for (j = 0; j < (int)ARRAY_SIZE(dev_profiles); j++) {
226 if (des.idVendor == dev_profiles[j].orig_vid
227 && des.idProduct == dev_profiles[j].orig_pid) {
228 /* Device matches the pre-firmware profile. */
229 prof = &dev_profiles[j];
230 sr_dbg("Found a %s %s.", prof->vendor, prof->model);
231 sdi = hantek_6xxx_dev_new(prof);
232 sdi->connection_id = g_strdup(connection_id);
233 devices = g_slist_append(devices, sdi);
235 if (ezusb_upload_firmware(drvc->sr_ctx, devlist[i],
236 USB_CONFIGURATION, prof->firmware) == SR_OK)
237 /* Remember when the firmware on this device was updated. */
238 devc->fw_updated = g_get_monotonic_time();
240 sr_err("Firmware upload failed.");
241 /* Dummy USB address of 0xff will get overwritten later. */
242 sdi->conn = sr_usb_dev_inst_new(
243 libusb_get_bus_number(devlist[i]), 0xff, NULL);
245 } else if (des.idVendor == dev_profiles[j].fw_vid
246 && des.idProduct == dev_profiles[j].fw_pid) {
247 /* Device matches the post-firmware profile. */
248 prof = &dev_profiles[j];
249 sr_dbg("Found a %s %s.", prof->vendor, prof->model);
250 sdi = hantek_6xxx_dev_new(prof);
251 sdi->connection_id = g_strdup(connection_id);
252 sdi->status = SR_ST_INACTIVE;
253 devices = g_slist_append(devices, sdi);
254 sdi->inst_type = SR_INST_USB;
255 sdi->conn = sr_usb_dev_inst_new(
256 libusb_get_bus_number(devlist[i]),
257 libusb_get_device_address(devlist[i]), NULL);
262 /* Not a supported VID/PID. */
265 libusb_free_device_list(devlist, 1);
270 static GSList *dev_list(const struct sr_dev_driver *di)
272 return ((struct drv_context *)(di->context))->instances;
275 static int dev_open(struct sr_dev_inst *sdi)
277 struct dev_context *devc;
278 struct sr_usb_dev_inst *usb;
279 int64_t timediff_us, timediff_ms;
286 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
287 * for the FX2 to renumerate.
290 if (devc->fw_updated > 0) {
291 sr_info("Waiting for device to reset.");
292 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
293 g_usleep(300 * 1000);
295 while (timediff_ms < MAX_RENUM_DELAY_MS) {
296 if ((err = hantek_6xxx_open(sdi)) == SR_OK)
298 g_usleep(100 * 1000);
299 timediff_us = g_get_monotonic_time() - devc->fw_updated;
300 timediff_ms = timediff_us / 1000;
301 sr_spew("Waited %" PRIi64 " ms.", timediff_ms);
303 if (timediff_ms < MAX_RENUM_DELAY_MS)
304 sr_info("Device came back after %"PRIu64" ms.", timediff_ms);
306 err = hantek_6xxx_open(sdi);
310 sr_err("Unable to open device.");
314 err = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
316 sr_err("Unable to claim interface: %s.",
317 libusb_error_name(err));
324 static int dev_close(struct sr_dev_inst *sdi)
326 hantek_6xxx_close(sdi);
331 static int cleanup(const struct sr_dev_driver *di)
333 return dev_clear(di);
336 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
337 const struct sr_channel_group *cg)
339 struct dev_context *devc;
340 struct sr_usb_dev_inst *usb;
342 const uint64_t *vdiv;
346 case SR_CONF_NUM_VDIV:
347 *data = g_variant_new_int32(ARRAY_SIZE(vdivs));
357 case SR_CONF_SAMPLERATE:
358 *data = g_variant_new_uint64(devc->samplerate);
360 case SR_CONF_LIMIT_MSEC:
361 *data = g_variant_new_uint64(devc->limit_msec);
363 case SR_CONF_LIMIT_SAMPLES:
364 *data = g_variant_new_uint64(devc->limit_samples);
370 if (usb->address == 255)
371 /* Device still needs to re-enumerate after firmware
372 * upload, so we don't know its (future) address. */
374 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
375 *data = g_variant_new_string(str);
381 if (sdi->channel_groups->data == cg)
383 else if (sdi->channel_groups->next->data == cg)
389 vdiv = vdivs[devc->voltage[ch_idx]];
390 *data = g_variant_new("(tt)", vdiv[0], vdiv[1]);
392 case SR_CONF_COUPLING:
393 *data = g_variant_new_string(coupling[devc->coupling[ch_idx]]);
401 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
402 const struct sr_channel_group *cg)
404 struct dev_context *devc;
406 int tmp_int, ch_idx, ret;
410 if (sdi->status != SR_ST_ACTIVE)
411 return SR_ERR_DEV_CLOSED;
417 case SR_CONF_SAMPLERATE:
418 devc->samplerate = g_variant_get_uint64(data);
419 hantek_6xxx_update_samplerate(sdi);
421 case SR_CONF_LIMIT_MSEC:
422 devc->limit_msec = g_variant_get_uint64(data);
424 case SR_CONF_LIMIT_SAMPLES:
425 devc->limit_samples = g_variant_get_uint64(data);
432 if (sdi->channel_groups->data == cg)
434 else if (sdi->channel_groups->next->data == cg)
440 g_variant_get(data, "(tt)", &p, &q);
442 for (i = 0; i < ARRAY_SIZE(vdivs); i++) {
443 if (vdivs[i][0] == p && vdivs[i][1] == q) {
449 devc->voltage[ch_idx] = tmp_int;
450 hantek_6xxx_update_vdiv(sdi);
454 case SR_CONF_COUPLING:
455 tmp_str = g_variant_get_string(data, NULL);
456 for (i = 0; coupling[i]; i++) {
457 if (!strcmp(tmp_str, coupling[i])) {
458 devc->coupling[ch_idx] = i;
462 if (coupling[i] == 0)
474 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
475 const struct sr_channel_group *cg)
477 GVariant *tuple, *rational[2];
482 if (key == SR_CONF_SCAN_OPTIONS) {
483 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
484 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
486 } else if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
487 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
488 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
497 case SR_CONF_DEVICE_OPTIONS:
498 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
499 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
501 case SR_CONF_SAMPLERATE:
502 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
503 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
504 samplerates, ARRAY_SIZE(samplerates),
506 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
507 *data = g_variant_builder_end(&gvb);
514 case SR_CONF_DEVICE_OPTIONS:
515 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
516 devopts_cg, ARRAY_SIZE(devopts_cg), sizeof(uint32_t));
518 case SR_CONF_COUPLING:
519 *data = g_variant_new_strv(coupling, ARRAY_SIZE(coupling));
522 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
523 for (i = 0; i < ARRAY_SIZE(vdivs); i++) {
524 rational[0] = g_variant_new_uint64(vdivs[i][0]);
525 rational[1] = g_variant_new_uint64(vdivs[i][1]);
526 tuple = g_variant_new_tuple(rational, 2);
527 g_variant_builder_add_value(&gvb, tuple);
529 *data = g_variant_builder_end(&gvb);
539 /* Minimise data amount for limit_samples and limit_msec limits. */
540 static uint32_t data_amount(const struct sr_dev_inst *sdi)
542 struct dev_context *devc = sdi->priv;
546 if (devc->limit_msec) {
547 time_left = devc->limit_msec - (g_get_monotonic_time() - devc->aq_started) / 1000;
548 data_left = devc->samplerate * MAX(time_left, 0) * NUM_CHANNELS / 1000;
549 } else if (devc->limit_samples) {
550 data_left = (devc->limit_samples - devc->samp_received) * NUM_CHANNELS;
552 data_left = devc->samplerate * NUM_CHANNELS;
555 data_left += MIN_PACKET_SIZE; /* Driver does not handle small buffers. */
557 sr_spew("data_amount %u", data_left);
562 static void send_chunk(struct sr_dev_inst *sdi, unsigned char *buf,
565 struct sr_datafeed_packet packet;
566 struct sr_datafeed_analog_old analog;
567 struct dev_context *devc = sdi->priv;
568 int num_channels, data_offset, i;
570 const float ch1_bit = RANGE(0) / 255;
571 const float ch2_bit = RANGE(1) / 255;
572 const float ch1_center = RANGE(0) / 2;
573 const float ch2_center = RANGE(1) / 2;
575 const gboolean ch1_ena = !!devc->ch_enabled[0];
576 const gboolean ch2_ena = !!devc->ch_enabled[1];
578 num_channels = (ch1_ena && ch2_ena) ? 2 : 1;
579 packet.type = SR_DF_ANALOG_OLD;
580 packet.payload = &analog;
582 analog.channels = devc->enabled_channels;
583 analog.num_samples = num_samples;
584 analog.mq = SR_MQ_VOLTAGE;
585 analog.unit = SR_UNIT_VOLT;
588 analog.data = g_try_malloc(analog.num_samples * sizeof(float) * num_channels);
590 sr_err("Analog data buffer malloc failed.");
591 devc->dev_state = STOPPING;
596 for (i = 0; i < num_samples; i++) {
598 * The device always sends data for both channels. If a channel
599 * is disabled, it contains a copy of the enabled channel's
600 * data. However, we only send the requested channels to
603 * Voltage values are encoded as a value 0-255, where the
604 * value is a point in the range represented by the vdiv
605 * setting. There are 10 vertical divs, so e.g. 500mV/div
606 * represents 5V peak-to-peak where 0 = -2.5V and 255 = +2.5V.
609 analog.data[data_offset++] = (ch1_bit * *(buf + i * 2) - ch1_center);
611 analog.data[data_offset++] = (ch2_bit * *(buf + i * 2 + 1) - ch2_center);
614 sr_session_send(devc->cb_data, &packet);
618 static void send_data(struct sr_dev_inst *sdi, struct libusb_transfer *buf[], uint64_t samples)
624 while (send < samples) {
625 chunk = MIN(samples - send, (uint64_t)(buf[i]->actual_length / NUM_CHANNELS));
627 send_chunk(sdi, buf[i]->buffer, chunk);
630 * Everything in this transfer was either copied to the buffer
631 * or sent to the session bus.
633 g_free(buf[i]->buffer);
634 libusb_free_transfer(buf[i]);
640 * Called by libusb (as triggered by handle_event()) when a transfer comes in.
641 * Only channel data comes in asynchronously, and all transfers for this are
642 * queued up beforehand, so this just needs to chuck the incoming data onto
643 * the libsigrok session bus.
645 static void LIBUSB_CALL receive_transfer(struct libusb_transfer *transfer)
647 struct sr_dev_inst *sdi;
648 struct dev_context *devc;
650 sdi = transfer->user_data;
653 if (devc->dev_state == FLUSH) {
654 g_free(transfer->buffer);
655 libusb_free_transfer(transfer);
656 devc->dev_state = CAPTURE;
657 devc->aq_started = g_get_monotonic_time();
658 read_channel(sdi, data_amount(sdi));
662 if (devc->dev_state != CAPTURE)
665 if (!devc->sample_buf) {
666 devc->sample_buf_size = 10;
667 devc->sample_buf = g_try_malloc(devc->sample_buf_size * sizeof(transfer));
668 devc->sample_buf_write = 0;
671 if (devc->sample_buf_write >= devc->sample_buf_size) {
672 devc->sample_buf_size += 10;
673 devc->sample_buf = g_try_realloc(devc->sample_buf,
674 devc->sample_buf_size * sizeof(transfer));
675 if (!devc->sample_buf) {
676 sr_err("Sample buffer malloc failed.");
677 devc->dev_state = STOPPING;
682 devc->sample_buf[devc->sample_buf_write++] = transfer;
683 devc->samp_received += transfer->actual_length / NUM_CHANNELS;
685 sr_spew("receive_transfer(): calculated samplerate == %" PRIu64 "ks/s",
686 (uint64_t)(transfer->actual_length * 1000 /
687 (g_get_monotonic_time() - devc->read_start_ts + 1) /
690 sr_spew("receive_transfer(): status %s received %d bytes.",
691 libusb_error_name(transfer->status), transfer->actual_length);
693 if (transfer->actual_length == 0)
694 /* Nothing to send to the bus. */
697 if (devc->limit_samples && devc->samp_received >= devc->limit_samples) {
698 sr_info("Requested number of samples reached, stopping. %"
699 PRIu64 " <= %" PRIu64, devc->limit_samples,
700 devc->samp_received);
701 send_data(sdi, devc->sample_buf, devc->limit_samples);
702 sdi->driver->dev_acquisition_stop(sdi, NULL);
703 } else if (devc->limit_msec && (g_get_monotonic_time() -
704 devc->aq_started) / 1000 >= devc->limit_msec) {
705 sr_info("Requested time limit reached, stopping. %d <= %d",
706 (uint32_t)devc->limit_msec,
707 (uint32_t)(g_get_monotonic_time() - devc->aq_started) / 1000);
708 send_data(sdi, devc->sample_buf, devc->samp_received);
709 g_free(devc->sample_buf);
710 devc->sample_buf = NULL;
711 sdi->driver->dev_acquisition_stop(sdi, NULL);
713 read_channel(sdi, data_amount(sdi));
717 static int read_channel(const struct sr_dev_inst *sdi, uint32_t amount)
720 struct dev_context *devc;
724 amount = MIN(amount, MAX_PACKET_SIZE);
725 ret = hantek_6xxx_get_channeldata(sdi, receive_transfer, amount);
726 devc->read_start_ts = g_get_monotonic_time();
727 devc->read_data_amount = amount;
732 static int handle_event(int fd, int revents, void *cb_data)
734 const struct sr_dev_inst *sdi;
735 struct sr_datafeed_packet packet;
737 struct sr_dev_driver *di;
738 struct dev_context *devc;
739 struct drv_context *drvc;
749 /* Always handle pending libusb events. */
750 tv.tv_sec = tv.tv_usec = 0;
751 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
753 if (devc->dev_state == STOPPING) {
754 /* We've been told to wind up the acquisition. */
755 sr_dbg("Stopping acquisition.");
757 hantek_6xxx_stop_data_collecting(sdi);
759 * TODO: Doesn't really cancel pending transfers so they might
760 * come in after SR_DF_END is sent.
762 usb_source_remove(sdi->session, drvc->sr_ctx);
764 packet.type = SR_DF_END;
765 packet.payload = NULL;
766 sr_session_send(sdi, &packet);
768 devc->dev_state = IDLE;
776 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
778 struct dev_context *devc;
779 struct sr_dev_driver *di = sdi->driver;
780 struct drv_context *drvc = di->context;
782 if (sdi->status != SR_ST_ACTIVE)
783 return SR_ERR_DEV_CLOSED;
786 devc->cb_data = cb_data;
788 if (configure_channels(sdi) != SR_OK) {
789 sr_err("Failed to configure channels.");
793 if (hantek_6xxx_init(sdi) != SR_OK)
796 /* Send header packet to the session bus. */
797 std_session_send_df_header(cb_data, LOG_PREFIX);
799 devc->samp_received = 0;
800 devc->dev_state = FLUSH;
802 usb_source_add(sdi->session, drvc->sr_ctx, TICK,
803 handle_event, (void *)sdi);
805 hantek_6xxx_start_data_collecting(sdi);
807 read_channel(sdi, FLUSH_PACKET_SIZE);
812 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
814 struct dev_context *devc;
818 if (sdi->status != SR_ST_ACTIVE)
822 devc->dev_state = STOPPING;
824 g_free(devc->sample_buf); devc->sample_buf = NULL;
829 SR_PRIV struct sr_dev_driver hantek_6xxx_driver_info = {
830 .name = "hantek-6xxx",
831 .longname = "Hantek 6xxx",
836 .dev_list = dev_list,
837 .dev_clear = dev_clear,
838 .config_get = config_get,
839 .config_set = config_set,
840 .config_list = config_list,
841 .dev_open = dev_open,
842 .dev_close = dev_close,
843 .dev_acquisition_start = dev_acquisition_start,
844 .dev_acquisition_stop = dev_acquisition_stop,