]> sigrok.org Git - libsigrok.git/blobdiff - hardware/demo/demo.c
demo: User-configurable number of probes.
[libsigrok.git] / hardware / demo / demo.c
index b7a07c12a3ad0b44470bf0e80db570fd59666ec8..b317fefed275be6326a426fc22ca169cd83d20ea 100644 (file)
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
 
-/* 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)
+#define LOG_PREFIX "demo"
 
-/* TODO: Number of probes should be configurable. */
-#define NUM_PROBES             8
-
-#define DEMONAME               "Demo device"
+#define DEFAULT_NUM_LOGIC_PROBES     8
+#define DEFAULT_NUM_ANALOG_PROBES    4
 
 /* The size of chunks to send through the session bus. */
-/* 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"
+#define LOGIC_BUFSIZE        4096
 
-/* Supported patterns which we can generate */
+/* Patterns we can generate */
 enum {
        /**
-        * Pattern which spells "sigrok" using '0's (with '1's as "background")
-        * when displayed using the 'bits' output format.
+        * Spells "sigrok" across 8 probes using '0's (with '1's as
+        * "background") when displayed using the 'bits' output format.
+        * The pattern is repeasted every 8 probes, shifted to the right
+        * in time by one bit.
         */
        PATTERN_SIGROK,
 
-       /** Pattern which consists of (pseudo-)random values on all probes. */
+       /** Pseudo-random values on all probes. */
        PATTERN_RANDOM,
 
        /**
-        * Pattern which consists of incrementing numbers.
-        * TODO: Better description.
+        * Incrementing number across 8 probes. The pattern is repeasted
+        * every 8 probes, shifted to the right in time by one bit.
         */
        PATTERN_INC,
 
-       /** Pattern where all probes have a low logic state. */
+       /** All probes have a low logic state. */
        PATTERN_ALL_LOW,
 
-       /** Pattern where all probes have a high logic state. */
+       /** All probes have a high logic state. */
        PATTERN_ALL_HIGH,
 };
 
