]> sigrok.org Git - libsigrok.git/blobdiff - hardware/demo/demo.c
probe_groups: API changes required to implement probe groups.
[libsigrok.git] / hardware / demo / demo.c
index 264188b09d1b175363ccbd82e12a04a093f0b6dc..b7a07c12a3ad0b44470bf0e80db570fd59666ec8 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * This file is part of the sigrok project.
+ * This file is part of the libsigrok project.
  *
  * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
  * Copyright (C) 2011 Olivier Fauchon <olivier@aixmarseille.com>
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
 
-/* Message logging helpers with driver-specific prefix string. */
-#define DRIVER_LOG_DOMAIN "demo: "
-#define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args)
-#define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args)
-#define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args)
-#define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args)
-#define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args)
-#define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args)
+/* Message logging helpers with subsystem-specific prefix string. */
+#define LOG_PREFIX "demo: "
+#define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
+#define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
+#define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
+#define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
+#define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
+#define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)
 
 /* TODO: Number of probes should be configurable. */
 #define NUM_PROBES             8
@@ -81,8 +81,12 @@ enum {
 
 /* Private, per-device-instance driver context. */
 struct dev_context {
+       struct sr_dev_inst *sdi;
        int pipe_fds[2];
        GIOChannel *channel;
+       uint64_t cur_samplerate;
+       uint64_t limit_samples;
+       uint64_t limit_msec;
        uint8_t sample_generator;
        uint64_t samples_counter;
        void *cb_data;
@@ -136,30 +140,25 @@ static uint8_t pattern_sigrok[] = {
 /* List of struct sr_dev_inst, maintained by dev_open()/dev_close(). */
 SR_PRIV struct sr_dev_driver demo_driver_info;
 static struct sr_dev_driver *di = &demo_driver_info;
-static uint64_t cur_samplerate = SR_KHZ(200);
-static uint64_t limit_samples = 0;
-static uint64_t limit_msec = 0;
-static int default_pattern = PATTERN_SIGROK;
 
-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);
 
-static int clear_instances(void)
+static int dev_clear(void)
 {
-       /* Nothing needed so far. */
-
-       return SR_OK;
+       return std_dev_clear(di, NULL);
 }
 
-static int hw_init(struct sr_context *sr_ctx)
+static int init(struct sr_context *sr_ctx)
 {
-       return std_hw_init(sr_ctx, di, DRIVER_LOG_DOMAIN);
+       return std_init(sr_ctx, di, LOG_PREFIX);
 }
 
-static GSList *hw_scan(GSList *options)
+static GSList *scan(GSList *options)
 {
        struct sr_dev_inst *sdi;
        struct sr_probe *probe;
        struct drv_context *drvc;
+       struct dev_context *devc;
        GSList *devices;
        int i;
 
@@ -171,8 +170,8 @@ static GSList *hw_scan(GSList *options)
 
        sdi = sr_dev_inst_new(0, SR_ST_ACTIVE, DEMONAME, NULL, NULL);
        if (!sdi) {
-               sr_err("%s: sr_dev_inst_new failed", __func__);
-               return 0;
+               sr_err("Device instance creation failed.");
+               return NULL;
        }
        sdi->driver = di;
 
@@ -186,54 +185,65 @@ static GSList *hw_scan(GSList *options)
        devices = g_slist_append(devices, sdi);
        drvc->instances = g_slist_append(drvc->instances, sdi);
 
+       if (!(devc = g_try_malloc(sizeof(struct dev_context)))) {
+               sr_err("Device context malloc failed.");
+               return NULL;
+       }
+
+       devc->sdi = sdi;
+       devc->cur_samplerate = SR_KHZ(200);
+       devc->limit_samples = 0;
+       devc->limit_msec = 0;
+       devc->sample_generator = PATTERN_SIGROK;
+
+       sdi->priv = devc;
+
        return devices;
 }
 
-static GSList *hw_dev_list(void)
+static GSList *dev_list(void)
 {
        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)
 {
-       (void)sdi;
-
-       /* Nothing needed so far. */
+       sdi->status = SR_ST_ACTIVE;
 
        return SR_OK;
 }
 
-static int hw_dev_close(struct sr_dev_inst *sdi)
+static int dev_close(struct sr_dev_inst *sdi)
 {
-       (void)sdi;
-
-       /* Nothing needed so far. */
+       sdi->status = SR_ST_INACTIVE;
 
        return SR_OK;
 }
 
-static int hw_cleanup(void)
+static int cleanup(void)
 {
-       /* Nothing needed so far. */
-       return SR_OK;
+       return dev_clear();
 }
 
-static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi)
+static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi,
+               const struct sr_probe_group *probe_group)
 {
-       (void)sdi;
+       struct dev_context *const devc = sdi->priv;
+
+       (void)probe_group;
 
        switch (id) {
        case SR_CONF_SAMPLERATE:
-               *data = g_variant_new_uint64(cur_samplerate);
+               *data = g_variant_new_uint64(devc->cur_samplerate);
                break;
        case SR_CONF_LIMIT_SAMPLES:
-               *data = g_variant_new_uint64(limit_samples);
+               *data = g_variant_new_uint64(devc->limit_samples);
                break;
        case SR_CONF_LIMIT_MSEC:
-               *data = g_variant_new_uint64(limit_msec);
+               *data = g_variant_new_uint64(devc->limit_msec);
                break;
        case SR_CONF_PATTERN_MODE:
-               switch (default_pattern) {
+               switch (devc->sample_generator) {
                case PATTERN_SIGROK:
                        *data = g_variant_new_string(STR_PATTERN_SIGROK);
                        break;
@@ -252,66 +262,74 @@ static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi)
                }
                break;
        default:
-               return SR_ERR_ARG;
+               return SR_ERR_NA;
        }
 
        return SR_OK;
 }
 
