]> sigrok.org Git - libsigrok.git/blobdiff - src/hardware/yokogawa-dlm/api.c
yokogawa-dlm: Config get/set/list handler updates
[libsigrok.git] / src / hardware / yokogawa-dlm / api.c
index 030bf85460fbc0531ed087a5bd598e8d0f1ba4bd..0ccf5834e157638aac443d69708a5230a8fceb46 100644 (file)
 #include "protocol.h"
 
 SR_PRIV struct sr_dev_driver yokogawa_dlm_driver_info;
-static struct sr_dev_driver *di = &yokogawa_dlm_driver_info;
 
-static char *MANUFACTURER_ID = "YOKOGAWA";
-static char *MANUFACTURER_NAME = "Yokogawa";
+static const char *MANUFACTURER_ID = "YOKOGAWA";
+static const char *MANUFACTURER_NAME = "Yokogawa";
+
+static const uint32_t dlm_scanopts[] = {
+       SR_CONF_CONN,
+};
+
+static const uint32_t dlm_drvopts[] = {
+       SR_CONF_LOGIC_ANALYZER,
+       SR_CONF_OSCILLOSCOPE,
+};
+
+static const uint32_t dlm_devopts[] = {
+       SR_CONF_LIMIT_FRAMES | SR_CONF_GET | SR_CONF_SET,
+       SR_CONF_SAMPLERATE | SR_CONF_GET,
+       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,
+       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,
+};
+
+static const uint32_t dlm_analog_devopts[] = {
+       SR_CONF_COUPLING | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
+       SR_CONF_VDIV | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
+       SR_CONF_NUM_VDIV | SR_CONF_GET,
+};
+
+static const uint32_t dlm_digital_devopts[] = {
+};
 
 enum {
        CG_INVALID = -1,
@@ -34,7 +61,7 @@ enum {
        CG_DIGITAL,
 };
 
-static int init(struct sr_context *sr_ctx)
+static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
 {
        return std_init(sr_ctx, di, LOG_PREFIX);
 }
@@ -62,17 +89,20 @@ static struct sr_dev_inst *probe_usbtmc_device(struct sr_scpi_dev_inst *scpi)
        if (dlm_model_get(hw_info->model, &model_name, &model_index) != SR_OK)
                goto fail;
 
-       if (!(sdi = sr_dev_inst_new(0, SR_ST_ACTIVE, MANUFACTURER_NAME,
-                                   model_name, NULL)))
-               goto fail;
+       sdi = g_malloc0(sizeof(struct sr_dev_inst));
+       sdi->status = SR_ST_ACTIVE;
+       sdi->vendor = g_strdup(MANUFACTURER_NAME);
+       sdi->model = g_strdup(model_name);
+       sdi->version = g_strdup(hw_info->firmware_version);
+
+       sdi->serial_num = g_strdup(hw_info->serial_number);
 
        sr_scpi_hw_info_free(hw_info);
        hw_info = NULL;
 
-       if (!(devc = g_try_malloc0(sizeof(struct dev_context))))
-               goto fail;
+       devc = g_malloc0(sizeof(struct dev_context));
 
-       sdi->driver = di;
+       sdi->driver = &yokogawa_dlm_driver_info;
        sdi->priv = devc;
        sdi->inst_type = SR_INST_SCPI;
        sdi->conn = scpi;
@@ -90,18 +120,17 @@ fail:
                sr_scpi_hw_info_free(hw_info);
        if (sdi)
                sr_dev_inst_free(sdi);
-       if (devc)
-               g_free(devc);
+       g_free(devc);
 
        return NULL;
 }
 
-static GSList *scan(GSList *options)
+static GSList *scan(struct sr_dev_driver *di, GSList *options)
 {
        return sr_scpi_scan(di->priv, options, probe_usbtmc_device);
 }
 
-static GSList *dev_list(void)
+static GSList *dev_list(const struct sr_dev_driver *di)
 {
        return ((struct drv_context *)(di->priv))->instances;
 }
