]> sigrok.org Git - libsigrok.git/blobdiff - hardware/demo/demo.c
libsigrok: Fix #includes.
[libsigrok.git] / hardware / demo / demo.c
index 0ecaeff6dea27d26cd211f20570ca5cbc57a9544..9531d0b03f08fc943faf516b1ae2ade1fc78e931 100644 (file)
 #include <stdlib.h>
 #include <unistd.h>
 #include <string.h>
-#include <sigrok.h>
-#include <sigrok-internal.h>
 #ifdef _WIN32
 #include <io.h>
 #include <fcntl.h>
 #define pipe(fds) _pipe(fds, 4096, _O_BINARY)
 #endif
 #include "config.h"
+#include "sigrok.h"
+#include "sigrok-internal.h"
 
+/* TODO: Number of probes should be configurable. */
 #define NUM_PROBES             8
+
 #define DEMONAME               "Demo device"
-/* size of chunks to send through the session bus */
+
+/* The size of chunks to send through the session bus. */
+/* TODO: Should be configurable. */
 #define BUFSIZE                4096
 
+/* Supported patterns which we can generate */
 enum {
-       GENMODE_DEFAULT,
-       GENMODE_RANDOM,
-       GENMODE_INC,
+       /**
+        * Pattern which spells "sigrok" using '0's (with '1's as "background")
+        * when displayed using the 'bits' output format.
+        */
+       PATTERN_SIGROK,
+
+       /** Pattern which consists of (pseudo-)random values on all probes. */
+       PATTERN_RANDOM,
+
+       /**
+        * Pattern which consists of incrementing numbers.
+        * TODO: Better description.
+        */
+       PATTERN_INC,
+
+       /** Pattern where all probes have a low logic state. */
+       PATTERN_ALL_LOW,
+
+       /** Pattern where all probes have a high logic state. */
+       PATTERN_ALL_HIGH,
 };
 
 /* FIXME: Should not be global. */
@@ -51,7 +73,7 @@ struct databag {
        uint8_t thread_running;
        uint64_t samples_counter;
        int device_index;
-       gpointer session_device_id;
+       gpointer session_data;
        GTimer *timer;
 };
 
@@ -71,13 +93,16 @@ static struct sr_samplerates samplerates = {
        NULL,
 };
 
