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 *dc_coupling[] = {
57 static const char *acdc_coupling[] = {
61 static const struct hantek_6xxx_profile dev_profiles[] = {
63 0x04b4, 0x6022, 0x04b5, 0x6022,
64 "Hantek", "6022BE", "hantek-6022be.fw",
65 dc_coupling, ARRAY_SIZE(dc_coupling),
68 0x8102, 0x8102, 0x1D50, 0x608E,
69 "Sainsmart", "DDS120", "sainsmart-dds120.fw",
70 acdc_coupling, ARRAY_SIZE(acdc_coupling),
75 static const uint64_t samplerates[] = {
79 static const uint64_t vdivs[][2] = {
83 static int read_channel(const struct sr_dev_inst *sdi, uint32_t amount);
85 static int dev_acquisition_stop(struct sr_dev_inst *sdi);
87 static struct sr_dev_inst *hantek_6xxx_dev_new(const struct hantek_6xxx_profile *prof)
89 struct sr_dev_inst *sdi;
90 struct sr_channel *ch;
91 struct sr_channel_group *cg;
92 struct dev_context *devc;
95 sdi = g_malloc0(sizeof(struct sr_dev_inst));
96 sdi->status = SR_ST_INITIALIZING;
97 sdi->vendor = g_strdup(prof->vendor);
98 sdi->model = g_strdup(prof->model);
100 for (i = 0; i < ARRAY_SIZE(channel_names); i++) {
101 ch = sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, TRUE, channel_names[i]);
102 cg = g_malloc0(sizeof(struct sr_channel_group));
103 cg->name = g_strdup(channel_names[i]);
104 cg->channels = g_slist_append(cg->channels, ch);
105 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
108 devc = g_malloc0(sizeof(struct dev_context));
110 for (i = 0; i < NUM_CHANNELS; i++) {
111 devc->ch_enabled[i] = TRUE;
112 devc->voltage[i] = DEFAULT_VOLTAGE;
113 devc->coupling[i] = DEFAULT_COUPLING;
115 devc->coupling_vals = prof->coupling_vals;
116 devc->coupling_tab_size = prof->coupling_tab_size;
118 devc->sample_buf = NULL;
119 devc->sample_buf_write = 0;
120 devc->sample_buf_size = 0;
122 devc->profile = prof;
123 devc->dev_state = IDLE;
124 devc->samplerate = DEFAULT_SAMPLERATE;
131 static int configure_channels(const struct sr_dev_inst *sdi)
133 struct dev_context *devc;
136 struct sr_channel *ch;
139 g_slist_free(devc->enabled_channels);
140 devc->enabled_channels = NULL;
141 memset(devc->ch_enabled, 0, sizeof(devc->ch_enabled));
143 for (l = sdi->channels, p = 0; l; l = l->next, p++) {
145 if (p < NUM_CHANNELS) {
146 devc->ch_enabled[p] = ch->enabled;
147 devc->enabled_channels = g_slist_append(devc->enabled_channels, ch);
154 static void clear_dev_context(void *priv)
156 struct dev_context *devc;
159 g_slist_free(devc->enabled_channels);
163 static int dev_clear(const struct sr_dev_driver *di)
165 return std_dev_clear(di, clear_dev_context);
168 static GSList *scan(struct sr_dev_driver *di, GSList *options)
170 struct drv_context *drvc;
171 struct dev_context *devc;
172 struct sr_dev_inst *sdi;
173 struct sr_usb_dev_inst *usb;
174 struct sr_config *src;
175 const struct hantek_6xxx_profile *prof;
176 GSList *l, *devices, *conn_devices;
177 struct libusb_device_descriptor des;
178 libusb_device **devlist;
181 char connection_id[64];
188 for (l = options; l; l = l->next) {
190 if (src->key == SR_CONF_CONN) {
191 conn = g_variant_get_string(src->data, NULL);
196 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
200 /* Find all Hantek 60xx devices and upload firmware to all of them. */
201 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
202 for (i = 0; devlist[i]; i++) {
205 for (l = conn_devices; l; l = l->next) {
207 if (usb->bus == libusb_get_bus_number(devlist[i])
208 && usb->address == libusb_get_device_address(devlist[i]))
212 /* This device matched none of the ones that
213 * matched the conn specification. */
217 libusb_get_device_descriptor(devlist[i], &des);
219 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
222 for (j = 0; dev_profiles[j].orig_vid; j++) {
223 if (des.idVendor == dev_profiles[j].orig_vid
224 && des.idProduct == dev_profiles[j].orig_pid) {
225 /* Device matches the pre-firmware profile. */
226 prof = &dev_profiles[j];
227 sr_dbg("Found a %s %s.", prof->vendor, prof->model);
228 sdi = hantek_6xxx_dev_new(prof);
229 sdi->connection_id = g_strdup(connection_id);
230 devices = g_slist_append(devices, sdi);
232 if (ezusb_upload_firmware(drvc->sr_ctx, devlist[i],
233 USB_CONFIGURATION, prof->firmware) == SR_OK)
234 /* Remember when the firmware on this device was updated. */
235 devc->fw_updated = g_get_monotonic_time();
237 sr_err("Firmware upload failed.");
238 /* Dummy USB address of 0xff will get overwritten later. */
239 sdi->conn = sr_usb_dev_inst_new(
240 libusb_get_bus_number(devlist[i]), 0xff, NULL);
242 } else if (des.idVendor == dev_profiles[j].fw_vid
243 && des.idProduct == dev_profiles[j].fw_pid) {
244 /* Device matches the post-firmware profile. */
245 prof = &dev_profiles[j];
246 sr_dbg("Found a %s %s.", prof->vendor, prof->model);
247 sdi = hantek_6xxx_dev_new(prof);
248 sdi->connection_id = g_strdup(connection_id);
249 sdi->status = SR_ST_INACTIVE;
250 devices = g_slist_append(devices, sdi);
251 sdi->inst_type = SR_INST_USB;
252 sdi->conn = sr_usb_dev_inst_new(
253 libusb_get_bus_number(devlist[i]),
254 libusb_get_device_address(devlist[i]), NULL);
259 /* Not a supported VID/PID. */
262 libusb_free_device_list(devlist, 1);
264 return std_scan_complete(di, devices);
267 static int dev_open(struct sr_dev_inst *sdi)
269 struct dev_context *devc;
270 struct sr_usb_dev_inst *usb;
271 int64_t timediff_us, timediff_ms;
278 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
279 * for the FX2 to renumerate.
282 if (devc->fw_updated > 0) {
283 sr_info("Waiting for device to reset.");
284 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
285 g_usleep(300 * 1000);
287 while (timediff_ms < MAX_RENUM_DELAY_MS) {
288 if ((err = hantek_6xxx_open(sdi)) == SR_OK)
290 g_usleep(100 * 1000);
291 timediff_us = g_get_monotonic_time() - devc->fw_updated;
292 timediff_ms = timediff_us / 1000;
293 sr_spew("Waited %" PRIi64 " ms.", timediff_ms);
295 if (timediff_ms < MAX_RENUM_DELAY_MS)
296 sr_info("Device came back after %"PRIu64" ms.", timediff_ms);
298 err = hantek_6xxx_open(sdi);
302 sr_err("Unable to open device.");
306 err = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
308 sr_err("Unable to claim interface: %s.",
309 libusb_error_name(err));
316 static int dev_close(struct sr_dev_inst *sdi)
318 hantek_6xxx_close(sdi);
323 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
324 const struct sr_channel_group *cg)
326 struct dev_context *devc;
327 struct sr_usb_dev_inst *usb;
329 const uint64_t *vdiv;
333 case SR_CONF_NUM_VDIV:
334 *data = g_variant_new_int32(ARRAY_SIZE(vdivs));
344 case SR_CONF_SAMPLERATE:
345 *data = g_variant_new_uint64(devc->samplerate);
347 case SR_CONF_LIMIT_MSEC:
348 *data = g_variant_new_uint64(devc->limit_msec);
350 case SR_CONF_LIMIT_SAMPLES:
351 *data = g_variant_new_uint64(devc->limit_samples);
357 if (usb->address == 255)
358 /* Device still needs to re-enumerate after firmware
359 * upload, so we don't know its (future) address. */
361 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
362 *data = g_variant_new_string(str);
368 if (sdi->channel_groups->data == cg)
370 else if (sdi->channel_groups->next->data == cg)
376 vdiv = vdivs[devc->voltage[ch_idx]];
377 *data = g_variant_new("(tt)", vdiv[0], vdiv[1]);
379 case SR_CONF_COUPLING:
380 *data = g_variant_new_string(devc->coupling_vals[devc->coupling[ch_idx]]);
388 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
389 const struct sr_channel_group *cg)
391 struct dev_context *devc;
393 int tmp_int, ch_idx, ret;
397 if (sdi->status != SR_ST_ACTIVE)
398 return SR_ERR_DEV_CLOSED;
404 case SR_CONF_SAMPLERATE:
405 devc->samplerate = g_variant_get_uint64(data);
406 hantek_6xxx_update_samplerate(sdi);
408 case SR_CONF_LIMIT_MSEC:
409 devc->limit_msec = g_variant_get_uint64(data);
411 case SR_CONF_LIMIT_SAMPLES:
412 devc->limit_samples = g_variant_get_uint64(data);
419 if (sdi->channel_groups->data == cg)
421 else if (sdi->channel_groups->next->data == cg)
427 g_variant_get(data, "(tt)", &p, &q);
429 for (i = 0; i < ARRAY_SIZE(vdivs); i++) {
430 if (vdivs[i][0] == p && vdivs[i][1] == q) {
436 devc->voltage[ch_idx] = tmp_int;
437 hantek_6xxx_update_vdiv(sdi);
441 case SR_CONF_COUPLING:
442 tmp_str = g_variant_get_string(data, NULL);
443 for (i = 0; devc->coupling_vals[i]; i++) {
444 if (!strcmp(tmp_str, devc->coupling_vals[i])) {
445 devc->coupling[ch_idx] = i;
449 if (devc->coupling_vals[i] == 0)
461 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
462 const struct sr_channel_group *cg)
464 GVariant *tuple, *rational[2];
468 struct dev_context *devc;
470 if (key == SR_CONF_SCAN_OPTIONS) {
471 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
472 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
474 } else if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
475 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
476 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(devc->coupling_vals, devc->coupling_tab_size);
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;
533 uint32_t data_left, data_left_2, i;
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 /* Round up to nearest power of two. */
546 for (i = MIN_PACKET_SIZE; i < data_left; i *= 2)
550 sr_spew("data_amount: %u (rounded to power of 2: %u)", data_left, data_left_2);
555 static void send_chunk(struct sr_dev_inst *sdi, unsigned char *buf,
558 struct sr_datafeed_packet packet;
559 struct sr_datafeed_analog analog;
560 struct sr_analog_encoding encoding;
561 struct sr_analog_meaning meaning;
562 struct sr_analog_spec spec;
563 struct dev_context *devc = sdi->priv;
564 int num_channels, data_offset, i;
566 const float ch1_bit = RANGE(0) / 255;
567 const float ch2_bit = RANGE(1) / 255;
568 const float ch1_center = RANGE(0) / 2;
569 const float ch2_center = RANGE(1) / 2;
571 const gboolean ch1_ena = !!devc->ch_enabled[0];
572 const gboolean ch2_ena = !!devc->ch_enabled[1];
574 sr_analog_init(&analog, &encoding, &meaning, &spec, 0);
576 num_channels = (ch1_ena && ch2_ena) ? 2 : 1;
577 packet.type = SR_DF_ANALOG;
578 packet.payload = &analog;
580 analog.meaning->channels = devc->enabled_channels;
581 analog.num_samples = num_samples;
582 analog.meaning->mq = SR_MQ_VOLTAGE;
583 analog.meaning->unit = SR_UNIT_VOLT;
584 analog.meaning->mqflags = 0;
586 analog.data = g_try_malloc(analog.num_samples * sizeof(float) * num_channels);
588 sr_err("Analog data buffer malloc failed.");
589 devc->dev_state = STOPPING;
594 for (i = 0; i < num_samples; i++) {
596 * The device always sends data for both channels. If a channel
597 * is disabled, it contains a copy of the enabled channel's
598 * data. However, we only send the requested channels to
601 * Voltage values are encoded as a value 0-255, where the
602 * value is a point in the range represented by the vdiv
603 * setting. There are 10 vertical divs, so e.g. 500mV/div
604 * represents 5V peak-to-peak where 0 = -2.5V and 255 = +2.5V.
607 ((float *)analog.data)[data_offset++] = (ch1_bit * *(buf + i * 2) - ch1_center);
609 ((float *)analog.data)[data_offset++] = (ch2_bit * *(buf + i * 2 + 1) - ch2_center);
612 sr_session_send(sdi, &packet);
616 static void send_data(struct sr_dev_inst *sdi, struct libusb_transfer *buf[], uint64_t samples)
622 while (send < samples) {
623 chunk = MIN(samples - send, (uint64_t)(buf[i]->actual_length / NUM_CHANNELS));
625 send_chunk(sdi, buf[i]->buffer, chunk);
628 * Everything in this transfer was either copied to the buffer
629 * or sent to the session bus.
631 g_free(buf[i]->buffer);
632 libusb_free_transfer(buf[i]);
638 * Called by libusb (as triggered by handle_event()) when a transfer comes in.
639 * Only channel data comes in asynchronously, and all transfers for this are
640 * queued up beforehand, so this just needs to chuck the incoming data onto
641 * the libsigrok session bus.
643 static void LIBUSB_CALL receive_transfer(struct libusb_transfer *transfer)
645 struct sr_dev_inst *sdi;
646 struct dev_context *devc;
648 sdi = transfer->user_data;
651 if (devc->dev_state == FLUSH) {
652 g_free(transfer->buffer);
653 libusb_free_transfer(transfer);
654 devc->dev_state = CAPTURE;
655 devc->aq_started = g_get_monotonic_time();
656 read_channel(sdi, data_amount(sdi));
660 if (devc->dev_state != CAPTURE)
663 if (!devc->sample_buf) {
664 devc->sample_buf_size = 10;
665 devc->sample_buf = g_try_malloc(devc->sample_buf_size * sizeof(transfer));
666 devc->sample_buf_write = 0;
669 if (devc->sample_buf_write >= devc->sample_buf_size) {
670 devc->sample_buf_size += 10;
671 devc->sample_buf = g_try_realloc(devc->sample_buf,
672 devc->sample_buf_size * sizeof(transfer));
673 if (!devc->sample_buf) {
674 sr_err("Sample buffer malloc failed.");
675 devc->dev_state = STOPPING;
680 devc->sample_buf[devc->sample_buf_write++] = transfer;
681 devc->samp_received += transfer->actual_length / NUM_CHANNELS;
683 sr_spew("receive_transfer(): calculated samplerate == %" PRIu64 "ks/s",
684 (uint64_t)(transfer->actual_length * 1000 /
685 (g_get_monotonic_time() - devc->read_start_ts + 1) /
688 sr_spew("receive_transfer(): status %s received %d bytes.",
689 libusb_error_name(transfer->status), transfer->actual_length);
691 if (transfer->actual_length == 0)
692 /* Nothing to send to the bus. */
695 if (devc->limit_samples && devc->samp_received >= devc->limit_samples) {
696 sr_info("Requested number of samples reached, stopping. %"
697 PRIu64 " <= %" PRIu64, devc->limit_samples,
698 devc->samp_received);
699 send_data(sdi, devc->sample_buf, devc->limit_samples);
700 sdi->driver->dev_acquisition_stop(sdi);
701 } else if (devc->limit_msec && (g_get_monotonic_time() -
702 devc->aq_started) / 1000 >= devc->limit_msec) {
703 sr_info("Requested time limit reached, stopping. %d <= %d",
704 (uint32_t)devc->limit_msec,
705 (uint32_t)(g_get_monotonic_time() - devc->aq_started) / 1000);
706 send_data(sdi, devc->sample_buf, devc->samp_received);
707 g_free(devc->sample_buf);
708 devc->sample_buf = NULL;
709 sdi->driver->dev_acquisition_stop(sdi);
711 read_channel(sdi, data_amount(sdi));
715 static int read_channel(const struct sr_dev_inst *sdi, uint32_t amount)
718 struct dev_context *devc;
722 amount = MIN(amount, MAX_PACKET_SIZE);
723 ret = hantek_6xxx_get_channeldata(sdi, receive_transfer, amount);
724 devc->read_start_ts = g_get_monotonic_time();
725 devc->read_data_amount = amount;
730 static int handle_event(int fd, int revents, void *cb_data)
732 const struct sr_dev_inst *sdi;
734 struct sr_dev_driver *di;
735 struct dev_context *devc;
736 struct drv_context *drvc;
746 /* Always handle pending libusb events. */
747 tv.tv_sec = tv.tv_usec = 0;
748 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
750 if (devc->dev_state == STOPPING) {
751 /* We've been told to wind up the acquisition. */
752 sr_dbg("Stopping acquisition.");
754 hantek_6xxx_stop_data_collecting(sdi);
756 * TODO: Doesn't really cancel pending transfers so they might
757 * come in after SR_DF_END is sent.
759 usb_source_remove(sdi->session, drvc->sr_ctx);
761 std_session_send_df_end(sdi);
763 devc->dev_state = IDLE;
771 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
773 struct dev_context *devc;
774 struct sr_dev_driver *di = sdi->driver;
775 struct drv_context *drvc = di->context;
777 if (sdi->status != SR_ST_ACTIVE)
778 return SR_ERR_DEV_CLOSED;
782 if (configure_channels(sdi) != SR_OK) {
783 sr_err("Failed to configure channels.");
787 if (hantek_6xxx_init(sdi) != SR_OK)
790 std_session_send_df_header(sdi);
792 devc->samp_received = 0;
793 devc->dev_state = FLUSH;
795 usb_source_add(sdi->session, drvc->sr_ctx, TICK,
796 handle_event, (void *)sdi);
798 hantek_6xxx_start_data_collecting(sdi);
800 read_channel(sdi, FLUSH_PACKET_SIZE);
805 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
807 struct dev_context *devc;
809 if (sdi->status != SR_ST_ACTIVE)
813 devc->dev_state = STOPPING;
815 g_free(devc->sample_buf); devc->sample_buf = NULL;
820 static struct sr_dev_driver hantek_6xxx_driver_info = {
821 .name = "hantek-6xxx",
822 .longname = "Hantek 6xxx",
825 .cleanup = std_cleanup,
827 .dev_list = std_dev_list,
828 .dev_clear = dev_clear,
829 .config_get = config_get,
830 .config_set = config_set,
831 .config_list = config_list,
832 .dev_open = dev_open,
833 .dev_close = dev_close,
834 .dev_acquisition_start = dev_acquisition_start,
835 .dev_acquisition_stop = dev_acquisition_stop,
838 SR_REGISTER_DEV_DRIVER(hantek_6xxx_driver_info);