]> 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 e117e6a59afa29cf065e6f0afcd4e0975eb68c89..58291961711c48cffc881f149aba1f8cad7017ce 100644 (file)
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  */
 
-#define DEMO_ANALOG
-
 #include <stdlib.h>
 #include <unistd.h>
 #include <string.h>
 #include <sigrok.h>
-#include <math.h>
 #ifdef _WIN32
 #include <io.h>
 #include <fcntl.h>
 #endif
 #include "config.h"
 
-#ifdef DEMO_ANALOG
-#define NUM_PROBES             9
-#else
 #define NUM_PROBES             8
-#endif
 #define DEMONAME               "Demo device"
 /* size of chunks to send through the session bus */
-#ifdef DEMO_ANALOG
-#define BUFSIZE                       32768
-#else
 #define BUFSIZE                4096
-#endif
 
 enum {
        GENMODE_DEFAULT,
        GENMODE_RANDOM,
        GENMODE_INC,
-       GENMODE_SINE,
 };
 
+/* FIXME: Should not be global. */
 GIOChannel *channels[2];
 
 struct databag {
@@ -66,21 +55,27 @@ struct databag {
 };
 
 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 struct sr_samplerates samplerates = {
+       SR_HZ(1),
+       SR_GHZ(1),
+       SR_HZ(1),
+       NULL,
 };
 
 static const char *patternmodes[] = {
        "random",
        "incremental",
-       "sine",
        NULL,
 };
 
-#ifndef DEMO_ANALOG
 static uint8_t genmode_default[] = {
        0x4c, 0x92, 0x92, 0x92, 0x64, 0x00, 0x00, 0x00,
        0x82, 0xfe, 0xfe, 0x82, 0x00, 0x00, 0x00, 0x00,
@@ -91,11 +86,10 @@ static uint8_t genmode_default[] = {
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0xbe, 0xbe, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
 };
-#endif
 
-/* 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 = KHZ(200);
+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;
@@ -104,14 +98,14 @@ 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;
 
@@ -126,7 +120,7 @@ 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)
@@ -144,23 +138,26 @@ 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:
+       case SR_DI_PATTERNMODES:
                info = &patternmodes;
                break;
        }
@@ -173,7 +170,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)
@@ -190,33 +187,34 @@ static int hw_set_configuration(int device_index, int capability, void *value)
        /* Avoid compiler warnings. */
        device_index = device_index;
 
-       if (capability == HWCAP_PROBECONFIG) {
-               /* Nothing to do. */
-               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;
-       } else if (capability == HWCAP_LIMIT_MSEC) {
+               ret = SR_OK;
+       } else if (capability == SR_HWCAP_LIMIT_MSEC) {
                tmp_u64 = value;
                limit_msec = *tmp_u64;
-               ret = SIGROK_OK;
-       } else if (capability == HWCAP_PATTERN_MODE) {
+               ret = SR_OK;
+       } else if (capability == SR_HWCAP_PATTERN_MODE) {
                stropt = value;
                if (!strcmp(stropt, "random")) {
                        default_genmode = GENMODE_RANDOM;
-                       ret = SIGROK_OK;
+                       ret = SR_OK;
                } else if (!strcmp(stropt, "incremental")) {
                        default_genmode = GENMODE_INC;
-                       ret = SIGROK_OK;
-               } else if (!strcmp(stropt, "sine")) {
-                       default_genmode = GENMODE_SINE;
-                       ret = SIGROK_OK;
+                       ret = SR_OK;
                } else {
-                       ret = SIGROK_ERR;
+                       ret = SR_ERR;
                }
        } else {
-               ret = SIGROK_ERR;
+               ret = SR_ERR;
        }
 
        return ret;
@@ -224,50 +222,14 @@ 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;
-#ifdef DEMO_ANALOG
-       /*
-        * We will simulate a device with 8 logic probes and 1 analog probe.
-        * This fictional device sends the data packed: 8 bits for 8 logic
-        * probes and 16 bits for the analog probe, in this order.
-        * Total of 24 bits.
-        * I could just generate a properly formatted DF_ANALOG packet here,
-        * but I will leave the formatting to receive_data() to make its code
-        * more like a real hardware driver.
-        */
-       memset(buf, 0, size * 3);
-
-       switch (mydata->sample_generator) {
-       default:
-       case GENMODE_DEFAULT:
-       case GENMODE_SINE:
-               for (i = 0; i < size * 3; i += 3) {
-                       *(buf + i) = i / 3;
-                       *(uint16_t *) (buf + i + 1) =
-                               (uint16_t) (sin(i / 3) * 256 * 30);
-               }
-               break;
-       case GENMODE_RANDOM:
-               for (i = 0; i < size * 3; i += 3) {
-                       *(buf + i) = (uint8_t)(rand() & 0xff);
-                       *(uint16_t *) (buf + i + 1) = (uint16_t)(rand() & 0xffff);
-               }
-               break;
-       case GENMODE_INC:
-               for (i = 0; i < size * 3; i += 3) {
-                       *(buf + i) = i / 3;
-                       *(uint16_t *)(buf + i + 1) = i / 3 * 256 * 10;
-               }
-               break;
-       }
-#else
+       uint64_t i;
 
        memset(buf, 0, size);
 
        switch (mydata->sample_generator) {
        case GENMODE_DEFAULT:
-               p = 0;
                for (i = 0; i < size; i++) {
                        *(buf + i) = ~(genmode_default[p] >> 1);
                        if (++p == 64)
@@ -283,7 +245,6 @@ static void samples_generator(uint8_t *buf, uint64_t size, void *data)
                        *(buf + i) = i;
                break;
        }
-#endif
 }
 
 /* Thread function */
@@ -312,22 +273,14 @@ static void thread_func(void *data)
                                        limit_samples - mydata->samples_counter);
 
                /* Make sure we don't overflow. */
-#ifdef DEMO_ANALOG
-               nb_to_send = MIN(nb_to_send, BUFSIZE / 3);
-#else
                nb_to_send = MIN(nb_to_send, BUFSIZE);
-#endif
 
                if (nb_to_send) {
                        samples_generator(buf, nb_to_send, data);
                        mydata->samples_counter += nb_to_send;
-#ifdef DEMO_ANALOG
-                       g_io_channel_write_chars(channels[1], (gchar *) &buf,
-                               nb_to_send * 3, (gsize *) &bytes_written, NULL);
-#else
-                       g_io_channel_write_chars(channels[1], (gchar *) &buf,
-                               nb_to_send, (gsize *) &bytes_written, NULL);
-#endif
+
+                       g_io_channel_write_chars(channels[1], (gchar *)&buf,
+                                       nb_to_send, (gsize *)&bytes_written, NULL);
                }
 
                /* Check if we're done. */
@@ -345,16 +298,9 @@ static void thread_func(void *data)
 /* 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;
-#ifdef DEMO_ANALOG
-       struct analog_sample *sample;
-       unsigned int i, x;
-       int sample_size = sizeof(struct analog_sample) +
-               (NUM_PROBES * sizeof(struct analog_probe));
-       char *buf;
-#endif
+       gsize z;
 
        /* Avoid compiler warnings. */
        fd = fd;
@@ -362,51 +308,14 @@ static int receive_data(int fd, int revents, void *user_data)
 
        do {
                g_io_channel_read_chars(channels[0],
-                                       (gchar *) &c, BUFSIZE, (gsize *) &z, NULL);
+                                       (gchar *)&c, BUFSIZE, &z, NULL);
 
                if (z > 0) {
-#ifdef DEMO_ANALOG
-                       packet.type = DF_ANALOG;
-
-                       packet.length = (z / 3) * sample_size;
-                       packet.unitsize = sample_size;
-
-                       buf = malloc(sample_size * packet.length);
-                       if (!buf)
-                               return FALSE;
-
-                       /* Craft our packet. */
-                       for (i = 0; i < z / 3; i++) {
-                               sample = (struct analog_sample *) (buf + (i * sample_size));
-                               sample->num_probes = NUM_PROBES;
-
-                               /* 8 Logic probes */
-                               for (x = 0; x < NUM_PROBES - 1; x++) {
-                                       sample->probes[x].val =
-                                               (c[i * 3] >> x) & 1;
-                                       sample->probes[x].res = 1;
-                               }
-
-                               /* 1 Analog probe, 16 bit adc */
-                               for (; x < NUM_PROBES; x++) {
-                                       sample->probes[x].val =
-                                               *(uint16_t *) (c + i * 3 + 1);
-                                       sample->probes[x].val &= ((1 << 16) - 1);
-                                       sample->probes[x].res = 16;
-                               }
-
-                       }
-
-                       packet.payload = buf;
-                       session_bus(user_data, &packet);
-                       free(buf);
-#else
-                       packet.type = DF_LOGIC;
+                       packet.type = SR_DF_LOGIC;
                        packet.length = z;
                        packet.unitsize = 1;
                        packet.payload = c;
-                       session_bus(user_data, &packet);
-#endif
+                       sr_session_bus(user_data, &packet);
                }
        } while (z > 0);
 