-static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi)
+static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
+               const struct sr_probe_group *probe_group)
 {
        int ret;
        const char *stropt;
 
-       (void)sdi;
+       (void)probe_group;
+       struct dev_context *const devc = sdi->priv;
+
+       if (sdi->status != SR_ST_ACTIVE)
+               return SR_ERR_DEV_CLOSED;
 
        if (id == SR_CONF_SAMPLERATE) {
-               cur_samplerate = g_variant_get_uint64(data);
+               devc->cur_samplerate = g_variant_get_uint64(data);
                sr_dbg("%s: setting samplerate to %" PRIu64, __func__,
-                      cur_samplerate);
+                      devc->cur_samplerate);
                ret = SR_OK;
        } else if (id == SR_CONF_LIMIT_SAMPLES) {
-               limit_msec = 0;
-               limit_samples = g_variant_get_uint64(data);
+               devc->limit_msec = 0;
+               devc->limit_samples = g_variant_get_uint64(data);
                sr_dbg("%s: setting limit_samples to %" PRIu64, __func__,
-                      limit_samples);
+                      devc->limit_samples);
                ret = SR_OK;
        } else if (id == SR_CONF_LIMIT_MSEC) {
-               limit_msec = g_variant_get_uint64(data);
-               limit_samples = 0;
+               devc->limit_msec = g_variant_get_uint64(data);
+               devc->limit_samples = 0;
                sr_dbg("%s: setting limit_msec to %" PRIu64, __func__,
-                      limit_msec);
+                      devc->limit_msec);
                ret = SR_OK;
        } else if (id == SR_CONF_PATTERN_MODE) {
                stropt = g_variant_get_string(data, NULL);
                ret = SR_OK;
                if (!strcmp(stropt, STR_PATTERN_SIGROK)) {
-                       default_pattern = PATTERN_SIGROK;
+                       devc->sample_generator = PATTERN_SIGROK;
                } else if (!strcmp(stropt, STR_PATTERN_RANDOM)) {
-                       default_pattern = PATTERN_RANDOM;
+                       devc->sample_generator = PATTERN_RANDOM;
                } else if (!strcmp(stropt, STR_PATTERN_INC)) {
-                       default_pattern = PATTERN_INC;
+                       devc->sample_generator = PATTERN_INC;
                } else if (!strcmp(stropt, STR_PATTERN_ALL_LOW)) {
-                       default_pattern = PATTERN_ALL_LOW;
+                       devc->sample_generator = PATTERN_ALL_LOW;
                } else if (!strcmp(stropt, STR_PATTERN_ALL_HIGH)) {
-                       default_pattern = PATTERN_ALL_HIGH;
+                       devc->sample_generator = PATTERN_ALL_HIGH;
                } else {
                        ret = SR_ERR;
                }
-               sr_dbg("%s: setting pattern to %d", __func__, default_pattern);
+               sr_dbg("%s: setting pattern to %d",
+                       __func__, devc->sample_generator);
        } else {
-               ret = SR_ERR;
+               ret = SR_ERR_NA;
        }
 
        return ret;
 }
 
