]> sigrok.org Git - libsigrok.git/blobdiff - hardware/hantek-dso/api.c
hantek-dso: calculate voltage based on vdiv setting
[libsigrok.git] / hardware / hantek-dso / api.c
index d1b98078607e5fadd8d89259a21ae78bf24c9c33..c571caf89ee92d258886ea547b8d703654fa023f 100644 (file)
 #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 */
 #define TICK    1
 
-static int capabilities[] = {
+static const int hwcaps[] = {
        SR_HWCAP_OSCILLOSCOPE,
        SR_HWCAP_LIMIT_SAMPLES,
        SR_HWCAP_CONTINUOUS,
+       SR_HWCAP_TIMEBASE,
+       SR_HWCAP_BUFFERSIZE,
+       SR_HWCAP_TRIGGER_SOURCE,
+       SR_HWCAP_TRIGGER_SLOPE,
+       SR_HWCAP_HORIZ_TRIGGERPOS,
+       SR_HWCAP_FILTER,
+       SR_HWCAP_VDIV,
+       SR_HWCAP_COUPLING,
        0,
 };
 
@@ -52,21 +62,83 @@ static const char *probe_names[] = {
        NULL,
 };
 
-static struct dso_profile dev_profiles[] = {
+static const struct dso_profile dev_profiles[] = {
        {       0x04b4, 0x2090,
                0x04b5, 0x2090,
                "Hantek", "DSO-2090",
                NULL, 2,
                FIRMWARE_DIR "/hantek-dso-2090.fw" },
-       { 0, 0, 0, 0, 0, 0, 0, 0, 0 }
+       { 0, 0, 0, 0, 0, 0, 0, 0, 0 },
 };
 
+static const uint64_t buffersizes[] = {
+       10240,
+       32768,
+       /* TODO: 65535 */
+       0,
+};
+
+static const struct sr_rational timebases[] = {
+       /* microseconds */
+       { 10, 1000000 },
+       { 20, 1000000 },
+       { 40, 1000000 },
+       { 100, 1000000 },
+       { 200, 1000000 },
+       { 400, 1000000 },
+       /* milliseconds */
+       { 1, 1000 },
+       { 2, 1000 },
+       { 4, 1000 },
+       { 10, 1000 },
+       { 20, 1000 },
+       { 40, 1000 },
+       { 100, 1000 },
+       { 200, 1000 },
+       { 400, 1000 },
+       { 0, 0},
+};
+
+static const struct sr_rational vdivs[] = {
+       /* millivolts */
+       { 10, 1000 },
+       { 20, 1000 },
+       { 50, 1000 },
+       { 100, 1000 },
+       { 200, 1000 },
+       { 500, 1000 },
+       /* volts */
+       { 1, 1 },
+       { 2, 1 },
+       { 5, 1 },
+       { 0, 0 },
+};
+
+static const char *trigger_sources[] = {
+       "CH1",
+       "CH2",
+       "EXT",
+       NULL,
+};
+
+static const char *filter_targets[] = {
+       "CH1",
+       "CH2",
+       /* TODO: "TRIGGER", */
+       NULL,
+};
+
+static const char *coupling[] = {
+       "AC",
+       "DC",
+       "GND",
+       NULL,
+};
 
 SR_PRIV libusb_context *usb_context = NULL;
 SR_PRIV GSList *dev_insts = NULL;
 
-
-static struct sr_dev_inst *dso_dev_new(int index, struct dso_profile *prof)
+static struct sr_dev_inst *dso_dev_new(int index, const struct dso_profile *prof)
 {
        struct sr_dev_inst *sdi;
        struct context *ctx;
@@ -92,10 +164,9 @@ static struct sr_dev_inst *dso_dev_new(int index, struct dso_profile *prof)
        ctx->voffset_ch1 = DEFAULT_VERT_OFFSET;
        ctx->voffset_ch2 = DEFAULT_VERT_OFFSET;
        ctx->voffset_trigger = DEFAULT_VERT_TRIGGERPOS;
-       ctx->selected_channel = DEFAULT_SELECTED_CHANNEL;
        ctx->framesize = DEFAULT_FRAMESIZE;
        ctx->triggerslope = SLOPE_POSITIVE;
-       ctx->triggersource = DEFAULT_TRIGGER_SOURCE;
+       ctx->triggersource = g_strdup(DEFAULT_TRIGGER_SOURCE);
        ctx->triggerposition = DEFAULT_HORIZ_TRIGGERPOS;
        sdi->priv = ctx;
        dev_insts = g_slist_append(dev_insts, sdi);
@@ -103,16 +174,17 @@ static struct sr_dev_inst *dso_dev_new(int index, struct dso_profile *prof)
        return sdi;
 }
 
-static int configure_probes(struct context *ctx, GSList *probes)
+static int configure_probes(struct context *ctx, const GSList *probes)
 {
-       struct sr_probe *probe;
-       GSList *l;
+       const struct sr_probe *probe;
+       const GSList *l;
 
+       ctx->ch1_enabled = ctx->ch2_enabled = FALSE;
        for (l = probes; l; l = l->next) {
                probe = (struct sr_probe *)l->data;
-               if (probe->index == 0)
+               if (probe->index == 1)
                        ctx->ch1_enabled = probe->enabled;
-               else if (probe->index == 1)
+               else if (probe->index == 2)
                        ctx->ch2_enabled = probe->enabled;
        }
 
@@ -123,7 +195,7 @@ static int hw_init(const char *devinfo)
 {
        struct sr_dev_inst *sdi;
        struct libusb_device_descriptor des;
-       struct dso_profile *prof;
+       const struct dso_profile *prof;
        struct context *ctx;
        libusb_device **devlist;
        int err, devcnt, i, j;
@@ -269,6 +341,8 @@ static int hw_cleanup(void)
                }
                dso_close(sdi);
                sr_usb_dev_inst_free(ctx->usb);
+               g_free(ctx->triggersource);
+
                sr_dev_inst_free(sdi);
        }
 
@@ -282,11 +356,11 @@ static int hw_cleanup(void)
        return SR_OK;
 }
 
-static void *hw_get_device_info(int dev_index, int dev_info_id)
+static const void *hw_dev_info_get(int dev_index, int dev_info_id)
 {
        struct sr_dev_inst *sdi;
        struct context *ctx;
-       void *info;
+       const void *info;
        uint64_t tmp;
 
        if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
@@ -304,6 +378,24 @@ static void *hw_get_device_info(int dev_index, int dev_info_id)
        case SR_DI_PROBE_NAMES:
                info = probe_names;
                break;
+       case SR_DI_BUFFERSIZES:
+               info = buffersizes;
+               break;
+       case SR_DI_TIMEBASES:
+               info = timebases;
+               break;
+       case SR_DI_TRIGGER_SOURCES:
+               info = trigger_sources;
+               break;
+       case SR_DI_FILTERS:
+               info = filter_targets;
+               break;
+       case SR_DI_VDIVS:
+               info = vdivs;
+               break;
+       case SR_DI_COUPLING:
+               info = coupling;
+               break;
        /* TODO remove this */
        case SR_DI_CUR_SAMPLERATE:
                info = &tmp;
@@ -313,27 +405,30 @@ static void *hw_get_device_info(int dev_index, int dev_info_id)
        return info;
 }
 
-static int hw_get_status(int device_index)
+static int hw_dev_status_get(int dev_index)
 {
        struct sr_dev_inst *sdi;
 
-       if (!(sdi = sr_dev_inst_get(dev_insts, device_index)))
+       if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
                return SR_ST_NOT_FOUND;
 
        return sdi->status;
 }
 
-static int *hwcap_get_all(void)
+static const int *hw_hwcap_get_all(void)
 {
-
-       return capabilities;
+       return hwcaps;
 }
 
-static int hw_dev_config_set(int dev_index, int hwcap, void *value)
+static int hw_dev_config_set(int dev_index, int hwcap, const void *value)
 {
        struct sr_dev_inst *sdi;
        struct context *ctx;
-       int tmp, ret;
+       struct sr_rational tmp_rat;
+       float tmp_float;
+       uint64_t tmp_u64;
+       int ret, i;
+       char **targets;
 
        if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
                return SR_ERR;
@@ -341,19 +436,108 @@ static int hw_dev_config_set(int dev_index, int hwcap, void *value)
        if (sdi->status != SR_ST_ACTIVE)
                return SR_ERR;
 
+       ret = SR_OK;
        ctx = sdi->priv;
        switch (hwcap) {
        case SR_HWCAP_LIMIT_FRAMES:
-               ctx->limit_frames = *(uint64_t *)value;
+               ctx->limit_frames = *(const uint64_t *)value;
                break;
        case SR_HWCAP_PROBECONFIG:
-               ret = configure_probes(ctx, (GSList *) value);
+               ret = configure_probes(ctx, (const GSList *)value);
+               break;
+       case SR_HWCAP_TRIGGER_SLOPE:
+               tmp_u64 = *(const int *)value;
+               if (tmp_u64 != SLOPE_NEGATIVE && tmp_u64 != SLOPE_POSITIVE)
+                       ret = SR_ERR_ARG;
+               ctx->triggerslope = tmp_u64;
+               break;
+       case SR_HWCAP_HORIZ_TRIGGERPOS:
+               tmp_float = *(const float *)value;
+               if (tmp_float < 0.0 || tmp_float > 1.0) {
+                       sr_err("hantek-dso: trigger position should be between 0.0 and 1.0");
+                       ret = SR_ERR_ARG;
+               } else
+                       ctx->triggerposition = tmp_float;
+               break;
+       case SR_HWCAP_BUFFERSIZE:
+               tmp_u64 = *(const int *)value;
+               for (i = 0; buffersizes[i]; i++) {
+                       if (buffersizes[i] == tmp_u64) {
+                               ctx->framesize = tmp_u64;
+                               break;
+                       }
+               }
+               if (buffersizes[i] == 0)
+                       ret = SR_ERR_ARG;
+               break;
+       case SR_HWCAP_TIMEBASE:
+               tmp_rat = *(const struct sr_rational *)value;
+               for (i = 0; timebases[i].p && timebases[i].q; i++) {
+                       if (timebases[i].p == tmp_rat.p
+                                       && timebases[i].q == tmp_rat.q) {
+                               ctx->timebase = i;
+                               break;
+                       }
+               }
+               if (timebases[i].p == 0 && timebases[i].q == 0)
+                       ret = SR_ERR_ARG;
                break;
-       case SR_HWCAP_TRIGGERSLOPE:
-               tmp = *(int *)value;
-               if (tmp != SLOPE_NEGATIVE && tmp != SLOPE_POSITIVE)
+       case SR_HWCAP_TRIGGER_SOURCE:
+               for (i = 0; trigger_sources[i]; i++) {
+                       if (!strcmp(value, trigger_sources[i])) {
+                               ctx->triggersource = g_strdup(value);
+                               break;
+                       }
+               }
+               if (trigger_sources[i] == 0)
                        ret = SR_ERR_ARG;
-               ctx->triggerslope = tmp;
+               break;
+       case SR_HWCAP_FILTER:
+               ctx->filter_ch1 = ctx->filter_ch2 = ctx->filter_trigger = 0;
+               targets = g_strsplit(value, ",", 0);
+               for (i = 0; targets[i]; i++) {
+                       if (targets[i] == '\0')
+                               /* Empty filter string can be used to clear them all. */
+                               ;
+                       else if (!strcmp(targets[i], "CH1"))
+                               ctx->filter_ch1 = TRUE;
+                       else if (!strcmp(targets[i], "CH2"))
+                               ctx->filter_ch2 = TRUE;
+                       else if (!strcmp(targets[i], "TRIGGER"))
+                               ctx->filter_trigger = TRUE;
+                       else {
+                               sr_err("invalid filter target %s", targets[i]);
+                               ret = SR_ERR_ARG;
+                       }
+               }
+               g_strfreev(targets);
+               break;
+       case SR_HWCAP_VDIV:
+               /* TODO not supporting vdiv per channel yet */
+               tmp_rat = *(const struct sr_rational *)value;
+               for (i = 0; vdivs[i].p && vdivs[i].q; i++) {
+                       if (vdivs[i].p == tmp_rat.p
+                                       && vdivs[i].q == tmp_rat.q) {
+                               ctx->voltage_ch1 = i;
+                               ctx->voltage_ch2 = i;
+                               break;
+                       }
+               }
+               if (vdivs[i].p == 0 && vdivs[i].q == 0)
+                       ret = SR_ERR_ARG;
+               break;
+       case SR_HWCAP_COUPLING:
+               /* TODO not supporting coupling per channel yet */
+               for (i = 0; coupling[i]; i++) {
+                       if (!strcmp(value, coupling[i])) {
+                               ctx->coupling_ch1 = i;
+                               ctx->coupling_ch2 = i;
+                               break;
+                       }
+               }
+               if (coupling[i] == 0)
+                       ret = SR_ERR_ARG;
+               break;
        default:
                ret = SR_ERR_ARG;
        }
@@ -371,8 +555,8 @@ static void receive_transfer(struct libusb_transfer *transfer)
        struct sr_datafeed_packet packet;
        struct sr_datafeed_analog analog;
        struct context *ctx;
-       float ch1, ch2;
-       int i;
+       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",
@@ -385,17 +569,38 @@ static void receive_transfer(struct libusb_transfer *transfer)
        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.data = g_try_malloc(analog.num_samples * sizeof(float) * ctx->profile->num_probes);
+       analog.unit = SR_UNIT_VOLTAGE;
+       analog.data = g_try_malloc(analog.num_samples * sizeof(float) * num_probes);
+       data_offset = 0;
        for (i = 0; i < analog.num_samples; i++) {
-               /* Hardcoded for two channels, since the order/encoding is specific. */
+               /* 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 */
-               ch2 = (*(transfer->buffer + i * 2) / 255.0);
-               ch1 = (*(transfer->buffer + i * 2 + 1) / 255.0);
-               analog.data[i * ctx->profile->num_probes] = ch1;
-               analog.data[i * ctx->profile->num_probes + 1] = ch2;
+               if (ctx->ch1_enabled) {
+                       range = ((float)vdivs[ctx->voltage_ch1].p / vdivs[ctx->voltage_ch1].q) * 8;
+                       ch1 = range / 255 * *(transfer->buffer + i * 2 + 1);
+                       /* Value is centered around 0V. */
+                       ch1 -= range / 2;
+                       analog.data[data_offset++] = ch1;
+               }
+               if (ctx->ch2_enabled) {
+                       range = ((float)vdivs[ctx->voltage_ch2].p / vdivs[ctx->voltage_ch2].q) * 8;
+                       ch2 = range / 255 * *(transfer->buffer + i * 2);
+                       ch2 -= range / 2;
+                       analog.data[data_offset++] = ch2;
+               }
        }
        g_free(transfer->buffer);
        libusb_free_transfer(transfer);
@@ -408,6 +613,7 @@ static void receive_transfer(struct libusb_transfer *transfer)
 
                if (ctx->limit_frames && ++ctx->num_frames == ctx->limit_frames) {
                        /* Terminate session */
+                       /* TODO: don't leave pending USB transfers hanging */
                        packet.type = SR_DF_END;
                        sr_session_send(ctx->cb_data, &packet);
                } else {
@@ -440,8 +646,8 @@ static int handle_event(int fd, int revents, void *cb_data)
                        return TRUE;
                if (dso_enable_trigger(ctx) != SR_OK)
                        return TRUE;
-               if (dso_force_trigger(ctx) != SR_OK)
-                       return TRUE;
+//             if (dso_force_trigger(ctx) != SR_OK)
+//                     return TRUE;
                sr_dbg("hantek-dso: successfully requested next chunk");
                ctx->dev_state = CAPTURE;
                return TRUE;
@@ -463,8 +669,8 @@ static int handle_event(int fd, int revents, void *cb_data)
                                break;
                        if (dso_enable_trigger(ctx) != SR_OK)
                                break;
-                       if (dso_force_trigger(ctx) != SR_OK)
-                               break;
+//                     if (dso_force_trigger(ctx) != SR_OK)
+//                             break;
                        sr_dbg("hantek-dso: successfully requested next chunk");
                }
                break;
@@ -499,7 +705,7 @@ static int handle_event(int fd, int revents, void *cb_data)
        return TRUE;
 }
 
-static int hw_start_acquisition(int device_index, void *cb_data)
+static int hw_dev_acquisition_start(int dev_index, void *cb_data)
 {
        const struct libusb_pollfd **lupfd;
        struct sr_datafeed_packet packet;
@@ -509,7 +715,7 @@ static int hw_start_acquisition(int device_index, void *cb_data)
        struct context *ctx;
        int i;
 
-       if (!(sdi = sr_dev_inst_get(dev_insts, device_index)))
+       if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
                return SR_ERR;
 
        if (sdi->status != SR_ST_ACTIVE)
@@ -550,13 +756,13 @@ static int hw_start_acquisition(int device_index, void *cb_data)
 /* TODO: doesn't really cancel pending transfers so they might come in after
  * SR_DF_END is sent.
  */
-static int hw_stop_acquisition(int device_index, gpointer session_device_id)
+static int hw_dev_acquisition_stop(int dev_index, void *cb_data)
 {
        struct sr_datafeed_packet packet;
        struct sr_dev_inst *sdi;
        struct context *ctx;
 
-       if (!(sdi = sr_dev_inst_get(dev_insts, device_index)))
+       if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
                return SR_ERR;
 
        if (sdi->status != SR_ST_ACTIVE)
@@ -566,12 +772,12 @@ static int hw_stop_acquisition(int device_index, gpointer session_device_id)
        ctx->dev_state = IDLE;
 
        packet.type = SR_DF_END;
-       sr_session_send(session_device_id, &packet);
+       sr_session_send(cb_data, &packet);
 
        return SR_OK;
 }
 
-SR_PRIV struct sr_dev_driver hantek_dso_plugin_info = {
+SR_PRIV struct sr_dev_driver hantek_dso_driver_info = {
        .name = "hantek-dso",
        .longname = "Hantek DSO",
        .api_version = 1,
@@ -579,10 +785,10 @@ SR_PRIV struct sr_dev_driver hantek_dso_plugin_info = {
        .cleanup = hw_cleanup,
        .dev_open = hw_dev_open,
        .dev_close = hw_dev_close,
-       .dev_info_get = hw_get_device_info,
-       .dev_status_get = hw_get_status,
-       .hwcap_get_all = hwcap_get_all,
+       .dev_info_get = hw_dev_info_get,
+       .dev_status_get = hw_dev_status_get,
+       .hwcap_get_all = hw_hwcap_get_all,
        .dev_config_set = hw_dev_config_set,
-       .dev_acquisition_start = hw_start_acquisition,
-       .dev_acquisition_stop = hw_stop_acquisition,
+       .dev_acquisition_start = hw_dev_acquisition_start,
+       .dev_acquisition_stop = hw_dev_acquisition_stop,
 };