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[] = {
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 const struct sr_probe *probe;
210 devc->ch1_enabled = devc->ch2_enabled = FALSE;
211 for (l = sdi->probes; l; l = l->next) {
212 probe = (struct sr_probe *)l->data;
213 if (probe->index == 0)
214 devc->ch1_enabled = probe->enabled;
215 else if (probe->index == 1)
216 devc->ch2_enabled = probe->enabled;
222 /* Properly close and free all devices. */
223 static int clear_instances(void)
225 struct sr_dev_inst *sdi;
226 struct drv_context *drvc;
227 struct dev_context *devc;
231 for (l = drvc->instances; l; l = l->next) {
232 if (!(sdi = l->data)) {
233 /* Log error, but continue cleaning up the rest. */
234 sr_err("%s: sdi was NULL, continuing", __func__);
237 if (!(devc = sdi->priv)) {
238 /* Log error, but continue cleaning up the rest. */
239 sr_err("%s: sdi->priv was NULL, continuing", __func__);
243 sr_usb_dev_inst_free(devc->usb);
244 g_free(devc->triggersource);
246 sr_dev_inst_free(sdi);
249 g_slist_free(drvc->instances);
250 drvc->instances = NULL;
255 static int hw_init(struct sr_context *sr_ctx)
257 struct drv_context *drvc;
259 if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
260 sr_err("Driver context malloc failed.");
261 return SR_ERR_MALLOC;
264 drvc->sr_ctx = sr_ctx;
270 static GSList *hw_scan(GSList *options)
272 struct sr_dev_inst *sdi;
273 const struct dso_profile *prof;
274 struct drv_context *drvc;
275 struct dev_context *devc;
277 struct libusb_device_descriptor des;
278 libusb_device **devlist;
279 int devcnt, ret, i, j;
286 drvc->instances = NULL;
290 /* Find all Hantek DSO devices and upload firmware to all of them. */
291 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
292 for (i = 0; devlist[i]; i++) {
293 if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
294 sr_err("Failed to get device descriptor: %s.",
295 libusb_error_name(ret));
300 for (j = 0; dev_profiles[j].orig_vid; j++) {
301 if (des.idVendor == dev_profiles[j].orig_vid
302 && des.idProduct == dev_profiles[j].orig_pid) {
303 /* Device matches the pre-firmware profile. */
304 prof = &dev_profiles[j];
305 sr_dbg("Found a %s %s.", prof->vendor, prof->model);
306 sdi = dso_dev_new(devcnt, prof);
307 devices = g_slist_append(devices, sdi);
309 if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
310 prof->firmware) == SR_OK)
311 /* Remember when the firmware on this device was updated */
312 devc->fw_updated = g_get_monotonic_time();
314 sr_err("Firmware upload failed for "
315 "device %d.", devcnt);
316 /* Dummy USB address of 0xff will get overwritten later. */
317 devc->usb = sr_usb_dev_inst_new(
318 libusb_get_bus_number(devlist[i]), 0xff, NULL);
321 } else if (des.idVendor == dev_profiles[j].fw_vid
322 && des.idProduct == dev_profiles[j].fw_pid) {
323 /* Device matches the post-firmware profile. */
324 prof = &dev_profiles[j];
325 sr_dbg("Found a %s %s.", prof->vendor, prof->model);
326 sdi = dso_dev_new(devcnt, prof);
327 sdi->status = SR_ST_INACTIVE;
328 devices = g_slist_append(devices, sdi);
330 devc->usb = sr_usb_dev_inst_new(
331 libusb_get_bus_number(devlist[i]),
332 libusb_get_device_address(devlist[i]), NULL);
338 /* not a supported VID/PID */
341 libusb_free_device_list(devlist, 1);
346 static GSList *hw_dev_list(void)
348 struct drv_context *drvc;
352 return drvc->instances;
355 static int hw_dev_open(struct sr_dev_inst *sdi)
357 struct dev_context *devc;
358 int64_t timediff_us, timediff_ms;
364 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
365 * for the FX2 to renumerate.
368 if (devc->fw_updated > 0) {
369 sr_info("Waiting for device to reset.");
370 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
371 g_usleep(300 * 1000);
373 while (timediff_ms < MAX_RENUM_DELAY_MS) {
374 if ((err = dso_open(sdi)) == SR_OK)
376 g_usleep(100 * 1000);
377 timediff_us = g_get_monotonic_time() - devc->fw_updated;
378 timediff_ms = timediff_us / 1000;
379 sr_spew("Waited %" PRIi64 " ms.", timediff_ms);
381 sr_info("Device came back after %d ms.", timediff_ms);
387 sr_err("Unable to open device.");
391 err = libusb_claim_interface(devc->usb->devhdl, USB_INTERFACE);
393 sr_err("Unable to claim interface: %s.",
394 libusb_error_name(err));
401 static int hw_dev_close(struct sr_dev_inst *sdi)
408 static int hw_cleanup(void)
410 struct drv_context *drvc;
412 if (!(drvc = di->priv))
420 static int hw_info_get(int info_id, const void **data,
421 const struct sr_dev_inst *sdi)
431 case SR_DI_BUFFERSIZES:
434 case SR_DI_TIMEBASES:
437 case SR_DI_TRIGGER_SOURCES:
438 *data = trigger_sources;
441 *data = filter_targets;
449 /* TODO remove this */
450 case SR_DI_CUR_SAMPLERATE:
460 static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
463 struct dev_context *devc;
464 struct sr_rational tmp_rat;
470 if (sdi->status != SR_ST_ACTIVE)
476 case SR_HWCAP_LIMIT_FRAMES:
477 devc->limit_frames = *(const uint64_t *)value;
479 case SR_HWCAP_TRIGGER_SLOPE:
480 tmp_u64 = *(const int *)value;
481 if (tmp_u64 != SLOPE_NEGATIVE && tmp_u64 != SLOPE_POSITIVE)
483 devc->triggerslope = tmp_u64;
485 case SR_HWCAP_HORIZ_TRIGGERPOS:
486 tmp_float = *(const float *)value;
487 if (tmp_float < 0.0 || tmp_float > 1.0) {
488 sr_err("Trigger position should be between 0.0 and 1.0.");
491 devc->triggerposition = tmp_float;
493 case SR_HWCAP_BUFFERSIZE:
494 tmp_u64 = *(const int *)value;
495 for (i = 0; buffersizes[i]; i++) {
496 if (buffersizes[i] == tmp_u64) {
497 devc->framesize = tmp_u64;
501 if (buffersizes[i] == 0)
504 case SR_HWCAP_TIMEBASE:
505 tmp_rat = *(const struct sr_rational *)value;
506 for (i = 0; timebases[i].p && timebases[i].q; i++) {
507 if (timebases[i].p == tmp_rat.p
508 && timebases[i].q == tmp_rat.q) {
513 if (timebases[i].p == 0 && timebases[i].q == 0)
516 case SR_HWCAP_TRIGGER_SOURCE:
517 for (i = 0; trigger_sources[i]; i++) {
518 if (!strcmp(value, trigger_sources[i])) {
519 devc->triggersource = g_strdup(value);
523 if (trigger_sources[i] == 0)
526 case SR_HWCAP_FILTER:
527 devc->filter_ch1 = devc->filter_ch2 = devc->filter_trigger = 0;
528 targets = g_strsplit(value, ",", 0);
529 for (i = 0; targets[i]; i++) {
530 if (targets[i] == '\0')
531 /* Empty filter string can be used to clear them all. */
533 else if (!strcmp(targets[i], "CH1"))
534 devc->filter_ch1 = TRUE;
535 else if (!strcmp(targets[i], "CH2"))
536 devc->filter_ch2 = TRUE;
537 else if (!strcmp(targets[i], "TRIGGER"))
538 devc->filter_trigger = TRUE;
540 sr_err("Invalid filter target %s.", targets[i]);
547 /* TODO: Not supporting vdiv per channel yet. */
548 tmp_rat = *(const struct sr_rational *)value;
549 for (i = 0; vdivs[i].p && vdivs[i].q; i++) {
550 if (vdivs[i].p == tmp_rat.p
551 && vdivs[i].q == tmp_rat.q) {
552 devc->voltage_ch1 = i;
553 devc->voltage_ch2 = i;
557 if (vdivs[i].p == 0 && vdivs[i].q == 0)
560 case SR_HWCAP_COUPLING:
561 /* TODO: Not supporting coupling per channel yet. */
562 for (i = 0; coupling[i]; i++) {
563 if (!strcmp(value, coupling[i])) {
564 devc->coupling_ch1 = i;
565 devc->coupling_ch2 = i;
569 if (coupling[i] == 0)
580 static void send_chunk(struct dev_context *devc, unsigned char *buf,
583 struct sr_datafeed_packet packet;
584 struct sr_datafeed_analog analog;
585 float ch1, ch2, range;
586 int num_probes, data_offset, i;
588 num_probes = (devc->ch1_enabled && devc->ch2_enabled) ? 2 : 1;
589 packet.type = SR_DF_ANALOG;
590 packet.payload = &analog;
591 /* TODO: support for 5xxx series 9-bit samples */
592 analog.num_samples = num_samples;
593 analog.mq = SR_MQ_VOLTAGE;
594 analog.unit = SR_UNIT_VOLT;
595 /* TODO: Check malloc return value. */
596 analog.data = g_try_malloc(analog.num_samples * sizeof(float) * num_probes);
598 for (i = 0; i < analog.num_samples; i++) {
600 * The device always sends data for both channels. If a channel
601 * is disabled, it contains a copy of the enabled channel's
602 * data. However, we only send the requested channels to
605 * Voltage values are encoded as a value 0-255 (0-512 on the
606 * DSO-5200*), where the value is a point in the range
607 * represented by the vdiv setting. There are 8 vertical divs,
608 * so e.g. 500mV/div represents 4V peak-to-peak where 0 = -2V
611 /* TODO: Support for DSO-5xxx series 9-bit samples. */
612 if (devc->ch1_enabled) {
613 range = ((float)vdivs[devc->voltage_ch1].p / vdivs[devc->voltage_ch1].q) * 8;
614 ch1 = range / 255 * *(buf + i * 2 + 1);
615 /* Value is centered around 0V. */
617 analog.data[data_offset++] = ch1;
619 if (devc->ch2_enabled) {
620 range = ((float)vdivs[devc->voltage_ch2].p / vdivs[devc->voltage_ch2].q) * 8;
621 ch2 = range / 255 * *(buf + i * 2);
623 analog.data[data_offset++] = ch2;
626 sr_session_send(devc->cb_data, &packet);
630 * Called by libusb (as triggered by handle_event()) when a transfer comes in.
631 * Only channel data comes in asynchronously, and all transfers for this are
632 * queued up beforehand, so this just needs to chuck the incoming data onto
633 * the libsigrok session bus.
635 static void receive_transfer(struct libusb_transfer *transfer)
637 struct sr_datafeed_packet packet;
638 struct dev_context *devc;
639 int num_samples, pre;
641 devc = transfer->user_data;
642 sr_dbg("receive_transfer(): status %d received %d bytes.",
643 transfer->status, transfer->actual_length);
645 if (transfer->actual_length == 0)
646 /* Nothing to send to the bus. */
649 num_samples = transfer->actual_length / 2;
651 sr_dbg("Got %d-%d/%d samples in frame.", devc->samp_received + 1,
652 devc->samp_received + num_samples, devc->framesize);
655 * The device always sends a full frame, but the beginning of the frame
656 * doesn't represent the trigger point. The offset at which the trigger
657 * happened came in with the capture state, so we need to start sending
658 * from there up the session bus. The samples in the frame buffer
659 * before that trigger point came after the end of the device's frame
660 * buffer was reached, and it wrapped around to overwrite up until the
663 if (devc->samp_received < devc->trigger_offset) {
664 /* Trigger point not yet reached. */
665 if (devc->samp_received + num_samples < devc->trigger_offset) {
666 /* The entire chunk is before the trigger point. */
667 memcpy(devc->framebuf + devc->samp_buffered * 2,
668 transfer->buffer, num_samples * 2);
669 devc->samp_buffered += num_samples;
672 * This chunk hits or overruns the trigger point.
673 * Store the part before the trigger fired, and
674 * send the rest up to the session bus.
676 pre = devc->trigger_offset - devc->samp_received;
677 memcpy(devc->framebuf + devc->samp_buffered * 2,
678 transfer->buffer, pre * 2);
679 devc->samp_buffered += pre;
681 /* The rest of this chunk starts with the trigger point. */
682 sr_dbg("Reached trigger point, %d samples buffered.",
683 devc->samp_buffered);
685 /* Avoid the corner case where the chunk ended at
686 * exactly the trigger point. */
687 if (num_samples > pre)
688 send_chunk(devc, transfer->buffer + pre * 2,
692 /* Already past the trigger point, just send it all out. */
693 send_chunk(devc, transfer->buffer,
697 devc->samp_received += num_samples;
699 /* Everything in this transfer was either copied to the buffer or
700 * sent to the session bus. */
701 g_free(transfer->buffer);
702 libusb_free_transfer(transfer);
704 if (devc->samp_received >= devc->framesize) {
705 /* That was the last chunk in this frame. Send the buffered
706 * pre-trigger samples out now, in one big chunk. */
707 sr_dbg("End of frame, sending %d pre-trigger buffered samples.",
708 devc->samp_buffered);
709 send_chunk(devc, devc->framebuf, devc->samp_buffered);
711 /* Mark the end of this frame. */
712 packet.type = SR_DF_FRAME_END;
713 sr_session_send(devc->cb_data, &packet);
715 if (devc->limit_frames && ++devc->num_frames == devc->limit_frames) {
716 /* Terminate session */
717 devc->dev_state = STOPPING;
719 devc->dev_state = NEW_CAPTURE;
724 static int handle_event(int fd, int revents, void *cb_data)
726 const struct sr_dev_inst *sdi;
727 struct sr_datafeed_packet packet;
729 struct dev_context *devc;
730 struct drv_context *drvc = di->priv;
731 const struct libusb_pollfd **lupfd;
733 uint32_t trigger_offset;
734 uint8_t capturestate;
741 if (devc->dev_state == STOPPING) {
742 /* We've been told to wind up the acquisition. */
743 sr_dbg("Stopping acquisition.");
745 * TODO: Doesn't really cancel pending transfers so they might
746 * come in after SR_DF_END is sent.
748 lupfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
749 for (i = 0; lupfd[i]; i++)
750 sr_source_remove(lupfd[i]->fd);
753 packet.type = SR_DF_END;
754 sr_session_send(sdi, &packet);
756 devc->dev_state = IDLE;
761 /* Always handle pending libusb events. */
762 tv.tv_sec = tv.tv_usec = 0;
763 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
766 if (devc->dev_state == NEW_CAPTURE) {
767 if (dso_capture_start(devc) != SR_OK)
769 if (dso_enable_trigger(devc) != SR_OK)
771 // if (dso_force_trigger(devc) != SR_OK)
773 sr_dbg("Successfully requested next chunk.");
774 devc->dev_state = CAPTURE;
777 if (devc->dev_state != CAPTURE)
780 if ((dso_get_capturestate(devc, &capturestate, &trigger_offset)) != SR_OK)
783 sr_dbg("Capturestate %d.", capturestate);
784 sr_dbg("Trigger offset 0x%.6x.", trigger_offset);
785 switch (capturestate) {
787 if (++devc->capture_empty_count >= MAX_CAPTURE_EMPTY) {
788 devc->capture_empty_count = 0;
789 if (dso_capture_start(devc) != SR_OK)
791 if (dso_enable_trigger(devc) != SR_OK)
793 // if (dso_force_trigger(devc) != SR_OK)
795 sr_dbg("Successfully requested next chunk.");
798 case CAPTURE_FILLING:
801 case CAPTURE_READY_8BIT:
802 /* Remember where in the captured frame the trigger is. */
803 devc->trigger_offset = trigger_offset;
805 num_probes = (devc->ch1_enabled && devc->ch2_enabled) ? 2 : 1;
806 /* TODO: Check malloc return value. */
807 devc->framebuf = g_try_malloc(devc->framesize * num_probes * 2);
808 devc->samp_buffered = devc->samp_received = 0;
810 /* Tell the scope to send us the first frame. */
811 if (dso_get_channeldata(devc, receive_transfer) != SR_OK)
815 * Don't hit the state machine again until we're done fetching
816 * the data we just told the scope to send.
818 devc->dev_state = FETCH_DATA;
820 /* Tell the frontend a new frame is on the way. */
821 packet.type = SR_DF_FRAME_BEGIN;
822 sr_session_send(sdi, &packet);
824 case CAPTURE_READY_9BIT:
826 sr_err("Not yet supported.");
828 case CAPTURE_TIMEOUT:
829 /* Doesn't matter, we'll try again next time. */
832 sr_dbg("Unknown capture state: %d.", capturestate);
839 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
842 const struct libusb_pollfd **lupfd;
843 struct sr_datafeed_packet packet;
844 struct sr_datafeed_header header;
845 struct sr_datafeed_meta_analog meta;
846 struct dev_context *devc;
847 struct drv_context *drvc = di->priv;
850 if (sdi->status != SR_ST_ACTIVE)
854 devc->cb_data = cb_data;
856 if (configure_probes(sdi) != SR_OK) {
857 sr_err("Failed to configure probes.");
861 if (dso_init(devc) != SR_OK)
864 if (dso_capture_start(devc) != SR_OK)
867 devc->dev_state = CAPTURE;
868 lupfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
869 for (i = 0; lupfd[i]; i++)
870 sr_source_add(lupfd[i]->fd, lupfd[i]->events, TICK,
871 handle_event, (void *)sdi);
874 /* Send header packet to the session bus. */
875 packet.type = SR_DF_HEADER;
876 packet.payload = (unsigned char *)&header;
877 header.feed_version = 1;
878 gettimeofday(&header.starttime, NULL);
879 sr_session_send(cb_data, &packet);
881 /* Send metadata about the SR_DF_ANALOG packets to come. */
882 packet.type = SR_DF_META_ANALOG;
883 packet.payload = &meta;
884 meta.num_probes = NUM_PROBES;
885 sr_session_send(cb_data, &packet);
890 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
892 struct dev_context *devc;
896 if (sdi->status != SR_ST_ACTIVE)
900 devc->dev_state = STOPPING;
905 SR_PRIV struct sr_dev_driver hantek_dso_driver_info = {
906 .name = "hantek-dso",
907 .longname = "Hantek DSO",
910 .cleanup = hw_cleanup,
912 .dev_list = hw_dev_list,
913 .dev_clear = clear_instances,
914 .dev_open = hw_dev_open,
915 .dev_close = hw_dev_close,
916 .info_get = hw_info_get,
917 .dev_config_set = hw_dev_config_set,
918 .dev_acquisition_start = hw_dev_acquisition_start,
919 .dev_acquisition_stop = hw_dev_acquisition_stop,