]> sigrok.org Git - libsigrok.git/blobdiff - hardware/link-mso19/api.c
Replace 'probe' with 'channel' in most places.
[libsigrok.git] / hardware / link-mso19 / api.c
index 0ae1eb630174ef960a07b76245bbaf397d834438..f1b28e93bca7313a1145dc89d7b2a24606bbf151 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * This file is part of the sigrok project.
+ * This file is part of the libsigrok project.
  *
  * Copyright (C) 2011 Daniel Ribeiro <drwyrm@gmail.com>
  * Copyright (C) 2012 Renato Caldas <rmsc@fe.up.pt>
 
 #include "protocol.h"
 
-static const int hwcaps[] = {
-       SR_HWCAP_LOGIC_ANALYZER,
-       SR_HWCAP_SAMPLERATE,
-       SR_HWCAP_TRIGGER_SLOPE,
-       SR_HWCAP_HORIZ_TRIGGERPOS,
-//      SR_HWCAP_CAPTURE_RATIO,
-       SR_HWCAP_LIMIT_SAMPLES,
-//      SR_HWCAP_RLE,
-       0,
+static const int32_t hwcaps[] = {
+       SR_CONF_OSCILLOSCOPE,
+       SR_CONF_LOGIC_ANALYZER,
+       SR_CONF_SAMPLERATE,
+       SR_CONF_TRIGGER_SLOPE,
+       SR_CONF_HORIZ_TRIGGERPOS,
+//      SR_CONF_CAPTURE_RATIO,
+       SR_CONF_LIMIT_SAMPLES,
+//      SR_CONF_RLE,
 };
 
 /*
- * Probes are numbered 0 to 7.
+ * Channels are numbered 0 to 7.
  *
  * See also: http://www.linkinstruments.com/images/mso19_1113.gif
  */
-SR_PRIV const char *mso19_probe_names[NUM_PROBES + 1] = {
-       "0", "1", "2", "3", "4", "5", "6", "7", NULL
+SR_PRIV const char *mso19_channel_names[NUM_PROBES + 1] = {
+       /* Note: DSO needs to be first. */
+       "DSO", "0", "1", "2", "3", "4", "5", "6", "7", NULL,
 };
 
-/*supported samplerates */
-static const struct sr_samplerates samplerates = {
+static const uint64_t samplerates[] = {
        SR_HZ(100),
        SR_MHZ(200),
        SR_HZ(100),
-       NULL,
 };
 
 SR_PRIV struct sr_dev_driver link_mso19_driver_info;
 static struct sr_dev_driver *di = &link_mso19_driver_info;
 
-static int hw_init(struct sr_context *sr_ctx)
+/* TODO: Use sr_dev_inst to store connection handle & use std_dev_clear(). */
+static int dev_clear(void)
 {
+       GSList *l;
+       struct sr_dev_inst *sdi;
        struct drv_context *drvc;
+       struct dev_context *devc;
+       int ret = SR_OK;
+
+       if (!(drvc = di->priv))
+               return SR_OK;
 
-       if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
-               sr_err("Driver context malloc failed.");
-               return SR_ERR_MALLOC;
+       /* Properly close and free all devices. */
+       for (l = drvc->instances; l; l = l->next) {
+               if (!(sdi = l->data)) {
+                       /* Log error, but continue cleaning up the rest. */
+                       sr_err("%s: sdi was NULL, continuing", __func__);
+                       ret = SR_ERR_BUG;
+                       continue;
+               }
+               if (!(devc = sdi->priv)) {
+                       /* Log error, but continue cleaning up the rest. */
+                       sr_err("%s: sdi->priv was NULL, continuing", __func__);
+                       ret = SR_ERR_BUG;
+                       continue;
+               }
+               std_serial_dev_close(sdi);
+               sr_serial_dev_inst_free(devc->serial);
+               sr_dev_inst_free(sdi);
        }
+       g_slist_free(drvc->instances);
+       drvc->instances = NULL;
 
-       drvc->sr_ctx = sr_ctx;
-       di->priv = drvc;
+       return ret;
+}
 
-       return SR_OK;
+static int init(struct sr_context *sr_ctx)
+{
+       return std_init(sr_ctx, di, LOG_PREFIX);
 }
 
-static GSList *hw_scan(GSList *options)
+static GSList *scan(GSList *options)
 {
        int i;
        GSList *devices = NULL;
        const char *conn = NULL;
        const char *serialcomm = NULL;
        GSList *l;
-       struct sr_hwopt *opt;
+       struct sr_config *src;
        struct udev *udev;
-
-       (void)options;
+       int ptype;
 
        for (l = options; l; l = l->next) {
-               opt = l->data;
-               switch (opt->hwopt) {
-               case SR_HWOPT_CONN:
-                       conn = opt->value;
+               src = l->data;
+               switch (src->key) {
+               case SR_CONF_CONN:
+                       conn = g_variant_get_string(src->data, NULL);
                        break;
-               case SR_HWOPT_SERIALCOMM:
-                       serialcomm = opt->value;
+               case SR_CONF_SERIALCOMM:
+                       serialcomm = g_variant_get_string(src->data, NULL);
                        break;
                }
        }
@@ -193,11 +217,12 @@ static GSList *hw_scan(GSList *options)
                sdi->priv = devc;
 
                for (i = 0; i < NUM_PROBES; i++) {
-                       struct sr_probe *probe;
-                       if (!(probe = sr_probe_new(i, SR_PROBE_LOGIC, TRUE,
-                                                  mso19_probe_names[i])))
+                       struct sr_channel *ch;
+                       ptype = (i == 0) ? SR_PROBE_ANALOG : SR_PROBE_LOGIC;
+                       if (!(ch = sr_probe_new(i, ptype, TRUE,
+                                                  mso19_channel_names[i])))
                                return 0;
-                       sdi->probes = g_slist_append(sdi->probes, probe);
+                       sdi->channels = g_slist_append(sdi->channels, ch);
                }
 
                //Add the driver
@@ -209,16 +234,12 @@ static GSList *hw_scan(GSList *options)
        return devices;
 }
 
-static GSList *hw_dev_list(void)
+static GSList *dev_list(void)
 {
-       struct drv_context *drvc;
-
-       drvc = di->priv;
-
-       return drvc->instances;
+       return ((struct drv_context *)(di->priv))->instances;
 }
 
-static int hw_dev_open(struct sr_dev_inst *sdi)
+static int dev_open(struct sr_dev_inst *sdi)
 {
        int ret;
        struct dev_context *devc;
@@ -249,114 +270,59 @@ static int hw_dev_open(struct sr_dev_inst *sdi)
        return SR_OK;
 }
 
-static int hw_dev_close(struct sr_dev_inst *sdi)
+static int cleanup(void)
 {
-       struct dev_context *devc;
-
-       devc = sdi->priv;
-
-       if (devc->serial && devc->serial->fd != -1) {
-               serial_close(devc->serial);
-               sdi->status = SR_ST_INACTIVE;
-       }
-
-       return SR_OK;
+       return dev_clear();
 }
 
-static int hw_cleanup(void)
+static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi,
+               const struct sr_channel_group *cg)
 {
-       GSList *l;
-       struct sr_dev_inst *sdi;
-       struct drv_context *drvc;
        struct dev_context *devc;
-       int ret = SR_OK;
-
-       if (!(drvc = di->priv))
-               return SR_OK;
-
-       /* Properly close and free all devices. */
-       for (l = drvc->instances; l; l = l->next) {
-               if (!(sdi = l->data)) {
-                       /* Log error, but continue cleaning up the rest. */
-                       sr_err("%s: sdi was NULL, continuing", __func__);
-                       ret = SR_ERR_BUG;
-                       continue;
-               }
-               if (!(devc = sdi->priv)) {
-                       /* Log error, but continue cleaning up the rest. */
-                       sr_err("%s: sdi->priv was NULL, continuing", __func__);
-                       ret = SR_ERR_BUG;
-                       continue;
-               }
-               hw_dev_close(sdi);
-               sr_serial_dev_inst_free(devc->serial);
-               sr_dev_inst_free(sdi);
-       }
-       g_slist_free(drvc->instances);
-       drvc->instances = NULL;
-
-       return ret;
-}
 
-static int hw_info_get(int info_id, const void **data,
-                      const struct sr_dev_inst *sdi)
-{
-       struct dev_context *devc;
+       (void)cg;
 
-       switch (info_id) {
-       case SR_DI_HWCAPS:
-               *data = hwcaps;
-               break;
-       case SR_DI_NUM_PROBES:
-               *data = GINT_TO_POINTER(1);
-               break;
-       case SR_DI_PROBE_NAMES:
-               *data = mso19_probe_names;
-               break;
-       case SR_DI_SAMPLERATES:
-               *data = &samplerates;
-               break;
-       case SR_DI_TRIGGER_TYPES:
-               *data = (char *)TRIGGER_TYPES;
-               break;
-       case SR_DI_CUR_SAMPLERATE:
+       switch (id) {
+       case SR_CONF_SAMPLERATE:
                if (sdi) {
                        devc = sdi->priv;
-                       *data = &devc->cur_rate;
+                       *data = g_variant_new_uint64(devc->cur_rate);
                } else
                        return SR_ERR;
                break;
        default:
-               return SR_ERR_ARG;
+               return SR_ERR_NA;
        }
 
        return SR_OK;
 }
 
-static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
-                            const void *value)
+static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
+               const struct sr_channel_group *cg)
 {
        int ret;
        struct dev_context *devc;
-       uint64_t num_samples, slope;
+       uint64_t num_samples;
+       const char *slope;
        int trigger_pos;
-       float pos;
+       double pos;
 
+       (void)cg;
        devc = sdi->priv;
 
        if (sdi->status != SR_ST_ACTIVE)
-               return SR_ERR;
+               return SR_ERR_DEV_CLOSED;
 
-       switch (hwcap) {
-       case SR_HWCAP_SAMPLERATE:
+       switch (id) {
+       case SR_CONF_SAMPLERATE:
                // FIXME
-               return mso_configure_rate(sdi, *(const uint64_t *)value);
+               return mso_configure_rate(sdi, g_variant_get_uint64(data));
                ret = SR_OK;
                break;
-       case SR_HWCAP_LIMIT_SAMPLES:
-               num_samples = *(uint64_t *)value;
-               if (num_samples < 1024) {
-                       sr_err("minimum of 1024 samples required");
+       case SR_CONF_LIMIT_SAMPLES:
+               num_samples = g_variant_get_uint64(data);
+               if (num_samples != 1024) {
+                       sr_err("Only 1024 samples are supported.");
                        ret = SR_ERR_ARG;
                } else {
                        devc->limit_samples = num_samples;
@@ -365,21 +331,23 @@ static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
                        ret = SR_OK;
                }
                break;
-       case SR_HWCAP_CAPTURE_RATIO:
+       case SR_CONF_CAPTURE_RATIO:
                ret = SR_OK;
                break;
-       case SR_HWCAP_TRIGGER_SLOPE:
-               slope = *(uint64_t *)value;
-               if (slope != SLOPE_NEGATIVE && slope != SLOPE_POSITIVE) {
+       case SR_CONF_TRIGGER_SLOPE:
+               slope = g_variant_get_string(data, NULL);
+
+               if (!slope || !(slope[0] == 'f' || slope[0] == 'r'))
                        sr_err("Invalid trigger slope");
                        ret = SR_ERR_ARG;
                } else {
-                       devc->trigger_slope = slope;
+                       devc->trigger_slope = (slope[0] == 'r')
+                               ? SLOPE_POSITIVE : SLOPE_NEGATIVE;
                        ret = SR_OK;
                }
                break;
-       case SR_HWCAP_HORIZ_TRIGGERPOS:
-               pos = *(float *)value;
+       case SR_CONF_HORIZ_TRIGGERPOS:
+               pos = g_variant_get_double(data);
                if (pos < 0 || pos > 255) {
                        sr_err("Trigger position (%f) should be between 0 and 255.", pos);
                        ret = SR_ERR_ARG;
@@ -389,33 +357,60 @@ static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
                        ret = SR_OK;
                }
                break;
-       case SR_HWCAP_RLE:
+       case SR_CONF_RLE:
                ret = SR_OK;
                break;
        default:
-               ret = SR_ERR;
+               ret = SR_ERR_NA;
                break;
        }
 
        return ret;
 }
 
-static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
-                                   void *cb_data)
+static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
+               const struct sr_channel_group *cg)
+{
+       GVariant *gvar;
+       GVariantBuilder gvb;
+
+       (void)cg;
+       (void)sdi;
+
+       switch (key) {
+       case SR_CONF_DEVICE_OPTIONS:
+               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
+                               hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
+               break;
+       case SR_CONF_SAMPLERATE:
+               g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
+               gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
+                               ARRAY_SIZE(samplerates), sizeof(uint64_t));
+               g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar);
+               *data = g_variant_builder_end(&gvb);
+               break;
+       case SR_CONF_TRIGGER_TYPE:
+               *data = g_variant_new_string(TRIGGER_TYPE);
+               break;
+       default:
+               return SR_ERR_NA;
+       }
+
+       return SR_OK;
+}
+
+static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
 {
-       struct sr_datafeed_packet *packet;
-       struct sr_datafeed_header *header;
-       struct sr_datafeed_meta_logic meta;
        struct dev_context *devc;
        int ret = SR_ERR;
 
-       devc = sdi->priv;
-
        if (sdi->status != SR_ST_ACTIVE)
-               return SR_ERR;
+               return SR_ERR_DEV_CLOSED;
 
-       if (mso_configure_probes(sdi) != SR_OK) {
-               sr_err("Failed to configure probes.");
+       devc = sdi->priv;
+
+       if (mso_configure_channels(sdi) != SR_OK) {
+               sr_err("Failed to configure channels.");
                return SR_ERR;
        }
 
@@ -456,39 +451,22 @@ static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
        if (ret != SR_OK)
                return ret;
 
-       sr_source_add(devc->serial->fd, G_IO_IN, -1, mso_receive_data, cb_data);
-
-       if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
-               sr_err("Datafeed packet malloc failed.");
-               return SR_ERR_MALLOC;
-       }
-
-       if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) {
-               sr_err("Datafeed header malloc failed.");
-               g_free(packet);
-               return SR_ERR_MALLOC;
-       }
+       /* Reset trigger state. */
+       devc->trigger_state = 0x00;
 
