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);
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(di, sr_ctx, 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 int dev_open(struct sr_dev_inst *sdi)
272 struct dev_context *devc;
273 struct sr_usb_dev_inst *usb;
274 int64_t timediff_us, timediff_ms;
281 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
282 * for the FX2 to renumerate.
285 if (devc->fw_updated > 0) {
286 sr_info("Waiting for device to reset.");
287 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
288 g_usleep(300 * 1000);
290 while (timediff_ms < MAX_RENUM_DELAY_MS) {
291 if ((err = hantek_6xxx_open(sdi)) == SR_OK)
293 g_usleep(100 * 1000);
294 timediff_us = g_get_monotonic_time() - devc->fw_updated;
295 timediff_ms = timediff_us / 1000;
296 sr_spew("Waited %" PRIi64 " ms.", timediff_ms);
298 if (timediff_ms < MAX_RENUM_DELAY_MS)
299 sr_info("Device came back after %"PRIu64" ms.", timediff_ms);
301 err = hantek_6xxx_open(sdi);
305 sr_err("Unable to open device.");
309 err = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
311 sr_err("Unable to claim interface: %s.",
312 libusb_error_name(err));
319 static int dev_close(struct sr_dev_inst *sdi)
321 hantek_6xxx_close(sdi);
326 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
327 const struct sr_channel_group *cg)
329 struct dev_context *devc;
330 struct sr_usb_dev_inst *usb;
332 const uint64_t *vdiv;
336 case SR_CONF_NUM_VDIV:
337 *data = g_variant_new_int32(ARRAY_SIZE(vdivs));
347 case SR_CONF_SAMPLERATE:
348 *data = g_variant_new_uint64(devc->samplerate);
350 case SR_CONF_LIMIT_MSEC:
351 *data = g_variant_new_uint64(devc->limit_msec);
353 case SR_CONF_LIMIT_SAMPLES:
354 *data = g_variant_new_uint64(devc->limit_samples);
360 if (usb->address == 255)
361 /* Device still needs to re-enumerate after firmware
362 * upload, so we don't know its (future) address. */
364 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
365 *data = g_variant_new_string(str);
371 if (sdi->channel_groups->data == cg)
373 else if (sdi->channel_groups->next->data == cg)
379 vdiv = vdivs[devc->voltage[ch_idx]];
380 *data = g_variant_new("(tt)", vdiv[0], vdiv[1]);
382 case SR_CONF_COUPLING:
383 *data = g_variant_new_string(coupling[devc->coupling[ch_idx]]);
391 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
392 const struct sr_channel_group *cg)
394 struct dev_context *devc;
396 int tmp_int, ch_idx, ret;
400 if (sdi->status != SR_ST_ACTIVE)
401 return SR_ERR_DEV_CLOSED;
407 case SR_CONF_SAMPLERATE:
408 devc->samplerate = g_variant_get_uint64(data);
409 hantek_6xxx_update_samplerate(sdi);
411 case SR_CONF_LIMIT_MSEC:
412 devc->limit_msec = g_variant_get_uint64(data);
414 case SR_CONF_LIMIT_SAMPLES:
415 devc->limit_samples = g_variant_get_uint64(data);
422 if (sdi->channel_groups->data == cg)
424 else if (sdi->channel_groups->next->data == cg)
430 g_variant_get(data, "(tt)", &p, &q);
432 for (i = 0; i < ARRAY_SIZE(vdivs); i++) {
433 if (vdivs[i][0] == p && vdivs[i][1] == q) {
439 devc->voltage[ch_idx] = tmp_int;
440 hantek_6xxx_update_vdiv(sdi);
444 case SR_CONF_COUPLING:
445 tmp_str = g_variant_get_string(data, NULL);
446 for (i = 0; coupling[i]; i++) {
447 if (!strcmp(tmp_str, coupling[i])) {
448 devc->coupling[ch_idx] = i;
452 if (coupling[i] == 0)
464 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
465 const struct sr_channel_group *cg)
467 GVariant *tuple, *rational[2];
472 if (key == SR_CONF_SCAN_OPTIONS) {
473 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
474 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
476 } else if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
477 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
478 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
487 case SR_CONF_DEVICE_OPTIONS:
488 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
489 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
491 case SR_CONF_SAMPLERATE:
492 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
493 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
494 samplerates, ARRAY_SIZE(samplerates),
496 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
497 *data = g_variant_builder_end(&gvb);
504 case SR_CONF_DEVICE_OPTIONS:
505 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
506 devopts_cg, ARRAY_SIZE(devopts_cg), sizeof(uint32_t));
508 case SR_CONF_COUPLING:
509 *data = g_variant_new_strv(coupling, ARRAY_SIZE(coupling));
512 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
513 for (i = 0; i < ARRAY_SIZE(vdivs); i++) {
514 rational[0] = g_variant_new_uint64(vdivs[i][0]);
515 rational[1] = g_variant_new_uint64(vdivs[i][1]);
516 tuple = g_variant_new_tuple(rational, 2);
517 g_variant_builder_add_value(&gvb, tuple);
519 *data = g_variant_builder_end(&gvb);
529 /* Minimise data amount for limit_samples and limit_msec limits. */
530 static uint32_t data_amount(const struct sr_dev_inst *sdi)
532 struct dev_context *devc = sdi->priv;
536 if (devc->limit_msec) {
537 time_left = devc->limit_msec - (g_get_monotonic_time() - devc->aq_started) / 1000;
538 data_left = devc->samplerate * MAX(time_left, 0) * NUM_CHANNELS / 1000;
539 } else if (devc->limit_samples) {
540 data_left = (devc->limit_samples - devc->samp_received) * NUM_CHANNELS;
542 data_left = devc->samplerate * NUM_CHANNELS;
545 data_left += MIN_PACKET_SIZE; /* Driver does not handle small buffers. */
547 sr_spew("data_amount %u", data_left);
552 static void send_chunk(struct sr_dev_inst *sdi, unsigned char *buf,
555 struct sr_datafeed_packet packet;
556 struct sr_datafeed_analog_old analog;
557 struct dev_context *devc = sdi->priv;
558 int num_channels, data_offset, i;
560 const float ch1_bit = RANGE(0) / 255;
561 const float ch2_bit = RANGE(1) / 255;
562 const float ch1_center = RANGE(0) / 2;
563 const float ch2_center = RANGE(1) / 2;
565 const gboolean ch1_ena = !!devc->ch_enabled[0];
566 const gboolean ch2_ena = !!devc->ch_enabled[1];
568 num_channels = (ch1_ena && ch2_ena) ? 2 : 1;
569 packet.type = SR_DF_ANALOG_OLD;
570 packet.payload = &analog;
572 analog.channels = devc->enabled_channels;
573 analog.num_samples = num_samples;
574 analog.mq = SR_MQ_VOLTAGE;
575 analog.unit = SR_UNIT_VOLT;
578 analog.data = g_try_malloc(analog.num_samples * sizeof(float) * num_channels);
580 sr_err("Analog data buffer malloc failed.");
581 devc->dev_state = STOPPING;
586 for (i = 0; i < num_samples; i++) {
588 * The device always sends data for both channels. If a channel
589 * is disabled, it contains a copy of the enabled channel's
590 * data. However, we only send the requested channels to
593 * Voltage values are encoded as a value 0-255, where the
594 * value is a point in the range represented by the vdiv
595 * setting. There are 10 vertical divs, so e.g. 500mV/div
596 * represents 5V peak-to-peak where 0 = -2.5V and 255 = +2.5V.
599 analog.data[data_offset++] = (ch1_bit * *(buf + i * 2) - ch1_center);
601 analog.data[data_offset++] = (ch2_bit * *(buf + i * 2 + 1) - ch2_center);
604 sr_session_send(sdi, &packet);
608 static void send_data(struct sr_dev_inst *sdi, struct libusb_transfer *buf[], uint64_t samples)
614 while (send < samples) {
615 chunk = MIN(samples - send, (uint64_t)(buf[i]->actual_length / NUM_CHANNELS));
617 send_chunk(sdi, buf[i]->buffer, chunk);
620 * Everything in this transfer was either copied to the buffer
621 * or sent to the session bus.
623 g_free(buf[i]->buffer);
624 libusb_free_transfer(buf[i]);
630 * Called by libusb (as triggered by handle_event()) when a transfer comes in.
631 * Only channel data comes in asynchronously, and all transfers for this are
632 * queued up beforehand, so this just needs to chuck the incoming data onto
633 * the libsigrok session bus.
635 static void LIBUSB_CALL receive_transfer(struct libusb_transfer *transfer)
637 struct sr_dev_inst *sdi;
638 struct dev_context *devc;
640 sdi = transfer->user_data;
643 if (devc->dev_state == FLUSH) {
644 g_free(transfer->buffer);
645 libusb_free_transfer(transfer);
646 devc->dev_state = CAPTURE;
647 devc->aq_started = g_get_monotonic_time();
648 read_channel(sdi, data_amount(sdi));
652 if (devc->dev_state != CAPTURE)
655 if (!devc->sample_buf) {
656 devc->sample_buf_size = 10;
657 devc->sample_buf = g_try_malloc(devc->sample_buf_size * sizeof(transfer));
658 devc->sample_buf_write = 0;
661 if (devc->sample_buf_write >= devc->sample_buf_size) {
662 devc->sample_buf_size += 10;
663 devc->sample_buf = g_try_realloc(devc->sample_buf,
664 devc->sample_buf_size * sizeof(transfer));
665 if (!devc->sample_buf) {
666 sr_err("Sample buffer malloc failed.");
667 devc->dev_state = STOPPING;
672 devc->sample_buf[devc->sample_buf_write++] = transfer;
673 devc->samp_received += transfer->actual_length / NUM_CHANNELS;
675 sr_spew("receive_transfer(): calculated samplerate == %" PRIu64 "ks/s",
676 (uint64_t)(transfer->actual_length * 1000 /
677 (g_get_monotonic_time() - devc->read_start_ts + 1) /
680 sr_spew("receive_transfer(): status %s received %d bytes.",
681 libusb_error_name(transfer->status), transfer->actual_length);
683 if (transfer->actual_length == 0)
684 /* Nothing to send to the bus. */
687 if (devc->limit_samples && devc->samp_received >= devc->limit_samples) {
688 sr_info("Requested number of samples reached, stopping. %"
689 PRIu64 " <= %" PRIu64, devc->limit_samples,
690 devc->samp_received);
691 send_data(sdi, devc->sample_buf, devc->limit_samples);
692 sdi->driver->dev_acquisition_stop(sdi);
693 } else if (devc->limit_msec && (g_get_monotonic_time() -
694 devc->aq_started) / 1000 >= devc->limit_msec) {
695 sr_info("Requested time limit reached, stopping. %d <= %d",
696 (uint32_t)devc->limit_msec,
697 (uint32_t)(g_get_monotonic_time() - devc->aq_started) / 1000);
698 send_data(sdi, devc->sample_buf, devc->samp_received);
699 g_free(devc->sample_buf);
700 devc->sample_buf = NULL;
701 sdi->driver->dev_acquisition_stop(sdi);
703 read_channel(sdi, data_amount(sdi));
707 static int read_channel(const struct sr_dev_inst *sdi, uint32_t amount)
710 struct dev_context *devc;
714 amount = MIN(amount, MAX_PACKET_SIZE);
715 ret = hantek_6xxx_get_channeldata(sdi, receive_transfer, amount);
716 devc->read_start_ts = g_get_monotonic_time();
717 devc->read_data_amount = amount;
722 static int handle_event(int fd, int revents, void *cb_data)
724 const struct sr_dev_inst *sdi;
726 struct sr_dev_driver *di;
727 struct dev_context *devc;
728 struct drv_context *drvc;
738 /* Always handle pending libusb events. */
739 tv.tv_sec = tv.tv_usec = 0;
740 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
742 if (devc->dev_state == STOPPING) {
743 /* We've been told to wind up the acquisition. */
744 sr_dbg("Stopping acquisition.");
746 hantek_6xxx_stop_data_collecting(sdi);
748 * TODO: Doesn't really cancel pending transfers so they might
749 * come in after SR_DF_END is sent.
751 usb_source_remove(sdi->session, drvc->sr_ctx);
753 std_session_send_df_end(sdi, LOG_PREFIX);
755 devc->dev_state = IDLE;
763 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
765 struct dev_context *devc;
766 struct sr_dev_driver *di = sdi->driver;
767 struct drv_context *drvc = di->context;
769 if (sdi->status != SR_ST_ACTIVE)
770 return SR_ERR_DEV_CLOSED;
774 if (configure_channels(sdi) != SR_OK) {
775 sr_err("Failed to configure channels.");
779 if (hantek_6xxx_init(sdi) != SR_OK)
782 std_session_send_df_header(sdi, LOG_PREFIX);
784 devc->samp_received = 0;
785 devc->dev_state = FLUSH;
787 usb_source_add(sdi->session, drvc->sr_ctx, TICK,
788 handle_event, (void *)sdi);
790 hantek_6xxx_start_data_collecting(sdi);
792 read_channel(sdi, FLUSH_PACKET_SIZE);
797 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
799 struct dev_context *devc;
801 if (sdi->status != SR_ST_ACTIVE)
805 devc->dev_state = STOPPING;
807 g_free(devc->sample_buf); devc->sample_buf = NULL;
812 SR_PRIV struct sr_dev_driver hantek_6xxx_driver_info = {
813 .name = "hantek-6xxx",
814 .longname = "Hantek 6xxx",
817 .cleanup = std_cleanup,
819 .dev_list = std_dev_list,
820 .dev_clear = dev_clear,
821 .config_get = config_get,
822 .config_set = config_set,
823 .config_list = config_list,
824 .dev_open = dev_open,
825 .dev_close = dev_close,
826 .dev_acquisition_start = dev_acquisition_start,
827 .dev_acquisition_stop = dev_acquisition_stop,