]> sigrok.org Git - libsigrok.git/blobdiff - src/hardware/lecroy-xstream/api.c
drivers: Factor out std_*_idx*().
[libsigrok.git] / src / hardware / lecroy-xstream / api.c
index 43b2fcfb4f610f0ba527b2e020816e0c8f77c86e..dc6ee2bcd795645bd9b3ec9740a97d506c04c4c2 100644 (file)
@@ -32,16 +32,25 @@ static const uint32_t scanopts[] = {
        SR_CONF_CONN,
 };
 
-static int check_manufacturer(const char *manufacturer)
-{
-       unsigned int i;
+static const uint32_t drvopts[] = {
+       SR_CONF_OSCILLOSCOPE,
+};
 
-       for (i = 0; i < ARRAY_SIZE(manufacturers); i++)
-               if (!strcmp(manufacturer, manufacturers[i]))
-                       return SR_OK;
+static const uint32_t 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_SOURCE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
+       SR_CONF_TRIGGER_SLOPE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
+};
 
-       return SR_ERR;
-}
+static const uint32_t devopts_cg_analog[] = {
+       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,
+};
 
 static struct sr_dev_inst *probe_serial_device(struct sr_scpi_dev_inst *scpi)
 {
@@ -53,13 +62,12 @@ static struct sr_dev_inst *probe_serial_device(struct sr_scpi_dev_inst *scpi)
        devc = NULL;
        hw_info = NULL;
 
-       sr_scpi_send(scpi, "COMM_HEADER OFF,WORD,BIN");
        if (sr_scpi_get_hw_id(scpi, &hw_info) != SR_OK) {
                sr_info("Couldn't get IDN response.");
                goto fail;
        }
 
-       if (check_manufacturer(hw_info->manufacturer) != SR_OK)
+       if (std_str_idx_s(hw_info->manufacturer, ARRAY_AND_SIZE(manufacturers)) < 0)
                goto fail;
 
        sdi = g_malloc0(sizeof(struct sr_dev_inst));
@@ -85,8 +93,7 @@ static struct sr_dev_inst *probe_serial_device(struct sr_scpi_dev_inst *scpi)
 
 fail:
        sr_scpi_hw_info_free(hw_info);
-       if (sdi)
-               sr_dev_inst_free(sdi);
+       sr_dev_inst_free(sdi);
        g_free(devc);
 
        return NULL;
@@ -97,54 +104,36 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
        return sr_scpi_scan(di->context, options, probe_serial_device);
 }
 
-static void clear_helper(void *priv)
+static void clear_helper(struct dev_context *devc)
 {
-       struct dev_context *devc;
-
-       devc = priv;
-
        lecroy_xstream_state_free(devc->model_state);
-
        g_free(devc->analog_groups);
-
-       g_free(devc);
 }
 
 static int dev_clear(const struct sr_dev_driver *di)
 {
-       return std_dev_clear(di, clear_helper);
+       return std_dev_clear_with_callback(di, (std_dev_clear_callback)clear_helper);
 }
 
 static int dev_open(struct sr_dev_inst *sdi)
 {
-       if (sdi->status != SR_ST_ACTIVE && sr_scpi_open(sdi->conn) != SR_OK)
+       if (sr_scpi_open(sdi->conn) != SR_OK)
                return SR_ERR;
 
        if (lecroy_xstream_state_get(sdi) != SR_OK)
                return SR_ERR;
 
-       sdi->status = SR_ST_ACTIVE;
-
        return SR_OK;
 }
 
 static int dev_close(struct sr_dev_inst *sdi)
 {
-       if (sdi->status == SR_ST_INACTIVE)
-               return SR_OK;
-
-       sr_scpi_close(sdi->conn);
-
-       sdi->status = SR_ST_INACTIVE;
-
-       return SR_OK;
+       return sr_scpi_close(sdi->conn);
 }
 
 static int config_get(uint32_t key, GVariant **data,
-                       const struct sr_dev_inst *sdi,
-                       const struct sr_channel_group *cg)
+       const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 {
-       int ret;
        unsigned int i;
        struct dev_context *devc;
        const struct scope_config *model;
@@ -155,27 +144,24 @@ static int config_get(uint32_t key, GVariant **data,
 
        devc = sdi->priv;
 
-       ret = SR_ERR_NA;
        model = devc->model_config;
        state = devc->model_state;
        *data = NULL;
+
        switch (key) {
        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].p,
-                                       model->timebases[state->timebase].q);
-               ret = SR_OK;
+                               model->timebases[state->timebase].p,
+                               model->timebases[state->timebase].q);
                break;
        case SR_CONF_NUM_VDIV:
                for (i = 0; i < model->analog_channels; i++) {
                        if (cg != devc->analog_groups[i])
                                continue;
                        *data = g_variant_new_int32(model->num_ydivs);
-                       ret = SR_OK;
                }
                break;
        case SR_CONF_VDIV:
