]> sigrok.org Git - libsigrok.git/blobdiff - src/hardware/rigol-ds/api.c
rigol-ds: Add more debug output.
[libsigrok.git] / src / hardware / rigol-ds / api.c
index 872531f694159b3c0d57d9ad7f2b5df584efd7de..d748e6d490c0c8007a2d48d56630169cc4ef0a8f 100644 (file)
 #include "libsigrok-internal.h"
 #include "protocol.h"
 
-static const int32_t hwopts[] = {
+static const uint32_t scanopts[] = {
        SR_CONF_CONN,
        SR_CONF_SERIALCOMM
 };
 
-static const int32_t hwcaps[] = {
+static const uint32_t devopts[] = {
        SR_CONF_OSCILLOSCOPE,
-       SR_CONF_TIMEBASE,
-       SR_CONF_TRIGGER_SOURCE,
-       SR_CONF_TRIGGER_SLOPE,
-       SR_CONF_HORIZ_TRIGGERPOS,
-       SR_CONF_NUM_TIMEBASE,
-       SR_CONF_LIMIT_FRAMES,
-       SR_CONF_SAMPLERATE,
+       SR_CONF_LIMIT_FRAMES | SR_CONF_SET,
+       SR_CONF_TIMEBASE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
+       SR_CONF_TRIGGER_SOURCE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
+       SR_CONF_TRIGGER_SLOPE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
+       SR_CONF_HORIZ_TRIGGERPOS | SR_CONF_SET,
+       SR_CONF_NUM_TIMEBASE | SR_CONF_GET,
+       SR_CONF_SAMPLERATE | SR_CONF_GET,
 };
 
-static const int32_t analog_hwcaps[] = {
-       SR_CONF_NUM_VDIV,
-       SR_CONF_VDIV,
-       SR_CONF_COUPLING,
-       SR_CONF_DATA_SOURCE,
+static const uint32_t analog_devopts[] = {
+       SR_CONF_NUM_VDIV | SR_CONF_GET,
+       SR_CONF_VDIV | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
+       SR_CONF_COUPLING | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
+       SR_CONF_DATA_SOURCE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
 };
 
 static const uint64_t timebases[][2] = {
@@ -177,7 +177,7 @@ enum series {
 /* short name, full name */
 static const struct rigol_ds_vendor supported_vendors[] = {
        [RIGOL] = {"Rigol", "Rigol Technologies"},
-       [AGILENT] = {"Agilent", "Rigol Technologies"},
+       [AGILENT] = {"Agilent", "Agilent Technologies"},
 };
 
 #define VENDOR(x) &supported_vendors[x]
@@ -237,17 +237,18 @@ static struct sr_dev_driver *di = &rigol_ds_driver_info;
 static void clear_helper(void *priv)
 {
        struct dev_context *devc;
+       unsigned int i;
 
        devc = priv;
        g_free(devc->data);
        g_free(devc->buffer);
-       g_free(devc->coupling[0]);
-       g_free(devc->coupling[1]);
+       for (i = 0; i < ARRAY_SIZE(devc->coupling); i++)
+               g_free(devc->coupling[i]);
        g_free(devc->trigger_source);
        g_free(devc->trigger_slope);
-       g_slist_free(devc->analog_groups[0].channels);
-       g_slist_free(devc->analog_groups[1].channels);
-       g_slist_free(devc->digital_group.channels);
+       g_free(devc->analog_groups);
+       g_free(devc->digital_group);
+       g_free(devc);
 }
 
 static int dev_clear(void)
@@ -290,22 +291,21 @@ static struct sr_dev_inst *probe_device(struct sr_scpi_dev_inst *scpi)
                }
        }
 
-       if (!model || !(sdi = sr_dev_inst_new(0, SR_ST_ACTIVE,
-                                             model->series->vendor->name,
-                                                 model->name,
-                                                 hw_info->firmware_version))) {
+       if (!model) {
                sr_scpi_hw_info_free(hw_info);
                return NULL;
        }
 
+       sdi = g_malloc0(sizeof(struct sr_dev_inst));
+       sdi->status = SR_ST_ACTIVE;
+       sdi->vendor = g_strdup(model->series->vendor->name);
+       sdi->model = g_strdup(model->name);
+       sdi->version = g_strdup(hw_info->firmware_version);
        sdi->conn = scpi;
-
        sdi->driver = di;
        sdi->inst_type = SR_INST_SCPI;
-
-       if (!(devc = g_try_malloc0(sizeof(struct dev_context))))
-               return NULL;
-
+       sdi->serial_num = g_strdup(hw_info->serial_number);
+       devc = g_malloc0(sizeof(struct dev_context));
        devc->limit_frames = 0;
        devc->model = model;
        devc->format = model->series->format;
@@ -336,32 +336,38 @@ static struct sr_dev_inst *probe_device(struct sr_scpi_dev_inst *scpi)
 
        sr_scpi_hw_info_free(hw_info);
 
+       devc->analog_groups = g_malloc0(sizeof(struct sr_channel_group*) *
+                                       model->analog_channels);
+
        for (i = 0; i < model->analog_channels; i++) {
                if (!(channel_name = g_strdup_printf("CH%d", i + 1)))
                        return NULL;
                ch = sr_channel_new(i, SR_CHANNEL_ANALOG, TRUE, channel_name);
                sdi->channels = g_slist_append(sdi->channels, ch);
-               devc->analog_groups[i].name = channel_name;
-               devc->analog_groups[i].channels = g_slist_append(NULL, ch);
+
+               devc->analog_groups[i] = g_malloc0(sizeof(struct sr_channel_group));
+
+               devc->analog_groups[i]->name = channel_name;
+               devc->analog_groups[i]->channels = g_slist_append(NULL, ch);
                sdi->channel_groups = g_slist_append(sdi->channel_groups,
-                               &devc->analog_groups[i]);
+                               devc->analog_groups[i]);
        }
 
        if (devc->model->has_digital) {
-               for (i = 0; i < 16; i++) {
+               devc->digital_group = g_malloc0(sizeof(struct sr_channel_group*));
+
+               for (i = 0; i < ARRAY_SIZE(devc->digital_channels); i++) {
                        if (!(channel_name = g_strdup_printf("D%d", i)))
                                return NULL;
                        ch = sr_channel_new(i, SR_CHANNEL_LOGIC, TRUE, channel_name);
                        g_free(channel_name);
-                       if (!ch)
-                               return NULL;
                        sdi->channels = g_slist_append(sdi->channels, ch);
-                       devc->digital_group.channels = g_slist_append(
-                                       devc->digital_group.channels, ch);
+                       devc->digital_group->channels = g_slist_append(
+                                       devc->digital_group->channels, ch);
                }
-               devc->digital_group.name = "LA";
+               devc->digital_group->name = g_strdup("LA");
                sdi->channel_groups = g_slist_append(sdi->channel_groups,
-                               &devc->digital_group);
+                               devc->digital_group);
        }
 
        for (i = 0; i < NUM_TIMEBASE; i++) {
@@ -399,13 +405,18 @@ static GSList *dev_list(void)
 
 static int dev_open(struct sr_dev_inst *sdi)
 {
+       int ret;
        struct sr_scpi_dev_inst *scpi = sdi->conn;
 
-       if (sr_scpi_open(scpi) < 0)
+       if ((ret = sr_scpi_open(scpi)) < 0) {
+               sr_err("Failed to open SCPI device: %s.", sr_strerror(ret));
                return SR_ERR;
+       }
 
-       if (rigol_ds_get_dev_cfg(sdi) != SR_OK)
+       if ((ret = rigol_ds_get_dev_cfg(sdi)) < 0) {
+               sr_err("Failed to get device config: %s.", sr_strerror(ret));
                return SR_ERR;
+       }
 
        sdi->status = SR_ST_ACTIVE;
 
@@ -480,7 +491,7 @@ static int digital_frame_size(const struct sr_dev_inst *sdi)
        }
 }
 
-static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi,
+static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
                const struct sr_channel_group *cg)
 {
        struct dev_context *devc;
@@ -512,7 +523,7 @@ static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi,
                }
        }
 
-       switch (id) {
+       switch (key) {
        case SR_CONF_NUM_TIMEBASE:
                *data = g_variant_new_int32(devc->model->series->num_horizontal_divs);
                break;
@@ -532,6 +543,7 @@ static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi,
                                (devc->timebase * devc->model->series->num_horizontal_divs);
                        *data = g_variant_new_uint64(samplerate);
                } else {
+                       sr_dbg("Unknown data source: %d.", devc->data_source);
                        return SR_ERR_NA;
                }
                break;
@@ -551,12 +563,14 @@ static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi,
                *data = g_variant_new_string(tmp_str);
                break;
        case SR_CONF_TRIGGER_SLOPE:
-               if (!strcmp(devc->trigger_slope, "POS"))
+               if (!strncmp(devc->trigger_slope, "POS", 3)) {
                        tmp_str = "r";
-               else if (!strcmp(devc->trigger_slope, "NEG"))
+               } else if (!strncmp(devc->trigger_slope, "NEG", 3)) {
                        tmp_str = "f";
-               else
+               } else {
+                       sr_dbg("Unknown trigger slope: '%s'.", devc->trigger_slope);
                        return SR_ERR_NA;
+               }
                *data = g_variant_new_string(tmp_str);
                break;
        case SR_CONF_TIMEBASE:
@@ -568,14 +582,18 @@ static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi,
                                idx = i;
                        }
                }
