]> sigrok.org Git - libsigrok.git/blobdiff - src/hardware/demo/demo.c
Demo: Fix #314 by always honoring sample limit changes
[libsigrok.git] / src / hardware / demo / demo.c
index b5cb276c9747f4011ed42ef8917abe1cf3866aa5..5128b9dc652094b75790d626fae7b2936bdc7f10 100644 (file)
@@ -4,6 +4,7 @@
  * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
  * Copyright (C) 2011 Olivier Fauchon <olivier@aixmarseille.com>
  * Copyright (C) 2012 Alexandru Gagniuc <mr.nuke.me@gmail.com>
+ * Copyright (C) 2015 Bartosz Golaszewski <bgolaszewski@baylibre.com>
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -103,6 +104,8 @@ struct analog_gen {
        float pattern_data[ANALOG_BUFSIZE];
        unsigned int num_samples;
        struct sr_datafeed_analog packet;
+       float avg_val; /* Average value */
+       unsigned num_avgs; /* Number of samples averaged */
 };
 
 /* Private, per-device-instance driver context. */
@@ -126,6 +129,14 @@ struct dev_context {
        /* Analog */
        int32_t num_analog_channels;
        GHashTable *ch_ag;
+       gboolean avg; /* True if averaging is enabled */
+       uint64_t avg_samples;
+};
+
+static const uint32_t drvopts[] = {
+       SR_CONF_DEMO_DEV,
+       SR_CONF_LOGIC_ANALYZER,
+       SR_CONF_OSCILLOSCOPE,
 };
 
 static const uint32_t scanopts[] = {
@@ -134,23 +145,23 @@ static const uint32_t scanopts[] = {
 };
 
 static const uint32_t devopts[] = {
-       SR_CONF_DEMO_DEV,
-       SR_CONF_LOGIC_ANALYZER,
-       SR_CONF_OSCILLOSCOPE,
-       SR_CONF_CONTINUOUS,
+       SR_CONF_CONTINUOUS | SR_CONF_SET,
        SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
        SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
-};
-
-static const uint32_t devopts_global[] = {
        SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
+       SR_CONF_AVERAGING | SR_CONF_GET | SR_CONF_SET,
+       SR_CONF_AVG_SAMPLES | SR_CONF_GET | SR_CONF_SET,
 };
 
 static const uint32_t devopts_cg_logic[] = {
        SR_CONF_PATTERN_MODE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
 };
 
-static const uint32_t devopts_cg_analog[] = {
+static const uint32_t devopts_cg_analog_group[] = {
+       SR_CONF_AMPLITUDE | SR_CONF_GET | SR_CONF_SET,
+};
+
+static const uint32_t devopts_cg_analog_channel[] = {
        SR_CONF_PATTERN_MODE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
        SR_CONF_AMPLITUDE | SR_CONF_GET | SR_CONF_SET,
 };
@@ -161,7 +172,7 @@ static const uint64_t samplerates[] = {
        SR_HZ(1),
 };
 
-static uint8_t pattern_sigrok[] = {
+static const uint8_t pattern_sigrok[] = {
        0x4c, 0x92, 0x92, 0x92, 0x64, 0x00, 0x00, 0x00,
        0x82, 0xfe, 0xfe, 0x82, 0x00, 0x00, 0x00, 0x00,
        0x7c, 0x82, 0x82, 0x92, 0x74, 0x00, 0x00, 0x00,
@@ -173,12 +184,10 @@ static uint8_t pattern_sigrok[] = {
 };
 
 SR_PRIV struct sr_dev_driver demo_driver_info;
-static struct sr_dev_driver *di = &demo_driver_info;
 
 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data);
 
-
-static int init(struct sr_context *sr_ctx)
+static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
 {
        return std_init(sr_ctx, di, LOG_PREFIX);
 }
@@ -202,31 +211,29 @@ static void generate_analog_pattern(struct analog_gen *ag, uint64_t sample_rate)
                        if (i % 5 == 0)
                                value = -value;
                        if (i % 10 == 0)
-                               last_end = i - 1;
+                               last_end = i;
                        ag->pattern_data[i] = value;
                }
                ag->num_samples = last_end;
                break;
-
        case PATTERN_SINE:
                frequency = (double) sample_rate / ANALOG_SAMPLES_PER_PERIOD;
 
                /* Make sure the number of samples we put out is an integer
                 * multiple of our period size */
                /* FIXME we actually need only one period. A ringbuffer would be
-                * usefull here.*/
+                * useful here. */
                while (num_samples % ANALOG_SAMPLES_PER_PERIOD != 0)
                        num_samples--;
 
                for (i = 0; i < num_samples; i++) {
                        t = (double) i / (double) sample_rate;
                        ag->pattern_data[i] = ag->amplitude *
-                                               sin(2 * M_PI * frequency * t);
+                                               sin(2 * G_PI * frequency * t);
                }
 
                ag->num_samples = num_samples;
                break;
-
        case PATTERN_TRIANGLE:
                frequency = (double) sample_rate / ANALOG_SAMPLES_PER_PERIOD;
 
@@ -235,13 +242,12 @@ static void generate_analog_pattern(struct analog_gen *ag, uint64_t sample_rate)
 
                for (i = 0; i < num_samples; i++) {
                        t = (double) i / (double) sample_rate;
-                       ag->pattern_data[i] = (2 * ag->amplitude / M_PI) *
-                                               asin(sin(2 * M_PI * frequency * t));
+                       ag->pattern_data[i] = (2 * ag->amplitude / G_PI) *
+                                               asin(sin(2 * G_PI * frequency * t));
                }
 
                ag->num_samples = num_samples;
                break;
-
        case PATTERN_SAWTOOTH:
                frequency = (double) sample_rate / ANALOG_SAMPLES_PER_PERIOD;
 
@@ -259,7 +265,7 @@ static void generate_analog_pattern(struct analog_gen *ag, uint64_t sample_rate)
        }
 }
 
