]> sigrok.org Git - libsigrok.git/blobdiff - src/hardware/yokogawa-dlm/protocol.c
yokogawa-dlm: Minor cosmetics, consistency fixes, typos.
[libsigrok.git] / src / hardware / yokogawa-dlm / protocol.c
index 11b8638e913ce940995fa4635ec8e568a2f97628..20ad5d55761070863249f3badc9995253e160846 100644 (file)
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/** @file
+/**
+ * @file
+ *
  * <em>Yokogawa DL/DLM series</em> oscilloscope driver
  * @internal
  */
 
 #include "protocol.h"
 
-static const uint32_t dlm_devopts[] = {
-       SR_CONF_LOGIC_ANALYZER,
-       SR_CONF_OSCILLOSCOPE,
-       SR_CONF_LIMIT_FRAMES | SR_CONF_SET,
-       SR_CONF_SAMPLERATE | SR_CONF_GET,
-       SR_CONF_TRIGGER_SLOPE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
-       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_HORIZ_TRIGGERPOS | SR_CONF_GET | SR_CONF_SET,
-};
-
-static const uint32_t dlm_analog_devopts[] = {
-       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_NUM_VDIV | SR_CONF_GET,
-};
-
 static const char *dlm_coupling_options[] = {
        "AC",
        "DC",
@@ -51,13 +35,6 @@ static const char *dlm_coupling_options[] = {
        NULL,
 };
 
-/* Note: Values must correlate to the trigger_slopes values */
-static const char *dlm_trigger_slopes[] = {
-       "r",
-       "f",
-       NULL,
-};
-
 static const char *dlm_2ch_trigger_sources[] = {
        "1",
        "2",
@@ -85,7 +62,14 @@ static const char *dlm_4ch_trigger_sources[] = {
        NULL,
 };
 
-static const uint64_t dlm_timebases[][2] = {
+/* Note: Values must correlate to the trigger_slopes values. */
+const char *dlm_trigger_slopes[3] = {
+       "r",
+       "f",
+       NULL,
+};
+
+const uint64_t dlm_timebases[36][2] = {
        /* nanoseconds */
        { 1, 1000000000 },
        { 2, 1000000000 },
@@ -128,7 +112,7 @@ static const uint64_t dlm_timebases[][2] = {
        { 500, 1 },
 };
 
-static const uint64_t dlm_vdivs[][2] = {
+const uint64_t dlm_vdivs[17][2] = {
        /* millivolts */
        { 2, 1000 },
        { 5, 1000 },
@@ -154,7 +138,7 @@ static const char *scope_analog_channel_names[] = {
        "1",
        "2",
        "3",
-       "4"
+       "4",
 };
 
 static const char *scope_digital_channel_names_8[] = {
@@ -165,7 +149,7 @@ static const char *scope_digital_channel_names_8[] = {
        "D4",
        "D5",
        "D6",
-       "D7"
+       "D7",
 };
 
 static const char *scope_digital_channel_names_32[] = {
@@ -214,21 +198,8 @@ static const struct scope_config scope_models[] = {
                .analog_names = &scope_analog_channel_names,
                .digital_names = &scope_digital_channel_names_8,
 
-               .devopts = &dlm_devopts,
-               .num_devopts = ARRAY_SIZE(dlm_devopts),
-
-               .analog_devopts = &dlm_analog_devopts,
-               .num_analog_devopts = ARRAY_SIZE(dlm_analog_devopts),
-
                .coupling_options = &dlm_coupling_options,
                .trigger_sources = &dlm_2ch_trigger_sources,
-               .trigger_slopes = &dlm_trigger_slopes,
-
-               .timebases = &dlm_timebases,
-               .num_timebases = ARRAY_SIZE(dlm_timebases),
-
-               .vdivs = &dlm_vdivs,
-               .num_vdivs = ARRAY_SIZE(dlm_vdivs),
 
                .num_xdivs = 10,
                .num_ydivs = 8,
@@ -243,21 +214,8 @@ static const struct scope_config scope_models[] = {
                .analog_names = &scope_analog_channel_names,
                .digital_names = &scope_digital_channel_names_8,
 
-               .devopts = &dlm_devopts,
-               .num_devopts = ARRAY_SIZE(dlm_devopts),
-
-               .analog_devopts = &dlm_analog_devopts,
-               .num_analog_devopts = ARRAY_SIZE(dlm_analog_devopts),
-
                .coupling_options = &dlm_coupling_options,
                .trigger_sources = &dlm_4ch_trigger_sources,
-               .trigger_slopes = &dlm_trigger_slopes,
-
-               .timebases = &dlm_timebases,
-               .num_timebases = ARRAY_SIZE(dlm_timebases),
-
-               .vdivs = &dlm_vdivs,
-               .num_vdivs = ARRAY_SIZE(dlm_vdivs),
 
                .num_xdivs = 10,
                .num_ydivs = 8,
@@ -274,21 +232,8 @@ static const struct scope_config scope_models[] = {
                .analog_names = &scope_analog_channel_names,
                .digital_names = NULL,
 
-               .devopts = &dlm_devopts,
-               .num_devopts = ARRAY_SIZE(dlm_devopts),
-
-               .analog_devopts = &dlm_analog_devopts,
-               .num_analog_devopts = ARRAY_SIZE(dlm_analog_devopts),
-
                .coupling_options = &dlm_coupling_options,
                .trigger_sources = &dlm_4ch_trigger_sources,
-               .trigger_slopes = &dlm_trigger_slopes,
-
-               .timebases = &dlm_timebases,
-               .num_timebases = ARRAY_SIZE(dlm_timebases),
-
-               .vdivs = &dlm_vdivs,
-               .num_vdivs = ARRAY_SIZE(dlm_vdivs),
 
                .num_xdivs = 10,
                .num_ydivs = 8,
@@ -303,21 +248,8 @@ static const struct scope_config scope_models[] = {
                .analog_names = &scope_analog_channel_names,
                .digital_names = &scope_digital_channel_names_32,
 
-               .devopts = &dlm_devopts,
-               .num_devopts = ARRAY_SIZE(dlm_devopts),
-
-               .analog_devopts = &dlm_analog_devopts,
-               .num_analog_devopts = ARRAY_SIZE(dlm_analog_devopts),
-
                .coupling_options = &dlm_coupling_options,
                .trigger_sources = &dlm_4ch_trigger_sources,
-               .trigger_slopes = &dlm_trigger_slopes,
-
-               .timebases = &dlm_timebases,
-               .num_timebases = ARRAY_SIZE(dlm_timebases),
-
-               .vdivs = &dlm_vdivs,
-               .num_vdivs = ARRAY_SIZE(dlm_vdivs),
 
                .num_xdivs = 10,
                .num_ydivs = 8,
@@ -332,21 +264,8 @@ static const struct scope_config scope_models[] = {
                .analog_names = &scope_analog_channel_names,
                .digital_names = &scope_digital_channel_names_32,
 
-               .devopts = &dlm_devopts,
-               .num_devopts = ARRAY_SIZE(dlm_devopts),
-
-               .analog_devopts = &dlm_analog_devopts,
-               .num_analog_devopts = ARRAY_SIZE(dlm_analog_devopts),
-
                .coupling_options = &dlm_coupling_options,
                .trigger_sources = &dlm_4ch_trigger_sources,
-               .trigger_slopes = &dlm_trigger_slopes,
-
-               .timebases = &dlm_timebases,
-               .num_timebases = ARRAY_SIZE(dlm_timebases),
-
-               .vdivs = &dlm_vdivs,
-               .num_vdivs = ARRAY_SIZE(dlm_vdivs),
 
                .num_xdivs = 10,
                .num_ydivs = 8,
@@ -365,27 +284,27 @@ static void scope_state_dump(const struct scope_config *config,
        unsigned int i;
        char *tmp;
 
-       for (i = 0; i < config->analog_channels; ++i) {
-               tmp = sr_voltage_string((*config->vdivs)[state->analog_states[i].vdiv][0],
-                               (*config->vdivs)[state->analog_states[i].vdiv][1]);
-               sr_info("State of analog channel  %d -> %s : %s (coupling) %s (vdiv) %2.2e (offset)",
+       for (i = 0; i < config->analog_channels; i++) {
+               tmp = sr_voltage_string(dlm_vdivs[state->analog_states[i].vdiv][0],
+                               dlm_vdivs[state->analog_states[i].vdiv][1]);
+               sr_info("State of analog channel %d -> %s : %s (coupling) %s (vdiv) %2.2e (offset)",
                                i + 1, state->analog_states[i].state ? "On" : "Off",
                                (*config->coupling_options)[state->analog_states[i].coupling],
                                tmp, state->analog_states[i].vertical_offset);
        }
 
-       for (i = 0; i < config->digital_channels; ++i) {
+       for (i = 0; i < config->digital_channels; i++) {
                sr_info("State of digital channel %d -> %s", i,
                                state->digital_states[i] ? "On" : "Off");
        }
 
-       for (i = 0; i < config->pods; ++i) {
+       for (i = 0; i < config->pods; i++) {
                sr_info("State of digital POD %d -> %s", i,
                                state->pod_states[i] ? "On" : "Off");
        }
 
-       tmp = sr_period_string((*config->timebases)[state->timebase][0] *
-                       (*config->timebases)[state->timebase][1]);
+       tmp = sr_period_string(dlm_timebases[state->timebase][0] *
+                       dlm_timebases[state->timebase][1]);
        sr_info("Current timebase: %s", tmp);
        g_free(tmp);
 
@@ -398,7 +317,7 @@ static void scope_state_dump(const struct scope_config *config,
 
        sr_info("Current trigger: %s (source), %s (slope) %.2f (offset)",
                        (*config->trigger_sources)[state->trigger_source],
-                       (*config->trigger_slopes)[state->trigger_slope],
+                       dlm_trigger_slopes[state->trigger_slope],
                        state->horiz_triggerpos);
 }
 
@@ -419,7 +338,7 @@ static int array_option_get(char *value, const char *(*array)[],
 
        *result = -1;
 
-       for (i = 0; (*array)[i]; ++i)
+       for (i = 0; (*array)[i]; i++)
                if (!g_strcmp0(value, (*array)[i])) {
                        *result = i;
                        break;
@@ -471,7 +390,8 @@ static int array_float_get(gchar *value, const uint64_t array[][2],
        /* Transform e.g. 10^-03 to 1000 as the array stores the inverse. */
        f = pow(10, abs(i));
 
-       /* Adjust the significand/factor pair to make sure
+       /*
+        * Adjust the significand/factor pair to make sure
         * that f is a multiple of 1000.
         */
        while ((int)fmod(log10(f), 3) > 0) { s *= 10; f *= 10; }
@@ -493,29 +413,42 @@ static int array_float_get(gchar *value, const uint64_t array[][2],
  * Obtains information about all analog channels from the oscilloscope.
  * The internal state information is updated accordingly.
  *
- * @param scpi An open SCPI connection.
+ * @param sdi The device instance.
  * @param config The device's device configuration.
  * @param state The device's state information.
  *
  * @return SR_ERR on error, SR_OK otherwise.
  */
-static int analog_channel_state_get(struct sr_scpi_dev_inst *scpi,
+static int analog_channel_state_get(const struct sr_dev_inst *sdi,
                const struct scope_config *config,
                struct scope_state *state)
 {
+       struct sr_scpi_dev_inst *scpi;
        int i, j;
+       GSList *l;
+       struct sr_channel *ch;
        gchar *response;
 
-       for (i = 0; i < config->analog_channels; ++i) {
+       scpi = sdi->conn;
+
+       for (i = 0; i < config->analog_channels; i++) {
 
                if (dlm_analog_chan_state_get(scpi, i + 1,
                                &state->analog_states[i].state) != SR_OK)
                        return SR_ERR;
 
+               for (l = sdi->channels; l; l = l->next) {
+                       ch = l->data;
+                       if (ch->index == i) {
+                               ch->enabled = state->analog_states[i].state;
+                               break;
+                       }
+               }
+
                if (dlm_analog_chan_vdiv_get(scpi, i + 1, &response) != SR_OK)
                        return SR_ERR;
 
-               if (array_float_get(response, *config->vdivs, config->num_vdivs,
+               if (array_float_get(response, dlm_vdivs, ARRAY_SIZE(dlm_vdivs),
                                &j) != SR_OK) {
                        g_free(response);
                        return SR_ERR;
@@ -556,39 +489,50 @@ static int analog_channel_state_get(struct sr_scpi_dev_inst *scpi,
  * Obtains information about all digital channels from the oscilloscope.
  * The internal state information is updated accordingly.
  *
- * @param scpi An open SCPI connection.
+ * @param sdi The device instance.
  * @param config The device's device configuration.
  * @param state The device's state information.
  *
  * @return SR_ERR on error, SR_OK otherwise.
  */
-static int digital_channel_state_get(struct sr_scpi_dev_inst *scpi,
+static int digital_channel_state_get(const struct sr_dev_inst *sdi,
                const struct scope_config *config,
                struct scope_state *state)
 {
-       unsigned int i;
+       struct sr_scpi_dev_inst *scpi;
+       int i;
+       GSList *l;
+       struct sr_channel *ch;
 
-       if (!config->digital_channels)
-               {
-                       sr_warn("Tried obtaining digital channel states on a " \
-                                       "model without digital inputs.");
-                       return SR_OK;
-               }
+       scpi = sdi->conn;
 
-       for (i = 0; i < config->digital_channels; ++i) {
+       if (!config->digital_channels) {
+               sr_warn("Tried obtaining digital channel states on a " \
+                               "model without digital inputs.");
+               return SR_OK;
+       }
+
+       for (i = 0; i < config->digital_channels; i++) {
                if (dlm_digital_chan_state_get(scpi, i + 1,
                                &state->digital_states[i]) != SR_OK) {
                        return SR_ERR;
                }
+
+               for (l = sdi->channels; l; l = l->next) {
+                       ch = l->data;
+                       if (ch->index == i + DLM_DIG_CHAN_INDEX_OFFS) {
+                               ch->enabled = state->digital_states[i];
+                               break;
+                       }
+               }
        }
 
-       if (!config->pods)
-       {
+       if (!config->pods) {
                sr_warn("Tried obtaining pod states on a model without pods.");
                return SR_OK;
        }
 
-       for (i = 0; i < config->pods; ++i) {
+       for (i = 0; i < config->pods; i++) {
                if (dlm_digital_pod_state_get(scpi, i + 'A',
                                &state->pod_states[i]) != SR_OK)
                        return SR_ERR;
@@ -597,6 +541,91 @@ static int digital_channel_state_get(struct sr_scpi_dev_inst *scpi,
        return SR_OK;
 }
 
+SR_PRIV int dlm_channel_state_set(const struct sr_dev_inst *sdi,
+               const int ch_index, gboolean ch_state)
+{
+       GSList *l;
+       struct sr_channel *ch;
+       struct dev_context *devc = NULL;
+       struct scope_state *state;
+       const struct scope_config *model = NULL;
+       struct sr_scpi_dev_inst *scpi;
+       gboolean chan_found;
+       gboolean *pod_enabled;
+       int i, result;
+
+       result = SR_OK;
+
+       scpi = sdi->conn;
+       devc = sdi->priv;
+       state = devc->model_state;
+       model = devc->model_config;
+       chan_found = FALSE;
+
+       pod_enabled = g_malloc0(sizeof(gboolean) * model->pods);
+
+       for (l = sdi->channels; l; l = l->next) {
+               ch = l->data;
+
+               switch (ch->type) {
+               case SR_CHANNEL_ANALOG:
+                       if (ch->index == ch_index) {
+                               if (dlm_analog_chan_state_set(scpi, ch->index + 1, ch_state) != SR_OK) {
+                                       result = SR_ERR;
+                                       break;
+                               }
+
+                               ch->enabled = ch_state;
+                               state->analog_states[ch->index].state = ch_state;
+                               chan_found = TRUE;
+                               break;
+                       }
+                       break;
+               case SR_CHANNEL_LOGIC:
+                       i = ch->index - DLM_DIG_CHAN_INDEX_OFFS;
+
+                       if (ch->index == ch_index) {
+                               if (dlm_digital_chan_state_set(scpi, i + 1, ch_state) != SR_OK) {
+                                       result = SR_ERR;
+                                       break;
+                               }
+
+                               ch->enabled = ch_state;
+                               state->digital_states[i] = ch_state;
+                               chan_found = TRUE;
+
+                               /* The corresponding pod has to be enabled also. */
+                               pod_enabled[i / 8] |= ch->enabled;
+                       } else {
+                               /* Also check all other channels. Maybe we can disable a pod. */
+                               pod_enabled[i / 8] |= ch->enabled;
+                       }
+                       break;
+               default:
+                       result = SR_ERR_NA;
+               }
+       }
+
+       for (i = 0; i < model->pods; i++) {
+               if (state->pod_states[i] == pod_enabled[i])
+                       continue;
+
+               if (dlm_digital_pod_state_set(scpi, i + 1, pod_enabled[i]) != SR_OK) {
+                       result = SR_ERR;
+                       break;
+               }
+
+               state->pod_states[i] = pod_enabled[i];
+       }
+
+       g_free(pod_enabled);
+
+       if ((result == SR_OK) && !chan_found)
+               result = SR_ERR_BUG;
+
+       return result;
+}
+
 /**
  * Obtains information about the sample rate from the oscilloscope.
  * The internal state information is updated accordingly.
@@ -614,7 +643,8 @@ SR_PRIV int dlm_sample_rate_query(const struct sr_dev_inst *sdi)
        devc = sdi->priv;
        state = devc->model_state;
 
-       /* No need to find an active channel to query the sample rate:
+       /*
+        * No need to find an active channel to query the sample rate:
         * querying any channel will do, so we use channel 1 all the time.
         */
        if (dlm_analog_chan_srate_get(sdi->conn, 1, &tmp_float) != SR_OK)
@@ -647,17 +677,17 @@ SR_PRIV int dlm_scope_state_query(struct sr_dev_inst *sdi)
        config = devc->model_config;
        state = devc->model_state;
 
-       if (analog_channel_state_get(sdi->conn, config, state) != SR_OK)
+       if (analog_channel_state_get(sdi, config, state) != SR_OK)
                return SR_ERR;
 
-       if (digital_channel_state_get(sdi->conn, config, state) != SR_OK)
+       if (digital_channel_state_get(sdi, config, state) != SR_OK)
                return SR_ERR;
 
        if (dlm_timebase_get(sdi->conn, &response) != SR_OK)
                return SR_ERR;
 
-       if (array_float_get(response, *config->timebases,
-                       config->num_timebases, &i) != SR_OK) {
+       if (array_float_get(response, dlm_timebases,
+                       ARRAY_SIZE(dlm_timebases), &i) != SR_OK) {
                g_free(response);
                return SR_ERR;
        }
@@ -670,8 +700,8 @@ SR_PRIV int dlm_scope_state_query(struct sr_dev_inst *sdi)
 
        /* TODO: Check if the calculation makes sense for the DLM. */
        state->horiz_triggerpos = tmp_float /
-                       (((double)(*config->timebases)[state->timebase][0] /
-                       (*config->timebases)[state->timebase][1]) * config->num_xdivs);
+                       (((double)dlm_timebases[state->timebase][0] /
+                       dlm_timebases[state->timebase][1]) * config->num_xdivs);
        state->horiz_triggerpos -= 0.5;
        state->horiz_triggerpos *= -1;
 
@@ -807,7 +837,7 @@ SR_PRIV int dlm_device_init(struct sr_dev_inst *sdi, int model_index)
        }
 
        /* Add digital channel groups. */
-       for (i = 0; i < scope_models[model_index].pods; ++i) {
+       for (i = 0; i < scope_models[model_index].pods; i++) {
                g_snprintf(tmp, sizeof(tmp), "POD%d", i);
 
                devc->digital_groups[i] = g_malloc0(sizeof(struct sr_channel_group));
@@ -934,10 +964,11 @@ static int dlm_analog_samples_send(GArray *data,
                return SR_ERR;
        }
 
-       range  = ch_state->waveform_range;
+       range = ch_state->waveform_range;
        offset = ch_state->waveform_offset;
 
-       /* Convert byte sample to voltage according to
+       /*
+        * Convert byte sample to voltage according to
         * page 269 of the Communication Interface User's Manual.
         */
        float_data = g_array_new(FALSE, FALSE, sizeof(float));
@@ -1013,7 +1044,7 @@ static int dlm_digital_samples_send(GArray *data,
  * @param cb_data Callback data, in this case our device instance.
  *
  * @return TRUE in case of success or a recoverable error,
- *  FALSE when a fatal error was encountered.
+ *         FALSE when a fatal error was encountered.
  */
 SR_PRIV int dlm_data_receive(int fd, int revents, void *cb_data)
 {
@@ -1109,7 +1140,8 @@ SR_PRIV int dlm_data_receive(int fd, int revents, void *cb_data)
        g_array_free(data, TRUE);
        data = NULL;
 
-       /* Signal the end of this frame if this was the last enabled channel
+       /*
+        * Signal the end of this frame if this was the last enabled channel
         * and set the next enabled channel. Then, request its data.
         */
        if (!devc->current_channel->next) {
@@ -1117,7 +1149,8 @@ SR_PRIV int dlm_data_receive(int fd, int revents, void *cb_data)
                sr_session_send(sdi, &packet);
                devc->current_channel = devc->enabled_channels;
 
-               /* As of now we only support importing the current acquisition
+               /*
+                * As of now we only support importing the current acquisition
                 * data so we're going to stop at this point.
                 */
                sdi->driver->dev_acquisition_stop(sdi, cb_data);