+static const char *pattern_strings[] = {
+       "sigrok",
+       "random",
+       "incremental",
+       "all-low",
+       "all-high",
+};
+
 /* 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;
        int64_t starttime;
+       uint64_t step;
+       int32_t num_logic_probes;
+       unsigned int logic_unitsize;
+       uint8_t logic_pattern;
+       unsigned char logic_data[LOGIC_BUFSIZE];
+       int32_t num_analog_probes;
+};
+
+static const int32_t hwopts[] = {
+       SR_CONF_NUM_LOGIC_PROBES,
+       SR_CONF_NUM_ANALOG_PROBES,
 };
 
 static const int hwcaps[] = {
@@ -109,20 +111,6 @@ static const uint64_t samplerates[] = {
        SR_HZ(1),
 };
 
-static const char *pattern_strings[] = {
-       "sigrok",
-       "random",
-       "incremental",
-       "all-low",
-       "all-high",
-};
-
-/* We name the probes 0-7 on our demo driver. */
-static const char *probe_names[NUM_PROBES + 1] = {
-       "0", "1", "2", "3", "4", "5", "6", "7",
-       NULL,
-};
-
 static uint8_t pattern_sigrok[] = {
        0x4c, 0x92, 0x92, 0x92, 0x64, 0x00, 0x00, 0x00,
        0x82, 0xfe, 0xfe, 0x82, 0x00, 0x00, 0x00, 0x00,
@@ -134,15 +122,12 @@ static uint8_t pattern_sigrok[] = {
        0xbe, 0xbe, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
 };
 
-/* Private, per-device-instance driver context. */
-/* TODO: struct context as with the other drivers. */
-
-/* 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 int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data);
 
+
 static int dev_clear(void)
 {
        return std_dev_clear(di, NULL);
@@ -155,29 +140,49 @@ static int init(struct sr_context *sr_ctx)
 
 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;
-
-       (void)options;
+       struct sr_dev_inst *sdi;
+       struct sr_probe *probe;
+       struct sr_config *src;
+       GSList *devices, *l;
+       int num_logic_probes, num_analog_probes, i;
+       char probe_name[16];
 
        drvc = di->priv;
 
-       devices = NULL;
+       num_logic_probes = DEFAULT_NUM_LOGIC_PROBES;
+       num_analog_probes = DEFAULT_NUM_ANALOG_PROBES;
+       for (l = options; l; l = l->next) {
+               src = l->data;
+               switch (src->key) {
+               case SR_CONF_NUM_LOGIC_PROBES:
+                       num_logic_probes = g_variant_get_int32(src->data);
+                       break;
+               case SR_CONF_NUM_ANALOG_PROBES:
+                       num_analog_probes = g_variant_get_int32(src->data);
+                       break;
+               }
+       }
 
-       sdi = sr_dev_inst_new(0, SR_ST_ACTIVE, DEMONAME, NULL, NULL);
+       devices = NULL;
+       sdi = sr_dev_inst_new(0, SR_ST_ACTIVE, "Demo device", NULL, NULL);
        if (!sdi) {
                sr_err("Device instance creation failed.");
                return NULL;
        }
        sdi->driver = di;
 
-       for (i = 0; probe_names[i]; i++) {
-               if (!(probe = sr_probe_new(i, SR_PROBE_LOGIC, TRUE,
-                               probe_names[i])))
+       for (i = 0; i < num_logic_probes; i++) {
+               sprintf(probe_name, "D%d", i);
+               if (!(probe = sr_probe_new(i, SR_PROBE_LOGIC, TRUE, probe_name)))
+                       return NULL;
+               sdi->probes = g_slist_append(sdi->probes, probe);
+       }
+
+       for (i = 0; i < num_analog_probes; i++) {
+               sprintf(probe_name, "A%d", i);
+               if (!(probe = sr_probe_new(i, SR_PROBE_ANALOG, TRUE, probe_name)))
                        return NULL;
                sdi->probes = g_slist_append(sdi->probes, probe);
        }
@@ -189,12 +194,14 @@ static GSList *scan(GSList *options)
                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;
+       devc->step = 0;
+       devc->num_logic_probes = num_logic_probes;
+       devc->logic_unitsize = (devc->num_logic_probes + 7) / 8;
+       devc->logic_pattern = PATTERN_SIGROK;
+       devc->num_analog_probes = num_analog_probes;
 
        sdi->priv = devc;
 
@@ -228,10 +235,11 @@ static int cleanup(void)
 static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi,
                const struct sr_probe_group *probe_group)
 {
-       struct dev_context *const devc = sdi->priv;
+       struct dev_context *devc;
 
        (void)probe_group;
 
+       devc = sdi->priv;
        switch (id) {
        case SR_CONF_SAMPLERATE:
                *data = g_variant_new_uint64(devc->cur_samplerate);
@@ -243,23 +251,13 @@ static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi,
                *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;
-               }
+               *data = g_variant_new_string(pattern_strings[devc->logic_pattern]);
+               break;
+       case SR_CONF_NUM_LOGIC_PROBES:
+               *data = g_variant_new_int32(devc->num_logic_probes);
+               break;
+       case SR_CONF_NUM_ANALOG_PROBES:
+               *data = g_variant_new_int32(devc->num_analog_probes);
                break;
        default:
                return SR_ERR_NA;
@@ -271,6 +269,7 @@ static int config_get(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)
 {
+       unsigned int i;
        int ret;
        const char *stropt;
 
@@ -282,39 +281,34 @@ static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
 
        if (id == SR_CONF_SAMPLERATE) {
                devc->cur_samplerate = g_variant_get_uint64(data);
-               sr_dbg("%s: setting samplerate to %" PRIu64, __func__,
-                      devc->cur_samplerate);
+               sr_dbg("Setting samplerate to %" PRIu64, devc->cur_samplerate);
                ret = SR_OK;
        } else if (id == SR_CONF_LIMIT_SAMPLES) {
                devc->limit_msec = 0;
                devc->limit_samples = g_variant_get_uint64(data);
-               sr_dbg("%s: setting limit_samples to %" PRIu64, __func__,
-                      devc->limit_samples);
+               sr_dbg("Setting limit_samples to %" PRIu64, devc->limit_samples);
                ret = SR_OK;
        } else if (id == SR_CONF_LIMIT_MSEC) {
                devc->limit_msec = g_variant_get_uint64(data);
                devc->limit_samples = 0;
-               sr_dbg("%s: setting limit_msec to %" PRIu64, __func__,
-                      devc->limit_msec);
+               sr_dbg("Setting limit_msec to %" PRIu64, 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)) {
-                       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;
+               ret = SR_ERR;
+               for (i = 0; i < ARRAY_SIZE(pattern_strings); i++) {
+                       if (!strcmp(stropt, pattern_strings[i])) {
+                               devc->logic_pattern = i;
+                               ret = SR_OK;
+                               break;
+                       }
                }
-               sr_dbg("%s: setting pattern to %d",
-                       __func__, devc->sample_generator);
+               /* Might as well do this now. */
+               if (i == PATTERN_ALL_LOW)
+                       memset(devc->logic_data, 0x00, LOGIC_BUFSIZE);
+               else if (i == PATTERN_ALL_HIGH)
+                       memset(devc->logic_data, 0xff, LOGIC_BUFSIZE);
+               sr_dbg("Setting pattern to %s", pattern_strings[i]);
        } else {
                ret = SR_ERR_NA;
        }