-               if (idx < 0)
+               if (idx < 0) {
+                       sr_dbg("Negative timebase index: %d.", idx);
                        return SR_ERR_NA;
+               }
                *data = g_variant_new("(tt)", devc->timebases[idx][0],
                                              devc->timebases[idx][1]);
                break;
        case SR_CONF_VDIV:
-               if (analog_channel < 0)
+               if (analog_channel < 0) {
+                       sr_dbg("Negative analog channel: %d.", analog_channel);
                        return SR_ERR_NA;
+               }
                for (i = 0; i < ARRAY_SIZE(vdivs); i++) {
                        float vdiv = (float)vdivs[i][0] / vdivs[i][1];
                        float diff = fabs(devc->vdiv[analog_channel] - vdiv);
@@ -584,23 +602,28 @@ static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi,
                                idx = i;
                        }
                }
-               if (idx < 0)
+               if (idx < 0) {
+                       sr_dbg("Negative vdiv index: %d.", idx);
                        return SR_ERR_NA;
+               }
                *data = g_variant_new("(tt)", vdivs[idx][0], vdivs[idx][1]);
                break;
        case SR_CONF_COUPLING:
-               if (analog_channel < 0)
+               if (analog_channel < 0) {
+                       sr_dbg("Negative analog channel: %d.", analog_channel);
                        return SR_ERR_NA;
+               }
                *data = g_variant_new_string(devc->coupling[analog_channel]);
                break;
        default:
