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 int32_t devopts[] = {
46 SR_CONF_TRIGGER_SOURCE,
47 SR_CONF_TRIGGER_SLOPE,
48 SR_CONF_HORIZ_TRIGGERPOS,
54 static const char *probe_names[] = {
59 static const struct dso_profile dev_profiles[] = {
60 { 0x04b4, 0x2090, 0x04b5, 0x2090,
62 FIRMWARE_DIR "/hantek-dso-2090.fw" },
63 { 0x04b4, 0x2150, 0x04b5, 0x2150,
65 FIRMWARE_DIR "/hantek-dso-2150.fw" },
66 { 0x04b4, 0x2250, 0x04b5, 0x2250,
68 FIRMWARE_DIR "/hantek-dso-2250.fw" },
69 { 0x04b4, 0x5200, 0x04b5, 0x5200,
71 FIRMWARE_DIR "/hantek-dso-5200.fw" },
72 { 0x04b4, 0x520a, 0x04b5, 0x520a,
73 "Hantek", "DSO-5200A",
74 FIRMWARE_DIR "/hantek-dso-5200A.fw" },
75 { 0, 0, 0, 0, 0, 0, 0 },
78 static const uint64_t buffersizes[] = {
84 static const int32_t timebases[][2] = {
104 static const int32_t vdivs[][2] = {
118 static const char *trigger_sources[] = {
125 static const char *filter_targets[] = {
128 /* TODO: "TRIGGER", */
131 static const char *coupling[] = {
137 SR_PRIV struct sr_dev_driver hantek_dso_driver_info;
138 static struct sr_dev_driver *di = &hantek_dso_driver_info;
140 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data);
142 static struct sr_dev_inst *dso_dev_new(int index, const struct dso_profile *prof)
144 struct sr_dev_inst *sdi;
145 struct sr_probe *probe;
146 struct drv_context *drvc;
147 struct dev_context *devc;
150 sdi = sr_dev_inst_new(index, SR_ST_INITIALIZING,
151 prof->vendor, prof->model, NULL);
157 * Add only the real probes -- EXT isn't a source of data, only
158 * a trigger source internal to the device.
160 for (i = 0; probe_names[i]; i++) {
161 if (!(probe = sr_probe_new(i, SR_PROBE_ANALOG, TRUE,
164 sdi->probes = g_slist_append(sdi->probes, probe);
167 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
168 sr_err("Device context malloc failed.");
172 devc->profile = prof;
173 devc->dev_state = IDLE;
174 devc->timebase = DEFAULT_TIMEBASE;
175 devc->ch1_enabled = TRUE;
176 devc->ch2_enabled = TRUE;
177 devc->voltage_ch1 = DEFAULT_VOLTAGE;
178 devc->voltage_ch2 = DEFAULT_VOLTAGE;
179 devc->coupling_ch1 = DEFAULT_COUPLING;
180 devc->coupling_ch2 = DEFAULT_COUPLING;
181 devc->voffset_ch1 = DEFAULT_VERT_OFFSET;
182 devc->voffset_ch2 = DEFAULT_VERT_OFFSET;
183 devc->voffset_trigger = DEFAULT_VERT_TRIGGERPOS;
184 devc->framesize = DEFAULT_FRAMESIZE;
185 devc->triggerslope = SLOPE_POSITIVE;
186 devc->triggersource = g_strdup(DEFAULT_TRIGGER_SOURCE);
187 devc->triggerposition = DEFAULT_HORIZ_TRIGGERPOS;
190 drvc->instances = g_slist_append(drvc->instances, sdi);
195 static int configure_probes(const struct sr_dev_inst *sdi)
197 struct dev_context *devc;
198 struct sr_probe *probe;
204 g_slist_free(devc->enabled_probes);
205 devc->ch1_enabled = devc->ch2_enabled = FALSE;
206 for (l = sdi->probes, p = 0; l; l = l->next, p++) {
209 devc->ch1_enabled = probe->enabled;
211 devc->ch2_enabled = probe->enabled;
213 devc->enabled_probes = g_slist_append(devc->enabled_probes, probe);
219 /* Properly close and free all devices. */
220 static int clear_instances(void)
222 struct sr_dev_inst *sdi;
223 struct drv_context *drvc;
224 struct dev_context *devc;
228 for (l = drvc->instances; l; l = l->next) {
229 if (!(sdi = l->data)) {
230 /* Log error, but continue cleaning up the rest. */
231 sr_err("%s: sdi was NULL, continuing", __func__);
234 if (!(devc = sdi->priv)) {
235 /* Log error, but continue cleaning up the rest. */
236 sr_err("%s: sdi->priv was NULL, continuing", __func__);
240 sr_usb_dev_inst_free(devc->usb);
241 g_free(devc->triggersource);
242 g_slist_free(devc->enabled_probes);
244 sr_dev_inst_free(sdi);
247 g_slist_free(drvc->instances);
248 drvc->instances = NULL;
253 static int hw_init(struct sr_context *sr_ctx)
255 return std_hw_init(sr_ctx, di, DRIVER_LOG_DOMAIN);
258 static GSList *hw_scan(GSList *options)
260 struct sr_dev_inst *sdi;
261 const struct dso_profile *prof;
262 struct drv_context *drvc;
263 struct dev_context *devc;
265 struct libusb_device_descriptor des;
266 libusb_device **devlist;
267 int devcnt, ret, i, j;
272 drvc->instances = NULL;
279 /* Find all Hantek DSO devices and upload firmware to all of them. */
280 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
281 for (i = 0; devlist[i]; i++) {
282 if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
283 sr_err("Failed to get device descriptor: %s.",
284 libusb_error_name(ret));
289 for (j = 0; dev_profiles[j].orig_vid; j++) {
290 if (des.idVendor == dev_profiles[j].orig_vid
291 && des.idProduct == dev_profiles[j].orig_pid) {
292 /* Device matches the pre-firmware profile. */
293 prof = &dev_profiles[j];
294 sr_dbg("Found a %s %s.", prof->vendor, prof->model);
295 sdi = dso_dev_new(devcnt, prof);
296 devices = g_slist_append(devices, sdi);
298 if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
299 prof->firmware) == SR_OK)
300 /* Remember when the firmware on this device was updated */
301 devc->fw_updated = g_get_monotonic_time();
303 sr_err("Firmware upload failed for "
304 "device %d.", devcnt);
305 /* Dummy USB address of 0xff will get overwritten later. */
306 devc->usb = sr_usb_dev_inst_new(
307 libusb_get_bus_number(devlist[i]), 0xff, NULL);
310 } else if (des.idVendor == dev_profiles[j].fw_vid
311 && des.idProduct == dev_profiles[j].fw_pid) {
312 /* Device matches the post-firmware profile. */
313 prof = &dev_profiles[j];
314 sr_dbg("Found a %s %s.", prof->vendor, prof->model);
315 sdi = dso_dev_new(devcnt, prof);
316 sdi->status = SR_ST_INACTIVE;
317 devices = g_slist_append(devices, sdi);
319 devc->usb = sr_usb_dev_inst_new(
320 libusb_get_bus_number(devlist[i]),
321 libusb_get_device_address(devlist[i]), NULL);
327 /* not a supported VID/PID */
330 libusb_free_device_list(devlist, 1);
335 static GSList *hw_dev_list(void)
337 return ((struct drv_context *)(di->priv))->instances;
340 static int hw_dev_open(struct sr_dev_inst *sdi)
342 struct dev_context *devc;
343 int64_t timediff_us, timediff_ms;
349 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
350 * for the FX2 to renumerate.
353 if (devc->fw_updated > 0) {
354 sr_info("Waiting for device to reset.");
355 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
356 g_usleep(300 * 1000);
358 while (timediff_ms < MAX_RENUM_DELAY_MS) {
359 if ((err = dso_open(sdi)) == SR_OK)
361 g_usleep(100 * 1000);
362 timediff_us = g_get_monotonic_time() - devc->fw_updated;
363 timediff_ms = timediff_us / 1000;
364 sr_spew("Waited %" PRIi64 " ms.", timediff_ms);
366 sr_info("Device came back after %d ms.", timediff_ms);
372 sr_err("Unable to open device.");
376 err = libusb_claim_interface(devc->usb->devhdl, USB_INTERFACE);
378 sr_err("Unable to claim interface: %s.",
379 libusb_error_name(err));
386 static int hw_dev_close(struct sr_dev_inst *sdi)
393 static int hw_cleanup(void)
395 struct drv_context *drvc;
397 if (!(drvc = di->priv))
405 static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi)
407 struct dev_context *devc;
416 if (sdi->status != SR_ST_ACTIVE)
422 case SR_CONF_LIMIT_FRAMES:
423 devc->limit_frames = g_variant_get_uint64(data);
425 case SR_CONF_TRIGGER_SLOPE:
426 tmp_u64 = g_variant_get_uint64(data);
427 if (tmp_u64 != SLOPE_NEGATIVE && tmp_u64 != SLOPE_POSITIVE)
429 devc->triggerslope = tmp_u64;
431 case SR_CONF_HORIZ_TRIGGERPOS:
432 tmp_double = g_variant_get_double(data);
433 if (tmp_double < 0.0 || tmp_double > 1.0) {
434 sr_err("Trigger position should be between 0.0 and 1.0.");
437 devc->triggerposition = tmp_double;
439 case SR_CONF_BUFFERSIZE:
440 tmp_u64 = g_variant_get_uint64(data);
441 for (i = 0; buffersizes[i]; i++) {
442 if (buffersizes[i] == tmp_u64) {
443 devc->framesize = tmp_u64;
447 if (buffersizes[i] == 0)
450 case SR_CONF_TIMEBASE:
451 g_variant_get(data, "(ii)", &p, &q);
453 for (i = 0; i < ARRAY_SIZE(timebases); i++) {
454 if (timebases[i][0] == p && timebases[i][1] == q) {
460 devc->timebase = tmp_int;
464 case SR_CONF_TRIGGER_SOURCE:
465 tmp_str = g_variant_get_string(data, NULL);
466 for (i = 0; trigger_sources[i]; i++) {
467 if (!strcmp(tmp_str, trigger_sources[i])) {
468 devc->triggersource = g_strdup(tmp_str);
472 if (trigger_sources[i] == 0)
476 tmp_str = g_variant_get_string(data, NULL);
477 devc->filter_ch1 = devc->filter_ch2 = devc->filter_trigger = 0;
478 targets = g_strsplit(tmp_str, ",", 0);
479 for (i = 0; targets[i]; i++) {
480 if (targets[i] == '\0')
481 /* Empty filter string can be used to clear them all. */
483 else if (!strcmp(targets[i], "CH1"))
484 devc->filter_ch1 = TRUE;
485 else if (!strcmp(targets[i], "CH2"))
486 devc->filter_ch2 = TRUE;
487 else if (!strcmp(targets[i], "TRIGGER"))
488 devc->filter_trigger = TRUE;
490 sr_err("Invalid filter target %s.", targets[i]);
497 /* TODO: Not supporting vdiv per channel yet. */
498 g_variant_get(data, "(ii)", &p, &q);
500 for (i = 0; i < ARRAY_SIZE(vdivs); i++) {
501 if (vdivs[i][0] == p && vdivs[i][1] == q) {
507 devc->voltage_ch1 = tmp_int;
508 devc->voltage_ch2 = tmp_int;
512 case SR_CONF_COUPLING:
513 tmp_str = g_variant_get_string(data, NULL);
514 /* TODO: Not supporting coupling per channel yet. */
515 for (i = 0; coupling[i]; i++) {
516 if (!strcmp(tmp_str, coupling[i])) {
517 devc->coupling_ch1 = i;
518 devc->coupling_ch2 = i;
522 if (coupling[i] == 0)
533 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
539 case SR_CONF_DEVICE_OPTIONS:
540 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
541 devopts, ARRAY_SIZE(devopts), sizeof(int32_t));
543 case SR_CONF_BUFFERSIZE:
544 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT64,
545 buffersizes, ARRAY_SIZE(buffersizes), sizeof(uint64_t));
547 case SR_CONF_COUPLING:
548 *data = g_variant_new_strv(coupling, ARRAY_SIZE(coupling));
551 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
552 vdivs, ARRAY_SIZE(vdivs) * 2, sizeof(int32_t));
555 *data = g_variant_new_strv(filter_targets,
556 ARRAY_SIZE(filter_targets));
558 case SR_CONF_TIMEBASE:
559 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
560 timebases, ARRAY_SIZE(timebases) * 2, sizeof(int32_t));
562 case SR_CONF_TRIGGER_SOURCE:
563 *data = g_variant_new_strv(trigger_sources,
564 ARRAY_SIZE(trigger_sources));
573 static void send_chunk(struct sr_dev_inst *sdi, unsigned char *buf,
576 struct sr_datafeed_packet packet;
577 struct sr_datafeed_analog analog;
578 struct dev_context *devc;
579 float ch1, ch2, range;
580 int num_probes, data_offset, i;
583 num_probes = (devc->ch1_enabled && devc->ch2_enabled) ? 2 : 1;
584 packet.type = SR_DF_ANALOG;
585 packet.payload = &analog;
586 /* TODO: support for 5xxx series 9-bit samples */
587 analog.probes = devc->enabled_probes;
588 analog.num_samples = num_samples;
589 analog.mq = SR_MQ_VOLTAGE;
590 analog.unit = SR_UNIT_VOLT;
591 /* TODO: Check malloc return value. */
592 analog.data = g_try_malloc(analog.num_samples * sizeof(float) * num_probes);
594 for (i = 0; i < analog.num_samples; i++) {
596 * The device always sends data for both channels. If a channel
597 * is disabled, it contains a copy of the enabled channel's
598 * data. However, we only send the requested channels to
601 * Voltage values are encoded as a value 0-255 (0-512 on the
602 * DSO-5200*), where the value is a point in the range
603 * represented by the vdiv setting. There are 8 vertical divs,
604 * so e.g. 500mV/div represents 4V peak-to-peak where 0 = -2V
607 /* TODO: Support for DSO-5xxx series 9-bit samples. */
608 if (devc->ch1_enabled) {
609 range = ((float)vdivs[devc->voltage_ch1][0] / vdivs[devc->voltage_ch1][1]) * 8;
610 ch1 = range / 255 * *(buf + i * 2 + 1);
611 /* Value is centered around 0V. */
613 analog.data[data_offset++] = ch1;
615 if (devc->ch2_enabled) {
616 range = ((float)vdivs[devc->voltage_ch2][0] / vdivs[devc->voltage_ch2][1]) * 8;
617 ch2 = range / 255 * *(buf + i * 2);
619 analog.data[data_offset++] = ch2;
622 sr_session_send(devc->cb_data, &packet);
626 * Called by libusb (as triggered by handle_event()) when a transfer comes in.
627 * Only channel data comes in asynchronously, and all transfers for this are
628 * queued up beforehand, so this just needs to chuck the incoming data onto
629 * the libsigrok session bus.
631 static void receive_transfer(struct libusb_transfer *transfer)
633 struct sr_datafeed_packet packet;
634 struct sr_dev_inst *sdi;
635 struct dev_context *devc;
636 int num_samples, pre;
638 sdi = transfer->user_data;
640 sr_dbg("receive_transfer(): status %d received %d bytes.",
641 transfer->status, transfer->actual_length);
643 if (transfer->actual_length == 0)
644 /* Nothing to send to the bus. */
647 num_samples = transfer->actual_length / 2;
649 sr_dbg("Got %d-%d/%d samples in frame.", devc->samp_received + 1,
650 devc->samp_received + num_samples, devc->framesize);
653 * The device always sends a full frame, but the beginning of the frame
654 * doesn't represent the trigger point. The offset at which the trigger
655 * happened came in with the capture state, so we need to start sending
656 * from there up the session bus. The samples in the frame buffer
657 * before that trigger point came after the end of the device's frame
658 * buffer was reached, and it wrapped around to overwrite up until the
661 if (devc->samp_received < devc->trigger_offset) {
662 /* Trigger point not yet reached. */
663 if (devc->samp_received + num_samples < devc->trigger_offset) {
664 /* The entire chunk is before the trigger point. */
665 memcpy(devc->framebuf + devc->samp_buffered * 2,
666 transfer->buffer, num_samples * 2);
667 devc->samp_buffered += num_samples;
670 * This chunk hits or overruns the trigger point.
671 * Store the part before the trigger fired, and
672 * send the rest up to the session bus.
674 pre = devc->trigger_offset - devc->samp_received;
675 memcpy(devc->framebuf + devc->samp_buffered * 2,
676 transfer->buffer, pre * 2);
677 devc->samp_buffered += pre;
679 /* The rest of this chunk starts with the trigger point. */
680 sr_dbg("Reached trigger point, %d samples buffered.",
681 devc->samp_buffered);
683 /* Avoid the corner case where the chunk ended at
684 * exactly the trigger point. */
685 if (num_samples > pre)
686 send_chunk(sdi, transfer->buffer + pre * 2,
690 /* Already past the trigger point, just send it all out. */
691 send_chunk(sdi, transfer->buffer,
695 devc->samp_received += num_samples;
697 /* Everything in this transfer was either copied to the buffer or
698 * sent to the session bus. */
699 g_free(transfer->buffer);
700 libusb_free_transfer(transfer);
702 if (devc->samp_received >= devc->framesize) {
703 /* That was the last chunk in this frame. Send the buffered
704 * pre-trigger samples out now, in one big chunk. */
705 sr_dbg("End of frame, sending %d pre-trigger buffered samples.",
706 devc->samp_buffered);
707 send_chunk(sdi, devc->framebuf, devc->samp_buffered);
709 /* Mark the end of this frame. */
710 packet.type = SR_DF_FRAME_END;
711 sr_session_send(devc->cb_data, &packet);
713 if (devc->limit_frames && ++devc->num_frames == devc->limit_frames) {
714 /* Terminate session */
715 devc->dev_state = STOPPING;
717 devc->dev_state = NEW_CAPTURE;
722 static int handle_event(int fd, int revents, void *cb_data)
724 const struct sr_dev_inst *sdi;
725 struct sr_datafeed_packet packet;
727 struct dev_context *devc;
728 struct drv_context *drvc = di->priv;
729 const struct libusb_pollfd **lupfd;
731 uint32_t trigger_offset;
732 uint8_t capturestate;
739 if (devc->dev_state == STOPPING) {
740 /* We've been told to wind up the acquisition. */
741 sr_dbg("Stopping acquisition.");
743 * TODO: Doesn't really cancel pending transfers so they might
744 * come in after SR_DF_END is sent.
746 lupfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
747 for (i = 0; lupfd[i]; i++)
748 sr_source_remove(lupfd[i]->fd);
751 packet.type = SR_DF_END;
752 sr_session_send(sdi, &packet);
754 devc->dev_state = IDLE;
759 /* Always handle pending libusb events. */
760 tv.tv_sec = tv.tv_usec = 0;
761 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
764 if (devc->dev_state == NEW_CAPTURE) {
765 if (dso_capture_start(devc) != SR_OK)
767 if (dso_enable_trigger(devc) != SR_OK)
769 // if (dso_force_trigger(devc) != SR_OK)
771 sr_dbg("Successfully requested next chunk.");
772 devc->dev_state = CAPTURE;
775 if (devc->dev_state != CAPTURE)
778 if ((dso_get_capturestate(devc, &capturestate, &trigger_offset)) != SR_OK)
781 sr_dbg("Capturestate %d.", capturestate);
782 sr_dbg("Trigger offset 0x%.6x.", trigger_offset);
783 switch (capturestate) {
785 if (++devc->capture_empty_count >= MAX_CAPTURE_EMPTY) {
786 devc->capture_empty_count = 0;
787 if (dso_capture_start(devc) != SR_OK)
789 if (dso_enable_trigger(devc) != SR_OK)
791 // if (dso_force_trigger(devc) != SR_OK)
793 sr_dbg("Successfully requested next chunk.");
796 case CAPTURE_FILLING:
799 case CAPTURE_READY_8BIT:
800 /* Remember where in the captured frame the trigger is. */
801 devc->trigger_offset = trigger_offset;
803 num_probes = (devc->ch1_enabled && devc->ch2_enabled) ? 2 : 1;
804 /* TODO: Check malloc return value. */
805 devc->framebuf = g_try_malloc(devc->framesize * num_probes * 2);
806 devc->samp_buffered = devc->samp_received = 0;
808 /* Tell the scope to send us the first frame. */
809 if (dso_get_channeldata(sdi, receive_transfer) != SR_OK)
813 * Don't hit the state machine again until we're done fetching
814 * the data we just told the scope to send.
816 devc->dev_state = FETCH_DATA;
818 /* Tell the frontend a new frame is on the way. */
819 packet.type = SR_DF_FRAME_BEGIN;
820 sr_session_send(sdi, &packet);
822 case CAPTURE_READY_9BIT:
824 sr_err("Not yet supported.");
826 case CAPTURE_TIMEOUT:
827 /* Doesn't matter, we'll try again next time. */
830 sr_dbg("Unknown capture state: %d.", capturestate);
837 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
840 const struct libusb_pollfd **lupfd;
841 struct dev_context *devc;
842 struct drv_context *drvc = di->priv;
845 if (sdi->status != SR_ST_ACTIVE)
849 devc->cb_data = cb_data;
851 if (configure_probes(sdi) != SR_OK) {
852 sr_err("Failed to configure probes.");
856 if (dso_init(devc) != SR_OK)
859 if (dso_capture_start(devc) != SR_OK)
862 devc->dev_state = CAPTURE;
863 lupfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
864 for (i = 0; lupfd[i]; i++)
865 sr_source_add(lupfd[i]->fd, lupfd[i]->events, TICK,
866 handle_event, (void *)sdi);
869 /* Send header packet to the session bus. */
870 std_session_send_df_header(cb_data, DRIVER_LOG_DOMAIN);
875 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
877 struct dev_context *devc;
881 if (sdi->status != SR_ST_ACTIVE)
885 devc->dev_state = STOPPING;
890 SR_PRIV struct sr_dev_driver hantek_dso_driver_info = {
891 .name = "hantek-dso",
892 .longname = "Hantek DSO",
895 .cleanup = hw_cleanup,
897 .dev_list = hw_dev_list,
898 .dev_clear = clear_instances,
900 .config_set = config_set,
901 .config_list = config_list,
902 .dev_open = hw_dev_open,
903 .dev_close = hw_dev_close,
904 .dev_acquisition_start = hw_dev_acquisition_start,
905 .dev_acquisition_stop = hw_dev_acquisition_stop,