2 * This file is part of the sigrok project.
4 * Copyright (C) 2012 Bert Vermeulen <bert@biot.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 #include <sys/types.h>
32 #include "libsigrok.h"
33 #include "libsigrok-internal.h"
38 /* Max time in ms before we want to check on USB events */
39 /* TODO tune this properly */
42 static const int hwcaps[] = {
43 SR_HWCAP_OSCILLOSCOPE,
44 SR_HWCAP_LIMIT_SAMPLES,
48 SR_HWCAP_TRIGGER_SOURCE,
49 SR_HWCAP_TRIGGER_SLOPE,
50 SR_HWCAP_HORIZ_TRIGGERPOS,
57 static const char *probe_names[] = {
63 static const struct dso_profile dev_profiles[] = {
64 { 0x04b4, 0x2090, 0x04b5, 0x2090,
66 FIRMWARE_DIR "/hantek-dso-2xxx.fw" },
67 { 0x04b4, 0x2150, 0x04b5, 0x2150,
69 FIRMWARE_DIR "/hantek-dso-2xxx.fw" },
70 { 0x04b4, 0x2250, 0x04b5, 0x2250,
72 FIRMWARE_DIR "/hantek-dso-2xxx.fw" },
73 { 0x04b4, 0x5200, 0x04b5, 0x5200,
75 FIRMWARE_DIR "/hantek-dso-5xxx.fw" },
76 { 0x04b4, 0x520a, 0x04b5, 0x520a,
77 "Hantek", "DSO-5200A",
78 FIRMWARE_DIR "/hantek-dso-5xxx.fw" },
79 { 0, 0, 0, 0, 0, 0, 0 },
82 static const uint64_t buffersizes[] = {
89 static const struct sr_rational timebases[] = {
110 static const struct sr_rational vdivs[] = {
125 static const char *trigger_sources[] = {
133 static const char *filter_targets[] = {
136 /* TODO: "TRIGGER", */
140 static const char *coupling[] = {
147 SR_PRIV libusb_context *usb_context = NULL;
148 SR_PRIV struct sr_dev_driver hantek_dso_driver_info;
149 static struct sr_dev_driver *hdi = &hantek_dso_driver_info;
151 static struct sr_dev_inst *dso_dev_new(int index, const struct dso_profile *prof)
153 struct sr_dev_inst *sdi;
156 sdi = sr_dev_inst_new(index, SR_ST_INITIALIZING,
157 prof->vendor, prof->model, NULL);
161 if (!(ctx = g_try_malloc0(sizeof(struct context)))) {
162 sr_err("hantek-dso: ctx malloc failed");
166 ctx->dev_state = IDLE;
167 ctx->timebase = DEFAULT_TIMEBASE;
168 ctx->ch1_enabled = TRUE;
169 ctx->ch2_enabled = TRUE;
170 ctx->voltage_ch1 = DEFAULT_VOLTAGE;
171 ctx->voltage_ch2 = DEFAULT_VOLTAGE;
172 ctx->coupling_ch1 = DEFAULT_COUPLING;
173 ctx->coupling_ch2 = DEFAULT_COUPLING;
174 ctx->voffset_ch1 = DEFAULT_VERT_OFFSET;
175 ctx->voffset_ch2 = DEFAULT_VERT_OFFSET;
176 ctx->voffset_trigger = DEFAULT_VERT_TRIGGERPOS;
177 ctx->framesize = DEFAULT_FRAMESIZE;
178 ctx->triggerslope = SLOPE_POSITIVE;
179 ctx->triggersource = g_strdup(DEFAULT_TRIGGER_SOURCE);
180 ctx->triggerposition = DEFAULT_HORIZ_TRIGGERPOS;
182 hdi->instances = g_slist_append(hdi->instances, sdi);
187 static int configure_probes(struct context *ctx, const GSList *probes)
189 const struct sr_probe *probe;
192 ctx->ch1_enabled = ctx->ch2_enabled = FALSE;
193 for (l = probes; l; l = l->next) {
194 probe = (struct sr_probe *)l->data;
195 if (probe->index == 1)
196 ctx->ch1_enabled = probe->enabled;
197 else if (probe->index == 2)
198 ctx->ch2_enabled = probe->enabled;
204 /* Properly close and free all devices. */
205 static void clear_instances(void)
207 struct sr_dev_inst *sdi;
211 for (l = hdi->instances; l; l = l->next) {
212 if (!(sdi = l->data)) {
213 /* Log error, but continue cleaning up the rest. */
214 sr_err("hantek-dso: %s: sdi was NULL, continuing", __func__);
217 if (!(ctx = sdi->priv)) {
218 /* Log error, but continue cleaning up the rest. */
219 sr_err("hantek-dso: %s: sdi->priv was NULL, continuing", __func__);
223 sr_usb_dev_inst_free(ctx->usb);
224 g_free(ctx->triggersource);
226 sr_dev_inst_free(sdi);
229 g_slist_free(hdi->instances);
230 hdi->instances = NULL;
234 static int hw_init(void)
237 if (libusb_init(&usb_context) != 0) {
238 sr_err("hantek-dso: Failed to initialize USB.");
245 static GSList *hw_scan(GSList *options)
247 struct sr_dev_inst *sdi;
248 const struct dso_profile *prof;
251 struct libusb_device_descriptor des;
252 libusb_device **devlist;
253 int devcnt, ret, i, j;
258 hdi->instances = NULL;
262 /* Find all Hantek DSO devices and upload firmware to all of them. */
263 libusb_get_device_list(usb_context, &devlist);
264 for (i = 0; devlist[i]; i++) {
265 if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
266 sr_err("hantek-dso: failed to get device descriptor: %d", ret);
271 for (j = 0; dev_profiles[j].orig_vid; j++) {
272 if (des.idVendor == dev_profiles[j].orig_vid
273 && des.idProduct == dev_profiles[j].orig_pid) {
274 /* Device matches the pre-firmware profile. */
275 prof = &dev_profiles[j];
276 sr_dbg("hantek-dso: Found a %s %s.", prof->vendor, prof->model);
277 sdi = dso_dev_new(devcnt, prof);
278 devices = g_slist_append(devices, sdi);
280 if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
281 prof->firmware) == SR_OK)
282 /* Remember when the firmware on this device was updated */
283 ctx->fw_updated = g_get_monotonic_time();
285 sr_err("hantek-dso: firmware upload failed for "
286 "device %d", devcnt);
287 /* Dummy USB address of 0xff will get overwritten later. */
288 ctx->usb = sr_usb_dev_inst_new(
289 libusb_get_bus_number(devlist[i]), 0xff, NULL);
292 } else if (des.idVendor == dev_profiles[j].fw_vid
293 && des.idProduct == dev_profiles[j].fw_pid) {
294 /* Device matches the post-firmware profile. */
295 prof = &dev_profiles[j];
296 sr_dbg("hantek-dso: Found a %s %s.", prof->vendor, prof->model);
297 sdi = dso_dev_new(devcnt, prof);
298 sdi->status = SR_ST_INACTIVE;
299 devices = g_slist_append(devices, sdi);
301 ctx->usb = sr_usb_dev_inst_new(
302 libusb_get_bus_number(devlist[i]),
303 libusb_get_device_address(devlist[i]), NULL);
309 /* not a supported VID/PID */
312 libusb_free_device_list(devlist, 1);
317 static int hw_dev_open(int dev_index)
319 struct sr_dev_inst *sdi;
321 int64_t timediff_us, timediff_ms;
324 if (!(sdi = sr_dev_inst_get(hdi->instances, dev_index)))
329 * if the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
330 * for the FX2 to renumerate
333 if (ctx->fw_updated > 0) {
334 sr_info("hantek-dso: waiting for device to reset");
335 /* takes at least 300ms for the FX2 to be gone from the USB bus */
336 g_usleep(300 * 1000);
338 while (timediff_ms < MAX_RENUM_DELAY_MS) {
339 if ((err = dso_open(dev_index)) == SR_OK)
341 g_usleep(100 * 1000);
342 timediff_us = g_get_monotonic_time() - ctx->fw_updated;
343 timediff_ms = timediff_us / 1000;
344 sr_spew("hantek-dso: waited %" PRIi64 " ms", timediff_ms);
346 sr_info("hantek-dso: device came back after %d ms", timediff_ms);
348 err = dso_open(dev_index);
352 sr_err("hantek-dso: unable to open device");
356 err = libusb_claim_interface(ctx->usb->devhdl, USB_INTERFACE);
358 sr_err("hantek-dso: Unable to claim interface: %d", err);
365 static int hw_dev_close(int dev_index)
367 struct sr_dev_inst *sdi;
369 if (!(sdi = sr_dev_inst_get(hdi->instances, dev_index)))
377 static int hw_cleanup(void)
383 libusb_exit(usb_context);
389 static const void *hw_dev_info_get(int dev_index, int dev_info_id)
391 struct sr_dev_inst *sdi;
395 if (!(sdi = sr_dev_inst_get(hdi->instances, dev_index)))
399 switch (dev_info_id) {
403 case SR_DI_NUM_PROBES:
404 info = GINT_TO_POINTER(NUM_PROBES);
406 case SR_DI_PROBE_NAMES:
409 case SR_DI_BUFFERSIZES:
412 case SR_DI_TIMEBASES:
415 case SR_DI_TRIGGER_SOURCES:
416 info = trigger_sources;
419 info = filter_targets;
427 /* TODO remove this */
428 case SR_DI_CUR_SAMPLERATE:
436 static int hw_dev_status_get(int dev_index)
438 struct sr_dev_inst *sdi;
440 if (!(sdi = sr_dev_inst_get(hdi->instances, dev_index)))
441 return SR_ST_NOT_FOUND;
446 static const int *hw_hwcap_get_all(void)
451 static int hw_dev_config_set(int dev_index, int hwcap, const void *value)
453 struct sr_dev_inst *sdi;
455 struct sr_rational tmp_rat;
461 if (!(sdi = sr_dev_inst_get(hdi->instances, dev_index)))
464 if (sdi->status != SR_ST_ACTIVE)
470 case SR_HWCAP_LIMIT_FRAMES:
471 ctx->limit_frames = *(const uint64_t *)value;
473 case SR_HWCAP_PROBECONFIG:
474 ret = configure_probes(ctx, (const GSList *)value);
476 case SR_HWCAP_TRIGGER_SLOPE:
477 tmp_u64 = *(const int *)value;
478 if (tmp_u64 != SLOPE_NEGATIVE && tmp_u64 != SLOPE_POSITIVE)
480 ctx->triggerslope = tmp_u64;
482 case SR_HWCAP_HORIZ_TRIGGERPOS:
483 tmp_float = *(const float *)value;
484 if (tmp_float < 0.0 || tmp_float > 1.0) {
485 sr_err("hantek-dso: trigger position should be between 0.0 and 1.0");
488 ctx->triggerposition = tmp_float;
490 case SR_HWCAP_BUFFERSIZE:
491 tmp_u64 = *(const int *)value;
492 for (i = 0; buffersizes[i]; i++) {
493 if (buffersizes[i] == tmp_u64) {
494 ctx->framesize = tmp_u64;
498 if (buffersizes[i] == 0)
501 case SR_HWCAP_TIMEBASE:
502 tmp_rat = *(const struct sr_rational *)value;
503 for (i = 0; timebases[i].p && timebases[i].q; i++) {
504 if (timebases[i].p == tmp_rat.p
505 && timebases[i].q == tmp_rat.q) {
510 if (timebases[i].p == 0 && timebases[i].q == 0)
513 case SR_HWCAP_TRIGGER_SOURCE:
514 for (i = 0; trigger_sources[i]; i++) {
515 if (!strcmp(value, trigger_sources[i])) {
516 ctx->triggersource = g_strdup(value);
520 if (trigger_sources[i] == 0)
523 case SR_HWCAP_FILTER:
524 ctx->filter_ch1 = ctx->filter_ch2 = ctx->filter_trigger = 0;
525 targets = g_strsplit(value, ",", 0);
526 for (i = 0; targets[i]; i++) {
527 if (targets[i] == '\0')
528 /* Empty filter string can be used to clear them all. */
530 else if (!strcmp(targets[i], "CH1"))
531 ctx->filter_ch1 = TRUE;
532 else if (!strcmp(targets[i], "CH2"))
533 ctx->filter_ch2 = TRUE;
534 else if (!strcmp(targets[i], "TRIGGER"))
535 ctx->filter_trigger = TRUE;
537 sr_err("invalid filter target %s", targets[i]);
544 /* TODO not supporting vdiv per channel yet */
545 tmp_rat = *(const struct sr_rational *)value;
546 for (i = 0; vdivs[i].p && vdivs[i].q; i++) {
547 if (vdivs[i].p == tmp_rat.p
548 && vdivs[i].q == tmp_rat.q) {
549 ctx->voltage_ch1 = i;
550 ctx->voltage_ch2 = i;
554 if (vdivs[i].p == 0 && vdivs[i].q == 0)
557 case SR_HWCAP_COUPLING:
558 /* TODO not supporting coupling per channel yet */
559 for (i = 0; coupling[i]; i++) {
560 if (!strcmp(value, coupling[i])) {
561 ctx->coupling_ch1 = i;
562 ctx->coupling_ch2 = i;
566 if (coupling[i] == 0)
576 static void send_chunk(struct context *ctx, unsigned char *buf,
579 struct sr_datafeed_packet packet;
580 struct sr_datafeed_analog analog;
581 float ch1, ch2, range;
582 int num_probes, data_offset, i;
584 num_probes = (ctx->ch1_enabled && ctx->ch2_enabled) ? 2 : 1;
585 packet.type = SR_DF_ANALOG;
586 packet.payload = &analog;
587 /* TODO: support for 5xxx series 9-bit samples */
588 analog.num_samples = num_samples;
589 analog.mq = SR_MQ_VOLTAGE;
590 analog.unit = SR_UNIT_VOLT;
591 analog.data = g_try_malloc(analog.num_samples * sizeof(float) * num_probes);
593 for (i = 0; i < analog.num_samples; i++) {
594 /* The device always sends data for both channels. If a channel
595 * is disabled, it contains a copy of the enabled channel's
596 * data. However, we only send the requested channels to the bus.
598 * Voltage values are encoded as a value 0-255 (0-512 on the 5200*),
599 * where the value is a point in the range represented by the vdiv
600 * setting. There are 8 vertical divs, so e.g. 500mV/div represents
601 * 4V peak-to-peak where 0 = -2V and 255 = +2V.
603 /* TODO: support for 5xxx series 9-bit samples */
604 if (ctx->ch1_enabled) {
605 range = ((float)vdivs[ctx->voltage_ch1].p / vdivs[ctx->voltage_ch1].q) * 8;
606 ch1 = range / 255 * *(buf + i * 2 + 1);
607 /* Value is centered around 0V. */
609 analog.data[data_offset++] = ch1;
611 if (ctx->ch2_enabled) {
612 range = ((float)vdivs[ctx->voltage_ch2].p / vdivs[ctx->voltage_ch2].q) * 8;
613 ch2 = range / 255 * *(buf + i * 2);
615 analog.data[data_offset++] = ch2;
618 sr_session_send(ctx->cb_data, &packet);
622 /* Called by libusb (as triggered by handle_event()) when a transfer comes in.
623 * Only channel data comes in asynchronously, and all transfers for this are
624 * queued up beforehand, so this just needs so chuck the incoming data onto
625 * the libsigrok session bus.
627 static void receive_transfer(struct libusb_transfer *transfer)
629 struct sr_datafeed_packet packet;
631 int num_samples, pre;
633 ctx = transfer->user_data;
634 sr_dbg("hantek-dso: receive_transfer(): status %d received %d bytes",
635 transfer->status, transfer->actual_length);
637 if (transfer->actual_length == 0)
638 /* Nothing to send to the bus. */
641 num_samples = transfer->actual_length / 2;
643 sr_dbg("hantek-dso: got %d-%d/%d samples in frame", ctx->samp_received + 1,
644 ctx->samp_received + num_samples, ctx->framesize);
646 /* The device always sends a full frame, but the beginning of the frame
647 * doesn't represent the trigger point. The offset at which the trigger
648 * happened came in with the capture state, so we need to start sending
649 * from there up the session bus. The samples in the frame buffer before
650 * that trigger point came after the end of the device's frame buffer was
651 * reached, and it wrapped around to overwrite up until the trigger point.
653 if (ctx->samp_received < ctx->trigger_offset) {
654 /* Trigger point not yet reached. */
655 if (ctx->samp_received + num_samples < ctx->trigger_offset) {
656 /* The entire chunk is before the trigger point. */
657 memcpy(ctx->framebuf + ctx->samp_buffered * 2,
658 transfer->buffer, num_samples * 2);
659 ctx->samp_buffered += num_samples;
661 /* This chunk hits or overruns the trigger point.
662 * Store the part before the trigger fired, and
663 * send the rest up to the session bus. */
664 pre = ctx->trigger_offset - ctx->samp_received;
665 memcpy(ctx->framebuf + ctx->samp_buffered * 2,
666 transfer->buffer, pre * 2);
667 ctx->samp_buffered += pre;
669 /* The rest of this chunk starts with the trigger point. */
670 sr_dbg("hantek-dso: reached trigger point, %d samples buffered",
673 /* Avoid the corner case where the chunk ended at
674 * exactly the trigger point. */
675 if (num_samples > pre)
676 send_chunk(ctx, transfer->buffer + pre * 2,
680 /* Already past the trigger point, just send it all out. */
681 send_chunk(ctx, transfer->buffer,
685 ctx->samp_received += num_samples;
687 /* Everything in this transfer was either copied to the buffer or
688 * sent to the session bus. */
689 g_free(transfer->buffer);
690 libusb_free_transfer(transfer);
692 if (ctx->samp_received >= ctx->framesize) {
693 /* That was the last chunk in this frame. Send the buffered
694 * pre-trigger samples out now, in one big chunk. */
695 sr_dbg("hantek-dso: end of frame, sending %d pre-trigger buffered samples",
697 send_chunk(ctx, ctx->framebuf, ctx->samp_buffered);
699 /* Mark the end of this frame. */
700 packet.type = SR_DF_FRAME_END;
701 sr_session_send(ctx->cb_data, &packet);
703 if (ctx->limit_frames && ++ctx->num_frames == ctx->limit_frames) {
704 /* Terminate session */
705 /* TODO: don't leave pending USB transfers hanging */
706 packet.type = SR_DF_END;
707 sr_session_send(ctx->cb_data, &packet);
709 ctx->dev_state = NEW_CAPTURE;
715 static int handle_event(int fd, int revents, void *cb_data)
717 struct sr_datafeed_packet packet;
721 uint32_t trigger_offset;
722 uint8_t capturestate;
724 /* Avoid compiler warnings. */
728 /* Always handle pending libusb events. */
729 tv.tv_sec = tv.tv_usec = 0;
730 libusb_handle_events_timeout(usb_context, &tv);
734 if (ctx->dev_state == NEW_CAPTURE) {
735 if (dso_capture_start(ctx) != SR_OK)
737 if (dso_enable_trigger(ctx) != SR_OK)
739 // if (dso_force_trigger(ctx) != SR_OK)
741 sr_dbg("hantek-dso: successfully requested next chunk");
742 ctx->dev_state = CAPTURE;
745 if (ctx->dev_state != CAPTURE)
748 if ((dso_get_capturestate(ctx, &capturestate, &trigger_offset)) != SR_OK)
751 sr_dbg("hantek-dso: capturestate %d", capturestate);
752 sr_dbg("hantek-dso: trigger offset 0x%.6x", trigger_offset);
753 switch (capturestate) {
755 if (++ctx->capture_empty_count >= MAX_CAPTURE_EMPTY) {
756 ctx->capture_empty_count = 0;
757 if (dso_capture_start(ctx) != SR_OK)
759 if (dso_enable_trigger(ctx) != SR_OK)
761 // if (dso_force_trigger(ctx) != SR_OK)
763 sr_dbg("hantek-dso: successfully requested next chunk");
766 case CAPTURE_FILLING:
769 case CAPTURE_READY_8BIT:
770 /* Remember where in the captured frame the trigger is. */
771 ctx->trigger_offset = trigger_offset;
773 num_probes = (ctx->ch1_enabled && ctx->ch2_enabled) ? 2 : 1;
774 ctx->framebuf = g_try_malloc(ctx->framesize * num_probes * 2);
775 ctx->samp_buffered = ctx->samp_received = 0;
777 /* Tell the scope to send us the first frame. */
778 if (dso_get_channeldata(ctx, receive_transfer) != SR_OK)
781 /* Don't hit the state machine again until we're done fetching
782 * the data we just told the scope to send.
784 ctx->dev_state = FETCH_DATA;
786 /* Tell the frontend a new frame is on the way. */
787 packet.type = SR_DF_FRAME_BEGIN;
788 sr_session_send(cb_data, &packet);
790 case CAPTURE_READY_9BIT:
792 sr_err("not yet supported");
794 case CAPTURE_TIMEOUT:
795 /* Doesn't matter, we'll try again next time. */
798 sr_dbg("unknown capture state");
804 static int hw_dev_acquisition_start(int dev_index, void *cb_data)
806 const struct libusb_pollfd **lupfd;
807 struct sr_datafeed_packet packet;
808 struct sr_datafeed_header header;
809 struct sr_datafeed_meta_analog meta;
810 struct sr_dev_inst *sdi;
814 if (!(sdi = sr_dev_inst_get(hdi->instances, dev_index)))
817 if (sdi->status != SR_ST_ACTIVE)
821 ctx->cb_data = cb_data;
823 if (dso_init(ctx) != SR_OK)
826 if (dso_capture_start(ctx) != SR_OK)
829 ctx->dev_state = CAPTURE;
830 lupfd = libusb_get_pollfds(usb_context);
831 for (i = 0; lupfd[i]; i++)
832 sr_source_add(lupfd[i]->fd, lupfd[i]->events, TICK, handle_event,
836 /* Send header packet to the session bus. */
837 packet.type = SR_DF_HEADER;
838 packet.payload = (unsigned char *)&header;
839 header.feed_version = 1;
840 gettimeofday(&header.starttime, NULL);
841 sr_session_send(cb_data, &packet);
843 /* Send metadata about the SR_DF_ANALOG packets to come. */
844 packet.type = SR_DF_META_ANALOG;
845 packet.payload = &meta;
846 meta.num_probes = NUM_PROBES;
847 sr_session_send(cb_data, &packet);
852 /* TODO: doesn't really cancel pending transfers so they might come in after
855 static int hw_dev_acquisition_stop(int dev_index, void *cb_data)
857 struct sr_datafeed_packet packet;
858 struct sr_dev_inst *sdi;
861 if (!(sdi = sr_dev_inst_get(hdi->instances, dev_index)))
864 if (sdi->status != SR_ST_ACTIVE)
868 ctx->dev_state = IDLE;
870 packet.type = SR_DF_END;
871 sr_session_send(cb_data, &packet);
876 SR_PRIV struct sr_dev_driver hantek_dso_driver_info = {
877 .name = "hantek-dso",
878 .longname = "Hantek DSO",
881 .cleanup = hw_cleanup,
883 .dev_open = hw_dev_open,
884 .dev_close = hw_dev_close,
885 .dev_info_get = hw_dev_info_get,
886 .dev_status_get = hw_dev_status_get,
887 .hwcap_get_all = hw_hwcap_get_all,
888 .dev_config_set = hw_dev_config_set,
889 .dev_acquisition_start = hw_dev_acquisition_start,
890 .dev_acquisition_stop = hw_dev_acquisition_stop,