@@ -119,7 +148,7 @@ static void clear_helper(void *priv)
        g_free(devc);
 }
 
-static int dev_clear(void)
+static int dev_clear(const struct sr_dev_driver *di)
 {
        return std_dev_clear(di, clear_helper);
 }
@@ -149,9 +178,9 @@ static int dev_close(struct sr_dev_inst *sdi)
        return SR_OK;
 }
 
-static int cleanup(void)
+static int cleanup(const struct sr_dev_driver *di)
 {
-       dev_clear();
+       dev_clear(di);
 
        return SR_OK;
 }
@@ -168,10 +197,10 @@ static int cleanup(void)
  * @retval CG_INVALID cg is something else
  */
 static int check_channel_group(struct dev_context *devc,
-                            const struct sr_channel_group *cg)
+                       const struct sr_channel_group *cg)
 {
        unsigned int i;
-       struct scope_config *model;
+       const struct scope_config *model;
 
        model = devc->model_config;
 
@@ -190,13 +219,13 @@ static int check_channel_group(struct dev_context *devc,
        return CG_INVALID;
 }
 
-static int config_get(int key, GVariant **data, const struct sr_dev_inst *sdi,
-                     const struct sr_channel_group *cg)
+static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
+               const struct sr_channel_group *cg)
 {
        int ret, cg_type;
        unsigned int i;
        struct dev_context *devc;
-       struct scope_config *model;
+       const struct scope_config *model;
        struct scope_state *state;
 
        if (!sdi || !(devc = sdi->priv))
@@ -210,14 +239,14 @@ static int config_get(int key, GVariant **data, const struct sr_dev_inst *sdi,
        state = devc->model_state;
 
        switch (key) {
-       case SR_CONF_NUM_TIMEBASE:
+       case SR_CONF_NUM_HDIV:
                *data = g_variant_new_int32(model->num_xdivs);
                ret = SR_OK;
                break;
        case SR_CONF_TIMEBASE:
                *data = g_variant_new("(tt)",
-                                     (*model->timebases)[state->timebase][0],
-                                     (*model->timebases)[state->timebase][1]);
+                               dlm_timebases[state->timebase][0],
+                               dlm_timebases[state->timebase][1]);
                ret = SR_OK;
                break;
        case SR_CONF_NUM_VDIV:
@@ -244,8 +273,8 @@ static int config_get(int key, GVariant **data, const struct sr_dev_inst *sdi,
                        if (cg != devc->analog_groups[i])
                                continue;
                        *data = g_variant_new("(tt)",
-                                             (*model->vdivs)[state->analog_states[i].vdiv][0],
-                                             (*model->vdivs)[state->analog_states[i].vdiv][1]);
+                                       dlm_vdivs[state->analog_states[i].vdiv][0],
+                                       dlm_vdivs[state->analog_states[i].vdiv][1]);
                        ret = SR_OK;
                        break;
                }
@@ -255,7 +284,7 @@ static int config_get(int key, GVariant **data, const struct sr_dev_inst *sdi,
                ret = SR_OK;
                break;
        case SR_CONF_TRIGGER_SLOPE:
-               *data = g_variant_new_string((*model->trigger_slopes)[state->trigger_slope]);
+               *data = g_variant_new_string(dlm_trigger_slopes[state->trigger_slope]);
                ret = SR_OK;
                break;
        case SR_CONF_HORIZ_TRIGGERPOS:
@@ -308,14 +337,14 @@ static GVariant *build_tuples(const uint64_t (*array)[][2], unsigned int n)
        return g_variant_builder_end(&gvb);
 }
 
-static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi,
-                     const struct sr_channel_group *cg)
+static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
+               const struct sr_channel_group *cg)
 {
        int ret, cg_type;
        unsigned int i, j;
        char float_str[30];
        struct dev_context *devc;
-       struct scope_config *model;
+       const struct scope_config *model;
        struct scope_state *state;
        const char *tmp;
        uint64_t p, q;
@@ -358,9 +387,9 @@ static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi,
 
                g_variant_get(data, "(tt)", &p, &q);
 
-               for (i = 0; i < model->num_vdivs; i++) {
-                       if (p != (*model->vdivs)[i][0] ||
-                           q != (*model->vdivs)[i][1])
+               for (i = 0; i < ARRAY_SIZE(dlm_vdivs); i++) {
+                       if (p != dlm_vdivs[i][0] ||
+                                       q != dlm_vdivs[i][1])
                                continue;
                        for (j = 1; j <= model->analog_channels; ++j) {
                                if (cg != devc->analog_groups[j - 1])
@@ -369,7 +398,7 @@ static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi,
                                g_ascii_formatd(float_str, sizeof(float_str),
                                                "%E", (float) p / q);
                                if (dlm_analog_chan_vdiv_set(sdi->conn, j, float_str) != SR_OK ||
-                                   sr_scpi_get_opc(sdi->conn) != SR_OK)
+                                               sr_scpi_get_opc(sdi->conn) != SR_OK)
                                        return SR_ERR;
 
                                break;
@@ -382,9 +411,9 @@ static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi,
        case SR_CONF_TIMEBASE:
                g_variant_get(data, "(tt)", &p, &q);
 
-               for (i = 0; i < model->num_timebases; i++) {
-                       if (p != (*model->timebases)[i][0] ||
-                           q != (*model->timebases)[i][1])
+               for (i = 0; i < ARRAY_SIZE(dlm_timebases); i++) {
+                       if (p != dlm_timebases[i][0] ||
+                                       q != dlm_timebases[i][1])
                                continue;
                        state->timebase = i;
                        g_ascii_formatd(float_str, sizeof(float_str),
@@ -403,9 +432,9 @@ static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi,
 
                state->horiz_triggerpos = tmp_d;
                tmp_d = -(tmp_d - 0.5) *
-                       ((double) (*model->timebases)[state->timebase][0] /
-                       (*model->timebases)[state->timebase][1])
-                        * model->num_xdivs;
+                               ((double) dlm_timebases[state->timebase][0] /
+                               dlm_timebases[state->timebase][1])
+                               * model->num_xdivs;
 
                g_ascii_formatd(float_str, sizeof(float_str), "%E", tmp_d);
                ret = dlm_horiz_trigger_pos_set(sdi->conn, float_str);
@@ -439,7 +468,7 @@ static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi,
                                state->analog_states[j-1].coupling = i;
 
                                if (dlm_analog_chan_coupl_set(sdi->conn, j, tmp) != SR_OK ||
-                                   sr_scpi_get_opc(sdi->conn) != SR_OK)
+                                               sr_scpi_get_opc(sdi->conn) != SR_OK)
                                        return SR_ERR;
                                break;
                        }
@@ -462,58 +491,88 @@ static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi,
        return ret;
 }
 
-static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
-                      const struct sr_channel_group *cg)
+static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
+               const struct sr_channel_group *cg)
 {
-       int cg_type;
-       struct dev_context *devc;
-       struct scope_config *model;
+       int cg_type = CG_NONE;
+       struct dev_context *devc = NULL;
+       const struct scope_config *model = NULL;
+
+       /* SR_CONF_SCAN_OPTIONS is always valid, regardless of sdi or probe group. */
+       if (key == SR_CONF_SCAN_OPTIONS) {
+               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
+                               dlm_scanopts, ARRAY_SIZE(dlm_scanopts), sizeof(uint32_t));
+               return SR_OK;
+       }
 
-       if (!sdi || !(devc = sdi->priv))
+       /* 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,
+                               dlm_drvopts, ARRAY_SIZE(dlm_drvopts), sizeof(uint32_t));
+               return SR_OK;
+       }
+
+       if (!sdi)
                return SR_ERR_ARG;
 
+       devc = sdi->priv;
+       model = devc->model_config;
+
+       /* If cg is NULL, only the SR_CONF_DEVICE_OPTIONS that are not
+        * specific to a probe group must be returned. */
+       if (!cg) {
+               switch (key) {
+               case SR_CONF_DEVICE_OPTIONS:
+                       *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
+                                       dlm_devopts, ARRAY_SIZE(dlm_devopts), sizeof(uint32_t));
+                       return SR_OK;
+               case SR_CONF_TIMEBASE:
+                       *data = build_tuples(&dlm_timebases, ARRAY_SIZE(dlm_timebases));
+                       return SR_OK;
+               case SR_CONF_TRIGGER_SOURCE:
+                       if (!model)
+                               return SR_ERR_ARG;
+                       *data = g_variant_new_strv(*model->trigger_sources,
+                                       g_strv_length((char **)*model->trigger_sources));
+                       return SR_OK;
+               case SR_CONF_TRIGGER_SLOPE:
+                       *data = g_variant_new_strv(dlm_trigger_slopes,
+                                       g_strv_length((char **)dlm_trigger_slopes));
+                       return SR_OK;
+               case SR_CONF_NUM_HDIV:
+                       *data = g_variant_new_uint32(ARRAY_SIZE(dlm_timebases));
+                       return SR_OK;
+               default:
+                       return SR_ERR_NA;
+               }
+       }
+
        if ((cg_type = check_channel_group(devc, cg)) == CG_INVALID)
                return SR_ERR;
 
