]> sigrok.org Git - libsigrok.git/blobdiff - hardware/demo/demo.c
drivers: return SR_ERR_NA on unsupported config key
[libsigrok.git] / hardware / demo / demo.c
index b20239a1d137e5b13364f691c2f64ab666911ac5..73fe092727f604423c21afdbd520023cd7eab799 100644 (file)
 /* TODO: Should be configurable. */
 #define BUFSIZE                4096
 
+#define STR_PATTERN_SIGROK   "sigrok"
+#define STR_PATTERN_RANDOM   "random"
+#define STR_PATTERN_INC      "incremental"
+#define STR_PATTERN_ALL_LOW  "all-low"
+#define STR_PATTERN_ALL_HIGH "all-high"
+
 /* Supported patterns which we can generate */
 enum {
        /**
@@ -75,11 +81,15 @@ enum {
 
 /* Private, per-device-instance driver context. */
 struct dev_context {
+       struct sr_dev_inst *sdi;
        int pipe_fds[2];
-       GIOChannel *channels[2];
+       GIOChannel *channel;
+       uint64_t cur_samplerate;
+       uint64_t limit_samples;
+       uint64_t limit_msec;
        uint8_t sample_generator;
        uint64_t samples_counter;
-       void *session_dev_id;
+       void *cb_data;
        int64_t starttime;
 };
 
@@ -93,11 +103,10 @@ static const int hwcaps[] = {
        SR_CONF_CONTINUOUS,
 };
 
-static const struct sr_samplerates samplerates = {
+static const uint64_t samplerates[] = {
        SR_HZ(1),
        SR_GHZ(1),
        SR_HZ(1),
-       NULL,
 };
 
 static const char *pattern_strings[] = {
@@ -106,7 +115,6 @@ static const char *pattern_strings[] = {
        "incremental",
        "all-low",
        "all-high",
-       NULL,
 };
 
 /* We name the probes 0-7 on our demo driver. */
@@ -132,10 +140,6 @@ 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);
 
@@ -148,17 +152,7 @@ static int clear_instances(void)
 
 static int hw_init(struct sr_context *sr_ctx)
 {
-       struct drv_context *drvc;
-
-       if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
-               sr_err("Driver context malloc failed.");
-               return SR_ERR_MALLOC;
-       }
-
-       drvc->sr_ctx = sr_ctx;
-       di->priv = drvc;
-
-       return SR_OK;
+       return std_hw_init(sr_ctx, di, DRIVER_LOG_DOMAIN);
 }
 
 static GSList *hw_scan(GSList *options)
@@ -166,18 +160,20 @@ static GSList *hw_scan(GSList *options)
        struct sr_dev_inst *sdi;
        struct sr_probe *probe;
        struct drv_context *drvc;
+       struct dev_context *devc;
        GSList *devices;
        int i;
 
        (void)options;
 
        drvc = di->priv;
+
        devices = NULL;
 
        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;
 
@@ -191,16 +187,25 @@ 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)
 {
-       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)
@@ -223,90 +228,143 @@ static int hw_dev_close(struct sr_dev_inst *sdi)
 
 static int hw_cleanup(void)
 {
-       /* Nothing needed so far. */
-       return SR_OK;
+       GSList *l;
+       struct sr_dev_inst *sdi;
+       struct drv_context *drvc;
+       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;
+               }
+               sr_dev_inst_free(sdi);
+       }
+       g_slist_free(drvc->instances);
+       drvc->instances = NULL;
+
+       return ret;
 }
 
