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_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
40 SR_CONF_NUM_VDIV | SR_CONF_GET,
41 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
42 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
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, 0x04b5, 0x6022,
65 "Hantek", "6022BE", "hantek-6022be.fw",
66 dc_coupling, ARRAY_SIZE(dc_coupling), FALSE,
69 0x8102, 0x8102, 0x1D50, 0x608E,
70 "Sainsmart", "DDS120", "sainsmart-dds120.fw",
71 acdc_coupling, ARRAY_SIZE(acdc_coupling), TRUE,
76 static const uint64_t samplerates[] = {
80 static const uint64_t vdivs[][2] = {
84 static int read_channel(const struct sr_dev_inst *sdi, uint32_t amount);
86 static int dev_acquisition_stop(struct sr_dev_inst *sdi);
88 static struct sr_dev_inst *hantek_6xxx_dev_new(const struct hantek_6xxx_profile *prof)
90 struct sr_dev_inst *sdi;
91 struct sr_channel *ch;
92 struct sr_channel_group *cg;
93 struct dev_context *devc;
96 sdi = g_malloc0(sizeof(struct sr_dev_inst));
97 sdi->status = SR_ST_INITIALIZING;
98 sdi->vendor = g_strdup(prof->vendor);
99 sdi->model = g_strdup(prof->model);
101 for (i = 0; i < ARRAY_SIZE(channel_names); i++) {
102 ch = sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, TRUE, channel_names[i]);
103 cg = g_malloc0(sizeof(struct sr_channel_group));
104 cg->name = g_strdup(channel_names[i]);
105 cg->channels = g_slist_append(cg->channels, ch);
106 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
109 devc = g_malloc0(sizeof(struct dev_context));
111 for (i = 0; i < NUM_CHANNELS; i++) {
112 devc->ch_enabled[i] = TRUE;
113 devc->voltage[i] = DEFAULT_VOLTAGE;
114 devc->coupling[i] = DEFAULT_COUPLING;
116 devc->coupling_vals = prof->coupling_vals;
117 devc->coupling_tab_size = prof->coupling_tab_size;
119 devc->sample_buf = NULL;
120 devc->sample_buf_write = 0;
121 devc->sample_buf_size = 0;
123 devc->profile = prof;
124 devc->dev_state = IDLE;
125 devc->samplerate = DEFAULT_SAMPLERATE;
132 static int configure_channels(const struct sr_dev_inst *sdi)
134 struct dev_context *devc;
137 struct sr_channel *ch;
140 g_slist_free(devc->enabled_channels);
141 devc->enabled_channels = NULL;
142 memset(devc->ch_enabled, 0, sizeof(devc->ch_enabled));
144 for (l = sdi->channels, p = 0; l; l = l->next, p++) {
146 if (p < NUM_CHANNELS) {
147 devc->ch_enabled[p] = ch->enabled;
148 devc->enabled_channels = g_slist_append(devc->enabled_channels, ch);
155 static void clear_dev_context(void *priv)
157 struct dev_context *devc;
160 g_slist_free(devc->enabled_channels);
164 static int dev_clear(const struct sr_dev_driver *di)
166 return std_dev_clear(di, clear_dev_context);
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 /* Device matches the post-firmware profile. */
246 prof = &dev_profiles[j];
247 sr_dbg("Found a %s %s.", prof->vendor, prof->model);
248 sdi = hantek_6xxx_dev_new(prof);
249 sdi->connection_id = g_strdup(connection_id);
250 sdi->status = SR_ST_INACTIVE;
251 devices = g_slist_append(devices, sdi);
252 sdi->inst_type = SR_INST_USB;
253 sdi->conn = sr_usb_dev_inst_new(
254 libusb_get_bus_number(devlist[i]),
255 libusb_get_device_address(devlist[i]), NULL);
260 /* Not a supported VID/PID. */
263 libusb_free_device_list(devlist, 1);
265 return std_scan_complete(di, devices);
268 static int dev_open(struct sr_dev_inst *sdi)
270 struct dev_context *devc;
271 struct sr_usb_dev_inst *usb;
272 int64_t timediff_us, timediff_ms;
279 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
280 * for the FX2 to renumerate.
283 if (devc->fw_updated > 0) {
284 sr_info("Waiting for device to reset.");
285 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
286 g_usleep(300 * 1000);
288 while (timediff_ms < MAX_RENUM_DELAY_MS) {
289 if ((err = hantek_6xxx_open(sdi)) == SR_OK)
291 g_usleep(100 * 1000);
292 timediff_us = g_get_monotonic_time() - devc->fw_updated;
293 timediff_ms = timediff_us / 1000;
294 sr_spew("Waited %" PRIi64 " ms.", timediff_ms);
296 if (timediff_ms < MAX_RENUM_DELAY_MS)
297 sr_info("Device came back after %"PRIu64" ms.", timediff_ms);
299 err = hantek_6xxx_open(sdi);
303 sr_err("Unable to open device.");
307 err = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
309 sr_err("Unable to claim interface: %s.",
310 libusb_error_name(err));
317 static int dev_close(struct sr_dev_inst *sdi)
319 hantek_6xxx_close(sdi);
324 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
325 const struct sr_channel_group *cg)
327 struct dev_context *devc;
328 struct sr_usb_dev_inst *usb;
330 const uint64_t *vdiv;
334 case SR_CONF_NUM_VDIV:
335 *data = g_variant_new_int32(ARRAY_SIZE(vdivs));
345 case SR_CONF_SAMPLERATE:
346 *data = g_variant_new_uint64(devc->samplerate);
348 case SR_CONF_LIMIT_MSEC:
349 *data = g_variant_new_uint64(devc->limit_msec);
351 case SR_CONF_LIMIT_SAMPLES:
352 *data = g_variant_new_uint64(devc->limit_samples);
358 if (usb->address == 255)
359 /* Device still needs to re-enumerate after firmware
360 * upload, so we don't know its (future) address. */
362 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
363 *data = g_variant_new_string(str);
369 if (sdi->channel_groups->data == cg)
371 else if (sdi->channel_groups->next->data == cg)
377 vdiv = vdivs[devc->voltage[ch_idx]];
378 *data = g_variant_new("(tt)", vdiv[0], vdiv[1]);
380 case SR_CONF_COUPLING:
381 *data = g_variant_new_string(devc->coupling_vals[devc->coupling[ch_idx]]);
389 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
390 const struct sr_channel_group *cg)
392 struct dev_context *devc;
394 int tmp_int, ch_idx, ret;
398 if (sdi->status != SR_ST_ACTIVE)
399 return SR_ERR_DEV_CLOSED;
405 case SR_CONF_SAMPLERATE:
406 devc->samplerate = g_variant_get_uint64(data);
407 hantek_6xxx_update_samplerate(sdi);
409 case SR_CONF_LIMIT_MSEC:
410 devc->limit_msec = g_variant_get_uint64(data);
412 case SR_CONF_LIMIT_SAMPLES:
413 devc->limit_samples = g_variant_get_uint64(data);
420 if (sdi->channel_groups->data == cg)
422 else if (sdi->channel_groups->next->data == cg)
428 g_variant_get(data, "(tt)", &p, &q);
430 for (i = 0; i < ARRAY_SIZE(vdivs); i++) {
431 if (vdivs[i][0] == p && vdivs[i][1] == q) {
437 devc->voltage[ch_idx] = tmp_int;
438 hantek_6xxx_update_vdiv(sdi);
442 case SR_CONF_COUPLING:
443 tmp_str = g_variant_get_string(data, NULL);
444 for (i = 0; i < devc->coupling_tab_size; i++) {
445 if (!strcmp(tmp_str, devc->coupling_vals[i])) {
446 devc->coupling[ch_idx] = i;
450 if (i == devc->coupling_tab_size)
462 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
463 const struct sr_channel_group *cg)
465 GVariant *tuple, *rational[2];
469 struct dev_context *devc = NULL;
471 if (key == SR_CONF_SCAN_OPTIONS) {
472 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
473 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
475 } else if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
476 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
477 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
486 case SR_CONF_DEVICE_OPTIONS:
487 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
488 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
490 case SR_CONF_SAMPLERATE:
491 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
492 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
493 samplerates, ARRAY_SIZE(samplerates),
495 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
496 *data = g_variant_builder_end(&gvb);
503 case SR_CONF_DEVICE_OPTIONS:
504 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
505 devopts_cg, ARRAY_SIZE(devopts_cg), sizeof(uint32_t));
507 case SR_CONF_COUPLING:
510 *data = g_variant_new_strv(devc->coupling_vals, devc->coupling_tab_size);
513 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
514 for (i = 0; i < ARRAY_SIZE(vdivs); i++) {
515 rational[0] = g_variant_new_uint64(vdivs[i][0]);
516 rational[1] = g_variant_new_uint64(vdivs[i][1]);
517 tuple = g_variant_new_tuple(rational, 2);
518 g_variant_builder_add_value(&gvb, tuple);
520 *data = g_variant_builder_end(&gvb);
530 /* Minimise data amount for limit_samples and limit_msec limits. */
531 static uint32_t data_amount(const struct sr_dev_inst *sdi)
533 struct dev_context *devc = sdi->priv;
534 uint32_t data_left, data_left_2, i;
537 if (devc->limit_msec) {
538 time_left = devc->limit_msec - (g_get_monotonic_time() - devc->aq_started) / 1000;
539 data_left = devc->samplerate * MAX(time_left, 0) * NUM_CHANNELS / 1000;
540 } else if (devc->limit_samples) {
541 data_left = (devc->limit_samples - devc->samp_received) * NUM_CHANNELS;
543 data_left = devc->samplerate * NUM_CHANNELS;
546 /* Round up to nearest power of two. */
547 for (i = MIN_PACKET_SIZE; i < data_left; i *= 2)
551 sr_spew("data_amount: %u (rounded to power of 2: %u)", data_left, data_left_2);
556 static void send_chunk(struct sr_dev_inst *sdi, unsigned char *buf,
559 struct sr_datafeed_packet packet;
560 struct sr_datafeed_analog analog;
561 struct sr_analog_encoding encoding;
562 struct sr_analog_meaning meaning;
563 struct sr_analog_spec spec;
564 struct dev_context *devc = sdi->priv;
565 GSList *channels = devc->enabled_channels;
567 const float ch_bit[] = { RANGE(0) / 255, RANGE(1) / 255 };
568 const float ch_center[] = { RANGE(0) / 2, RANGE(1) / 2 };
570 sr_analog_init(&analog, &encoding, &meaning, &spec, 0);
572 packet.type = SR_DF_ANALOG;
573 packet.payload = &analog;
575 analog.num_samples = num_samples;
576 analog.meaning->mq = SR_MQ_VOLTAGE;
577 analog.meaning->unit = SR_UNIT_VOLT;
578 analog.meaning->mqflags = 0;
580 analog.data = g_try_malloc(num_samples * sizeof(float));
582 sr_err("Analog data buffer malloc failed.");
583 devc->dev_state = STOPPING;
587 for (int ch = 0; ch < 2; ch++) {
588 if (!devc->ch_enabled[ch])
591 float vdivlog = log10f(ch_bit[ch]);
592 int digits = -(int)vdivlog + (vdivlog < 0.0);
593 analog.encoding->digits = digits;
594 analog.spec->spec_digits = digits;
595 analog.meaning->channels = g_slist_append(NULL, channels->data);
597 for (int i = 0; i < num_samples; i++) {
599 * The device always sends data for both channels. If a channel
600 * is disabled, it contains a copy of the enabled channel's
601 * data. However, we only send the requested channels to
604 * Voltage values are encoded as a value 0-255, where the
605 * value is a point in the range represented by the vdiv
606 * setting. There are 10 vertical divs, so e.g. 500mV/div
607 * represents 5V peak-to-peak where 0 = -2.5V and 255 = +2.5V.
609 ((float *)analog.data)[i] = ch_bit[ch] * *(buf + i * 2 + ch) - ch_center[ch];
612 sr_session_send(sdi, &packet);
613 g_slist_free(analog.meaning->channels);
615 channels = channels->next;
620 static void send_data(struct sr_dev_inst *sdi, struct libusb_transfer *buf[], uint64_t samples)
626 while (send < samples) {
627 chunk = MIN(samples - send, (uint64_t)(buf[i]->actual_length / NUM_CHANNELS));
629 send_chunk(sdi, buf[i]->buffer, chunk);
632 * Everything in this transfer was either copied to the buffer
633 * or sent to the session bus.
635 g_free(buf[i]->buffer);
636 libusb_free_transfer(buf[i]);
642 * Called by libusb (as triggered by handle_event()) when a transfer comes in.
643 * Only channel data comes in asynchronously, and all transfers for this are
644 * queued up beforehand, so this just needs to chuck the incoming data onto
645 * the libsigrok session bus.
647 static void LIBUSB_CALL receive_transfer(struct libusb_transfer *transfer)
649 struct sr_dev_inst *sdi;
650 struct dev_context *devc;
652 sdi = transfer->user_data;
655 if (devc->dev_state == FLUSH) {
656 g_free(transfer->buffer);
657 libusb_free_transfer(transfer);
658 devc->dev_state = CAPTURE;
659 devc->aq_started = g_get_monotonic_time();
660 read_channel(sdi, data_amount(sdi));
664 if (devc->dev_state != CAPTURE)
667 if (!devc->sample_buf) {
668 devc->sample_buf_size = 10;
669 devc->sample_buf = g_try_malloc(devc->sample_buf_size * sizeof(transfer));
670 devc->sample_buf_write = 0;
673 if (devc->sample_buf_write >= devc->sample_buf_size) {
674 devc->sample_buf_size += 10;
675 devc->sample_buf = g_try_realloc(devc->sample_buf,
676 devc->sample_buf_size * sizeof(transfer));
677 if (!devc->sample_buf) {
678 sr_err("Sample buffer malloc failed.");
679 devc->dev_state = STOPPING;
684 devc->sample_buf[devc->sample_buf_write++] = transfer;
685 devc->samp_received += transfer->actual_length / NUM_CHANNELS;
687 sr_spew("receive_transfer(): calculated samplerate == %" PRIu64 "ks/s",
688 (uint64_t)(transfer->actual_length * 1000 /
689 (g_get_monotonic_time() - devc->read_start_ts + 1) /
692 sr_spew("receive_transfer(): status %s received %d bytes.",
693 libusb_error_name(transfer->status), transfer->actual_length);
695 if (transfer->actual_length == 0)
696 /* Nothing to send to the bus. */
699 if (devc->limit_samples && devc->samp_received >= devc->limit_samples) {
700 sr_info("Requested number of samples reached, stopping. %"
701 PRIu64 " <= %" PRIu64, devc->limit_samples,
702 devc->samp_received);
703 send_data(sdi, devc->sample_buf, devc->limit_samples);
704 sdi->driver->dev_acquisition_stop(sdi);
705 } else if (devc->limit_msec && (g_get_monotonic_time() -
706 devc->aq_started) / 1000 >= devc->limit_msec) {
707 sr_info("Requested time limit reached, stopping. %d <= %d",
708 (uint32_t)devc->limit_msec,
709 (uint32_t)(g_get_monotonic_time() - devc->aq_started) / 1000);
710 send_data(sdi, devc->sample_buf, devc->samp_received);
711 g_free(devc->sample_buf);
712 devc->sample_buf = NULL;
713 sdi->driver->dev_acquisition_stop(sdi);
715 read_channel(sdi, data_amount(sdi));
719 static int read_channel(const struct sr_dev_inst *sdi, uint32_t amount)
722 struct dev_context *devc;
726 amount = MIN(amount, MAX_PACKET_SIZE);
727 ret = hantek_6xxx_get_channeldata(sdi, receive_transfer, amount);
728 devc->read_start_ts = g_get_monotonic_time();
729 devc->read_data_amount = amount;
734 static int handle_event(int fd, int revents, void *cb_data)
736 const struct sr_dev_inst *sdi;
738 struct sr_dev_driver *di;
739 struct dev_context *devc;
740 struct drv_context *drvc;
750 /* Always handle pending libusb events. */
751 tv.tv_sec = tv.tv_usec = 0;
752 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
754 if (devc->dev_state == STOPPING) {
755 /* We've been told to wind up the acquisition. */
756 sr_dbg("Stopping acquisition.");
758 hantek_6xxx_stop_data_collecting(sdi);
760 * TODO: Doesn't really cancel pending transfers so they might
761 * come in after SR_DF_END is sent.
763 usb_source_remove(sdi->session, drvc->sr_ctx);
765 std_session_send_df_end(sdi);
767 devc->dev_state = IDLE;
775 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
777 struct dev_context *devc;
778 struct sr_dev_driver *di = sdi->driver;
779 struct drv_context *drvc = di->context;
781 if (sdi->status != SR_ST_ACTIVE)
782 return SR_ERR_DEV_CLOSED;
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;
813 if (sdi->status != SR_ST_ACTIVE)
817 devc->dev_state = STOPPING;
819 g_free(devc->sample_buf); devc->sample_buf = NULL;
824 static struct sr_dev_driver hantek_6xxx_driver_info = {
825 .name = "hantek-6xxx",
826 .longname = "Hantek 6xxx",
829 .cleanup = std_cleanup,
831 .dev_list = std_dev_list,
832 .dev_clear = dev_clear,
833 .config_get = config_get,
834 .config_set = config_set,
835 .config_list = config_list,
836 .dev_open = dev_open,
837 .dev_close = dev_close,
838 .dev_acquisition_start = dev_acquisition_start,
839 .dev_acquisition_stop = dev_acquisition_stop,
842 SR_REGISTER_DEV_DRIVER(hantek_6xxx_driver_info);