-       model = devc->model_config;
-
        switch (key) {
-       case SR_CONF_SCAN_OPTIONS:
-               *data = NULL;
-               break;
        case SR_CONF_DEVICE_OPTIONS:
-               if (cg_type == CG_NONE) {
-                       *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
-                               model->hw_caps, model->num_hwcaps, sizeof(int32_t));
-               } else if (cg_type == CG_ANALOG) {
-                       *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
-                               model->analog_hwcaps, model->num_analog_hwcaps, sizeof(int32_t));
+               if (cg_type == CG_ANALOG) {
+                       *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
+                               dlm_analog_devopts, ARRAY_SIZE(dlm_analog_devopts), sizeof(uint32_t));
+               } else if (cg_type == CG_DIGITAL) {
+                       *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
+                               dlm_digital_devopts, ARRAY_SIZE(dlm_digital_devopts), sizeof(uint32_t));
                } else {
-                       *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
-                               NULL, 0, sizeof(int32_t));
+                       *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
+                               NULL, 0, sizeof(uint32_t));
                }
                break;
        case SR_CONF_COUPLING:
                if (cg_type == CG_NONE)
                        return SR_ERR_CHANNEL_GROUP;
                *data = g_variant_new_strv(*model->coupling_options,
-                          g_strv_length((char **)*model->coupling_options));
-               break;
-       case SR_CONF_TRIGGER_SOURCE:
-               *data = g_variant_new_strv(*model->trigger_sources,
-                          g_strv_length((char **)*model->trigger_sources));
-               break;
-       case SR_CONF_TRIGGER_SLOPE:
-               *data = g_variant_new_strv(*model->trigger_slopes,
-                          g_strv_length((char **)*model->trigger_slopes));
-               break;
-       case SR_CONF_TIMEBASE:
-               *data = build_tuples(model->timebases, model->num_timebases);
+                               g_strv_length((char **)*model->coupling_options));
                break;
        case SR_CONF_VDIV:
                if (cg_type == CG_NONE)
                        return SR_ERR_CHANNEL_GROUP;
