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,
48 static const char *channel_names[] = {
52 static const struct hantek_6xxx_profile dev_profiles[] = {
54 0x04b4, 0x6022, 0x04b5, 0x6022,
55 "Hantek", "6022BE", "hantek-6022be.fw",
60 static const uint64_t samplerates[] = {
64 static const uint64_t vdivs[][2] = {
68 SR_PRIV struct sr_dev_driver hantek_6xxx_driver_info;
70 static int read_channel(const struct sr_dev_inst *sdi, uint32_t amount);
72 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data);
74 static struct sr_dev_inst *hantek_6xxx_dev_new(const struct hantek_6xxx_profile *prof)
76 struct sr_dev_inst *sdi;
77 struct sr_channel *ch;
78 struct sr_channel_group *cg;
79 struct drv_context *drvc;
80 struct dev_context *devc;
83 sdi = g_malloc0(sizeof(struct sr_dev_inst));
84 sdi->status = SR_ST_INITIALIZING;
85 sdi->vendor = g_strdup(prof->vendor);
86 sdi->model = g_strdup(prof->model);
87 sdi->driver = &hantek_6xxx_driver_info;
89 for (i = 0; i < ARRAY_SIZE(channel_names); i++) {
90 ch = sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, TRUE, channel_names[i]);
91 cg = g_malloc0(sizeof(struct sr_channel_group));
92 cg->name = g_strdup(channel_names[i]);
93 cg->channels = g_slist_append(cg->channels, ch);
94 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
97 devc = g_malloc0(sizeof(struct dev_context));
99 for (i = 0; i < NUM_CHANNELS; i++) {
100 devc->ch_enabled[i] = TRUE;
101 devc->voltage[i] = DEFAULT_VOLTAGE;
104 devc->sample_buf = NULL;
105 devc->sample_buf_write = 0;
106 devc->sample_buf_size = 0;
108 devc->profile = prof;
109 devc->dev_state = IDLE;
110 devc->samplerate = DEFAULT_SAMPLERATE;
113 drvc = sdi->driver->context;
114 drvc->instances = g_slist_append(drvc->instances, sdi);
119 static int configure_channels(const struct sr_dev_inst *sdi)
121 struct dev_context *devc;
124 struct sr_channel *ch;
127 g_slist_free(devc->enabled_channels);
128 devc->enabled_channels = NULL;
129 memset(devc->ch_enabled, 0, sizeof(devc->ch_enabled));
131 for (l = sdi->channels, p = 0; l; l = l->next, p++) {
133 if (p < NUM_CHANNELS) {
134 devc->ch_enabled[p] = ch->enabled;
135 devc->enabled_channels = g_slist_append(devc->enabled_channels, ch);
142 static void clear_dev_context(void *priv)
144 struct dev_context *devc;
147 g_slist_free(devc->enabled_channels);
150 static int dev_clear(const struct sr_dev_driver *di)
152 return std_dev_clear(di, clear_dev_context);
155 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
157 return std_init(sr_ctx, di, LOG_PREFIX);
160 static GSList *scan(struct sr_dev_driver *di, GSList *options)
162 struct drv_context *drvc;
163 struct dev_context *devc;
164 struct sr_dev_inst *sdi;
165 struct sr_usb_dev_inst *usb;
166 struct sr_config *src;
167 const struct hantek_6xxx_profile *prof;
168 GSList *l, *devices, *conn_devices;
169 struct libusb_device_descriptor des;
170 libusb_device **devlist;
173 char connection_id[64];
180 for (l = options; l; l = l->next) {
182 if (src->key == SR_CONF_CONN) {
183 conn = g_variant_get_string(src->data, NULL);
188 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
192 /* Find all Hantek 60xx devices and upload firmware to all of them. */
193 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
194 for (i = 0; devlist[i]; i++) {
197 for (l = conn_devices; l; l = l->next) {
199 if (usb->bus == libusb_get_bus_number(devlist[i])
200 && usb->address == libusb_get_device_address(devlist[i]))
204 /* This device matched none of the ones that
205 * matched the conn specification. */
209 libusb_get_device_descriptor(devlist[i], &des);
211 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
214 for (j = 0; j < (int)ARRAY_SIZE(dev_profiles); j++) {
215 if (des.idVendor == dev_profiles[j].orig_vid
216 && des.idProduct == dev_profiles[j].orig_pid) {
217 /* Device matches the pre-firmware profile. */
218 prof = &dev_profiles[j];
219 sr_dbg("Found a %s %s.", prof->vendor, prof->model);
220 sdi = hantek_6xxx_dev_new(prof);
221 sdi->connection_id = g_strdup(connection_id);
222 devices = g_slist_append(devices, sdi);
224 if (ezusb_upload_firmware(drvc->sr_ctx, devlist[i],
225 USB_CONFIGURATION, prof->firmware) == SR_OK)
226 /* Remember when the firmware on this device was updated. */
227 devc->fw_updated = g_get_monotonic_time();
229 sr_err("Firmware upload failed.");
230 /* Dummy USB address of 0xff will get overwritten later. */
231 sdi->conn = sr_usb_dev_inst_new(
232 libusb_get_bus_number(devlist[i]), 0xff, NULL);
234 } else if (des.idVendor == dev_profiles[j].fw_vid
235 && des.idProduct == dev_profiles[j].fw_pid) {
236 /* Device matches the post-firmware profile. */
237 prof = &dev_profiles[j];
238 sr_dbg("Found a %s %s.", prof->vendor, prof->model);
239 sdi = hantek_6xxx_dev_new(prof);
240 sdi->connection_id = g_strdup(connection_id);
241 sdi->status = SR_ST_INACTIVE;
242 devices = g_slist_append(devices, sdi);
243 sdi->inst_type = SR_INST_USB;
244 sdi->conn = sr_usb_dev_inst_new(
245 libusb_get_bus_number(devlist[i]),
246 libusb_get_device_address(devlist[i]), NULL);
251 /* Not a supported VID/PID. */
254 libusb_free_device_list(devlist, 1);
259 static GSList *dev_list(const struct sr_dev_driver *di)
261 return ((struct drv_context *)(di->context))->instances;
264 static int dev_open(struct sr_dev_inst *sdi)
266 struct dev_context *devc;
267 struct sr_usb_dev_inst *usb;
268 int64_t timediff_us, timediff_ms;
275 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
276 * for the FX2 to renumerate.
279 if (devc->fw_updated > 0) {
280 sr_info("Waiting for device to reset.");
281 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
282 g_usleep(300 * 1000);
284 while (timediff_ms < MAX_RENUM_DELAY_MS) {
285 if ((err = hantek_6xxx_open(sdi)) == SR_OK)
287 g_usleep(100 * 1000);
288 timediff_us = g_get_monotonic_time() - devc->fw_updated;
289 timediff_ms = timediff_us / 1000;
290 sr_spew("Waited %" PRIi64 " ms.", timediff_ms);
292 if (timediff_ms < MAX_RENUM_DELAY_MS)
293 sr_info("Device came back after %"PRIu64" ms.", timediff_ms);
295 err = hantek_6xxx_open(sdi);
299 sr_err("Unable to open device.");
303 err = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
305 sr_err("Unable to claim interface: %s.",
306 libusb_error_name(err));
313 static int dev_close(struct sr_dev_inst *sdi)
315 hantek_6xxx_close(sdi);
320 static int cleanup(const struct sr_dev_driver *di)
322 return dev_clear(di);
325 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
326 const struct sr_channel_group *cg)
328 struct dev_context *devc;
329 struct sr_usb_dev_inst *usb;
331 const uint64_t *vdiv;
335 case SR_CONF_NUM_VDIV:
336 *data = g_variant_new_int32(ARRAY_SIZE(vdivs));
346 case SR_CONF_SAMPLERATE:
347 *data = g_variant_new_uint64(devc->samplerate);
349 case SR_CONF_LIMIT_MSEC:
350 *data = g_variant_new_uint64(devc->limit_msec);
352 case SR_CONF_LIMIT_SAMPLES:
353 *data = g_variant_new_uint64(devc->limit_samples);
359 if (usb->address == 255)
360 /* Device still needs to re-enumerate after firmware
361 * upload, so we don't know its (future) address. */
363 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
364 *data = g_variant_new_string(str);
370 if (sdi->channel_groups->data == cg)
372 else if (sdi->channel_groups->next->data == cg)
378 vdiv = vdivs[devc->voltage[ch_idx]];
379 *data = g_variant_new("(tt)", vdiv[0], vdiv[1]);
387 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
388 const struct sr_channel_group *cg)
390 struct dev_context *devc;
392 int tmp_int, ch_idx, ret;
395 if (sdi->status != SR_ST_ACTIVE)
396 return SR_ERR_DEV_CLOSED;
402 case SR_CONF_SAMPLERATE:
403 devc->samplerate = g_variant_get_uint64(data);
404 hantek_6xxx_update_samplerate(sdi);
406 case SR_CONF_LIMIT_MSEC:
407 devc->limit_msec = g_variant_get_uint64(data);
409 case SR_CONF_LIMIT_SAMPLES:
410 devc->limit_samples = g_variant_get_uint64(data);
417 if (sdi->channel_groups->data == cg)
419 else if (sdi->channel_groups->next->data == cg)
425 g_variant_get(data, "(tt)", &p, &q);
427 for (i = 0; i < ARRAY_SIZE(vdivs); i++) {
428 if (vdivs[i][0] == p && vdivs[i][1] == q) {
434 devc->voltage[ch_idx] = tmp_int;
435 hantek_6xxx_update_vdiv(sdi);
448 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
449 const struct sr_channel_group *cg)
451 GVariant *tuple, *rational[2];
456 if (key == SR_CONF_SCAN_OPTIONS) {
457 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
458 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
460 } else if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
461 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
462 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
471 case SR_CONF_DEVICE_OPTIONS:
472 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
473 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
475 case SR_CONF_SAMPLERATE:
476 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
477 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
478 samplerates, ARRAY_SIZE(samplerates),
480 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
481 *data = g_variant_builder_end(&gvb);
488 case SR_CONF_DEVICE_OPTIONS:
489 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
490 devopts_cg, ARRAY_SIZE(devopts_cg), sizeof(uint32_t));
493 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
494 for (i = 0; i < ARRAY_SIZE(vdivs); i++) {
495 rational[0] = g_variant_new_uint64(vdivs[i][0]);
496 rational[1] = g_variant_new_uint64(vdivs[i][1]);
497 tuple = g_variant_new_tuple(rational, 2);
498 g_variant_builder_add_value(&gvb, tuple);
500 *data = g_variant_builder_end(&gvb);
510 /* Minimise data amount for limit_samples and limit_msec limits. */
511 static uint32_t data_amount(const struct sr_dev_inst *sdi)
513 struct dev_context *devc = sdi->priv;
517 if (devc->limit_msec) {
518 time_left = devc->limit_msec - (g_get_monotonic_time() - devc->aq_started) / 1000;
519 data_left = devc->samplerate * MAX(time_left, 0) * NUM_CHANNELS / 1000;
520 } else if (devc->limit_samples) {
521 data_left = (devc->limit_samples - devc->samp_received) * NUM_CHANNELS;
523 data_left = devc->samplerate * NUM_CHANNELS;
526 data_left += MIN_PACKET_SIZE; /* Driver does not handle small buffers. */
528 sr_spew("data_amount %u", data_left);
533 static void send_chunk(struct sr_dev_inst *sdi, unsigned char *buf,
536 struct sr_datafeed_packet packet;
537 struct sr_datafeed_analog_old analog;
538 struct dev_context *devc = sdi->priv;
539 int num_channels, data_offset, i;
541 const float ch1_bit = RANGE(0) / 255;
542 const float ch2_bit = RANGE(1) / 255;
543 const float ch1_center = RANGE(0) / 2;
544 const float ch2_center = RANGE(1) / 2;
546 const gboolean ch1_ena = !!devc->ch_enabled[0];
547 const gboolean ch2_ena = !!devc->ch_enabled[1];
549 num_channels = (ch1_ena && ch2_ena) ? 2 : 1;
550 packet.type = SR_DF_ANALOG_OLD;
551 packet.payload = &analog;
553 analog.channels = devc->enabled_channels;
554 analog.num_samples = num_samples;
555 analog.mq = SR_MQ_VOLTAGE;
556 analog.unit = SR_UNIT_VOLT;
559 analog.data = g_try_malloc(analog.num_samples * sizeof(float) * num_channels);
561 sr_err("Analog data buffer malloc failed.");
562 devc->dev_state = STOPPING;
567 for (i = 0; i < num_samples; i++) {
569 * The device always sends data for both channels. If a channel
570 * is disabled, it contains a copy of the enabled channel's
571 * data. However, we only send the requested channels to
574 * Voltage values are encoded as a value 0-255, where the
575 * value is a point in the range represented by the vdiv
576 * setting. There are 10 vertical divs, so e.g. 500mV/div
577 * represents 5V peak-to-peak where 0 = -2.5V and 255 = +2.5V.
580 analog.data[data_offset++] = (ch1_bit * *(buf + i * 2) - ch1_center);
582 analog.data[data_offset++] = (ch2_bit * *(buf + i * 2 + 1) - ch2_center);
585 sr_session_send(devc->cb_data, &packet);
589 static void send_data(struct sr_dev_inst *sdi, struct libusb_transfer *buf[], uint64_t samples)
595 while (send < samples) {
596 chunk = MIN(samples - send, (uint64_t)(buf[i]->actual_length / NUM_CHANNELS));
598 send_chunk(sdi, buf[i]->buffer, chunk);
601 * Everything in this transfer was either copied to the buffer
602 * or sent to the session bus.
604 g_free(buf[i]->buffer);
605 libusb_free_transfer(buf[i]);
611 * Called by libusb (as triggered by handle_event()) when a transfer comes in.
612 * Only channel data comes in asynchronously, and all transfers for this are
613 * queued up beforehand, so this just needs to chuck the incoming data onto
614 * the libsigrok session bus.
616 static void LIBUSB_CALL receive_transfer(struct libusb_transfer *transfer)
618 struct sr_dev_inst *sdi;
619 struct dev_context *devc;
621 sdi = transfer->user_data;
624 if (devc->dev_state == FLUSH) {
625 devc->dev_state = CAPTURE;
626 devc->aq_started = g_get_monotonic_time();
627 read_channel(sdi, data_amount(sdi));
631 if (devc->dev_state != CAPTURE)
634 if (!devc->sample_buf) {
635 devc->sample_buf_size = 10;
636 devc->sample_buf = g_try_malloc(devc->sample_buf_size * sizeof(transfer));
637 devc->sample_buf_write = 0;
640 if (devc->sample_buf_write >= devc->sample_buf_size) {
641 devc->sample_buf_size += 10;
642 devc->sample_buf = g_try_realloc(devc->sample_buf,
643 devc->sample_buf_size * sizeof(transfer));
644 if (!devc->sample_buf) {
645 sr_err("Sample buffer malloc failed.");
646 devc->dev_state = STOPPING;
651 devc->sample_buf[devc->sample_buf_write++] = transfer;
652 devc->samp_received = transfer->actual_length / NUM_CHANNELS;
654 sr_spew("receive_transfer(): calculated samplerate == %" PRIu64 "ks/s",
655 (uint64_t)(transfer->actual_length * 1000 /
656 (g_get_monotonic_time() - devc->read_start_ts + 1) /
659 sr_spew("receive_transfer(): status %s received %d bytes.",
660 libusb_error_name(transfer->status), transfer->actual_length);
662 if (transfer->actual_length == 0)
663 /* Nothing to send to the bus. */
666 if (devc->limit_samples && devc->samp_received >= devc->limit_samples) {
667 sr_info("Requested number of samples reached, stopping. %"
668 PRIu64 " <= %" PRIu64, devc->limit_samples,
669 devc->samp_received);
670 send_data(sdi, devc->sample_buf, devc->limit_samples);
671 sdi->driver->dev_acquisition_stop(sdi, NULL);
672 } else if (devc->limit_msec && (g_get_monotonic_time() -
673 devc->aq_started) / 1000 >= devc->limit_msec) {
674 sr_info("Requested time limit reached, stopping. %d <= %d",
675 (uint32_t)devc->limit_msec,
676 (uint32_t)(g_get_monotonic_time() - devc->aq_started) / 1000);
677 send_data(sdi, devc->sample_buf, devc->samp_received);
678 g_free(devc->sample_buf);
679 devc->sample_buf = NULL;
680 sdi->driver->dev_acquisition_stop(sdi, NULL);
682 read_channel(sdi, data_amount(sdi));
686 static int read_channel(const struct sr_dev_inst *sdi, uint32_t amount)
689 struct dev_context *devc;
693 amount = MIN(amount, MAX_PACKET_SIZE);
694 ret = hantek_6xxx_get_channeldata(sdi, receive_transfer, amount);
695 devc->read_start_ts = g_get_monotonic_time();
696 devc->read_data_amount = amount;
701 static int handle_event(int fd, int revents, void *cb_data)
703 const struct sr_dev_inst *sdi;
704 struct sr_datafeed_packet packet;
706 struct sr_dev_driver *di;
707 struct dev_context *devc;
708 struct drv_context *drvc;
718 /* Always handle pending libusb events. */
719 tv.tv_sec = tv.tv_usec = 0;
720 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
722 if (devc->dev_state == STOPPING) {
723 /* We've been told to wind up the acquisition. */
724 sr_dbg("Stopping acquisition.");
726 hantek_6xxx_stop_data_collecting(sdi);
728 * TODO: Doesn't really cancel pending transfers so they might
729 * come in after SR_DF_END is sent.
731 usb_source_remove(sdi->session, drvc->sr_ctx);
733 packet.type = SR_DF_END;
734 packet.payload = NULL;
735 sr_session_send(sdi, &packet);
737 devc->dev_state = IDLE;
745 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
747 struct dev_context *devc;
748 struct sr_dev_driver *di = sdi->driver;
749 struct drv_context *drvc = di->context;
751 if (sdi->status != SR_ST_ACTIVE)
752 return SR_ERR_DEV_CLOSED;
755 devc->cb_data = cb_data;
757 if (configure_channels(sdi) != SR_OK) {
758 sr_err("Failed to configure channels.");
762 if (hantek_6xxx_init(sdi) != SR_OK)
765 /* Send header packet to the session bus. */
766 std_session_send_df_header(cb_data, LOG_PREFIX);
768 devc->samp_received = 0;
769 devc->dev_state = FLUSH;
771 usb_source_add(sdi->session, drvc->sr_ctx, TICK,
772 handle_event, (void *)sdi);
774 hantek_6xxx_start_data_collecting(sdi);
776 read_channel(sdi, FLUSH_PACKET_SIZE);
781 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
783 struct dev_context *devc;
787 if (sdi->status != SR_ST_ACTIVE)
791 devc->dev_state = STOPPING;
793 g_free(devc->sample_buf); devc->sample_buf = NULL;
798 SR_PRIV struct sr_dev_driver hantek_6xxx_driver_info = {
799 .name = "hantek-6xxx",
800 .longname = "Hantek 6xxx",
805 .dev_list = dev_list,
806 .dev_clear = dev_clear,
807 .config_get = config_get,
808 .config_set = config_set,
809 .config_list = config_list,
810 .dev_open = dev_open,
811 .dev_close = dev_close,
812 .dev_acquisition_start = dev_acquisition_start,
813 .dev_acquisition_stop = dev_acquisition_stop,