-static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
+static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
+               const struct sr_probe_group *probe_group)
 {
        GVariant *gvar;
        GVariantBuilder gvb;
 
        (void)sdi;
+       (void)probe_group;
 
        switch (key) {
        case SR_CONF_DEVICE_OPTIONS:
@@ -329,7 +347,7 @@ static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
                *data = g_variant_new_strv(pattern_strings, ARRAY_SIZE(pattern_strings));
                break;
        default:
-               return SR_ERR_ARG;
+               return SR_ERR_NA;
        }
 
        return SR_OK;
@@ -387,13 +405,13 @@ static int receive_data(int fd, int revents, void *cb_data)
        /* How many "virtual" samples should we have collected by now? */
        time = g_get_monotonic_time();
        elapsed = time - devc->starttime;
-       expected_samplenum = elapsed * cur_samplerate / 1000000;
+       expected_samplenum = elapsed * devc->cur_samplerate / 1000000;
        /* Of those, how many do we still have to send? */
        samples_to_send = expected_samplenum - devc->samples_counter;
 
-       if (limit_samples) {
+       if (devc->limit_samples) {
                samples_to_send = MIN(samples_to_send,
-                                limit_samples - devc->samples_counter);
+                                devc->limit_samples - devc->samples_counter);
        }
 
        while (samples_to_send > 0) {
@@ -410,29 +428,23 @@ static int receive_data(int fd, int revents, void *cb_data)
                devc->samples_counter += sending_now;
        }
 
-       if (limit_samples && devc->samples_counter >= limit_samples) {
+       if (devc->limit_samples &&
+               devc->samples_counter >= devc->limit_samples) {
                sr_info("Requested number of samples reached.");
-               hw_dev_acquisition_stop(NULL, cb_data);
+               dev_acquisition_stop(devc->sdi, cb_data);
                return TRUE;
        }
 
        return TRUE;
 }
 
-static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
-               void *cb_data)
+static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
 {
-       struct dev_context *devc;
+       struct dev_context *const devc = sdi->priv;
 
-       (void)sdi;
+       if (sdi->status != SR_ST_ACTIVE)
+               return SR_ERR_DEV_CLOSED;
 
-       /* TODO: 'devc' is never g_free()'d? */
-       if (!(devc = g_try_malloc(sizeof(struct dev_context)))) {
-               sr_err("%s: devc malloc failed", __func__);
-               return SR_ERR_MALLOC;
-       }
-
-       devc->sample_generator = default_pattern;
        devc->cb_data = cb_data;
        devc->samples_counter = 0;
 
@@ -463,7 +475,7 @@ static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
                    40, receive_data, devc);
 
        /* Send header packet to the session bus. */
-       std_session_send_df_header(cb_data, DRIVER_LOG_DOMAIN);
+       std_session_send_df_header(cb_data, LOG_PREFIX);
 
        /* We use this timestamp to decide how many more samples to send. */
        devc->starttime = g_get_monotonic_time();
@@ -471,19 +483,19 @@ static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
        return SR_OK;
 }
 
-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)
 {
-       struct dev_context *devc;
+       struct dev_context *const devc = sdi->priv;
        struct sr_datafeed_packet packet;
 
-       (void)sdi;
-
-       devc = cb_data;
+       (void)cb_data;
 
        sr_dbg("Stopping aquisition.");
 
        sr_session_source_remove_channel(devc->channel);
        g_io_channel_shutdown(devc->channel, FALSE, NULL);
+       g_io_channel_unref(devc->channel);
+       devc->channel = NULL;
 
        /* Send last packet. */
        packet.type = SR_DF_END;
@@ -496,17 +508,17 @@ SR_PRIV struct sr_dev_driver demo_driver_info = {
        .name = "demo",
        .longname = "Demo driver and pattern generator",
        .api_version = 1,
-       .init = hw_init,
-       .cleanup = hw_cleanup,
-       .scan = hw_scan,
-       .dev_list = hw_dev_list,
-       .dev_clear = clear_instances,
+       .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 = hw_dev_open,
-       .dev_close = hw_dev_close,
-       .dev_acquisition_start = hw_dev_acquisition_start,
-       .dev_acquisition_stop = hw_dev_acquisition_stop,
+       .dev_open = dev_open,
+       .dev_close = dev_close,
+       .dev_acquisition_start = dev_acquisition_start,
+       .dev_acquisition_stop = dev_acquisition_stop,
        .priv = NULL,
 };