]> sigrok.org Git - libsigrok.git/blobdiff - src/hardware/rigol-ds/api.c
rigol-ds: Add DS1000Z series support.
[libsigrok.git] / src / hardware / rigol-ds / api.c
index 1c2a2ba18b0b3489c703475a30a4dd27bd5f79ae..60d63d5913956f50c20277faba9a2254fa6ba395 100644 (file)
@@ -39,17 +39,17 @@ static const uint32_t devopts[] = {
        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_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_NUM_HDIV | SR_CONF_GET,
        SR_CONF_SAMPLERATE | SR_CONF_GET,
+       SR_CONF_DATA_SOURCE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
 };
 
 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] = {
@@ -113,6 +113,9 @@ static const uint64_t vdivs[][2] = {
        { 2, 1 },
        { 5, 1 },
        { 10, 1 },
+       { 20, 1 },
+       { 50, 1 },
+       { 100, 1 },
 };
 
 #define NUM_TIMEBASE  ARRAY_SIZE(timebases)
@@ -172,6 +175,7 @@ enum series {
        DS2000,
        DS2000A,
        DSO1000,
+       DS1000Z,
 };
 
 /* short name, full name */
@@ -189,11 +193,13 @@ static const struct rigol_ds_series supported_series[] = {
        [DS1000] = {VENDOR(RIGOL), "DS1000", PROTOCOL_V2, FORMAT_IEEE488_2,
                {50, 1}, {2, 1000}, 12, 600, 1048576},
        [DS2000] = {VENDOR(RIGOL), "DS2000", PROTOCOL_V3, FORMAT_IEEE488_2,
-               {500, 1}, {2, 1000}, 14, 1400, 14000},
+               {500, 1}, {500, 1000000}, 14, 1400, 14000},
        [DS2000A] = {VENDOR(RIGOL), "DS2000A", PROTOCOL_V3, FORMAT_IEEE488_2,
                {1000, 1}, {500, 1000000}, 14, 1400, 14000},
        [DSO1000] = {VENDOR(AGILENT), "DSO1000", PROTOCOL_V3, FORMAT_IEEE488_2,
                {50, 1}, {2, 1000}, 12, 600, 20480},
+       [DS1000Z] = {VENDOR(RIGOL), "DS1000Z", PROTOCOL_V4, FORMAT_IEEE488_2,
+               {50, 1}, {1, 1000}, 12, 1200, 12000000},
 };
 
 #define SERIES(x) &supported_series[x]
@@ -229,6 +235,15 @@ static const struct rigol_ds_model supported_models[] = {
        {SERIES(DSO1000), "DSO1014A", {2, 1000000000}, 4, false},
        {SERIES(DSO1000), "DSO1022A", {2, 1000000000}, 2, false},
        {SERIES(DSO1000), "DSO1024A", {2, 1000000000}, 4, false},
+       {SERIES(DS1000Z), "DS1054Z", {5, 1000000000}, 4, false},
+       {SERIES(DS1000Z), "DS1074Z", {5, 1000000000}, 4, false},
+       {SERIES(DS1000Z), "DS1104Z", {5, 1000000000}, 4, false},
+       {SERIES(DS1000Z), "DS1074Z-S", {5, 1000000000}, 4, false},
+       {SERIES(DS1000Z), "DS1104Z-S", {5, 1000000000}, 4, false},
+       {SERIES(DS1000Z), "MSO1074Z", {5, 1000000000}, 4, true},
+       {SERIES(DS1000Z), "MSO1104Z", {5, 1000000000}, 4, true},
+       {SERIES(DS1000Z), "MSO1074Z-S", {5, 1000000000}, 4, true},
+       {SERIES(DS1000Z), "MSO1104Z-S", {5, 1000000000}, 4, true},
 };
 
 SR_PRIV struct sr_dev_driver rigol_ds_driver_info;
@@ -247,7 +262,6 @@ static void clear_helper(void *priv)
        g_free(devc->trigger_source);
        g_free(devc->trigger_slope);
        g_free(devc->analog_groups);
-       g_free(devc->digital_group);
        g_free(devc);
 }
 
@@ -342,8 +356,7 @@ static struct sr_dev_inst *probe_device(struct sr_scpi_dev_inst *scpi)
        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);
