]> sigrok.org Git - libsigrok.git/blobdiff - src/hardware/rigol-ds/api.c
std_gvar_tuple_array(): Change to allow for more ARRAY_AND_SIZE usage.
[libsigrok.git] / src / hardware / rigol-ds / api.c
index 7f136a6bec654317852abeaefabafed94193d0f0..c2661a45ba96a7ee8d4dca5a4c48a1e615e64f92 100644 (file)
@@ -34,7 +34,7 @@
 
 static const uint32_t scanopts[] = {
        SR_CONF_CONN,
-       SR_CONF_SERIALCOMM
+       SR_CONF_SERIALCOMM,
 };
 
 static const uint32_t drvopts[] = {
@@ -53,7 +53,7 @@ static const uint32_t devopts[] = {
        SR_CONF_DATA_SOURCE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
 };
 
-static const uint32_t analog_devopts[] = {
+static const uint32_t devopts_cg_analog[] = {
        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,
@@ -126,56 +126,23 @@ static const uint64_t vdivs[][2] = {
        { 100, 1 },
 };
 
-#define NUM_TIMEBASE  ARRAY_SIZE(timebases)
-#define NUM_VDIV      ARRAY_SIZE(vdivs)
-
 static const char *trigger_sources[] = {
-       "CH1",
-       "CH2",
-       "CH3",
-       "CH4",
-       "EXT",
-       "AC Line",
-       "D0",
-       "D1",
-       "D2",
-       "D3",
-       "D4",
-       "D5",
-       "D6",
-       "D7",
-       "D8",
-       "D9",
-       "D10",
-       "D11",
-       "D12",
-       "D13",
-       "D14",
-       "D15",
+       "CH1", "CH2", "CH3", "CH4",
+       "EXT", "AC Line",
+       "D0", "D1", "D2", "D3", "D4", "D5", "D6", "D7",
+       "D8", "D9", "D10", "D11", "D12", "D13", "D14", "D15",
 };
 
 static const char *trigger_slopes[] = {
-       "r",
-       "f",
+       "r", "f",
 };
 
 static const char *coupling[] = {
-       "AC",
-       "DC",
-       "GND",
+       "AC", "DC", "GND",
 };
 
 static const uint64_t probe_factor[] = {
-       1,
-       2,
-       5,
-       10,
-       20,
-       50,
-       100,
-       200,
-       500,
-       1000,
+       1, 2, 5, 10, 20, 50, 100, 200, 500, 1000,
 };
 
 /* Do not change the order of entries */
@@ -206,8 +173,8 @@ static const struct rigol_ds_vendor supported_vendors[] = {
 };
 
 #define VENDOR(x) &supported_vendors[x]
-/* vendor, series, protocol, max timebase, min vdiv, number of horizontal divs,
- * live waveform samples, memory buffer samples */
+/* vendor, series/name, protocol, data format, max timebase, min vdiv,
+ * number of horizontal divs, live waveform samples, memory buffer samples */
 static const struct rigol_ds_series supported_series[] = {
        [VS5000] = {VENDOR(RIGOL), "VS5000", PROTOCOL_V1, FORMAT_RAW,
                {50, 1}, {2, 1000}, 14, 2048, 0},
@@ -250,6 +217,10 @@ static const struct rigol_ds_model supported_models[] = {
        {SERIES(DS2000A), "DS2102A", {5, 1000000000}, 2, false},
        {SERIES(DS2000A), "DS2202A", {2, 1000000000}, 2, false},
        {SERIES(DS2000A), "DS2302A", {1, 1000000000}, 2, false},
+       {SERIES(DS2000A), "MSO2072A", {5, 1000000000}, 2, true},
+       {SERIES(DS2000A), "MSO2102A", {5, 1000000000}, 2, true},
+       {SERIES(DS2000A), "MSO2202A", {2, 1000000000}, 2, true},
+       {SERIES(DS2000A), "MSO2302A", {1, 1000000000}, 2, true},
        {SERIES(DSO1000), "DSO1002A", {5, 1000000000}, 2, false},
        {SERIES(DSO1000), "DSO1004A", {5, 1000000000}, 4, false},
        {SERIES(DSO1000), "DSO1012A", {2, 1000000000}, 2, false},
@@ -271,12 +242,10 @@ static const struct rigol_ds_model supported_models[] = {
 
 static struct sr_dev_driver rigol_ds_driver_info;
 
-static void clear_helper(void *priv)
+static void clear_helper(struct dev_context *devc)
 {
-       struct dev_context *devc;
        unsigned int i;
 
-       devc = priv;
        g_free(devc->data);
        g_free(devc->buffer);
        for (i = 0; i < ARRAY_SIZE(devc->coupling); i++)
@@ -284,12 +253,11 @@ static void clear_helper(void *priv)
        g_free(devc->trigger_source);
        g_free(devc->trigger_slope);
        g_free(devc->analog_groups);
-       g_free(devc);
 }
 
 static int dev_clear(const struct sr_dev_driver *di)
 {
-       return std_dev_clear(di, clear_helper);
+       return std_dev_clear_with_callback(di, (std_dev_clear_callback)clear_helper);
 }
 
 static struct sr_dev_inst *probe_device(struct sr_scpi_dev_inst *scpi)
@@ -396,18 +364,18 @@ static struct sr_dev_inst *probe_device(struct sr_scpi_dev_inst *scpi)
                                devc->digital_group);
        }
 
-       for (i = 0; i < NUM_TIMEBASE; i++) {
+       for (i = 0; i < ARRAY_SIZE(timebases); i++) {
                if (!memcmp(&devc->model->min_timebase, &timebases[i], sizeof(uint64_t[2])))
                        devc->timebases = &timebases[i];
                if (!memcmp(&devc->model->series->max_timebase, &timebases[i], sizeof(uint64_t[2])))
                        devc->num_timebases = &timebases[i] - devc->timebases + 1;
        }
 
-       for (i = 0; i < NUM_VDIV; i++) {
+       for (i = 0; i < ARRAY_SIZE(vdivs); i++) {
                if (!memcmp(&devc->model->series->min_vdiv,
                                        &vdivs[i], sizeof(uint64_t[2]))) {
                        devc->vdivs = &vdivs[i];
-                       devc->num_vdivs = NUM_VDIV - i;
+                       devc->num_vdivs = ARRAY_SIZE(vdivs) - i;
                }
        }
 
@@ -441,8 +409,6 @@ static int dev_open(struct sr_dev_inst *sdi)
                return SR_ERR;
        }
 
-       sdi->status = SR_ST_ACTIVE;
-
        return SR_OK;
 }
 
@@ -451,22 +417,16 @@ static int dev_close(struct sr_dev_inst *sdi)
        struct sr_scpi_dev_inst *scpi;
        struct dev_context *devc;
 
-       if (sdi->status != SR_ST_ACTIVE)
-               return SR_ERR_DEV_CLOSED;
-
        scpi = sdi->conn;
        devc = sdi->priv;
 
+       if (!scpi)
+               return SR_ERR_BUG;
+
        if (devc->model->series->protocol == PROTOCOL_V2)
                rigol_ds_config_set(sdi, ":KEY:LOCK DISABLE");
 
-       if (scpi) {
-               if (sr_scpi_close(scpi) < 0)
-                       return SR_ERR;
-               sdi->status = SR_ST_INACTIVE;
-       }
-
-       return SR_OK;
+       return sr_scpi_close(scpi);
 }
 
 static int analog_frame_size(const struct sr_dev_inst *sdi)
@@ -666,9 +626,6 @@ static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sd
 
        devc = sdi->priv;
 
-       if (sdi->status != SR_ST_ACTIVE)
-               return SR_ERR_DEV_CLOSED;
-
        /* If a channel group is specified, it must be a valid one. */
        if (cg && !g_slist_find(sdi->channel_groups, cg)) {
                sr_err("Invalid channel group specified.");
@@ -757,10 +714,8 @@ static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sd
                }
                break;
        case SR_CONF_VDIV:
-               if (!cg) {
-                       sr_err("No channel group specified.");
+               if (!cg)
                        return SR_ERR_CHANNEL_GROUP;
-               }
                g_variant_get(data, "(tt)", &p, &q);
                for (i = 0; i < devc->model->analog_channels; i++) {
                        if (cg == devc->analog_groups[i]) {
@@ -780,10 +735,8 @@ static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sd
                sr_dbg("Didn't set vdiv, unknown channel(group).");
                return SR_ERR_NA;
        case SR_CONF_COUPLING:
-               if (!cg) {
-                       sr_err("No channel group specified.");
+               if (!cg)
                        return SR_ERR_CHANNEL_GROUP;
-               }
                tmp_str = g_variant_get_string(data, NULL);
                for (i = 0; i < devc->model->analog_channels; i++) {
                        if (cg == devc->analog_groups[i]) {
@@ -802,10 +755,8 @@ static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sd
                sr_dbg("Didn't set coupling, unknown channel(group).");
                return SR_ERR_NA;
        case SR_CONF_PROBE_FACTOR:
-               if (!cg) {
-                       sr_err("No channel group specified.");
+               if (!cg)
                        return SR_ERR_CHANNEL_GROUP;
-               }
                p = g_variant_get_uint64(data);
                for (i = 0; i < devc->model->analog_channels; i++) {
                        if (cg == devc->analog_groups[i]) {
@@ -850,54 +801,23 @@ static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sd
 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];
-       GVariantBuilder gvb;
        unsigned int i;
-       struct dev_context *devc = NULL;
-
-       /* SR_CONF_SCAN_OPTIONS is always valid, regardless of sdi or channel group. */
-       if (key == SR_CONF_SCAN_OPTIONS) {
-               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
-                               scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
-               return SR_OK;
-       }
-
-       /* If sdi is NULL, nothing except SR_CONF_DEVICE_OPTIONS can be provided. */
-       if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
-               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
-                               drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
-               return SR_OK;
-       }
-
-       /* Every other option requires a valid device instance. */
-       if (!sdi)
-               return SR_ERR_ARG;
-       devc = sdi->priv;
+       struct dev_context *devc;
 
-       /* If a channel group is specified, it must be a valid one. */
-       if (cg && !g_slist_find(sdi->channel_groups, cg)) {
-               sr_err("Invalid channel group specified.");
-               return SR_ERR;
-       }
+       devc = (sdi) ? sdi->priv : NULL;
 
        switch (key) {
+       case SR_CONF_SCAN_OPTIONS:
        case SR_CONF_DEVICE_OPTIONS:
-               if (!cg) {
-                       /* If cg is NULL, only the SR_CONF_DEVICE_OPTIONS that are not
-                        * specific to a channel group must be returned. */
-                       *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
-                                       devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
-                       return SR_OK;
-               }
+               if (!cg)
+                       return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
                if (cg == devc->digital_group) {
-                       *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
-                               NULL, 0, sizeof(uint32_t));
+                       *data = std_gvar_array_u32(NULL, 0);
                        return SR_OK;
                } else {
                        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));
+                                       *data = std_gvar_array_u32(ARRAY_AND_SIZE(devopts_cg_analog));
                                        return SR_OK;
                                }
                        }
@@ -905,36 +825,22 @@ static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *
                }
                break;
        case SR_CONF_COUPLING:
-               if (!cg) {
-                       sr_err("No channel group specified.");
+               if (!cg)
                        return SR_ERR_CHANNEL_GROUP;
-               }
-               *data = g_variant_new_strv(coupling, ARRAY_SIZE(coupling));
+               *data = g_variant_new_strv(ARRAY_AND_SIZE(coupling));
                break;
        case SR_CONF_PROBE_FACTOR:
-               if (!cg) {
-                       sr_err("No channel group specified.");
+               if (!cg)
                        return SR_ERR_CHANNEL_GROUP;
-               }
-               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT64,
-                       probe_factor, ARRAY_SIZE(probe_factor), sizeof(uint64_t));
+               *data = std_gvar_array_u64(ARRAY_AND_SIZE(probe_factor));
                break;
        case SR_CONF_VDIV:
                if (!devc)
                        /* Can't know this until we have the exact model. */
                        return SR_ERR_ARG;
-               if (!cg) {
-                       sr_err("No channel group specified.");
+               if (!cg)
                        return SR_ERR_CHANNEL_GROUP;
-               }
-               g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
-               for (i = 0; i < devc->num_vdivs; i++) {
-                       rational[0] = g_variant_new_uint64(devc->vdivs[i][0]);
-                       rational[1] = g_variant_new_uint64(devc->vdivs[i][1]);
-                       tuple = g_variant_new_tuple(rational, 2);
-                       g_variant_builder_add_value(&gvb, tuple);
-               }
-               *data = g_variant_builder_end(&gvb);
+               *data = std_gvar_tuple_array(devc->vdivs, devc->num_vdivs);
                break;
        case SR_CONF_TIMEBASE:
                if (!devc)
@@ -942,14 +848,7 @@ static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *
                        return SR_ERR_ARG;
                if (devc->num_timebases <= 0)
                        return SR_ERR_NA;
-               g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
-               for (i = 0; i < devc->num_timebases; i++) {
-                       rational[0] = g_variant_new_uint64(devc->timebases[i][0]);
-                       rational[1] = g_variant_new_uint64(devc->timebases[i][1]);
-                       tuple = g_variant_new_tuple(rational, 2);
-                       g_variant_builder_add_value(&gvb, tuple);
-               }
-               *data = g_variant_builder_end(&gvb);
+               *data = std_gvar_tuple_array(devc->timebases, devc->num_timebases);
                break;
        case SR_CONF_TRIGGER_SOURCE:
                if (!devc)
@@ -959,7 +858,7 @@ static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *
                                devc->model->has_digital ? ARRAY_SIZE(trigger_sources) : 4);
                break;
        case SR_CONF_TRIGGER_SLOPE:
-               *data = g_variant_new_strv(trigger_slopes, ARRAY_SIZE(trigger_slopes));
+               *data = g_variant_new_strv(ARRAY_AND_SIZE(trigger_slopes));
                break;
        case SR_CONF_DATA_SOURCE:
                if (!devc)
@@ -973,7 +872,7 @@ static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *
                        *data = g_variant_new_strv(data_sources, ARRAY_SIZE(data_sources) - 1);
                        break;
                default:
-                       *data = g_variant_new_strv(data_sources, ARRAY_SIZE(data_sources));
+                       *data = g_variant_new_strv(ARRAY_AND_SIZE(data_sources));
                        break;
                }
                break;
