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 ARRAY_AND_SIZE(dc_coupling), FALSE,
69 0x8102, 0x8102, 0x1d50, 0x608e, 0x0002,
70 "Sainsmart", "DDS120", "fx2lafw-sainsmart-dds120.fw",
71 ARRAY_AND_SIZE(acdc_coupling), TRUE,
74 0x04b4, 0x602a, 0x1d50, 0x608e, 0x0003,
75 "Hantek", "6022BL", "fx2lafw-hantek-6022bl.fw",
76 ARRAY_AND_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->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_helper(struct dev_context *devc)
157 g_slist_free(devc->enabled_channels);
160 static int dev_clear(const struct sr_dev_driver *di)
162 return std_dev_clear_with_callback(di, (std_dev_clear_callback)clear_helper);
165 static GSList *scan(struct sr_dev_driver *di, GSList *options)
167 struct drv_context *drvc;
168 struct dev_context *devc;
169 struct sr_dev_inst *sdi;
170 struct sr_usb_dev_inst *usb;
171 struct sr_config *src;
172 const struct hantek_6xxx_profile *prof;
173 GSList *l, *devices, *conn_devices;
174 struct libusb_device_descriptor des;
175 libusb_device **devlist;
178 char connection_id[64];
185 for (l = options; l; l = l->next) {
187 if (src->key == SR_CONF_CONN) {
188 conn = g_variant_get_string(src->data, NULL);
193 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
197 /* Find all Hantek 60xx devices and upload firmware to all of them. */
198 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
199 for (i = 0; devlist[i]; i++) {
202 for (l = conn_devices; l; l = l->next) {
204 if (usb->bus == libusb_get_bus_number(devlist[i])
205 && usb->address == libusb_get_device_address(devlist[i]))
209 /* This device matched none of the ones that
210 * matched the conn specification. */
214 libusb_get_device_descriptor(devlist[i], &des);
216 if (usb_get_port_path(devlist[i], connection_id, sizeof(connection_id)) < 0)
220 for (j = 0; dev_profiles[j].orig_vid; j++) {
221 if (des.idVendor == dev_profiles[j].orig_vid
222 && des.idProduct == dev_profiles[j].orig_pid) {
223 /* Device matches the pre-firmware profile. */
224 prof = &dev_profiles[j];
225 sr_dbg("Found a %s %s.", prof->vendor, prof->model);
226 sdi = hantek_6xxx_dev_new(prof);
227 sdi->connection_id = g_strdup(connection_id);
228 devices = g_slist_append(devices, sdi);
230 if (ezusb_upload_firmware(drvc->sr_ctx, devlist[i],
231 USB_CONFIGURATION, prof->firmware) == SR_OK) {
232 /* Remember when the firmware on this device was updated. */
233 devc->fw_updated = g_get_monotonic_time();
235 sr_err("Firmware upload failed, name %s.", prof->firmware);
237 /* Dummy USB address of 0xff will get overwritten later. */
238 sdi->conn = sr_usb_dev_inst_new(
239 libusb_get_bus_number(devlist[i]), 0xff, NULL);
241 } else if (des.idVendor == dev_profiles[j].fw_vid
242 && des.idProduct == dev_profiles[j].fw_pid
243 && des.bcdDevice == dev_profiles[j].fw_prod_ver) {
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,
324 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
326 struct dev_context *devc;
327 struct sr_usb_dev_inst *usb;
328 const uint64_t *vdiv;
332 case SR_CONF_NUM_VDIV:
333 *data = g_variant_new_int32(ARRAY_SIZE(vdivs));
343 case SR_CONF_SAMPLERATE:
344 *data = g_variant_new_uint64(devc->samplerate);
346 case SR_CONF_LIMIT_MSEC:
347 *data = g_variant_new_uint64(devc->limit_msec);
349 case SR_CONF_LIMIT_SAMPLES:
350 *data = g_variant_new_uint64(devc->limit_samples);
356 if (usb->address == 255)
357 /* Device still needs to re-enumerate after firmware
358 * upload, so we don't know its (future) address. */
360 *data = g_variant_new_printf("%d.%d", usb->bus, usb->address);
366 if (sdi->channel_groups->data == cg)
368 else if (sdi->channel_groups->next->data == cg)
374 vdiv = vdivs[devc->voltage[ch_idx]];
375 *data = g_variant_new("(tt)", vdiv[0], vdiv[1]);
377 case SR_CONF_COUPLING:
378 *data = g_variant_new_string((devc->coupling[ch_idx] \
379 == COUPLING_DC) ? "DC" : "AC");
387 static int config_set(uint32_t key, GVariant *data,
388 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
390 struct dev_context *devc;
396 case SR_CONF_SAMPLERATE:
397 devc->samplerate = g_variant_get_uint64(data);
398 hantek_6xxx_update_samplerate(sdi);
400 case SR_CONF_LIMIT_MSEC:
401 devc->limit_msec = g_variant_get_uint64(data);
403 case SR_CONF_LIMIT_SAMPLES:
404 devc->limit_samples = g_variant_get_uint64(data);
410 if (sdi->channel_groups->data == cg)
412 else if (sdi->channel_groups->next->data == cg)
418 if ((idx = std_u64_tuple_idx(data, ARRAY_AND_SIZE(vdivs))) < 0)
420 devc->voltage[ch_idx] = idx;
421 hantek_6xxx_update_vdiv(sdi);
423 case SR_CONF_COUPLING:
424 if ((idx = std_str_idx(data, devc->coupling_vals,
425 devc->coupling_tab_size)) < 0)
427 devc->coupling[ch_idx] = idx;
437 static int config_list(uint32_t key, GVariant **data,
438 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
440 struct dev_context *devc;
442 devc = (sdi) ? sdi->priv : NULL;
446 case SR_CONF_SCAN_OPTIONS:
447 case SR_CONF_DEVICE_OPTIONS:
448 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
449 case SR_CONF_SAMPLERATE:
450 *data = std_gvar_samplerates(ARRAY_AND_SIZE(samplerates));
457 case SR_CONF_DEVICE_OPTIONS:
458 *data = std_gvar_array_u32(ARRAY_AND_SIZE(devopts_cg));
460 case SR_CONF_COUPLING:
463 *data = g_variant_new_strv(devc->coupling_vals, devc->coupling_tab_size);
466 *data = std_gvar_tuple_array(ARRAY_AND_SIZE(vdivs));
476 /* Minimise data amount for limit_samples and limit_msec limits. */
477 static uint32_t data_amount(const struct sr_dev_inst *sdi)
479 struct dev_context *devc = sdi->priv;
480 uint32_t data_left, data_left_2, i;
483 if (devc->limit_msec) {
484 time_left = devc->limit_msec - (g_get_monotonic_time() - devc->aq_started) / 1000;
485 data_left = devc->samplerate * MAX(time_left, 0) * NUM_CHANNELS / 1000;
486 } else if (devc->limit_samples) {
487 data_left = (devc->limit_samples - devc->samp_received) * NUM_CHANNELS;
489 data_left = devc->samplerate * NUM_CHANNELS;
492 /* Round up to nearest power of two. */
493 for (i = MIN_PACKET_SIZE; i < data_left; i *= 2)
497 sr_spew("data_amount: %u (rounded to power of 2: %u)", data_left, data_left_2);
502 static void send_chunk(struct sr_dev_inst *sdi, unsigned char *buf,
505 struct sr_datafeed_packet packet;
506 struct sr_datafeed_analog analog;
507 struct sr_analog_encoding encoding;
508 struct sr_analog_meaning meaning;
509 struct sr_analog_spec spec;
510 struct dev_context *devc = sdi->priv;
511 GSList *channels = devc->enabled_channels;
513 const float ch_bit[] = { RANGE(0) / 255, RANGE(1) / 255 };
514 const float ch_center[] = { RANGE(0) / 2, RANGE(1) / 2 };
516 sr_analog_init(&analog, &encoding, &meaning, &spec, 0);
518 packet.type = SR_DF_ANALOG;
519 packet.payload = &analog;
521 analog.num_samples = num_samples;
522 analog.meaning->mq = SR_MQ_VOLTAGE;
523 analog.meaning->unit = SR_UNIT_VOLT;
524 analog.meaning->mqflags = 0;
526 analog.data = g_try_malloc(num_samples * sizeof(float));
528 sr_err("Analog data buffer malloc failed.");
529 devc->dev_state = STOPPING;
533 for (int ch = 0; ch < NUM_CHANNELS; ch++) {
534 if (!devc->ch_enabled[ch])
537 float vdivlog = log10f(ch_bit[ch]);
538 int digits = -(int)vdivlog + (vdivlog < 0.0);
539 analog.encoding->digits = digits;
540 analog.spec->spec_digits = digits;
541 analog.meaning->channels = g_slist_append(NULL, channels->data);
543 for (int i = 0; i < num_samples; i++) {
545 * The device always sends data for both channels. If a channel
546 * is disabled, it contains a copy of the enabled channel's
547 * data. However, we only send the requested channels to
550 * Voltage values are encoded as a value 0-255, where the
551 * value is a point in the range represented by the vdiv
552 * setting. There are 10 vertical divs, so e.g. 500mV/div
553 * represents 5V peak-to-peak where 0 = -2.5V and 255 = +2.5V.
555 ((float *)analog.data)[i] = ch_bit[ch] * *(buf + i * 2 + ch) - ch_center[ch];
558 sr_session_send(sdi, &packet);
559 g_slist_free(analog.meaning->channels);
561 channels = channels->next;
567 * Called by libusb (as triggered by handle_event()) when a transfer comes in.
568 * Only channel data comes in asynchronously, and all transfers for this are
569 * queued up beforehand, so this just needs to chuck the incoming data onto
570 * the libsigrok session bus.
572 static void LIBUSB_CALL receive_transfer(struct libusb_transfer *transfer)
574 struct sr_dev_inst *sdi;
575 struct dev_context *devc;
577 sdi = transfer->user_data;
580 if (devc->dev_state == FLUSH) {
581 g_free(transfer->buffer);
582 libusb_free_transfer(transfer);
583 devc->dev_state = CAPTURE;
584 devc->aq_started = g_get_monotonic_time();
585 read_channel(sdi, data_amount(sdi));
589 if (devc->dev_state != CAPTURE)
592 sr_spew("receive_transfer(): calculated samplerate == %" PRIu64 "ks/s",
593 (uint64_t)(transfer->actual_length * 1000 /
594 (g_get_monotonic_time() - devc->read_start_ts + 1) /
597 sr_spew("receive_transfer(): status %s received %d bytes.",
598 libusb_error_name(transfer->status), transfer->actual_length);
600 if (transfer->actual_length == 0)
601 /* Nothing to send to the bus. */
604 unsigned samples_received = transfer->actual_length / NUM_CHANNELS;
605 send_chunk(sdi, transfer->buffer, samples_received);
606 devc->samp_received += samples_received;
608 g_free(transfer->buffer);
609 libusb_free_transfer(transfer);
611 if (devc->limit_samples && devc->samp_received >= devc->limit_samples) {
612 sr_info("Requested number of samples reached, stopping. %"
613 PRIu64 " <= %" PRIu64, devc->limit_samples,
614 devc->samp_received);
615 sr_dev_acquisition_stop(sdi);
616 } else if (devc->limit_msec && (g_get_monotonic_time() -
617 devc->aq_started) / 1000 >= devc->limit_msec) {
618 sr_info("Requested time limit reached, stopping. %d <= %d",
619 (uint32_t)devc->limit_msec,
620 (uint32_t)(g_get_monotonic_time() - devc->aq_started) / 1000);
621 sr_dev_acquisition_stop(sdi);
623 read_channel(sdi, data_amount(sdi));
627 static int read_channel(const struct sr_dev_inst *sdi, uint32_t amount)
630 struct dev_context *devc;
634 amount = MIN(amount, MAX_PACKET_SIZE);
635 ret = hantek_6xxx_get_channeldata(sdi, receive_transfer, amount);
636 devc->read_start_ts = g_get_monotonic_time();
641 static int handle_event(int fd, int revents, void *cb_data)
643 const struct sr_dev_inst *sdi;
645 struct sr_dev_driver *di;
646 struct dev_context *devc;
647 struct drv_context *drvc;
657 /* Always handle pending libusb events. */
658 tv.tv_sec = tv.tv_usec = 0;
659 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
661 if (devc->dev_state == STOPPING) {
662 /* We've been told to wind up the acquisition. */
663 sr_dbg("Stopping acquisition.");
665 hantek_6xxx_stop_data_collecting(sdi);
667 * TODO: Doesn't really cancel pending transfers so they might
668 * come in after SR_DF_END is sent.
670 usb_source_remove(sdi->session, drvc->sr_ctx);
672 std_session_send_df_end(sdi);
674 devc->dev_state = IDLE;
682 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
684 struct dev_context *devc;
685 struct sr_dev_driver *di = sdi->driver;
686 struct drv_context *drvc = di->context;
690 if (configure_channels(sdi) != SR_OK) {
691 sr_err("Failed to configure channels.");
695 if (hantek_6xxx_init(sdi) != SR_OK)
698 std_session_send_df_header(sdi);
700 devc->samp_received = 0;
701 devc->dev_state = FLUSH;
703 usb_source_add(sdi->session, drvc->sr_ctx, TICK,
704 handle_event, (void *)sdi);
706 hantek_6xxx_start_data_collecting(sdi);
708 read_channel(sdi, FLUSH_PACKET_SIZE);
713 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
715 struct dev_context *devc;
718 devc->dev_state = STOPPING;
723 static struct sr_dev_driver hantek_6xxx_driver_info = {
724 .name = "hantek-6xxx",
725 .longname = "Hantek 6xxx",
728 .cleanup = std_cleanup,
730 .dev_list = std_dev_list,
731 .dev_clear = dev_clear,
732 .config_get = config_get,
733 .config_set = config_set,
734 .config_list = config_list,
735 .dev_open = dev_open,
736 .dev_close = dev_close,
737 .dev_acquisition_start = dev_acquisition_start,
738 .dev_acquisition_stop = dev_acquisition_stop,
741 SR_REGISTER_DEV_DRIVER(hantek_6xxx_driver_info);