]> sigrok.org Git - libsigrok.git/blobdiff - src/hardware/yokogawa-dlm/api.c
drivers: Factor out std_*_idx*().
[libsigrok.git] / src / hardware / yokogawa-dlm / api.c
index 61c71ea8320d0101992180d6fd5970d656d4360b..21b7e40a06f4bba765778f9028f3941706c15ee2 100644 (file)
 #include "scpi.h"
 #include "protocol.h"
 
-SR_PRIV struct sr_dev_driver yokogawa_dlm_driver_info;
+static struct sr_dev_driver yokogawa_dlm_driver_info;
 
 static const char *MANUFACTURER_ID = "YOKOGAWA";
-static const char *MANUFACTURER_NAME = "Yokogawa";
 
-static const uint32_t dlm_scanopts[] = {
+static const uint32_t scanopts[] = {
        SR_CONF_CONN,
 };
 
-static const uint32_t dlm_drvopts[] = {
+static const uint32_t drvopts[] = {
        SR_CONF_LOGIC_ANALYZER,
        SR_CONF_OSCILLOSCOPE,
 };
 
-static const uint32_t dlm_devopts[] = {
+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_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_TRIGGER_SLOPE | 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,
+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 const uint32_t dlm_digital_devopts[] = {
+static const uint32_t devopts_cg_digital[] = {
 };
 
 enum {
@@ -63,11 +62,6 @@ enum {
        CG_DIGITAL,
 };
 
-static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
-{
-       return std_init(sr_ctx, di, LOG_PREFIX);
-}
-
 static struct sr_dev_inst *probe_usbtmc_device(struct sr_scpi_dev_inst *scpi)
 {
        struct sr_dev_inst *sdi;
@@ -92,8 +86,7 @@ static struct sr_dev_inst *probe_usbtmc_device(struct sr_scpi_dev_inst *scpi)
                goto fail;
 
        sdi = g_malloc0(sizeof(struct sr_dev_inst));
-       sdi->status = SR_ST_ACTIVE;
-       sdi->vendor = g_strdup(MANUFACTURER_NAME);
+       sdi->vendor = g_strdup("Yokogawa");
        sdi->model = g_strdup(model_name);
        sdi->version = g_strdup(hw_info->firmware_version);
 
@@ -112,16 +105,11 @@ static struct sr_dev_inst *probe_usbtmc_device(struct sr_scpi_dev_inst *scpi)
        if (dlm_device_init(sdi, model_index) != SR_OK)
                goto fail;
 
-       sr_scpi_close(sdi->conn);
-
-       sdi->status = SR_ST_INACTIVE;
        return sdi;
 
 fail:
-       if (hw_info)
-               sr_scpi_hw_info_free(hw_info);
-       if (sdi)
-               sr_dev_inst_free(sdi);
+       sr_scpi_hw_info_free(hw_info);
+       sr_dev_inst_free(sdi);
        g_free(devc);
 
        return NULL;
@@ -132,59 +120,32 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
        return sr_scpi_scan(di->context, options, probe_usbtmc_device);
 }
 
-static GSList *dev_list(const struct sr_dev_driver *di)
+static void clear_helper(struct dev_context *devc)
 {
-       return ((struct drv_context *)(di->context))->instances;
-}
-
-static void clear_helper(void *priv)
-{
-       struct dev_context *devc;
-
-       devc = priv;
-
        dlm_scope_state_destroy(devc->model_state);
-
        g_free(devc->analog_groups);
        g_free(devc->digital_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 (dlm_scope_state_query(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;
-}
-
-static int cleanup(const struct sr_dev_driver *di)
-{
-       dev_clear(di);
-
-       return SR_OK;
+       return sr_scpi_close(sdi->conn);
 }
 
 /**
@@ -221,8 +182,8 @@ static int check_channel_group(struct dev_context *devc,
        return CG_INVALID;
 }
 
-static int config_get(uint32_t 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;
@@ -230,9 +191,11 @@ static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *s
        const struct scope_config *model;
        struct scope_state *state;
 
-       if (!sdi || !(devc = sdi->priv))
+       if (!sdi)
                return SR_ERR_ARG;
 
+       devc = sdi->priv;
+
        if ((cg_type = check_channel_group(devc, cg)) == CG_INVALID)
                return SR_ERR;
 
@@ -252,7 +215,6 @@ static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *s
                break;
        case SR_CONF_NUM_VDIV:
                if (cg_type == CG_NONE) {
-                       sr_err("No channel group specified.");
                        return SR_ERR_CHANNEL_GROUP;
                } else if (cg_type == CG_ANALOG) {
                                *data = g_variant_new_int32(model->num_ydivs);
@@ -265,7 +227,6 @@ static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *s
        case SR_CONF_VDIV:
                ret = SR_ERR_NA;
                if (cg_type == CG_NONE) {
-                       sr_err("No channel group specified.");
                        return SR_ERR_CHANNEL_GROUP;
                } else if (cg_type != CG_ANALOG)
                        break;
@@ -295,7 +256,6 @@ static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *s
        case SR_CONF_COUPLING:
                ret = SR_ERR_NA;
                if (cg_type == CG_NONE) {
-                       sr_err("No channel group specified.");
                        return SR_ERR_CHANNEL_GROUP;
                } else if (cg_type != CG_ANALOG)
                        break;
@@ -319,36 +279,16 @@ static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *s
        return ret;
 }
 
-static GVariant *build_tuples(const uint64_t (*array)[][2], unsigned int n)
+static int config_set(uint32_t key, GVariant *data,
+       const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 {
-       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][0]);
-               rational[1] = g_variant_new_uint64((*array)[i][1]);
-
-               /* FIXME: Valgrind reports a memory leak here. */
-               g_variant_builder_add_value(&gvb, g_variant_new_tuple(rational, 2));
-       }
-
-       return g_variant_builder_end(&gvb);
-}
-
-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;
+       int ret, cg_type, idx;
        unsigned int i, j;
        char float_str[30];
        struct dev_context *devc;
        const struct scope_config *model;
        struct scope_state *state;
        const char *tmp;
-       uint64_t p, q;
        double tmp_d;
        gboolean update_sample_rate;
 
@@ -381,48 +321,31 @@ static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sd
                }
                break;
        case SR_CONF_VDIV:
-               if (cg_type == CG_NONE) {
-                       sr_err("No channel group specified.");
+               if (cg_type == CG_NONE)
                        return SR_ERR_CHANNEL_GROUP;
-               }
-
-               g_variant_get(data, "(tt)", &p, &q);
-
-               for (i = 0; i < ARRAY_SIZE(dlm_vdivs); i++) {
-                       if (p != dlm_vdivs[i][0] ||
-                                       q != dlm_vdivs[i][1])
+               if ((idx = std_u64_tuple_idx(data, ARRAY_AND_SIZE(dlm_vdivs))) < 0)
+                       return SR_ERR_ARG;
+               for (j = 1; j <= model->analog_channels; j++) {
+                       if (cg != devc->analog_groups[j - 1])
                                continue;
-                       for (j = 1; j <= model->analog_channels; j++) {
-                               if (cg != devc->analog_groups[j - 1])
-                                       continue;
-                               state->analog_states[j - 1].vdiv = i;
-                               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)
-                                       return SR_ERR;
-
-                               break;
-                       }
-
-                       ret = SR_OK;
+                       state->analog_states[j - 1].vdiv = idx;
+                       g_ascii_formatd(float_str, sizeof(float_str),
+                                       "%E", (float) dlm_vdivs[idx][0] / dlm_vdivs[idx][1]);
+                       if (dlm_analog_chan_vdiv_set(sdi->conn, j, float_str) != SR_OK ||
+                                       sr_scpi_get_opc(sdi->conn) != SR_OK)
+                               return SR_ERR;
                        break;
                }
+               ret = SR_OK;
                break;
        case SR_CONF_TIMEBASE:
-               g_variant_get(data, "(tt)", &p, &q);
-
-               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),
-                                       "%E", (float) p / q);
-                       ret = dlm_timebase_set(sdi->conn, float_str);
-                       update_sample_rate = TRUE;
-                       break;
-               }
+               if ((idx = std_u64_tuple_idx(data, ARRAY_AND_SIZE(dlm_timebases))) < 0)
+                       return SR_ERR_ARG;
+               state->timebase = idx;
+               g_ascii_formatd(float_str, sizeof(float_str),
+                               "%E", (float) dlm_timebases[idx][0] / dlm_timebases[idx][1]);
+               ret = dlm_timebase_set(sdi->conn, float_str);
+               update_sample_rate = TRUE;
                break;
        case SR_CONF_HORIZ_TRIGGERPOS:
                tmp_d = g_variant_get_double(data);
@@ -453,10 +376,8 @@ static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sd
                ret = dlm_trigger_slope_set(sdi->conn, state->trigger_slope);
                break;
        case SR_CONF_COUPLING:
-               if (cg_type == CG_NONE) {
-                       sr_err("No channel group specified.");
+               if (cg_type == CG_NONE)
                        return SR_ERR_CHANNEL_GROUP;
-               }
 
                tmp = g_variant_get_string(data, NULL);
 
@@ -493,7 +414,7 @@ static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sd
 }
 
 static int config_channel_set(const struct sr_dev_inst *sdi,
-                       struct sr_channel *ch, unsigned int changes)
+       struct sr_channel *ch, unsigned int changes)
 {
        /* Currently we only handle SR_CHANNEL_SET_ENABLED. */
        if (changes != SR_CHANNEL_SET_ENABLED)
@@ -502,45 +423,23 @@ static int config_channel_set(const struct sr_dev_inst *sdi,
        return dlm_channel_state_set(sdi, ch->index, ch->enabled);
 }
 
-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)
 {
        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 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;
+       struct dev_context *devc;
+       const struct scope_config *model;
 
-       devc = sdi->priv;
-       model = devc->model_config;
+       devc = (sdi) ? sdi->priv : NULL;
+       model = (devc) ? devc->model_config : NULL;
 
-       /*
-        * 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_SCAN_OPTIONS:
                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;
+                       return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
                case SR_CONF_TIMEBASE:
-                       *data = build_tuples(&dlm_timebases, ARRAY_SIZE(dlm_timebases));
+                       *data = std_gvar_tuple_array(ARRAY_AND_SIZE(dlm_timebases));
                        return SR_OK;
                case SR_CONF_TRIGGER_SOURCE:
                        if (!model)
@@ -565,16 +464,12 @@ static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *
 
        switch (key) {
        case SR_CONF_DEVICE_OPTIONS:
-               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_UINT32,
-                               NULL, 0, sizeof(uint32_t));
-               }
+               if (cg_type == CG_ANALOG)
+                       *data = std_gvar_array_u32(ARRAY_AND_SIZE(devopts_cg_analog));
+               else if (cg_type == CG_DIGITAL)
+                       *data = std_gvar_array_u32(ARRAY_AND_SIZE(devopts_cg_digital));
+               else
+                       *data = std_gvar_array_u32(NULL, 0);
                break;
        case SR_CONF_COUPLING:
                if (cg_type == CG_NONE)
@@ -585,7 +480,7 @@ static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *
        case SR_CONF_VDIV:
                if (cg_type == CG_NONE)
                        return SR_ERR_CHANNEL_GROUP;
-               *data = build_tuples(&dlm_vdivs, ARRAY_SIZE(dlm_vdivs));
+               *data = std_gvar_tuple_array(ARRAY_AND_SIZE(dlm_vdivs));
                break;
        default:
                return SR_ERR_NA;
@@ -625,7 +520,7 @@ static int dlm_check_channels(GSList *channels)
        return SR_OK;
 }
 
-static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
+static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 {
        GSList *l;
        gboolean digital_added;
@@ -633,11 +528,6 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
        struct dev_context *devc;
        struct sr_scpi_dev_inst *scpi;
 
-       (void)cb_data;
-
-       if (sdi->status != SR_ST_ACTIVE)
-               return SR_ERR_DEV_CLOSED;
-
        scpi = sdi->conn;
        devc = sdi->priv;
        digital_added = FALSE;
@@ -670,26 +560,17 @@ 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 5ms. */
        sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 5,
                        dlm_data_receive, (void *)sdi);
 
        return SR_OK;
 }
 