-static GSList *scan(GSList *options)
+static GSList *scan(struct sr_dev_driver *di, GSList *options)
 {
        struct drv_context *drvc;
        struct dev_context *devc;
@@ -290,9 +296,9 @@ static GSList *scan(GSList *options)
 
        devices = NULL;
 
-       sdi = sr_dev_inst_new();
+       sdi = g_malloc0(sizeof(struct sr_dev_inst));
        sdi->status = SR_ST_ACTIVE;
-       sdi->model = "Demo device";
+       sdi->model = g_strdup("Demo device");
        sdi->driver = di;
 
        devc = g_malloc(sizeof(struct dev_context));
@@ -305,15 +311,15 @@ static GSList *scan(GSList *options)
        devc->logic_unitsize = (devc->num_logic_channels + 7) / 8;
        devc->logic_pattern = PATTERN_SIGROK;
        devc->num_analog_channels = num_analog_channels;
+       devc->avg = FALSE;
+       devc->avg_samples = 0;
 
        /* Logic channels, all in one channel group. */
        cg = g_malloc0(sizeof(struct sr_channel_group));
        cg->name = g_strdup("Logic");
        for (i = 0; i < num_logic_channels; i++) {
                sprintf(channel_name, "D%d", i);
-               if (!(ch = sr_channel_new(i, SR_CHANNEL_LOGIC, TRUE, channel_name)))
-                       return NULL;
-               sdi->channels = g_slist_append(sdi->channels, ch);
+               ch = sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE, channel_name);
                cg->channels = g_slist_append(cg->channels, ch);
        }
        sdi->channel_groups = g_slist_append(NULL, cg);
@@ -328,9 +334,8 @@ static GSList *scan(GSList *options)
        devc->ch_ag = g_hash_table_new(g_direct_hash, g_direct_equal);
        for (i = 0; i < num_analog_channels; i++) {
                snprintf(channel_name, 16, "A%d", i);
-               ch = sr_channel_new(i + num_logic_channels, SR_CHANNEL_ANALOG,
+               ch = sr_channel_new(sdi, i + num_logic_channels, SR_CHANNEL_ANALOG,
                                TRUE, channel_name);
-               sdi->channels = g_slist_append(sdi->channels, ch);
                acg->channels = g_slist_append(acg->channels, ch);
 
                /* Every analog channel gets its own channel group as well. */
@@ -348,6 +353,8 @@ static GSList *scan(GSList *options)
                ag->packet.unit = SR_UNIT_VOLT;
                ag->packet.data = ag->pattern_data;
                ag->pattern = pattern;
+               ag->avg_val = 0.0f;
+               ag->num_avgs = 0;
                g_hash_table_insert(devc->ch_ag, ch, ag);
 
                if (++pattern == ARRAY_SIZE(analog_pattern_str))
@@ -361,7 +368,7 @@ static GSList *scan(GSList *options)
        return devices;
 }
 
-static GSList *dev_list(void)
+static GSList *dev_list(const struct sr_dev_driver *di)
 {
        return ((struct drv_context *)(di->priv))->instances;
 }
@@ -396,7 +403,7 @@ static void clear_helper(void *priv)
        g_free(devc);
 }
 
-static int cleanup(void)
+static int cleanup(const struct sr_dev_driver *di)
 {
        return std_dev_clear(di, clear_helper);
 }
@@ -423,6 +430,12 @@ static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *s
        case SR_CONF_LIMIT_MSEC:
                *data = g_variant_new_uint64(devc->limit_msec);
                break;
