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(const struct sr_dev_inst *sdi)
205 struct dev_context *devc;
206 const struct sr_probe *probe;
211 devc->ch1_enabled = devc->ch2_enabled = FALSE;
212 for (l = sdi->probes; l; l = l->next) {
213 probe = (struct sr_probe *)l->data;
214 if (probe->index == 0)
215 devc->ch1_enabled = probe->enabled;
216 else if (probe->index == 1)
217 devc->ch2_enabled = probe->enabled;
223 /* Properly close and free all devices. */
224 static int clear_instances(void)
226 struct sr_dev_inst *sdi;
227 struct drv_context *drvc;
228 struct dev_context *devc;
232 for (l = drvc->instances; l; l = l->next) {
233 if (!(sdi = l->data)) {
234 /* Log error, but continue cleaning up the rest. */
235 sr_err("hantek-dso: %s: sdi was NULL, continuing", __func__);
238 if (!(devc = sdi->priv)) {
239 /* Log error, but continue cleaning up the rest. */
240 sr_err("hantek-dso: %s: sdi->priv was NULL, continuing", __func__);
244 sr_usb_dev_inst_free(devc->usb);
245 g_free(devc->triggersource);
247 sr_dev_inst_free(sdi);
250 g_slist_free(drvc->instances);
251 drvc->instances = NULL;
256 static int hw_init(void)
258 struct drv_context *drvc;
260 if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
261 sr_err("hantek-dso: driver context malloc failed.");
265 if (libusb_init(&drvc->usb_context) != 0) {
267 sr_err("hantek-dso: Failed to initialize USB.");
276 static GSList *hw_scan(GSList *options)
278 struct sr_dev_inst *sdi;
279 const struct dso_profile *prof;
280 struct drv_context *drvc;
281 struct dev_context *devc;
283 struct libusb_device_descriptor des;
284 libusb_device **devlist;
285 int devcnt, ret, i, j;
291 drvc->instances = NULL;
295 /* Find all Hantek DSO devices and upload firmware to all of them. */
296 libusb_get_device_list(drvc->usb_context, &devlist);
297 for (i = 0; devlist[i]; i++) {
298 if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
299 sr_err("hantek-dso: failed to get device descriptor: %d", ret);
304 for (j = 0; dev_profiles[j].orig_vid; j++) {
305 if (des.idVendor == dev_profiles[j].orig_vid
306 && des.idProduct == dev_profiles[j].orig_pid) {
307 /* Device matches the pre-firmware profile. */
308 prof = &dev_profiles[j];
309 sr_dbg("hantek-dso: Found a %s %s.", prof->vendor, prof->model);
310 sdi = dso_dev_new(devcnt, prof);
311 devices = g_slist_append(devices, sdi);
313 if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
314 prof->firmware) == SR_OK)
315 /* Remember when the firmware on this device was updated */
316 devc->fw_updated = g_get_monotonic_time();
318 sr_err("hantek-dso: firmware upload failed for "
319 "device %d", devcnt);
320 /* Dummy USB address of 0xff will get overwritten later. */
321 devc->usb = sr_usb_dev_inst_new(
322 libusb_get_bus_number(devlist[i]), 0xff, NULL);
325 } else if (des.idVendor == dev_profiles[j].fw_vid
326 && des.idProduct == dev_profiles[j].fw_pid) {
327 /* Device matches the post-firmware profile. */
328 prof = &dev_profiles[j];
329 sr_dbg("hantek-dso: Found a %s %s.", prof->vendor, prof->model);
330 sdi = dso_dev_new(devcnt, prof);
331 sdi->status = SR_ST_INACTIVE;
332 devices = g_slist_append(devices, sdi);
334 devc->usb = sr_usb_dev_inst_new(
335 libusb_get_bus_number(devlist[i]),
336 libusb_get_device_address(devlist[i]), NULL);
342 /* not a supported VID/PID */
345 libusb_free_device_list(devlist, 1);
350 static GSList *hw_dev_list(void)
352 struct drv_context *drvc;
356 return drvc->instances;
359 static int hw_dev_open(struct sr_dev_inst *sdi)
361 struct dev_context *devc;
362 int64_t timediff_us, timediff_ms;
368 * if the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
369 * for the FX2 to renumerate
372 if (devc->fw_updated > 0) {
373 sr_info("hantek-dso: waiting for device to reset");
374 /* takes at least 300ms for the FX2 to be gone from the USB bus */
375 g_usleep(300 * 1000);
377 while (timediff_ms < MAX_RENUM_DELAY_MS) {
378 if ((err = dso_open(sdi)) == SR_OK)
380 g_usleep(100 * 1000);
381 timediff_us = g_get_monotonic_time() - devc->fw_updated;
382 timediff_ms = timediff_us / 1000;
383 sr_spew("hantek-dso: waited %" PRIi64 " ms", timediff_ms);
385 sr_info("hantek-dso: device came back after %d ms", timediff_ms);
391 sr_err("hantek-dso: unable to open device");
395 err = libusb_claim_interface(devc->usb->devhdl, USB_INTERFACE);
397 sr_err("hantek-dso: Unable to claim interface: %d", err);
404 static int hw_dev_close(struct sr_dev_inst *sdi)
412 static int hw_cleanup(void)
414 struct drv_context *drvc;
416 if (!(drvc = hdi->priv))
421 if (drvc->usb_context)
422 libusb_exit(drvc->usb_context);
423 drvc->usb_context = NULL;
428 static int hw_info_get(int info_id, const void **data,
429 const struct sr_dev_inst *sdi)
439 case SR_DI_NUM_PROBES:
440 *data = GINT_TO_POINTER(NUM_PROBES);
442 case SR_DI_PROBE_NAMES:
445 case SR_DI_BUFFERSIZES:
448 case SR_DI_TIMEBASES:
451 case SR_DI_TRIGGER_SOURCES:
452 *data = trigger_sources;
455 *data = filter_targets;
463 /* TODO remove this */
464 case SR_DI_CUR_SAMPLERATE:
474 static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
477 struct dev_context *devc;
478 struct sr_rational tmp_rat;
484 if (sdi->status != SR_ST_ACTIVE)
490 case SR_HWCAP_LIMIT_FRAMES:
491 devc->limit_frames = *(const uint64_t *)value;
493 case SR_HWCAP_TRIGGER_SLOPE:
494 tmp_u64 = *(const int *)value;
495 if (tmp_u64 != SLOPE_NEGATIVE && tmp_u64 != SLOPE_POSITIVE)
497 devc->triggerslope = tmp_u64;
499 case SR_HWCAP_HORIZ_TRIGGERPOS:
500 tmp_float = *(const float *)value;
501 if (tmp_float < 0.0 || tmp_float > 1.0) {
502 sr_err("hantek-dso: trigger position should be between 0.0 and 1.0");
505 devc->triggerposition = tmp_float;
507 case SR_HWCAP_BUFFERSIZE:
508 tmp_u64 = *(const int *)value;
509 for (i = 0; buffersizes[i]; i++) {
510 if (buffersizes[i] == tmp_u64) {
511 devc->framesize = tmp_u64;
515 if (buffersizes[i] == 0)
518 case SR_HWCAP_TIMEBASE:
519 tmp_rat = *(const struct sr_rational *)value;
520 for (i = 0; timebases[i].p && timebases[i].q; i++) {
521 if (timebases[i].p == tmp_rat.p
522 && timebases[i].q == tmp_rat.q) {
527 if (timebases[i].p == 0 && timebases[i].q == 0)
530 case SR_HWCAP_TRIGGER_SOURCE:
531 for (i = 0; trigger_sources[i]; i++) {
532 if (!strcmp(value, trigger_sources[i])) {
533 devc->triggersource = g_strdup(value);
537 if (trigger_sources[i] == 0)
540 case SR_HWCAP_FILTER:
541 devc->filter_ch1 = devc->filter_ch2 = devc->filter_trigger = 0;
542 targets = g_strsplit(value, ",", 0);
543 for (i = 0; targets[i]; i++) {
544 if (targets[i] == '\0')
545 /* Empty filter string can be used to clear them all. */
547 else if (!strcmp(targets[i], "CH1"))
548 devc->filter_ch1 = TRUE;
549 else if (!strcmp(targets[i], "CH2"))
550 devc->filter_ch2 = TRUE;
551 else if (!strcmp(targets[i], "TRIGGER"))
552 devc->filter_trigger = TRUE;
554 sr_err("invalid filter target %s", targets[i]);
561 /* TODO not supporting vdiv per channel yet */
562 tmp_rat = *(const struct sr_rational *)value;
563 for (i = 0; vdivs[i].p && vdivs[i].q; i++) {
564 if (vdivs[i].p == tmp_rat.p
565 && vdivs[i].q == tmp_rat.q) {
566 devc->voltage_ch1 = i;
567 devc->voltage_ch2 = i;
571 if (vdivs[i].p == 0 && vdivs[i].q == 0)
574 case SR_HWCAP_COUPLING:
575 /* TODO not supporting coupling per channel yet */
576 for (i = 0; coupling[i]; i++) {
577 if (!strcmp(value, coupling[i])) {
578 devc->coupling_ch1 = i;
579 devc->coupling_ch2 = i;
583 if (coupling[i] == 0)
593 static void send_chunk(struct dev_context *devc, unsigned char *buf,
596 struct sr_datafeed_packet packet;
597 struct sr_datafeed_analog analog;
598 float ch1, ch2, range;
599 int num_probes, data_offset, i;
601 num_probes = (devc->ch1_enabled && devc->ch2_enabled) ? 2 : 1;
602 packet.type = SR_DF_ANALOG;
603 packet.payload = &analog;
604 /* TODO: support for 5xxx series 9-bit samples */
605 analog.num_samples = num_samples;
606 analog.mq = SR_MQ_VOLTAGE;
607 analog.unit = SR_UNIT_VOLT;
608 analog.data = g_try_malloc(analog.num_samples * sizeof(float) * num_probes);
610 for (i = 0; i < analog.num_samples; i++) {
611 /* The device always sends data for both channels. If a channel
612 * is disabled, it contains a copy of the enabled channel's
613 * data. However, we only send the requested channels to the bus.
615 * Voltage values are encoded as a value 0-255 (0-512 on the 5200*),
616 * where the value is a point in the range represented by the vdiv
617 * setting. There are 8 vertical divs, so e.g. 500mV/div represents
618 * 4V peak-to-peak where 0 = -2V and 255 = +2V.
620 /* TODO: support for 5xxx series 9-bit samples */
621 if (devc->ch1_enabled) {
622 range = ((float)vdivs[devc->voltage_ch1].p / vdivs[devc->voltage_ch1].q) * 8;
623 ch1 = range / 255 * *(buf + i * 2 + 1);
624 /* Value is centered around 0V. */
626 analog.data[data_offset++] = ch1;
628 if (devc->ch2_enabled) {
629 range = ((float)vdivs[devc->voltage_ch2].p / vdivs[devc->voltage_ch2].q) * 8;
630 ch2 = range / 255 * *(buf + i * 2);
632 analog.data[data_offset++] = ch2;
635 sr_session_send(devc->cb_data, &packet);
639 /* Called by libusb (as triggered by handle_event()) when a transfer comes in.
640 * Only channel data comes in asynchronously, and all transfers for this are
641 * queued up beforehand, so this just needs so chuck the incoming data onto
642 * the libsigrok session bus.
644 static void receive_transfer(struct libusb_transfer *transfer)
646 struct sr_datafeed_packet packet;
647 struct dev_context *devc;
648 int num_samples, pre;
650 devc = transfer->user_data;
651 sr_dbg("hantek-dso: receive_transfer(): status %d received %d bytes",
652 transfer->status, transfer->actual_length);
654 if (transfer->actual_length == 0)
655 /* Nothing to send to the bus. */
658 num_samples = transfer->actual_length / 2;
660 sr_dbg("hantek-dso: got %d-%d/%d samples in frame", devc->samp_received + 1,
661 devc->samp_received + num_samples, devc->framesize);
663 /* The device always sends a full frame, but the beginning of the frame
664 * doesn't represent the trigger point. The offset at which the trigger
665 * happened came in with the capture state, so we need to start sending
666 * from there up the session bus. The samples in the frame buffer before
667 * that trigger point came after the end of the device's frame buffer was
668 * reached, and it wrapped around to overwrite up until the trigger point.
670 if (devc->samp_received < devc->trigger_offset) {
671 /* Trigger point not yet reached. */
672 if (devc->samp_received + num_samples < devc->trigger_offset) {
673 /* The entire chunk is before the trigger point. */
674 memcpy(devc->framebuf + devc->samp_buffered * 2,
675 transfer->buffer, num_samples * 2);
676 devc->samp_buffered += num_samples;
678 /* This chunk hits or overruns the trigger point.
679 * Store the part before the trigger fired, and
680 * send the rest up to the session bus. */
681 pre = devc->trigger_offset - devc->samp_received;
682 memcpy(devc->framebuf + devc->samp_buffered * 2,
683 transfer->buffer, pre * 2);
684 devc->samp_buffered += pre;
686 /* The rest of this chunk starts with the trigger point. */
687 sr_dbg("hantek-dso: reached trigger point, %d samples buffered",
688 devc->samp_buffered);
690 /* Avoid the corner case where the chunk ended at
691 * exactly the trigger point. */
692 if (num_samples > pre)
693 send_chunk(devc, transfer->buffer + pre * 2,
697 /* Already past the trigger point, just send it all out. */
698 send_chunk(devc, transfer->buffer,
702 devc->samp_received += num_samples;
704 /* Everything in this transfer was either copied to the buffer or
705 * sent to the session bus. */
706 g_free(transfer->buffer);
707 libusb_free_transfer(transfer);
709 if (devc->samp_received >= devc->framesize) {
710 /* That was the last chunk in this frame. Send the buffered
711 * pre-trigger samples out now, in one big chunk. */
712 sr_dbg("hantek-dso: end of frame, sending %d pre-trigger buffered samples",
713 devc->samp_buffered);
714 send_chunk(devc, devc->framebuf, devc->samp_buffered);
716 /* Mark the end of this frame. */
717 packet.type = SR_DF_FRAME_END;
718 sr_session_send(devc->cb_data, &packet);
720 if (devc->limit_frames && ++devc->num_frames == devc->limit_frames) {
721 /* Terminate session */
722 devc->dev_state = STOPPING;
724 devc->dev_state = NEW_CAPTURE;
730 static int handle_event(int fd, int revents, void *cb_data)
732 const struct sr_dev_inst *sdi;
733 struct sr_datafeed_packet packet;
735 struct drv_context *drvc;
736 struct dev_context *devc;
737 const struct libusb_pollfd **lupfd;
739 uint32_t trigger_offset;
740 uint8_t capturestate;
742 /* Avoid compiler warnings. */
749 if (devc->dev_state == STOPPING) {
750 /* We've been told to wind up the acquisition. */
751 sr_dbg("hantek-dso: stopping acquisition");
752 /* TODO: doesn't really cancel pending transfers so they might
753 * come in after SR_DF_END is sent. */
754 lupfd = libusb_get_pollfds(drvc->usb_context);
755 for (i = 0; lupfd[i]; i++)
756 sr_source_remove(lupfd[i]->fd);
759 packet.type = SR_DF_END;
760 sr_session_send(sdi, &packet);
762 devc->dev_state = IDLE;
767 /* Always handle pending libusb events. */
768 tv.tv_sec = tv.tv_usec = 0;
769 libusb_handle_events_timeout(drvc->usb_context, &tv);
772 if (devc->dev_state == NEW_CAPTURE) {
773 if (dso_capture_start(devc) != SR_OK)
775 if (dso_enable_trigger(devc) != SR_OK)
777 // if (dso_force_trigger(devc) != SR_OK)
779 sr_dbg("hantek-dso: successfully requested next chunk");
780 devc->dev_state = CAPTURE;
783 if (devc->dev_state != CAPTURE)
786 if ((dso_get_capturestate(devc, &capturestate, &trigger_offset)) != SR_OK)
789 sr_dbg("hantek-dso: capturestate %d", capturestate);
790 sr_dbg("hantek-dso: trigger offset 0x%.6x", trigger_offset);
791 switch (capturestate) {
793 if (++devc->capture_empty_count >= MAX_CAPTURE_EMPTY) {
794 devc->capture_empty_count = 0;
795 if (dso_capture_start(devc) != SR_OK)
797 if (dso_enable_trigger(devc) != SR_OK)
799 // if (dso_force_trigger(devc) != SR_OK)
801 sr_dbg("hantek-dso: successfully requested next chunk");
804 case CAPTURE_FILLING:
807 case CAPTURE_READY_8BIT:
808 /* Remember where in the captured frame the trigger is. */
809 devc->trigger_offset = trigger_offset;
811 num_probes = (devc->ch1_enabled && devc->ch2_enabled) ? 2 : 1;
812 devc->framebuf = g_try_malloc(devc->framesize * num_probes * 2);
813 devc->samp_buffered = devc->samp_received = 0;
815 /* Tell the scope to send us the first frame. */
816 if (dso_get_channeldata(devc, receive_transfer) != SR_OK)
819 /* Don't hit the state machine again until we're done fetching
820 * the data we just told the scope to send.
822 devc->dev_state = FETCH_DATA;
824 /* Tell the frontend a new frame is on the way. */
825 packet.type = SR_DF_FRAME_BEGIN;
826 sr_session_send(sdi, &packet);
828 case CAPTURE_READY_9BIT:
830 sr_err("not yet supported");
832 case CAPTURE_TIMEOUT:
833 /* Doesn't matter, we'll try again next time. */
836 sr_dbg("unknown capture state");
842 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
845 const struct libusb_pollfd **lupfd;
846 struct sr_datafeed_packet packet;
847 struct sr_datafeed_header header;
848 struct sr_datafeed_meta_analog meta;
849 struct drv_context *drvc;
850 struct dev_context *devc;
854 if (sdi->status != SR_ST_ACTIVE)
858 devc->cb_data = cb_data;
860 if (configure_probes(sdi) != SR_OK) {
861 sr_err("hantek-dso: failed to configured probes");
865 if (dso_init(devc) != SR_OK)
868 if (dso_capture_start(devc) != SR_OK)
871 devc->dev_state = CAPTURE;
872 lupfd = libusb_get_pollfds(drvc->usb_context);
873 for (i = 0; lupfd[i]; i++)
874 sr_source_add(lupfd[i]->fd, lupfd[i]->events, TICK, handle_event,
878 /* Send header packet to the session bus. */
879 packet.type = SR_DF_HEADER;
880 packet.payload = (unsigned char *)&header;
881 header.feed_version = 1;
882 gettimeofday(&header.starttime, NULL);
883 sr_session_send(cb_data, &packet);
885 /* Send metadata about the SR_DF_ANALOG packets to come. */
886 packet.type = SR_DF_META_ANALOG;
887 packet.payload = &meta;
888 meta.num_probes = NUM_PROBES;
889 sr_session_send(cb_data, &packet);
894 static int hw_dev_acquisition_stop(const struct sr_dev_inst *sdi,
897 struct dev_context *devc;
901 if (sdi->status != SR_ST_ACTIVE)
905 devc->dev_state = STOPPING;
910 SR_PRIV struct sr_dev_driver hantek_dso_driver_info = {
911 .name = "hantek-dso",
912 .longname = "Hantek DSO",
915 .cleanup = hw_cleanup,
917 .dev_list = hw_dev_list,
918 .dev_clear = clear_instances,
919 .dev_open = hw_dev_open,
920 .dev_close = hw_dev_close,
921 .info_get = hw_info_get,
922 .dev_config_set = hw_dev_config_set,
923 .dev_acquisition_start = hw_dev_acquisition_start,
924 .dev_acquisition_stop = hw_dev_acquisition_stop,