-static int config_get(int id, const void **data, const struct sr_dev_inst *sdi)
+static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi)
 {
-       (void)sdi;
+       struct dev_context *const devc = sdi->priv;
 
        switch (id) {
        case SR_CONF_SAMPLERATE:
-               *data = &cur_samplerate;
+               *data = g_variant_new_uint64(devc->cur_samplerate);
+               break;
+       case SR_CONF_LIMIT_SAMPLES:
+               *data = g_variant_new_uint64(devc->limit_samples);
+               break;
+       case SR_CONF_LIMIT_MSEC:
+               *data = g_variant_new_uint64(devc->limit_msec);
+               break;
+       case SR_CONF_PATTERN_MODE:
+               switch (devc->sample_generator) {
+               case PATTERN_SIGROK:
+                       *data = g_variant_new_string(STR_PATTERN_SIGROK);
+                       break;
+               case PATTERN_RANDOM:
+                       *data = g_variant_new_string(STR_PATTERN_RANDOM);
+                       break;
+               case PATTERN_INC:
+                       *data = g_variant_new_string(STR_PATTERN_INC);
+                       break;
+               case PATTERN_ALL_LOW:
+                       *data = g_variant_new_string(STR_PATTERN_ALL_LOW);
+                       break;
+               case PATTERN_ALL_HIGH:
+                       *data = g_variant_new_string(STR_PATTERN_ALL_HIGH);
+                       break;
+               }
                break;
        default:
-               return SR_ERR_ARG;
+               return SR_ERR_NA;
        }
 
        return SR_OK;
 }
 
