]> sigrok.org Git - libsigrok.git/blobdiff - hardware/demo/demo.c
demo: Always use glib's memory allocation functions.
[libsigrok.git] / hardware / demo / demo.c
index f3f71fa5728ec49a59f74400b3e39c9d29743266..58291961711c48cffc881f149aba1f8cad7017ce 100644 (file)
@@ -2,6 +2,7 @@
  * This file is part of the sigrok project.
  *
  * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
+ * Copyright (C) 2011 Olivier Fauchon <olivier@aixmarseille.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
 #include <unistd.h>
 #include <string.h>
 #include <sigrok.h>
+#ifdef _WIN32
+#include <io.h>
+#include <fcntl.h>
+#define pipe(fds) _pipe(fds, 4096, _O_BINARY)
+#endif
 #include "config.h"
 
-#define BUFSIZE                        4096
+#define NUM_PROBES             8
+#define DEMONAME               "Demo device"
+/* size of chunks to send through the session bus */
+#define BUFSIZE                4096
 
-#define NUM_PROBES                     8
-#define NUM_TRIGGER_STAGES             4
-#define TRIGGER_TYPES                  "01"
-
-/* Software trigger implementation: positive values indicate trigger stage. */
-#define TRIGGER_FIRED                  -1
-
-#define USB_MODEL_NAME                 "demodevice"
-#define USB_VENDOR_NAME                        "demovendor"
-#define USB_MODEL_VERSION              "1.0"
-
-#define GENMODE_RANDOM                 1
-#define GENMODE_INC                    2
-
-static GThread *my_thread;
-static int thread_running;
-
-static int capabilities[] = {
-       HWCAP_LOGIC_ANALYZER,
-       HWCAP_SAMPLERATE,
-       HWCAP_LIMIT_SAMPLES,
+enum {
+       GENMODE_DEFAULT,
+       GENMODE_RANDOM,
+       GENMODE_INC,
 };
 
-/* Random selection of samplerates this "device" shall support. */
-static uint64_t supported_samplerates[] = {
-       KHZ(100),
-       KHZ(500),
-       MHZ(1),
-       MHZ(2),
-       MHZ(12),
-       MHZ(24),
-       0,
-};
-
-static struct samplerates samplerates = {
-       KHZ(100),
-       MHZ(24),
-       0,
-       supported_samplerates,
-};
+/* FIXME: Should not be global. */
+GIOChannel *channels[2];
 
 struct databag {
        int pipe_fds[2];
@@ -73,38 +50,65 @@ struct databag {
        uint8_t thread_running;
        uint64_t samples_counter;
        int device_index;
-       int loop_sleep;
        gpointer session_device_id;
+       GTimer *timer;
 };
 
-/* List of struct sigrok_device_instance, maintained by opendev()/closedev(). */
-static GSList *device_instances = NULL;
+static int capabilities[] = {
+       SR_HWCAP_LOGIC_ANALYZER,
+       SR_HWCAP_SAMPLERATE,
+       SR_HWCAP_PATTERN_MODE,
+       SR_HWCAP_LIMIT_SAMPLES,
+       SR_HWCAP_LIMIT_MSEC,
+       SR_HWCAP_CONTINUOUS,
+};
 
-/* TODO: All of these should go in a device-specific struct. */
-static uint64_t cur_samplerate = 0;
-static uint64_t limit_samples = 0;
-// static uint8_t probe_mask = 0;
-// static uint8_t trigger_mask[NUM_TRIGGER_STAGES] = { 0 };
-// static uint8_t trigger_value[NUM_TRIGGER_STAGES] = { 0 };
-// static uint8_t trigger_buffer[NUM_TRIGGER_STAGES] = { 0 };
+static struct sr_samplerates samplerates = {
+       SR_HZ(1),
+       SR_GHZ(1),
+       SR_HZ(1),
+       NULL,
+};
 
-// static int trigger_stage = TRIGGER_FIRED;
+static const char *patternmodes[] = {
+       "random",
+       "incremental",
+       NULL,
+};
+
+static uint8_t genmode_default[] = {
+       0x4c, 0x92, 0x92, 0x92, 0x64, 0x00, 0x00, 0x00,
+       0x82, 0xfe, 0xfe, 0x82, 0x00, 0x00, 0x00, 0x00,
+       0x7c, 0x82, 0x82, 0x92, 0x74, 0x00, 0x00, 0x00,
+       0xfe, 0x12, 0x12, 0x32, 0xcc, 0x00, 0x00, 0x00,
+       0x7c, 0x82, 0x82, 0x82, 0x7c, 0x00, 0x00, 0x00,
+       0xfe, 0x10, 0x28, 0x44, 0x82, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0xbe, 0xbe, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+};
+
+/* 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 limit_samples = 0;
+static uint64_t limit_msec = 0;
+static int default_genmode = GENMODE_DEFAULT;
+static GThread *my_thread;
+static int thread_running;
 
-static int hw_set_configuration(int device_index, int capability, void *value);
 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)
 {
-       /* Avoid compiler warning. */
-       deviceinfo = deviceinfo;
+       struct sr_device_instance *sdi;
 
-       struct sigrok_device_instance *sdi;
-
-       sdi = sigrok_device_instance_new(0, ST_ACTIVE,
-                USB_VENDOR_NAME, USB_MODEL_NAME, USB_MODEL_VERSION);
+       /* Avoid compiler warnings. */
+       deviceinfo = deviceinfo;
 
+       sdi = sr_device_instance_new(0, SR_ST_ACTIVE, DEMONAME, NULL, NULL);
        if (!sdi)
                return 0;
+
        device_instances = g_slist_append(device_instances, sdi);
 
        return 1;
@@ -112,16 +116,16 @@ static int hw_init(char *deviceinfo)
 
 static int hw_opendev(int device_index)
 {
-       /* Avoid compiler warning. */
+       /* Avoid compiler warnings. */
        device_index = device_index;
 
        /* Nothing needed so far. */
-       return SIGROK_OK;
+       return SR_OK;
 }
 
 static void hw_closedev(int device_index)
 {
-       /* Avoid compiler warning. */
+       /* Avoid compiler warnings. */
        device_index = device_index;
 
        /* Nothing needed so far. */
@@ -134,28 +138,28 @@ 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_SAMPLERATES:
+       case SR_DI_SAMPLERATES:
                info = &samplerates;
                break;
-       case DI_TRIGGER_TYPES:
-               info = TRIGGER_TYPES;
-               break;
-       case DI_CUR_SAMPLERATE:
+       case SR_DI_CUR_SAMPLERATE:
                info = &cur_samplerate;
                break;
+       case SR_DI_PATTERNMODES:
+               info = &patternmodes;
+               break;
        }
 
        return info;
@@ -163,10 +167,10 @@ static void *hw_get_device_info(int device_index, int device_info_id)
 
 static int hw_get_status(int device_index)
 {
-       /* Avoid compiler warning. */
+       /* Avoid compiler warnings. */
        device_index = device_index;
 
-       return 0; /* FIXME */
+       return SR_ST_ACTIVE;
 }
 
 static int *hw_get_capabilities(void)
@@ -178,22 +182,39 @@ static int hw_set_configuration(int device_index, int capability, void *value)
 {
        int ret;
        uint64_t *tmp_u64;
+       char *stropt;
 
-       /* Avoid compiler warning. */
+       /* Avoid compiler warnings. */
        device_index = device_index;
 
-       if (capability == HWCAP_SAMPLERATE) {
-               cur_samplerate = *(uint64_t *) value;
-               ret = SIGROK_OK;
-       } else if (capability == HWCAP_PROBECONFIG) {
-               // ret = configure_probes((GSList *) value); FIXME
-               ret = SIGROK_OK;
-       } else if (capability == HWCAP_LIMIT_SAMPLES) {
+       if (capability == SR_HWCAP_PROBECONFIG) {
+               /* Nothing to do, but must be supported */
+               ret = SR_OK;
+       } else if (capability == SR_HWCAP_SAMPLERATE) {
+               tmp_u64 = value;
+               cur_samplerate = *tmp_u64;
+               ret = SR_OK;
+       } else if (capability == SR_HWCAP_LIMIT_SAMPLES) {
                tmp_u64 = value;
                limit_samples = *tmp_u64;
-               ret = SIGROK_OK;
+               ret = SR_OK;
+       } else if (capability == SR_HWCAP_LIMIT_MSEC) {
+               tmp_u64 = value;
+               limit_msec = *tmp_u64;
+               ret = SR_OK;
+       } else if (capability == SR_HWCAP_PATTERN_MODE) {
+               stropt = value;
+               if (!strcmp(stropt, "random")) {
+                       default_genmode = GENMODE_RANDOM;
+                       ret = SR_OK;
+               } else if (!strcmp(stropt, "incremental")) {
+                       default_genmode = GENMODE_INC;
+                       ret = SR_OK;
+               } else {
+                       ret = SR_ERR;
+               }
        } else {
-               ret = SIGROK_ERR;
+               ret = SR_ERR;
        }
 
        return ret;
@@ -201,12 +222,20 @@ 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 i;
 
        memset(buf, 0, size);
 
        switch (mydata->sample_generator) {
+       case GENMODE_DEFAULT:
+               for (i = 0; i < size; i++) {
+                       *(buf + i) = ~(genmode_default[p] >> 1);
+                       if (++p == 64)
+                               p = 0;
+               }
+               break;
        case GENMODE_RANDOM: /* Random */
                for (i = 0; i < size; i++)
                        *(buf + i) = (uint8_t)(rand() & 0xff);
@@ -224,124 +253,170 @@ static void thread_func(void *data)
        struct databag *mydata = 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);
 
        while (thread_running) {
-               nb_to_send = limit_samples - mydata->samples_counter;
+               /* Rate control */
+               time_cur = g_timer_elapsed(mydata->timer, NULL);
 
-               if (nb_to_send == 0) {
+               time_diff = time_cur - time_last;
+               time_last = time_cur;
+
+               nb_to_send = cur_samplerate * time_diff;
+
+               if (limit_samples)
+                       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);
+               }
+
+               /* 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;
-
-               write(mydata->pipe_fds[1], &buf, nb_to_send);
-               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;
-       /* uint16_t samples[1000]; */
+       struct sr_datafeed_packet packet;
        char c[BUFSIZE];
-       uint64_t z;
+       gsize z;
 
        /* Avoid compiler warnings. */
+       fd = fd;
        revents = revents;
 
-       z = read(fd, &c, BUFSIZE);
-       if (z > 0) {
-               packet.type = DF_LOGIC;
-               packet.length = z;
-               packet.unitsize = 1;
-               packet.payload = c;
-               session_bus(user_data, &packet);
+       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);
+
+               return FALSE;
        }
+
        return TRUE;
 }
 
 static int hw_start_acquisition(int device_index, gpointer session_device_id)
 {
-       struct datafeed_packet *packet;
-       struct datafeed_header *header;
-       unsigned char *buf;
+       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 = GENMODE_RANDOM;
+       mydata->sample_generator = default_genmode;
        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)) {
-               fprintf(stderr, "Pipe failed.\n");
-               return SIGROK_ERR_MALLOC; /* FIXME */
+       if (pipe(mydata->pipe_fds))
+               return SR_ERR;
 
-       }
-       source_add(mydata->pipe_fds[0], G_IO_IN | G_IO_ERR, 40, receive_data,
-                  session_device_id);
+       channels[0] = g_io_channel_unix_new(mydata->pipe_fds[0]);
+       channels[1] = g_io_channel_unix_new(mydata->pipe_fds[1]);
+
+       /* Set channel encoding to binary (default is UTF-8). */
+       g_io_channel_set_encoding(channels[0], NULL, NULL);
+       g_io_channel_set_encoding(channels[1], NULL, NULL);
+
+       /* Make channels to unbuffered. */
+       g_io_channel_set_buffered(channels[0], FALSE);
+       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);
 
        /* Run the demo thread. */
        g_thread_init(NULL);
+       /* 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) {
-               fprintf(stderr, "demo: Thread creation failed.\n");
-               return SIGROK_ERR_MALLOC; /* FIXME */
-       }
+       if (!my_thread)
+               return SR_ERR;
 
-       packet = malloc(sizeof(struct datafeed_packet));
-       header = malloc(sizeof(struct datafeed_header));
-       buf = malloc(2048);
-       if (!packet || !header || !buf)
-               return SIGROK_ERR_MALLOC;
+       if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
+               sr_err("demo: %s: packet malloc failed", __func__);
+               return SR_ERR_MALLOC;
+       }
 
-       /* FIXME */
-       memset(buf, 0x55, 2048);
+       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;
 }
 
-/* This stops acquisition on ALL devices, ignoring device_index. */
 static void hw_stop_acquisition(int device_index, gpointer session_device_id)
 {
-       struct datafeed_packet packet;
-
-       /* QUICK HACK */
+       /* 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 = {
+struct sr_device_plugin demo_plugin_info = {
        "demo",
+       "Demo driver and pattern generator",
        1,
        hw_init,
        hw_cleanup,