+               sr_dbg("Tried to get unknown config key: %d.", key);
                return SR_ERR_NA;
        }
 
        return SR_OK;
 }
 
-static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
+static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
                const struct sr_channel_group *cg)
 {
        struct dev_context *devc;
@@ -624,15 +647,18 @@ static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
        }
 
        ret = SR_OK;
-       switch (id) {
+       switch (key) {
        case SR_CONF_LIMIT_FRAMES:
                devc->limit_frames = g_variant_get_uint64(data);
                break;
        case SR_CONF_TRIGGER_SLOPE:
                tmp_str = g_variant_get_string(data, NULL);
 
-               if (!tmp_str || !(tmp_str[0] == 'f' || tmp_str[0] == 'r'))
+               if (!tmp_str || !(tmp_str[0] == 'f' || tmp_str[0] == 'r')) {
+                       sr_err("Unknown trigger slope: '%s'.",
+                              (tmp_str) ? tmp_str : "NULL");
                        return SR_ERR_ARG;
+               }
 
                g_free(devc->trigger_slope);
                devc->trigger_slope = g_strdup((tmp_str[0] == 'r') ? "POS" : "NEG");
@@ -640,8 +666,10 @@ static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
                break;
        case SR_CONF_HORIZ_TRIGGERPOS:
                t_dbl = g_variant_get_double(data);
-               if (t_dbl < 0.0 || t_dbl > 1.0)
+               if (t_dbl < 0.0 || t_dbl > 1.0) {
+                       sr_err("Invalid horiz. trigger position: %g.", t_dbl);
                        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. */
@@ -660,8 +688,10 @@ static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
                                break;
                        }
                }
-               if (i == devc->num_timebases)
+               if (i == devc->num_timebases) {
+                       sr_err("Invalid timebase index: %d.", i);
                        ret = SR_ERR_ARG;
+               }
                break;
        case SR_CONF_TRIGGER_SOURCE:
                tmp_str = g_variant_get_string(data, NULL);
@@ -685,8 +715,10 @@ static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
                                break;
                        }
                }
-               if (i == ARRAY_SIZE(trigger_sources))
+               if (i == ARRAY_SIZE(trigger_sources)) {
+                       sr_err("Invalid trigger source index: %d.", i);
                        ret = SR_ERR_ARG;
+               }
                break;
        case SR_CONF_VDIV:
                if (!cg) {
@@ -694,8 +726,8 @@ static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
                        return SR_ERR_CHANNEL_GROUP;
                }
                g_variant_get(data, "(tt)", &p, &q);
