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>
33 #include "sigrok-internal.h"
37 /* FIXME: Temporary build fix, this will be removed later. */
38 #define GTV_TO_MSEC(gtv) (gtv.tv_sec * 1000 + gtv.tv_usec / 1000)
40 /* Max time in ms before we want to check on events */
43 static const int hwcaps[] = {
44 SR_HWCAP_OSCILLOSCOPE,
45 SR_HWCAP_LIMIT_SAMPLES,
49 SR_HWCAP_TRIGGER_SOURCE,
50 SR_HWCAP_TRIGGER_SLOPE,
51 SR_HWCAP_HORIZ_TRIGGERPOS,
58 static const char *probe_names[] = {
64 static const struct dso_profile dev_profiles[] = {
69 FIRMWARE_DIR "/hantek-dso-2090.fw" },
70 { 0, 0, 0, 0, 0, 0, 0, 0, 0 },
73 static const uint64_t buffersizes[] = {
80 static const struct sr_rational timebases[] = {
101 static const struct sr_rational vdivs[] = {
116 static const char *trigger_sources[] = {
123 static const char *filter_targets[] = {
126 /* TODO: "TRIGGER", */
130 static const char *coupling[] = {
137 SR_PRIV libusb_context *usb_context = NULL;
138 SR_PRIV GSList *dev_insts = NULL;
140 static struct sr_dev_inst *dso_dev_new(int index, const struct dso_profile *prof)
142 struct sr_dev_inst *sdi;
145 sdi = sr_dev_inst_new(index, SR_ST_INITIALIZING,
146 prof->vendor, prof->model, prof->model_version);
150 if (!(ctx = g_try_malloc0(sizeof(struct context)))) {
151 sr_err("hantek-dso: ctx malloc failed");
155 ctx->dev_state = IDLE;
156 ctx->timebase = DEFAULT_TIMEBASE;
157 ctx->ch1_enabled = TRUE;
158 ctx->ch2_enabled = TRUE;
159 ctx->voltage_ch1 = DEFAULT_VOLTAGE;
160 ctx->voltage_ch2 = DEFAULT_VOLTAGE;
161 ctx->coupling_ch1 = DEFAULT_COUPLING;
162 ctx->coupling_ch2 = DEFAULT_COUPLING;
163 ctx->voffset_ch1 = DEFAULT_VERT_OFFSET;
164 ctx->voffset_ch2 = DEFAULT_VERT_OFFSET;
165 ctx->voffset_trigger = DEFAULT_VERT_TRIGGERPOS;
166 ctx->framesize = DEFAULT_FRAMESIZE;
167 ctx->triggerslope = SLOPE_POSITIVE;
168 ctx->triggersource = g_strdup(DEFAULT_TRIGGER_SOURCE);
169 ctx->triggerposition = DEFAULT_HORIZ_TRIGGERPOS;
171 dev_insts = g_slist_append(dev_insts, sdi);
176 static int configure_probes(struct context *ctx, const GSList *probes)
178 const struct sr_probe *probe;
181 ctx->ch1_enabled = ctx->ch2_enabled = FALSE;
182 for (l = probes; l; l = l->next) {
183 probe = (struct sr_probe *)l->data;
184 if (probe->index == 1)
185 ctx->ch1_enabled = probe->enabled;
186 else if (probe->index == 2)
187 ctx->ch2_enabled = probe->enabled;
193 static int hw_init(const char *devinfo)
195 struct sr_dev_inst *sdi;
196 struct libusb_device_descriptor des;
197 const struct dso_profile *prof;
199 libusb_device **devlist;
200 int err, devcnt, i, j;
202 /* Avoid compiler warnings. */
205 if (libusb_init(&usb_context) != 0) {
206 sr_err("hantek-dso: Failed to initialize USB.");
210 /* Find all Hantek DSO devices and upload firmware to all of them. */
212 libusb_get_device_list(usb_context, &devlist);
213 for (i = 0; devlist[i]; i++) {
214 if ((err = libusb_get_device_descriptor(devlist[i], &des))) {
215 sr_err("hantek-dso: failed to get device descriptor: %d", err);
220 for (j = 0; dev_profiles[j].orig_vid; j++) {
221 if (des.idVendor == dev_profiles[j].orig_vid
222 && des.idProduct == dev_profiles[j].orig_pid) {
223 /* Device matches the pre-firmware profile. */
224 prof = &dev_profiles[j];
225 sr_dbg("hantek-dso: Found a %s %s.", prof->vendor, prof->model);
226 sdi = dso_dev_new(devcnt, prof);
228 if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
229 prof->firmware) == SR_OK)
230 /* Remember when the firmware on this device was updated */
231 g_get_current_time(&ctx->fw_updated);
233 sr_err("hantek-dso: firmware upload failed for "
234 "device %d", devcnt);
235 /* Dummy USB address of 0xff will get overwritten later. */
236 ctx->usb = sr_usb_dev_inst_new(
237 libusb_get_bus_number(devlist[i]), 0xff, NULL);
240 } else if (des.idVendor == dev_profiles[j].fw_vid
241 && des.idProduct == dev_profiles[j].fw_pid) {
242 /* Device matches the post-firmware profile. */
243 prof = &dev_profiles[j];
244 sr_dbg("hantek-dso: Found a %s %s.", prof->vendor, prof->model);
245 sdi = dso_dev_new(devcnt, prof);
246 sdi->status = SR_ST_INACTIVE;
248 ctx->usb = sr_usb_dev_inst_new(
249 libusb_get_bus_number(devlist[i]),
250 libusb_get_device_address(devlist[i]), NULL);
256 /* not a supported VID/PID */
259 libusb_free_device_list(devlist, 1);
264 static int hw_dev_open(int dev_index)
267 struct sr_dev_inst *sdi;
271 if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
276 * if the firmware was recently uploaded, wait up to MAX_RENUM_DELAY ms
277 * for the FX2 to renumerate
280 if (GTV_TO_MSEC(ctx->fw_updated) > 0) {
281 sr_info("hantek-dso: waiting for device to reset");
282 /* takes at least 300ms for the FX2 to be gone from the USB bus */
283 g_usleep(300 * 1000);
285 while (timediff < MAX_RENUM_DELAY) {
286 if ((err = dso_open(dev_index)) == SR_OK)
288 g_usleep(100 * 1000);
289 g_get_current_time(&cur_time);
290 timediff = GTV_TO_MSEC(cur_time) - GTV_TO_MSEC(ctx->fw_updated);
292 sr_info("hantek-dso: device came back after %d ms", timediff);
294 err = dso_open(dev_index);
298 sr_err("hantek-dso: unable to open device");
302 err = libusb_claim_interface(ctx->usb->devhdl, USB_INTERFACE);
304 sr_err("hantek-dso: Unable to claim interface: %d", err);
311 static int hw_dev_close(int dev_index)
313 struct sr_dev_inst *sdi;
315 if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
323 static int hw_cleanup(void)
326 struct sr_dev_inst *sdi;
329 /* Properly close and free all devices. */
330 for (l = dev_insts; l; l = l->next) {
331 if (!(sdi = l->data)) {
332 /* Log error, but continue cleaning up the rest. */
333 sr_err("hantek-dso: %s: sdi was NULL, continuing", __func__);
336 if (!(ctx = sdi->priv)) {
337 /* Log error, but continue cleaning up the rest. */
338 sr_err("hantek-dso: %s: sdi->priv was NULL, continuing", __func__);
342 sr_usb_dev_inst_free(ctx->usb);
343 g_free(ctx->triggersource);
345 sr_dev_inst_free(sdi);
348 g_slist_free(dev_insts);
352 libusb_exit(usb_context);
358 static const void *hw_dev_info_get(int dev_index, int dev_info_id)
360 struct sr_dev_inst *sdi;
365 if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
370 switch (dev_info_id) {
374 case SR_DI_NUM_PROBES:
375 info = GINT_TO_POINTER(ctx->profile->num_probes);
377 case SR_DI_PROBE_NAMES:
380 case SR_DI_BUFFERSIZES:
383 case SR_DI_TIMEBASES:
386 case SR_DI_TRIGGER_SOURCES:
387 info = trigger_sources;
390 info = filter_targets;
398 /* TODO remove this */
399 case SR_DI_CUR_SAMPLERATE:
407 static int hw_dev_status_get(int dev_index)
409 struct sr_dev_inst *sdi;
411 if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
412 return SR_ST_NOT_FOUND;
417 static const int *hw_hwcap_get_all(void)
422 static int hw_dev_config_set(int dev_index, int hwcap, const void *value)
424 struct sr_dev_inst *sdi;
426 struct sr_rational tmp_rat;
432 if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
435 if (sdi->status != SR_ST_ACTIVE)
441 case SR_HWCAP_LIMIT_FRAMES:
442 ctx->limit_frames = *(const uint64_t *)value;
444 case SR_HWCAP_PROBECONFIG:
445 ret = configure_probes(ctx, (const GSList *)value);
447 case SR_HWCAP_TRIGGER_SLOPE:
448 tmp_u64 = *(const int *)value;
449 if (tmp_u64 != SLOPE_NEGATIVE && tmp_u64 != SLOPE_POSITIVE)
451 ctx->triggerslope = tmp_u64;
453 case SR_HWCAP_HORIZ_TRIGGERPOS:
454 tmp_float = *(const float *)value;
455 if (tmp_float < 0.0 || tmp_float > 1.0) {
456 sr_err("hantek-dso: trigger position should be between 0.0 and 1.0");
459 ctx->triggerposition = tmp_float;
461 case SR_HWCAP_BUFFERSIZE:
462 tmp_u64 = *(const int *)value;
463 for (i = 0; buffersizes[i]; i++) {
464 if (buffersizes[i] == tmp_u64) {
465 ctx->framesize = tmp_u64;
469 if (buffersizes[i] == 0)
472 case SR_HWCAP_TIMEBASE:
473 tmp_rat = *(const struct sr_rational *)value;
474 for (i = 0; timebases[i].p && timebases[i].q; i++) {
475 if (timebases[i].p == tmp_rat.p
476 && timebases[i].q == tmp_rat.q) {
481 if (timebases[i].p == 0 && timebases[i].q == 0)
484 case SR_HWCAP_TRIGGER_SOURCE:
485 for (i = 0; trigger_sources[i]; i++) {
486 if (!strcmp(value, trigger_sources[i])) {
487 ctx->triggersource = g_strdup(value);
491 if (trigger_sources[i] == 0)
494 case SR_HWCAP_FILTER:
495 ctx->filter_ch1 = ctx->filter_ch2 = ctx->filter_trigger = 0;
496 targets = g_strsplit(value, ",", 0);
497 for (i = 0; targets[i]; i++) {
498 if (targets[i] == '\0')
499 /* Empty filter string can be used to clear them all. */
501 else if (!strcmp(targets[i], "CH1"))
502 ctx->filter_ch1 = TRUE;
503 else if (!strcmp(targets[i], "CH2"))
504 ctx->filter_ch2 = TRUE;
505 else if (!strcmp(targets[i], "TRIGGER"))
506 ctx->filter_trigger = TRUE;
508 sr_err("invalid filter target %s", targets[i]);
515 /* TODO not supporting vdiv per channel yet */
516 tmp_rat = *(const struct sr_rational *)value;
517 for (i = 0; vdivs[i].p && vdivs[i].q; i++) {
518 if (vdivs[i].p == tmp_rat.p
519 && vdivs[i].q == tmp_rat.q) {
520 ctx->voltage_ch1 = i;
521 ctx->voltage_ch2 = i;
525 if (vdivs[i].p == 0 && vdivs[i].q == 0)
528 case SR_HWCAP_COUPLING:
529 /* TODO not supporting coupling per channel yet */
530 for (i = 0; coupling[i]; i++) {
531 if (!strcmp(value, coupling[i])) {
532 ctx->coupling_ch1 = i;
533 ctx->coupling_ch2 = i;
537 if (coupling[i] == 0)
547 /* Called by libusb (as triggered by handle_event()) when a transfer comes in.
548 * Only channel data comes in asynchronously, and all transfers for this are
549 * queued up beforehand, so this just needs so chuck the incoming data onto
550 * the libsigrok session bus.
552 static void receive_transfer(struct libusb_transfer *transfer)
554 struct sr_datafeed_packet packet;
555 struct sr_datafeed_analog analog;
557 float ch1, ch2, range;
558 int num_probes, data_offset, i;
560 ctx = transfer->user_data;
561 sr_dbg("hantek-dso: receive_transfer(): status %d received %d bytes",
562 transfer->status, transfer->actual_length);
564 if (transfer->actual_length == 0)
565 /* Nothing to send to the bus. */
568 ctx->current_transfer += transfer->actual_length;
569 sr_dbg("hantek-dso: got %d of %d in frame", ctx->current_transfer, ctx->framesize * 2);
571 num_probes = (ctx->ch1_enabled && ctx->ch2_enabled) ? 2 : 1;
572 packet.type = SR_DF_ANALOG;
573 packet.payload = &analog;
574 /* TODO: support for 5xxx series 9-bit samples */
575 analog.num_samples = transfer->actual_length / 2;
576 analog.unit = SR_UNIT_VOLTAGE;
577 analog.data = g_try_malloc(analog.num_samples * sizeof(float) * num_probes);
579 for (i = 0; i < analog.num_samples; i++) {
580 /* The device always sends data for both channels. If a channel
581 * is disabled, it contains a copy of the enabled channel's
582 * data. However, we only send the requested channels to the bus.
584 * Voltage values are encoded as a value 0-255 (0-512 on the 5200*),
585 * where the value is a point in the range represented by the vdiv
586 * setting. There are 8 vertical divs, so e.g. 500mV/div represents
587 * 4V peak-to-peak where 0 = -2V and 255 = +2V.
589 /* TODO: support for 5xxx series 9-bit samples */
590 if (ctx->ch1_enabled) {
591 range = ((float)vdivs[ctx->voltage_ch1].p / vdivs[ctx->voltage_ch1].q) * 8;
592 ch1 = range / 255 * *(transfer->buffer + i * 2 + 1);
593 /* Value is centered around 0V. */
595 analog.data[data_offset++] = ch1;
597 if (ctx->ch2_enabled) {
598 range = ((float)vdivs[ctx->voltage_ch2].p / vdivs[ctx->voltage_ch2].q) * 8;
599 ch2 = range / 255 * *(transfer->buffer + i * 2);
601 analog.data[data_offset++] = ch2;
604 g_free(transfer->buffer);
605 libusb_free_transfer(transfer);
606 sr_session_send(ctx->cb_data, &packet);
608 if (ctx->current_transfer >= ctx->framesize * 2) {
609 /* That's the last chunk in this frame. */
610 packet.type = SR_DF_FRAME_END;
611 sr_session_send(ctx->cb_data, &packet);
613 if (ctx->limit_frames && ++ctx->num_frames == ctx->limit_frames) {
614 /* Terminate session */
615 /* TODO: don't leave pending USB transfers hanging */
616 packet.type = SR_DF_END;
617 sr_session_send(ctx->cb_data, &packet);
619 ctx->current_transfer = 0;
620 ctx->dev_state = NEW_CAPTURE;
626 static int handle_event(int fd, int revents, void *cb_data)
628 struct sr_datafeed_packet packet;
633 /* Avoid compiler warnings. */
637 /* Always handle pending libusb events. */
638 tv.tv_sec = tv.tv_usec = 0;
639 libusb_handle_events_timeout(usb_context, &tv);
643 if (ctx->dev_state == NEW_CAPTURE) {
644 if (dso_capture_start(ctx) != SR_OK)
646 if (dso_enable_trigger(ctx) != SR_OK)
648 // if (dso_force_trigger(ctx) != SR_OK)
650 sr_dbg("hantek-dso: successfully requested next chunk");
651 ctx->dev_state = CAPTURE;
654 if (ctx->dev_state != CAPTURE)
657 if ((capturestate = dso_get_capturestate(ctx)) == CAPTURE_UNKNOWN) {
658 /* Generated by the function, not the hardware. */
662 sr_dbg("hantek-dso: capturestate %d", capturestate);
663 switch (capturestate) {
665 if (++ctx->capture_empty_count >= MAX_CAPTURE_EMPTY) {
666 ctx->capture_empty_count = 0;
667 if (dso_capture_start(ctx) != SR_OK)
669 if (dso_enable_trigger(ctx) != SR_OK)
671 // if (dso_force_trigger(ctx) != SR_OK)
673 sr_dbg("hantek-dso: successfully requested next chunk");
676 case CAPTURE_FILLING:
679 case CAPTURE_READY_8BIT:
680 /* Tell the scope to send us the first frame. */
681 if (dso_get_channeldata(ctx, receive_transfer) != SR_OK)
684 /* Don't hit the state machine again until we're done fetching
685 * the data we just told the scope to send.
687 ctx->dev_state = FETCH_DATA;
689 /* Tell the frontend a new frame is on the way. */
690 packet.type = SR_DF_FRAME_BEGIN;
691 sr_session_send(cb_data, &packet);
693 case CAPTURE_READY_9BIT:
695 sr_err("not yet supported");
697 case CAPTURE_TIMEOUT:
698 /* Doesn't matter, we'll try again next time. */
701 sr_dbg("unknown capture state");
707 static int hw_dev_acquisition_start(int dev_index, void *cb_data)
709 const struct libusb_pollfd **lupfd;
710 struct sr_datafeed_packet packet;
711 struct sr_datafeed_header header;
712 struct sr_datafeed_meta_analog meta;
713 struct sr_dev_inst *sdi;
717 if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
720 if (sdi->status != SR_ST_ACTIVE)
724 ctx->cb_data = cb_data;
726 if (dso_init(ctx) != SR_OK)
729 if (dso_capture_start(ctx) != SR_OK)
732 ctx->dev_state = CAPTURE;
733 lupfd = libusb_get_pollfds(usb_context);
734 for (i = 0; lupfd[i]; i++)
735 sr_source_add(lupfd[i]->fd, lupfd[i]->events, TICK, handle_event,
739 /* Send header packet to the session bus. */
740 packet.type = SR_DF_HEADER;
741 packet.payload = (unsigned char *)&header;
742 header.feed_version = 1;
743 gettimeofday(&header.starttime, NULL);
744 sr_session_send(cb_data, &packet);
746 /* Send metadata about the SR_DF_ANALOG packets to come. */
747 packet.type = SR_DF_META_ANALOG;
748 packet.payload = &meta;
749 meta.num_probes = ctx->profile->num_probes;
750 sr_session_send(cb_data, &packet);
755 /* TODO: doesn't really cancel pending transfers so they might come in after
758 static int hw_dev_acquisition_stop(int dev_index, void *cb_data)
760 struct sr_datafeed_packet packet;
761 struct sr_dev_inst *sdi;
764 if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
767 if (sdi->status != SR_ST_ACTIVE)
771 ctx->dev_state = IDLE;
773 packet.type = SR_DF_END;
774 sr_session_send(cb_data, &packet);
779 SR_PRIV struct sr_dev_driver hantek_dso_driver_info = {
780 .name = "hantek-dso",
781 .longname = "Hantek DSO",
784 .cleanup = hw_cleanup,
785 .dev_open = hw_dev_open,
786 .dev_close = hw_dev_close,
787 .dev_info_get = hw_dev_info_get,
788 .dev_status_get = hw_dev_status_get,
789 .hwcap_get_all = hw_hwcap_get_all,
790 .dev_config_set = hw_dev_config_set,
791 .dev_acquisition_start = hw_dev_acquisition_start,
792 .dev_acquisition_stop = hw_dev_acquisition_stop,