-               *data = build_tuples(model->vdivs, model->num_vdivs);
+               *data = build_tuples(&dlm_vdivs, ARRAY_SIZE(dlm_vdivs));
                break;
        default:
                return SR_ERR_NA;
@@ -559,7 +618,7 @@ static int dlm_setup_channels(const struct sr_dev_inst *sdi)
        unsigned int i;
        gboolean *pod_enabled, setup_changed;
        struct scope_state *state;
-       struct scope_config *model;
+       const struct scope_config *model;
        struct sr_channel *ch;
        struct dev_context *devc;
        struct sr_scpi_dev_inst *scpi;
@@ -570,7 +629,7 @@ static int dlm_setup_channels(const struct sr_dev_inst *sdi)
        model = devc->model_config;
        setup_changed = FALSE;
 
-       pod_enabled = g_try_malloc0(sizeof(gboolean) * model->pods);
+       pod_enabled = g_malloc0(sizeof(gboolean) * model->pods);
 
        for (l = sdi->channels; l; l = l->next) {
                ch = l->data;
@@ -580,24 +639,25 @@ static int dlm_setup_channels(const struct sr_dev_inst *sdi)
                                break;
 
                        if (dlm_analog_chan_state_set(scpi, ch->index + 1,
-                                                     ch->enabled) != SR_OK)
+                                       ch->enabled) != SR_OK)
                                return SR_ERR;
 
                        state->analog_states[ch->index].state = ch->enabled;
                        setup_changed = TRUE;
                        break;
                case SR_CHANNEL_LOGIC:
