]> sigrok.org Git - libsigrok.git/blobdiff - hardware/demo/demo.c
demo: s/genmode/pattern/.
[libsigrok.git] / hardware / demo / demo.c
index f1580a7dfc36f808ffa49d6053c041bb8a082c8e..2bd4709545cd656d93c99abb35f12fac779ede91 100644 (file)
@@ -23,6 +23,7 @@
 #include <unistd.h>
 #include <string.h>
 #include <sigrok.h>
+#include <sigrok-internal.h>
 #ifdef _WIN32
 #include <io.h>
 #include <fcntl.h>
 /* size of chunks to send through the session bus */
 #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,
 };
 
+/* FIXME: Should not be global. */
 GIOChannel *channels[2];
 
 struct databag {
@@ -49,26 +65,33 @@ struct databag {
        uint8_t thread_running;
        uint64_t samples_counter;
        int device_index;
-       int loop_sleep;
        gpointer session_device_id;
        GTimer *timer;
 };
 
 static int capabilities[] = {
-       HWCAP_LOGIC_ANALYZER,
-       HWCAP_PATTERN_MODE,
-       HWCAP_LIMIT_SAMPLES,
-       HWCAP_LIMIT_MSEC,
-       HWCAP_CONTINUOUS
+       SR_HWCAP_LOGIC_ANALYZER,
+       SR_HWCAP_SAMPLERATE,
+       SR_HWCAP_PATTERN_MODE,
+       SR_HWCAP_LIMIT_SAMPLES,
+       SR_HWCAP_LIMIT_MSEC,
+       SR_HWCAP_CONTINUOUS,
 };
 
-static const char *patternmodes[] = {
+static struct sr_samplerates samplerates = {
+       SR_HZ(1),
+       SR_GHZ(1),
+       SR_HZ(1),
+       NULL,
+};
+
+static const char *pattern_strings[] = {
        "random",
        "incremental",
        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,
@@ -79,25 +102,25 @@ static uint8_t genmode_default[] = {
        0xbe, 0xbe, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
 };
 
-/* List of struct sigrok_device_instance, maintained by opendev()/closedev(). */
+/* List of struct sr_device_instance, maintained by opendev()/closedev(). */
 static GSList *device_instances = NULL;
-static uint64_t cur_samplerate = 0;
+static uint64_t cur_samplerate = SR_KHZ(200);
 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 int hw_init(char *deviceinfo)
+static int hw_init(const char *deviceinfo)
 {
-       struct sigrok_device_instance *sdi;
+       struct sr_device_instance *sdi;
 
        /* Avoid compiler warnings. */
        deviceinfo = deviceinfo;
 
-       sdi = sigrok_device_instance_new(0, ST_ACTIVE, DEMONAME, NULL, NULL);
+       sdi = sr_device_instance_new(0, SR_ST_ACTIVE, DEMONAME, NULL, NULL);
        if (!sdi)
                return 0;
 
@@ -112,15 +135,18 @@ static int hw_opendev(int device_index)
        device_index = device_index;
 
        /* Nothing needed so far. */
-       return SIGROK_OK;
+
+       return SR_OK;
 }
 
-static void hw_closedev(int device_index)
+static int hw_closedev(int device_index)
 {
        /* Avoid compiler warnings. */
        device_index = device_index;
 
        /* Nothing needed so far. */
+
+       return SR_OK;
 }
 
 static void hw_cleanup(void)
@@ -130,24 +156,27 @@ static void hw_cleanup(void)
 
 static void *hw_get_device_info(int device_index, int device_info_id)
 {
-       struct sigrok_device_instance *sdi;
+       struct sr_device_instance *sdi;
        void *info = NULL;
 
-       if (!(sdi = get_sigrok_device_instance(device_instances, device_index)))
+       if (!(sdi = sr_get_device_instance(device_instances, device_index)))
                return NULL;
 
        switch (device_info_id) {
-       case DI_INSTANCE:
+       case SR_DI_INSTANCE:
                info = sdi;
                break;
-       case DI_NUM_PROBES:
+       case SR_DI_NUM_PROBES:
                info = GINT_TO_POINTER(NUM_PROBES);
                break;
-       case DI_CUR_SAMPLERATE:
+       case SR_DI_SAMPLERATES:
+               info = &samplerates;
+               break;
+       case SR_DI_CUR_SAMPLERATE:
                info = &cur_samplerate;
                break;
-       case DI_PATTERNMODES:
-               info = &patternmodes;
+       case SR_DI_PATTERNMODES:
+               info = &pattern_strings;
                break;
        }
 
@@ -159,7 +188,7 @@ static int hw_get_status(int device_index)
        /* Avoid compiler warnings. */
        device_index = device_index;
 
-       return ST_ACTIVE;
+       return SR_ST_ACTIVE;
 }
 
 static int *hw_get_capabilities(void)
@@ -170,36 +199,44 @@ static int *hw_get_capabilities(void)
 static int hw_set_configuration(int device_index, int capability, void *value)
 {
        int ret;
-       uint64_t *tmp_u64;
        char *stropt;
 
        /* Avoid compiler warnings. */
        device_index = device_index;
 
-       if (capability == HWCAP_PROBECONFIG) {
-               /* Nothing to do. */
-               ret = SIGROK_OK;
-       } else if (capability == HWCAP_LIMIT_SAMPLES) {
-               tmp_u64 = value;
-               limit_samples = *tmp_u64;
-               ret = SIGROK_OK;
-       } else if (capability == HWCAP_LIMIT_MSEC) {
-               tmp_u64 = value;
-               limit_msec = *tmp_u64;
-               ret = SIGROK_OK;
-       } else if (capability == HWCAP_PATTERN_MODE) {
+       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;
+               sr_dbg("demo: %s: setting samplerate to %" PRIu64, __func__,
+                      cur_samplerate);
+               ret = SR_OK;
+       } else if (capability == SR_HWCAP_LIMIT_SAMPLES) {
+               limit_samples = *(uint64_t *)value;
+               sr_dbg("demo: %s: setting limit_samples to %" PRIu64, __func__,
+                      limit_samples);
+               ret = SR_OK;
+       } else if (capability == SR_HWCAP_LIMIT_MSEC) {
+               limit_msec = *(uint64_t *)value;
+               sr_dbg("demo: %s: setting limit_msec to %" PRIu64, __func__,
+                      limit_msec);
+               ret = SR_OK;
+       } else if (capability == SR_HWCAP_PATTERN_MODE) {
                stropt = value;
                if (!strcmp(stropt, "random")) {
-                       default_genmode = GENMODE_RANDOM;
-                       ret = SIGROK_OK;
+                       default_pattern = PATTERN_RANDOM;
+                       ret = SR_OK;
                } else if (!strcmp(stropt, "incremental")) {
-                       default_genmode = GENMODE_INC;
-                       ret = SIGROK_OK;
+                       default_pattern = PATTERN_INC;
+                       ret = SR_OK;
                } else {
-                       ret = SIGROK_ERR;
+                       ret = SR_ERR;
                }
+               sr_dbg("demo: %s: setting pattern to %d", __func__,
+                      default_pattern);
        } else {
-               ret = SIGROK_ERR;
+               ret = SR_ERR;
        }
 
        return ret;
@@ -207,25 +244,25 @@ static int hw_set_configuration(int device_index, int capability, void *value)
 
 static void samples_generator(uint8_t *buf, uint64_t size, void *data)
 {
+       static uint64_t p = 0;
        struct databag *mydata = data;
-       uint64_t p, i;
+       uint64_t i;
 
        memset(buf, 0, size);
 
        switch (mydata->sample_generator) {
-       case GENMODE_DEFAULT:
-               p = 0;
+       case PATTERN_SIGROK:
                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;
@@ -239,80 +276,105 @@ static void thread_func(void *data)
        uint8_t buf[BUFSIZE];
        uint64_t nb_to_send = 0;
        int bytes_written;
-       unsigned int msec_elapsed;
+
+       double time_cur, time_last, time_diff;
+
+       time_last = g_timer_elapsed(mydata->timer, NULL);
 
        while (thread_running) {
+               /* Rate control */
+               time_cur = g_timer_elapsed(mydata->timer, NULL);
+
+               time_diff = time_cur - time_last;
+               time_last = time_cur;
+
+               nb_to_send = cur_samplerate * time_diff;
+
                if (limit_samples)
-                       nb_to_send = limit_samples - mydata->samples_counter;
-               else
-                       nb_to_send = BUFSIZE;  /* Continuous mode */
-
-               if (limit_msec) {
-                       msec_elapsed = g_timer_elapsed(mydata->timer, NULL) * 1000;
-                       if (msec_elapsed > limit_msec)
-                               nb_to_send = 0;
+                       nb_to_send = MIN(nb_to_send,
+                                       limit_samples - mydata->samples_counter);
+
+               /* Make sure we don't overflow. */
+               nb_to_send = MIN(nb_to_send, BUFSIZE);
+
+               if (nb_to_send) {
+                       samples_generator(buf, nb_to_send, data);
+                       mydata->samples_counter += nb_to_send;
+
+                       g_io_channel_write_chars(channels[1], (gchar *)&buf,
+                                       nb_to_send, (gsize *)&bytes_written, NULL);
                }
 
-               if (nb_to_send == 0) {
+               /* Check if we're done. */
+               if ((limit_msec && time_cur * 1000 > limit_msec) ||
+                   (limit_samples && mydata->samples_counter >= limit_samples))
+               {
                        close(mydata->pipe_fds[1]);
                        thread_running = 0;
-                       hw_stop_acquisition(mydata->device_index,
-                                           mydata->session_device_id);
-               } else if (nb_to_send > BUFSIZE) {
-                       nb_to_send = BUFSIZE;
                }
 
-               samples_generator(buf, nb_to_send, data);
-               mydata->samples_counter += nb_to_send;
-
-               g_io_channel_write_chars(channels[1], (gchar *)&buf,
-                               nb_to_send, (gsize *)&bytes_written, NULL);
-
-               g_usleep(mydata->loop_sleep);
+               g_usleep(10);
        }
 }
 
 /* Callback handling data */
 static int receive_data(int fd, int revents, void *user_data)
 {
-       struct datafeed_packet packet;
+       struct sr_datafeed_packet packet;
        char c[BUFSIZE];
-       uint64_t z;
+       gsize z;
 
        /* Avoid compiler warnings. */
        fd = fd;
        revents = revents;
 
-       g_io_channel_read_chars(channels[0], (gchar *)&c, BUFSIZE, &z, NULL);
+       do {
+               g_io_channel_read_chars(channels[0],
+                                       (gchar *)&c, BUFSIZE, &z, NULL);
+
+               if (z > 0) {
+                       packet.type = SR_DF_LOGIC;
+                       packet.length = z;
+                       packet.unitsize = 1;
+                       packet.payload = c;
+                       sr_session_bus(user_data, &packet);
+               }
+       } while (z > 0);
+
+       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);
 
-       if (z > 0) {
-               packet.type = DF_LOGIC;
-               packet.length = z;
-               packet.unitsize = 1;
-               packet.payload = c;
-               session_bus(user_data, &packet);
+               return FALSE;
        }
+
        return TRUE;
 }
 
 static int hw_start_acquisition(int device_index, gpointer session_device_id)
 {
-       struct datafeed_packet *packet;
-       struct datafeed_header *header;
+       struct sr_datafeed_packet *packet;
+       struct sr_datafeed_header *header;
        struct databag *mydata;
 
-       mydata = malloc(sizeof(struct databag));
-       if (!mydata)
-               return SIGROK_ERR_MALLOC;
+       /* TODO: 'mydata' is never g_free()'d? */
+       if (!(mydata = g_try_malloc(sizeof(struct databag)))) {
+               sr_err("demo: %s: mydata malloc failed", __func__);
+               return SR_ERR_MALLOC;
+       }
 
-       mydata->sample_generator = default_genmode;
+       mydata->sample_generator = default_pattern;
        mydata->session_device_id = session_device_id;
        mydata->device_index = device_index;
        mydata->samples_counter = 0;
-       mydata->loop_sleep = 100000;
 
        if (pipe(mydata->pipe_fds))
-               return SIGROK_ERR;
+               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]);
@@ -325,63 +387,67 @@ static int hw_start_acquisition(int device_index, gpointer session_device_id)
        g_io_channel_set_buffered(channels[0], FALSE);
        g_io_channel_set_buffered(channels[1], FALSE);
 
-       source_add(mydata->pipe_fds[0], G_IO_IN | G_IO_ERR, 40, receive_data,
-                  session_device_id);
+       sr_source_add(mydata->pipe_fds[0], G_IO_IN | G_IO_ERR, 40,
+                     receive_data, session_device_id);
 
        /* Run the demo thread. */
        g_thread_init(NULL);
-       if (limit_msec)
-               mydata->timer = g_timer_new();
+       /* this needs to be done between g_thread_init() and 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 SIGROK_ERR;
+               return SR_ERR;
+
+       if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
+               sr_err("demo: %s: packet malloc failed", __func__);
+               return SR_ERR_MALLOC;
+       }
 
-       packet = malloc(sizeof(struct datafeed_packet));
-       header = malloc(sizeof(struct datafeed_header));
-       if (!packet || !header)
-               return SIGROK_ERR_MALLOC;
+       if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) {
+               sr_err("demo: %s: header malloc failed", __func__);
+               return SR_ERR_MALLOC;
+       }
 
-       packet->type = DF_HEADER;
-       packet->length = sizeof(struct datafeed_header);
+       packet->type = SR_DF_HEADER;
+       packet->length = sizeof(struct sr_datafeed_header);
        packet->payload = (unsigned char *)header;
        header->feed_version = 1;
        gettimeofday(&header->starttime, NULL);
        header->samplerate = cur_samplerate;
-       header->protocol_id = PROTO_RAW;
+       header->protocol_id = SR_PROTO_RAW;
        header->num_logic_probes = NUM_PROBES;
        header->num_analog_probes = 0;
-       session_bus(session_device_id, packet);
-       free(header);
-       free(packet);
+       sr_session_bus(session_device_id, packet);
+       g_free(header);
+       g_free(packet);
 
-       return SIGROK_OK;
+       return SR_OK;
 }
 
 static void hw_stop_acquisition(int device_index, gpointer session_device_id)
 {
-       struct datafeed_packet packet;
-
        /* Avoid compiler warnings. */
        device_index = device_index;
+       session_device_id = session_device_id;
 
-       /* Send last packet. */
-       packet.type = DF_END;
-       session_bus(session_device_id, &packet);
+       /* Stop generate thread. */
+       thread_running = 0;
 }
 
-struct device_plugin demo_plugin_info = {
-       "demo",
-       1,
-       hw_init,
-       hw_cleanup,
-       hw_opendev,
-       hw_closedev,
-       hw_get_device_info,
-       hw_get_status,
-       hw_get_capabilities,
-       hw_set_configuration,
-       hw_start_acquisition,
-       hw_stop_acquisition,
+struct sr_device_plugin demo_plugin_info = {
+       .name = "demo",
+       .longname = "Demo driver and pattern generator",
+       .api_version = 1,
+       .init = hw_init,
+       .cleanup = hw_cleanup,
+       .opendev = hw_opendev,
+       .closedev = hw_closedev,
+       .get_device_info = hw_get_device_info,
+       .get_status = hw_get_status,
+       .get_capabilities = hw_get_capabilities,
+       .set_configuration = hw_set_configuration,
+       .start_acquisition = hw_start_acquisition,
+       .stop_acquisition = hw_stop_acquisition,
 };