+       case SR_CONF_AVERAGING:
+               *data = g_variant_new_boolean(devc->avg);
+               break;
+       case SR_CONF_AVG_SAMPLES:
+               *data = g_variant_new_uint64(devc->avg_samples);
+               break;
        case SR_CONF_PATTERN_MODE:
                if (!cg)
                        return SR_ERR_CHANNEL_GROUP;
@@ -475,17 +488,22 @@ static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sd
        switch (key) {
        case SR_CONF_SAMPLERATE:
                devc->cur_samplerate = g_variant_get_uint64(data);
-               sr_dbg("Setting samplerate to %" PRIu64, devc->cur_samplerate);
                break;
        case SR_CONF_LIMIT_SAMPLES:
                devc->limit_msec = 0;
                devc->limit_samples = g_variant_get_uint64(data);
-               sr_dbg("Setting sample limit to %" PRIu64, devc->limit_samples);
                break;
        case SR_CONF_LIMIT_MSEC:
                devc->limit_msec = g_variant_get_uint64(data);
                devc->limit_samples = 0;
-               sr_dbg("Setting time limit to %" PRIu64"ms", devc->limit_msec);
+               break;
+       case SR_CONF_AVERAGING:
+               devc->avg = g_variant_get_boolean(data);
+               sr_dbg("%s averaging", devc->avg ? "Enabling" : "Disabling");
+               break;
+       case SR_CONF_AVG_SAMPLES:
+               devc->avg_samples = g_variant_get_uint64(data);
+               sr_dbg("Setting averaging rate to %" PRIu64, devc->avg_samples);
                break;
        case SR_CONF_PATTERN_MODE:
                if (!cg)
@@ -555,8 +573,6 @@ static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *
        GVariant *gvar;
        GVariantBuilder gvb;
 
-       (void)sdi;
-
        if (key == SR_CONF_SCAN_OPTIONS) {
                *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
                                scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
@@ -565,7 +581,7 @@ static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *
 
        if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
                *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
-                               devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
+                               drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
                return SR_OK;
        }
 
@@ -576,7 +592,7 @@ static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *
                switch (key) {
                case SR_CONF_DEVICE_OPTIONS:
                        *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
-                                       devopts_global, ARRAY_SIZE(devopts_global), sizeof(uint32_t));
+                                       devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
                        break;
                case SR_CONF_SAMPLERATE:
                        g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
@@ -589,22 +605,31 @@ static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *
                        return SR_ERR_NA;
                }
        } else {
-               /* Any channel in the group will do. */
                ch = cg->channels->data;
                switch (key) {
                case SR_CONF_DEVICE_OPTIONS:
                        if (ch->type == SR_CHANNEL_LOGIC)
-                               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
+                               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
                                                devopts_cg_logic, ARRAY_SIZE(devopts_cg_logic),
                                                sizeof(uint32_t));
-                       else if (ch->type == SR_CHANNEL_ANALOG)
-                               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
-                                               devopts_cg_analog, ARRAY_SIZE(devopts_cg_analog),
-                                               sizeof(uint32_t));
+                       else if (ch->type == SR_CHANNEL_ANALOG) {
+                               if (strcmp(cg->name, "Analog") == 0)
+                                       *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
+                                                       devopts_cg_analog_group, ARRAY_SIZE(devopts_cg_analog_group),
+                                                       sizeof(uint32_t));
+                               else
+                                       *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
+                                                       devopts_cg_analog_channel, ARRAY_SIZE(devopts_cg_analog_channel),
+                                                       sizeof(uint32_t));
+                       }
                        else
                                return SR_ERR_BUG;
                        break;
                case SR_CONF_PATTERN_MODE:
+                       /* The analog group (with all 4 channels) shall not have a pattern property. */
+                       if (strcmp(cg->name, "Analog") == 0)
+                               return SR_ERR_NA;
+
                        if (ch->type == SR_CHANNEL_LOGIC)
                                *data = g_variant_new_strv(logic_pattern_str,
                                                ARRAY_SIZE(logic_pattern_str));
@@ -663,6 +688,65 @@ static void logic_generator(struct sr_dev_inst *sdi, uint64_t size)
        }
 }
 
