]> 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 5148c8d7fc039cb37bc7b850b2674ed37e64c114..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_hwcaps[] = {
-       SR_CONF_LOGIC_ANALYZER,
-       SR_CONF_OSCILLOSCOPE,
-       SR_CONF_TRIGGER_SLOPE,
-       SR_CONF_TRIGGER_SOURCE,
-       SR_CONF_TIMEBASE,
-       SR_CONF_NUM_TIMEBASE,
-       SR_CONF_HORIZ_TRIGGERPOS,
-};
-
-static const uint32_t dlm_analog_caps[] = {
-       SR_CONF_VDIV,
-       SR_CONF_COUPLING,
-       SR_CONF_NUM_VDIV,
-};
-
 static const char *dlm_coupling_options[] = {
        "AC",
        "DC",
@@ -49,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",
@@ -83,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 },
@@ -126,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 },
@@ -152,10 +138,45 @@ static const char *scope_analog_channel_names[] = {
        "1",
        "2",
        "3",
-       "4"
+       "4",
+};
+
+static const char *scope_digital_channel_names_8[] = {
+       "D0",
+       "D1",
+       "D2",
+       "D3",
+       "D4",
+       "D5",
+       "D6",
+       "D7",
 };
 
-static const char *scope_digital_channel_names[] = {
+static const char *scope_digital_channel_names_32[] = {
+       "A0",
+       "A1",
+       "A2",
+       "A3",
+       "A4",
+       "A5",
+       "A6",
+       "A7",
+       "B0",
+       "B1",
+       "B2",
+       "B3",
+       "B4",
+       "B5",
+       "B6",
+       "B7",
+       "C0",
+       "C1",
+       "C2",
+       "C3",
+       "C4",
+       "C5",
+       "C6",
+       "C7",
        "D0",
        "D1",
        "D2",
@@ -163,10 +184,10 @@ static const char *scope_digital_channel_names[] = {
        "D4",
        "D5",
        "D6",
-       "D7"
+       "D7",
 };
 
-static struct scope_config scope_models[] = {
+static const struct scope_config scope_models[] = {
        {
                .model_id   = {"710105",  "710115",  "710125",  NULL},
                .model_name = {"DLM2022", "DLM2032", "DLM2052", NULL},
@@ -175,23 +196,10 @@ static struct scope_config scope_models[] = {
                .pods = 0,
 
                .analog_names = &scope_analog_channel_names,
-               .digital_names = &scope_digital_channel_names,
-
-               .hw_caps = &dlm_hwcaps,
-               .num_hwcaps = ARRAY_SIZE(dlm_hwcaps),
-
-               .analog_hwcaps = &dlm_analog_caps,
-               .num_analog_hwcaps = ARRAY_SIZE(dlm_analog_caps),
+               .digital_names = &scope_digital_channel_names_8,
 
                .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,
@@ -204,23 +212,60 @@ static struct scope_config scope_models[] = {
                .pods = 1,
 
                .analog_names = &scope_analog_channel_names,
-               .digital_names = &scope_digital_channel_names,
+               .digital_names = &scope_digital_channel_names_8,
+
+               .coupling_options = &dlm_coupling_options,
+               .trigger_sources = &dlm_4ch_trigger_sources,
+
+               .num_xdivs = 10,
+               .num_ydivs = 8,
+       },
+       {
+               .model_id   = {"701307", "701308",  "701310", "701311",
+                               "701312", "701313",  NULL},
+               .model_name = {"DL9040", "DL9040L", "DL9140", "DL9140L",
+                               "DL9240", "DL9240L", NULL},
+               .analog_channels = 4,
+               .digital_channels = 0,
+               .pods = 0,
+
+               .analog_names = &scope_analog_channel_names,
+               .digital_names = NULL,
 
-               .hw_caps = &dlm_hwcaps,
-               .num_hwcaps = ARRAY_SIZE(dlm_hwcaps),
+               .coupling_options = &dlm_coupling_options,
+               .trigger_sources = &dlm_4ch_trigger_sources,
+
+               .num_xdivs = 10,
+               .num_ydivs = 8,
+       },
+       {
+               .model_id   = {"701320",  "701321",  NULL},
+               .model_name = {"DL9505L", "DL9510L", NULL},
+               .analog_channels = 4,
+               .digital_channels = 16,
+               .pods = 4,
 
-               .analog_hwcaps = &dlm_analog_caps,
-               .num_analog_hwcaps = ARRAY_SIZE(dlm_analog_caps),
+               .analog_names = &scope_analog_channel_names,
+               .digital_names = &scope_digital_channel_names_32,
 
                .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),
+               .num_xdivs = 10,
+               .num_ydivs = 8,
+       },
+       {
+               .model_id   = {"701330",  "701331",  NULL},
+               .model_name = {"DL9705L", "DL9710L", NULL},
+               .analog_channels = 4,
+               .digital_channels = 32,
+               .pods = 4,
+
+               .analog_names = &scope_analog_channel_names,
+               .digital_names = &scope_digital_channel_names_32,
 
-               .vdivs = &dlm_vdivs,
-               .num_vdivs = ARRAY_SIZE(dlm_vdivs),
+               .coupling_options = &dlm_coupling_options,
+               .trigger_sources = &dlm_4ch_trigger_sources,
 
                .num_xdivs = 10,
                .num_ydivs = 8,
@@ -233,33 +278,33 @@ static struct scope_config scope_models[] = {
  * @param config This is the scope configuration.
  * @param state The current scope state to print.
  */
-static void scope_state_dump(struct scope_config *config,
+static void scope_state_dump(const struct scope_config *config,
                struct scope_state *state)
 {
        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);
 
@@ -272,7 +317,7 @@ static void scope_state_dump(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);
 }
 
@@ -293,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;
@@ -345,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; }
@@ -367,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,
-               struct scope_config *config,
+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;
@@ -430,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,
-               struct scope_config *config,
+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;
@@ -471,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.
@@ -488,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)
@@ -512,7 +668,7 @@ SR_PRIV int dlm_scope_state_query(struct sr_dev_inst *sdi)
 {
        struct dev_context *devc;
        struct scope_state *state;
-       struct scope_config *config;
+       const struct scope_config *config;
        float tmp_float;
        gchar *response;
        int i;
@@ -521,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;
        }
@@ -544,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;
 
@@ -586,7 +742,7 @@ SR_PRIV int dlm_scope_state_query(struct sr_dev_inst *sdi)
  *
  * @return The newly allocated scope_state struct.
  */
-static struct scope_state *dlm_scope_state_new(struct scope_config *config)
+static struct scope_state *dlm_scope_state_new(const struct scope_config *config)
 {
        struct scope_state *state;
 
@@ -663,14 +819,12 @@ SR_PRIV int dlm_device_init(struct sr_dev_inst *sdi, int model_index)
                        scope_models[model_index].analog_channels);
 
        devc->digital_groups = g_malloc0(sizeof(struct sr_channel_group*) *
-                       scope_models[model_index].digital_channels);
+                       scope_models[model_index].pods);
 
-       /* Add analog channels. */
+       /* Add analog channels, each in its own group. */
        for (i = 0; i < scope_models[model_index].analog_channels; i++) {
-               if (!(ch = sr_channel_new(i, SR_CHANNEL_ANALOG, TRUE,
-                               (*scope_models[model_index].analog_names)[i])))
-                       return SR_ERR_MALLOC;
-               sdi->channels = g_slist_append(sdi->channels, ch);
+               ch = sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, TRUE,
+                               (*scope_models[model_index].analog_names)[i]);
 
                devc->analog_groups[i] = g_malloc0(sizeof(struct sr_channel_group));
 
@@ -683,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));
@@ -697,10 +851,9 @@ SR_PRIV int dlm_device_init(struct sr_dev_inst *sdi, int model_index)
 
        /* Add digital channels. */
        for (i = 0; i < scope_models[model_index].digital_channels; i++) {
-               if (!(ch = sr_channel_new(i, SR_CHANNEL_LOGIC, TRUE,
-                               (*scope_models[model_index].digital_names)[i])))
-                       return SR_ERR_MALLOC;
-               sdi->channels = g_slist_append(sdi->channels, ch);
+               ch = sr_channel_new(sdi, DLM_DIG_CHAN_INDEX_OFFS + i,
+                               SR_CHANNEL_LOGIC, TRUE,
+                               (*scope_models[model_index].digital_names)[i]);
 
                devc->digital_groups[i / 8]->channels = g_slist_append(
                                devc->digital_groups[i / 8]->channels, ch);
@@ -811,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));
@@ -890,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)
 {
@@ -986,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) {
@@ -994,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);
@@ -1003,7 +1159,7 @@ SR_PRIV int dlm_data_receive(int fd, int revents, void *cb_data)
                devc->current_channel = devc->current_channel->next;
 
        if (dlm_channel_data_request(sdi) != SR_OK) {
-               sr_err("Failed to request aquisition data.");
+               sr_err("Failed to request acquisition data.");
                goto fail;
        }