+                       i = ch->index - DLM_DIG_CHAN_INDEX_OFFS;
                        if (ch->enabled)
-                               pod_enabled[ch->index / 8] = TRUE;
+                               pod_enabled[i / 8] = TRUE;
 
-                       if (ch->enabled == state->digital_states[ch->index])
+                       if (ch->enabled == state->digital_states[i])
                                break;
 
-                       if (dlm_digital_chan_state_set(scpi, ch->index + 1,
-                                                      ch->enabled) != SR_OK)
+                       if (dlm_digital_chan_state_set(scpi, i + 1,
+                                       ch->enabled) != SR_OK)
                                return SR_ERR;
 
-                       state->digital_states[ch->index] = ch->enabled;
+                       state->digital_states[i] = ch->enabled;
                        setup_changed = TRUE;
                        break;
                default:
@@ -610,7 +670,7 @@ static int dlm_setup_channels(const struct sr_dev_inst *sdi)
                        continue;
 
                if (dlm_digital_pod_state_set(scpi, i,
-                                             pod_enabled[i - 1]) != SR_OK)
+                               pod_enabled[i - 1]) != SR_OK)
                        return SR_ERR;
 
                state->pod_states[i - 1] = pod_enabled[i - 1];
@@ -635,7 +695,8 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
 
        (void)cb_data;
 
-       if (sdi->status != SR_ST_ACTIVE) return SR_ERR_DEV_CLOSED;
+       if (sdi->status != SR_ST_ACTIVE)
+               return SR_ERR_DEV_CLOSED;
 
        scpi = sdi->conn;
        devc = sdi->priv;
@@ -651,9 +712,9 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
                /* Only add a single digital channel. */
                if (ch->type != SR_CHANNEL_LOGIC || !digital_added) {
                        devc->enabled_channels = g_slist_append(
-                                       devc->enabled_channels, ch);
-               if (ch->type == SR_CHANNEL_LOGIC)
-                       digital_added = TRUE;
+                               devc->enabled_channels, ch);
+                       if (ch->type == SR_CHANNEL_LOGIC)
+                               digital_added = TRUE;
                }
        }
 
@@ -674,8 +735,8 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
        devc->current_channel = devc->enabled_channels;
        dlm_channel_data_request(sdi);
 
-       /* Call our callback when data comes in or after 50ms. */
-       sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 10,
+       /* Call our callback when data comes in or after 5ms. */
+       sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 5,
                        dlm_data_receive, (void *)sdi);
 
        return SR_OK;
@@ -708,7 +769,7 @@ static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 
 SR_PRIV struct sr_dev_driver yokogawa_dlm_driver_info = {
        .name = "yokogawa-dlm",
-       .longname = "Yokogawa DL/DLM driver",
+       .longname = "Yokogawa DL/DLM",
        .api_version = 1,
        .init = init,
        .cleanup = cleanup,