@@ -332,6 +326,10 @@ static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
        (void)probe_group;
 
        switch (key) {
+       case SR_CONF_SCAN_OPTIONS:
+               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
+                               hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
+               break;
        case SR_CONF_DEVICE_OPTIONS:
                *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
                                hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
@@ -353,55 +351,63 @@ static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
        return SR_OK;
 }
 
-static void samples_generator(uint8_t *buf, uint64_t size,
-                             struct dev_context *devc)
+static void logic_generator(struct sr_dev_inst *sdi, uint64_t size)
 {
-       static uint64_t p = 0;
-       uint64_t i;
-
-       /* TODO: Needed? */
-       memset(buf, 0, size);
-
-       switch (devc->sample_generator) {
-       case PATTERN_SIGROK: /* sigrok pattern */
-               for (i = 0; i < size; i++) {
-                       *(buf + i) = ~(pattern_sigrok[
-                               p++ % sizeof(pattern_sigrok)] >> 1);
+       struct dev_context *devc;
+       uint64_t i, j;
+       uint8_t pat;
+
+       devc = sdi->priv;
+
+       switch (devc->logic_pattern) {
+       case PATTERN_SIGROK:
+               memset(devc->logic_data, 0x00, size);
+               for (i = 0; i < size; i += devc->logic_unitsize) {
+                       for (j = 0; j < devc->logic_unitsize; j++) {
+                               pat = pattern_sigrok[(devc->step + j) % sizeof(pattern_sigrok)] >> 1;
+                               devc->logic_data[i + j] = ~pat;
+                       }
+                       devc->step++;
                }
                break;
-       case PATTERN_RANDOM: /* Random */
+       case PATTERN_RANDOM:
                for (i = 0; i < size; i++)
-                       *(buf + i) = (uint8_t)(rand() & 0xff);
+                       devc->logic_data[i] = (uint8_t)(rand() & 0xff);
                break;
-       case PATTERN_INC: /* Simple increment */
-               for (i = 0; i < size; i++)
-                       *(buf + i) = p++;
-               break;
-       case PATTERN_ALL_LOW: /* All probes are low */
-               memset(buf, 0x00, size);
+       case PATTERN_INC:
+               for (i = 0; i < size; i++) {
+                       for (j = 0; j < devc->logic_unitsize; j++) {
+                               devc->logic_data[i + j] = devc->step;
+                       }
+                       devc->step++;
+               }
                break;
-       case PATTERN_ALL_HIGH: /* All probes are high */
-               memset(buf, 0xff, size);
+       case PATTERN_ALL_LOW:
+       case PATTERN_ALL_HIGH:
+               /* These were set when the pattern mode was selected. */
                break;
        default:
-               sr_err("Unknown pattern: %d.", devc->sample_generator);
+               sr_err("Unknown pattern: %d.", devc->logic_pattern);
                break;
        }
 }
 
 /* Callback handling data */
-static int receive_data(int fd, int revents, void *cb_data)
+static int prepare_data(int fd, int revents, void *cb_data)
 {
-       struct dev_context *devc = cb_data;
+       struct sr_dev_inst *sdi;
+       struct dev_context *devc;
        struct sr_datafeed_packet packet;
        struct sr_datafeed_logic logic;
-       uint8_t buf[BUFSIZE];
-       static uint64_t samples_to_send, expected_samplenum, sending_now;
+       uint64_t samples_to_send, expected_samplenum, sending_now;
        int64_t time, elapsed;
 
        (void)fd;
        (void)revents;
 
+       sdi = cb_data;
+       devc = sdi->priv;
+
        /* How many "virtual" samples should we have collected by now? */
        time = g_get_monotonic_time();
        elapsed = time - devc->starttime;
@@ -411,27 +417,28 @@ static int receive_data(int fd, int revents, void *cb_data)
 
        if (devc->limit_samples) {
                samples_to_send = MIN(samples_to_send,
-                                devc->limit_samples - devc->samples_counter);
+                               devc->limit_samples - devc->samples_counter);
        }
 
        while (samples_to_send > 0) {
-               sending_now = MIN(samples_to_send, sizeof(buf));
+               sending_now = MIN(samples_to_send, LOGIC_BUFSIZE / devc->logic_unitsize);
                samples_to_send -= sending_now;
-               samples_generator(buf, sending_now, devc);
 
+               /* Logic */
+               logic_generator(sdi, sending_now * devc->logic_unitsize);
                packet.type = SR_DF_LOGIC;
                packet.payload = &logic;
-               logic.length = sending_now;
-               logic.unitsize = 1;
-               logic.data = buf;
-               sr_session_send(devc->cb_data, &packet);
+               logic.length = sending_now * devc->logic_unitsize;
+               logic.unitsize = devc->logic_unitsize;
+               logic.data = devc->logic_data;
+               sr_session_send(sdi, &packet);
                devc->samples_counter += sending_now;
        }
 
        if (devc->limit_samples &&
                devc->samples_counter >= devc->limit_samples) {
                sr_info("Requested number of samples reached.");
-               dev_acquisition_stop(devc->sdi, cb_data);
+               dev_acquisition_stop(sdi, cb_data);
                return TRUE;
        }
 
@@ -440,12 +447,12 @@ static int receive_data(int fd, int revents, void *cb_data)
 
 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
 {
-       struct dev_context *const devc = sdi->priv;
+       struct dev_context *devc;
 
        if (sdi->status != SR_ST_ACTIVE)
                return SR_ERR_DEV_CLOSED;
 
-       devc->cb_data = cb_data;
+       devc = sdi->priv;
        devc->samples_counter = 0;
 
        /*
@@ -456,7 +463,6 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
         * up a timeout-based polling mechanism.
         */
        if (pipe(devc->pipe_fds)) {
-               /* TODO: Better error message. */
                sr_err("%s: pipe() failed", __func__);
                return SR_ERR;
        }
@@ -472,7 +478,7 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
        g_io_channel_set_buffered(devc->channel, FALSE);
 
        sr_session_source_add_channel(devc->channel, G_IO_IN | G_IO_ERR,
-                   40, receive_data, devc);
+                       40, prepare_data, (void *)sdi);
 
        /* Send header packet to the session bus. */
        std_session_send_df_header(cb_data, LOG_PREFIX);
@@ -499,7 +505,7 @@ static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 
        /* Send last packet. */
        packet.type = SR_DF_END;
-       sr_session_send(devc->cb_data, &packet);
+       sr_session_send(sdi, &packet);
 
        return SR_OK;
 }