-static int config_set(int id, const void *value, const struct sr_dev_inst *sdi)
+static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi)
 {
        int ret;
        const char *stropt;
 
-       (void)sdi;
+       struct dev_context *const devc = sdi->priv;
 
        if (id == SR_CONF_SAMPLERATE) {
-               cur_samplerate = *(const uint64_t *)value;
+               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 = *(const uint64_t *)value;
+               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 = *(const uint64_t *)value;
-               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 = value;
+               stropt = g_variant_get_string(data, NULL);
                ret = SR_OK;
-               if (!strcmp(stropt, "sigrok")) {
-                       default_pattern = PATTERN_SIGROK;
-               } else if (!strcmp(stropt, "random")) {
-                       default_pattern = PATTERN_RANDOM;
-               } else if (!strcmp(stropt, "incremental")) {
-                       default_pattern = PATTERN_INC;
-               } else if (!strcmp(stropt, "all-low")) {
-                       default_pattern = PATTERN_ALL_LOW;
-               } else if (!strcmp(stropt, "all-high")) {
-                       default_pattern = PATTERN_ALL_HIGH;
+               if (!strcmp(stropt, STR_PATTERN_SIGROK)) {
+                       devc->sample_generator = PATTERN_SIGROK;
+               } else if (!strcmp(stropt, STR_PATTERN_RANDOM)) {
+                       devc->sample_generator = PATTERN_RANDOM;
+               } else if (!strcmp(stropt, STR_PATTERN_INC)) {
+                       devc->sample_generator = PATTERN_INC;
+               } else if (!strcmp(stropt, STR_PATTERN_ALL_LOW)) {
+                       devc->sample_generator = PATTERN_ALL_LOW;
+               } else if (!strcmp(stropt, STR_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, const void **data, const struct sr_dev_inst *sdi)
+static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
 {
+       GVariant *gvar;
+       GVariantBuilder gvb;
 
        (void)sdi;
 
        switch (key) {
        case SR_CONF_DEVICE_OPTIONS:
-               *data = hwcaps;
+               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
+                               hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
                break;
        case SR_CONF_SAMPLERATE:
-               *data = &samplerates;
+               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_PATTERN_MODE:
-               *data = &pattern_strings;
+               *data = g_variant_new_strv(pattern_strings, ARRAY_SIZE(pattern_strings));
                break;
        default:
-               return SR_ERR_ARG;
+               return SR_ERR_NA;
        }
 
        return SR_OK;
@@ -324,9 +382,8 @@ static void samples_generator(uint8_t *buf, uint64_t size,
        switch (devc->sample_generator) {
        case PATTERN_SIGROK: /* sigrok pattern */
                for (i = 0; i < size; i++) {
-                       *(buf + i) = ~(pattern_sigrok[p] >> 1);
-                       if (++p == 64)
-                               p = 0;
+                       *(buf + i) = ~(pattern_sigrok[
+                               p++ % sizeof(pattern_sigrok)] >> 1);
                }
                break;
        case PATTERN_RANDOM: /* Random */
@@ -335,7 +392,7 @@ static void samples_generator(uint8_t *buf, uint64_t size,
                break;
        case PATTERN_INC: /* Simple increment */
                for (i = 0; i < size; i++)
-                       *(buf + i) = i;
+                       *(buf + i) = p++;
                break;
        case PATTERN_ALL_LOW: /* All probes are low */
                memset(buf, 0x00, size);
@@ -365,13 +422,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) {
@@ -384,13 +441,14 @@ static int receive_data(int fd, int revents, void *cb_data)
                logic.length = sending_now;
                logic.unitsize = 1;
                logic.data = buf;
-               sr_session_send(devc->session_dev_id, &packet);
+               sr_session_send(devc->cb_data, &packet);
                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);
+               hw_dev_acquisition_stop(devc->sdi, cb_data);
                return TRUE;
        }
 
@@ -400,22 +458,9 @@ static int receive_data(int fd, int revents, void *cb_data)
 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
                void *cb_data)
 {
-       struct sr_datafeed_packet *packet;
-       struct sr_datafeed_header *header;
-       struct dev_context *devc;
-
-       (void)sdi;
+       struct dev_context *const devc = sdi->priv;
 
-       sr_dbg("Starting acquisition.");
-
-       /* 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->session_dev_id = cb_data;
+       devc->cb_data = cb_data;
        devc->samples_counter = 0;
 
        /*
@@ -431,64 +476,45 @@ static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
                return SR_ERR;
        }
 
-       devc->channels[0] = g_io_channel_unix_new(devc->pipe_fds[0]);
-       devc->channels[1] = g_io_channel_unix_new(devc->pipe_fds[1]);
+       devc->channel = g_io_channel_unix_new(devc->pipe_fds[0]);
 
-       g_io_channel_set_flags(devc->channels[0], G_IO_FLAG_NONBLOCK, NULL);
+       g_io_channel_set_flags(devc->channel, G_IO_FLAG_NONBLOCK, NULL);
 
        /* Set channel encoding to binary (default is UTF-8). */
-       g_io_channel_set_encoding(devc->channels[0], NULL, NULL);
-       g_io_channel_set_encoding(devc->channels[1], NULL, NULL);
+       g_io_channel_set_encoding(devc->channel, NULL, NULL);
 
        /* Make channels to unbuffered. */
-       g_io_channel_set_buffered(devc->channels[0], FALSE);
-       g_io_channel_set_buffered(devc->channels[1], FALSE);
+       g_io_channel_set_buffered(devc->channel, FALSE);
 
-       sr_session_source_add_channel(devc->channels[0], G_IO_IN | G_IO_ERR,
+       sr_session_source_add_channel(devc->channel, G_IO_IN | G_IO_ERR,
                    40, receive_data, devc);
 
-       if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
-               sr_err("%s: packet malloc failed", __func__);
-               return SR_ERR_MALLOC;
-       }
-
-       if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) {
-               sr_err("%s: header malloc failed", __func__);
-               return SR_ERR_MALLOC;
-       }
-
-       packet->type = SR_DF_HEADER;
-       packet->payload = header;
-       header->feed_version = 1;
-       gettimeofday(&header->starttime, NULL);
-       sr_session_send(devc->session_dev_id, packet);
+       /* Send header packet to the session bus. */
+       std_session_send_df_header(cb_data, DRIVER_LOG_DOMAIN);
 
        /* We use this timestamp to decide how many more samples to send. */
        devc->starttime = g_get_monotonic_time();
 
-       g_free(header);
-       g_free(packet);
-
        return SR_OK;
 }
 
 static int hw_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->channels[0]);
-       g_io_channel_shutdown(devc->channels[0], FALSE, NULL);
+       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;
-       sr_session_send(devc->session_dev_id, &packet);
+       sr_session_send(devc->cb_data, &packet);
 
        return SR_OK;
 }