+               ch = sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, TRUE, channel_name);
 
                devc->analog_groups[i] = g_malloc0(sizeof(struct sr_channel_group));
 
@@ -354,14 +367,13 @@ static struct sr_dev_inst *probe_device(struct sr_scpi_dev_inst *scpi)
        }
 
        if (devc->model->has_digital) {
-               devc->digital_group = g_malloc0(sizeof(struct sr_channel_group*));
+               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);
+                       ch = sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE, channel_name);
                        g_free(channel_name);
-                       sdi->channels = g_slist_append(sdi->channels, ch);
                        devc->digital_group->channels = g_slist_append(
                                        devc->digital_group->channels, ch);
                }
@@ -378,8 +390,10 @@ static struct sr_dev_inst *probe_device(struct sr_scpi_dev_inst *scpi)
        }
 
        for (i = 0; i < NUM_VDIV; i++)
-               if (!memcmp(&devc->model->series->min_vdiv, &vdivs[i], sizeof(uint64_t[2])))
+               if (!memcmp(&devc->model->series->min_vdiv, &vdivs[i], sizeof(uint64_t[2]))) {
                        devc->vdivs = &vdivs[i];
+                       devc->num_vdivs = NUM_VDIV - i;
+               }
 
        if (!(devc->buffer = g_try_malloc(ACQ_BUFFER_SIZE)))
                return NULL;
@@ -405,13 +419,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;
 
@@ -494,7 +513,7 @@ static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *s
        const char *tmp_str;
        uint64_t samplerate;
        int analog_channel = -1;
-       float smallest_diff = 0.0000000001;
+       float smallest_diff = INFINITY;
        int idx = -1;
        unsigned i;
 
@@ -519,11 +538,12 @@ static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *s
        }
 
        switch (key) {
-       case SR_CONF_NUM_TIMEBASE:
+       case SR_CONF_NUM_HDIV:
                *data = g_variant_new_int32(devc->model->series->num_horizontal_divs);
                break;
        case SR_CONF_NUM_VDIV:
-               *data = g_variant_new_int32(NUM_VDIV);
+               *data = g_variant_new_int32(devc->num_vdivs);
+               break;
        case SR_CONF_DATA_SOURCE:
                if (devc->data_source == DATA_SOURCE_LIVE)
                        *data = g_variant_new_string("Live");
@@ -538,6 +558,7 @@ static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *s
                                (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;
@@ -557,12 +578,14 @@ static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *s
                *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:
@@ -574,14 +597,18 @@ static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *s
                                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);
@@ -590,16 +617,21 @@ static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *s
                                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;
        }
 
@@ -637,8 +669,11 @@ static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sd
        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");
@@ -646,8 +681,10 @@ static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sd
                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. */
@@ -666,8 +703,10 @@ static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sd
                                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);
@@ -691,8 +730,10 @@ static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sd
                                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) {
@@ -711,9 +752,11 @@ static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sd
                                        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) {
@@ -731,9 +774,11 @@ static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sd
                                                                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);
@@ -745,10 +790,13 @@ static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sd
                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;
        }
@@ -782,14 +830,9 @@ static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *
                return SR_ERR_ARG;
 
        /* If a channel group is specified, it must be a valid one. */
-       if (cg) {
-               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;
-               }
+       if (cg && !g_slist_find(sdi->channel_groups, cg)) {
+               sr_err("Invalid channel group specified.");
+               return SR_ERR;
        }
 
        switch (key) {
@@ -829,7 +872,7 @@ static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *
                        return SR_ERR_CHANNEL_GROUP;
                }
                g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
-               for (i = 0; i < NUM_VDIV; i++) {
+               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);
@@ -879,6 +922,7 @@ static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *
                }
                break;
        default:
+               sr_dbg("Tried to list unknown config key: %d.", key);
                return SR_ERR_NA;
        }
 
@@ -891,6 +935,7 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
        struct dev_context *devc;
        struct sr_channel *ch;
        struct sr_datafeed_packet packet;
+       gboolean some_digital;
        GSList *l;
 
        if (sdi->status != SR_ST_ACTIVE)
