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"
36 /* Max time in ms before we want to check on USB events */
37 /* TODO tune this properly */
40 static const int hwcaps[] = {
41 SR_HWCAP_OSCILLOSCOPE,
42 SR_HWCAP_LIMIT_SAMPLES,
46 SR_HWCAP_TRIGGER_SOURCE,
47 SR_HWCAP_TRIGGER_SLOPE,
48 SR_HWCAP_HORIZ_TRIGGERPOS,
55 static const char *probe_names[] = {
61 static const struct dso_profile dev_profiles[] = {
62 { 0x04b4, 0x2090, 0x04b5, 0x2090,
64 FIRMWARE_DIR "/hantek-dso-2xxx.fw" },
65 { 0x04b4, 0x2150, 0x04b5, 0x2150,
67 FIRMWARE_DIR "/hantek-dso-2xxx.fw" },
68 { 0x04b4, 0x2250, 0x04b5, 0x2250,
70 FIRMWARE_DIR "/hantek-dso-2xxx.fw" },
71 { 0x04b4, 0x5200, 0x04b5, 0x5200,
73 FIRMWARE_DIR "/hantek-dso-5xxx.fw" },
74 { 0x04b4, 0x520a, 0x04b5, 0x520a,
75 "Hantek", "DSO-5200A",
76 FIRMWARE_DIR "/hantek-dso-5xxx.fw" },
77 { 0, 0, 0, 0, 0, 0, 0 },
80 static const uint64_t buffersizes[] = {
87 static const struct sr_rational timebases[] = {
108 static const struct sr_rational vdivs[] = {
123 static const char *trigger_sources[] = {
131 static const char *filter_targets[] = {
134 /* TODO: "TRIGGER", */
138 static const char *coupling[] = {
145 SR_PRIV struct sr_dev_driver hantek_dso_driver_info;
146 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);
165 * Add only the real probes -- EXT isn't a source of data, only
166 * a trigger source internal to the device.
168 for (i = 0; probe_names[i]; i++) {
169 if (!(probe = sr_probe_new(i, SR_PROBE_ANALOG, TRUE,
172 sdi->probes = g_slist_append(sdi->probes, probe);
175 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
176 sr_err("Device context 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("%s: sdi was NULL, continuing", __func__);
238 if (!(devc = sdi->priv)) {
239 /* Log error, but continue cleaning up the rest. */
240 sr_err("%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(struct sr_context *sr_ctx)
258 struct drv_context *drvc;
260 if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
261 sr_err("Driver context malloc failed.");
262 return SR_ERR_MALLOC;
265 if (libusb_init(NULL) != 0) {
267 sr_err("Failed to initialize USB.");
271 drvc->sr_ctx = sr_ctx;
277 static GSList *hw_scan(GSList *options)
279 struct sr_dev_inst *sdi;
280 const struct dso_profile *prof;
281 struct drv_context *drvc;
282 struct dev_context *devc;
284 struct libusb_device_descriptor des;
285 libusb_device **devlist;
286 int devcnt, ret, i, j;
293 drvc->instances = NULL;
297 /* Find all Hantek DSO devices and upload firmware to all of them. */
298 libusb_get_device_list(NULL, &devlist);
299 for (i = 0; devlist[i]; i++) {
300 if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
301 sr_err("Failed to get device descriptor: %d.", ret);
306 for (j = 0; dev_profiles[j].orig_vid; j++) {
307 if (des.idVendor == dev_profiles[j].orig_vid
308 && des.idProduct == dev_profiles[j].orig_pid) {
309 /* Device matches the pre-firmware profile. */
310 prof = &dev_profiles[j];
311 sr_dbg("Found a %s %s.", prof->vendor, prof->model);
312 sdi = dso_dev_new(devcnt, prof);
313 devices = g_slist_append(devices, sdi);
315 if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
316 prof->firmware) == SR_OK)
317 /* Remember when the firmware on this device was updated */
318 devc->fw_updated = g_get_monotonic_time();
320 sr_err("Firmware upload failed for "
321 "device %d.", devcnt);
322 /* Dummy USB address of 0xff will get overwritten later. */
323 devc->usb = sr_usb_dev_inst_new(
324 libusb_get_bus_number(devlist[i]), 0xff, NULL);
327 } else if (des.idVendor == dev_profiles[j].fw_vid
328 && des.idProduct == dev_profiles[j].fw_pid) {
329 /* Device matches the post-firmware profile. */
330 prof = &dev_profiles[j];
331 sr_dbg("Found a %s %s.", prof->vendor, prof->model);
332 sdi = dso_dev_new(devcnt, prof);
333 sdi->status = SR_ST_INACTIVE;
334 devices = g_slist_append(devices, sdi);
336 devc->usb = sr_usb_dev_inst_new(
337 libusb_get_bus_number(devlist[i]),
338 libusb_get_device_address(devlist[i]), NULL);
344 /* not a supported VID/PID */
347 libusb_free_device_list(devlist, 1);
352 static GSList *hw_dev_list(void)
354 struct drv_context *drvc;
358 return drvc->instances;
361 static int hw_dev_open(struct sr_dev_inst *sdi)
363 struct dev_context *devc;
364 int64_t timediff_us, timediff_ms;
370 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
371 * for the FX2 to renumerate.
374 if (devc->fw_updated > 0) {
375 sr_info("Waiting for device to reset.");
376 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
377 g_usleep(300 * 1000);
379 while (timediff_ms < MAX_RENUM_DELAY_MS) {
380 if ((err = dso_open(sdi)) == SR_OK)
382 g_usleep(100 * 1000);
383 timediff_us = g_get_monotonic_time() - devc->fw_updated;
384 timediff_ms = timediff_us / 1000;
385 sr_spew("Waited %" PRIi64 " ms.", timediff_ms);
387 sr_info("Device came back after %d ms.", timediff_ms);
393 sr_err("Unable to open device.");
397 err = libusb_claim_interface(devc->usb->devhdl, USB_INTERFACE);
399 sr_err("Unable to claim interface: %d.", err);
406 static int hw_dev_close(struct sr_dev_inst *sdi)
413 static int hw_cleanup(void)
415 struct drv_context *drvc;
417 if (!(drvc = hdi->priv))
427 static int hw_info_get(int info_id, const void **data,
428 const struct sr_dev_inst *sdi)
438 case SR_DI_NUM_PROBES:
439 *data = GINT_TO_POINTER(NUM_PROBES);
441 case SR_DI_PROBE_NAMES:
444 case SR_DI_BUFFERSIZES:
447 case SR_DI_TIMEBASES:
450 case SR_DI_TRIGGER_SOURCES:
451 *data = trigger_sources;
454 *data = filter_targets;
462 /* TODO remove this */
463 case SR_DI_CUR_SAMPLERATE:
473 static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
476 struct dev_context *devc;
477 struct sr_rational tmp_rat;
483 if (sdi->status != SR_ST_ACTIVE)
489 case SR_HWCAP_LIMIT_FRAMES:
490 devc->limit_frames = *(const uint64_t *)value;
492 case SR_HWCAP_TRIGGER_SLOPE:
493 tmp_u64 = *(const int *)value;
494 if (tmp_u64 != SLOPE_NEGATIVE && tmp_u64 != SLOPE_POSITIVE)
496 devc->triggerslope = tmp_u64;
498 case SR_HWCAP_HORIZ_TRIGGERPOS:
499 tmp_float = *(const float *)value;
500 if (tmp_float < 0.0 || tmp_float > 1.0) {
501 sr_err("Trigger position should be between 0.0 and 1.0.");
504 devc->triggerposition = tmp_float;
506 case SR_HWCAP_BUFFERSIZE:
507 tmp_u64 = *(const int *)value;
508 for (i = 0; buffersizes[i]; i++) {
509 if (buffersizes[i] == tmp_u64) {
510 devc->framesize = tmp_u64;
514 if (buffersizes[i] == 0)
517 case SR_HWCAP_TIMEBASE:
518 tmp_rat = *(const struct sr_rational *)value;
519 for (i = 0; timebases[i].p && timebases[i].q; i++) {
520 if (timebases[i].p == tmp_rat.p
521 && timebases[i].q == tmp_rat.q) {
526 if (timebases[i].p == 0 && timebases[i].q == 0)
529 case SR_HWCAP_TRIGGER_SOURCE:
530 for (i = 0; trigger_sources[i]; i++) {
531 if (!strcmp(value, trigger_sources[i])) {
532 devc->triggersource = g_strdup(value);
536 if (trigger_sources[i] == 0)
539 case SR_HWCAP_FILTER:
540 devc->filter_ch1 = devc->filter_ch2 = devc->filter_trigger = 0;
541 targets = g_strsplit(value, ",", 0);
542 for (i = 0; targets[i]; i++) {
543 if (targets[i] == '\0')
544 /* Empty filter string can be used to clear them all. */
546 else if (!strcmp(targets[i], "CH1"))
547 devc->filter_ch1 = TRUE;
548 else if (!strcmp(targets[i], "CH2"))
549 devc->filter_ch2 = TRUE;
550 else if (!strcmp(targets[i], "TRIGGER"))
551 devc->filter_trigger = TRUE;
553 sr_err("Invalid filter target %s.", targets[i]);
560 /* TODO: Not supporting vdiv per channel yet. */
561 tmp_rat = *(const struct sr_rational *)value;
562 for (i = 0; vdivs[i].p && vdivs[i].q; i++) {
563 if (vdivs[i].p == tmp_rat.p
564 && vdivs[i].q == tmp_rat.q) {
565 devc->voltage_ch1 = i;
566 devc->voltage_ch2 = i;
570 if (vdivs[i].p == 0 && vdivs[i].q == 0)
573 case SR_HWCAP_COUPLING:
574 /* TODO: Not supporting coupling per channel yet. */
575 for (i = 0; coupling[i]; i++) {
576 if (!strcmp(value, coupling[i])) {
577 devc->coupling_ch1 = i;
578 devc->coupling_ch2 = i;
582 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 /* TODO: Check malloc return value. */
609 analog.data = g_try_malloc(analog.num_samples * sizeof(float) * num_probes);
611 for (i = 0; i < analog.num_samples; i++) {
613 * The device always sends data for both channels. If a channel
614 * is disabled, it contains a copy of the enabled channel's
615 * data. However, we only send the requested channels to
618 * Voltage values are encoded as a value 0-255 (0-512 on the
619 * DSO-5200*), where the value is a point in the range
620 * represented by the vdiv setting. There are 8 vertical divs,
621 * so e.g. 500mV/div represents 4V peak-to-peak where 0 = -2V
624 /* TODO: Support for DSO-5xxx series 9-bit samples. */
625 if (devc->ch1_enabled) {
626 range = ((float)vdivs[devc->voltage_ch1].p / vdivs[devc->voltage_ch1].q) * 8;
627 ch1 = range / 255 * *(buf + i * 2 + 1);
628 /* Value is centered around 0V. */
630 analog.data[data_offset++] = ch1;
632 if (devc->ch2_enabled) {
633 range = ((float)vdivs[devc->voltage_ch2].p / vdivs[devc->voltage_ch2].q) * 8;
634 ch2 = range / 255 * *(buf + i * 2);
636 analog.data[data_offset++] = ch2;
639 sr_session_send(devc->cb_data, &packet);
643 * Called by libusb (as triggered by handle_event()) when a transfer comes in.
644 * Only channel data comes in asynchronously, and all transfers for this are
645 * queued up beforehand, so this just needs to chuck the incoming data onto
646 * the libsigrok session bus.
648 static void receive_transfer(struct libusb_transfer *transfer)
650 struct sr_datafeed_packet packet;
651 struct dev_context *devc;
652 int num_samples, pre;
654 devc = transfer->user_data;
655 sr_dbg("receive_transfer(): status %d received %d bytes.",
656 transfer->status, transfer->actual_length);
658 if (transfer->actual_length == 0)
659 /* Nothing to send to the bus. */
662 num_samples = transfer->actual_length / 2;
664 sr_dbg("Got %d-%d/%d samples in frame.", devc->samp_received + 1,
665 devc->samp_received + num_samples, devc->framesize);
668 * The device always sends a full frame, but the beginning of the frame
669 * doesn't represent the trigger point. The offset at which the trigger
670 * happened came in with the capture state, so we need to start sending
671 * from there up the session bus. The samples in the frame buffer
672 * before that trigger point came after the end of the device's frame
673 * buffer was reached, and it wrapped around to overwrite up until the
676 if (devc->samp_received < devc->trigger_offset) {
677 /* Trigger point not yet reached. */
678 if (devc->samp_received + num_samples < devc->trigger_offset) {
679 /* The entire chunk is before the trigger point. */
680 memcpy(devc->framebuf + devc->samp_buffered * 2,
681 transfer->buffer, num_samples * 2);
682 devc->samp_buffered += num_samples;
685 * This chunk hits or overruns the trigger point.
686 * Store the part before the trigger fired, and
687 * send the rest up to the session bus.
689 pre = devc->trigger_offset - devc->samp_received;
690 memcpy(devc->framebuf + devc->samp_buffered * 2,
691 transfer->buffer, pre * 2);
692 devc->samp_buffered += pre;
694 /* The rest of this chunk starts with the trigger point. */
695 sr_dbg("Reached trigger point, %d samples buffered.",
696 devc->samp_buffered);
698 /* Avoid the corner case where the chunk ended at
699 * exactly the trigger point. */
700 if (num_samples > pre)
701 send_chunk(devc, transfer->buffer + pre * 2,
705 /* Already past the trigger point, just send it all out. */
706 send_chunk(devc, transfer->buffer,
710 devc->samp_received += num_samples;
712 /* Everything in this transfer was either copied to the buffer or
713 * sent to the session bus. */
714 g_free(transfer->buffer);
715 libusb_free_transfer(transfer);
717 if (devc->samp_received >= devc->framesize) {
718 /* That was the last chunk in this frame. Send the buffered
719 * pre-trigger samples out now, in one big chunk. */
720 sr_dbg("End of frame, sending %d pre-trigger buffered samples.",
721 devc->samp_buffered);
722 send_chunk(devc, devc->framebuf, devc->samp_buffered);
724 /* Mark the end of this frame. */
725 packet.type = SR_DF_FRAME_END;
726 sr_session_send(devc->cb_data, &packet);
728 if (devc->limit_frames && ++devc->num_frames == devc->limit_frames) {
729 /* Terminate session */
730 devc->dev_state = STOPPING;
732 devc->dev_state = NEW_CAPTURE;
737 static int handle_event(int fd, int revents, void *cb_data)
739 const struct sr_dev_inst *sdi;
740 struct sr_datafeed_packet packet;
742 struct dev_context *devc;
743 const struct libusb_pollfd **lupfd;
745 uint32_t trigger_offset;
746 uint8_t capturestate;
753 if (devc->dev_state == STOPPING) {
754 /* We've been told to wind up the acquisition. */
755 sr_dbg("Stopping acquisition.");
757 * TODO: Doesn't really cancel pending transfers so they might
758 * come in after SR_DF_END is sent.
760 lupfd = libusb_get_pollfds(NULL);
761 for (i = 0; lupfd[i]; i++)
762 sr_source_remove(lupfd[i]->fd);
765 packet.type = SR_DF_END;
766 sr_session_send(sdi, &packet);
768 devc->dev_state = IDLE;
773 /* Always handle pending libusb events. */
774 tv.tv_sec = tv.tv_usec = 0;
775 libusb_handle_events_timeout(NULL, &tv);
778 if (devc->dev_state == NEW_CAPTURE) {
779 if (dso_capture_start(devc) != SR_OK)
781 if (dso_enable_trigger(devc) != SR_OK)
783 // if (dso_force_trigger(devc) != SR_OK)
785 sr_dbg("Successfully requested next chunk.");
786 devc->dev_state = CAPTURE;
789 if (devc->dev_state != CAPTURE)
792 if ((dso_get_capturestate(devc, &capturestate, &trigger_offset)) != SR_OK)
795 sr_dbg("Capturestate %d.", capturestate);
796 sr_dbg("Trigger offset 0x%.6x.", trigger_offset);
797 switch (capturestate) {
799 if (++devc->capture_empty_count >= MAX_CAPTURE_EMPTY) {
800 devc->capture_empty_count = 0;
801 if (dso_capture_start(devc) != SR_OK)
803 if (dso_enable_trigger(devc) != SR_OK)
805 // if (dso_force_trigger(devc) != SR_OK)
807 sr_dbg("Successfully requested next chunk.");
810 case CAPTURE_FILLING:
813 case CAPTURE_READY_8BIT:
814 /* Remember where in the captured frame the trigger is. */
815 devc->trigger_offset = trigger_offset;
817 num_probes = (devc->ch1_enabled && devc->ch2_enabled) ? 2 : 1;
818 /* TODO: Check malloc return value. */
819 devc->framebuf = g_try_malloc(devc->framesize * num_probes * 2);
820 devc->samp_buffered = devc->samp_received = 0;
822 /* Tell the scope to send us the first frame. */
823 if (dso_get_channeldata(devc, receive_transfer) != SR_OK)
827 * Don't hit the state machine again until we're done fetching
828 * the data we just told the scope to send.
830 devc->dev_state = FETCH_DATA;
832 /* Tell the frontend a new frame is on the way. */
833 packet.type = SR_DF_FRAME_BEGIN;
834 sr_session_send(sdi, &packet);
836 case CAPTURE_READY_9BIT:
838 sr_err("Not yet supported.");
840 case CAPTURE_TIMEOUT:
841 /* Doesn't matter, we'll try again next time. */
844 sr_dbg("Unknown capture state: %d.", capturestate);
851 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
854 const struct libusb_pollfd **lupfd;
855 struct sr_datafeed_packet packet;
856 struct sr_datafeed_header header;
857 struct sr_datafeed_meta_analog meta;
858 struct dev_context *devc;
861 if (sdi->status != SR_ST_ACTIVE)
865 devc->cb_data = cb_data;
867 if (configure_probes(sdi) != SR_OK) {
868 sr_err("Failed to configure probes.");
872 if (dso_init(devc) != SR_OK)
875 if (dso_capture_start(devc) != SR_OK)
878 devc->dev_state = CAPTURE;
879 lupfd = libusb_get_pollfds(NULL);
880 for (i = 0; lupfd[i]; i++)
881 sr_source_add(lupfd[i]->fd, lupfd[i]->events, TICK,
882 handle_event, (void *)sdi);
885 /* Send header packet to the session bus. */
886 packet.type = SR_DF_HEADER;
887 packet.payload = (unsigned char *)&header;
888 header.feed_version = 1;
889 gettimeofday(&header.starttime, NULL);
890 sr_session_send(cb_data, &packet);
892 /* Send metadata about the SR_DF_ANALOG packets to come. */
893 packet.type = SR_DF_META_ANALOG;
894 packet.payload = &meta;
895 meta.num_probes = NUM_PROBES;
896 sr_session_send(cb_data, &packet);
901 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
903 struct dev_context *devc;
907 if (sdi->status != SR_ST_ACTIVE)
911 devc->dev_state = STOPPING;
916 SR_PRIV struct sr_dev_driver hantek_dso_driver_info = {
917 .name = "hantek-dso",
918 .longname = "Hantek DSO",
921 .cleanup = hw_cleanup,
923 .dev_list = hw_dev_list,
924 .dev_clear = clear_instances,
925 .dev_open = hw_dev_open,
926 .dev_close = hw_dev_close,
927 .info_get = hw_info_get,
928 .dev_config_set = hw_dev_config_set,
929 .dev_acquisition_start = hw_dev_acquisition_start,
930 .dev_acquisition_stop = hw_dev_acquisition_stop,