]> sigrok.org Git - libsigrok.git/blobdiff - src/hardware/lecroy-xstream/protocol.c
lecroy-xstream: Fix COMM_HEADER and COMM_FORMAT
[libsigrok.git] / src / hardware / lecroy-xstream / protocol.c
index bf89f14cb8cecfc89fbfafdeabd28940cb1c373e..63459d0b8cb412daf850a7841ba59041c10f04c2 100644 (file)
 #include "scpi.h"
 #include "protocol.h"
 
-SR_PRIV void lecroy_queue_logic_data(struct dev_context *devc,
-                                 size_t group, GByteArray *pod_data);
-SR_PRIV void lecroy_send_logic_packet(struct sr_dev_inst *sdi,
-                                  struct dev_context *devc);
-SR_PRIV void lecroy_cleanup_logic_data(struct dev_context *devc);
-
 struct lecroy_wavedesc_2_x {
        uint16_t comm_type;
        uint16_t comm_order; /* 1 - little endian */
@@ -80,49 +74,23 @@ struct lecroy_wavedesc {
        };
 } __attribute__((packed));
 
-static const uint32_t lecroy_devopts[] = {
-       SR_CONF_OSCILLOSCOPE,
-       SR_CONF_LIMIT_FRAMES | SR_CONF_GET | SR_CONF_SET,
-       SR_CONF_TRIGGER_SOURCE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
-       SR_CONF_TIMEBASE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
-       SR_CONF_NUM_HDIV | SR_CONF_GET,
-       SR_CONF_TRIGGER_SLOPE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
-       SR_CONF_HORIZ_TRIGGERPOS | SR_CONF_GET | SR_CONF_SET,
-       SR_CONF_SAMPLERATE | SR_CONF_GET,
-};
-
-static const uint32_t lecroy_analog_devopts[] = {
-       SR_CONF_NUM_VDIV | SR_CONF_GET,
-       SR_CONF_COUPLING | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
-       SR_CONF_VDIV | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
-};
-
-static const char *lecroy_coupling_options[] = {
+static const char *coupling_options[] = {
        "A1M", // AC with 1 MOhm termination
-       "D50",  // DC with 50 Ohm termination
+       "D50", // DC with 50 Ohm termination
        "D1M", // DC with 1 MOhm termination
        "GND",
        "OVL",
-       NULL,
 };
 
 static const char *scope_trigger_slopes[] = {
-       "POS",
-       "NEG",
-       NULL,
+       "POS", "NEG",
 };
 
-static const char *lecroy_xstream_trigger_sources[] = {
-       "C1",
-       "C2",
-       "C3",
-       "C4",
-       "LINE",
-       "EXT",
-       NULL,
+static const char *trigger_sources[] = {
+       "C1", "C2", "C3", "C4", "LINE", "EXT",
 };
 
-static const struct sr_rational lecroy_timebases[] = {
+static const uint64_t timebases[][2] = {
        /* picoseconds */
        { 20, 1000000000000 },
        { 50, 1000000000000 },
@@ -172,7 +140,7 @@ static const struct sr_rational lecroy_timebases[] = {
        { 1000, 1 },
 };
 
-static const struct sr_rational lecroy_vdivs[] = {
+static const uint64_t vdivs[][2] = {
        /* millivolts */
        { 1, 1000 },
        { 2, 1000 },
@@ -193,10 +161,7 @@ static const struct sr_rational lecroy_vdivs[] = {
 };
 
 static const char *scope_analog_channel_names[] = {
-       "CH1",
-       "CH2",
-       "CH3",
-       "CH4",
+       "CH1", "CH2", "CH3", "CH4",
 };
 
 static const struct scope_config scope_models[] = {
@@ -206,21 +171,20 @@ static const struct scope_config scope_models[] = {
                .analog_channels = 4,
                .analog_names = &scope_analog_channel_names,
 
-               .devopts = &lecroy_devopts,
-               .num_devopts = ARRAY_SIZE(lecroy_devopts),
+               .coupling_options = &coupling_options,
+               .num_coupling_options = ARRAY_SIZE(coupling_options),
 
-               .analog_devopts = &lecroy_analog_devopts,
-               .num_analog_devopts = ARRAY_SIZE(lecroy_analog_devopts),
+               .trigger_sources = &trigger_sources,
+               .num_trigger_sources = ARRAY_SIZE(trigger_sources),
 
-               .coupling_options = &lecroy_coupling_options,
-               .trigger_sources = &lecroy_xstream_trigger_sources,
                .trigger_slopes = &scope_trigger_slopes,
+               .num_trigger_slopes = ARRAY_SIZE(scope_trigger_slopes),
 
-               .timebases = lecroy_timebases,
-               .num_timebases = ARRAY_SIZE(lecroy_timebases),
+               .timebases = &timebases,
+               .num_timebases = ARRAY_SIZE(timebases),
 
-               .vdivs = lecroy_vdivs,
-               .num_vdivs = ARRAY_SIZE(lecroy_vdivs),
+               .vdivs = &vdivs,
+               .num_vdivs = ARRAY_SIZE(vdivs),
 
                .num_xdivs = 10,
                .num_ydivs = 8,
@@ -234,16 +198,16 @@ static void scope_state_dump(const struct scope_config *config,
        char *tmp;
 
        for (i = 0; i < config->analog_channels; i++) {
-               tmp = sr_voltage_string(config->vdivs[state->analog_channels[i].vdiv].p,
-                                       config->vdivs[state->analog_channels[i].vdiv].q);
+               tmp = sr_voltage_string((*config->vdivs)[state->analog_channels[i].vdiv][0],
+                                       (*config->vdivs)[state->analog_channels[i].vdiv][1]);
                sr_info("State of analog channel %d -> %s : %s (coupling) %s (vdiv) %2.2e (offset)",
                        i + 1, state->analog_channels[i].state ? "On" : "Off",
                        (*config->coupling_options)[state->analog_channels[i].coupling],
                        tmp, state->analog_channels[i].vertical_offset);
        }
 
-       tmp = sr_period_string_f(1.0/(((float)config->timebases[state->timebase].p) /
-                                     ((float)config->timebases[state->timebase].q)), 0);
+       tmp = sr_period_string((*config->timebases)[state->timebase][0],
+                               (*config->timebases)[state->timebase][1]);
        sr_info("Current timebase: %s", tmp);
        g_free(tmp);
 
@@ -258,12 +222,11 @@ static void scope_state_dump(const struct scope_config *config,
 }
 
 static int scope_state_get_array_option(const char *resp,
-                                       const char *(*array)[],
-                                       int *result)
+       const char *(*array)[], unsigned int n, int *result)
 {
        unsigned int i;
 
-       for (i = 0; (*array)[i]; i++) {
+       for (i = 0; i < n; i++) {
                if (!g_strcmp0(resp, (*array)[i])) {
                        *result = i;
                        return SR_OK;
@@ -284,16 +247,18 @@ static int scope_state_get_array_option(const char *resp,
  *
  * @return SR_ERR on any parsing error, SR_OK otherwise.
  */
-static int array_float_get(gchar *value, const struct sr_rational *aval,
+static int array_float_get(gchar *value, const uint64_t array[][2],
                int array_len, unsigned int *result)
 {
        struct sr_rational rval;
+       struct sr_rational aval;
 
        if (sr_parse_rational(value, &rval) != SR_OK)
                return SR_ERR;
 
        for (int i = 0; i < array_len; i++) {
-               if (sr_rational_eq(&rval, aval+i)) {
+               sr_rational_set(&aval, array[i][0], array[i][1]);
+               if (sr_rational_eq(&rval, &aval)) {
                        *result = i;
                        return SR_OK;
                }
@@ -311,19 +276,18 @@ static int analog_channel_state_get(struct sr_scpi_dev_inst *scpi,
        char *tmp_str;
 
        for (i = 0; i < config->analog_channels; i++) {
-               g_snprintf(command, sizeof(command), "C%d:TRACE?", i+1);
+               g_snprintf(command, sizeof(command), "C%d:TRACE?", i + 1);
 
                if (sr_scpi_get_bool(scpi, command,
-                                       &state->analog_channels[i].state) != SR_OK)
+                               &state->analog_channels[i].state) != SR_OK)
                        return SR_ERR;
 
-               g_snprintf(command, sizeof(command), "C%d:VDIV?", i+1);
+               g_snprintf(command, sizeof(command), "C%d:VDIV?", i + 1);
 
                if (sr_scpi_get_string(scpi, command, &tmp_str) != SR_OK)
                        return SR_ERR;
 
-                if (array_float_get(tmp_str, lecroy_vdivs, ARRAY_SIZE(lecroy_vdivs),
-                                   &j) != SR_OK) {
+                if (array_float_get(tmp_str, ARRAY_AND_SIZE(vdivs), &j) != SR_OK) {
                        g_free(tmp_str);
                        sr_err("Could not determine array index for vertical div scale.");
                        return SR_ERR;
@@ -332,19 +296,20 @@ static int analog_channel_state_get(struct sr_scpi_dev_inst *scpi,
                g_free(tmp_str);
                state->analog_channels[i].vdiv = j;
 
-               g_snprintf(command, sizeof(command), "C%d:OFFSET?", i+1);
+               g_snprintf(command, sizeof(command), "C%d:OFFSET?", i + 1);
 
                if (sr_scpi_get_float(scpi, command, &state->analog_channels[i].vertical_offset) != SR_OK)
                        return SR_ERR;
 
-               g_snprintf(command, sizeof(command), "C%d:COUPLING?", i+1);
+               g_snprintf(command, sizeof(command), "C%d:COUPLING?", i + 1);
 
                if (sr_scpi_get_string(scpi, command, &tmp_str) != SR_OK)
                        return SR_ERR;
 
 
                if (scope_state_get_array_option(tmp_str, config->coupling_options,
-                                        &state->analog_channels[i].coupling) != SR_OK)
+                                config->num_coupling_options,
+                                &state->analog_channels[i].coupling) != SR_OK)
                        return SR_ERR;
 
                g_free(tmp_str);
@@ -365,12 +330,12 @@ SR_PRIV int lecroy_xstream_update_sample_rate(const struct sr_dev_inst *sdi)
        config = devc->model_config;
 
        if (sr_scpi_get_float(sdi->conn, "MEMORY_SIZE?", &memsize) != SR_OK)
-                       return SR_ERR;
+               return SR_ERR;
 
        if (sr_scpi_get_float(sdi->conn, "TIME_DIV?", &timediv) != SR_OK)
                return SR_ERR;
 
-       state->sample_rate = 1/((timediv * config->num_xdivs) / memsize);
+       state->sample_rate = 1 / ((timediv * config->num_xdivs) / memsize);
 
        return SR_OK;
 }
@@ -378,8 +343,8 @@ SR_PRIV int lecroy_xstream_update_sample_rate(const struct sr_dev_inst *sdi)
 SR_PRIV int lecroy_xstream_state_get(struct sr_dev_inst *sdi)
 {
        struct dev_context *devc;
-       struct scope_state *state
-;      const struct scope_config *config;
+       struct scope_state *state;
+       const struct scope_config *config;
        unsigned int i;
        char *tmp_str, *tmp_str2, *tmpp, *p, *key;
        char command[MAX_COMMAND_SIZE];
@@ -397,8 +362,7 @@ SR_PRIV int lecroy_xstream_state_get(struct sr_dev_inst *sdi)
        if (sr_scpi_get_string(sdi->conn, "TIME_DIV?", &tmp_str) != SR_OK)
                return SR_ERR;
 
-       if (array_float_get(tmp_str, lecroy_timebases, ARRAY_SIZE(lecroy_timebases),
-                           &i) != SR_OK) {
+       if (array_float_get(tmp_str, ARRAY_AND_SIZE(timebases), &i) != SR_OK) {
                g_free(tmp_str);
                sr_err("Could not determine array index for timbase scale.");
                return SR_ERR;
@@ -412,7 +376,7 @@ SR_PRIV int lecroy_xstream_state_get(struct sr_dev_inst *sdi)
        key = tmpp = NULL;
        tmp_str2 = tmp_str;
        i = 0;
-       while((p = strtok_r(tmp_str2, ",", &tmpp))) {
+       while ((p = strtok_r(tmp_str2, ",", &tmpp))) {
                tmp_str2 = NULL;
                if (i == 0) {
                        /* trigger type */
@@ -426,17 +390,15 @@ SR_PRIV int lecroy_xstream_state_get(struct sr_dev_inst *sdi)
                i++;
        }
 
-       if (!trig_source || scope_state_get_array_option(trig_source, config->trigger_sources,
-                                                       &state->trigger_source) != SR_OK)
+       if (!trig_source || scope_state_get_array_option(trig_source, config->trigger_sources, config->num_trigger_sources, &state->trigger_source) != SR_OK)
                return SR_ERR;
 
-
        g_snprintf(command, sizeof(command), "%s:TRIG_SLOPE?", trig_source);
        if (sr_scpi_get_string(sdi->conn, command, &tmp_str) != SR_OK)
                return SR_ERR;
 
        if (scope_state_get_array_option(tmp_str,
-               config->trigger_slopes, &state->trigger_slope) != SR_OK)
+               config->trigger_slopes, config->num_trigger_slopes, &state->trigger_slope) != SR_OK)
                return SR_ERR;
 
        if (sr_scpi_get_float(sdi->conn, "TRIG_DELAY?", &state->horiz_triggerpos) != SR_OK)
@@ -493,22 +455,25 @@ SR_PRIV int lecroy_xstream_init_device(struct sr_dev_inst *sdi)
        }
 
        if (model_index == -1) {
-               sr_dbg("Unsupported LECROY device.");
+               sr_dbg("Unsupported LeCroy device.");
                return SR_ERR_NA;
        }
 
+       /* Set the desired response and format modes. */
+       sr_scpi_send(sdi->conn, "COMM_HEADER OFF");
+       sr_scpi_send(sdi->conn, "COMM_FORMAT OFF,WORD,BIN");
+
        devc->analog_groups = g_malloc0(sizeof(struct sr_channel_group*) *
-                                       scope_models[model_index].analog_channels);
+                               scope_models[model_index].analog_channels);
 
        /* Add analog channels. */
        for (i = 0; i < scope_models[model_index].analog_channels; i++) {
-
-               g_snprintf(command, sizeof(command), "C%d:TRACE?", i+1);
+               g_snprintf(command, sizeof(command), "C%d:TRACE?", i + 1);
 
                if (sr_scpi_get_bool(sdi->conn, command, &channel_enabled) != SR_OK)
                        return SR_ERR;
 
-               g_snprintf(command, sizeof(command), "C%d:VDIV?", i+1);
+               g_snprintf(command, sizeof(command), "C%d:VDIV?", i + 1);
 
                ch = sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, channel_enabled,
                           (*scope_models[model_index].analog_names)[i]);
@@ -529,9 +494,6 @@ SR_PRIV int lecroy_xstream_init_device(struct sr_dev_inst *sdi)
        if (!(devc->model_state = scope_state_new(devc->model_config)))
                return SR_ERR_MALLOC;
 
-       /* Set the desired response mode. */
-       sr_scpi_send(sdi->conn, "COMM_HEADER OFF,WORD,BIN");
-
        return SR_OK;
 }
 
@@ -546,19 +508,18 @@ static int lecroy_waveform_2_x_to_analog(GByteArray *data,
        int16_t *waveform_data;
        unsigned int i, num_samples;
 
-       data_float  = g_malloc(desc->version_2_x.wave_array_count * sizeof(float));
+       data_float = g_malloc(desc->version_2_x.wave_array_count * sizeof(float));
        num_samples = desc->version_2_x.wave_array_count;
 
        waveform_data = (int16_t *)(data->data +
                                    + desc->version_2_x.wave_descriptor_length
                                    + desc->version_2_x.user_text_len);
 
-       for(i = 0; i  < num_samples; i++)
+       for (i = 0; i < num_samples; i++)
                data_float[i] = (float)waveform_data[i]
                        * desc->version_2_x.vertical_gain
                        + desc->version_2_x.vertical_offset;
 
-
        analog->data = data_float;
        analog->num_samples = num_samples;
 
@@ -578,13 +539,14 @@ static int lecroy_waveform_2_x_to_analog(GByteArray *data,
                meaning->mq = SR_MQ_CURRENT;
                meaning->unit = SR_UNIT_AMPERE;
        } else {
-               /* default to voltage */
+               /* Default to voltage. */
                meaning->mq = SR_MQ_VOLTAGE;
                meaning->unit = SR_UNIT_VOLT;
        }
 
        meaning->mqflags = 0;
        spec->spec_digits = 3;
+
        return SR_OK;
 }
 
@@ -603,7 +565,9 @@ static int lecroy_waveform_to_analog(GByteArray *data,
                return lecroy_waveform_2_x_to_analog(data, desc, analog);
        }
 
-       sr_err("Waveformat template '%.16s' not supported\n", desc->template_name);
+       sr_err("Waveformat template '%.16s' not supported.",
+              desc->template_name);
+
        return SR_ERR;
 }
 
@@ -619,6 +583,7 @@ SR_PRIV int lecroy_xstream_receive_data(int fd, int revents, void *cb_data)
        struct sr_analog_meaning meaning;
        struct sr_analog_spec spec;
        char buf[8];
+
        (void)fd;
        (void)revents;
 
@@ -643,11 +608,10 @@ SR_PRIV int lecroy_xstream_receive_data(int fd, int revents, void *cb_data)
 
        if (ch->type != SR_CHANNEL_ANALOG)
                return SR_ERR;
-       /*
-        * Pass on the received data of the channel(s).
-        */
+
+       /* Pass on the received data of the channel(s). */
        if (sr_scpi_read_data(sdi->conn, buf, 4) != 4) {
-               sr_err("reading header failed\n");
+               sr_err("Reading header failed.");
                return TRUE;
        }
 
@@ -675,7 +639,6 @@ SR_PRIV int lecroy_xstream_receive_data(int fd, int revents, void *cb_data)
        g_slist_free(meaning.channels);
        g_free(analog.data);
 
-
        /*
         * Advance to the next enabled channel. When data for all enabled
         * channels was received, then flush potentially queued logic data,
@@ -696,7 +659,7 @@ SR_PRIV int lecroy_xstream_receive_data(int fd, int revents, void *cb_data)
         * the first enabled channel.
         */
        if (++devc->num_frames == devc->frame_limit) {
-               sdi->driver->dev_acquisition_stop(sdi);
+               sr_dev_acquisition_stop(sdi);
        } else {
                devc->current_channel = devc->enabled_channels;
                lecroy_xstream_request_data(sdi);