@@ -901,13 +946,14 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
 
        devc->num_frames = 0;
 
+       some_digital = FALSE;
        for (l = sdi->channels; l; l = l->next) {
                ch = l->data;
                sr_dbg("handling channel %s", ch->name);
                if (ch->type == SR_CHANNEL_ANALOG) {
                        if (ch->enabled)
-                               devc->enabled_analog_channels = g_slist_append(
-                                               devc->enabled_analog_channels, ch);
+                               devc->enabled_channels = g_slist_append(
+                                               devc->enabled_channels, ch);
                        if (ch->enabled != devc->analog_channels[ch->index]) {
                                /* Enabled channel is currently disabled, or vice versa. */
                                if (rigol_ds_config_set(sdi, ":CHAN%d:DISP %s", ch->index + 1,
@@ -916,19 +962,29 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
                                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. */
+                       if (ch->enabled && (
+                                               devc->model->series->protocol > PROTOCOL_V2 ||
+                                               !some_digital))
+                               devc->enabled_channels = g_slist_append(
+                                               devc->enabled_channels, ch);
                        if (ch->enabled) {
-                               devc->enabled_digital_channels = g_slist_append(
-                                               devc->enabled_digital_channels, ch);
+                               some_digital = TRUE;
                                /* Turn on LA module if currently off. */
                                if (!devc->la_enabled) {
-                                       if (rigol_ds_config_set(sdi, ":LA:DISP ON") != SR_OK)
+                                       if (rigol_ds_config_set(sdi,
+                                                       devc->model->series->protocol >= PROTOCOL_V4 ?
+                                                               ":LA:STAT ON" : ":LA:DISP ON") != SR_OK)
                                                return SR_ERR;
                                        devc->la_enabled = TRUE;
                                }
                        }
                        if (ch->enabled != devc->digital_channels[ch->index]) {
                                /* Enabled channel is currently disabled, or vice versa. */
-                               if (rigol_ds_config_set(sdi, ":DIG%d:TURN %s", ch->index,
+                               if (rigol_ds_config_set(sdi,
+                                               devc->model->series->protocol >= PROTOCOL_V4 ?
+                                                       ":LA:DIG%d:DISP %s" : ":DIG%d:TURN %s", ch->index,
                                                ch->enabled ? "ON" : "OFF") != SR_OK)
                                        return SR_ERR;
                                devc->digital_channels[ch->index] = ch->enabled;
@@ -936,12 +992,14 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
                }
        }
 
-       if (!devc->enabled_analog_channels && !devc->enabled_digital_channels)
+       if (!devc->enabled_channels)
                return SR_ERR;
 
        /* Turn off LA module if on and no digital channels selected. */
-       if (devc->la_enabled && !devc->enabled_digital_channels)
-               if (rigol_ds_config_set(sdi, ":LA:DISP OFF") != SR_OK)
+       if (devc->la_enabled && !some_digital)
+               if (rigol_ds_config_set(sdi,
+                               devc->model->series->protocol >= PROTOCOL_V4 ?
+                                       ":LA:STAT OFF" : ":LA:DISP OFF") != SR_OK)
                        return SR_ERR;
 
        /* Set memory mode. */
@@ -984,10 +1042,7 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
        /* Send header packet to the session bus. */
        std_session_send_df_header(cb_data, LOG_PREFIX);
 
-       if (devc->enabled_analog_channels)
-               devc->channel_entry = devc->enabled_analog_channels;
-       else
-               devc->channel_entry = devc->enabled_digital_channels;
+       devc->channel_entry = devc->enabled_channels;
 
        if (rigol_ds_capture_start(sdi) != SR_OK)
                return SR_ERR;
@@ -1018,10 +1073,8 @@ static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
        packet.type = SR_DF_END;
        sr_session_send(sdi, &packet);
 
-       g_slist_free(devc->enabled_analog_channels);
-       g_slist_free(devc->enabled_digital_channels);
-       devc->enabled_analog_channels = NULL;
-       devc->enabled_digital_channels = NULL;
+       g_slist_free(devc->enabled_channels);
+       devc->enabled_channels = NULL;
        scpi = sdi->conn;
        sr_scpi_source_remove(sdi->session, scpi);