-               for (i = 0; i < 2; i++) {
-                       if (cg == &devc->analog_groups[i]) {
+               for (i = 0; i < devc->model->analog_channels; i++) {
+                       if (cg == devc->analog_groups[i]) {
                                for (j = 0; j < ARRAY_SIZE(vdivs); j++) {
                                        if (vdivs[j][0] != p || vdivs[j][1] != q)
                                                continue;
@@ -705,9 +737,11 @@ static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
                                        return rigol_ds_config_set(sdi, ":CHAN%d:SCAL %s", i + 1,
                                                        buffer);
                                }
+                               sr_err("Invalid vdiv index: %d.", j);
                                return SR_ERR_ARG;
                        }
                }
+               sr_dbg("Didn't set vdiv, unknown channel(group).");
                return SR_ERR_NA;
        case SR_CONF_COUPLING:
                if (!cg) {
@@ -715,8 +749,8 @@ static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
                        return SR_ERR_CHANNEL_GROUP;
                }
                tmp_str = g_variant_get_string(data, NULL);
-               for (i = 0; i < 2; i++) {
-                       if (cg == &devc->analog_groups[i]) {
+               for (i = 0; i < devc->model->analog_channels; i++) {
+                       if (cg == devc->analog_groups[i]) {
                                for (j = 0; j < ARRAY_SIZE(coupling); j++) {
                                        if (!strcmp(tmp_str, coupling[j])) {
                                                g_free(devc->coupling[i]);
@@ -725,9 +759,11 @@ static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
                                                                devc->coupling[i]);
                                        }
                                }
+                               sr_err("Invalid coupling index: %d.", j);
                                return SR_ERR_ARG;
                        }
                }
+               sr_dbg("Didn't set coupling, unknown channel(group).");
                return SR_ERR_NA;
        case SR_CONF_DATA_SOURCE:
                tmp_str = g_variant_get_string(data, NULL);
@@ -739,10 +775,13 @@ static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
                else if (devc->model->series->protocol >= PROTOCOL_V3
                         && !strcmp(tmp_str, "Segmented"))
                        devc->data_source = DATA_SOURCE_SEGMENTED;
-               else
+               else {
+                       sr_err("Unknown data source: '%s'.", tmp_str);
                        return SR_ERR;
+               }
                break;
        default:
+               sr_dbg("Tried to set unknown config key: %d.", key);
                ret = SR_ERR_NA;
                break;
        }
@@ -750,7 +789,7 @@ static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
        return ret;
 }
 
-static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
+static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
                const struct sr_channel_group *cg)
 {
        GVariant *tuple, *rational[2];
@@ -762,12 +801,12 @@ static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
                devc = sdi->priv;
 
        if (key == SR_CONF_SCAN_OPTIONS) {
-               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
-                               hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
+               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
+                               scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
                return SR_OK;
        } else if (key == SR_CONF_DEVICE_OPTIONS && cg == NULL) {
-               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
-                       hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
+               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
+                               devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
                return SR_OK;
        }
 
@@ -777,8 +816,10 @@ static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
 
        /* If a channel group is specified, it must be a valid one. */
        if (cg) {
-               if (cg != &devc->analog_groups[0]
-                               && cg != &devc->analog_groups[1]) {
+               for (i = 0; i < devc->model->analog_channels; i++)
+                       if (cg == devc->analog_groups[i])
+                               break;
+               if (i >= devc->model->analog_channels) {
                        sr_err("Invalid channel group specified.");
                        return SR_ERR;
                }
@@ -790,15 +831,15 @@ static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
                        sr_err("No channel group specified.");
                        return SR_ERR_CHANNEL_GROUP;
                }
-               if (cg == &devc->digital_group) {
-                       *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
-                               NULL, 0, sizeof(int32_t));
+               if (cg == devc->digital_group) {
+                       *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
+                               NULL, 0, sizeof(uint32_t));
                        return SR_OK;
                } else {
-                       for (i = 0; i < 2; i++) {
-                               if (cg == &devc->analog_groups[i]) {
-                                       *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
-                                               analog_hwcaps, ARRAY_SIZE(analog_hwcaps), sizeof(int32_t));
+                       for (i = 0; i < devc->model->analog_channels; i++) {
+                               if (cg == devc->analog_groups[i]) {
+                                       *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
+                                               analog_devopts, ARRAY_SIZE(analog_devopts), sizeof(uint32_t));
                                        return SR_OK;
                                }
                        }
@@ -871,6 +912,7 @@ static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
                }
                break;
        default:
+               sr_dbg("Tried to list unknown config key: %d.", key);
                return SR_ERR_NA;
        }