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 devopts[] = {
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 return std_hw_init(sr_ctx, di, DRIVER_LOG_DOMAIN);
265 static GSList *hw_scan(GSList *options)
267 struct sr_dev_inst *sdi;
268 const struct dso_profile *prof;
269 struct drv_context *drvc;
270 struct dev_context *devc;
272 struct libusb_device_descriptor des;
273 libusb_device **devlist;
274 int devcnt, ret, i, j;
279 drvc->instances = NULL;
286 /* Find all Hantek DSO devices and upload firmware to all of them. */
287 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
288 for (i = 0; devlist[i]; i++) {
289 if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
290 sr_err("Failed to get device descriptor: %s.",
291 libusb_error_name(ret));
296 for (j = 0; dev_profiles[j].orig_vid; j++) {
297 if (des.idVendor == dev_profiles[j].orig_vid
298 && des.idProduct == dev_profiles[j].orig_pid) {
299 /* Device matches the pre-firmware profile. */
300 prof = &dev_profiles[j];
301 sr_dbg("Found a %s %s.", prof->vendor, prof->model);
302 sdi = dso_dev_new(devcnt, prof);
303 devices = g_slist_append(devices, sdi);
305 if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
306 prof->firmware) == SR_OK)
307 /* Remember when the firmware on this device was updated */
308 devc->fw_updated = g_get_monotonic_time();
310 sr_err("Firmware upload failed for "
311 "device %d.", devcnt);
312 /* Dummy USB address of 0xff will get overwritten later. */
313 devc->usb = sr_usb_dev_inst_new(
314 libusb_get_bus_number(devlist[i]), 0xff, NULL);
317 } else if (des.idVendor == dev_profiles[j].fw_vid
318 && des.idProduct == dev_profiles[j].fw_pid) {
319 /* Device matches the post-firmware profile. */
320 prof = &dev_profiles[j];
321 sr_dbg("Found a %s %s.", prof->vendor, prof->model);
322 sdi = dso_dev_new(devcnt, prof);
323 sdi->status = SR_ST_INACTIVE;
324 devices = g_slist_append(devices, sdi);
326 devc->usb = sr_usb_dev_inst_new(
327 libusb_get_bus_number(devlist[i]),
328 libusb_get_device_address(devlist[i]), NULL);
334 /* not a supported VID/PID */
337 libusb_free_device_list(devlist, 1);
342 static GSList *hw_dev_list(void)
344 return ((struct drv_context *)(di->priv))->instances;
347 static int hw_dev_open(struct sr_dev_inst *sdi)
349 struct dev_context *devc;
350 int64_t timediff_us, timediff_ms;
356 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
357 * for the FX2 to renumerate.
360 if (devc->fw_updated > 0) {
361 sr_info("Waiting for device to reset.");
362 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
363 g_usleep(300 * 1000);
365 while (timediff_ms < MAX_RENUM_DELAY_MS) {
366 if ((err = dso_open(sdi)) == SR_OK)
368 g_usleep(100 * 1000);
369 timediff_us = g_get_monotonic_time() - devc->fw_updated;
370 timediff_ms = timediff_us / 1000;
371 sr_spew("Waited %" PRIi64 " ms.", timediff_ms);
373 sr_info("Device came back after %d ms.", timediff_ms);
379 sr_err("Unable to open device.");
383 err = libusb_claim_interface(devc->usb->devhdl, USB_INTERFACE);
385 sr_err("Unable to claim interface: %s.",
386 libusb_error_name(err));
393 static int hw_dev_close(struct sr_dev_inst *sdi)
400 static int hw_cleanup(void)
402 struct drv_context *drvc;
404 if (!(drvc = di->priv))
412 static int config_set(int id, const void *value, const struct sr_dev_inst *sdi)
414 struct dev_context *devc;
415 struct sr_rational tmp_rat;
421 if (sdi->status != SR_ST_ACTIVE)
427 case SR_CONF_LIMIT_FRAMES:
428 devc->limit_frames = *(const uint64_t *)value;
430 case SR_CONF_TRIGGER_SLOPE:
431 tmp_u64 = *(const int *)value;
432 if (tmp_u64 != SLOPE_NEGATIVE && tmp_u64 != SLOPE_POSITIVE)
434 devc->triggerslope = tmp_u64;
436 case SR_CONF_HORIZ_TRIGGERPOS:
437 tmp_float = *(const float *)value;
438 if (tmp_float < 0.0 || tmp_float > 1.0) {
439 sr_err("Trigger position should be between 0.0 and 1.0.");
442 devc->triggerposition = tmp_float;
444 case SR_CONF_BUFFERSIZE:
445 tmp_u64 = *(const int *)value;
446 for (i = 0; buffersizes[i]; i++) {
447 if (buffersizes[i] == tmp_u64) {
448 devc->framesize = tmp_u64;
452 if (buffersizes[i] == 0)
455 case SR_CONF_TIMEBASE:
456 tmp_rat = *(const struct sr_rational *)value;
457 for (i = 0; timebases[i].p && timebases[i].q; i++) {
458 if (timebases[i].p == tmp_rat.p
459 && timebases[i].q == tmp_rat.q) {
464 if (timebases[i].p == 0 && timebases[i].q == 0)
467 case SR_CONF_TRIGGER_SOURCE:
468 for (i = 0; trigger_sources[i]; i++) {
469 if (!strcmp(value, trigger_sources[i])) {
470 devc->triggersource = g_strdup(value);
474 if (trigger_sources[i] == 0)
478 devc->filter_ch1 = devc->filter_ch2 = devc->filter_trigger = 0;
479 targets = g_strsplit(value, ",", 0);
480 for (i = 0; targets[i]; i++) {
481 if (targets[i] == '\0')
482 /* Empty filter string can be used to clear them all. */
484 else if (!strcmp(targets[i], "CH1"))
485 devc->filter_ch1 = TRUE;
486 else if (!strcmp(targets[i], "CH2"))
487 devc->filter_ch2 = TRUE;
488 else if (!strcmp(targets[i], "TRIGGER"))
489 devc->filter_trigger = TRUE;
491 sr_err("Invalid filter target %s.", targets[i]);
498 /* TODO: Not supporting vdiv per channel yet. */
499 tmp_rat = *(const struct sr_rational *)value;
500 for (i = 0; vdivs[i].p && vdivs[i].q; i++) {
501 if (vdivs[i].p == tmp_rat.p
502 && vdivs[i].q == tmp_rat.q) {
503 devc->voltage_ch1 = i;
504 devc->voltage_ch2 = i;
508 if (vdivs[i].p == 0 && vdivs[i].q == 0)
511 case SR_CONF_COUPLING:
512 /* TODO: Not supporting coupling per channel yet. */
513 for (i = 0; coupling[i]; i++) {
514 if (!strcmp(value, coupling[i])) {
515 devc->coupling_ch1 = i;
516 devc->coupling_ch2 = i;
520 if (coupling[i] == 0)
531 static int config_list(int key, const void **data, const struct sr_dev_inst *sdi)
537 case SR_CONF_DEVICE_OPTIONS:
540 case SR_CONF_BUFFERSIZE:
543 case SR_CONF_COUPLING:
550 *data = filter_targets;
552 case SR_CONF_TIMEBASE:
555 case SR_CONF_TRIGGER_SOURCE:
556 *data = trigger_sources;
565 static void send_chunk(struct sr_dev_inst *sdi, unsigned char *buf,
568 struct sr_datafeed_packet packet;
569 struct sr_datafeed_analog analog;
570 struct dev_context *devc;
571 float ch1, ch2, range;
572 int num_probes, data_offset, i;
575 num_probes = (devc->ch1_enabled && devc->ch2_enabled) ? 2 : 1;
576 packet.type = SR_DF_ANALOG;
577 packet.payload = &analog;
578 /* TODO: support for 5xxx series 9-bit samples */
579 analog.probes = devc->enabled_probes;
580 analog.num_samples = num_samples;
581 analog.mq = SR_MQ_VOLTAGE;
582 analog.unit = SR_UNIT_VOLT;
583 /* TODO: Check malloc return value. */
584 analog.data = g_try_malloc(analog.num_samples * sizeof(float) * num_probes);
586 for (i = 0; i < analog.num_samples; i++) {
588 * The device always sends data for both channels. If a channel
589 * is disabled, it contains a copy of the enabled channel's
590 * data. However, we only send the requested channels to
593 * Voltage values are encoded as a value 0-255 (0-512 on the
594 * DSO-5200*), where the value is a point in the range
595 * represented by the vdiv setting. There are 8 vertical divs,
596 * so e.g. 500mV/div represents 4V peak-to-peak where 0 = -2V
599 /* TODO: Support for DSO-5xxx series 9-bit samples. */
600 if (devc->ch1_enabled) {
601 range = ((float)vdivs[devc->voltage_ch1].p / vdivs[devc->voltage_ch1].q) * 8;
602 ch1 = range / 255 * *(buf + i * 2 + 1);
603 /* Value is centered around 0V. */
605 analog.data[data_offset++] = ch1;
607 if (devc->ch2_enabled) {
608 range = ((float)vdivs[devc->voltage_ch2].p / vdivs[devc->voltage_ch2].q) * 8;
609 ch2 = range / 255 * *(buf + i * 2);
611 analog.data[data_offset++] = ch2;
614 sr_session_send(devc->cb_data, &packet);
618 * Called by libusb (as triggered by handle_event()) when a transfer comes in.
619 * Only channel data comes in asynchronously, and all transfers for this are
620 * queued up beforehand, so this just needs to chuck the incoming data onto
621 * the libsigrok session bus.
623 static void receive_transfer(struct libusb_transfer *transfer)
625 struct sr_datafeed_packet packet;
626 struct sr_dev_inst *sdi;
627 struct dev_context *devc;
628 int num_samples, pre;
630 sdi = transfer->user_data;
632 sr_dbg("receive_transfer(): status %d received %d bytes.",
633 transfer->status, transfer->actual_length);
635 if (transfer->actual_length == 0)
636 /* Nothing to send to the bus. */
639 num_samples = transfer->actual_length / 2;
641 sr_dbg("Got %d-%d/%d samples in frame.", devc->samp_received + 1,
642 devc->samp_received + num_samples, devc->framesize);
645 * The device always sends a full frame, but the beginning of the frame
646 * doesn't represent the trigger point. The offset at which the trigger
647 * happened came in with the capture state, so we need to start sending
648 * from there up the session bus. The samples in the frame buffer
649 * before that trigger point came after the end of the device's frame
650 * buffer was reached, and it wrapped around to overwrite up until the
653 if (devc->samp_received < devc->trigger_offset) {
654 /* Trigger point not yet reached. */
655 if (devc->samp_received + num_samples < devc->trigger_offset) {
656 /* The entire chunk is before the trigger point. */
657 memcpy(devc->framebuf + devc->samp_buffered * 2,
658 transfer->buffer, num_samples * 2);
659 devc->samp_buffered += num_samples;
662 * This chunk hits or overruns the trigger point.
663 * Store the part before the trigger fired, and
664 * send the rest up to the session bus.
666 pre = devc->trigger_offset - devc->samp_received;
667 memcpy(devc->framebuf + devc->samp_buffered * 2,
668 transfer->buffer, pre * 2);
669 devc->samp_buffered += pre;
671 /* The rest of this chunk starts with the trigger point. */
672 sr_dbg("Reached trigger point, %d samples buffered.",
673 devc->samp_buffered);
675 /* Avoid the corner case where the chunk ended at
676 * exactly the trigger point. */
677 if (num_samples > pre)
678 send_chunk(sdi, transfer->buffer + pre * 2,
682 /* Already past the trigger point, just send it all out. */
683 send_chunk(sdi, transfer->buffer,
687 devc->samp_received += num_samples;
689 /* Everything in this transfer was either copied to the buffer or
690 * sent to the session bus. */
691 g_free(transfer->buffer);
692 libusb_free_transfer(transfer);
694 if (devc->samp_received >= devc->framesize) {
695 /* That was the last chunk in this frame. Send the buffered
696 * pre-trigger samples out now, in one big chunk. */
697 sr_dbg("End of frame, sending %d pre-trigger buffered samples.",
698 devc->samp_buffered);
699 send_chunk(sdi, devc->framebuf, devc->samp_buffered);
701 /* Mark the end of this frame. */
702 packet.type = SR_DF_FRAME_END;
703 sr_session_send(devc->cb_data, &packet);
705 if (devc->limit_frames && ++devc->num_frames == devc->limit_frames) {
706 /* Terminate session */
707 devc->dev_state = STOPPING;
709 devc->dev_state = NEW_CAPTURE;
714 static int handle_event(int fd, int revents, void *cb_data)
716 const struct sr_dev_inst *sdi;
717 struct sr_datafeed_packet packet;
719 struct dev_context *devc;
720 struct drv_context *drvc = di->priv;
721 const struct libusb_pollfd **lupfd;
723 uint32_t trigger_offset;
724 uint8_t capturestate;
731 if (devc->dev_state == STOPPING) {
732 /* We've been told to wind up the acquisition. */
733 sr_dbg("Stopping acquisition.");
735 * TODO: Doesn't really cancel pending transfers so they might
736 * come in after SR_DF_END is sent.
738 lupfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
739 for (i = 0; lupfd[i]; i++)
740 sr_source_remove(lupfd[i]->fd);
743 packet.type = SR_DF_END;
744 sr_session_send(sdi, &packet);
746 devc->dev_state = IDLE;
751 /* Always handle pending libusb events. */
752 tv.tv_sec = tv.tv_usec = 0;
753 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
756 if (devc->dev_state == NEW_CAPTURE) {
757 if (dso_capture_start(devc) != SR_OK)
759 if (dso_enable_trigger(devc) != SR_OK)
761 // if (dso_force_trigger(devc) != SR_OK)
763 sr_dbg("Successfully requested next chunk.");
764 devc->dev_state = CAPTURE;
767 if (devc->dev_state != CAPTURE)
770 if ((dso_get_capturestate(devc, &capturestate, &trigger_offset)) != SR_OK)
773 sr_dbg("Capturestate %d.", capturestate);
774 sr_dbg("Trigger offset 0x%.6x.", trigger_offset);
775 switch (capturestate) {
777 if (++devc->capture_empty_count >= MAX_CAPTURE_EMPTY) {
778 devc->capture_empty_count = 0;
779 if (dso_capture_start(devc) != SR_OK)
781 if (dso_enable_trigger(devc) != SR_OK)
783 // if (dso_force_trigger(devc) != SR_OK)
785 sr_dbg("Successfully requested next chunk.");
788 case CAPTURE_FILLING:
791 case CAPTURE_READY_8BIT:
792 /* Remember where in the captured frame the trigger is. */
793 devc->trigger_offset = trigger_offset;
795 num_probes = (devc->ch1_enabled && devc->ch2_enabled) ? 2 : 1;
796 /* TODO: Check malloc return value. */
797 devc->framebuf = g_try_malloc(devc->framesize * num_probes * 2);
798 devc->samp_buffered = devc->samp_received = 0;
800 /* Tell the scope to send us the first frame. */
801 if (dso_get_channeldata(sdi, receive_transfer) != SR_OK)
805 * Don't hit the state machine again until we're done fetching
806 * the data we just told the scope to send.
808 devc->dev_state = FETCH_DATA;
810 /* Tell the frontend a new frame is on the way. */
811 packet.type = SR_DF_FRAME_BEGIN;
812 sr_session_send(sdi, &packet);
814 case CAPTURE_READY_9BIT:
816 sr_err("Not yet supported.");
818 case CAPTURE_TIMEOUT:
819 /* Doesn't matter, we'll try again next time. */
822 sr_dbg("Unknown capture state: %d.", capturestate);
829 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
832 const struct libusb_pollfd **lupfd;
833 struct dev_context *devc;
834 struct drv_context *drvc = di->priv;
837 if (sdi->status != SR_ST_ACTIVE)
841 devc->cb_data = cb_data;
843 if (configure_probes(sdi) != SR_OK) {
844 sr_err("Failed to configure probes.");
848 if (dso_init(devc) != SR_OK)
851 if (dso_capture_start(devc) != SR_OK)
854 devc->dev_state = CAPTURE;
855 lupfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
856 for (i = 0; lupfd[i]; i++)
857 sr_source_add(lupfd[i]->fd, lupfd[i]->events, TICK,
858 handle_event, (void *)sdi);
861 /* Send header packet to the session bus. */
862 std_session_send_df_header(cb_data, DRIVER_LOG_DOMAIN);
867 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
869 struct dev_context *devc;
873 if (sdi->status != SR_ST_ACTIVE)
877 devc->dev_state = STOPPING;
882 SR_PRIV struct sr_dev_driver hantek_dso_driver_info = {
883 .name = "hantek-dso",
884 .longname = "Hantek DSO",
887 .cleanup = hw_cleanup,
889 .dev_list = hw_dev_list,
890 .dev_clear = clear_instances,
892 .config_set = config_set,
893 .config_list = config_list,
894 .dev_open = hw_dev_open,
895 .dev_close = hw_dev_close,
896 .dev_acquisition_start = hw_dev_acquisition_start,
897 .dev_acquisition_stop = hw_dev_acquisition_stop,