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(struct dev_context *devc)
161 g_slist_free(devc->enabled_channels);
164 static int dev_clear(const struct sr_dev_driver *di)
166 return std_dev_clear_with_callback(di, (std_dev_clear_callback)clear_helper);
169 static GSList *scan(struct sr_dev_driver *di, GSList *options)
171 struct drv_context *drvc;
172 struct dev_context *devc;
173 struct sr_dev_inst *sdi;
174 struct sr_usb_dev_inst *usb;
175 struct sr_config *src;
176 const struct hantek_6xxx_profile *prof;
177 GSList *l, *devices, *conn_devices;
178 struct libusb_device_descriptor des;
179 libusb_device **devlist;
182 char connection_id[64];
189 for (l = options; l; l = l->next) {
191 if (src->key == SR_CONF_CONN) {
192 conn = g_variant_get_string(src->data, NULL);
197 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
201 /* Find all Hantek 60xx devices and upload firmware to all of them. */
202 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
203 for (i = 0; devlist[i]; i++) {
206 for (l = conn_devices; l; l = l->next) {
208 if (usb->bus == libusb_get_bus_number(devlist[i])
209 && usb->address == libusb_get_device_address(devlist[i]))
213 /* This device matched none of the ones that
214 * matched the conn specification. */
218 libusb_get_device_descriptor(devlist[i], &des);
220 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
223 for (j = 0; dev_profiles[j].orig_vid; j++) {
224 if (des.idVendor == dev_profiles[j].orig_vid
225 && des.idProduct == dev_profiles[j].orig_pid) {
226 /* Device matches the pre-firmware profile. */
227 prof = &dev_profiles[j];
228 sr_dbg("Found a %s %s.", prof->vendor, prof->model);
229 sdi = hantek_6xxx_dev_new(prof);
230 sdi->connection_id = g_strdup(connection_id);
231 devices = g_slist_append(devices, sdi);
233 if (ezusb_upload_firmware(drvc->sr_ctx, devlist[i],
234 USB_CONFIGURATION, prof->firmware) == SR_OK)
235 /* Remember when the firmware on this device was updated. */
236 devc->fw_updated = g_get_monotonic_time();
238 sr_err("Firmware upload failed.");
239 /* Dummy USB address of 0xff will get overwritten later. */
240 sdi->conn = sr_usb_dev_inst_new(
241 libusb_get_bus_number(devlist[i]), 0xff, NULL);
243 } else if (des.idVendor == dev_profiles[j].fw_vid
244 && des.idProduct == dev_profiles[j].fw_pid
245 && des.bcdDevice == dev_profiles[j].fw_prod_ver) {
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);
266 return std_scan_complete(di, devices);
269 static int dev_open(struct sr_dev_inst *sdi)
271 struct dev_context *devc;
272 struct sr_usb_dev_inst *usb;
273 int64_t timediff_us, timediff_ms;
280 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
281 * for the FX2 to renumerate.
284 if (devc->fw_updated > 0) {
285 sr_info("Waiting for device to reset.");
286 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
287 g_usleep(300 * 1000);
289 while (timediff_ms < MAX_RENUM_DELAY_MS) {
290 if ((err = hantek_6xxx_open(sdi)) == SR_OK)
292 g_usleep(100 * 1000);
293 timediff_us = g_get_monotonic_time() - devc->fw_updated;
294 timediff_ms = timediff_us / 1000;
295 sr_spew("Waited %" PRIi64 " ms.", timediff_ms);
297 if (timediff_ms < MAX_RENUM_DELAY_MS)
298 sr_info("Device came back after %"PRIu64" ms.", timediff_ms);
300 err = hantek_6xxx_open(sdi);
304 sr_err("Unable to open device.");
308 err = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
310 sr_err("Unable to claim interface: %s.",
311 libusb_error_name(err));
318 static int dev_close(struct sr_dev_inst *sdi)
320 hantek_6xxx_close(sdi);
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]);
381 case SR_CONF_COUPLING:
382 *data = g_variant_new_string((devc->coupling[ch_idx] \
383 == COUPLING_DC) ? "DC" : "AC");
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;
403 case SR_CONF_SAMPLERATE:
404 devc->samplerate = g_variant_get_uint64(data);
405 hantek_6xxx_update_samplerate(sdi);
407 case SR_CONF_LIMIT_MSEC:
408 devc->limit_msec = g_variant_get_uint64(data);
410 case SR_CONF_LIMIT_SAMPLES:
411 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);
439 case SR_CONF_COUPLING:
440 tmp_str = g_variant_get_string(data, NULL);
441 for (i = 0; i < devc->coupling_tab_size; i++) {
442 if (!strcmp(tmp_str, devc->coupling_vals[i])) {
443 devc->coupling[ch_idx] = i;
447 if (i == devc->coupling_tab_size)
458 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
459 const struct sr_channel_group *cg)
461 GVariant *tuple, *rational[2];
465 struct dev_context *devc;
467 devc = (sdi) ? sdi->priv : NULL;
471 case SR_CONF_SCAN_OPTIONS:
472 case SR_CONF_DEVICE_OPTIONS:
473 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
474 case SR_CONF_SAMPLERATE:
475 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
476 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
477 samplerates, ARRAY_SIZE(samplerates),
479 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
480 *data = g_variant_builder_end(&gvb);
487 case SR_CONF_DEVICE_OPTIONS:
488 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
489 devopts_cg, ARRAY_SIZE(devopts_cg), sizeof(uint32_t));
491 case SR_CONF_COUPLING:
492 *data = g_variant_new_strv(devc->coupling_vals, devc->coupling_tab_size);
495 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
496 for (i = 0; i < ARRAY_SIZE(vdivs); i++) {
497 rational[0] = g_variant_new_uint64(vdivs[i][0]);
498 rational[1] = g_variant_new_uint64(vdivs[i][1]);
499 tuple = g_variant_new_tuple(rational, 2);
500 g_variant_builder_add_value(&gvb, tuple);
502 *data = g_variant_builder_end(&gvb);
512 /* Minimise data amount for limit_samples and limit_msec limits. */
513 static uint32_t data_amount(const struct sr_dev_inst *sdi)
515 struct dev_context *devc = sdi->priv;
516 uint32_t data_left, data_left_2, i;
519 if (devc->limit_msec) {
520 time_left = devc->limit_msec - (g_get_monotonic_time() - devc->aq_started) / 1000;
521 data_left = devc->samplerate * MAX(time_left, 0) * NUM_CHANNELS / 1000;
522 } else if (devc->limit_samples) {
523 data_left = (devc->limit_samples - devc->samp_received) * NUM_CHANNELS;
525 data_left = devc->samplerate * NUM_CHANNELS;
528 /* Round up to nearest power of two. */
529 for (i = MIN_PACKET_SIZE; i < data_left; i *= 2)
533 sr_spew("data_amount: %u (rounded to power of 2: %u)", data_left, data_left_2);
538 static void send_chunk(struct sr_dev_inst *sdi, unsigned char *buf,
541 struct sr_datafeed_packet packet;
542 struct sr_datafeed_analog analog;
543 struct sr_analog_encoding encoding;
544 struct sr_analog_meaning meaning;
545 struct sr_analog_spec spec;
546 struct dev_context *devc = sdi->priv;
547 GSList *channels = devc->enabled_channels;
549 const float ch_bit[] = { RANGE(0) / 255, RANGE(1) / 255 };
550 const float ch_center[] = { RANGE(0) / 2, RANGE(1) / 2 };
552 sr_analog_init(&analog, &encoding, &meaning, &spec, 0);
554 packet.type = SR_DF_ANALOG;
555 packet.payload = &analog;
557 analog.num_samples = num_samples;
558 analog.meaning->mq = SR_MQ_VOLTAGE;
559 analog.meaning->unit = SR_UNIT_VOLT;
560 analog.meaning->mqflags = 0;
562 analog.data = g_try_malloc(num_samples * sizeof(float));
564 sr_err("Analog data buffer malloc failed.");
565 devc->dev_state = STOPPING;
569 for (int ch = 0; ch < 2; ch++) {
570 if (!devc->ch_enabled[ch])
573 float vdivlog = log10f(ch_bit[ch]);
574 int digits = -(int)vdivlog + (vdivlog < 0.0);
575 analog.encoding->digits = digits;
576 analog.spec->spec_digits = digits;
577 analog.meaning->channels = g_slist_append(NULL, channels->data);
579 for (int i = 0; i < num_samples; i++) {
581 * The device always sends data for both channels. If a channel
582 * is disabled, it contains a copy of the enabled channel's
583 * data. However, we only send the requested channels to
586 * Voltage values are encoded as a value 0-255, where the
587 * value is a point in the range represented by the vdiv
588 * setting. There are 10 vertical divs, so e.g. 500mV/div
589 * represents 5V peak-to-peak where 0 = -2.5V and 255 = +2.5V.
591 ((float *)analog.data)[i] = ch_bit[ch] * *(buf + i * 2 + ch) - ch_center[ch];
594 sr_session_send(sdi, &packet);
595 g_slist_free(analog.meaning->channels);
597 channels = channels->next;
602 static void send_data(struct sr_dev_inst *sdi, struct libusb_transfer *buf[], uint64_t samples)
608 while (send < samples) {
609 chunk = MIN(samples - send, (uint64_t)(buf[i]->actual_length / NUM_CHANNELS));
611 send_chunk(sdi, buf[i]->buffer, chunk);
614 * Everything in this transfer was either copied to the buffer
615 * or sent to the session bus.
617 g_free(buf[i]->buffer);
618 libusb_free_transfer(buf[i]);
624 * Called by libusb (as triggered by handle_event()) when a transfer comes in.
625 * Only channel data comes in asynchronously, and all transfers for this are
626 * queued up beforehand, so this just needs to chuck the incoming data onto
627 * the libsigrok session bus.
629 static void LIBUSB_CALL receive_transfer(struct libusb_transfer *transfer)
631 struct sr_dev_inst *sdi;
632 struct dev_context *devc;
634 sdi = transfer->user_data;
637 if (devc->dev_state == FLUSH) {
638 g_free(transfer->buffer);
639 libusb_free_transfer(transfer);
640 devc->dev_state = CAPTURE;
641 devc->aq_started = g_get_monotonic_time();
642 read_channel(sdi, data_amount(sdi));
646 if (devc->dev_state != CAPTURE)
649 if (!devc->sample_buf) {
650 devc->sample_buf_size = 10;
651 devc->sample_buf = g_try_malloc(devc->sample_buf_size * sizeof(transfer));
652 devc->sample_buf_write = 0;
655 if (devc->sample_buf_write >= devc->sample_buf_size) {
656 devc->sample_buf_size += 10;
657 devc->sample_buf = g_try_realloc(devc->sample_buf,
658 devc->sample_buf_size * sizeof(transfer));
659 if (!devc->sample_buf) {
660 sr_err("Sample buffer malloc failed.");
661 devc->dev_state = STOPPING;
666 devc->sample_buf[devc->sample_buf_write++] = transfer;
667 devc->samp_received += transfer->actual_length / NUM_CHANNELS;
669 sr_spew("receive_transfer(): calculated samplerate == %" PRIu64 "ks/s",
670 (uint64_t)(transfer->actual_length * 1000 /
671 (g_get_monotonic_time() - devc->read_start_ts + 1) /
674 sr_spew("receive_transfer(): status %s received %d bytes.",
675 libusb_error_name(transfer->status), transfer->actual_length);
677 if (transfer->actual_length == 0)
678 /* Nothing to send to the bus. */
681 if (devc->limit_samples && devc->samp_received >= devc->limit_samples) {
682 sr_info("Requested number of samples reached, stopping. %"
683 PRIu64 " <= %" PRIu64, devc->limit_samples,
684 devc->samp_received);
685 send_data(sdi, devc->sample_buf, devc->limit_samples);
686 sr_dev_acquisition_stop(sdi);
687 } else if (devc->limit_msec && (g_get_monotonic_time() -
688 devc->aq_started) / 1000 >= devc->limit_msec) {
689 sr_info("Requested time limit reached, stopping. %d <= %d",
690 (uint32_t)devc->limit_msec,
691 (uint32_t)(g_get_monotonic_time() - devc->aq_started) / 1000);
692 send_data(sdi, devc->sample_buf, devc->samp_received);
693 g_free(devc->sample_buf);
694 devc->sample_buf = NULL;
695 sr_dev_acquisition_stop(sdi);
697 read_channel(sdi, data_amount(sdi));
701 static int read_channel(const struct sr_dev_inst *sdi, uint32_t amount)
704 struct dev_context *devc;
708 amount = MIN(amount, MAX_PACKET_SIZE);
709 ret = hantek_6xxx_get_channeldata(sdi, receive_transfer, amount);
710 devc->read_start_ts = g_get_monotonic_time();
711 devc->read_data_amount = amount;
716 static int handle_event(int fd, int revents, void *cb_data)
718 const struct sr_dev_inst *sdi;
720 struct sr_dev_driver *di;
721 struct dev_context *devc;
722 struct drv_context *drvc;
732 /* Always handle pending libusb events. */
733 tv.tv_sec = tv.tv_usec = 0;
734 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
736 if (devc->dev_state == STOPPING) {
737 /* We've been told to wind up the acquisition. */
738 sr_dbg("Stopping acquisition.");
740 hantek_6xxx_stop_data_collecting(sdi);
742 * TODO: Doesn't really cancel pending transfers so they might
743 * come in after SR_DF_END is sent.
745 usb_source_remove(sdi->session, drvc->sr_ctx);
747 std_session_send_df_end(sdi);
749 devc->dev_state = IDLE;
757 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
759 struct dev_context *devc;
760 struct sr_dev_driver *di = sdi->driver;
761 struct drv_context *drvc = di->context;
765 if (configure_channels(sdi) != SR_OK) {
766 sr_err("Failed to configure channels.");
770 if (hantek_6xxx_init(sdi) != SR_OK)
773 std_session_send_df_header(sdi);
775 devc->samp_received = 0;
776 devc->dev_state = FLUSH;
778 usb_source_add(sdi->session, drvc->sr_ctx, TICK,
779 handle_event, (void *)sdi);
781 hantek_6xxx_start_data_collecting(sdi);
783 read_channel(sdi, FLUSH_PACKET_SIZE);
788 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
790 struct dev_context *devc;
793 devc->dev_state = STOPPING;
795 g_free(devc->sample_buf);
796 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);