-static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
+static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 {
        struct dev_context *devc;
-       struct sr_datafeed_packet packet;
-
-       (void)cb_data;
-
-       packet.type = SR_DF_END;
-       packet.payload = NULL;
-       sr_session_send(sdi, &packet);
 
-       if (sdi->status != SR_ST_ACTIVE)
-               return SR_ERR_DEV_CLOSED;
+       std_session_send_df_end(sdi);
 
        devc = sdi->priv;
 
@@ -702,14 +583,14 @@ static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
        return SR_OK;
 }
 
-SR_PRIV struct sr_dev_driver yokogawa_dlm_driver_info = {
+static struct sr_dev_driver yokogawa_dlm_driver_info = {
        .name = "yokogawa-dlm",
        .longname = "Yokogawa DL/DLM",
        .api_version = 1,
-       .init = init,
-       .cleanup = cleanup,
+       .init = std_init,
+       .cleanup = std_cleanup,
        .scan = scan,
-       .dev_list = dev_list,
+       .dev_list = std_dev_list,
        .dev_clear = dev_clear,
        .config_get = config_get,
        .config_set = config_set,
@@ -721,3 +602,4 @@ SR_PRIV struct sr_dev_driver yokogawa_dlm_driver_info = {
        .dev_acquisition_stop = dev_acquisition_stop,
        .context = NULL,
 };
+SR_REGISTER_DEV_DRIVER(yokogawa_dlm_driver_info);