@@ -993,9 +892,6 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi)
        gboolean some_digital;
        GSList *l;
 
-       if (sdi->status != SR_ST_ACTIVE)
-               return SR_ERR_DEV_CLOSED;
-
        scpi = sdi->conn;
        devc = sdi->priv;
 
@@ -1017,10 +913,10 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi)
                                devc->analog_channels[ch->index] = ch->enabled;
                        }
                } else if (ch->type == SR_CHANNEL_LOGIC) {
-                       /* Only one list entry for DS1000D series. All channels are retrieved
-                        * together when this entry is processed. */
+                       /* Only one list entry for older protocols. All channels are
+                        * retrieved together when this entry is processed. */
                        if (ch->enabled && (
-                                               devc->model->series->protocol > PROTOCOL_V2 ||
+                                               devc->model->series->protocol > PROTOCOL_V3 ||
                                                !some_digital))
                                devc->enabled_channels = g_slist_append(
                                                devc->enabled_channels, ch);
@@ -1029,7 +925,7 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi)
                                /* Turn on LA module if currently off. */
                                if (!devc->la_enabled) {
                                        if (rigol_ds_config_set(sdi,
-                                                       devc->model->series->protocol >= PROTOCOL_V4 ?
+                                                       devc->model->series->protocol >= PROTOCOL_V3 ?
                                                                ":LA:STAT ON" : ":LA:DISP ON") != SR_OK)
                                                return SR_ERR;
                                        devc->la_enabled = TRUE;
@@ -1038,7 +934,7 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi)
                        if (ch->enabled != devc->digital_channels[ch->index]) {
                                /* Enabled channel is currently disabled, or vice versa. */
                                if (rigol_ds_config_set(sdi,
-                                               devc->model->series->protocol >= PROTOCOL_V4 ?
+                                               devc->model->series->protocol >= PROTOCOL_V3 ?
                                                        ":LA:DIG%d:DISP %s" : ":DIG%d:TURN %s", ch->index,
                                                ch->enabled ? "ON" : "OFF") != SR_OK)
                                        return SR_ERR;
@@ -1053,7 +949,7 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi)
        /* Turn off LA module if on and no digital channels selected. */
        if (devc->la_enabled && !some_digital)
                if (rigol_ds_config_set(sdi,
-                               devc->model->series->protocol >= PROTOCOL_V4 ?
+                               devc->model->series->protocol >= PROTOCOL_V3 ?
                                        ":LA:STAT OFF" : ":LA:DISP OFF") != SR_OK)
                        return SR_ERR;
 
@@ -1115,11 +1011,6 @@ static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 
        devc = sdi->priv;
 
-       if (sdi->status != SR_ST_ACTIVE) {
-               sr_err("Device inactive, can't stop acquisition.");
-               return SR_ERR;
-       }
-
        std_session_send_df_end(sdi);
 
        g_slist_free(devc->enabled_channels);