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;
289 drvc->instances = NULL;
296 /* Find all Hantek DSO devices and upload firmware to all of them. */
297 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
298 for (i = 0; devlist[i]; i++) {
299 if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
300 sr_err("Failed to get device descriptor: %s.",
301 libusb_error_name(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: %s.",
400 libusb_error_name(err));
407 static int hw_dev_close(struct sr_dev_inst *sdi)
414 static int hw_cleanup(void)
416 struct drv_context *drvc;
418 if (!(drvc = di->priv))
426 static int config_set(int id, const void *value, const struct sr_dev_inst *sdi)
428 struct dev_context *devc;
429 struct sr_rational tmp_rat;
435 if (sdi->status != SR_ST_ACTIVE)
441 case SR_CONF_LIMIT_FRAMES:
442 devc->limit_frames = *(const uint64_t *)value;
444 case SR_CONF_TRIGGER_SLOPE:
445 tmp_u64 = *(const int *)value;
446 if (tmp_u64 != SLOPE_NEGATIVE && tmp_u64 != SLOPE_POSITIVE)
448 devc->triggerslope = tmp_u64;
450 case SR_CONF_HORIZ_TRIGGERPOS:
451 tmp_float = *(const float *)value;
452 if (tmp_float < 0.0 || tmp_float > 1.0) {
453 sr_err("Trigger position should be between 0.0 and 1.0.");
456 devc->triggerposition = tmp_float;
458 case SR_CONF_BUFFERSIZE:
459 tmp_u64 = *(const int *)value;
460 for (i = 0; buffersizes[i]; i++) {
461 if (buffersizes[i] == tmp_u64) {
462 devc->framesize = tmp_u64;
466 if (buffersizes[i] == 0)
469 case SR_CONF_TIMEBASE:
470 tmp_rat = *(const struct sr_rational *)value;
471 for (i = 0; timebases[i].p && timebases[i].q; i++) {
472 if (timebases[i].p == tmp_rat.p
473 && timebases[i].q == tmp_rat.q) {
478 if (timebases[i].p == 0 && timebases[i].q == 0)
481 case SR_CONF_TRIGGER_SOURCE:
482 for (i = 0; trigger_sources[i]; i++) {
483 if (!strcmp(value, trigger_sources[i])) {
484 devc->triggersource = g_strdup(value);
488 if (trigger_sources[i] == 0)
492 devc->filter_ch1 = devc->filter_ch2 = devc->filter_trigger = 0;
493 targets = g_strsplit(value, ",", 0);
494 for (i = 0; targets[i]; i++) {
495 if (targets[i] == '\0')
496 /* Empty filter string can be used to clear them all. */
498 else if (!strcmp(targets[i], "CH1"))
499 devc->filter_ch1 = TRUE;
500 else if (!strcmp(targets[i], "CH2"))
501 devc->filter_ch2 = TRUE;
502 else if (!strcmp(targets[i], "TRIGGER"))
503 devc->filter_trigger = TRUE;
505 sr_err("Invalid filter target %s.", targets[i]);
512 /* TODO: Not supporting vdiv per channel yet. */
513 tmp_rat = *(const struct sr_rational *)value;
514 for (i = 0; vdivs[i].p && vdivs[i].q; i++) {
515 if (vdivs[i].p == tmp_rat.p
516 && vdivs[i].q == tmp_rat.q) {
517 devc->voltage_ch1 = i;
518 devc->voltage_ch2 = i;
522 if (vdivs[i].p == 0 && vdivs[i].q == 0)
525 case SR_CONF_COUPLING:
526 /* TODO: Not supporting coupling per channel yet. */
527 for (i = 0; coupling[i]; i++) {
528 if (!strcmp(value, coupling[i])) {
529 devc->coupling_ch1 = i;
530 devc->coupling_ch2 = i;
534 if (coupling[i] == 0)
545 static int config_list(int key, const void **data, const struct sr_dev_inst *sdi)
551 case SR_CONF_DEVICE_OPTIONS:
554 case SR_CONF_BUFFERSIZE:
557 case SR_CONF_COUPLING:
564 *data = filter_targets;
566 case SR_CONF_TIMEBASE:
569 case SR_CONF_TRIGGER_SOURCE:
570 *data = trigger_sources;
579 static void send_chunk(struct sr_dev_inst *sdi, unsigned char *buf,
582 struct sr_datafeed_packet packet;
583 struct sr_datafeed_analog analog;
584 struct dev_context *devc;
585 float ch1, ch2, range;
586 int num_probes, data_offset, i;
589 num_probes = (devc->ch1_enabled && devc->ch2_enabled) ? 2 : 1;
590 packet.type = SR_DF_ANALOG;
591 packet.payload = &analog;
592 /* TODO: support for 5xxx series 9-bit samples */
593 analog.probes = devc->enabled_probes;
594 analog.num_samples = num_samples;
595 analog.mq = SR_MQ_VOLTAGE;
596 analog.unit = SR_UNIT_VOLT;
597 /* TODO: Check malloc return value. */
598 analog.data = g_try_malloc(analog.num_samples * sizeof(float) * num_probes);
600 for (i = 0; i < analog.num_samples; i++) {
602 * The device always sends data for both channels. If a channel
603 * is disabled, it contains a copy of the enabled channel's
604 * data. However, we only send the requested channels to
607 * Voltage values are encoded as a value 0-255 (0-512 on the
608 * DSO-5200*), where the value is a point in the range
609 * represented by the vdiv setting. There are 8 vertical divs,
610 * so e.g. 500mV/div represents 4V peak-to-peak where 0 = -2V
613 /* TODO: Support for DSO-5xxx series 9-bit samples. */
614 if (devc->ch1_enabled) {
615 range = ((float)vdivs[devc->voltage_ch1].p / vdivs[devc->voltage_ch1].q) * 8;
616 ch1 = range / 255 * *(buf + i * 2 + 1);
617 /* Value is centered around 0V. */
619 analog.data[data_offset++] = ch1;
621 if (devc->ch2_enabled) {
622 range = ((float)vdivs[devc->voltage_ch2].p / vdivs[devc->voltage_ch2].q) * 8;
623 ch2 = range / 255 * *(buf + i * 2);
625 analog.data[data_offset++] = ch2;
628 sr_session_send(devc->cb_data, &packet);
632 * Called by libusb (as triggered by handle_event()) when a transfer comes in.
633 * Only channel data comes in asynchronously, and all transfers for this are
634 * queued up beforehand, so this just needs to chuck the incoming data onto
635 * the libsigrok session bus.
637 static void receive_transfer(struct libusb_transfer *transfer)
639 struct sr_datafeed_packet packet;
640 struct sr_dev_inst *sdi;
641 struct dev_context *devc;
642 int num_samples, pre;
644 sdi = transfer->user_data;
646 sr_dbg("receive_transfer(): status %d received %d bytes.",
647 transfer->status, transfer->actual_length);
649 if (transfer->actual_length == 0)
650 /* Nothing to send to the bus. */
653 num_samples = transfer->actual_length / 2;
655 sr_dbg("Got %d-%d/%d samples in frame.", devc->samp_received + 1,
656 devc->samp_received + num_samples, devc->framesize);
659 * The device always sends a full frame, but the beginning of the frame
660 * doesn't represent the trigger point. The offset at which the trigger
661 * happened came in with the capture state, so we need to start sending
662 * from there up the session bus. The samples in the frame buffer
663 * before that trigger point came after the end of the device's frame
664 * buffer was reached, and it wrapped around to overwrite up until the
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;
676 * This chunk hits or overruns the trigger point.
677 * Store the part before the trigger fired, and
678 * send the rest up to the session bus.
680 pre = devc->trigger_offset - devc->samp_received;
681 memcpy(devc->framebuf + devc->samp_buffered * 2,
682 transfer->buffer, pre * 2);
683 devc->samp_buffered += pre;
685 /* The rest of this chunk starts with the trigger point. */
686 sr_dbg("Reached trigger point, %d samples buffered.",
687 devc->samp_buffered);
689 /* Avoid the corner case where the chunk ended at
690 * exactly the trigger point. */
691 if (num_samples > pre)
692 send_chunk(sdi, transfer->buffer + pre * 2,
696 /* Already past the trigger point, just send it all out. */
697 send_chunk(sdi, transfer->buffer,
701 devc->samp_received += num_samples;
703 /* Everything in this transfer was either copied to the buffer or
704 * sent to the session bus. */
705 g_free(transfer->buffer);
706 libusb_free_transfer(transfer);
708 if (devc->samp_received >= devc->framesize) {
709 /* That was the last chunk in this frame. Send the buffered
710 * pre-trigger samples out now, in one big chunk. */
711 sr_dbg("End of frame, sending %d pre-trigger buffered samples.",
712 devc->samp_buffered);
713 send_chunk(sdi, devc->framebuf, devc->samp_buffered);
715 /* Mark the end of this frame. */
716 packet.type = SR_DF_FRAME_END;
717 sr_session_send(devc->cb_data, &packet);
719 if (devc->limit_frames && ++devc->num_frames == devc->limit_frames) {
720 /* Terminate session */
721 devc->dev_state = STOPPING;
723 devc->dev_state = NEW_CAPTURE;
728 static int handle_event(int fd, int revents, void *cb_data)
730 const struct sr_dev_inst *sdi;
731 struct sr_datafeed_packet packet;
733 struct dev_context *devc;
734 struct drv_context *drvc = di->priv;
735 const struct libusb_pollfd **lupfd;
737 uint32_t trigger_offset;
738 uint8_t capturestate;
745 if (devc->dev_state == STOPPING) {
746 /* We've been told to wind up the acquisition. */
747 sr_dbg("Stopping acquisition.");
749 * TODO: Doesn't really cancel pending transfers so they might
750 * come in after SR_DF_END is sent.
752 lupfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
753 for (i = 0; lupfd[i]; i++)
754 sr_source_remove(lupfd[i]->fd);
757 packet.type = SR_DF_END;
758 sr_session_send(sdi, &packet);
760 devc->dev_state = IDLE;
765 /* Always handle pending libusb events. */
766 tv.tv_sec = tv.tv_usec = 0;
767 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
770 if (devc->dev_state == NEW_CAPTURE) {
771 if (dso_capture_start(devc) != SR_OK)
773 if (dso_enable_trigger(devc) != SR_OK)
775 // if (dso_force_trigger(devc) != SR_OK)
777 sr_dbg("Successfully requested next chunk.");
778 devc->dev_state = CAPTURE;
781 if (devc->dev_state != CAPTURE)
784 if ((dso_get_capturestate(devc, &capturestate, &trigger_offset)) != SR_OK)
787 sr_dbg("Capturestate %d.", capturestate);
788 sr_dbg("Trigger offset 0x%.6x.", trigger_offset);
789 switch (capturestate) {
791 if (++devc->capture_empty_count >= MAX_CAPTURE_EMPTY) {
792 devc->capture_empty_count = 0;
793 if (dso_capture_start(devc) != SR_OK)
795 if (dso_enable_trigger(devc) != SR_OK)
797 // if (dso_force_trigger(devc) != SR_OK)
799 sr_dbg("Successfully requested next chunk.");
802 case CAPTURE_FILLING:
805 case CAPTURE_READY_8BIT:
806 /* Remember where in the captured frame the trigger is. */
807 devc->trigger_offset = trigger_offset;
809 num_probes = (devc->ch1_enabled && devc->ch2_enabled) ? 2 : 1;
810 /* TODO: Check malloc return value. */
811 devc->framebuf = g_try_malloc(devc->framesize * num_probes * 2);
812 devc->samp_buffered = devc->samp_received = 0;
814 /* Tell the scope to send us the first frame. */
815 if (dso_get_channeldata(sdi, 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: %d.", capturestate);
843 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
846 const struct libusb_pollfd **lupfd;
847 struct sr_datafeed_packet packet;
848 struct sr_datafeed_header header;
849 struct dev_context *devc;
850 struct drv_context *drvc = di->priv;
853 if (sdi->status != SR_ST_ACTIVE)
857 devc->cb_data = cb_data;
859 if (configure_probes(sdi) != SR_OK) {
860 sr_err("Failed to configure probes.");
864 if (dso_init(devc) != SR_OK)
867 if (dso_capture_start(devc) != SR_OK)
870 devc->dev_state = CAPTURE;
871 lupfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
872 for (i = 0; lupfd[i]; i++)
873 sr_source_add(lupfd[i]->fd, lupfd[i]->events, TICK,
874 handle_event, (void *)sdi);
877 /* Send header packet to the session bus. */
878 packet.type = SR_DF_HEADER;
879 packet.payload = (unsigned char *)&header;
880 header.feed_version = 1;
881 gettimeofday(&header.starttime, NULL);
882 sr_session_send(cb_data, &packet);
887 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
889 struct dev_context *devc;
893 if (sdi->status != SR_ST_ACTIVE)
897 devc->dev_state = STOPPING;
902 SR_PRIV struct sr_dev_driver hantek_dso_driver_info = {
903 .name = "hantek-dso",
904 .longname = "Hantek DSO",
907 .cleanup = hw_cleanup,
909 .dev_list = hw_dev_list,
910 .dev_clear = clear_instances,
911 .config_set = config_set,
912 .config_list = config_list,
913 .dev_open = hw_dev_open,
914 .dev_close = hw_dev_close,
915 .dev_acquisition_start = hw_dev_acquisition_start,
916 .dev_acquisition_stop = hw_dev_acquisition_stop,