-       packet->type = SR_DF_HEADER;
-       packet->payload = (unsigned char *)header;
-       header->feed_version = 1;
-       gettimeofday(&header->starttime, NULL);
-       sr_session_send(cb_data, packet);
+       /* Send header packet to the session bus. */
+       std_session_send_df_header(cb_data, LOG_PREFIX);
 
-       packet->type = SR_DF_META_LOGIC;
-       packet->payload = &meta;
-       meta.samplerate = devc->cur_rate;
-       meta.num_probes = NUM_PROBES;
-       sr_session_send(cb_data, packet);
+       /* Our first channel is analog, the other 8 are of type 'logic'. */
+       /* TODO. */
 
-       g_free(header);
-       g_free(packet);
+       serial_source_add(devc->serial, G_IO_IN, -1, mso_receive_data, cb_data);
 
        return SR_OK;
 }
 
 /* This stops acquisition on ALL devices, ignoring dev_index. */
-static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
+static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 {
        (void)cb_data;
 
@@ -501,16 +479,17 @@ SR_PRIV struct sr_dev_driver link_mso19_driver_info = {
        .name = "link-mso19",
        .longname = "Link Instruments MSO-19",
        .api_version = 1,
-       .init = hw_init,
-       .cleanup = hw_cleanup,
-       .scan = hw_scan,
-       .dev_list = hw_dev_list,
-       .dev_clear = hw_cleanup,
-       .dev_open = hw_dev_open,
-       .dev_close = hw_dev_close,
-       .info_get = hw_info_get,
-       .dev_config_set = hw_dev_config_set,
-       .dev_acquisition_start = hw_dev_acquisition_start,
-       .dev_acquisition_stop = hw_dev_acquisition_stop,
+       .init = init,
+       .cleanup = cleanup,
+       .scan = scan,
+       .dev_list = dev_list,
+       .dev_clear = dev_clear,
+       .config_get = config_get,
+       .config_set = config_set,
+       .config_list = config_list,
+       .dev_open = dev_open,
+       .dev_close = std_serial_dev_close,
+       .dev_acquisition_start = dev_acquisition_start,
+       .dev_acquisition_stop = dev_acquisition_stop,
        .priv = NULL,
 };