]> sigrok.org Git - libsigrok.git/blobdiff - hardware/hantek-dso/api.c
hantek-dso: use new scan API
[libsigrok.git] / hardware / hantek-dso / api.c
index 23d268424b4403e0fc588cef172bcf49826295fb..67278439ceffc2bcec275227ba21e397e9bd77ce 100644 (file)
 #include <string.h>
 #include <sys/time.h>
 #include <inttypes.h>
-#include <arpa/inet.h>
 #include <glib.h>
 #include <libusb.h>
-#include "sigrok.h"
-#include "sigrok-internal.h"
+#include "libsigrok.h"
+#include "libsigrok-internal.h"
 #include "config.h"
 #include "dso.h"
 
-/* FIXME: Temporary build fix, this will be removed later. */
-#define GTV_TO_MSEC(gtv)       (gtv.tv_sec * 1000 + gtv.tv_usec / 1000)
 
-/* Max time in ms before we want to check on events */
+/* Max time in ms before we want to check on USB events */
+/* TODO tune this properly */
 #define TICK    1
 
 static const int hwcaps[] = {
@@ -63,12 +61,22 @@ static const char *probe_names[] = {
 };
 
 static const struct dso_profile dev_profiles[] = {
-       {       0x04b4, 0x2090,
-               0x04b5, 0x2090,
+       {       0x04b4, 0x2090, 0x04b5, 0x2090,
                "Hantek", "DSO-2090",
-               NULL, 2,
-               FIRMWARE_DIR "/hantek-dso-2090.fw" },
-       { 0, 0, 0, 0, 0, 0, 0, 0, 0 },
+               FIRMWARE_DIR "/hantek-dso-2xxx.fw" },
+       {       0x04b4, 0x2150, 0x04b5, 0x2150,
+               "Hantek", "DSO-2150",
+               FIRMWARE_DIR "/hantek-dso-2xxx.fw" },
+       {       0x04b4, 0x2250, 0x04b5, 0x2250,
+               "Hantek", "DSO-2250",
+               FIRMWARE_DIR "/hantek-dso-2xxx.fw" },
+       {       0x04b4, 0x5200, 0x04b5, 0x5200,
+               "Hantek", "DSO-5200",
+               FIRMWARE_DIR "/hantek-dso-5xxx.fw" },
+       {       0x04b4, 0x520a, 0x04b5, 0x520a,
+               "Hantek", "DSO-5200A",
+               FIRMWARE_DIR "/hantek-dso-5xxx.fw" },
+       { 0, 0, 0, 0, 0, 0, 0 },
 };
 
 static const uint64_t buffersizes[] = {
@@ -118,6 +126,7 @@ static const char *trigger_sources[] = {
        "CH1",
        "CH2",
        "EXT",
+       /* TODO: forced */
        NULL,
 };
 
@@ -136,7 +145,8 @@ static const char *coupling[] = {
 };
 
 SR_PRIV libusb_context *usb_context = NULL;
-SR_PRIV GSList *dev_insts = NULL;
+SR_PRIV struct sr_dev_driver hantek_dso_driver_info;
+static struct sr_dev_driver *hdi = &hantek_dso_driver_info;
 
 static struct sr_dev_inst *dso_dev_new(int index, const struct dso_profile *prof)
 {
@@ -144,7 +154,7 @@ static struct sr_dev_inst *dso_dev_new(int index, const struct dso_profile *prof
        struct context *ctx;
 
        sdi = sr_dev_inst_new(index, SR_ST_INITIALIZING,
-               prof->vendor, prof->model, prof->model_version);
+               prof->vendor, prof->model, NULL);
        if (!sdi)
                return NULL;
 
@@ -169,7 +179,7 @@ static struct sr_dev_inst *dso_dev_new(int index, const struct dso_profile *prof
        ctx->triggersource = g_strdup(DEFAULT_TRIGGER_SOURCE);
        ctx->triggerposition = DEFAULT_HORIZ_TRIGGERPOS;
        sdi->priv = ctx;
-       dev_insts = g_slist_append(dev_insts, sdi);
+       hdi->instances = g_slist_append(hdi->instances, sdi);
 
        return sdi;
 }
@@ -191,29 +201,69 @@ static int configure_probes(struct context *ctx, const GSList *probes)
        return SR_OK;
 }
 
-static int hw_init(const char *devinfo)
+/* Properly close and free all devices. */
+static void clear_instances(void)
 {
        struct sr_dev_inst *sdi;
-       struct libusb_device_descriptor des;
-       const struct dso_profile *prof;
        struct context *ctx;
-       libusb_device **devlist;
-       int err, devcnt, i, j;
+       GSList *l;
 
-       /* Avoid compiler warnings. */
-       (void)devinfo;
+       for (l = hdi->instances; l; l = l->next) {
+               if (!(sdi = l->data)) {
+                       /* Log error, but continue cleaning up the rest. */
+                       sr_err("hantek-dso: %s: sdi was NULL, continuing", __func__);
+                       continue;
+               }
+               if (!(ctx = sdi->priv)) {
+                       /* Log error, but continue cleaning up the rest. */
+                       sr_err("hantek-dso: %s: sdi->priv was NULL, continuing", __func__);
+                       continue;
+               }
+               dso_close(sdi);
+               sr_usb_dev_inst_free(ctx->usb);
+               g_free(ctx->triggersource);
+
+               sr_dev_inst_free(sdi);
+       }
+
+       g_slist_free(hdi->instances);
+       hdi->instances = NULL;
+
+}
+
+static int hw_init(void)
+{
 
        if (libusb_init(&usb_context) != 0) {
                sr_err("hantek-dso: Failed to initialize USB.");
-               return 0;
+               return SR_ERR;
        }
 
-       /* Find all Hantek DSO devices and upload firmware to all of them. */
+       return SR_OK;
+}
+
+static GSList *hw_scan(GSList *options)
+{
+       struct sr_dev_inst *sdi;
+       const struct dso_profile *prof;
+       struct context *ctx;
+       GSList *devices;
+       struct libusb_device_descriptor des;
+       libusb_device **devlist;
+       int devcnt, ret, i, j;
+
+       (void)options;
        devcnt = 0;
+       devices = 0;
+       hdi->instances = NULL;
+
+       clear_instances();
+
+       /* Find all Hantek DSO devices and upload firmware to all of them. */
        libusb_get_device_list(usb_context, &devlist);
        for (i = 0; devlist[i]; i++) {
-               if ((err = libusb_get_device_descriptor(devlist[i], &des))) {
-                       sr_err("hantek-dso: failed to get device descriptor: %d", err);
+               if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
+                       sr_err("hantek-dso: failed to get device descriptor: %d", ret);
                        continue;
                }
 
@@ -225,11 +275,12 @@ static int hw_init(const char *devinfo)
                                prof = &dev_profiles[j];
                                sr_dbg("hantek-dso: Found a %s %s.", prof->vendor, prof->model);
                                sdi = dso_dev_new(devcnt, prof);
+                               devices = g_slist_append(devices, sdi);
                                ctx = sdi->priv;
                                if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
                                                prof->firmware) == SR_OK)
                                        /* Remember when the firmware on this device was updated */
-                                       g_get_current_time(&ctx->fw_updated);
+                                       ctx->fw_updated = g_get_monotonic_time();
                                else
                                        sr_err("hantek-dso: firmware upload failed for "
                                               "device %d", devcnt);
@@ -245,6 +296,7 @@ static int hw_init(const char *devinfo)
                                sr_dbg("hantek-dso: Found a %s %s.", prof->vendor, prof->model);
                                sdi = dso_dev_new(devcnt, prof);
                                sdi->status = SR_ST_INACTIVE;
+                               devices = g_slist_append(devices, sdi);
                                ctx = sdi->priv;
                                ctx->usb = sr_usb_dev_inst_new(
                                                libusb_get_bus_number(devlist[i]),
@@ -259,38 +311,39 @@ static int hw_init(const char *devinfo)
        }
        libusb_free_device_list(devlist, 1);
 
-       return devcnt;
+       return devices;
 }
 
 static int hw_dev_open(int dev_index)
 {
-       GTimeVal cur_time;
        struct sr_dev_inst *sdi;
        struct context *ctx;
-       int timediff, err;
+       int64_t timediff_us, timediff_ms;
+       int err;
 
-       if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
+       if (!(sdi = sr_dev_inst_get(hdi->instances, dev_index)))
                return SR_ERR_ARG;
        ctx = sdi->priv;
 
        /*
-        * if the firmware was recently uploaded, wait up to MAX_RENUM_DELAY ms
+        * if the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
         * for the FX2 to renumerate
         */
-       err = 0;
-       if (GTV_TO_MSEC(ctx->fw_updated) > 0) {
+       err = SR_ERR;
+       if (ctx->fw_updated > 0) {
                sr_info("hantek-dso: waiting for device to reset");
                /* takes at least 300ms for the FX2 to be gone from the USB bus */
                g_usleep(300 * 1000);
-               timediff = 0;
-               while (timediff < MAX_RENUM_DELAY) {
+               timediff_ms = 0;
+               while (timediff_ms < MAX_RENUM_DELAY_MS) {
                        if ((err = dso_open(dev_index)) == SR_OK)
                                break;
                        g_usleep(100 * 1000);
-                       g_get_current_time(&cur_time);
-                       timediff = GTV_TO_MSEC(cur_time) - GTV_TO_MSEC(ctx->fw_updated);
+                       timediff_us = g_get_monotonic_time() - ctx->fw_updated;
+                       timediff_ms = timediff_us / 1000;
+                       sr_spew("hantek-dso: waited %" PRIi64 " ms", timediff_ms);
                }
-               sr_info("hantek-dso: device came back after %d ms", timediff);
+               sr_info("hantek-dso: device came back after %d ms", timediff_ms);
        } else {
                err = dso_open(dev_index);
        }
@@ -313,7 +366,7 @@ static int hw_dev_close(int dev_index)
 {
        struct sr_dev_inst *sdi;
 
-       if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
+       if (!(sdi = sr_dev_inst_get(hdi->instances, dev_index)))
                return SR_ERR_ARG;
 
        dso_close(sdi);
@@ -323,31 +376,8 @@ static int hw_dev_close(int dev_index)
 
 static int hw_cleanup(void)
 {
-       GSList *l;
-       struct sr_dev_inst *sdi;
-       struct context *ctx;
 
-       /* Properly close and free all devices. */
-       for (l = dev_insts; l; l = l->next) {
-               if (!(sdi = l->data)) {
-                       /* Log error, but continue cleaning up the rest. */
-                       sr_err("hantek-dso: %s: sdi was NULL, continuing", __func__);
-                       continue;
-               }
-               if (!(ctx = sdi->priv)) {
-                       /* Log error, but continue cleaning up the rest. */
-                       sr_err("hantek-dso: %s: sdi->priv was NULL, continuing", __func__);
-                       continue;
-               }
-               dso_close(sdi);
-               sr_usb_dev_inst_free(ctx->usb);
-               g_free(ctx->triggersource);
-
-               sr_dev_inst_free(sdi);
-       }
-
-       g_slist_free(dev_insts);
-       dev_insts = NULL;
+       clear_instances();
 
        if (usb_context)
                libusb_exit(usb_context);
@@ -359,13 +389,11 @@ static int hw_cleanup(void)
 static const void *hw_dev_info_get(int dev_index, int dev_info_id)
 {
        struct sr_dev_inst *sdi;
-       struct context *ctx;
        const void *info;
        uint64_t tmp;
 
-       if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
+       if (!(sdi = sr_dev_inst_get(hdi->instances, dev_index)))
                return NULL;
-       ctx = sdi->priv;
 
        info = NULL;
        switch (dev_info_id) {
@@ -373,7 +401,7 @@ static const void *hw_dev_info_get(int dev_index, int dev_info_id)
                info = sdi;
                break;
        case SR_DI_NUM_PROBES:
-               info = GINT_TO_POINTER(ctx->profile->num_probes);
+               info = GINT_TO_POINTER(NUM_PROBES);
                break;
        case SR_DI_PROBE_NAMES:
                info = probe_names;
@@ -409,7 +437,7 @@ static int hw_dev_status_get(int dev_index)
 {
        struct sr_dev_inst *sdi;
 
-       if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
+       if (!(sdi = sr_dev_inst_get(hdi->instances, dev_index)))
                return SR_ST_NOT_FOUND;
 
        return sdi->status;
@@ -430,7 +458,7 @@ static int hw_dev_config_set(int dev_index, int hwcap, const void *value)
        int ret, i;
        char **targets;
 
-       if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
+       if (!(sdi = sr_dev_inst_get(hdi->instances, dev_index)))
                return SR_ERR;
 
        if (sdi->status != SR_ST_ACTIVE)
@@ -545,58 +573,130 @@ static int hw_dev_config_set(int dev_index, int hwcap, const void *value)
        return ret;
 }
 
-/* Called by libusb (as triggered by handle_event()) when a transfer comes in.
- * Only channel data comes in asynchronously, and all transfers for this are
- * queued up beforehand, so this just needs so chuck the incoming data onto
- * the libsigrok session bus.
- */
-static void receive_transfer(struct libusb_transfer *transfer)
+static void send_chunk(struct context *ctx, unsigned char *buf,
+               int num_samples)
 {
        struct sr_datafeed_packet packet;
        struct sr_datafeed_analog analog;
-       struct context *ctx;
-       float ch1, ch2;
+       float ch1, ch2, range;
        int num_probes, data_offset, i;
 
-       ctx = transfer->user_data;
-       sr_dbg("hantek-dso: receive_transfer(): status %d received %d bytes",
-                       transfer->status, transfer->actual_length);
-
-       if (transfer->actual_length == 0)
-               /* Nothing to send to the bus. */
-               return;
-
-       ctx->current_transfer += transfer->actual_length;
-       sr_dbg("hantek-dso: got %d of %d in frame", ctx->current_transfer, ctx->framesize * 2);
-
        num_probes = (ctx->ch1_enabled && ctx->ch2_enabled) ? 2 : 1;
        packet.type = SR_DF_ANALOG;
        packet.payload = &analog;
        /* TODO: support for 5xxx series 9-bit samples */
-       analog.num_samples = transfer->actual_length / 2;
+       analog.num_samples = num_samples;
+       analog.mq = SR_MQ_VOLTAGE;
+       analog.unit = SR_UNIT_VOLT;
        analog.data = g_try_malloc(analog.num_samples * sizeof(float) * num_probes);
        data_offset = 0;
        for (i = 0; i < analog.num_samples; i++) {
                /* The device always sends data for both channels. If a channel
                 * is disabled, it contains a copy of the enabled channel's
                 * data. However, we only send the requested channels to the bus.
+                *
+                * Voltage values are encoded as a value 0-255 (0-512 on the 5200*),
+                * where the value is a point in the range represented by the vdiv
+                * setting. There are 8 vertical divs, so e.g. 500mV/div represents
+                * 4V peak-to-peak where 0 = -2V and 255 = +2V.
                 */
                /* TODO: support for 5xxx series 9-bit samples */
                if (ctx->ch1_enabled) {
-                       ch1 = (*(transfer->buffer + i * 2 + 1) / 255.0);
+                       range = ((float)vdivs[ctx->voltage_ch1].p / vdivs[ctx->voltage_ch1].q) * 8;
+                       ch1 = range / 255 * *(buf + i * 2 + 1);
+                       /* Value is centered around 0V. */
+                       ch1 -= range / 2;
                        analog.data[data_offset++] = ch1;
                }
                if (ctx->ch2_enabled) {
-                       ch2 = (*(transfer->buffer + i * 2) / 255.0);
+                       range = ((float)vdivs[ctx->voltage_ch2].p / vdivs[ctx->voltage_ch2].q) * 8;
+                       ch2 = range / 255 * *(buf + i * 2);
+                       ch2 -= range / 2;
                        analog.data[data_offset++] = ch2;
                }
        }
+       sr_session_send(ctx->cb_data, &packet);
+
+}
+
+/* Called by libusb (as triggered by handle_event()) when a transfer comes in.
+ * Only channel data comes in asynchronously, and all transfers for this are
+ * queued up beforehand, so this just needs so chuck the incoming data onto
+ * the libsigrok session bus.
+ */
+static void receive_transfer(struct libusb_transfer *transfer)
+{
+       struct sr_datafeed_packet packet;
+       struct context *ctx;
+       int num_samples, pre;
+
+       ctx = transfer->user_data;
+       sr_dbg("hantek-dso: receive_transfer(): status %d received %d bytes",
+                       transfer->status, transfer->actual_length);
+
+       if (transfer->actual_length == 0)
+               /* Nothing to send to the bus. */
+               return;
+
+       num_samples = transfer->actual_length / 2;
+
+       sr_dbg("hantek-dso: got %d-%d/%d samples in frame", ctx->samp_received + 1,
+                       ctx->samp_received + num_samples, ctx->framesize);
+
+       /* The device always sends a full frame, but the beginning of the frame
+        * doesn't represent the trigger point. The offset at which the trigger
+        * happened came in with the capture state, so we need to start sending
+        * from there up the session bus. The samples in the frame buffer before
+        * that trigger point came after the end of the device's frame buffer was
+        * reached, and it wrapped around to overwrite up until the trigger point.
+        */
+       if (ctx->samp_received < ctx->trigger_offset) {
+               /* Trigger point not yet reached. */
+               if (ctx->samp_received + num_samples < ctx->trigger_offset) {
+                       /* The entire chunk is before the trigger point. */
+                       memcpy(ctx->framebuf + ctx->samp_buffered * 2,
+                                       transfer->buffer, num_samples * 2);
+                       ctx->samp_buffered += num_samples;
+               } else {
+                       /* This chunk hits or overruns the trigger point.
+                        * Store the part before the trigger fired, and
+                        * send the rest up to the session bus. */
+                       pre = ctx->trigger_offset - ctx->samp_received;
+                       memcpy(ctx->framebuf + ctx->samp_buffered * 2,
+                                       transfer->buffer, pre * 2);
+                       ctx->samp_buffered += pre;
+
+                       /* The rest of this chunk starts with the trigger point. */
+                       sr_dbg("hantek-dso: reached trigger point, %d samples buffered",
+                                       ctx->samp_buffered);
+
+                       /* Avoid the corner case where the chunk ended at
+                        * exactly the trigger point. */
+                       if (num_samples > pre)
+                               send_chunk(ctx, transfer->buffer + pre * 2,
+                                               num_samples - pre);
+               }
+       } else {
+               /* Already past the trigger point, just send it all out. */
+               send_chunk(ctx, transfer->buffer,
+                               num_samples);
+       }
+
+       ctx->samp_received += num_samples;
+
+       /* Everything in this transfer was either copied to the buffer or
+        * sent to the session bus. */
        g_free(transfer->buffer);
        libusb_free_transfer(transfer);
-       sr_session_send(ctx->cb_data, &packet);
 
-       if (ctx->current_transfer >= ctx->framesize * 2) {
-               /* That's the last chunk in this frame. */
+       if (ctx->samp_received >= ctx->framesize) {
+               /* That was the last chunk in this frame. Send the buffered
+                * pre-trigger samples out now, in one big chunk. */
+               sr_dbg("hantek-dso: end of frame, sending %d pre-trigger buffered samples",
+                               ctx->samp_buffered);
+               send_chunk(ctx, ctx->framebuf, ctx->samp_buffered);
+
+               /* Mark the end of this frame. */
                packet.type = SR_DF_FRAME_END;
                sr_session_send(ctx->cb_data, &packet);
 
@@ -606,7 +706,6 @@ static void receive_transfer(struct libusb_transfer *transfer)
                        packet.type = SR_DF_END;
                        sr_session_send(ctx->cb_data, &packet);
                } else {
-                       ctx->current_transfer = 0;
                        ctx->dev_state = NEW_CAPTURE;
                }
        }
@@ -618,7 +717,9 @@ static int handle_event(int fd, int revents, void *cb_data)
        struct sr_datafeed_packet packet;
        struct timeval tv;
        struct context *ctx;
-       int capturestate;
+       int num_probes;
+       uint32_t trigger_offset;
+       uint8_t capturestate;
 
        /* Avoid compiler warnings. */
        (void)fd;
@@ -644,12 +745,11 @@ static int handle_event(int fd, int revents, void *cb_data)
        if (ctx->dev_state != CAPTURE)
                return TRUE;
 
-       if ((capturestate = dso_get_capturestate(ctx)) == CAPTURE_UNKNOWN) {
-               /* Generated by the function, not the hardware. */
+       if ((dso_get_capturestate(ctx, &capturestate, &trigger_offset)) != SR_OK)
                return TRUE;
-       }
 
        sr_dbg("hantek-dso: capturestate %d", capturestate);
+       sr_dbg("hantek-dso: trigger offset 0x%.6x", trigger_offset);
        switch (capturestate) {
        case CAPTURE_EMPTY:
                if (++ctx->capture_empty_count >= MAX_CAPTURE_EMPTY) {
@@ -667,6 +767,13 @@ static int handle_event(int fd, int revents, void *cb_data)
                /* no data yet */
                break;
        case CAPTURE_READY_8BIT:
+               /* Remember where in the captured frame the trigger is. */
+               ctx->trigger_offset = trigger_offset;
+
+               num_probes = (ctx->ch1_enabled && ctx->ch2_enabled) ? 2 : 1;
+               ctx->framebuf = g_try_malloc(ctx->framesize * num_probes * 2);
+               ctx->samp_buffered = ctx->samp_received = 0;
+
                /* Tell the scope to send us the first frame. */
                if (dso_get_channeldata(ctx, receive_transfer) != SR_OK)
                        break;
@@ -704,7 +811,7 @@ static int hw_dev_acquisition_start(int dev_index, void *cb_data)
        struct context *ctx;
        int i;
 
-       if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
+       if (!(sdi = sr_dev_inst_get(hdi->instances, dev_index)))
                return SR_ERR;
 
        if (sdi->status != SR_ST_ACTIVE)
@@ -736,7 +843,7 @@ static int hw_dev_acquisition_start(int dev_index, void *cb_data)
        /* Send metadata about the SR_DF_ANALOG packets to come. */
        packet.type = SR_DF_META_ANALOG;
        packet.payload = &meta;
-       meta.num_probes = ctx->profile->num_probes;
+       meta.num_probes = NUM_PROBES;
        sr_session_send(cb_data, &packet);
 
        return SR_OK;
@@ -751,7 +858,7 @@ static int hw_dev_acquisition_stop(int dev_index, void *cb_data)
        struct sr_dev_inst *sdi;
        struct context *ctx;
 
-       if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
+       if (!(sdi = sr_dev_inst_get(hdi->instances, dev_index)))
                return SR_ERR;
 
        if (sdi->status != SR_ST_ACTIVE)
@@ -772,6 +879,7 @@ SR_PRIV struct sr_dev_driver hantek_dso_driver_info = {
        .api_version = 1,
        .init = hw_init,
        .cleanup = hw_cleanup,
+       .scan = hw_scan,
        .dev_open = hw_dev_open,
        .dev_close = hw_dev_close,
        .dev_info_get = hw_dev_info_get,
@@ -780,4 +888,5 @@ SR_PRIV struct sr_dev_driver hantek_dso_driver_info = {
        .dev_config_set = hw_dev_config_set,
        .dev_acquisition_start = hw_dev_acquisition_start,
        .dev_acquisition_stop = hw_dev_acquisition_stop,
+       .instances = NULL,
 };