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/>.
24 /* Max time in ms before we want to check on USB events */
27 #define RANGE(ch) (((float)vdivs[devc->voltage[ch]][0] / vdivs[devc->voltage[ch]][1]) * VDIV_MULTIPLIER)
29 static const uint32_t scanopts[] = {
33 static const uint32_t drvopts[] = {
37 static const uint32_t devopts[] = {
38 SR_CONF_CONN | SR_CONF_GET,
39 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
40 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
41 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
42 SR_CONF_NUM_VDIV | SR_CONF_GET,
45 static const uint32_t devopts_cg[] = {
46 SR_CONF_VDIV | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
47 SR_CONF_COUPLING | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
50 static const char *channel_names[] = {
54 static const char *dc_coupling[] = {
58 static const char *acdc_coupling[] = {
62 static const struct hantek_6xxx_profile dev_profiles[] = {
64 0x04b4, 0x6022, 0x1d50, 0x608e, 0x0001,
65 "Hantek", "6022BE", "fx2lafw-hantek-6022be.fw",
66 dc_coupling, ARRAY_SIZE(dc_coupling), FALSE,
69 0x8102, 0x8102, 0x1d50, 0x608e, 0x0002,
70 "Sainsmart", "DDS120", "fx2lafw-sainsmart-dds120.fw",
71 acdc_coupling, ARRAY_SIZE(acdc_coupling), TRUE,
74 0x04b4, 0x602a, 0x1d50, 0x608e, 0x0003,
75 "Hantek", "6022BL", "fx2lafw-hantek-6022bl.fw",
76 dc_coupling, ARRAY_SIZE(dc_coupling), FALSE,
81 static const uint64_t samplerates[] = {
85 static const uint64_t vdivs[][2] = {
89 static int read_channel(const struct sr_dev_inst *sdi, uint32_t amount);
91 static struct sr_dev_inst *hantek_6xxx_dev_new(const struct hantek_6xxx_profile *prof)
93 struct sr_dev_inst *sdi;
94 struct sr_channel *ch;
95 struct sr_channel_group *cg;
96 struct dev_context *devc;
99 sdi = g_malloc0(sizeof(struct sr_dev_inst));
100 sdi->status = SR_ST_INITIALIZING;
101 sdi->vendor = g_strdup(prof->vendor);
102 sdi->model = g_strdup(prof->model);
104 for (i = 0; i < ARRAY_SIZE(channel_names); i++) {
105 ch = sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, TRUE, channel_names[i]);
106 cg = g_malloc0(sizeof(struct sr_channel_group));
107 cg->name = g_strdup(channel_names[i]);
108 cg->channels = g_slist_append(cg->channels, ch);
109 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
112 devc = g_malloc0(sizeof(struct dev_context));
114 for (i = 0; i < NUM_CHANNELS; i++) {
115 devc->ch_enabled[i] = TRUE;
116 devc->voltage[i] = DEFAULT_VOLTAGE;
117 devc->coupling[i] = DEFAULT_COUPLING;
119 devc->coupling_vals = prof->coupling_vals;
120 devc->coupling_tab_size = prof->coupling_tab_size;
121 devc->has_coupling = prof->has_coupling;
123 devc->sample_buf = NULL;
124 devc->sample_buf_write = 0;
125 devc->sample_buf_size = 0;
127 devc->profile = prof;
128 devc->dev_state = IDLE;
129 devc->samplerate = DEFAULT_SAMPLERATE;
136 static int configure_channels(const struct sr_dev_inst *sdi)
138 struct dev_context *devc;
141 struct sr_channel *ch;
144 g_slist_free(devc->enabled_channels);
145 devc->enabled_channels = NULL;
146 memset(devc->ch_enabled, 0, sizeof(devc->ch_enabled));
148 for (l = sdi->channels, p = 0; l; l = l->next, p++) {
150 if (p < NUM_CHANNELS) {
151 devc->ch_enabled[p] = ch->enabled;
152 devc->enabled_channels = g_slist_append(devc->enabled_channels, ch);
159 static void clear_helper(void *priv)
161 struct dev_context *devc;
164 g_slist_free(devc->enabled_channels);
168 static int dev_clear(const struct sr_dev_driver *di)
170 return std_dev_clear_with_callback(di, clear_helper);
173 static GSList *scan(struct sr_dev_driver *di, GSList *options)
175 struct drv_context *drvc;
176 struct dev_context *devc;
177 struct sr_dev_inst *sdi;
178 struct sr_usb_dev_inst *usb;
179 struct sr_config *src;
180 const struct hantek_6xxx_profile *prof;
181 GSList *l, *devices, *conn_devices;
182 struct libusb_device_descriptor des;
183 libusb_device **devlist;
186 char connection_id[64];
193 for (l = options; l; l = l->next) {
195 if (src->key == SR_CONF_CONN) {
196 conn = g_variant_get_string(src->data, NULL);
201 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
205 /* Find all Hantek 60xx devices and upload firmware to all of them. */
206 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
207 for (i = 0; devlist[i]; i++) {
210 for (l = conn_devices; l; l = l->next) {
212 if (usb->bus == libusb_get_bus_number(devlist[i])
213 && usb->address == libusb_get_device_address(devlist[i]))
217 /* This device matched none of the ones that
218 * matched the conn specification. */
222 libusb_get_device_descriptor(devlist[i], &des);
224 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
227 for (j = 0; dev_profiles[j].orig_vid; j++) {
228 if (des.idVendor == dev_profiles[j].orig_vid
229 && des.idProduct == dev_profiles[j].orig_pid) {
230 /* Device matches the pre-firmware profile. */
231 prof = &dev_profiles[j];
232 sr_dbg("Found a %s %s.", prof->vendor, prof->model);
233 sdi = hantek_6xxx_dev_new(prof);
234 sdi->connection_id = g_strdup(connection_id);
235 devices = g_slist_append(devices, sdi);
237 if (ezusb_upload_firmware(drvc->sr_ctx, devlist[i],
238 USB_CONFIGURATION, prof->firmware) == SR_OK)
239 /* Remember when the firmware on this device was updated. */
240 devc->fw_updated = g_get_monotonic_time();
242 sr_err("Firmware upload failed.");
243 /* Dummy USB address of 0xff will get overwritten later. */
244 sdi->conn = sr_usb_dev_inst_new(
245 libusb_get_bus_number(devlist[i]), 0xff, NULL);
247 } else if (des.idVendor == dev_profiles[j].fw_vid
248 && des.idProduct == dev_profiles[j].fw_pid
249 && des.bcdDevice == dev_profiles[j].fw_prod_ver) {
250 /* Device matches the post-firmware profile. */
251 prof = &dev_profiles[j];
252 sr_dbg("Found a %s %s.", prof->vendor, prof->model);
253 sdi = hantek_6xxx_dev_new(prof);
254 sdi->connection_id = g_strdup(connection_id);
255 sdi->status = SR_ST_INACTIVE;
256 devices = g_slist_append(devices, sdi);
257 sdi->inst_type = SR_INST_USB;
258 sdi->conn = sr_usb_dev_inst_new(
259 libusb_get_bus_number(devlist[i]),
260 libusb_get_device_address(devlist[i]), NULL);
265 /* Not a supported VID/PID. */
268 libusb_free_device_list(devlist, 1);
270 return std_scan_complete(di, devices);
273 static int dev_open(struct sr_dev_inst *sdi)
275 struct dev_context *devc;
276 struct sr_usb_dev_inst *usb;
277 int64_t timediff_us, timediff_ms;
284 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
285 * for the FX2 to renumerate.
288 if (devc->fw_updated > 0) {
289 sr_info("Waiting for device to reset.");
290 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
291 g_usleep(300 * 1000);
293 while (timediff_ms < MAX_RENUM_DELAY_MS) {
294 if ((err = hantek_6xxx_open(sdi)) == SR_OK)
296 g_usleep(100 * 1000);
297 timediff_us = g_get_monotonic_time() - devc->fw_updated;
298 timediff_ms = timediff_us / 1000;
299 sr_spew("Waited %" PRIi64 " ms.", timediff_ms);
301 if (timediff_ms < MAX_RENUM_DELAY_MS)
302 sr_info("Device came back after %"PRIu64" ms.", timediff_ms);
304 err = hantek_6xxx_open(sdi);
308 sr_err("Unable to open device.");
312 err = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
314 sr_err("Unable to claim interface: %s.",
315 libusb_error_name(err));
322 static int dev_close(struct sr_dev_inst *sdi)
324 hantek_6xxx_close(sdi);
329 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
330 const struct sr_channel_group *cg)
332 struct dev_context *devc;
333 struct sr_usb_dev_inst *usb;
335 const uint64_t *vdiv;
339 case SR_CONF_NUM_VDIV:
340 *data = g_variant_new_int32(ARRAY_SIZE(vdivs));
350 case SR_CONF_SAMPLERATE:
351 *data = g_variant_new_uint64(devc->samplerate);
353 case SR_CONF_LIMIT_MSEC:
354 *data = g_variant_new_uint64(devc->limit_msec);
356 case SR_CONF_LIMIT_SAMPLES:
357 *data = g_variant_new_uint64(devc->limit_samples);
363 if (usb->address == 255)
364 /* Device still needs to re-enumerate after firmware
365 * upload, so we don't know its (future) address. */
367 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
368 *data = g_variant_new_string(str);
374 if (sdi->channel_groups->data == cg)
376 else if (sdi->channel_groups->next->data == cg)
382 vdiv = vdivs[devc->voltage[ch_idx]];
383 *data = g_variant_new("(tt)", vdiv[0], vdiv[1]);
385 case SR_CONF_COUPLING:
386 *data = g_variant_new_string((devc->coupling[ch_idx] \
387 == COUPLING_DC) ? "DC" : "AC");
395 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
396 const struct sr_channel_group *cg)
398 struct dev_context *devc;
400 int tmp_int, ch_idx, ret;
408 case SR_CONF_SAMPLERATE:
409 devc->samplerate = g_variant_get_uint64(data);
410 hantek_6xxx_update_samplerate(sdi);
412 case SR_CONF_LIMIT_MSEC:
413 devc->limit_msec = g_variant_get_uint64(data);
415 case SR_CONF_LIMIT_SAMPLES:
416 devc->limit_samples = g_variant_get_uint64(data);
423 if (sdi->channel_groups->data == cg)
425 else if (sdi->channel_groups->next->data == cg)
431 g_variant_get(data, "(tt)", &p, &q);
433 for (i = 0; i < ARRAY_SIZE(vdivs); i++) {
434 if (vdivs[i][0] == p && vdivs[i][1] == q) {
440 devc->voltage[ch_idx] = tmp_int;
441 hantek_6xxx_update_vdiv(sdi);
445 case SR_CONF_COUPLING:
446 tmp_str = g_variant_get_string(data, NULL);
447 for (i = 0; i < devc->coupling_tab_size; i++) {
448 if (!strcmp(tmp_str, devc->coupling_vals[i])) {
449 devc->coupling[ch_idx] = i;
453 if (i == devc->coupling_tab_size)
465 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
466 const struct sr_channel_group *cg)
468 GVariant *tuple, *rational[2];
472 struct dev_context *devc = NULL;
474 if (key == SR_CONF_SCAN_OPTIONS) {
475 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
476 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
478 } else if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
479 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
480 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
489 case SR_CONF_DEVICE_OPTIONS:
490 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
491 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
493 case SR_CONF_SAMPLERATE:
494 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
495 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
496 samplerates, ARRAY_SIZE(samplerates),
498 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
499 *data = g_variant_builder_end(&gvb);
506 case SR_CONF_DEVICE_OPTIONS:
507 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
508 devopts_cg, ARRAY_SIZE(devopts_cg), sizeof(uint32_t));
510 case SR_CONF_COUPLING:
513 *data = g_variant_new_strv(devc->coupling_vals, devc->coupling_tab_size);
516 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
517 for (i = 0; i < ARRAY_SIZE(vdivs); i++) {
518 rational[0] = g_variant_new_uint64(vdivs[i][0]);
519 rational[1] = g_variant_new_uint64(vdivs[i][1]);
520 tuple = g_variant_new_tuple(rational, 2);
521 g_variant_builder_add_value(&gvb, tuple);
523 *data = g_variant_builder_end(&gvb);
533 /* Minimise data amount for limit_samples and limit_msec limits. */
534 static uint32_t data_amount(const struct sr_dev_inst *sdi)
536 struct dev_context *devc = sdi->priv;
537 uint32_t data_left, data_left_2, i;
540 if (devc->limit_msec) {
541 time_left = devc->limit_msec - (g_get_monotonic_time() - devc->aq_started) / 1000;
542 data_left = devc->samplerate * MAX(time_left, 0) * NUM_CHANNELS / 1000;
543 } else if (devc->limit_samples) {
544 data_left = (devc->limit_samples - devc->samp_received) * NUM_CHANNELS;
546 data_left = devc->samplerate * NUM_CHANNELS;
549 /* Round up to nearest power of two. */
550 for (i = MIN_PACKET_SIZE; i < data_left; i *= 2)
554 sr_spew("data_amount: %u (rounded to power of 2: %u)", data_left, data_left_2);
559 static void send_chunk(struct sr_dev_inst *sdi, unsigned char *buf,
562 struct sr_datafeed_packet packet;
563 struct sr_datafeed_analog analog;
564 struct sr_analog_encoding encoding;
565 struct sr_analog_meaning meaning;
566 struct sr_analog_spec spec;
567 struct dev_context *devc = sdi->priv;
568 GSList *channels = devc->enabled_channels;
570 const float ch_bit[] = { RANGE(0) / 255, RANGE(1) / 255 };
571 const float ch_center[] = { RANGE(0) / 2, RANGE(1) / 2 };
573 sr_analog_init(&analog, &encoding, &meaning, &spec, 0);
575 packet.type = SR_DF_ANALOG;
576 packet.payload = &analog;
578 analog.num_samples = num_samples;
579 analog.meaning->mq = SR_MQ_VOLTAGE;
580 analog.meaning->unit = SR_UNIT_VOLT;
581 analog.meaning->mqflags = 0;
583 analog.data = g_try_malloc(num_samples * sizeof(float));
585 sr_err("Analog data buffer malloc failed.");
586 devc->dev_state = STOPPING;
590 for (int ch = 0; ch < 2; ch++) {
591 if (!devc->ch_enabled[ch])
594 float vdivlog = log10f(ch_bit[ch]);
595 int digits = -(int)vdivlog + (vdivlog < 0.0);
596 analog.encoding->digits = digits;
597 analog.spec->spec_digits = digits;
598 analog.meaning->channels = g_slist_append(NULL, channels->data);
600 for (int i = 0; i < num_samples; i++) {
602 * The device always sends data for both channels. If a channel
603 * is disabled, it contains a copy of the enabled channel's
604 * data. However, we only send the requested channels to
607 * Voltage values are encoded as a value 0-255, where the
608 * value is a point in the range represented by the vdiv
609 * setting. There are 10 vertical divs, so e.g. 500mV/div
610 * represents 5V peak-to-peak where 0 = -2.5V and 255 = +2.5V.
612 ((float *)analog.data)[i] = ch_bit[ch] * *(buf + i * 2 + ch) - ch_center[ch];
615 sr_session_send(sdi, &packet);
616 g_slist_free(analog.meaning->channels);
618 channels = channels->next;
623 static void send_data(struct sr_dev_inst *sdi, struct libusb_transfer *buf[], uint64_t samples)
629 while (send < samples) {
630 chunk = MIN(samples - send, (uint64_t)(buf[i]->actual_length / NUM_CHANNELS));
632 send_chunk(sdi, buf[i]->buffer, chunk);
635 * Everything in this transfer was either copied to the buffer
636 * or sent to the session bus.
638 g_free(buf[i]->buffer);
639 libusb_free_transfer(buf[i]);
645 * Called by libusb (as triggered by handle_event()) when a transfer comes in.
646 * Only channel data comes in asynchronously, and all transfers for this are
647 * queued up beforehand, so this just needs to chuck the incoming data onto
648 * the libsigrok session bus.
650 static void LIBUSB_CALL receive_transfer(struct libusb_transfer *transfer)
652 struct sr_dev_inst *sdi;
653 struct dev_context *devc;
655 sdi = transfer->user_data;
658 if (devc->dev_state == FLUSH) {
659 g_free(transfer->buffer);
660 libusb_free_transfer(transfer);
661 devc->dev_state = CAPTURE;
662 devc->aq_started = g_get_monotonic_time();
663 read_channel(sdi, data_amount(sdi));
667 if (devc->dev_state != CAPTURE)
670 if (!devc->sample_buf) {
671 devc->sample_buf_size = 10;
672 devc->sample_buf = g_try_malloc(devc->sample_buf_size * sizeof(transfer));
673 devc->sample_buf_write = 0;
676 if (devc->sample_buf_write >= devc->sample_buf_size) {
677 devc->sample_buf_size += 10;
678 devc->sample_buf = g_try_realloc(devc->sample_buf,
679 devc->sample_buf_size * sizeof(transfer));
680 if (!devc->sample_buf) {
681 sr_err("Sample buffer malloc failed.");
682 devc->dev_state = STOPPING;
687 devc->sample_buf[devc->sample_buf_write++] = transfer;
688 devc->samp_received += transfer->actual_length / NUM_CHANNELS;
690 sr_spew("receive_transfer(): calculated samplerate == %" PRIu64 "ks/s",
691 (uint64_t)(transfer->actual_length * 1000 /
692 (g_get_monotonic_time() - devc->read_start_ts + 1) /
695 sr_spew("receive_transfer(): status %s received %d bytes.",
696 libusb_error_name(transfer->status), transfer->actual_length);
698 if (transfer->actual_length == 0)
699 /* Nothing to send to the bus. */
702 if (devc->limit_samples && devc->samp_received >= devc->limit_samples) {
703 sr_info("Requested number of samples reached, stopping. %"
704 PRIu64 " <= %" PRIu64, devc->limit_samples,
705 devc->samp_received);
706 send_data(sdi, devc->sample_buf, devc->limit_samples);
707 sr_dev_acquisition_stop(sdi);
708 } else if (devc->limit_msec && (g_get_monotonic_time() -
709 devc->aq_started) / 1000 >= devc->limit_msec) {
710 sr_info("Requested time limit reached, stopping. %d <= %d",
711 (uint32_t)devc->limit_msec,
712 (uint32_t)(g_get_monotonic_time() - devc->aq_started) / 1000);
713 send_data(sdi, devc->sample_buf, devc->samp_received);
714 g_free(devc->sample_buf);
715 devc->sample_buf = NULL;
716 sr_dev_acquisition_stop(sdi);
718 read_channel(sdi, data_amount(sdi));
722 static int read_channel(const struct sr_dev_inst *sdi, uint32_t amount)
725 struct dev_context *devc;
729 amount = MIN(amount, MAX_PACKET_SIZE);
730 ret = hantek_6xxx_get_channeldata(sdi, receive_transfer, amount);
731 devc->read_start_ts = g_get_monotonic_time();
732 devc->read_data_amount = amount;
737 static int handle_event(int fd, int revents, void *cb_data)
739 const struct sr_dev_inst *sdi;
741 struct sr_dev_driver *di;
742 struct dev_context *devc;
743 struct drv_context *drvc;
753 /* Always handle pending libusb events. */
754 tv.tv_sec = tv.tv_usec = 0;
755 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
757 if (devc->dev_state == STOPPING) {
758 /* We've been told to wind up the acquisition. */
759 sr_dbg("Stopping acquisition.");
761 hantek_6xxx_stop_data_collecting(sdi);
763 * TODO: Doesn't really cancel pending transfers so they might
764 * come in after SR_DF_END is sent.
766 usb_source_remove(sdi->session, drvc->sr_ctx);
768 std_session_send_df_end(sdi);
770 devc->dev_state = IDLE;
778 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
780 struct dev_context *devc;
781 struct sr_dev_driver *di = sdi->driver;
782 struct drv_context *drvc = di->context;
786 if (configure_channels(sdi) != SR_OK) {
787 sr_err("Failed to configure channels.");
791 if (hantek_6xxx_init(sdi) != SR_OK)
794 std_session_send_df_header(sdi);
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)
811 struct dev_context *devc;
814 devc->dev_state = STOPPING;
816 g_free(devc->sample_buf);
817 devc->sample_buf = NULL;
822 static struct sr_dev_driver hantek_6xxx_driver_info = {
823 .name = "hantek-6xxx",
824 .longname = "Hantek 6xxx",
827 .cleanup = std_cleanup,
829 .dev_list = std_dev_list,
830 .dev_clear = dev_clear,
831 .config_get = config_get,
832 .config_set = config_set,
833 .config_list = config_list,
834 .dev_open = dev_open,
835 .dev_close = dev_close,
836 .dev_acquisition_start = dev_acquisition_start,
837 .dev_acquisition_stop = dev_acquisition_stop,
840 SR_REGISTER_DEV_DRIVER(hantek_6xxx_driver_info);