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, 0x04b5, 0x6022,
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);
160 static int dev_clear(const struct sr_dev_driver *di)
162 return std_dev_clear(di, clear_dev_context);
165 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
167 return std_init(sr_ctx, di, LOG_PREFIX);
170 static GSList *scan(struct sr_dev_driver *di, GSList *options)
172 struct drv_context *drvc;
173 struct dev_context *devc;
174 struct sr_dev_inst *sdi;
175 struct sr_usb_dev_inst *usb;
176 struct sr_config *src;
177 const struct hantek_6xxx_profile *prof;
178 GSList *l, *devices, *conn_devices;
179 struct libusb_device_descriptor des;
180 libusb_device **devlist;
183 char connection_id[64];
190 for (l = options; l; l = l->next) {
192 if (src->key == SR_CONF_CONN) {
193 conn = g_variant_get_string(src->data, NULL);
198 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
202 /* Find all Hantek 60xx devices and upload firmware to all of them. */
203 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
204 for (i = 0; devlist[i]; i++) {
207 for (l = conn_devices; l; l = l->next) {
209 if (usb->bus == libusb_get_bus_number(devlist[i])
210 && usb->address == libusb_get_device_address(devlist[i]))
214 /* This device matched none of the ones that
215 * matched the conn specification. */
219 libusb_get_device_descriptor(devlist[i], &des);
221 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
224 for (j = 0; j < (int)ARRAY_SIZE(dev_profiles); j++) {
225 if (des.idVendor == dev_profiles[j].orig_vid
226 && des.idProduct == dev_profiles[j].orig_pid) {
227 /* Device matches the pre-firmware profile. */
228 prof = &dev_profiles[j];
229 sr_dbg("Found a %s %s.", prof->vendor, prof->model);
230 sdi = hantek_6xxx_dev_new(prof);
231 sdi->connection_id = g_strdup(connection_id);
232 devices = g_slist_append(devices, sdi);
234 if (ezusb_upload_firmware(drvc->sr_ctx, devlist[i],
235 USB_CONFIGURATION, prof->firmware) == SR_OK)
236 /* Remember when the firmware on this device was updated. */
237 devc->fw_updated = g_get_monotonic_time();
239 sr_err("Firmware upload failed.");
240 /* Dummy USB address of 0xff will get overwritten later. */
241 sdi->conn = sr_usb_dev_inst_new(
242 libusb_get_bus_number(devlist[i]), 0xff, NULL);
244 } else if (des.idVendor == dev_profiles[j].fw_vid
245 && des.idProduct == dev_profiles[j].fw_pid) {
246 /* Device matches the post-firmware profile. */
247 prof = &dev_profiles[j];
248 sr_dbg("Found a %s %s.", prof->vendor, prof->model);
249 sdi = hantek_6xxx_dev_new(prof);
250 sdi->connection_id = g_strdup(connection_id);
251 sdi->status = SR_ST_INACTIVE;
252 devices = g_slist_append(devices, sdi);
253 sdi->inst_type = SR_INST_USB;
254 sdi->conn = sr_usb_dev_inst_new(
255 libusb_get_bus_number(devlist[i]),
256 libusb_get_device_address(devlist[i]), NULL);
261 /* Not a supported VID/PID. */
264 libusb_free_device_list(devlist, 1);
269 static GSList *dev_list(const struct sr_dev_driver *di)
271 return ((struct drv_context *)(di->context))->instances;
274 static int dev_open(struct sr_dev_inst *sdi)
276 struct dev_context *devc;
277 struct sr_usb_dev_inst *usb;
278 int64_t timediff_us, timediff_ms;
285 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
286 * for the FX2 to renumerate.
289 if (devc->fw_updated > 0) {
290 sr_info("Waiting for device to reset.");
291 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
292 g_usleep(300 * 1000);
294 while (timediff_ms < MAX_RENUM_DELAY_MS) {
295 if ((err = hantek_6xxx_open(sdi)) == SR_OK)
297 g_usleep(100 * 1000);
298 timediff_us = g_get_monotonic_time() - devc->fw_updated;
299 timediff_ms = timediff_us / 1000;
300 sr_spew("Waited %" PRIi64 " ms.", timediff_ms);
302 if (timediff_ms < MAX_RENUM_DELAY_MS)
303 sr_info("Device came back after %"PRIu64" ms.", timediff_ms);
305 err = hantek_6xxx_open(sdi);
309 sr_err("Unable to open device.");
313 err = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
315 sr_err("Unable to claim interface: %s.",
316 libusb_error_name(err));
323 static int dev_close(struct sr_dev_inst *sdi)
325 hantek_6xxx_close(sdi);
330 static int cleanup(const struct sr_dev_driver *di)
332 return dev_clear(di);
335 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
336 const struct sr_channel_group *cg)
338 struct dev_context *devc;
339 struct sr_usb_dev_inst *usb;
341 const uint64_t *vdiv;
345 case SR_CONF_NUM_VDIV:
346 *data = g_variant_new_int32(ARRAY_SIZE(vdivs));
356 case SR_CONF_SAMPLERATE:
357 *data = g_variant_new_uint64(devc->samplerate);
359 case SR_CONF_LIMIT_MSEC:
360 *data = g_variant_new_uint64(devc->limit_msec);
362 case SR_CONF_LIMIT_SAMPLES:
363 *data = g_variant_new_uint64(devc->limit_samples);
369 if (usb->address == 255)
370 /* Device still needs to re-enumerate after firmware
371 * upload, so we don't know its (future) address. */
373 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
374 *data = g_variant_new_string(str);
380 if (sdi->channel_groups->data == cg)
382 else if (sdi->channel_groups->next->data == cg)
388 vdiv = vdivs[devc->voltage[ch_idx]];
389 *data = g_variant_new("(tt)", vdiv[0], vdiv[1]);
391 case SR_CONF_COUPLING:
392 *data = g_variant_new_string(coupling[devc->coupling[ch_idx]]);
400 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
401 const struct sr_channel_group *cg)
403 struct dev_context *devc;
405 int tmp_int, ch_idx, ret;
409 if (sdi->status != SR_ST_ACTIVE)
410 return SR_ERR_DEV_CLOSED;
416 case SR_CONF_SAMPLERATE:
417 devc->samplerate = g_variant_get_uint64(data);
418 hantek_6xxx_update_samplerate(sdi);
420 case SR_CONF_LIMIT_MSEC:
421 devc->limit_msec = g_variant_get_uint64(data);
423 case SR_CONF_LIMIT_SAMPLES:
424 devc->limit_samples = g_variant_get_uint64(data);
431 if (sdi->channel_groups->data == cg)
433 else if (sdi->channel_groups->next->data == cg)
439 g_variant_get(data, "(tt)", &p, &q);
441 for (i = 0; i < ARRAY_SIZE(vdivs); i++) {
442 if (vdivs[i][0] == p && vdivs[i][1] == q) {
448 devc->voltage[ch_idx] = tmp_int;
449 hantek_6xxx_update_vdiv(sdi);
453 case SR_CONF_COUPLING:
454 tmp_str = g_variant_get_string(data, NULL);
455 for (i = 0; coupling[i]; i++) {
456 if (!strcmp(tmp_str, coupling[i])) {
457 devc->coupling[ch_idx] = i;
461 if (coupling[i] == 0)
473 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
474 const struct sr_channel_group *cg)
476 GVariant *tuple, *rational[2];
481 if (key == SR_CONF_SCAN_OPTIONS) {
482 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
483 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
485 } else if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
486 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
487 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
496 case SR_CONF_DEVICE_OPTIONS:
497 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
498 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
500 case SR_CONF_SAMPLERATE:
501 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
502 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
503 samplerates, ARRAY_SIZE(samplerates),
505 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
506 *data = g_variant_builder_end(&gvb);
513 case SR_CONF_DEVICE_OPTIONS:
514 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
515 devopts_cg, ARRAY_SIZE(devopts_cg), sizeof(uint32_t));
517 case SR_CONF_COUPLING:
518 *data = g_variant_new_strv(coupling, ARRAY_SIZE(coupling));
521 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
522 for (i = 0; i < ARRAY_SIZE(vdivs); i++) {
523 rational[0] = g_variant_new_uint64(vdivs[i][0]);
524 rational[1] = g_variant_new_uint64(vdivs[i][1]);
525 tuple = g_variant_new_tuple(rational, 2);
526 g_variant_builder_add_value(&gvb, tuple);
528 *data = g_variant_builder_end(&gvb);
538 /* Minimise data amount for limit_samples and limit_msec limits. */
539 static uint32_t data_amount(const struct sr_dev_inst *sdi)
541 struct dev_context *devc = sdi->priv;
545 if (devc->limit_msec) {
546 time_left = devc->limit_msec - (g_get_monotonic_time() - devc->aq_started) / 1000;
547 data_left = devc->samplerate * MAX(time_left, 0) * NUM_CHANNELS / 1000;
548 } else if (devc->limit_samples) {
549 data_left = (devc->limit_samples - devc->samp_received) * NUM_CHANNELS;
551 data_left = devc->samplerate * NUM_CHANNELS;
554 data_left += MIN_PACKET_SIZE; /* Driver does not handle small buffers. */
556 sr_spew("data_amount %u", data_left);
561 static void send_chunk(struct sr_dev_inst *sdi, unsigned char *buf,
564 struct sr_datafeed_packet packet;
565 struct sr_datafeed_analog_old analog;
566 struct dev_context *devc = sdi->priv;
567 int num_channels, data_offset, i;
569 const float ch1_bit = RANGE(0) / 255;
570 const float ch2_bit = RANGE(1) / 255;
571 const float ch1_center = RANGE(0) / 2;
572 const float ch2_center = RANGE(1) / 2;
574 const gboolean ch1_ena = !!devc->ch_enabled[0];
575 const gboolean ch2_ena = !!devc->ch_enabled[1];
577 num_channels = (ch1_ena && ch2_ena) ? 2 : 1;
578 packet.type = SR_DF_ANALOG_OLD;
579 packet.payload = &analog;
581 analog.channels = devc->enabled_channels;
582 analog.num_samples = num_samples;
583 analog.mq = SR_MQ_VOLTAGE;
584 analog.unit = SR_UNIT_VOLT;
587 analog.data = g_try_malloc(analog.num_samples * sizeof(float) * num_channels);
589 sr_err("Analog data buffer malloc failed.");
590 devc->dev_state = STOPPING;
595 for (i = 0; i < num_samples; i++) {
597 * The device always sends data for both channels. If a channel
598 * is disabled, it contains a copy of the enabled channel's
599 * data. However, we only send the requested channels to
602 * Voltage values are encoded as a value 0-255, where the
603 * value is a point in the range represented by the vdiv
604 * setting. There are 10 vertical divs, so e.g. 500mV/div
605 * represents 5V peak-to-peak where 0 = -2.5V and 255 = +2.5V.
608 analog.data[data_offset++] = (ch1_bit * *(buf + i * 2) - ch1_center);
610 analog.data[data_offset++] = (ch2_bit * *(buf + i * 2 + 1) - ch2_center);
613 sr_session_send(devc->cb_data, &packet);
617 static void send_data(struct sr_dev_inst *sdi, struct libusb_transfer *buf[], uint64_t samples)
623 while (send < samples) {
624 chunk = MIN(samples - send, (uint64_t)(buf[i]->actual_length / NUM_CHANNELS));
626 send_chunk(sdi, buf[i]->buffer, chunk);
629 * Everything in this transfer was either copied to the buffer
630 * or sent to the session bus.
632 g_free(buf[i]->buffer);
633 libusb_free_transfer(buf[i]);
639 * Called by libusb (as triggered by handle_event()) when a transfer comes in.
640 * Only channel data comes in asynchronously, and all transfers for this are
641 * queued up beforehand, so this just needs to chuck the incoming data onto
642 * the libsigrok session bus.
644 static void LIBUSB_CALL receive_transfer(struct libusb_transfer *transfer)
646 struct sr_dev_inst *sdi;
647 struct dev_context *devc;
649 sdi = transfer->user_data;
652 if (devc->dev_state == FLUSH) {
653 devc->dev_state = CAPTURE;
654 devc->aq_started = g_get_monotonic_time();
655 read_channel(sdi, data_amount(sdi));
659 if (devc->dev_state != CAPTURE)
662 if (!devc->sample_buf) {
663 devc->sample_buf_size = 10;
664 devc->sample_buf = g_try_malloc(devc->sample_buf_size * sizeof(transfer));
665 devc->sample_buf_write = 0;
668 if (devc->sample_buf_write >= devc->sample_buf_size) {
669 devc->sample_buf_size += 10;
670 devc->sample_buf = g_try_realloc(devc->sample_buf,
671 devc->sample_buf_size * sizeof(transfer));
672 if (!devc->sample_buf) {
673 sr_err("Sample buffer malloc failed.");
674 devc->dev_state = STOPPING;
679 devc->sample_buf[devc->sample_buf_write++] = transfer;
680 devc->samp_received += transfer->actual_length / NUM_CHANNELS;
682 sr_spew("receive_transfer(): calculated samplerate == %" PRIu64 "ks/s",
683 (uint64_t)(transfer->actual_length * 1000 /
684 (g_get_monotonic_time() - devc->read_start_ts + 1) /
687 sr_spew("receive_transfer(): status %s received %d bytes.",
688 libusb_error_name(transfer->status), transfer->actual_length);
690 if (transfer->actual_length == 0)
691 /* Nothing to send to the bus. */
694 if (devc->limit_samples && devc->samp_received >= devc->limit_samples) {
695 sr_info("Requested number of samples reached, stopping. %"
696 PRIu64 " <= %" PRIu64, devc->limit_samples,
697 devc->samp_received);
698 send_data(sdi, devc->sample_buf, devc->limit_samples);
699 sdi->driver->dev_acquisition_stop(sdi, NULL);
700 } else if (devc->limit_msec && (g_get_monotonic_time() -
701 devc->aq_started) / 1000 >= devc->limit_msec) {
702 sr_info("Requested time limit reached, stopping. %d <= %d",
703 (uint32_t)devc->limit_msec,
704 (uint32_t)(g_get_monotonic_time() - devc->aq_started) / 1000);
705 send_data(sdi, devc->sample_buf, devc->samp_received);
706 g_free(devc->sample_buf);
707 devc->sample_buf = NULL;
708 sdi->driver->dev_acquisition_stop(sdi, NULL);
710 read_channel(sdi, data_amount(sdi));
714 static int read_channel(const struct sr_dev_inst *sdi, uint32_t amount)
717 struct dev_context *devc;
721 amount = MIN(amount, MAX_PACKET_SIZE);
722 ret = hantek_6xxx_get_channeldata(sdi, receive_transfer, amount);
723 devc->read_start_ts = g_get_monotonic_time();
724 devc->read_data_amount = amount;
729 static int handle_event(int fd, int revents, void *cb_data)
731 const struct sr_dev_inst *sdi;
732 struct sr_datafeed_packet packet;
734 struct sr_dev_driver *di;
735 struct dev_context *devc;
736 struct drv_context *drvc;
746 /* Always handle pending libusb events. */
747 tv.tv_sec = tv.tv_usec = 0;
748 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
750 if (devc->dev_state == STOPPING) {
751 /* We've been told to wind up the acquisition. */
752 sr_dbg("Stopping acquisition.");
754 hantek_6xxx_stop_data_collecting(sdi);
756 * TODO: Doesn't really cancel pending transfers so they might
757 * come in after SR_DF_END is sent.
759 usb_source_remove(sdi->session, drvc->sr_ctx);
761 packet.type = SR_DF_END;
762 packet.payload = NULL;
763 sr_session_send(sdi, &packet);
765 devc->dev_state = IDLE;
773 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
775 struct dev_context *devc;
776 struct sr_dev_driver *di = sdi->driver;
777 struct drv_context *drvc = di->context;
779 if (sdi->status != SR_ST_ACTIVE)
780 return SR_ERR_DEV_CLOSED;
783 devc->cb_data = cb_data;
785 if (configure_channels(sdi) != SR_OK) {
786 sr_err("Failed to configure channels.");
790 if (hantek_6xxx_init(sdi) != SR_OK)
793 /* Send header packet to the session bus. */
794 std_session_send_df_header(cb_data, LOG_PREFIX);
796 devc->samp_received = 0;
797 devc->dev_state = FLUSH;
799 usb_source_add(sdi->session, drvc->sr_ctx, TICK,
800 handle_event, (void *)sdi);
802 hantek_6xxx_start_data_collecting(sdi);
804 read_channel(sdi, FLUSH_PACKET_SIZE);
809 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
811 struct dev_context *devc;
815 if (sdi->status != SR_ST_ACTIVE)
819 devc->dev_state = STOPPING;
821 g_free(devc->sample_buf); devc->sample_buf = NULL;
826 SR_PRIV struct sr_dev_driver hantek_6xxx_driver_info = {
827 .name = "hantek-6xxx",
828 .longname = "Hantek 6xxx",
833 .dev_list = dev_list,
834 .dev_clear = dev_clear,
835 .config_get = config_get,
836 .config_set = config_set,
837 .config_list = config_list,
838 .dev_open = dev_open,
839 .dev_close = dev_close,
840 .dev_acquisition_start = dev_acquisition_start,
841 .dev_acquisition_stop = dev_acquisition_stop,