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 static int read_channel(const struct sr_dev_inst *sdi, uint32_t amount);
79 static int dev_acquisition_stop(struct sr_dev_inst *sdi);
81 static struct sr_dev_inst *hantek_6xxx_dev_new(const struct hantek_6xxx_profile *prof)
83 struct sr_dev_inst *sdi;
84 struct sr_channel *ch;
85 struct sr_channel_group *cg;
86 struct dev_context *devc;
89 sdi = g_malloc0(sizeof(struct sr_dev_inst));
90 sdi->status = SR_ST_INITIALIZING;
91 sdi->vendor = g_strdup(prof->vendor);
92 sdi->model = g_strdup(prof->model);
94 for (i = 0; i < ARRAY_SIZE(channel_names); i++) {
95 ch = sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, TRUE, channel_names[i]);
96 cg = g_malloc0(sizeof(struct sr_channel_group));
97 cg->name = g_strdup(channel_names[i]);
98 cg->channels = g_slist_append(cg->channels, ch);
99 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
102 devc = g_malloc0(sizeof(struct dev_context));
104 for (i = 0; i < NUM_CHANNELS; i++) {
105 devc->ch_enabled[i] = TRUE;
106 devc->voltage[i] = DEFAULT_VOLTAGE;
107 devc->coupling[i] = DEFAULT_COUPLING;
110 devc->sample_buf = NULL;
111 devc->sample_buf_write = 0;
112 devc->sample_buf_size = 0;
114 devc->profile = prof;
115 devc->dev_state = IDLE;
116 devc->samplerate = DEFAULT_SAMPLERATE;
123 static int configure_channels(const struct sr_dev_inst *sdi)
125 struct dev_context *devc;
128 struct sr_channel *ch;
131 g_slist_free(devc->enabled_channels);
132 devc->enabled_channels = NULL;
133 memset(devc->ch_enabled, 0, sizeof(devc->ch_enabled));
135 for (l = sdi->channels, p = 0; l; l = l->next, p++) {
137 if (p < NUM_CHANNELS) {
138 devc->ch_enabled[p] = ch->enabled;
139 devc->enabled_channels = g_slist_append(devc->enabled_channels, ch);
146 static void clear_dev_context(void *priv)
148 struct dev_context *devc;
151 g_slist_free(devc->enabled_channels);
155 static int dev_clear(const struct sr_dev_driver *di)
157 return std_dev_clear(di, clear_dev_context);
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);
256 return std_scan_complete(di, devices);
259 static int dev_open(struct sr_dev_inst *sdi)
261 struct dev_context *devc;
262 struct sr_usb_dev_inst *usb;
263 int64_t timediff_us, timediff_ms;
270 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
271 * for the FX2 to renumerate.
274 if (devc->fw_updated > 0) {
275 sr_info("Waiting for device to reset.");
276 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
277 g_usleep(300 * 1000);
279 while (timediff_ms < MAX_RENUM_DELAY_MS) {
280 if ((err = hantek_6xxx_open(sdi)) == SR_OK)
282 g_usleep(100 * 1000);
283 timediff_us = g_get_monotonic_time() - devc->fw_updated;
284 timediff_ms = timediff_us / 1000;
285 sr_spew("Waited %" PRIi64 " ms.", timediff_ms);
287 if (timediff_ms < MAX_RENUM_DELAY_MS)
288 sr_info("Device came back after %"PRIu64" ms.", timediff_ms);
290 err = hantek_6xxx_open(sdi);
294 sr_err("Unable to open device.");
298 err = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
300 sr_err("Unable to claim interface: %s.",
301 libusb_error_name(err));
308 static int dev_close(struct sr_dev_inst *sdi)
310 hantek_6xxx_close(sdi);
315 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
316 const struct sr_channel_group *cg)
318 struct dev_context *devc;
319 struct sr_usb_dev_inst *usb;
321 const uint64_t *vdiv;
325 case SR_CONF_NUM_VDIV:
326 *data = g_variant_new_int32(ARRAY_SIZE(vdivs));
336 case SR_CONF_SAMPLERATE:
337 *data = g_variant_new_uint64(devc->samplerate);
339 case SR_CONF_LIMIT_MSEC:
340 *data = g_variant_new_uint64(devc->limit_msec);
342 case SR_CONF_LIMIT_SAMPLES:
343 *data = g_variant_new_uint64(devc->limit_samples);
349 if (usb->address == 255)
350 /* Device still needs to re-enumerate after firmware
351 * upload, so we don't know its (future) address. */
353 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
354 *data = g_variant_new_string(str);
360 if (sdi->channel_groups->data == cg)
362 else if (sdi->channel_groups->next->data == cg)
368 vdiv = vdivs[devc->voltage[ch_idx]];
369 *data = g_variant_new("(tt)", vdiv[0], vdiv[1]);
371 case SR_CONF_COUPLING:
372 *data = g_variant_new_string(coupling[devc->coupling[ch_idx]]);
380 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
381 const struct sr_channel_group *cg)
383 struct dev_context *devc;
385 int tmp_int, ch_idx, ret;
389 if (sdi->status != SR_ST_ACTIVE)
390 return SR_ERR_DEV_CLOSED;
396 case SR_CONF_SAMPLERATE:
397 devc->samplerate = g_variant_get_uint64(data);
398 hantek_6xxx_update_samplerate(sdi);
400 case SR_CONF_LIMIT_MSEC:
401 devc->limit_msec = g_variant_get_uint64(data);
403 case SR_CONF_LIMIT_SAMPLES:
404 devc->limit_samples = g_variant_get_uint64(data);
411 if (sdi->channel_groups->data == cg)
413 else if (sdi->channel_groups->next->data == cg)
419 g_variant_get(data, "(tt)", &p, &q);
421 for (i = 0; i < ARRAY_SIZE(vdivs); i++) {
422 if (vdivs[i][0] == p && vdivs[i][1] == q) {
428 devc->voltage[ch_idx] = tmp_int;
429 hantek_6xxx_update_vdiv(sdi);
433 case SR_CONF_COUPLING:
434 tmp_str = g_variant_get_string(data, NULL);
435 for (i = 0; coupling[i]; i++) {
436 if (!strcmp(tmp_str, coupling[i])) {
437 devc->coupling[ch_idx] = i;
441 if (coupling[i] == 0)
453 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
454 const struct sr_channel_group *cg)
456 GVariant *tuple, *rational[2];
461 if (key == SR_CONF_SCAN_OPTIONS) {
462 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
463 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
465 } else if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
466 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
467 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
476 case SR_CONF_DEVICE_OPTIONS:
477 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
478 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
480 case SR_CONF_SAMPLERATE:
481 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
482 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
483 samplerates, ARRAY_SIZE(samplerates),
485 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
486 *data = g_variant_builder_end(&gvb);
493 case SR_CONF_DEVICE_OPTIONS:
494 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
495 devopts_cg, ARRAY_SIZE(devopts_cg), sizeof(uint32_t));
497 case SR_CONF_COUPLING:
498 *data = g_variant_new_strv(coupling, ARRAY_SIZE(coupling));
501 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
502 for (i = 0; i < ARRAY_SIZE(vdivs); i++) {
503 rational[0] = g_variant_new_uint64(vdivs[i][0]);
504 rational[1] = g_variant_new_uint64(vdivs[i][1]);
505 tuple = g_variant_new_tuple(rational, 2);
506 g_variant_builder_add_value(&gvb, tuple);
508 *data = g_variant_builder_end(&gvb);
518 /* Minimise data amount for limit_samples and limit_msec limits. */
519 static uint32_t data_amount(const struct sr_dev_inst *sdi)
521 struct dev_context *devc = sdi->priv;
525 if (devc->limit_msec) {
526 time_left = devc->limit_msec - (g_get_monotonic_time() - devc->aq_started) / 1000;
527 data_left = devc->samplerate * MAX(time_left, 0) * NUM_CHANNELS / 1000;
528 } else if (devc->limit_samples) {
529 data_left = (devc->limit_samples - devc->samp_received) * NUM_CHANNELS;
531 data_left = devc->samplerate * NUM_CHANNELS;
534 data_left += MIN_PACKET_SIZE; /* Driver does not handle small buffers. */
536 sr_spew("data_amount %u", data_left);
541 static void send_chunk(struct sr_dev_inst *sdi, unsigned char *buf,
544 struct sr_datafeed_packet packet;
545 struct sr_datafeed_analog_old analog;
546 struct dev_context *devc = sdi->priv;
547 int num_channels, data_offset, i;
549 const float ch1_bit = RANGE(0) / 255;
550 const float ch2_bit = RANGE(1) / 255;
551 const float ch1_center = RANGE(0) / 2;
552 const float ch2_center = RANGE(1) / 2;
554 const gboolean ch1_ena = !!devc->ch_enabled[0];
555 const gboolean ch2_ena = !!devc->ch_enabled[1];
557 num_channels = (ch1_ena && ch2_ena) ? 2 : 1;
558 packet.type = SR_DF_ANALOG_OLD;
559 packet.payload = &analog;
561 analog.channels = devc->enabled_channels;
562 analog.num_samples = num_samples;
563 analog.mq = SR_MQ_VOLTAGE;
564 analog.unit = SR_UNIT_VOLT;
567 analog.data = g_try_malloc(analog.num_samples * sizeof(float) * num_channels);
569 sr_err("Analog data buffer malloc failed.");
570 devc->dev_state = STOPPING;
575 for (i = 0; i < num_samples; i++) {
577 * The device always sends data for both channels. If a channel
578 * is disabled, it contains a copy of the enabled channel's
579 * data. However, we only send the requested channels to
582 * Voltage values are encoded as a value 0-255, where the
583 * value is a point in the range represented by the vdiv
584 * setting. There are 10 vertical divs, so e.g. 500mV/div
585 * represents 5V peak-to-peak where 0 = -2.5V and 255 = +2.5V.
588 analog.data[data_offset++] = (ch1_bit * *(buf + i * 2) - ch1_center);
590 analog.data[data_offset++] = (ch2_bit * *(buf + i * 2 + 1) - ch2_center);
593 sr_session_send(sdi, &packet);
597 static void send_data(struct sr_dev_inst *sdi, struct libusb_transfer *buf[], uint64_t samples)
603 while (send < samples) {
604 chunk = MIN(samples - send, (uint64_t)(buf[i]->actual_length / NUM_CHANNELS));
606 send_chunk(sdi, buf[i]->buffer, chunk);
609 * Everything in this transfer was either copied to the buffer
610 * or sent to the session bus.
612 g_free(buf[i]->buffer);
613 libusb_free_transfer(buf[i]);
619 * Called by libusb (as triggered by handle_event()) when a transfer comes in.
620 * Only channel data comes in asynchronously, and all transfers for this are
621 * queued up beforehand, so this just needs to chuck the incoming data onto
622 * the libsigrok session bus.
624 static void LIBUSB_CALL receive_transfer(struct libusb_transfer *transfer)
626 struct sr_dev_inst *sdi;
627 struct dev_context *devc;
629 sdi = transfer->user_data;
632 if (devc->dev_state == FLUSH) {
633 g_free(transfer->buffer);
634 libusb_free_transfer(transfer);
635 devc->dev_state = CAPTURE;
636 devc->aq_started = g_get_monotonic_time();
637 read_channel(sdi, data_amount(sdi));
641 if (devc->dev_state != CAPTURE)
644 if (!devc->sample_buf) {
645 devc->sample_buf_size = 10;
646 devc->sample_buf = g_try_malloc(devc->sample_buf_size * sizeof(transfer));
647 devc->sample_buf_write = 0;
650 if (devc->sample_buf_write >= devc->sample_buf_size) {
651 devc->sample_buf_size += 10;
652 devc->sample_buf = g_try_realloc(devc->sample_buf,
653 devc->sample_buf_size * sizeof(transfer));
654 if (!devc->sample_buf) {
655 sr_err("Sample buffer malloc failed.");
656 devc->dev_state = STOPPING;
661 devc->sample_buf[devc->sample_buf_write++] = transfer;
662 devc->samp_received += transfer->actual_length / NUM_CHANNELS;
664 sr_spew("receive_transfer(): calculated samplerate == %" PRIu64 "ks/s",
665 (uint64_t)(transfer->actual_length * 1000 /
666 (g_get_monotonic_time() - devc->read_start_ts + 1) /
669 sr_spew("receive_transfer(): status %s received %d bytes.",
670 libusb_error_name(transfer->status), transfer->actual_length);
672 if (transfer->actual_length == 0)
673 /* Nothing to send to the bus. */
676 if (devc->limit_samples && devc->samp_received >= devc->limit_samples) {
677 sr_info("Requested number of samples reached, stopping. %"
678 PRIu64 " <= %" PRIu64, devc->limit_samples,
679 devc->samp_received);
680 send_data(sdi, devc->sample_buf, devc->limit_samples);
681 sdi->driver->dev_acquisition_stop(sdi);
682 } else if (devc->limit_msec && (g_get_monotonic_time() -
683 devc->aq_started) / 1000 >= devc->limit_msec) {
684 sr_info("Requested time limit reached, stopping. %d <= %d",
685 (uint32_t)devc->limit_msec,
686 (uint32_t)(g_get_monotonic_time() - devc->aq_started) / 1000);
687 send_data(sdi, devc->sample_buf, devc->samp_received);
688 g_free(devc->sample_buf);
689 devc->sample_buf = NULL;
690 sdi->driver->dev_acquisition_stop(sdi);
692 read_channel(sdi, data_amount(sdi));
696 static int read_channel(const struct sr_dev_inst *sdi, uint32_t amount)
699 struct dev_context *devc;
703 amount = MIN(amount, MAX_PACKET_SIZE);
704 ret = hantek_6xxx_get_channeldata(sdi, receive_transfer, amount);
705 devc->read_start_ts = g_get_monotonic_time();
706 devc->read_data_amount = amount;
711 static int handle_event(int fd, int revents, void *cb_data)
713 const struct sr_dev_inst *sdi;
715 struct sr_dev_driver *di;
716 struct dev_context *devc;
717 struct drv_context *drvc;
727 /* Always handle pending libusb events. */
728 tv.tv_sec = tv.tv_usec = 0;
729 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
731 if (devc->dev_state == STOPPING) {
732 /* We've been told to wind up the acquisition. */
733 sr_dbg("Stopping acquisition.");
735 hantek_6xxx_stop_data_collecting(sdi);
737 * TODO: Doesn't really cancel pending transfers so they might
738 * come in after SR_DF_END is sent.
740 usb_source_remove(sdi->session, drvc->sr_ctx);
742 std_session_send_df_end(sdi);
744 devc->dev_state = IDLE;
752 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
754 struct dev_context *devc;
755 struct sr_dev_driver *di = sdi->driver;
756 struct drv_context *drvc = di->context;
758 if (sdi->status != SR_ST_ACTIVE)
759 return SR_ERR_DEV_CLOSED;
763 if (configure_channels(sdi) != SR_OK) {
764 sr_err("Failed to configure channels.");
768 if (hantek_6xxx_init(sdi) != SR_OK)
771 std_session_send_df_header(sdi);
773 devc->samp_received = 0;
774 devc->dev_state = FLUSH;
776 usb_source_add(sdi->session, drvc->sr_ctx, TICK,
777 handle_event, (void *)sdi);
779 hantek_6xxx_start_data_collecting(sdi);
781 read_channel(sdi, FLUSH_PACKET_SIZE);
786 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
788 struct dev_context *devc;
790 if (sdi->status != SR_ST_ACTIVE)
794 devc->dev_state = STOPPING;
796 g_free(devc->sample_buf); devc->sample_buf = NULL;
801 static struct sr_dev_driver hantek_6xxx_driver_info = {
802 .name = "hantek-6xxx",
803 .longname = "Hantek 6xxx",
806 .cleanup = std_cleanup,
808 .dev_list = std_dev_list,
809 .dev_clear = dev_clear,
810 .config_get = config_get,
811 .config_set = config_set,
812 .config_list = config_list,
813 .dev_open = dev_open,
814 .dev_close = dev_close,
815 .dev_acquisition_start = dev_acquisition_start,
816 .dev_acquisition_stop = dev_acquisition_stop,
819 SR_REGISTER_DEV_DRIVER(hantek_6xxx_driver_info);