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)devc->vdivs[devc->voltage[ch]][0] / devc->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_COUPLING | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
47 SR_CONF_VDIV | 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 uint64_t vdivs[][2] = {
66 static const uint64_t vdivs_instrustar[][2] = {
67 VDIV_VALUES_INSTRUSTAR
70 static const uint64_t samplerates[] = {
74 static const struct hantek_6xxx_profile dev_profiles[] = {
76 /* Windows: "Hantek6022BE DRIVER 1": 04b4:6022 */
77 0x04b4, 0x6022, 0x1d50, 0x608e, 0x0001,
78 "Hantek", "6022BE", "fx2lafw-hantek-6022be.fw",
79 ARRAY_AND_SIZE(dc_coupling), FALSE,
80 ARRAY_AND_SIZE(vdivs),
83 /* Windows: "Hantek6022BE DRIVER 2": 04b5:6022 */
84 0x04b5, 0x6022, 0x1d50, 0x608e, 0x0001,
85 "Hantek", "6022BE", "fx2lafw-hantek-6022be.fw",
86 ARRAY_AND_SIZE(dc_coupling), FALSE,
87 ARRAY_AND_SIZE(vdivs),
90 0x8102, 0x8102, 0x1d50, 0x608e, 0x0002,
91 "Sainsmart", "DDS120", "fx2lafw-sainsmart-dds120.fw",
92 ARRAY_AND_SIZE(acdc_coupling), TRUE,
93 ARRAY_AND_SIZE(vdivs),
96 /* Windows: "Hantek6022BL DRIVER 1": 04b4:602a */
97 0x04b4, 0x602a, 0x1d50, 0x608e, 0x0003,
98 "Hantek", "6022BL", "fx2lafw-hantek-6022bl.fw",
99 ARRAY_AND_SIZE(dc_coupling), FALSE,
100 ARRAY_AND_SIZE(vdivs),
103 /* Windows: "Hantek6022BL DRIVER 2": 04b5:602a */
104 0x04b5, 0x602a, 0x1d50, 0x608e, 0x0003,
105 "Hantek", "6022BL", "fx2lafw-hantek-6022bl.fw",
106 ARRAY_AND_SIZE(dc_coupling), FALSE,
107 ARRAY_AND_SIZE(vdivs),
110 0xd4a2, 0x5660, 0x1d50, 0x608e, 0x0004,
111 "YiXingDianZi", "MDSO", "fx2lafw-yixingdianzi-mdso.fw",
112 ARRAY_AND_SIZE(dc_coupling), FALSE,
113 ARRAY_AND_SIZE(vdivs),
116 /*"InstrustarISDS205": d4a2:5661 */
117 0xd4a2, 0x5661, 0x1d50, 0x608e, 0x0005,
118 "Instrustar", "ISDS205B", "fx2lafw-instrustar-isds205b.fw",
119 ARRAY_AND_SIZE(acdc_coupling), TRUE,
120 ARRAY_AND_SIZE(vdivs_instrustar),
126 static int read_channel(const struct sr_dev_inst *sdi, uint32_t amount);
128 static struct sr_dev_inst *hantek_6xxx_dev_new(const struct hantek_6xxx_profile *prof)
130 struct sr_dev_inst *sdi;
131 struct sr_channel *ch;
132 struct sr_channel_group *cg;
133 struct dev_context *devc;
136 sdi = g_malloc0(sizeof(struct sr_dev_inst));
137 sdi->status = SR_ST_INITIALIZING;
138 sdi->vendor = g_strdup(prof->vendor);
139 sdi->model = g_strdup(prof->model);
141 for (i = 0; i < ARRAY_SIZE(channel_names); i++) {
142 ch = sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, TRUE, channel_names[i]);
143 cg = g_malloc0(sizeof(struct sr_channel_group));
144 cg->name = g_strdup(channel_names[i]);
145 cg->channels = g_slist_append(cg->channels, ch);
146 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
149 devc = g_malloc0(sizeof(struct dev_context));
151 for (i = 0; i < NUM_CHANNELS; i++) {
152 devc->ch_enabled[i] = TRUE;
153 devc->voltage[i] = DEFAULT_VOLTAGE;
154 devc->coupling[i] = DEFAULT_COUPLING;
156 devc->coupling_vals = prof->coupling_vals;
157 devc->coupling_tab_size = prof->coupling_tab_size;
158 devc->has_coupling = prof->has_coupling;
159 devc->vdivs = prof->vdivs;
160 devc->vdivs_size = prof->vdivs_size;
162 devc->profile = prof;
163 devc->dev_state = IDLE;
164 devc->samplerate = DEFAULT_SAMPLERATE;
171 static int configure_channels(const struct sr_dev_inst *sdi)
173 struct dev_context *devc;
176 struct sr_channel *ch;
179 g_slist_free(devc->enabled_channels);
180 devc->enabled_channels = NULL;
181 memset(devc->ch_enabled, 0, sizeof(devc->ch_enabled));
183 for (l = sdi->channels, p = 0; l; l = l->next, p++) {
185 if (p < NUM_CHANNELS) {
186 devc->ch_enabled[p] = ch->enabled;
187 devc->enabled_channels = g_slist_append(devc->enabled_channels, ch);
194 static void clear_helper(struct dev_context *devc)
196 g_slist_free(devc->enabled_channels);
199 static int dev_clear(const struct sr_dev_driver *di)
201 return std_dev_clear_with_callback(di, (std_dev_clear_callback)clear_helper);
204 static GSList *scan(struct sr_dev_driver *di, GSList *options)
206 struct drv_context *drvc;
207 struct dev_context *devc;
208 struct sr_dev_inst *sdi;
209 struct sr_usb_dev_inst *usb;
210 struct sr_config *src;
211 const struct hantek_6xxx_profile *prof;
212 GSList *l, *devices, *conn_devices;
213 struct libusb_device_descriptor des;
214 libusb_device **devlist;
217 char connection_id[64];
224 for (l = options; l; l = l->next) {
226 if (src->key == SR_CONF_CONN) {
227 conn = g_variant_get_string(src->data, NULL);
232 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
236 /* Find all Hantek 60xx devices and upload firmware to all of them. */
237 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
238 for (i = 0; devlist[i]; i++) {
241 for (l = conn_devices; l; l = l->next) {
243 if (usb->bus == libusb_get_bus_number(devlist[i])
244 && usb->address == libusb_get_device_address(devlist[i]))
248 /* This device matched none of the ones that
249 * matched the conn specification. */
253 libusb_get_device_descriptor(devlist[i], &des);
255 if (usb_get_port_path(devlist[i], connection_id, sizeof(connection_id)) < 0)
259 for (j = 0; dev_profiles[j].orig_vid; j++) {
260 if (des.idVendor == dev_profiles[j].orig_vid
261 && des.idProduct == dev_profiles[j].orig_pid) {
262 /* Device matches the pre-firmware profile. */
263 prof = &dev_profiles[j];
264 sr_dbg("Found a %s %s.", prof->vendor, prof->model);
265 sdi = hantek_6xxx_dev_new(prof);
266 sdi->connection_id = g_strdup(connection_id);
267 devices = g_slist_append(devices, sdi);
269 if (ezusb_upload_firmware(drvc->sr_ctx, devlist[i],
270 USB_CONFIGURATION, prof->firmware) == SR_OK) {
271 /* Remember when the firmware on this device was updated. */
272 devc->fw_updated = g_get_monotonic_time();
274 sr_err("Firmware upload failed, name %s.", prof->firmware);
276 /* Dummy USB address of 0xff will get overwritten later. */
277 sdi->conn = sr_usb_dev_inst_new(
278 libusb_get_bus_number(devlist[i]), 0xff, NULL);
280 } else if (des.idVendor == dev_profiles[j].fw_vid
281 && des.idProduct == dev_profiles[j].fw_pid
282 && des.bcdDevice == dev_profiles[j].fw_prod_ver) {
283 /* Device matches the post-firmware profile. */
284 prof = &dev_profiles[j];
285 sr_dbg("Found a %s %s.", prof->vendor, prof->model);
286 sdi = hantek_6xxx_dev_new(prof);
287 sdi->connection_id = g_strdup(connection_id);
288 sdi->status = SR_ST_INACTIVE;
289 devices = g_slist_append(devices, sdi);
290 sdi->inst_type = SR_INST_USB;
291 sdi->conn = sr_usb_dev_inst_new(
292 libusb_get_bus_number(devlist[i]),
293 libusb_get_device_address(devlist[i]), NULL);
298 /* Not a supported VID/PID. */
301 libusb_free_device_list(devlist, 1);
303 return std_scan_complete(di, devices);
306 static int dev_open(struct sr_dev_inst *sdi)
308 struct dev_context *devc;
309 struct sr_usb_dev_inst *usb;
310 int64_t timediff_us, timediff_ms;
317 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
318 * for the FX2 to renumerate.
321 if (devc->fw_updated > 0) {
322 sr_info("Waiting for device to reset.");
323 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
324 g_usleep(300 * 1000);
326 while (timediff_ms < MAX_RENUM_DELAY_MS) {
327 if ((err = hantek_6xxx_open(sdi)) == SR_OK)
329 g_usleep(100 * 1000);
330 timediff_us = g_get_monotonic_time() - devc->fw_updated;
331 timediff_ms = timediff_us / 1000;
332 sr_spew("Waited %" PRIi64 " ms.", timediff_ms);
334 if (timediff_ms < MAX_RENUM_DELAY_MS)
335 sr_info("Device came back after %"PRIu64" ms.", timediff_ms);
337 err = hantek_6xxx_open(sdi);
341 sr_err("Unable to open device.");
345 err = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
347 sr_err("Unable to claim interface: %s.",
348 libusb_error_name(err));
355 static int dev_close(struct sr_dev_inst *sdi)
357 hantek_6xxx_close(sdi);
362 static int config_get(uint32_t key, GVariant **data,
363 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
365 struct dev_context *devc;
366 struct sr_usb_dev_inst *usb;
367 const uint64_t *vdiv;
376 case SR_CONF_NUM_VDIV:
377 *data = g_variant_new_int32(devc->vdivs_size);
383 case SR_CONF_SAMPLERATE:
384 *data = g_variant_new_uint64(devc->samplerate);
386 case SR_CONF_LIMIT_MSEC:
387 *data = g_variant_new_uint64(devc->limit_msec);
389 case SR_CONF_LIMIT_SAMPLES:
390 *data = g_variant_new_uint64(devc->limit_samples);
396 if (usb->address == 255)
397 /* Device still needs to re-enumerate after firmware
398 * upload, so we don't know its (future) address. */
400 *data = g_variant_new_printf("%d.%d", usb->bus, usb->address);
406 if (sdi->channel_groups->data == cg)
408 else if (sdi->channel_groups->next->data == cg)
414 vdiv = devc->vdivs[devc->voltage[ch_idx]];
415 *data = g_variant_new("(tt)", vdiv[0], vdiv[1]);
417 case SR_CONF_COUPLING:
418 *data = g_variant_new_string((devc->coupling[ch_idx] \
419 == COUPLING_DC) ? "DC" : "AC");
427 static int config_set(uint32_t key, GVariant *data,
428 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
430 struct dev_context *devc;
436 case SR_CONF_SAMPLERATE:
437 devc->samplerate = g_variant_get_uint64(data);
438 hantek_6xxx_update_samplerate(sdi);
440 case SR_CONF_LIMIT_MSEC:
441 devc->limit_msec = g_variant_get_uint64(data);
443 case SR_CONF_LIMIT_SAMPLES:
444 devc->limit_samples = g_variant_get_uint64(data);
450 if (sdi->channel_groups->data == cg)
452 else if (sdi->channel_groups->next->data == cg)
458 if ((idx = std_u64_tuple_idx(data, devc->vdivs, devc->vdivs_size)) < 0)
460 devc->voltage[ch_idx] = idx;
461 hantek_6xxx_update_vdiv(sdi);
463 case SR_CONF_COUPLING:
464 if ((idx = std_str_idx(data, devc->coupling_vals,
465 devc->coupling_tab_size)) < 0)
467 devc->coupling[ch_idx] = idx;
468 hantek_6xxx_update_coupling(sdi);
478 static int config_list(uint32_t key, GVariant **data,
479 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
481 struct dev_context *devc;
483 devc = (sdi) ? sdi->priv : NULL;
487 case SR_CONF_SCAN_OPTIONS:
488 case SR_CONF_DEVICE_OPTIONS:
489 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
490 case SR_CONF_SAMPLERATE:
491 *data = std_gvar_samplerates(ARRAY_AND_SIZE(samplerates));
498 case SR_CONF_DEVICE_OPTIONS:
499 *data = std_gvar_array_u32(ARRAY_AND_SIZE(devopts_cg));
501 case SR_CONF_COUPLING:
504 *data = g_variant_new_strv(devc->coupling_vals, devc->coupling_tab_size);
509 *data = std_gvar_tuple_array(devc->vdivs,devc->vdivs_size);
519 /* Minimise data amount for limit_samples and limit_msec limits. */
520 static uint32_t data_amount(const struct sr_dev_inst *sdi)
522 struct dev_context *devc = sdi->priv;
523 uint32_t data_left, data_left_2, i;
526 if (devc->limit_msec) {
527 time_left = devc->limit_msec - (g_get_monotonic_time() - devc->aq_started) / 1000;
528 data_left = devc->samplerate * MAX(time_left, 0) * NUM_CHANNELS / 1000;
529 } else if (devc->limit_samples) {
530 data_left = (devc->limit_samples - devc->samp_received) * NUM_CHANNELS;
532 data_left = devc->samplerate * NUM_CHANNELS;
535 /* Round up to nearest power of two. */
536 for (i = MIN_PACKET_SIZE; i < data_left; i *= 2)
540 sr_spew("data_amount: %u (rounded to power of 2: %u)", data_left, data_left_2);
545 static void send_chunk(struct sr_dev_inst *sdi, unsigned char *buf,
548 struct sr_datafeed_packet packet;
549 struct sr_datafeed_analog analog;
550 struct sr_analog_encoding encoding;
551 struct sr_analog_meaning meaning;
552 struct sr_analog_spec spec;
553 struct dev_context *devc = sdi->priv;
554 GSList *channels = devc->enabled_channels;
556 const float ch_bit[] = { RANGE(0) / 255, RANGE(1) / 255 };
557 const float ch_center[] = { RANGE(0) / 2, RANGE(1) / 2 };
559 sr_analog_init(&analog, &encoding, &meaning, &spec, 0);
561 packet.type = SR_DF_ANALOG;
562 packet.payload = &analog;
564 analog.num_samples = num_samples;
565 analog.meaning->mq = SR_MQ_VOLTAGE;
566 analog.meaning->unit = SR_UNIT_VOLT;
567 analog.meaning->mqflags = 0;
569 analog.data = g_try_malloc(num_samples * sizeof(float));
571 sr_err("Analog data buffer malloc failed.");
572 devc->dev_state = STOPPING;
576 for (int ch = 0; ch < NUM_CHANNELS; ch++) {
577 if (!devc->ch_enabled[ch])
580 float vdivlog = log10f(ch_bit[ch]);
581 int digits = -(int)vdivlog + (vdivlog < 0.0);
582 analog.encoding->digits = digits;
583 analog.spec->spec_digits = digits;
584 analog.meaning->channels = g_slist_append(NULL, channels->data);
586 for (int 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.
598 ((float *)analog.data)[i] = ch_bit[ch] * *(buf + i * 2 + ch) - ch_center[ch];
601 sr_session_send(sdi, &packet);
602 g_slist_free(analog.meaning->channels);
604 channels = channels->next;
610 * Called by libusb (as triggered by handle_event()) when a transfer comes in.
611 * Only channel data comes in asynchronously, and all transfers for this are
612 * queued up beforehand, so this just needs to chuck the incoming data onto
613 * the libsigrok session bus.
615 static void LIBUSB_CALL receive_transfer(struct libusb_transfer *transfer)
617 struct sr_dev_inst *sdi;
618 struct dev_context *devc;
620 sdi = transfer->user_data;
623 if (devc->dev_state == FLUSH) {
624 g_free(transfer->buffer);
625 libusb_free_transfer(transfer);
626 devc->dev_state = CAPTURE;
627 devc->aq_started = g_get_monotonic_time();
628 read_channel(sdi, data_amount(sdi));
632 if (devc->dev_state != CAPTURE)
635 sr_spew("receive_transfer(): calculated samplerate == %" PRIu64 "ks/s",
636 (uint64_t)(transfer->actual_length * 1000 /
637 (g_get_monotonic_time() - devc->read_start_ts + 1) /
640 sr_spew("receive_transfer(): status %s received %d bytes.",
641 libusb_error_name(transfer->status), transfer->actual_length);
643 if (transfer->actual_length == 0)
644 /* Nothing to send to the bus. */
647 unsigned samples_received = transfer->actual_length / NUM_CHANNELS;
648 send_chunk(sdi, transfer->buffer, samples_received);
649 devc->samp_received += samples_received;
651 g_free(transfer->buffer);
652 libusb_free_transfer(transfer);
654 if (devc->limit_samples && devc->samp_received >= devc->limit_samples) {
655 sr_info("Requested number of samples reached, stopping. %"
656 PRIu64 " <= %" PRIu64, devc->limit_samples,
657 devc->samp_received);
658 sr_dev_acquisition_stop(sdi);
659 } else if (devc->limit_msec && (g_get_monotonic_time() -
660 devc->aq_started) / 1000 >= devc->limit_msec) {
661 sr_info("Requested time limit reached, stopping. %d <= %d",
662 (uint32_t)devc->limit_msec,
663 (uint32_t)(g_get_monotonic_time() - devc->aq_started) / 1000);
664 sr_dev_acquisition_stop(sdi);
666 read_channel(sdi, data_amount(sdi));
670 static int read_channel(const struct sr_dev_inst *sdi, uint32_t amount)
673 struct dev_context *devc;
677 amount = MIN(amount, MAX_PACKET_SIZE);
678 ret = hantek_6xxx_get_channeldata(sdi, receive_transfer, amount);
679 devc->read_start_ts = g_get_monotonic_time();
684 static int handle_event(int fd, int revents, void *cb_data)
686 const struct sr_dev_inst *sdi;
688 struct sr_dev_driver *di;
689 struct dev_context *devc;
690 struct drv_context *drvc;
700 /* Always handle pending libusb events. */
701 tv.tv_sec = tv.tv_usec = 0;
702 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
704 if (devc->dev_state == STOPPING) {
705 /* We've been told to wind up the acquisition. */
706 sr_dbg("Stopping acquisition.");
708 hantek_6xxx_stop_data_collecting(sdi);
710 * TODO: Doesn't really cancel pending transfers so they might
711 * come in after SR_DF_END is sent.
713 usb_source_remove(sdi->session, drvc->sr_ctx);
715 std_session_send_df_end(sdi);
717 devc->dev_state = IDLE;
725 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
727 struct dev_context *devc;
728 struct sr_dev_driver *di = sdi->driver;
729 struct drv_context *drvc = di->context;
733 if (configure_channels(sdi) != SR_OK) {
734 sr_err("Failed to configure channels.");
738 if (hantek_6xxx_init(sdi) != SR_OK)
741 std_session_send_df_header(sdi);
743 devc->samp_received = 0;
744 devc->dev_state = FLUSH;
746 usb_source_add(sdi->session, drvc->sr_ctx, TICK,
747 handle_event, (void *)sdi);
749 hantek_6xxx_start_data_collecting(sdi);
751 read_channel(sdi, FLUSH_PACKET_SIZE);
756 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
758 struct dev_context *devc;
761 devc->dev_state = STOPPING;
766 static struct sr_dev_driver hantek_6xxx_driver_info = {
767 .name = "hantek-6xxx",
768 .longname = "Hantek 6xxx",
771 .cleanup = std_cleanup,
773 .dev_list = std_dev_list,
774 .dev_clear = dev_clear,
775 .config_get = config_get,
776 .config_set = config_set,
777 .config_list = config_list,
778 .dev_open = dev_open,
779 .dev_close = dev_close,
780 .dev_acquisition_start = dev_acquisition_start,
781 .dev_acquisition_stop = dev_acquisition_stop,
784 SR_REGISTER_DEV_DRIVER(hantek_6xxx_driver_info);