@@ -183,68 +169,41 @@ static int config_get(uint32_t key, GVariant **data,
                        if (cg != devc->analog_groups[i])
                                continue;
                        *data = g_variant_new("(tt)",
-                                     model->vdivs[state->analog_channels[i].vdiv].p,
-                                     model->vdivs[state->analog_channels[i].vdiv].q);
-                       ret = SR_OK;
+                               model->vdivs[state->analog_channels[i].vdiv].p,
+                               model->vdivs[state->analog_channels[i].vdiv].q);
                }
                break;
        case SR_CONF_TRIGGER_SOURCE:
                *data = g_variant_new_string((*model->trigger_sources)[state->trigger_source]);
-               ret = SR_OK;
                break;
        case SR_CONF_TRIGGER_SLOPE:
                *data = g_variant_new_string((*model->trigger_slopes)[state->trigger_slope]);
-               ret = SR_OK;
                break;
        case SR_CONF_HORIZ_TRIGGERPOS:
                *data = g_variant_new_double(state->horiz_triggerpos);
-               ret = SR_OK;
                break;
        case SR_CONF_COUPLING:
-
                for (i = 0; i < model->analog_channels; i++) {
-                       if (cg != devc->analog_groups[i]) {
+                       if (cg != devc->analog_groups[i])
                                continue;
-                       }
                        *data = g_variant_new_string((*model->coupling_options)[state->analog_channels[i].coupling]);
-                       ret = SR_OK;
                }
                break;
        case SR_CONF_SAMPLERATE:
                *data = g_variant_new_uint64(state->sample_rate);
-               ret = SR_OK;
                break;
        case SR_CONF_ENABLED:
                *data = g_variant_new_boolean(FALSE);
-               ret = SR_OK;
                break;
        default:
-               ret = SR_ERR_NA;
-       }
-       return ret;
-}
-
-static GVariant *build_tuples(const struct sr_rational *array, unsigned int n)
-{
-       unsigned int i;
-       GVariant *rational[2];
-       GVariantBuilder gvb;
-
-       g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
-
-       for (i = 0; i < n; i++) {
-               rational[0] = g_variant_new_uint64(array[i].p);
-               rational[1] = g_variant_new_uint64(array[i].q);
-
-               /* FIXME: Valgrind reports a memory leak here. */
-               g_variant_builder_add_value(&gvb, g_variant_new_tuple(rational, 2));
+               return SR_ERR_NA;
        }
 
-       return g_variant_builder_end(&gvb);
+       return SR_OK;
 }
 
-static int config_set(uint32_t 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;
        unsigned int i, j;
@@ -359,7 +318,6 @@ static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sd
                }
                break;
        case SR_CONF_COUPLING:
