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"
37 /* Max time in ms before we want to check on USB events */
38 /* TODO tune this properly */
41 static const int hwcaps[] = {
42 SR_HWCAP_OSCILLOSCOPE,
43 SR_HWCAP_LIMIT_SAMPLES,
47 SR_HWCAP_TRIGGER_SOURCE,
48 SR_HWCAP_TRIGGER_SLOPE,
49 SR_HWCAP_HORIZ_TRIGGERPOS,
56 static const char *probe_names[] = {
62 static const struct dso_profile dev_profiles[] = {
63 { 0x04b4, 0x2090, 0x04b5, 0x2090,
65 FIRMWARE_DIR "/hantek-dso-2xxx.fw" },
66 { 0x04b4, 0x2150, 0x04b5, 0x2150,
68 FIRMWARE_DIR "/hantek-dso-2xxx.fw" },
69 { 0x04b4, 0x2250, 0x04b5, 0x2250,
71 FIRMWARE_DIR "/hantek-dso-2xxx.fw" },
72 { 0x04b4, 0x5200, 0x04b5, 0x5200,
74 FIRMWARE_DIR "/hantek-dso-5xxx.fw" },
75 { 0x04b4, 0x520a, 0x04b5, 0x520a,
76 "Hantek", "DSO-5200A",
77 FIRMWARE_DIR "/hantek-dso-5xxx.fw" },
78 { 0, 0, 0, 0, 0, 0, 0 },
81 static const uint64_t buffersizes[] = {
88 static const struct sr_rational timebases[] = {
109 static const struct sr_rational vdivs[] = {
124 static const char *trigger_sources[] = {
132 static const char *filter_targets[] = {
135 /* TODO: "TRIGGER", */
139 static const char *coupling[] = {
146 SR_PRIV struct sr_dev_driver hantek_dso_driver_info;
147 static struct sr_dev_driver *hdi = &hantek_dso_driver_info;
148 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data);
150 static struct sr_dev_inst *dso_dev_new(int index, const struct dso_profile *prof)
152 struct sr_dev_inst *sdi;
153 struct sr_probe *probe;
154 struct drv_context *drvc;
155 struct dev_context *devc;
158 sdi = sr_dev_inst_new(index, SR_ST_INITIALIZING,
159 prof->vendor, prof->model, NULL);
164 /* Add only the real probes -- EXT isn't a source of data, only
165 * a trigger source internal to the device.
167 for (i = 0; probe_names[i]; i++) {
168 if (!(probe = sr_probe_new(i, SR_PROBE_ANALOG, TRUE,
171 sdi->probes = g_slist_append(sdi->probes, probe);
174 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
175 sr_err("hantek-dso: devc malloc failed");
178 devc->profile = prof;
179 devc->dev_state = IDLE;
180 devc->timebase = DEFAULT_TIMEBASE;
181 devc->ch1_enabled = TRUE;
182 devc->ch2_enabled = TRUE;
183 devc->voltage_ch1 = DEFAULT_VOLTAGE;
184 devc->voltage_ch2 = DEFAULT_VOLTAGE;
185 devc->coupling_ch1 = DEFAULT_COUPLING;
186 devc->coupling_ch2 = DEFAULT_COUPLING;
187 devc->voffset_ch1 = DEFAULT_VERT_OFFSET;
188 devc->voffset_ch2 = DEFAULT_VERT_OFFSET;
189 devc->voffset_trigger = DEFAULT_VERT_TRIGGERPOS;
190 devc->framesize = DEFAULT_FRAMESIZE;
191 devc->triggerslope = SLOPE_POSITIVE;
192 devc->triggersource = g_strdup(DEFAULT_TRIGGER_SOURCE);
193 devc->triggerposition = DEFAULT_HORIZ_TRIGGERPOS;
196 drvc->instances = g_slist_append(drvc->instances, sdi);
201 static int configure_probes(const struct sr_dev_inst *sdi)
203 struct dev_context *devc;
204 const struct sr_probe *probe;
209 devc->ch1_enabled = devc->ch2_enabled = FALSE;
210 for (l = sdi->probes; l; l = l->next) {
211 probe = (struct sr_probe *)l->data;
212 if (probe->index == 0)
213 devc->ch1_enabled = probe->enabled;
214 else if (probe->index == 1)
215 devc->ch2_enabled = probe->enabled;
221 /* Properly close and free all devices. */
222 static int clear_instances(void)
224 struct sr_dev_inst *sdi;
225 struct drv_context *drvc;
226 struct dev_context *devc;
230 for (l = drvc->instances; l; l = l->next) {
231 if (!(sdi = l->data)) {
232 /* Log error, but continue cleaning up the rest. */
233 sr_err("hantek-dso: %s: sdi was NULL, continuing", __func__);
236 if (!(devc = sdi->priv)) {
237 /* Log error, but continue cleaning up the rest. */
238 sr_err("hantek-dso: %s: sdi->priv was NULL, continuing", __func__);
242 sr_usb_dev_inst_free(devc->usb);
243 g_free(devc->triggersource);
245 sr_dev_inst_free(sdi);
248 g_slist_free(drvc->instances);
249 drvc->instances = NULL;
254 static int hw_init(void)
256 struct drv_context *drvc;
258 if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
259 sr_err("hantek-dso: driver context malloc failed.");
260 return SR_ERR_MALLOC;
263 if (libusb_init(NULL) != 0) {
265 sr_err("hantek-dso: Failed to initialize USB.");
274 static GSList *hw_scan(GSList *options)
276 struct sr_dev_inst *sdi;
277 const struct dso_profile *prof;
278 struct drv_context *drvc;
279 struct dev_context *devc;
281 struct libusb_device_descriptor des;
282 libusb_device **devlist;
283 int devcnt, ret, i, j;
289 drvc->instances = NULL;
293 /* Find all Hantek DSO devices and upload firmware to all of them. */
294 libusb_get_device_list(NULL, &devlist);
295 for (i = 0; devlist[i]; i++) {
296 if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
297 sr_err("hantek-dso: failed to get device descriptor: %d", ret);
302 for (j = 0; dev_profiles[j].orig_vid; j++) {
303 if (des.idVendor == dev_profiles[j].orig_vid
304 && des.idProduct == dev_profiles[j].orig_pid) {
305 /* Device matches the pre-firmware profile. */
306 prof = &dev_profiles[j];
307 sr_dbg("hantek-dso: Found a %s %s.", prof->vendor, prof->model);
308 sdi = dso_dev_new(devcnt, prof);
309 devices = g_slist_append(devices, sdi);
311 if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
312 prof->firmware) == SR_OK)
313 /* Remember when the firmware on this device was updated */
314 devc->fw_updated = g_get_monotonic_time();
316 sr_err("hantek-dso: firmware upload failed for "
317 "device %d", devcnt);
318 /* Dummy USB address of 0xff will get overwritten later. */
319 devc->usb = sr_usb_dev_inst_new(
320 libusb_get_bus_number(devlist[i]), 0xff, NULL);
323 } else if (des.idVendor == dev_profiles[j].fw_vid
324 && des.idProduct == dev_profiles[j].fw_pid) {
325 /* Device matches the post-firmware profile. */
326 prof = &dev_profiles[j];
327 sr_dbg("hantek-dso: Found a %s %s.", prof->vendor, prof->model);
328 sdi = dso_dev_new(devcnt, prof);
329 sdi->status = SR_ST_INACTIVE;
330 devices = g_slist_append(devices, sdi);
332 devc->usb = sr_usb_dev_inst_new(
333 libusb_get_bus_number(devlist[i]),
334 libusb_get_device_address(devlist[i]), NULL);
340 /* not a supported VID/PID */
343 libusb_free_device_list(devlist, 1);
348 static GSList *hw_dev_list(void)
350 struct drv_context *drvc;
354 return drvc->instances;
357 static int hw_dev_open(struct sr_dev_inst *sdi)
359 struct dev_context *devc;
360 int64_t timediff_us, timediff_ms;
366 * if the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
367 * for the FX2 to renumerate
370 if (devc->fw_updated > 0) {
371 sr_info("hantek-dso: waiting for device to reset");
372 /* takes at least 300ms for the FX2 to be gone from the USB bus */
373 g_usleep(300 * 1000);
375 while (timediff_ms < MAX_RENUM_DELAY_MS) {
376 if ((err = dso_open(sdi)) == SR_OK)
378 g_usleep(100 * 1000);
379 timediff_us = g_get_monotonic_time() - devc->fw_updated;
380 timediff_ms = timediff_us / 1000;
381 sr_spew("hantek-dso: waited %" PRIi64 " ms", timediff_ms);
383 sr_info("hantek-dso: device came back after %d ms", timediff_ms);
389 sr_err("hantek-dso: unable to open device");
393 err = libusb_claim_interface(devc->usb->devhdl, USB_INTERFACE);
395 sr_err("hantek-dso: Unable to claim interface: %d", err);
402 static int hw_dev_close(struct sr_dev_inst *sdi)
410 static int hw_cleanup(void)
412 struct drv_context *drvc;
414 if (!(drvc = hdi->priv))
424 static int hw_info_get(int info_id, const void **data,
425 const struct sr_dev_inst *sdi)
435 case SR_DI_NUM_PROBES:
436 *data = GINT_TO_POINTER(NUM_PROBES);
438 case SR_DI_PROBE_NAMES:
441 case SR_DI_BUFFERSIZES:
444 case SR_DI_TIMEBASES:
447 case SR_DI_TRIGGER_SOURCES:
448 *data = trigger_sources;
451 *data = filter_targets;
459 /* TODO remove this */
460 case SR_DI_CUR_SAMPLERATE:
470 static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
473 struct dev_context *devc;
474 struct sr_rational tmp_rat;
480 if (sdi->status != SR_ST_ACTIVE)
486 case SR_HWCAP_LIMIT_FRAMES:
487 devc->limit_frames = *(const uint64_t *)value;
489 case SR_HWCAP_TRIGGER_SLOPE:
490 tmp_u64 = *(const int *)value;
491 if (tmp_u64 != SLOPE_NEGATIVE && tmp_u64 != SLOPE_POSITIVE)
493 devc->triggerslope = tmp_u64;
495 case SR_HWCAP_HORIZ_TRIGGERPOS:
496 tmp_float = *(const float *)value;
497 if (tmp_float < 0.0 || tmp_float > 1.0) {
498 sr_err("hantek-dso: trigger position should be between 0.0 and 1.0");
501 devc->triggerposition = tmp_float;
503 case SR_HWCAP_BUFFERSIZE:
504 tmp_u64 = *(const int *)value;
505 for (i = 0; buffersizes[i]; i++) {
506 if (buffersizes[i] == tmp_u64) {
507 devc->framesize = tmp_u64;
511 if (buffersizes[i] == 0)
514 case SR_HWCAP_TIMEBASE:
515 tmp_rat = *(const struct sr_rational *)value;
516 for (i = 0; timebases[i].p && timebases[i].q; i++) {
517 if (timebases[i].p == tmp_rat.p
518 && timebases[i].q == tmp_rat.q) {
523 if (timebases[i].p == 0 && timebases[i].q == 0)
526 case SR_HWCAP_TRIGGER_SOURCE:
527 for (i = 0; trigger_sources[i]; i++) {
528 if (!strcmp(value, trigger_sources[i])) {
529 devc->triggersource = g_strdup(value);
533 if (trigger_sources[i] == 0)
536 case SR_HWCAP_FILTER:
537 devc->filter_ch1 = devc->filter_ch2 = devc->filter_trigger = 0;
538 targets = g_strsplit(value, ",", 0);
539 for (i = 0; targets[i]; i++) {
540 if (targets[i] == '\0')
541 /* Empty filter string can be used to clear them all. */
543 else if (!strcmp(targets[i], "CH1"))
544 devc->filter_ch1 = TRUE;
545 else if (!strcmp(targets[i], "CH2"))
546 devc->filter_ch2 = TRUE;
547 else if (!strcmp(targets[i], "TRIGGER"))
548 devc->filter_trigger = TRUE;
550 sr_err("invalid filter target %s", targets[i]);
557 /* TODO not supporting vdiv per channel yet */
558 tmp_rat = *(const struct sr_rational *)value;
559 for (i = 0; vdivs[i].p && vdivs[i].q; i++) {
560 if (vdivs[i].p == tmp_rat.p
561 && vdivs[i].q == tmp_rat.q) {
562 devc->voltage_ch1 = i;
563 devc->voltage_ch2 = i;
567 if (vdivs[i].p == 0 && vdivs[i].q == 0)
570 case SR_HWCAP_COUPLING:
571 /* TODO not supporting coupling per channel yet */
572 for (i = 0; coupling[i]; i++) {
573 if (!strcmp(value, coupling[i])) {
574 devc->coupling_ch1 = i;
575 devc->coupling_ch2 = i;
579 if (coupling[i] == 0)
589 static void send_chunk(struct dev_context *devc, unsigned char *buf,
592 struct sr_datafeed_packet packet;
593 struct sr_datafeed_analog analog;
594 float ch1, ch2, range;
595 int num_probes, data_offset, i;
597 num_probes = (devc->ch1_enabled && devc->ch2_enabled) ? 2 : 1;
598 packet.type = SR_DF_ANALOG;
599 packet.payload = &analog;
600 /* TODO: support for 5xxx series 9-bit samples */
601 analog.num_samples = num_samples;
602 analog.mq = SR_MQ_VOLTAGE;
603 analog.unit = SR_UNIT_VOLT;
604 /* TODO: Check malloc return value. */
605 analog.data = g_try_malloc(analog.num_samples * sizeof(float) * num_probes);
607 for (i = 0; i < analog.num_samples; i++) {
608 /* The device always sends data for both channels. If a channel
609 * is disabled, it contains a copy of the enabled channel's
610 * data. However, we only send the requested channels to the bus.
612 * Voltage values are encoded as a value 0-255 (0-512 on the 5200*),
613 * where the value is a point in the range represented by the vdiv
614 * setting. There are 8 vertical divs, so e.g. 500mV/div represents
615 * 4V peak-to-peak where 0 = -2V and 255 = +2V.
617 /* TODO: support for 5xxx series 9-bit samples */
618 if (devc->ch1_enabled) {
619 range = ((float)vdivs[devc->voltage_ch1].p / vdivs[devc->voltage_ch1].q) * 8;
620 ch1 = range / 255 * *(buf + i * 2 + 1);
621 /* Value is centered around 0V. */
623 analog.data[data_offset++] = ch1;
625 if (devc->ch2_enabled) {
626 range = ((float)vdivs[devc->voltage_ch2].p / vdivs[devc->voltage_ch2].q) * 8;
627 ch2 = range / 255 * *(buf + i * 2);
629 analog.data[data_offset++] = ch2;
632 sr_session_send(devc->cb_data, &packet);
636 /* Called by libusb (as triggered by handle_event()) when a transfer comes in.
637 * Only channel data comes in asynchronously, and all transfers for this are
638 * queued up beforehand, so this just needs so chuck the incoming data onto
639 * the libsigrok session bus.
641 static void receive_transfer(struct libusb_transfer *transfer)
643 struct sr_datafeed_packet packet;
644 struct dev_context *devc;
645 int num_samples, pre;
647 devc = transfer->user_data;
648 sr_dbg("hantek-dso: receive_transfer(): status %d received %d bytes",
649 transfer->status, transfer->actual_length);
651 if (transfer->actual_length == 0)
652 /* Nothing to send to the bus. */
655 num_samples = transfer->actual_length / 2;
657 sr_dbg("hantek-dso: got %d-%d/%d samples in frame", devc->samp_received + 1,
658 devc->samp_received + num_samples, devc->framesize);
660 /* The device always sends a full frame, but the beginning of the frame
661 * doesn't represent the trigger point. The offset at which the trigger
662 * happened came in with the capture state, so we need to start sending
663 * from there up the session bus. The samples in the frame buffer before
664 * that trigger point came after the end of the device's frame buffer was
665 * reached, and it wrapped around to overwrite up until the trigger point.
667 if (devc->samp_received < devc->trigger_offset) {
668 /* Trigger point not yet reached. */
669 if (devc->samp_received + num_samples < devc->trigger_offset) {
670 /* The entire chunk is before the trigger point. */
671 memcpy(devc->framebuf + devc->samp_buffered * 2,
672 transfer->buffer, num_samples * 2);
673 devc->samp_buffered += num_samples;
675 /* This chunk hits or overruns the trigger point.
676 * Store the part before the trigger fired, and
677 * send the rest up to the session bus. */
678 pre = devc->trigger_offset - devc->samp_received;
679 memcpy(devc->framebuf + devc->samp_buffered * 2,
680 transfer->buffer, pre * 2);
681 devc->samp_buffered += pre;
683 /* The rest of this chunk starts with the trigger point. */
684 sr_dbg("hantek-dso: reached trigger point, %d samples buffered",
685 devc->samp_buffered);
687 /* Avoid the corner case where the chunk ended at
688 * exactly the trigger point. */
689 if (num_samples > pre)
690 send_chunk(devc, transfer->buffer + pre * 2,
694 /* Already past the trigger point, just send it all out. */
695 send_chunk(devc, transfer->buffer,
699 devc->samp_received += num_samples;
701 /* Everything in this transfer was either copied to the buffer or
702 * sent to the session bus. */
703 g_free(transfer->buffer);
704 libusb_free_transfer(transfer);
706 if (devc->samp_received >= devc->framesize) {
707 /* That was the last chunk in this frame. Send the buffered
708 * pre-trigger samples out now, in one big chunk. */
709 sr_dbg("hantek-dso: end of frame, sending %d pre-trigger buffered samples",
710 devc->samp_buffered);
711 send_chunk(devc, devc->framebuf, devc->samp_buffered);
713 /* Mark the end of this frame. */
714 packet.type = SR_DF_FRAME_END;
715 sr_session_send(devc->cb_data, &packet);
717 if (devc->limit_frames && ++devc->num_frames == devc->limit_frames) {
718 /* Terminate session */
719 devc->dev_state = STOPPING;
721 devc->dev_state = NEW_CAPTURE;
727 static int handle_event(int fd, int revents, void *cb_data)
729 const struct sr_dev_inst *sdi;
730 struct sr_datafeed_packet packet;
732 struct dev_context *devc;
733 const struct libusb_pollfd **lupfd;
735 uint32_t trigger_offset;
736 uint8_t capturestate;
738 /* Avoid compiler warnings. */
744 if (devc->dev_state == STOPPING) {
745 /* We've been told to wind up the acquisition. */
746 sr_dbg("hantek-dso: stopping acquisition");
747 /* TODO: doesn't really cancel pending transfers so they might
748 * come in after SR_DF_END is sent. */
749 lupfd = libusb_get_pollfds(NULL);
750 for (i = 0; lupfd[i]; i++)
751 sr_source_remove(lupfd[i]->fd);
754 packet.type = SR_DF_END;
755 sr_session_send(sdi, &packet);
757 devc->dev_state = IDLE;
762 /* Always handle pending libusb events. */
763 tv.tv_sec = tv.tv_usec = 0;
764 libusb_handle_events_timeout(NULL, &tv);
767 if (devc->dev_state == NEW_CAPTURE) {
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");
775 devc->dev_state = CAPTURE;
778 if (devc->dev_state != CAPTURE)
781 if ((dso_get_capturestate(devc, &capturestate, &trigger_offset)) != SR_OK)
784 sr_dbg("hantek-dso: capturestate %d", capturestate);
785 sr_dbg("hantek-dso: trigger offset 0x%.6x", trigger_offset);
786 switch (capturestate) {
788 if (++devc->capture_empty_count >= MAX_CAPTURE_EMPTY) {
789 devc->capture_empty_count = 0;
790 if (dso_capture_start(devc) != SR_OK)
792 if (dso_enable_trigger(devc) != SR_OK)
794 // if (dso_force_trigger(devc) != SR_OK)
796 sr_dbg("hantek-dso: successfully requested next chunk");
799 case CAPTURE_FILLING:
802 case CAPTURE_READY_8BIT:
803 /* Remember where in the captured frame the trigger is. */
804 devc->trigger_offset = trigger_offset;
806 num_probes = (devc->ch1_enabled && devc->ch2_enabled) ? 2 : 1;
807 /* TODO: Check malloc return value. */
808 devc->framebuf = g_try_malloc(devc->framesize * num_probes * 2);
809 devc->samp_buffered = devc->samp_received = 0;
811 /* Tell the scope to send us the first frame. */
812 if (dso_get_channeldata(devc, receive_transfer) != SR_OK)
815 /* Don't hit the state machine again until we're done fetching
816 * the data we just told the scope to send.
818 devc->dev_state = FETCH_DATA;
820 /* Tell the frontend a new frame is on the way. */
821 packet.type = SR_DF_FRAME_BEGIN;
822 sr_session_send(sdi, &packet);
824 case CAPTURE_READY_9BIT:
826 sr_err("not yet supported");
828 case CAPTURE_TIMEOUT:
829 /* Doesn't matter, we'll try again next time. */
832 sr_dbg("unknown capture state");
838 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
841 const struct libusb_pollfd **lupfd;
842 struct sr_datafeed_packet packet;
843 struct sr_datafeed_header header;
844 struct sr_datafeed_meta_analog meta;
845 struct dev_context *devc;
848 if (sdi->status != SR_ST_ACTIVE)
852 devc->cb_data = cb_data;
854 if (configure_probes(sdi) != SR_OK) {
855 sr_err("hantek-dso: failed to configured probes");
859 if (dso_init(devc) != SR_OK)
862 if (dso_capture_start(devc) != SR_OK)
865 devc->dev_state = CAPTURE;
866 lupfd = libusb_get_pollfds(NULL);
867 for (i = 0; lupfd[i]; i++)
868 sr_source_add(lupfd[i]->fd, lupfd[i]->events, TICK, handle_event,
872 /* Send header packet to the session bus. */
873 packet.type = SR_DF_HEADER;
874 packet.payload = (unsigned char *)&header;
875 header.feed_version = 1;
876 gettimeofday(&header.starttime, NULL);
877 sr_session_send(cb_data, &packet);
879 /* Send metadata about the SR_DF_ANALOG packets to come. */
880 packet.type = SR_DF_META_ANALOG;
881 packet.payload = &meta;
882 meta.num_probes = NUM_PROBES;
883 sr_session_send(cb_data, &packet);
888 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
890 struct dev_context *devc;
894 if (sdi->status != SR_ST_ACTIVE)
898 devc->dev_state = STOPPING;
903 SR_PRIV struct sr_dev_driver hantek_dso_driver_info = {
904 .name = "hantek-dso",
905 .longname = "Hantek DSO",
908 .cleanup = hw_cleanup,
910 .dev_list = hw_dev_list,
911 .dev_clear = clear_instances,
912 .dev_open = hw_dev_open,
913 .dev_close = hw_dev_close,
914 .info_get = hw_info_get,
915 .dev_config_set = hw_dev_config_set,
916 .dev_acquisition_start = hw_dev_acquisition_start,
917 .dev_acquisition_stop = hw_dev_acquisition_stop,