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 struct sr_dev_driver hantek_dso_driver_info;
148 static struct sr_dev_driver *hdi = &hantek_dso_driver_info;
149 static int hw_dev_acquisition_stop(const struct sr_dev_inst *sdi,
152 static struct sr_dev_inst *dso_dev_new(int index, const struct dso_profile *prof)
154 struct sr_dev_inst *sdi;
155 struct sr_probe *probe;
156 struct drv_context *drvc;
157 struct dev_context *devc;
160 sdi = sr_dev_inst_new(index, SR_ST_INITIALIZING,
161 prof->vendor, prof->model, NULL);
166 /* Add only the real probes -- EXT isn't a source of data, only
167 * a trigger source internal to the device.
169 for (i = 0; probe_names[i]; i++) {
170 if (!(probe = sr_probe_new(i, SR_PROBE_ANALOG, TRUE,
173 sdi->probes = g_slist_append(sdi->probes, probe);
176 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
177 sr_err("hantek-dso: devc malloc failed");
180 devc->profile = prof;
181 devc->dev_state = IDLE;
182 devc->timebase = DEFAULT_TIMEBASE;
183 devc->ch1_enabled = TRUE;
184 devc->ch2_enabled = TRUE;
185 devc->voltage_ch1 = DEFAULT_VOLTAGE;
186 devc->voltage_ch2 = DEFAULT_VOLTAGE;
187 devc->coupling_ch1 = DEFAULT_COUPLING;
188 devc->coupling_ch2 = DEFAULT_COUPLING;
189 devc->voffset_ch1 = DEFAULT_VERT_OFFSET;
190 devc->voffset_ch2 = DEFAULT_VERT_OFFSET;
191 devc->voffset_trigger = DEFAULT_VERT_TRIGGERPOS;
192 devc->framesize = DEFAULT_FRAMESIZE;
193 devc->triggerslope = SLOPE_POSITIVE;
194 devc->triggersource = g_strdup(DEFAULT_TRIGGER_SOURCE);
195 devc->triggerposition = DEFAULT_HORIZ_TRIGGERPOS;
198 drvc->instances = g_slist_append(drvc->instances, sdi);
203 static int configure_probes(struct dev_context *devc, const GSList *probes)
205 const struct sr_probe *probe;
208 devc->ch1_enabled = devc->ch2_enabled = FALSE;
209 for (l = probes; l; l = l->next) {
210 probe = (struct sr_probe *)l->data;
211 if (probe->index == 0)
212 devc->ch1_enabled = probe->enabled;
213 else if (probe->index == 1)
214 devc->ch2_enabled = probe->enabled;
220 /* Properly close and free all devices. */
221 static void clear_instances(void)
223 struct sr_dev_inst *sdi;
224 struct drv_context *drvc;
225 struct dev_context *devc;
229 for (l = drvc->instances; l; l = l->next) {
230 if (!(sdi = l->data)) {
231 /* Log error, but continue cleaning up the rest. */
232 sr_err("hantek-dso: %s: sdi was NULL, continuing", __func__);
235 if (!(devc = sdi->priv)) {
236 /* Log error, but continue cleaning up the rest. */
237 sr_err("hantek-dso: %s: sdi->priv was NULL, continuing", __func__);
241 sr_usb_dev_inst_free(devc->usb);
242 g_free(devc->triggersource);
244 sr_dev_inst_free(sdi);
247 g_slist_free(drvc->instances);
248 drvc->instances = NULL;
252 static int hw_init(void)
254 struct drv_context *drvc;
256 if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
257 sr_err("hantek-dso: driver context malloc failed.");
261 if (libusb_init(&drvc->usb_context) != 0) {
263 sr_err("hantek-dso: Failed to initialize USB.");
272 static GSList *hw_scan(GSList *options)
274 struct sr_dev_inst *sdi;
275 const struct dso_profile *prof;
276 struct drv_context *drvc;
277 struct dev_context *devc;
279 struct libusb_device_descriptor des;
280 libusb_device **devlist;
281 int devcnt, ret, i, j;
287 drvc->instances = NULL;
291 /* Find all Hantek DSO devices and upload firmware to all of them. */
292 libusb_get_device_list(drvc->usb_context, &devlist);
293 for (i = 0; devlist[i]; i++) {
294 if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
295 sr_err("hantek-dso: failed to get device descriptor: %d", ret);
300 for (j = 0; dev_profiles[j].orig_vid; j++) {
301 if (des.idVendor == dev_profiles[j].orig_vid
302 && des.idProduct == dev_profiles[j].orig_pid) {
303 /* Device matches the pre-firmware profile. */
304 prof = &dev_profiles[j];
305 sr_dbg("hantek-dso: Found a %s %s.", prof->vendor, prof->model);
306 sdi = dso_dev_new(devcnt, prof);
307 devices = g_slist_append(devices, sdi);
309 if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
310 prof->firmware) == SR_OK)
311 /* Remember when the firmware on this device was updated */
312 devc->fw_updated = g_get_monotonic_time();
314 sr_err("hantek-dso: firmware upload failed for "
315 "device %d", devcnt);
316 /* Dummy USB address of 0xff will get overwritten later. */
317 devc->usb = sr_usb_dev_inst_new(
318 libusb_get_bus_number(devlist[i]), 0xff, NULL);
321 } else if (des.idVendor == dev_profiles[j].fw_vid
322 && des.idProduct == dev_profiles[j].fw_pid) {
323 /* Device matches the post-firmware profile. */
324 prof = &dev_profiles[j];
325 sr_dbg("hantek-dso: Found a %s %s.", prof->vendor, prof->model);
326 sdi = dso_dev_new(devcnt, prof);
327 sdi->status = SR_ST_INACTIVE;
328 devices = g_slist_append(devices, sdi);
330 devc->usb = sr_usb_dev_inst_new(
331 libusb_get_bus_number(devlist[i]),
332 libusb_get_device_address(devlist[i]), NULL);
338 /* not a supported VID/PID */
341 libusb_free_device_list(devlist, 1);
346 static int hw_dev_open(struct sr_dev_inst *sdi)
348 struct dev_context *devc;
349 int64_t timediff_us, timediff_ms;
355 * if the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
356 * for the FX2 to renumerate
359 if (devc->fw_updated > 0) {
360 sr_info("hantek-dso: waiting for device to reset");
361 /* takes at least 300ms for the FX2 to be gone from the USB bus */
362 g_usleep(300 * 1000);
364 while (timediff_ms < MAX_RENUM_DELAY_MS) {
365 if ((err = dso_open(sdi)) == SR_OK)
367 g_usleep(100 * 1000);
368 timediff_us = g_get_monotonic_time() - devc->fw_updated;
369 timediff_ms = timediff_us / 1000;
370 sr_spew("hantek-dso: waited %" PRIi64 " ms", timediff_ms);
372 sr_info("hantek-dso: device came back after %d ms", timediff_ms);
378 sr_err("hantek-dso: unable to open device");
382 err = libusb_claim_interface(devc->usb->devhdl, USB_INTERFACE);
384 sr_err("hantek-dso: Unable to claim interface: %d", err);
391 static int hw_dev_close(struct sr_dev_inst *sdi)
399 static int hw_cleanup(void)
401 struct drv_context *drvc;
403 if (!(drvc = hdi->priv))
408 if (drvc->usb_context)
409 libusb_exit(drvc->usb_context);
410 drvc->usb_context = NULL;
415 static int hw_info_get(int info_id, const void **data,
416 const struct sr_dev_inst *sdi)
426 case SR_DI_NUM_PROBES:
427 *data = GINT_TO_POINTER(NUM_PROBES);
429 case SR_DI_PROBE_NAMES:
432 case SR_DI_BUFFERSIZES:
435 case SR_DI_TIMEBASES:
438 case SR_DI_TRIGGER_SOURCES:
439 *data = trigger_sources;
442 *data = filter_targets;
450 /* TODO remove this */
451 case SR_DI_CUR_SAMPLERATE:
461 static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
464 struct dev_context *devc;
465 struct sr_rational tmp_rat;
471 if (sdi->status != SR_ST_ACTIVE)
477 case SR_HWCAP_LIMIT_FRAMES:
478 devc->limit_frames = *(const uint64_t *)value;
480 case SR_HWCAP_PROBECONFIG:
481 ret = configure_probes(devc, (const GSList *)value);
483 case SR_HWCAP_TRIGGER_SLOPE:
484 tmp_u64 = *(const int *)value;
485 if (tmp_u64 != SLOPE_NEGATIVE && tmp_u64 != SLOPE_POSITIVE)
487 devc->triggerslope = tmp_u64;
489 case SR_HWCAP_HORIZ_TRIGGERPOS:
490 tmp_float = *(const float *)value;
491 if (tmp_float < 0.0 || tmp_float > 1.0) {
492 sr_err("hantek-dso: trigger position should be between 0.0 and 1.0");
495 devc->triggerposition = tmp_float;
497 case SR_HWCAP_BUFFERSIZE:
498 tmp_u64 = *(const int *)value;
499 for (i = 0; buffersizes[i]; i++) {
500 if (buffersizes[i] == tmp_u64) {
501 devc->framesize = tmp_u64;
505 if (buffersizes[i] == 0)
508 case SR_HWCAP_TIMEBASE:
509 tmp_rat = *(const struct sr_rational *)value;
510 for (i = 0; timebases[i].p && timebases[i].q; i++) {
511 if (timebases[i].p == tmp_rat.p
512 && timebases[i].q == tmp_rat.q) {
517 if (timebases[i].p == 0 && timebases[i].q == 0)
520 case SR_HWCAP_TRIGGER_SOURCE:
521 for (i = 0; trigger_sources[i]; i++) {
522 if (!strcmp(value, trigger_sources[i])) {
523 devc->triggersource = g_strdup(value);
527 if (trigger_sources[i] == 0)
530 case SR_HWCAP_FILTER:
531 devc->filter_ch1 = devc->filter_ch2 = devc->filter_trigger = 0;
532 targets = g_strsplit(value, ",", 0);
533 for (i = 0; targets[i]; i++) {
534 if (targets[i] == '\0')
535 /* Empty filter string can be used to clear them all. */
537 else if (!strcmp(targets[i], "CH1"))
538 devc->filter_ch1 = TRUE;
539 else if (!strcmp(targets[i], "CH2"))
540 devc->filter_ch2 = TRUE;
541 else if (!strcmp(targets[i], "TRIGGER"))
542 devc->filter_trigger = TRUE;
544 sr_err("invalid filter target %s", targets[i]);
551 /* TODO not supporting vdiv per channel yet */
552 tmp_rat = *(const struct sr_rational *)value;
553 for (i = 0; vdivs[i].p && vdivs[i].q; i++) {
554 if (vdivs[i].p == tmp_rat.p
555 && vdivs[i].q == tmp_rat.q) {
556 devc->voltage_ch1 = i;
557 devc->voltage_ch2 = i;
561 if (vdivs[i].p == 0 && vdivs[i].q == 0)
564 case SR_HWCAP_COUPLING:
565 /* TODO not supporting coupling per channel yet */
566 for (i = 0; coupling[i]; i++) {
567 if (!strcmp(value, coupling[i])) {
568 devc->coupling_ch1 = i;
569 devc->coupling_ch2 = i;
573 if (coupling[i] == 0)
583 static void send_chunk(struct dev_context *devc, unsigned char *buf,
586 struct sr_datafeed_packet packet;
587 struct sr_datafeed_analog analog;
588 float ch1, ch2, range;
589 int num_probes, data_offset, i;
591 num_probes = (devc->ch1_enabled && devc->ch2_enabled) ? 2 : 1;
592 packet.type = SR_DF_ANALOG;
593 packet.payload = &analog;
594 /* TODO: support for 5xxx series 9-bit samples */
595 analog.num_samples = num_samples;
596 analog.mq = SR_MQ_VOLTAGE;
597 analog.unit = SR_UNIT_VOLT;
598 analog.data = g_try_malloc(analog.num_samples * sizeof(float) * num_probes);
600 for (i = 0; i < analog.num_samples; i++) {
601 /* The device always sends data for both channels. If a channel
602 * is disabled, it contains a copy of the enabled channel's
603 * data. However, we only send the requested channels to the bus.
605 * Voltage values are encoded as a value 0-255 (0-512 on the 5200*),
606 * where the value is a point in the range represented by the vdiv
607 * setting. There are 8 vertical divs, so e.g. 500mV/div represents
608 * 4V peak-to-peak where 0 = -2V and 255 = +2V.
610 /* TODO: support for 5xxx series 9-bit samples */
611 if (devc->ch1_enabled) {
612 range = ((float)vdivs[devc->voltage_ch1].p / vdivs[devc->voltage_ch1].q) * 8;
613 ch1 = range / 255 * *(buf + i * 2 + 1);
614 /* Value is centered around 0V. */
616 analog.data[data_offset++] = ch1;
618 if (devc->ch2_enabled) {
619 range = ((float)vdivs[devc->voltage_ch2].p / vdivs[devc->voltage_ch2].q) * 8;
620 ch2 = range / 255 * *(buf + i * 2);
622 analog.data[data_offset++] = ch2;
625 sr_session_send(devc->cb_data, &packet);
629 /* Called by libusb (as triggered by handle_event()) when a transfer comes in.
630 * Only channel data comes in asynchronously, and all transfers for this are
631 * queued up beforehand, so this just needs so chuck the incoming data onto
632 * the libsigrok session bus.
634 static void receive_transfer(struct libusb_transfer *transfer)
636 struct sr_datafeed_packet packet;
637 struct dev_context *devc;
638 int num_samples, pre;
640 devc = transfer->user_data;
641 sr_dbg("hantek-dso: receive_transfer(): status %d received %d bytes",
642 transfer->status, transfer->actual_length);
644 if (transfer->actual_length == 0)
645 /* Nothing to send to the bus. */
648 num_samples = transfer->actual_length / 2;
650 sr_dbg("hantek-dso: got %d-%d/%d samples in frame", devc->samp_received + 1,
651 devc->samp_received + num_samples, devc->framesize);
653 /* The device always sends a full frame, but the beginning of the frame
654 * doesn't represent the trigger point. The offset at which the trigger
655 * happened came in with the capture state, so we need to start sending
656 * from there up the session bus. The samples in the frame buffer before
657 * that trigger point came after the end of the device's frame buffer was
658 * reached, and it wrapped around to overwrite up until the trigger point.
660 if (devc->samp_received < devc->trigger_offset) {
661 /* Trigger point not yet reached. */
662 if (devc->samp_received + num_samples < devc->trigger_offset) {
663 /* The entire chunk is before the trigger point. */
664 memcpy(devc->framebuf + devc->samp_buffered * 2,
665 transfer->buffer, num_samples * 2);
666 devc->samp_buffered += num_samples;
668 /* This chunk hits or overruns the trigger point.
669 * Store the part before the trigger fired, and
670 * send the rest up to the session bus. */
671 pre = devc->trigger_offset - devc->samp_received;
672 memcpy(devc->framebuf + devc->samp_buffered * 2,
673 transfer->buffer, pre * 2);
674 devc->samp_buffered += pre;
676 /* The rest of this chunk starts with the trigger point. */
677 sr_dbg("hantek-dso: reached trigger point, %d samples buffered",
678 devc->samp_buffered);
680 /* Avoid the corner case where the chunk ended at
681 * exactly the trigger point. */
682 if (num_samples > pre)
683 send_chunk(devc, transfer->buffer + pre * 2,
687 /* Already past the trigger point, just send it all out. */
688 send_chunk(devc, transfer->buffer,
692 devc->samp_received += num_samples;
694 /* Everything in this transfer was either copied to the buffer or
695 * sent to the session bus. */
696 g_free(transfer->buffer);
697 libusb_free_transfer(transfer);
699 if (devc->samp_received >= devc->framesize) {
700 /* That was the last chunk in this frame. Send the buffered
701 * pre-trigger samples out now, in one big chunk. */
702 sr_dbg("hantek-dso: end of frame, sending %d pre-trigger buffered samples",
703 devc->samp_buffered);
704 send_chunk(devc, devc->framebuf, devc->samp_buffered);
706 /* Mark the end of this frame. */
707 packet.type = SR_DF_FRAME_END;
708 sr_session_send(devc->cb_data, &packet);
710 if (devc->limit_frames && ++devc->num_frames == devc->limit_frames) {
711 /* Terminate session */
712 /* TODO: don't leave pending USB transfers hanging */
713 packet.type = SR_DF_END;
714 sr_session_send(ctx->cb_data, &packet);
716 devc->dev_state = NEW_CAPTURE;
722 static int handle_event(int fd, int revents, void *cb_data)
724 struct sr_datafeed_packet packet;
727 struct drv_context *drvc;
728 struct dev_context *devc;
729 uint32_t trigger_offset;
730 uint8_t capturestate;
732 /* Avoid compiler warnings. */
739 /* Always handle pending libusb events. */
740 tv.tv_sec = tv.tv_usec = 0;
741 libusb_handle_events_timeout(drvc->usb_context, &tv);
745 if (devc->dev_state == NEW_CAPTURE) {
746 if (dso_capture_start(devc) != SR_OK)
748 if (dso_enable_trigger(devc) != SR_OK)
750 // if (dso_force_trigger(devc) != SR_OK)
752 sr_dbg("hantek-dso: successfully requested next chunk");
753 devc->dev_state = CAPTURE;
756 if (devc->dev_state != CAPTURE)
759 if ((dso_get_capturestate(devc, &capturestate, &trigger_offset)) != SR_OK)
762 sr_dbg("hantek-dso: capturestate %d", capturestate);
763 sr_dbg("hantek-dso: trigger offset 0x%.6x", trigger_offset);
764 switch (capturestate) {
766 if (++devc->capture_empty_count >= MAX_CAPTURE_EMPTY) {
767 devc->capture_empty_count = 0;
768 if (dso_capture_start(devc) != SR_OK)
770 if (dso_enable_trigger(devc) != SR_OK)
772 // if (dso_force_trigger(devc) != SR_OK)
774 sr_dbg("hantek-dso: successfully requested next chunk");
777 case CAPTURE_FILLING:
780 case CAPTURE_READY_8BIT:
781 /* Remember where in the captured frame the trigger is. */
782 devc->trigger_offset = trigger_offset;
784 num_probes = (devc->ch1_enabled && devc->ch2_enabled) ? 2 : 1;
785 devc->framebuf = g_try_malloc(devc->framesize * num_probes * 2);
786 devc->samp_buffered = devc->samp_received = 0;
788 /* Tell the scope to send us the first frame. */
789 if (dso_get_channeldata(devc, receive_transfer) != SR_OK)
792 /* Don't hit the state machine again until we're done fetching
793 * the data we just told the scope to send.
795 devc->dev_state = FETCH_DATA;
797 /* Tell the frontend a new frame is on the way. */
798 packet.type = SR_DF_FRAME_BEGIN;
799 sr_session_send(sdi, &packet);
801 case CAPTURE_READY_9BIT:
803 sr_err("not yet supported");
805 case CAPTURE_TIMEOUT:
806 /* Doesn't matter, we'll try again next time. */
809 sr_dbg("unknown capture state");
815 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
818 const struct libusb_pollfd **lupfd;
819 struct sr_datafeed_packet packet;
820 struct sr_datafeed_header header;
821 struct sr_datafeed_meta_analog meta;
822 struct drv_context *drvc;
823 struct dev_context *devc;
827 if (sdi->status != SR_ST_ACTIVE)
831 devc->cb_data = cb_data;
833 if (dso_init(devc) != SR_OK)
836 if (dso_capture_start(devc) != SR_OK)
839 devc->dev_state = CAPTURE;
840 lupfd = libusb_get_pollfds(drvc->usb_context);
841 for (i = 0; lupfd[i]; i++)
842 sr_source_add(lupfd[i]->fd, lupfd[i]->events, TICK, handle_event,
846 /* Send header packet to the session bus. */
847 packet.type = SR_DF_HEADER;
848 packet.payload = (unsigned char *)&header;
849 header.feed_version = 1;
850 gettimeofday(&header.starttime, NULL);
851 sr_session_send(cb_data, &packet);
853 /* Send metadata about the SR_DF_ANALOG packets to come. */
854 packet.type = SR_DF_META_ANALOG;
855 packet.payload = &meta;
856 meta.num_probes = NUM_PROBES;
857 sr_session_send(cb_data, &packet);
862 /* TODO: doesn't really cancel pending transfers so they might come in after
865 static int hw_dev_acquisition_stop(const struct sr_dev_inst *sdi,
868 struct dev_context *devc;
872 if (sdi->status != SR_ST_ACTIVE)
876 ctx->dev_state = IDLE;
878 packet.type = SR_DF_END;
879 sr_session_send(cb_data, &packet);
884 SR_PRIV struct sr_dev_driver hantek_dso_driver_info = {
885 .name = "hantek-dso",
886 .longname = "Hantek DSO",
889 .cleanup = hw_cleanup,
891 .dev_open = hw_dev_open,
892 .dev_close = hw_dev_close,
893 .info_get = hw_info_get,
894 .dev_config_set = hw_dev_config_set,
895 .dev_acquisition_start = hw_dev_acquisition_start,
896 .dev_acquisition_stop = hw_dev_acquisition_stop,