+static void send_analog_packet(struct analog_gen *ag,
+                              struct sr_dev_inst *sdi,
+                              uint64_t *analog_sent,
+                              uint64_t analog_todo)
+{
+       struct sr_datafeed_packet packet;
+       struct dev_context *devc;
+       uint64_t sending_now, to_avg;
+       int ag_pattern_pos;
+       unsigned int i;
+
+       devc = sdi->priv;
+       packet.type = SR_DF_ANALOG;
+       packet.payload = &ag->packet;
+
+       if (!devc->avg) {
+               ag_pattern_pos = devc->analog_counter % ag->num_samples;
+               sending_now = MIN(analog_todo, ag->num_samples-ag_pattern_pos);
+               ag->packet.data = ag->pattern_data + ag_pattern_pos;
+               ag->packet.num_samples = sending_now;
+               sr_session_send(sdi, &packet);
+
+               /* Whichever channel group gets there first. */
+               *analog_sent = MAX(*analog_sent, sending_now);
+       } else {
+               ag_pattern_pos = devc->analog_counter % ag->num_samples;
+               to_avg = MIN(analog_todo, ag->num_samples-ag_pattern_pos);
+
+               for (i = 0; i < to_avg; i++) {
+                       ag->avg_val = (ag->avg_val +
+                                       *(ag->pattern_data +
+                                         ag_pattern_pos + i)) / 2;
+                       ag->num_avgs++;
+                       /* Time to send averaged data? */
+                       if (devc->avg_samples > 0 &&
+                           ag->num_avgs >= devc->avg_samples)
+                               goto do_send;
+               }
+
+               if (devc->avg_samples == 0) {
+                       /* We're averaging all the samples, so wait with
+                        * sending until the very end.
+                        */
+                       *analog_sent = ag->num_avgs;
+                       return;
+               }
+
+do_send:
+               ag->packet.data = &ag->avg_val;
+               ag->packet.num_samples = 1;
+
+               sr_session_send(sdi, &packet);
+               *analog_sent = ag->num_avgs;
+
+               ag->num_avgs = 0;
+               ag->avg_val = 0.0f;
+       }
+}
+
 /* Callback handling data */
 static int prepare_data(int fd, int revents, void *cb_data)
 {
@@ -686,16 +770,16 @@ static int prepare_data(int fd, int revents, void *cb_data)
        /* How many samples should we have sent by now? */
        time = g_get_monotonic_time();
        elapsed = time - devc->starttime;
-       expected_samplenum = elapsed * devc->cur_samplerate / 1000000;
+       expected_samplenum = elapsed * devc->cur_samplerate / (1000 * 1000);
 
        /* But never more than the limit, if there is one. */
        if (!devc->continuous)
                expected_samplenum = MIN(expected_samplenum, devc->limit_samples);
 
        /* Of those, how many do we still have to send? */
-       if (devc->num_logic_channels)
+       if (devc->num_logic_channels && (devc->logic_counter < devc->limit_samples))
                logic_todo = expected_samplenum - devc->logic_counter;
-       if (devc->num_analog_channels)
+       if (devc->num_analog_channels && (devc->analog_counter < devc->limit_samples))
                analog_todo = expected_samplenum - devc->analog_counter;
 
        while (logic_todo || analog_todo) {
@@ -719,21 +803,8 @@ static int prepare_data(int fd, int revents, void *cb_data)
 
                        g_hash_table_iter_init(&iter, devc->ch_ag);
                        while (g_hash_table_iter_next(&iter, NULL, &value)) {
-                               ag = value;
-                               packet.type = SR_DF_ANALOG;
-                               packet.payload = &ag->packet;
-
-                               /* FIXME we should make sure we output a whole
-                                * period of data before we send out again the
-                                * beginning of our buffer. A ring buffer would
-                                * help here as well */
-
-                               sending_now = MIN(analog_todo, ag->num_samples);
-                               ag->packet.num_samples = sending_now;
-                               sr_session_send(sdi, &packet);
-
-                               /* Whichever channel group gets there first. */
-                               analog_sent = MAX(analog_sent, sending_now);
+                               send_analog_packet(value, sdi,
+                                                  &analog_sent, analog_todo);
                        }
                        analog_todo -= analog_sent;
                        devc->analog_counter += analog_sent;
@@ -743,6 +814,19 @@ static int prepare_data(int fd, int revents, void *cb_data)
        if (!devc->continuous
                        && (!devc->num_logic_channels || devc->logic_counter >= devc->limit_samples)
                        && (!devc->num_analog_channels || devc->analog_counter >= devc->limit_samples)) {
+               /* If we're averaging everything - now is the time to send data */
+               if (devc->avg_samples == 0) {
+                       g_hash_table_iter_init(&iter, devc->ch_ag);
+                       while (g_hash_table_iter_next(&iter, NULL, &value)) {
+                               ag = value;
+                               packet.type = SR_DF_ANALOG;
+                               packet.payload = &ag->packet;
+                               ag->packet.data = &ag->avg_val;
+                               ag->packet.num_samples = 1;
+                               sr_session_send(sdi, &packet);
+                       }
+               }
+
                sr_dbg("Requested number of samples reached.");
                dev_acquisition_stop(sdi, cb_data);
                return TRUE;