@@ -416,8 +325,8 @@ static int receive_data(int fd, int revents, void *user_data)
                g_io_channel_close(channels[0]);
 
                /* Send last packet. */
-               packet.type = DF_END;
-               session_bus(user_data, &packet);
+               packet.type = SR_DF_END;
+               sr_session_bus(user_data, &packet);
 
                return FALSE;
        }
@@ -427,13 +336,15 @@ static int receive_data(int fd, int revents, void *user_data)
 
 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->session_device_id = session_device_id;
@@ -441,7 +352,7 @@ static int hw_start_acquisition(int device_index, gpointer session_device_id)
        mydata->samples_counter = 0;
 
        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]);
@@ -454,41 +365,43 @@ 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);
+       /* 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;
 
-       packet = malloc(sizeof(struct datafeed_packet));
-       header = malloc(sizeof(struct datafeed_header));
-       if (!packet || !header)
-               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;
+       }
 
-       packet->type = DF_HEADER;
-       packet->length = sizeof(struct datafeed_header);
+       if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) {
+               sr_err("demo: %s: header malloc failed", __func__);
+               return SR_ERR_MALLOC;
+       }
+
+       packet->type = SR_DF_HEADER;
+       packet->length = sizeof(struct sr_datafeed_header);
        packet->payload = (unsigned char *)header;
-#ifdef DEMO_ANALOG
-       packet->unitsize = sizeof(struct analog_sample) +
-               (NUM_PROBES * sizeof(struct analog_probe));
-#endif
        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)
@@ -501,8 +414,9 @@ static void hw_stop_acquisition(int device_index, gpointer session_device_id)
        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,