-
                tmp = g_variant_get_string(data, NULL);
 
                for (i = 0; (*model->coupling_options)[i]; i++) {
@@ -368,7 +326,7 @@ static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sd
                        for (j = 1; j <= model->analog_channels; j++) {
                                if (cg != devc->analog_groups[j - 1])
                                        continue;
-                               state->analog_channels[j-1].coupling = i;
+                               state->analog_channels[j - 1].coupling = i;
 
                                g_snprintf(command, sizeof(command),
                                                "C%d:COUPLING %s", j, tmp);
@@ -397,35 +355,22 @@ static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sd
        return ret;
 }
 
-static int config_list(uint32_t 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)
 {
-       struct dev_context *devc = NULL;
-       const struct scope_config *model = NULL;
-       (void)cg;
+       struct dev_context *devc;
+       const struct scope_config *model;
 
-       if (sdi) {
-               devc = sdi->priv;
-               model = devc->model_config;
-       }
+       devc = (sdi) ? sdi->priv : NULL;
+       model = (devc) ? devc->model_config : NULL;
 
        switch (key) {
        case SR_CONF_SCAN_OPTIONS:
-               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
-                               scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
-               break;
+               return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, NULL, NULL);
        case SR_CONF_DEVICE_OPTIONS:
-               if (!cg) {
-                       *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
-                                                         model->devopts,
-                                                         model->num_devopts,
-                                                         sizeof(uint32_t));
-                       break;
-               }
-               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
-                                                 model->analog_devopts,
-                                                 model->num_analog_devopts,
-                                                 sizeof(uint32_t));
+               if (!cg)
+                       return STD_CONFIG_LIST(key, data, sdi, cg, NULL, drvopts, devopts);
+               *data = std_gvar_array_u32(ARRAY_AND_SIZE(devopts_cg_analog));
                break;
        case SR_CONF_COUPLING:
                *data = g_variant_new_strv(*model->coupling_options,
@@ -446,12 +391,12 @@ static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *
        case SR_CONF_TIMEBASE:
                if (!model)
                        return SR_ERR_ARG;
-               *data = build_tuples(model->timebases, model->num_timebases);
+               *data = std_gvar_tuple_rational(model->timebases, model->num_timebases);
                break;
        case SR_CONF_VDIV:
                if (!model)
                        return SR_ERR_ARG;
-               *data = build_tuples(model->vdivs, model->num_vdivs);
+               *data = std_gvar_tuple_rational(model->vdivs, model->num_vdivs);
                break;
        default:
                return SR_ERR_NA;
@@ -473,11 +418,11 @@ SR_PRIV int lecroy_xstream_request_data(const struct sr_dev_inst *sdi)
                return SR_ERR;
 
        g_snprintf(command, sizeof(command),
-                       "COMM_FORMAT DEF9,WORD,BIN;C%d:WAVEFORM?", ch->index+1);
+               "COMM_FORMAT DEF9,WORD,BIN;C%d:WAVEFORM?", ch->index + 1);
        return sr_scpi_send(sdi->conn, command);
 }
 
-static int lecroy_setup_channels(const struct sr_dev_inst *sdi)
+static int setup_channels(const struct sr_dev_inst *sdi)
 {
        GSList *l;
        gboolean setup_changed;
@@ -499,7 +444,7 @@ static int lecroy_setup_channels(const struct sr_dev_inst *sdi)
                        if (ch->enabled == state->analog_channels[ch->index].state)
                                break;
                        g_snprintf(command, sizeof(command), "C%d:TRACE %s",
-                                  ch->index+1, ch->enabled ? "ON" : "OFF");
+                                  ch->index + 1, ch->enabled ? "ON" : "OFF");
 
                        if (sr_scpi_send(scpi, command) != SR_OK)
                                return SR_ERR;
@@ -525,11 +470,9 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi)
        int ret;
        struct sr_scpi_dev_inst *scpi;
 
-       if (sdi->status != SR_ST_ACTIVE)
-               return SR_ERR_DEV_CLOSED;
-
        devc = sdi->priv;
        scpi = sdi->conn;
+
        /* Preset empty results. */
        g_slist_free(devc->enabled_channels);
        devc->enabled_channels = NULL;
@@ -555,7 +498,7 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi)
         * Configure the analog channels and the
         * corresponding digital pods.
         */
-       if (lecroy_setup_channels(sdi) != SR_OK) {
+       if (setup_channels(sdi) != SR_OK) {
                sr_err("Failed to setup channel configuration!");
                ret = SR_ERR;
                goto free_enabled;
@@ -577,6 +520,7 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 free_enabled:
        g_slist_free(devc->enabled_channels);
        devc->enabled_channels = NULL;
+
        return ret;
 }
 
@@ -587,9 +531,6 @@ static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 
        std_session_send_df_end(sdi);
 
-       if (sdi->status != SR_ST_ACTIVE)
-               return SR_ERR_DEV_CLOSED;
-
        devc = sdi->priv;
 
        devc->num_frames = 0;
@@ -603,7 +544,7 @@ static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 
 static struct sr_dev_driver lecroy_xstream_driver_info = {
        .name = "lecroy-xstream",
-       .longname = "LeCroy Xstream based scopes",
+       .longname = "LeCroy X-Stream",
        .api_version = 1,
        .init = std_init,
        .cleanup = std_cleanup,