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[] = {
42 SR_CONF_LIMIT_SAMPLES,
46 SR_CONF_TRIGGER_SOURCE,
47 SR_CONF_TRIGGER_SLOPE,
48 SR_CONF_HORIZ_TRIGGERPOS,
55 static const char *probe_names[] = {
60 static const struct dso_profile dev_profiles[] = {
61 { 0x04b4, 0x2090, 0x04b5, 0x2090,
63 FIRMWARE_DIR "/hantek-dso-2xxx.fw" },
64 { 0x04b4, 0x2150, 0x04b5, 0x2150,
66 FIRMWARE_DIR "/hantek-dso-2xxx.fw" },
67 { 0x04b4, 0x2250, 0x04b5, 0x2250,
69 FIRMWARE_DIR "/hantek-dso-2xxx.fw" },
70 { 0x04b4, 0x5200, 0x04b5, 0x5200,
72 FIRMWARE_DIR "/hantek-dso-5xxx.fw" },
73 { 0x04b4, 0x520a, 0x04b5, 0x520a,
74 "Hantek", "DSO-5200A",
75 FIRMWARE_DIR "/hantek-dso-5xxx.fw" },
76 { 0, 0, 0, 0, 0, 0, 0 },
79 static const uint64_t buffersizes[] = {
86 static const struct sr_rational timebases[] = {
107 static const struct sr_rational vdivs[] = {
122 static const char *trigger_sources[] = {
130 static const char *filter_targets[] = {
133 /* TODO: "TRIGGER", */
137 static const char *coupling[] = {
144 SR_PRIV struct sr_dev_driver hantek_dso_driver_info;
145 static struct sr_dev_driver *di = &hantek_dso_driver_info;
147 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data);
149 static struct sr_dev_inst *dso_dev_new(int index, const struct dso_profile *prof)
151 struct sr_dev_inst *sdi;
152 struct sr_probe *probe;
153 struct drv_context *drvc;
154 struct dev_context *devc;
157 sdi = sr_dev_inst_new(index, SR_ST_INITIALIZING,
158 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("Device context malloc failed.");
179 devc->profile = prof;
180 devc->dev_state = IDLE;
181 devc->timebase = DEFAULT_TIMEBASE;
182 devc->ch1_enabled = TRUE;
183 devc->ch2_enabled = TRUE;
184 devc->voltage_ch1 = DEFAULT_VOLTAGE;
185 devc->voltage_ch2 = DEFAULT_VOLTAGE;
186 devc->coupling_ch1 = DEFAULT_COUPLING;
187 devc->coupling_ch2 = DEFAULT_COUPLING;
188 devc->voffset_ch1 = DEFAULT_VERT_OFFSET;
189 devc->voffset_ch2 = DEFAULT_VERT_OFFSET;
190 devc->voffset_trigger = DEFAULT_VERT_TRIGGERPOS;
191 devc->framesize = DEFAULT_FRAMESIZE;
192 devc->triggerslope = SLOPE_POSITIVE;
193 devc->triggersource = g_strdup(DEFAULT_TRIGGER_SOURCE);
194 devc->triggerposition = DEFAULT_HORIZ_TRIGGERPOS;
197 drvc->instances = g_slist_append(drvc->instances, sdi);
202 static int configure_probes(const struct sr_dev_inst *sdi)
204 struct dev_context *devc;
205 struct sr_probe *probe;
211 g_slist_free(devc->enabled_probes);
212 devc->ch1_enabled = devc->ch2_enabled = FALSE;
213 for (l = sdi->probes, p = 0; l; l = l->next, p++) {
216 devc->ch1_enabled = probe->enabled;
218 devc->ch2_enabled = probe->enabled;
220 devc->enabled_probes = g_slist_append(devc->enabled_probes, probe);
226 /* Properly close and free all devices. */
227 static int clear_instances(void)
229 struct sr_dev_inst *sdi;
230 struct drv_context *drvc;
231 struct dev_context *devc;
235 for (l = drvc->instances; l; l = l->next) {
236 if (!(sdi = l->data)) {
237 /* Log error, but continue cleaning up the rest. */
238 sr_err("%s: sdi was NULL, continuing", __func__);
241 if (!(devc = sdi->priv)) {
242 /* Log error, but continue cleaning up the rest. */
243 sr_err("%s: sdi->priv was NULL, continuing", __func__);
247 sr_usb_dev_inst_free(devc->usb);
248 g_free(devc->triggersource);
249 g_slist_free(devc->enabled_probes);
251 sr_dev_inst_free(sdi);
254 g_slist_free(drvc->instances);
255 drvc->instances = NULL;
260 static int hw_init(struct sr_context *sr_ctx)
262 struct drv_context *drvc;
264 if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
265 sr_err("Driver context malloc failed.");
266 return SR_ERR_MALLOC;
269 drvc->sr_ctx = sr_ctx;
275 static GSList *hw_scan(GSList *options)
277 struct sr_dev_inst *sdi;
278 const struct dso_profile *prof;
279 struct drv_context *drvc;
280 struct dev_context *devc;
282 struct libusb_device_descriptor des;
283 libusb_device **devlist;
284 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->sr_ctx->libusb_ctx, &devlist);
297 for (i = 0; devlist[i]; i++) {
298 if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
299 sr_err("Failed to get device descriptor: %s.",
300 libusb_error_name(ret));
305 for (j = 0; dev_profiles[j].orig_vid; j++) {
306 if (des.idVendor == dev_profiles[j].orig_vid
307 && des.idProduct == dev_profiles[j].orig_pid) {
308 /* Device matches the pre-firmware profile. */
309 prof = &dev_profiles[j];
310 sr_dbg("Found a %s %s.", prof->vendor, prof->model);
311 sdi = dso_dev_new(devcnt, prof);
312 devices = g_slist_append(devices, sdi);
314 if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
315 prof->firmware) == SR_OK)
316 /* Remember when the firmware on this device was updated */
317 devc->fw_updated = g_get_monotonic_time();
319 sr_err("Firmware upload failed for "
320 "device %d.", devcnt);
321 /* Dummy USB address of 0xff will get overwritten later. */
322 devc->usb = sr_usb_dev_inst_new(
323 libusb_get_bus_number(devlist[i]), 0xff, NULL);
326 } else if (des.idVendor == dev_profiles[j].fw_vid
327 && des.idProduct == dev_profiles[j].fw_pid) {
328 /* Device matches the post-firmware profile. */
329 prof = &dev_profiles[j];
330 sr_dbg("Found a %s %s.", prof->vendor, prof->model);
331 sdi = dso_dev_new(devcnt, prof);
332 sdi->status = SR_ST_INACTIVE;
333 devices = g_slist_append(devices, sdi);
335 devc->usb = sr_usb_dev_inst_new(
336 libusb_get_bus_number(devlist[i]),
337 libusb_get_device_address(devlist[i]), NULL);
343 /* not a supported VID/PID */
346 libusb_free_device_list(devlist, 1);
351 static GSList *hw_dev_list(void)
353 struct drv_context *drvc;
357 return drvc->instances;
360 static int hw_dev_open(struct sr_dev_inst *sdi)
362 struct dev_context *devc;
363 int64_t timediff_us, timediff_ms;
369 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
370 * for the FX2 to renumerate.
373 if (devc->fw_updated > 0) {
374 sr_info("Waiting for device to reset.");
375 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
376 g_usleep(300 * 1000);
378 while (timediff_ms < MAX_RENUM_DELAY_MS) {
379 if ((err = dso_open(sdi)) == SR_OK)
381 g_usleep(100 * 1000);
382 timediff_us = g_get_monotonic_time() - devc->fw_updated;
383 timediff_ms = timediff_us / 1000;
384 sr_spew("Waited %" PRIi64 " ms.", timediff_ms);
386 sr_info("Device came back after %d ms.", timediff_ms);
392 sr_err("Unable to open device.");
396 err = libusb_claim_interface(devc->usb->devhdl, USB_INTERFACE);
398 sr_err("Unable to claim interface: %s.",
399 libusb_error_name(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 = di->priv))
425 static int config_get(int id, const void **data, const struct sr_dev_inst *sdi)
435 case SR_DI_BUFFERSIZES:
438 case SR_DI_TIMEBASES:
441 case SR_DI_TRIGGER_SOURCES:
442 *data = trigger_sources;
445 *data = filter_targets;
453 /* TODO remove this */
454 case SR_DI_CUR_SAMPLERATE:
464 static int config_set(int id, const void *value, const struct sr_dev_inst *sdi)
466 struct dev_context *devc;
467 struct sr_rational tmp_rat;
473 if (sdi->status != SR_ST_ACTIVE)
479 case SR_CONF_LIMIT_FRAMES:
480 devc->limit_frames = *(const uint64_t *)value;
482 case SR_CONF_TRIGGER_SLOPE:
483 tmp_u64 = *(const int *)value;
484 if (tmp_u64 != SLOPE_NEGATIVE && tmp_u64 != SLOPE_POSITIVE)
486 devc->triggerslope = tmp_u64;
488 case SR_CONF_HORIZ_TRIGGERPOS:
489 tmp_float = *(const float *)value;
490 if (tmp_float < 0.0 || tmp_float > 1.0) {
491 sr_err("Trigger position should be between 0.0 and 1.0.");
494 devc->triggerposition = tmp_float;
496 case SR_CONF_BUFFERSIZE:
497 tmp_u64 = *(const int *)value;
498 for (i = 0; buffersizes[i]; i++) {
499 if (buffersizes[i] == tmp_u64) {
500 devc->framesize = tmp_u64;
504 if (buffersizes[i] == 0)
507 case SR_CONF_TIMEBASE:
508 tmp_rat = *(const struct sr_rational *)value;
509 for (i = 0; timebases[i].p && timebases[i].q; i++) {
510 if (timebases[i].p == tmp_rat.p
511 && timebases[i].q == tmp_rat.q) {
516 if (timebases[i].p == 0 && timebases[i].q == 0)
519 case SR_CONF_TRIGGER_SOURCE:
520 for (i = 0; trigger_sources[i]; i++) {
521 if (!strcmp(value, trigger_sources[i])) {
522 devc->triggersource = g_strdup(value);
526 if (trigger_sources[i] == 0)
530 devc->filter_ch1 = devc->filter_ch2 = devc->filter_trigger = 0;
531 targets = g_strsplit(value, ",", 0);
532 for (i = 0; targets[i]; i++) {
533 if (targets[i] == '\0')
534 /* Empty filter string can be used to clear them all. */
536 else if (!strcmp(targets[i], "CH1"))
537 devc->filter_ch1 = TRUE;
538 else if (!strcmp(targets[i], "CH2"))
539 devc->filter_ch2 = TRUE;
540 else if (!strcmp(targets[i], "TRIGGER"))
541 devc->filter_trigger = TRUE;
543 sr_err("Invalid filter target %s.", targets[i]);
550 /* TODO: Not supporting vdiv per channel yet. */
551 tmp_rat = *(const struct sr_rational *)value;
552 for (i = 0; vdivs[i].p && vdivs[i].q; i++) {
553 if (vdivs[i].p == tmp_rat.p
554 && vdivs[i].q == tmp_rat.q) {
555 devc->voltage_ch1 = i;
556 devc->voltage_ch2 = i;
560 if (vdivs[i].p == 0 && vdivs[i].q == 0)
563 case SR_CONF_COUPLING:
564 /* TODO: Not supporting coupling per channel yet. */
565 for (i = 0; coupling[i]; i++) {
566 if (!strcmp(value, coupling[i])) {
567 devc->coupling_ch1 = i;
568 devc->coupling_ch2 = i;
572 if (coupling[i] == 0)
583 static void send_chunk(struct sr_dev_inst *sdi, unsigned char *buf,
586 struct sr_datafeed_packet packet;
587 struct sr_datafeed_analog analog;
588 struct dev_context *devc;
589 float ch1, ch2, range;
590 int num_probes, data_offset, i;
593 num_probes = (devc->ch1_enabled && devc->ch2_enabled) ? 2 : 1;
594 packet.type = SR_DF_ANALOG;
595 packet.payload = &analog;
596 /* TODO: support for 5xxx series 9-bit samples */
597 analog.probes = devc->enabled_probes;
598 analog.num_samples = num_samples;
599 analog.mq = SR_MQ_VOLTAGE;
600 analog.unit = SR_UNIT_VOLT;
601 /* TODO: Check malloc return value. */
602 analog.data = g_try_malloc(analog.num_samples * sizeof(float) * num_probes);
604 for (i = 0; i < analog.num_samples; i++) {
606 * The device always sends data for both channels. If a channel
607 * is disabled, it contains a copy of the enabled channel's
608 * data. However, we only send the requested channels to
611 * Voltage values are encoded as a value 0-255 (0-512 on the
612 * DSO-5200*), where the value is a point in the range
613 * represented by the vdiv setting. There are 8 vertical divs,
614 * so e.g. 500mV/div represents 4V peak-to-peak where 0 = -2V
617 /* TODO: Support for DSO-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 to 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 sr_dev_inst *sdi;
645 struct dev_context *devc;
646 int num_samples, pre;
648 sdi = transfer->user_data;
650 sr_dbg("receive_transfer(): status %d received %d bytes.",
651 transfer->status, transfer->actual_length);
653 if (transfer->actual_length == 0)
654 /* Nothing to send to the bus. */
657 num_samples = transfer->actual_length / 2;
659 sr_dbg("Got %d-%d/%d samples in frame.", devc->samp_received + 1,
660 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
667 * before that trigger point came after the end of the device's frame
668 * buffer was reached, and it wrapped around to overwrite up until the
671 if (devc->samp_received < devc->trigger_offset) {
672 /* Trigger point not yet reached. */
673 if (devc->samp_received + num_samples < devc->trigger_offset) {
674 /* The entire chunk is before the trigger point. */
675 memcpy(devc->framebuf + devc->samp_buffered * 2,
676 transfer->buffer, num_samples * 2);
677 devc->samp_buffered += num_samples;
680 * This chunk hits or overruns the trigger point.
681 * Store the part before the trigger fired, and
682 * send the rest up to the session bus.
684 pre = devc->trigger_offset - devc->samp_received;
685 memcpy(devc->framebuf + devc->samp_buffered * 2,
686 transfer->buffer, pre * 2);
687 devc->samp_buffered += pre;
689 /* The rest of this chunk starts with the trigger point. */
690 sr_dbg("Reached trigger point, %d samples buffered.",
691 devc->samp_buffered);
693 /* Avoid the corner case where the chunk ended at
694 * exactly the trigger point. */
695 if (num_samples > pre)
696 send_chunk(sdi, transfer->buffer + pre * 2,
700 /* Already past the trigger point, just send it all out. */
701 send_chunk(sdi, transfer->buffer,
705 devc->samp_received += num_samples;
707 /* Everything in this transfer was either copied to the buffer or
708 * sent to the session bus. */
709 g_free(transfer->buffer);
710 libusb_free_transfer(transfer);
712 if (devc->samp_received >= devc->framesize) {
713 /* That was the last chunk in this frame. Send the buffered
714 * pre-trigger samples out now, in one big chunk. */
715 sr_dbg("End of frame, sending %d pre-trigger buffered samples.",
716 devc->samp_buffered);
717 send_chunk(sdi, devc->framebuf, devc->samp_buffered);
719 /* Mark the end of this frame. */
720 packet.type = SR_DF_FRAME_END;
721 sr_session_send(devc->cb_data, &packet);
723 if (devc->limit_frames && ++devc->num_frames == devc->limit_frames) {
724 /* Terminate session */
725 devc->dev_state = STOPPING;
727 devc->dev_state = NEW_CAPTURE;
732 static int handle_event(int fd, int revents, void *cb_data)
734 const struct sr_dev_inst *sdi;
735 struct sr_datafeed_packet packet;
737 struct dev_context *devc;
738 struct drv_context *drvc = di->priv;
739 const struct libusb_pollfd **lupfd;
741 uint32_t trigger_offset;
742 uint8_t capturestate;
749 if (devc->dev_state == STOPPING) {
750 /* We've been told to wind up the acquisition. */
751 sr_dbg("Stopping acquisition.");
753 * TODO: Doesn't really cancel pending transfers so they might
754 * come in after SR_DF_END is sent.
756 lupfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
757 for (i = 0; lupfd[i]; i++)
758 sr_source_remove(lupfd[i]->fd);
761 packet.type = SR_DF_END;
762 sr_session_send(sdi, &packet);
764 devc->dev_state = IDLE;
769 /* Always handle pending libusb events. */
770 tv.tv_sec = tv.tv_usec = 0;
771 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
774 if (devc->dev_state == NEW_CAPTURE) {
775 if (dso_capture_start(devc) != SR_OK)
777 if (dso_enable_trigger(devc) != SR_OK)
779 // if (dso_force_trigger(devc) != SR_OK)
781 sr_dbg("Successfully requested next chunk.");
782 devc->dev_state = CAPTURE;
785 if (devc->dev_state != CAPTURE)
788 if ((dso_get_capturestate(devc, &capturestate, &trigger_offset)) != SR_OK)
791 sr_dbg("Capturestate %d.", capturestate);
792 sr_dbg("Trigger offset 0x%.6x.", trigger_offset);
793 switch (capturestate) {
795 if (++devc->capture_empty_count >= MAX_CAPTURE_EMPTY) {
796 devc->capture_empty_count = 0;
797 if (dso_capture_start(devc) != SR_OK)
799 if (dso_enable_trigger(devc) != SR_OK)
801 // if (dso_force_trigger(devc) != SR_OK)
803 sr_dbg("Successfully requested next chunk.");
806 case CAPTURE_FILLING:
809 case CAPTURE_READY_8BIT:
810 /* Remember where in the captured frame the trigger is. */
811 devc->trigger_offset = trigger_offset;
813 num_probes = (devc->ch1_enabled && devc->ch2_enabled) ? 2 : 1;
814 /* TODO: Check malloc return value. */
815 devc->framebuf = g_try_malloc(devc->framesize * num_probes * 2);
816 devc->samp_buffered = devc->samp_received = 0;
818 /* Tell the scope to send us the first frame. */
819 if (dso_get_channeldata(sdi, receive_transfer) != SR_OK)
823 * Don't hit the state machine again until we're done fetching
824 * the data we just told the scope to send.
826 devc->dev_state = FETCH_DATA;
828 /* Tell the frontend a new frame is on the way. */
829 packet.type = SR_DF_FRAME_BEGIN;
830 sr_session_send(sdi, &packet);
832 case CAPTURE_READY_9BIT:
834 sr_err("Not yet supported.");
836 case CAPTURE_TIMEOUT:
837 /* Doesn't matter, we'll try again next time. */
840 sr_dbg("Unknown capture state: %d.", capturestate);
847 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
850 const struct libusb_pollfd **lupfd;
851 struct sr_datafeed_packet packet;
852 struct sr_datafeed_header header;
853 struct dev_context *devc;
854 struct drv_context *drvc = di->priv;
857 if (sdi->status != SR_ST_ACTIVE)
861 devc->cb_data = cb_data;
863 if (configure_probes(sdi) != SR_OK) {
864 sr_err("Failed to configure probes.");
868 if (dso_init(devc) != SR_OK)
871 if (dso_capture_start(devc) != SR_OK)
874 devc->dev_state = CAPTURE;
875 lupfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
876 for (i = 0; lupfd[i]; i++)
877 sr_source_add(lupfd[i]->fd, lupfd[i]->events, TICK,
878 handle_event, (void *)sdi);
881 /* Send header packet to the session bus. */
882 packet.type = SR_DF_HEADER;
883 packet.payload = (unsigned char *)&header;
884 header.feed_version = 1;
885 gettimeofday(&header.starttime, NULL);
886 sr_session_send(cb_data, &packet);
891 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
893 struct dev_context *devc;
897 if (sdi->status != SR_ST_ACTIVE)
901 devc->dev_state = STOPPING;
906 SR_PRIV struct sr_dev_driver hantek_dso_driver_info = {
907 .name = "hantek-dso",
908 .longname = "Hantek DSO",
911 .cleanup = hw_cleanup,
913 .dev_list = hw_dev_list,
914 .dev_clear = clear_instances,
915 .config_get = config_get,
916 .config_set = config_set,
917 .dev_open = hw_dev_open,
918 .dev_close = hw_dev_close,
919 .dev_acquisition_start = hw_dev_acquisition_start,
920 .dev_acquisition_stop = hw_dev_acquisition_stop,