-static const char *patternmodes[] = {
+static const char *pattern_strings[] = {
+       "sigrok",
        "random",
        "incremental",
+       "all-low",
+       "all-high",
        NULL,
 };
 
-static uint8_t genmode_default[] = {
+static 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,
@@ -91,24 +116,27 @@ static uint8_t genmode_default[] = {
 /* List of struct sr_device_instance, maintained by opendev()/closedev(). */
 static GSList *device_instances = NULL;
 static uint64_t cur_samplerate = SR_KHZ(200);
+static uint64_t period_ps = 5000000;
 static uint64_t limit_samples = 0;
 static uint64_t limit_msec = 0;
-static int default_genmode = GENMODE_DEFAULT;
+static int default_pattern = PATTERN_SIGROK;
 static GThread *my_thread;
 static int thread_running;
 
-static void hw_stop_acquisition(int device_index, gpointer session_device_id);
+static void hw_stop_acquisition(int device_index, gpointer session_data);
 
 static int hw_init(const char *deviceinfo)
 {
        struct sr_device_instance *sdi;
 
        /* Avoid compiler warnings. */
-       deviceinfo = deviceinfo;
+       (void)deviceinfo;
 
        sdi = sr_device_instance_new(0, SR_ST_ACTIVE, DEMONAME, NULL, NULL);
-       if (!sdi)
+       if (!sdi) {
+               sr_err("demo: %s: sr_device_instance_new failed", __func__);
                return 0;
+       }
 
        device_instances = g_slist_append(device_instances, sdi);
 
@@ -118,7 +146,7 @@ static int hw_init(const char *deviceinfo)
 static int hw_opendev(int device_index)
 {
        /* Avoid compiler warnings. */
-       device_index = device_index;
+       (void)device_index;
 
        /* Nothing needed so far. */
 
@@ -128,7 +156,7 @@ static int hw_opendev(int device_index)
 static int hw_closedev(int device_index)
 {
        /* Avoid compiler warnings. */
-       device_index = device_index;
+       (void)device_index;
 
        /* Nothing needed so far. */
 
@@ -145,8 +173,10 @@ static void *hw_get_device_info(int device_index, int device_info_id)
        struct sr_device_instance *sdi;
        void *info = NULL;
 
-       if (!(sdi = sr_get_device_instance(device_instances, device_index)))
+       if (!(sdi = sr_get_device_instance(device_instances, device_index))) {
+               sr_err("demo: %s: sdi was NULL", __func__);
                return NULL;
+       }
 
        switch (device_info_id) {
        case SR_DI_INSTANCE:
@@ -162,7 +192,7 @@ static void *hw_get_device_info(int device_index, int device_info_id)
                info = &cur_samplerate;
                break;
        case SR_DI_PATTERNMODES:
-               info = &patternmodes;
+               info = &pattern_strings;
                break;
        }
 
@@ -172,7 +202,7 @@ static void *hw_get_device_info(int device_index, int device_info_id)
 static int hw_get_status(int device_index)
 {
        /* Avoid compiler warnings. */
-       device_index = device_index;
+       (void)device_index;
 
        return SR_ST_ACTIVE;
 }
@@ -188,13 +218,14 @@ static int hw_set_configuration(int device_index, int capability, void *value)
        char *stropt;
 
        /* Avoid compiler warnings. */
-       device_index = device_index;
+       (void)device_index;
 
        if (capability == SR_HWCAP_PROBECONFIG) {
                /* Nothing to do, but must be supported */
                ret = SR_OK;
        } else if (capability == SR_HWCAP_SAMPLERATE) {
                cur_samplerate = *(uint64_t *)value;
+               period_ps = 1000000000000 / cur_samplerate;
                sr_dbg("demo: %s: setting samplerate to %" PRIu64, __func__,
                       cur_samplerate);
                ret = SR_OK;
@@ -210,17 +241,22 @@ static int hw_set_configuration(int device_index, int capability, void *value)
                ret = SR_OK;
        } else if (capability == SR_HWCAP_PATTERN_MODE) {
                stropt = value;
-               if (!strcmp(stropt, "random")) {
-                       default_genmode = GENMODE_RANDOM;
-                       ret = SR_OK;
+               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_genmode = GENMODE_INC;
-                       ret = SR_OK;
+                       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;
                } else {
                        ret = SR_ERR;
                }
-               sr_dbg("demo: %s: setting patternmode to %d", __func__,
-                      default_genmode);
+               sr_dbg("demo: %s: setting pattern to %d", __func__,
+                      default_pattern);
        } else {
                ret = SR_ERR;
        }
@@ -234,24 +270,34 @@ static void samples_generator(uint8_t *buf, uint64_t size, void *data)
        struct databag *mydata = data;
        uint64_t i;
 
+       /* TODO: Needed? */
        memset(buf, 0, size);
 
        switch (mydata->sample_generator) {
-       case GENMODE_DEFAULT:
+       case PATTERN_SIGROK: /* sigrok pattern */
                for (i = 0; i < size; i++) {
-                       *(buf + i) = ~(genmode_default[p] >> 1);
+                       *(buf + i) = ~(pattern_sigrok[p] >> 1);
                        if (++p == 64)
                                p = 0;
                }
                break;
-       case GENMODE_RANDOM: /* Random */
+       case PATTERN_RANDOM: /* Random */
                for (i = 0; i < size; i++)
                        *(buf + i) = (uint8_t)(rand() & 0xff);
                break;
-       case GENMODE_INC: /* Simple increment */
+       case PATTERN_INC: /* Simple increment */
                for (i = 0; i < size; i++)
                        *(buf + i) = i;
                break;
+       case PATTERN_ALL_LOW: /* All probes are low */
+               memset(buf, 0x00, size);
+               break;
+       case PATTERN_ALL_HIGH: /* All probes are high */
+               memset(buf, 0xff, size);
+               break;
+       default:
+               /* TODO: Error handling. */
+               break;
        }
 }
 
@@ -262,7 +308,6 @@ static void thread_func(void *data)
        uint8_t buf[BUFSIZE];
        uint64_t nb_to_send = 0;
        int bytes_written;
-
        double time_cur, time_last, time_diff;
 
        time_last = g_timer_elapsed(mydata->timer, NULL);
@@ -276,9 +321,10 @@ static void thread_func(void *data)
 
                nb_to_send = cur_samplerate * time_diff;
 
-               if (limit_samples)
+               if (limit_samples) {
                        nb_to_send = MIN(nb_to_send,
-                                       limit_samples - mydata->samples_counter);
+                                     limit_samples - mydata->samples_counter);
+               }
 
                /* Make sure we don't overflow. */
                nb_to_send = MIN(nb_to_send, BUFSIZE);
@@ -288,7 +334,7 @@ static void thread_func(void *data)
                        mydata->samples_counter += nb_to_send;
 
                        g_io_channel_write_chars(channels[1], (gchar *)&buf,
-                                       nb_to_send, (gsize *)&bytes_written, NULL);
+                               nb_to_send, (gsize *)&bytes_written, NULL);
                }
 
                /* Check if we're done. */
@@ -304,15 +350,17 @@ static void thread_func(void *data)
 }
 
 /* Callback handling data */
-static int receive_data(int fd, int revents, void *user_data)
+static int receive_data(int fd, int revents, void *session_data)
 {
        struct sr_datafeed_packet packet;
-       char c[BUFSIZE];
+       struct sr_datafeed_logic logic;
+       static uint64_t samples_received = 0;
+       unsigned char c[BUFSIZE];
        gsize z;
 
        /* Avoid compiler warnings. */
-       fd = fd;
-       revents = revents;
+       (void)fd;
+       (void)revents;
 
        do {
                g_io_channel_read_chars(channels[0],
@@ -320,21 +368,24 @@ static int receive_data(int fd, int revents, void *user_data)
 
                if (z > 0) {
                        packet.type = SR_DF_LOGIC;
-                       packet.length = z;
-                       packet.unitsize = 1;
-                       packet.payload = c;
-                       sr_session_bus(user_data, &packet);
+                       packet.payload = &logic;
+                       packet.timeoffset =  samples_received * period_ps;
+                       packet.duration = z * period_ps;
+                       logic.length = z;
+                       logic.unitsize = 1;
+                       logic.data = c;
+                       sr_session_bus(session_data, &packet);
+                       samples_received += z;
                }
        } while (z > 0);
 
-       if (!thread_running && z <= 0)
-       {
-               /* Make sure we don't receive more packets */
+       if (!thread_running && z <= 0) {
+               /* Make sure we don't receive more packets. */
                g_io_channel_close(channels[0]);
 
                /* Send last packet. */
                packet.type = SR_DF_END;
-               sr_session_bus(user_data, &packet);
+               sr_session_bus(session_data, &packet);
 
                return FALSE;
        }
@@ -342,7 +393,7 @@ static int receive_data(int fd, int revents, void *user_data)
        return TRUE;
 }
 
-static int hw_start_acquisition(int device_index, gpointer session_device_id)
+static int hw_start_acquisition(int device_index, gpointer session_data)
 {
        struct sr_datafeed_packet *packet;
        struct sr_datafeed_header *header;
@@ -354,13 +405,16 @@ static int hw_start_acquisition(int device_index, gpointer session_device_id)
                return SR_ERR_MALLOC;
        }
 
-       mydata->sample_generator = default_genmode;
-       mydata->session_device_id = session_device_id;
+       mydata->sample_generator = default_pattern;
+       mydata->session_data = session_data;
        mydata->device_index = device_index;
        mydata->samples_counter = 0;
 
-       if (pipe(mydata->pipe_fds))
+       if (pipe(mydata->pipe_fds)) {
+               /* TODO: Better error message. */
+               sr_err("demo: %s: pipe() failed", __func__);
                return SR_ERR;
+       }
 
        channels[0] = g_io_channel_unix_new(mydata->pipe_fds[0]);
        channels[1] = g_io_channel_unix_new(mydata->pipe_fds[1]);
@@ -374,17 +428,19 @@ static int hw_start_acquisition(int device_index, gpointer session_device_id)
        g_io_channel_set_buffered(channels[1], FALSE);
 
        sr_source_add(mydata->pipe_fds[0], G_IO_IN | G_IO_ERR, 40,
-                     receive_data, session_device_id);
+                     receive_data, session_data);
 
        /* Run the demo thread. */
        g_thread_init(NULL);
-       /* this needs to be done between g_thread_init() and g_thread_create() */
+       /* This must to be done between g_thread_init() & g_thread_create(). */
        mydata->timer = g_timer_new();
        thread_running = 1;
        my_thread =
            g_thread_create((GThreadFunc)thread_func, mydata, TRUE, NULL);
-       if (!my_thread)
-               return SR_ERR;
+       if (!my_thread) {
+               sr_err("demo: %s: g_thread_create failed", __func__);
+               return SR_ERR; /* TODO */
+       }
 
        if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
                sr_err("demo: %s: packet malloc failed", __func__);
@@ -397,26 +453,26 @@ static int hw_start_acquisition(int device_index, gpointer session_device_id)
        }
 
        packet->type = SR_DF_HEADER;
-       packet->length = sizeof(struct sr_datafeed_header);
-       packet->payload = (unsigned char *)header;
+       packet->payload = header;
+       packet->timeoffset = 0;
+       packet->duration = 0;
        header->feed_version = 1;
        gettimeofday(&header->starttime, NULL);
        header->samplerate = cur_samplerate;
-       header->protocol_id = SR_PROTO_RAW;
        header->num_logic_probes = NUM_PROBES;
        header->num_analog_probes = 0;
-       sr_session_bus(session_device_id, packet);
+       sr_session_bus(session_data, packet);
        g_free(header);
        g_free(packet);
 
        return SR_OK;
 }
 
-static void hw_stop_acquisition(int device_index, gpointer session_device_id)
+static void hw_stop_acquisition(int device_index, gpointer session_data)
 {
        /* Avoid compiler warnings. */
-       device_index = device_index;
-       session_device_id = session_device_id;
+       (void)device_index;
+       (void)session_data;
 
        /* Stop generate thread. */
        thread_running = 0;