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.");
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;
292 drvc->instances = NULL;
296 /* Find all Hantek DSO devices and upload firmware to all of them. */
297 libusb_get_device_list(NULL, &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: %d.", 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: %d.", err);
405 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))
426 static int hw_info_get(int info_id, const void **data,
427 const struct sr_dev_inst *sdi)
437 case SR_DI_NUM_PROBES:
438 *data = GINT_TO_POINTER(NUM_PROBES);
440 case SR_DI_PROBE_NAMES:
443 case SR_DI_BUFFERSIZES:
446 case SR_DI_TIMEBASES:
449 case SR_DI_TRIGGER_SOURCES:
450 *data = trigger_sources;
453 *data = filter_targets;
461 /* TODO remove this */
462 case SR_DI_CUR_SAMPLERATE:
472 static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
475 struct dev_context *devc;
476 struct sr_rational tmp_rat;
482 if (sdi->status != SR_ST_ACTIVE)
488 case SR_HWCAP_LIMIT_FRAMES:
489 devc->limit_frames = *(const uint64_t *)value;
491 case SR_HWCAP_TRIGGER_SLOPE:
492 tmp_u64 = *(const int *)value;
493 if (tmp_u64 != SLOPE_NEGATIVE && tmp_u64 != SLOPE_POSITIVE)
495 devc->triggerslope = tmp_u64;
497 case SR_HWCAP_HORIZ_TRIGGERPOS:
498 tmp_float = *(const float *)value;
499 if (tmp_float < 0.0 || tmp_float > 1.0) {
500 sr_err("Trigger position should be between 0.0 and 1.0.");
503 devc->triggerposition = tmp_float;
505 case SR_HWCAP_BUFFERSIZE:
506 tmp_u64 = *(const int *)value;
507 for (i = 0; buffersizes[i]; i++) {
508 if (buffersizes[i] == tmp_u64) {
509 devc->framesize = tmp_u64;
513 if (buffersizes[i] == 0)
516 case SR_HWCAP_TIMEBASE:
517 tmp_rat = *(const struct sr_rational *)value;
518 for (i = 0; timebases[i].p && timebases[i].q; i++) {
519 if (timebases[i].p == tmp_rat.p
520 && timebases[i].q == tmp_rat.q) {
525 if (timebases[i].p == 0 && timebases[i].q == 0)
528 case SR_HWCAP_TRIGGER_SOURCE:
529 for (i = 0; trigger_sources[i]; i++) {
530 if (!strcmp(value, trigger_sources[i])) {
531 devc->triggersource = g_strdup(value);
535 if (trigger_sources[i] == 0)
538 case SR_HWCAP_FILTER:
539 devc->filter_ch1 = devc->filter_ch2 = devc->filter_trigger = 0;
540 targets = g_strsplit(value, ",", 0);
541 for (i = 0; targets[i]; i++) {
542 if (targets[i] == '\0')
543 /* Empty filter string can be used to clear them all. */
545 else if (!strcmp(targets[i], "CH1"))
546 devc->filter_ch1 = TRUE;
547 else if (!strcmp(targets[i], "CH2"))
548 devc->filter_ch2 = TRUE;
549 else if (!strcmp(targets[i], "TRIGGER"))
550 devc->filter_trigger = TRUE;
552 sr_err("Invalid filter target %s.", targets[i]);
559 /* TODO: Not supporting vdiv per channel yet. */
560 tmp_rat = *(const struct sr_rational *)value;
561 for (i = 0; vdivs[i].p && vdivs[i].q; i++) {
562 if (vdivs[i].p == tmp_rat.p
563 && vdivs[i].q == tmp_rat.q) {
564 devc->voltage_ch1 = i;
565 devc->voltage_ch2 = i;
569 if (vdivs[i].p == 0 && vdivs[i].q == 0)
572 case SR_HWCAP_COUPLING:
573 /* TODO: Not supporting coupling per channel yet. */
574 for (i = 0; coupling[i]; i++) {
575 if (!strcmp(value, coupling[i])) {
576 devc->coupling_ch1 = i;
577 devc->coupling_ch2 = i;
581 if (coupling[i] == 0)
592 static void send_chunk(struct dev_context *devc, unsigned char *buf,
595 struct sr_datafeed_packet packet;
596 struct sr_datafeed_analog analog;
597 float ch1, ch2, range;
598 int num_probes, data_offset, i;
600 num_probes = (devc->ch1_enabled && devc->ch2_enabled) ? 2 : 1;
601 packet.type = SR_DF_ANALOG;
602 packet.payload = &analog;
603 /* TODO: support for 5xxx series 9-bit samples */
604 analog.num_samples = num_samples;
605 analog.mq = SR_MQ_VOLTAGE;
606 analog.unit = SR_UNIT_VOLT;
607 /* TODO: Check malloc return value. */
608 analog.data = g_try_malloc(analog.num_samples * sizeof(float) * num_probes);
610 for (i = 0; i < analog.num_samples; i++) {
612 * The device always sends data for both channels. If a channel
613 * is disabled, it contains a copy of the enabled channel's
614 * data. However, we only send the requested channels to
617 * Voltage values are encoded as a value 0-255 (0-512 on the
618 * DSO-5200*), where the value is a point in the range
619 * represented by the vdiv setting. There are 8 vertical divs,
620 * so e.g. 500mV/div represents 4V peak-to-peak where 0 = -2V
623 /* TODO: Support for DSO-5xxx series 9-bit samples. */
624 if (devc->ch1_enabled) {
625 range = ((float)vdivs[devc->voltage_ch1].p / vdivs[devc->voltage_ch1].q) * 8;
626 ch1 = range / 255 * *(buf + i * 2 + 1);
627 /* Value is centered around 0V. */
629 analog.data[data_offset++] = ch1;
631 if (devc->ch2_enabled) {
632 range = ((float)vdivs[devc->voltage_ch2].p / vdivs[devc->voltage_ch2].q) * 8;
633 ch2 = range / 255 * *(buf + i * 2);
635 analog.data[data_offset++] = ch2;
638 sr_session_send(devc->cb_data, &packet);
642 * Called by libusb (as triggered by handle_event()) when a transfer comes in.
643 * Only channel data comes in asynchronously, and all transfers for this are
644 * queued up beforehand, so this just needs to chuck the incoming data onto
645 * the libsigrok session bus.
647 static void receive_transfer(struct libusb_transfer *transfer)
649 struct sr_datafeed_packet packet;
650 struct dev_context *devc;
651 int num_samples, pre;
653 devc = transfer->user_data;
654 sr_dbg("receive_transfer(): status %d received %d bytes.",
655 transfer->status, transfer->actual_length);
657 if (transfer->actual_length == 0)
658 /* Nothing to send to the bus. */
661 num_samples = transfer->actual_length / 2;
663 sr_dbg("Got %d-%d/%d samples in frame.", devc->samp_received + 1,
664 devc->samp_received + num_samples, devc->framesize);
667 * The device always sends a full frame, but the beginning of the frame
668 * doesn't represent the trigger point. The offset at which the trigger
669 * happened came in with the capture state, so we need to start sending
670 * from there up the session bus. The samples in the frame buffer
671 * before that trigger point came after the end of the device's frame
672 * buffer was reached, and it wrapped around to overwrite up until the
675 if (devc->samp_received < devc->trigger_offset) {
676 /* Trigger point not yet reached. */
677 if (devc->samp_received + num_samples < devc->trigger_offset) {
678 /* The entire chunk is before the trigger point. */
679 memcpy(devc->framebuf + devc->samp_buffered * 2,
680 transfer->buffer, num_samples * 2);
681 devc->samp_buffered += num_samples;
684 * This chunk hits or overruns the trigger point.
685 * Store the part before the trigger fired, and
686 * send the rest up to the session bus.
688 pre = devc->trigger_offset - devc->samp_received;
689 memcpy(devc->framebuf + devc->samp_buffered * 2,
690 transfer->buffer, pre * 2);
691 devc->samp_buffered += pre;
693 /* The rest of this chunk starts with the trigger point. */
694 sr_dbg("Reached trigger point, %d samples buffered.",
695 devc->samp_buffered);
697 /* Avoid the corner case where the chunk ended at
698 * exactly the trigger point. */
699 if (num_samples > pre)
700 send_chunk(devc, transfer->buffer + pre * 2,
704 /* Already past the trigger point, just send it all out. */
705 send_chunk(devc, transfer->buffer,
709 devc->samp_received += num_samples;
711 /* Everything in this transfer was either copied to the buffer or
712 * sent to the session bus. */
713 g_free(transfer->buffer);
714 libusb_free_transfer(transfer);
716 if (devc->samp_received >= devc->framesize) {
717 /* That was the last chunk in this frame. Send the buffered
718 * pre-trigger samples out now, in one big chunk. */
719 sr_dbg("End of frame, sending %d pre-trigger buffered samples.",
720 devc->samp_buffered);
721 send_chunk(devc, devc->framebuf, devc->samp_buffered);
723 /* Mark the end of this frame. */
724 packet.type = SR_DF_FRAME_END;
725 sr_session_send(devc->cb_data, &packet);
727 if (devc->limit_frames && ++devc->num_frames == devc->limit_frames) {
728 /* Terminate session */
729 devc->dev_state = STOPPING;
731 devc->dev_state = NEW_CAPTURE;
736 static int handle_event(int fd, int revents, void *cb_data)
738 const struct sr_dev_inst *sdi;
739 struct sr_datafeed_packet packet;
741 struct dev_context *devc;
742 const struct libusb_pollfd **lupfd;
744 uint32_t trigger_offset;
745 uint8_t capturestate;
752 if (devc->dev_state == STOPPING) {
753 /* We've been told to wind up the acquisition. */
754 sr_dbg("Stopping acquisition.");
756 * TODO: Doesn't really cancel pending transfers so they might
757 * come in after SR_DF_END is sent.
759 lupfd = libusb_get_pollfds(NULL);
760 for (i = 0; lupfd[i]; i++)
761 sr_source_remove(lupfd[i]->fd);
764 packet.type = SR_DF_END;
765 sr_session_send(sdi, &packet);
767 devc->dev_state = IDLE;
772 /* Always handle pending libusb events. */
773 tv.tv_sec = tv.tv_usec = 0;
774 libusb_handle_events_timeout(NULL, &tv);
777 if (devc->dev_state == NEW_CAPTURE) {
778 if (dso_capture_start(devc) != SR_OK)
780 if (dso_enable_trigger(devc) != SR_OK)
782 // if (dso_force_trigger(devc) != SR_OK)
784 sr_dbg("Successfully requested next chunk.");
785 devc->dev_state = CAPTURE;
788 if (devc->dev_state != CAPTURE)
791 if ((dso_get_capturestate(devc, &capturestate, &trigger_offset)) != SR_OK)
794 sr_dbg("Capturestate %d.", capturestate);
795 sr_dbg("Trigger offset 0x%.6x.", trigger_offset);
796 switch (capturestate) {
798 if (++devc->capture_empty_count >= MAX_CAPTURE_EMPTY) {
799 devc->capture_empty_count = 0;
800 if (dso_capture_start(devc) != SR_OK)
802 if (dso_enable_trigger(devc) != SR_OK)
804 // if (dso_force_trigger(devc) != SR_OK)
806 sr_dbg("Successfully requested next chunk.");
809 case CAPTURE_FILLING:
812 case CAPTURE_READY_8BIT:
813 /* Remember where in the captured frame the trigger is. */
814 devc->trigger_offset = trigger_offset;
816 num_probes = (devc->ch1_enabled && devc->ch2_enabled) ? 2 : 1;
817 /* TODO: Check malloc return value. */
818 devc->framebuf = g_try_malloc(devc->framesize * num_probes * 2);
819 devc->samp_buffered = devc->samp_received = 0;
821 /* Tell the scope to send us the first frame. */
822 if (dso_get_channeldata(devc, receive_transfer) != SR_OK)
826 * Don't hit the state machine again until we're done fetching
827 * the data we just told the scope to send.
829 devc->dev_state = FETCH_DATA;
831 /* Tell the frontend a new frame is on the way. */
832 packet.type = SR_DF_FRAME_BEGIN;
833 sr_session_send(sdi, &packet);
835 case CAPTURE_READY_9BIT:
837 sr_err("Not yet supported.");
839 case CAPTURE_TIMEOUT:
840 /* Doesn't matter, we'll try again next time. */
843 sr_dbg("Unknown capture state: %d.", capturestate);
850 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
853 const struct libusb_pollfd **lupfd;
854 struct sr_datafeed_packet packet;
855 struct sr_datafeed_header header;
856 struct sr_datafeed_meta_analog meta;
857 struct dev_context *devc;
860 if (sdi->status != SR_ST_ACTIVE)
864 devc->cb_data = cb_data;
866 if (configure_probes(sdi) != SR_OK) {
867 sr_err("Failed to configure probes.");
871 if (dso_init(devc) != SR_OK)
874 if (dso_capture_start(devc) != SR_OK)
877 devc->dev_state = CAPTURE;
878 lupfd = libusb_get_pollfds(NULL);
879 for (i = 0; lupfd[i]; i++)
880 sr_source_add(lupfd[i]->fd, lupfd[i]->events, TICK,
881 handle_event, (void *)sdi);
884 /* Send header packet to the session bus. */
885 packet.type = SR_DF_HEADER;
886 packet.payload = (unsigned char *)&header;
887 header.feed_version = 1;
888 gettimeofday(&header.starttime, NULL);
889 sr_session_send(cb_data, &packet);
891 /* Send metadata about the SR_DF_ANALOG packets to come. */
892 packet.type = SR_DF_META_ANALOG;
893 packet.payload = &meta;
894 meta.num_probes = NUM_PROBES;
895 sr_session_send(cb_data, &packet);
900 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
902 struct dev_context *devc;
906 if (sdi->status != SR_ST_ACTIVE)
910 devc->dev_state = STOPPING;
915 SR_PRIV struct sr_dev_driver hantek_dso_driver_info = {
916 .name = "hantek-dso",
917 .longname = "Hantek DSO",
920 .cleanup = hw_cleanup,
922 .dev_list = hw_dev_list,
923 .dev_clear = clear_instances,
924 .dev_open = hw_dev_open,
925 .dev_close = hw_dev_close,
926 .info_get = hw_info_get,
927 .dev_config_set = hw_dev_config_set,
928 .dev_acquisition_start = hw_dev_acquisition_start,
929 .dev_acquisition_stop = hw_dev_acquisition_stop,