]> sigrok.org Git - libsigrok.git/blobdiff - hardware/rigol-ds1xx2/api.c
drivers: return SR_ERR_NA on unsupported config key
[libsigrok.git] / hardware / rigol-ds1xx2 / api.c
index 5d2e36b6b864714a1ea0140f30a0eef04b2bbac2..3abe0046621ead400878ee129867eceeb6246623 100644 (file)
@@ -2,6 +2,7 @@
  * This file is part of the libsigrok project.
  *
  * Copyright (C) 2012 Martin Ling <martin-git@earth.li>
+ * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
 #include "libsigrok-internal.h"
 #include "protocol.h"
 
-static const int hwcaps[] = {
+#define NUM_TIMEBASE  12
+#define NUM_VDIV      8
+
+static const int32_t hwcaps[] = {
        SR_CONF_OSCILLOSCOPE,
-       SR_CONF_LIMIT_SAMPLES,
        SR_CONF_TIMEBASE,
        SR_CONF_TRIGGER_SOURCE,
        SR_CONF_TRIGGER_SLOPE,
        SR_CONF_HORIZ_TRIGGERPOS,
        SR_CONF_VDIV,
        SR_CONF_COUPLING,
-       0,
+       SR_CONF_NUM_TIMEBASE,
+       SR_CONF_NUM_VDIV,
 };
 
-static const struct sr_rational timebases[] = {
+static const uint64_t timebases[][2] = {
        /* nanoseconds */
        { 2, 1000000000 },
        { 5, 1000000000 },
@@ -74,10 +78,9 @@ static const struct sr_rational timebases[] = {
        { 10, 1 },
        { 20, 1 },
        { 50, 1 },
-       { 0, 0},
 };
 
-static const struct sr_rational vdivs[] = {
+static const uint64_t vdivs[][2] = {
        /* millivolts */
        { 2, 1000 },
        { 5, 1000 },
@@ -92,7 +95,6 @@ static const struct sr_rational vdivs[] = {
        { 2, 1 },
        { 5, 1 },
        { 10, 1 },
-       { 0, 0 },
 };
 
 static const char *trigger_sources[] = {
@@ -100,21 +102,35 @@ static const char *trigger_sources[] = {
        "CH2",
        "EXT",
        "AC Line",
-       NULL,
+       "D0",
+       "D1",
+       "D2",
+       "D3",
+       "D4",
+       "D5",
+       "D6",
+       "D7",
+       "D8",
+       "D9",
+       "D10",
+       "D11",
+       "D12",
+       "D13",
+       "D14",
+       "D15",
 };
 
 static const char *coupling[] = {
        "AC",
        "DC",
        "GND",
-       NULL,
 };
 
 static const char *supported_models[] = {
        "DS1052E",
        "DS1102E",
        "DS1052D",
-       "DS1102D"
+       "DS1102D",
 };
 
 SR_PRIV struct sr_dev_driver rigol_ds1xx2_driver_info;
@@ -138,7 +154,10 @@ static int clear_instances(void)
                        continue;
 
                g_free(devc->device);
-               g_slist_free(devc->enabled_probes);
+               g_free(devc->coupling[0]);
+               g_free(devc->coupling[1]);
+               g_free(devc->trigger_source);
+               g_free(devc->trigger_slope);
                close(devc->fd);
 
                sr_dev_inst_free(sdi);
@@ -150,21 +169,33 @@ static int clear_instances(void)
        return SR_OK;
 }
 
-static int hw_init(struct sr_context *sr_ctx)
+static int set_cfg(const struct sr_dev_inst *sdi, const char *format, ...)
 {
-       struct drv_context *drvc;
-       (void)sr_ctx;
+       struct dev_context *devc;
+       va_list args;
+       char buf[256];
 
-       if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
-               sr_err("Driver context malloc failed.");
-               return SR_ERR_MALLOC;
-       }
+       devc = sdi->priv;
+
+       va_start(args, format);
+       vsnprintf(buf, 255, format, args);
+       va_end(args);
+       if (rigol_ds1xx2_send(devc, buf) != SR_OK)
+               return SR_ERR;
 
-       di->priv = drvc;
+       /* When setting a bunch of parameters in a row, the DS1052E scrambles
+        * some of them unless there is at least 100ms delay in between. */
+       sr_spew("delay %dms", 100);
+       g_usleep(100);
 
        return SR_OK;
 }
 
+static int hw_init(struct sr_context *sr_ctx)
+{
+       return std_hw_init(sr_ctx, di, DRIVER_LOG_DOMAIN);
+}
+
 static GSList *hw_scan(GSList *options)
 {
        struct drv_context *drvc;
@@ -178,20 +209,23 @@ static GSList *hw_scan(GSList *options)
        const gchar *prefix = "usbtmc";
        gchar *device;
        const gchar *idn_query = "*IDN?";
-       int len, num_tokens, fd, i;
+       unsigned int i;
+       int len, num_tokens, fd;
        const gchar *delimiter = ",";
        gchar **tokens;
        const char *manufacturer, *model, *version;
-       int num_models;
        gboolean matched = FALSE;
+       gboolean has_digital = FALSE;
        char buf[256];
+       gchar *channel_name;
 
        (void)options;
 
-       devices = NULL;
        drvc = di->priv;
        drvc->instances = NULL;
 
+       devices = NULL;
+
        dir = g_dir_open("/sys/class/usb/", 0, NULL);
 
        if (dir == NULL)
@@ -235,11 +269,10 @@ static GSList *hw_scan(GSList *options)
                        return NULL;
                }
 
-               num_models = sizeof(supported_models) / sizeof(supported_models[0]);
-
-               for (i = 0; i < num_models; i++) {
+               for (i = 0; i < ARRAY_SIZE(supported_models); i++) {
                        if (!strcmp(model, supported_models[i])) {
                                matched = 1;
+                               has_digital = g_str_has_suffix(model, "D");
                                break;
                        }
                }
@@ -258,19 +291,31 @@ static GSList *hw_scan(GSList *options)
                        g_free(device);
                        return NULL;
                }
-
+               devc->limit_frames = 0;
                devc->device = device;
-
+               devc->has_digital = has_digital;
                sdi->priv = devc;
                sdi->driver = di;
 
                for (i = 0; i < 2; i++) {
-                       if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE,
+                       if (!(probe = sr_probe_new(i, SR_PROBE_ANALOG, TRUE,
                            i == 0 ? "CH1" : "CH2")))
                                return NULL;
                        sdi->probes = g_slist_append(sdi->probes, probe);
                }
 
+               if (devc->has_digital) {
+                       for (i = 0; i < 16; i++) {
+                               if (!(channel_name = g_strdup_printf("D%d", i)))
+                                       return NULL;
+                               probe = sr_probe_new(i, SR_PROBE_LOGIC, TRUE, channel_name);
+                               g_free(channel_name);
+                               if (!probe)
+                                       return NULL;
+                               sdi->probes = g_slist_append(sdi->probes, probe);
+                       }
+               }
+
                drvc->instances = g_slist_append(drvc->instances, sdi);
                devices = g_slist_append(devices, sdi);
        }
@@ -282,11 +327,7 @@ static GSList *hw_scan(GSList *options)
 
 static GSList *hw_dev_list(void)
 {
-       struct drv_context *drvc;
-
-       drvc = di->priv;
-
-       return drvc->instances;
+       return ((struct drv_context *)(di->priv))->instances;
 }
 
 static int hw_dev_open(struct sr_dev_inst *sdi)
@@ -298,10 +339,11 @@ static int hw_dev_open(struct sr_dev_inst *sdi)
 
        if ((fd = open(devc->device, O_RDWR)) == -1)
                return SR_ERR;
-
        devc->fd = fd;
 
-       devc->scale = 1;
+       if (rigol_ds1xx2_get_dev_cfg(sdi) != SR_OK)
+               /* TODO: force configuration? */
+               return SR_ERR;
 
        return SR_OK;
 }
@@ -324,14 +366,33 @@ static int hw_cleanup(void)
        return SR_OK;
 }
 
-static int config_set(int id, const void *value, const struct sr_dev_inst *sdi)
+static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi)
+{
+
+       (void)sdi;
+
+       switch (id) {
+       case SR_CONF_NUM_TIMEBASE:
+               *data = g_variant_new_int32(NUM_TIMEBASE);
+               break;
+       case SR_CONF_NUM_VDIV:
+               *data = g_variant_new_int32(NUM_VDIV);
+               break;
+       default:
+               return SR_ERR_NA;
+       }
+
+       return SR_OK;
+}
+
+static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi)
 {
        struct dev_context *devc;
-       uint64_t tmp_u64;
-       float tmp_float;
-       struct sr_rational tmp_rat;
-       int ret, i, j;
-       char *channel;
+       uint64_t tmp_u64, p, q;
+       double t_dbl;
+       unsigned int i;
+       int ret;
+       const char *tmp_str;
 
        devc = sdi->priv;
 
@@ -343,145 +404,211 @@ static int config_set(int id, const void *value, const struct sr_dev_inst *sdi)
        ret = SR_OK;
        switch (id) {
        case SR_CONF_LIMIT_FRAMES:
-               devc->limit_frames = *(const uint64_t *)value;
+               devc->limit_frames = g_variant_get_uint64(data);
                break;
        case SR_CONF_TRIGGER_SLOPE:
-               tmp_u64 = *(const int *)value;
-               rigol_ds1xx2_send_data(devc->fd, ":TRIG:EDGE:SLOP %s\n",
-                                      tmp_u64 ? "POS" : "NEG");
+               tmp_u64 = g_variant_get_uint64(data);
+               if (tmp_u64 != 0 && tmp_u64 != 1)
+                       return SR_ERR;
+               g_free(devc->trigger_slope);
+               devc->trigger_slope = g_strdup(tmp_u64 ? "POS" : "NEG");
+               ret = set_cfg(sdi, ":TRIG:EDGE:SLOP %s", devc->trigger_slope);
                break;
        case SR_CONF_HORIZ_TRIGGERPOS:
-               tmp_float = *(const float *)value;
-               rigol_ds1xx2_send_data(devc->fd, ":TIM:OFFS %.9f\n", tmp_float);
+               t_dbl = g_variant_get_double(data);
+               if (t_dbl < 0.0 || t_dbl > 1.0)
+                       return SR_ERR;
+               devc->horiz_triggerpos = t_dbl;
+               /* We have the trigger offset as a percentage of the frame, but
+                * need to express this in seconds. */
+               t_dbl = -(devc->horiz_triggerpos - 0.5) * devc->timebase * NUM_TIMEBASE;
+               ret = set_cfg(sdi, ":TIM:OFFS %.6f", t_dbl);
                break;
        case SR_CONF_TIMEBASE:
-               tmp_rat = *(const struct sr_rational *)value;
-               rigol_ds1xx2_send_data(devc->fd, ":TIM:SCAL %.9f\n",
-                                      (float)tmp_rat.p / tmp_rat.q);
+               g_variant_get(data, "(tt)", &p, &q);
+               for (i = 0; i < ARRAY_SIZE(timebases); i++) {
+                       if (timebases[i][0] == p && timebases[i][1] == q) {
+                               devc->timebase = (float)p / q;
+                               ret = set_cfg(sdi, ":TIM:SCAL %.9f", devc->timebase);
+                               break;
+                       }
+               }
+               if (i == ARRAY_SIZE(timebases))
+                       ret = SR_ERR_ARG;
                break;
        case SR_CONF_TRIGGER_SOURCE:
-               if (!strcmp(value, "CH1"))
-                       channel = "CHAN1";
-               else if (!strcmp(value, "CH2"))
-                       channel = "CHAN2";
-               else if (!strcmp(value, "EXT"))
-                       channel = "EXT";
-               else if (!strcmp(value, "AC Line"))
-                       channel = "ACL";
-               else {
-                       ret = SR_ERR_ARG;
-                       break;
+               tmp_str = g_variant_get_string(data, NULL);
+               for (i = 0; i < ARRAY_SIZE(trigger_sources); i++) {
+                       if (!strcmp(trigger_sources[i], tmp_str)) {
+                               g_free(devc->trigger_source);
+                               devc->trigger_source = g_strdup(trigger_sources[i]);
+                               if (!strcmp(devc->trigger_source, "AC Line"))
+                                       tmp_str = "ACL";
+                               else if (!strcmp(devc->trigger_source, "CH1"))
+                                       tmp_str = "CHAN1";
+                               else if (!strcmp(devc->trigger_source, "CH2"))
+                                       tmp_str = "CHAN2";
+                               else
+                                       tmp_str = (char *)devc->trigger_source;
+                               ret = set_cfg(sdi, ":TRIG:EDGE:SOUR %s", tmp_str);
+                               break;
+                       }
                }
-               rigol_ds1xx2_send_data(devc->fd, ":TRIG:EDGE:SOUR %s\n", channel);
+               if (i == ARRAY_SIZE(trigger_sources))
+                       ret = SR_ERR_ARG;
                break;
        case SR_CONF_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) {
-                               devc->scale = (float)tmp_rat.p / tmp_rat.q;
-                               for (j = 0; j < 2; j++)
-                                       rigol_ds1xx2_send_data(devc->fd,
-                                        ":CHAN%d:SCAL %.3f\n", j, devc->scale);
-                               break;
-                       }
+               g_variant_get(data, "(tt)", &p, &q);
+               for (i = 0; i < ARRAY_SIZE(vdivs); i++) {
+                       if (vdivs[i][0] != p || vdivs[i][1] != q)
+                               continue;
+                       devc->vdiv[0] = devc->vdiv[1] = (float)p / q;
+                       set_cfg(sdi, ":CHAN1:SCAL %.3f", devc->vdiv[0]);
+                       ret = set_cfg(sdi, ":CHAN2:SCAL %.3f", devc->vdiv[1]);
+                       break;
                }
-               if (vdivs[i].p == 0 && vdivs[i].q == 0)
+               if (i == ARRAY_SIZE(vdivs))
                        ret = SR_ERR_ARG;
                break;
        case SR_CONF_COUPLING:
                /* TODO: Not supporting coupling per channel yet. */
-               for (i = 0; coupling[i]; i++) {
-                       if (!strcmp(value, coupling[i])) {
-                               for (j = 0; j < 2; j++)
-                                       rigol_ds1xx2_send_data(devc->fd,
-                                         ":CHAN%d:COUP %s\n", j, coupling[i]);
+               tmp_str = g_variant_get_string(data, NULL);
+               for (i = 0; i < ARRAY_SIZE(coupling); i++) {
+                       if (!strcmp(tmp_str, coupling[i])) {
+                               g_free(devc->coupling[0]);
+                               g_free(devc->coupling[1]);
+                               devc->coupling[0] = g_strdup(coupling[i]);
+                               devc->coupling[1] = g_strdup(coupling[i]);
+                               set_cfg(sdi, ":CHAN1:COUP %s", devc->coupling[0]);
+                               ret = set_cfg(sdi, ":CHAN2:COUP %s", devc->coupling[1]);
                                break;
                        }
                }
-               if (coupling[i] == 0)
+               if (i == ARRAY_SIZE(coupling))
                        ret = SR_ERR_ARG;
                break;
        default:
-               sr_err("Unknown hardware capability: %d.", id);
-               ret = SR_ERR_ARG;
+               ret = SR_ERR_NA;
                break;
        }
 
        return ret;
 }
 
-static int config_list(int key, const void **data, const struct sr_dev_inst *sdi)
+static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
 {
-
-       (void)sdi;
+       GVariant *tuple, *rational[2];
+       GVariantBuilder gvb;
+       unsigned int i;
+       struct dev_context *devc;
 
        switch (key) {
        case SR_CONF_DEVICE_OPTIONS:
-               *data = hwcaps;
+               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
+                               hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
                break;
        case SR_CONF_COUPLING:
-               *data = coupling;
+               *data = g_variant_new_strv(coupling, ARRAY_SIZE(coupling));
                break;
        case SR_CONF_VDIV:
-               *data = vdivs;
+               g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
+               for (i = 0; i < ARRAY_SIZE(vdivs); i++) {
+                       rational[0] = g_variant_new_uint64(vdivs[i][0]);
+                       rational[1] = g_variant_new_uint64(vdivs[i][1]);
+                       tuple = g_variant_new_tuple(rational, 2);
+                       g_variant_builder_add_value(&gvb, tuple);
+               }
+               *data = g_variant_builder_end(&gvb);
                break;
        case SR_CONF_TIMEBASE:
-               *data = timebases;
+               g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
+               for (i = 0; i < ARRAY_SIZE(timebases); i++) {
+                       rational[0] = g_variant_new_uint64(timebases[i][0]);
+                       rational[1] = g_variant_new_uint64(timebases[i][1]);
+                       tuple = g_variant_new_tuple(rational, 2);
+                       g_variant_builder_add_value(&gvb, tuple);
+               }
+               *data = g_variant_builder_end(&gvb);
                break;
        case SR_CONF_TRIGGER_SOURCE:
-               *data = trigger_sources;
+               if (!sdi || !sdi->priv)
+                       /* Can't know this until we have the exact model. */
+                       return SR_ERR_ARG;
+               devc = sdi->priv;
+               *data = g_variant_new_strv(trigger_sources,
+                               devc->has_digital ? ARRAY_SIZE(trigger_sources) : 4);
                break;
        default:
-               return SR_ERR_ARG;
+               return SR_ERR_NA;
        }
 
        return SR_OK;
 }
 
-static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
-                                   void *cb_data)
+static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
 {
        struct dev_context *devc;
-       struct sr_datafeed_packet packet;
-       struct sr_datafeed_header header;
-       char buf[256];
-       int len;
+       struct sr_probe *probe;
+       GSList *l;
+       char cmd[256];
 
        (void)cb_data;
 
        devc = sdi->priv;
 
-       devc->num_frames = 0;
+       for (l = sdi->probes; l; l = l->next) {
+               probe = l->data;
+               sr_dbg("handling probe %s", probe->name);
+               if (probe->type == SR_PROBE_ANALOG) {
+                       if (probe->enabled)
+                               devc->enabled_analog_probes = g_slist_append(
+                                               devc->enabled_analog_probes, probe);
+                       if (probe->enabled != devc->analog_channels[probe->index]) {
+                               /* Enabled channel is currently disabled, or vice versa. */
+                               sprintf(cmd, ":CHAN%d:DISP %s", probe->index + 1,
+                                               probe->enabled ? "ON" : "OFF");
+                               if (rigol_ds1xx2_send(devc, cmd) != SR_OK)
+                                       return SR_ERR;
+                       }
+               } else if (probe->type == SR_PROBE_LOGIC) {
+                       if (probe->enabled)
+                               devc->enabled_digital_probes = g_slist_append(
+                                               devc->enabled_digital_probes, probe);
+                       if (probe->enabled != devc->digital_channels[probe->index]) {
+                               /* Enabled channel is currently disabled, or vice versa. */
+                               sprintf(cmd, ":DIG%d:TURN %s", probe->index,
+                                               probe->enabled ? "ON" : "OFF");
+                               if (rigol_ds1xx2_send(devc, cmd) != SR_OK)
+                                       return SR_ERR;
+                       }
+               }
+       }
+       if (!devc->enabled_analog_probes && !devc->enabled_digital_probes)
+               return SR_ERR;
 
-       sr_source_add(devc->fd, G_IO_IN, 50, rigol_ds1xx2_receive_data, (void *)sdi);
+       sr_source_add(devc->fd, G_IO_IN, 50, rigol_ds1xx2_receive, (void *)sdi);
 
        /* Send header packet to the session bus. */
-       packet.type = SR_DF_HEADER;
-       packet.payload = (unsigned char *)&header;
-       header.feed_version = 1;
-       gettimeofday(&header.starttime, NULL);
-       sr_session_send(cb_data, &packet);
-
-       /* Hardcoded to CH1 only. */
-       devc->enabled_probes = g_slist_append(NULL, sdi->probes->data);
-       rigol_ds1xx2_send_data(devc->fd, ":CHAN1:SCAL?\n");
-       len = read(devc->fd, buf, sizeof(buf));
-       buf[len] = 0;
-       devc->scale = atof(buf);
-       sr_dbg("Scale is %.3f.", devc->scale);
-       rigol_ds1xx2_send_data(devc->fd, ":CHAN1:OFFS?\n");
-       len = read(devc->fd, buf, sizeof(buf));
-       buf[len] = 0;
-       devc->offset = atof(buf);
-       sr_dbg("Offset is %.6f.", devc->offset);
-       rigol_ds1xx2_send_data(devc->fd, ":WAV:DATA?\n");
+       std_session_send_df_header(cb_data, DRIVER_LOG_DOMAIN);
+
+       /* Fetch the first frame. */
+       if (devc->enabled_analog_probes) {
+               devc->channel_frame = devc->enabled_analog_probes->data;
+               if (rigol_ds1xx2_send(devc, ":WAV:DATA? CHAN%d",
+                               devc->channel_frame->index + 1) != SR_OK)
+                       return SR_ERR;
+       } else {
+               devc->channel_frame = devc->enabled_digital_probes->data;
+               if (rigol_ds1xx2_send(devc, ":WAV:DATA? DIG") != SR_OK)
+                       return SR_ERR;
+       }
+
+       devc->num_frame_bytes = 0;
 
        return SR_OK;
 }
 
-static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
+static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 {
        struct dev_context *devc;
 
@@ -494,6 +621,10 @@ static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
                return SR_ERR;
        }
 
+       g_slist_free(devc->enabled_analog_probes);
+       g_slist_free(devc->enabled_digital_probes);
+       devc->enabled_analog_probes = NULL;
+       devc->enabled_digital_probes = NULL;
        sr_source_remove(devc->fd);
 
        return SR_OK;
@@ -508,11 +639,12 @@ SR_PRIV struct sr_dev_driver rigol_ds1xx2_driver_info = {
        .scan = hw_scan,
        .dev_list = hw_dev_list,
        .dev_clear = clear_instances,
+       .config_get = config_get,
        .config_set = config_set,
        .config_list = config_list,
        .dev_open = hw_dev_open,
        .dev_close = hw_dev_close,
-       .dev_acquisition_start = hw_dev_acquisition_start,
-       .dev_acquisition_stop = hw_dev_acquisition_stop,
+       .dev_acquisition_start = dev_acquisition_start,
+       .dev_acquisition_stop = dev_acquisition_stop,
        .priv = NULL,
 };