]> sigrok.org Git - libsigrok.git/blobdiff - hardware/demo/demo.c
alsa: Use message logging helpers.
[libsigrok.git] / hardware / demo / demo.c
index 2f845108a934ab7fdf6652a1b78c84cbe84b7b53..8a8b2cf40b5044de93b6197676b605245c88223d 100644 (file)
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
 
+/* Message logging helpers with driver-specific prefix string. */
+#define DRIVER_LOG_DOMAIN "demo: "
+#define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args)
+#define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args)
+#define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args)
+#define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args)
+#define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args)
+#define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args)
+
 /* TODO: Number of probes should be configurable. */
 #define NUM_PROBES             8
 
@@ -63,9 +72,8 @@ enum {
        PATTERN_ALL_HIGH,
 };
 
-/* FIXME: Should not be global. */
-
-struct context {
+/* Private, per-device-instance driver context. */
+struct dev_context {
        int pipe_fds[2];
        GIOChannel *channels[2];
        uint8_t sample_generator;
@@ -138,13 +146,17 @@ static int default_pattern = PATTERN_SIGROK;
 static GThread *my_thread;
 static int thread_running;
 
-static int hw_dev_acquisition_stop(const struct sr_dev_inst *sdi,
-               void *cb_data);
+static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data);
 
 static int hw_init(void)
 {
+       struct drv_context *drvc;
 
-       /* Nothing to do. */
+       if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
+               sr_err("Driver context malloc failed.");
+               return SR_ERR_MALLOC;
+       }
+       ddi->priv = drvc;
 
        return SR_OK;
 }
@@ -152,27 +164,47 @@ static int hw_init(void)
 static GSList *hw_scan(GSList *options)
 {
        struct sr_dev_inst *sdi;
+       struct sr_probe *probe;
+       struct drv_context *drvc;
        GSList *devices;
+       int i;
 
        (void)options;
+
+       drvc = ddi->priv;
        devices = NULL;
 
        sdi = sr_dev_inst_new(0, SR_ST_ACTIVE, DEMONAME, NULL, NULL);
        if (!sdi) {
-               sr_err("demo: %s: sr_dev_inst_new failed", __func__);
+               sr_err("%s: sr_dev_inst_new failed", __func__);
                return 0;
        }
        sdi->driver = ddi;
 
+       for (i = 0; probe_names[i]; i++) {
+               if (!(probe = sr_probe_new(i, SR_PROBE_ANALOG, TRUE,
+                               probe_names[i])))
+                       return NULL;
+               sdi->probes = g_slist_append(sdi->probes, probe);
+       }
+
        devices = g_slist_append(devices, sdi);
-       ddi->instances = g_slist_append(ddi->instances, sdi);
+       drvc->instances = g_slist_append(drvc->instances, sdi);
 
        return devices;
 }
 
+static GSList *hw_dev_list(void)
+{
+       struct drv_context *drvc;
+
+       drvc = ddi->priv;
+
+       return drvc->instances;
+}
+
 static int hw_dev_open(struct sr_dev_inst *sdi)
 {
-       /* Avoid compiler warnings. */
        (void)sdi;
 
        /* Nothing needed so far. */
@@ -182,7 +214,6 @@ static int hw_dev_open(struct sr_dev_inst *sdi)
 
 static int hw_dev_close(struct sr_dev_inst *sdi)
 {
-       /* Avoid compiler warnings. */
        (void)sdi;
 
        /* Nothing needed so far. */
@@ -199,11 +230,9 @@ static int hw_cleanup(void)
 static int hw_info_get(int info_id, const void **data,
        const struct sr_dev_inst *sdi)
 {
+       (void)sdi;
 
        switch (info_id) {
-       case SR_DI_INST:
-               *data = sdi;
-               break;
        case SR_DI_HWCAPS:
                *data = hwcaps;
                break;
@@ -237,24 +266,21 @@ static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
 
        (void)sdi;
 
-       if (hwcap == SR_HWCAP_PROBECONFIG) {
-               /* Nothing to do, but must be supported */
-               ret = SR_OK;
-       } else if (hwcap == SR_HWCAP_SAMPLERATE) {
+       if (hwcap == SR_HWCAP_SAMPLERATE) {
                cur_samplerate = *(const uint64_t *)value;
-               sr_dbg("demo: %s: setting samplerate to %" PRIu64, __func__,
+               sr_dbg("%s: setting samplerate to %" PRIu64, __func__,
                       cur_samplerate);
                ret = SR_OK;
        } else if (hwcap == SR_HWCAP_LIMIT_SAMPLES) {
                limit_msec = 0;
                limit_samples = *(const uint64_t *)value;
-               sr_dbg("demo: %s: setting limit_samples to %" PRIu64, __func__,
+               sr_dbg("%s: setting limit_samples to %" PRIu64, __func__,
                       limit_samples);
                ret = SR_OK;
        } else if (hwcap == SR_HWCAP_LIMIT_MSEC) {
                limit_msec = *(const uint64_t *)value;
                limit_samples = 0;
-               sr_dbg("demo: %s: setting limit_msec to %" PRIu64, __func__,
+               sr_dbg("%s: setting limit_msec to %" PRIu64, __func__,
                       limit_msec);
                ret = SR_OK;
        } else if (hwcap == SR_HWCAP_PATTERN_MODE) {
@@ -273,8 +299,7 @@ static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
                } else {
                        ret = SR_ERR;
                }
-               sr_dbg("demo: %s: setting pattern to %d", __func__,
-                      default_pattern);
+               sr_dbg("%s: setting pattern to %d", __func__, default_pattern);
        } else {
                ret = SR_ERR;
        }
@@ -285,13 +310,13 @@ static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
 static void samples_generator(uint8_t *buf, uint64_t size, void *data)
 {
        static uint64_t p = 0;
-       struct context *ctx = data;
+       struct dev_context *devc = data;
        uint64_t i;
 
        /* TODO: Needed? */
        memset(buf, 0, size);
 
-       switch (ctx->sample_generator) {
+       switch (devc->sample_generator) {
        case PATTERN_SIGROK: /* sigrok pattern */
                for (i = 0; i < size; i++) {
                        *(buf + i) = ~(pattern_sigrok[p] >> 1);
@@ -314,8 +339,7 @@ static void samples_generator(uint8_t *buf, uint64_t size, void *data)
                memset(buf, 0xff, size);
                break;
        default:
-               sr_err("demo: %s: unknown pattern %d", __func__,
-                      ctx->sample_generator);
+               sr_err("Unknown pattern: %d.", devc->sample_generator);
                break;
        }
 }
@@ -323,17 +347,17 @@ static void samples_generator(uint8_t *buf, uint64_t size, void *data)
 /* Thread function */
 static void thread_func(void *data)
 {
-       struct context *ctx = data;
+       struct dev_context *devc = 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(ctx->timer, NULL);
+       time_last = g_timer_elapsed(devc->timer, NULL);
 
        while (thread_running) {
                /* Rate control */
-               time_cur = g_timer_elapsed(ctx->timer, NULL);
+               time_cur = g_timer_elapsed(devc->timer, NULL);
 
                time_diff = time_cur - time_last;
                time_last = time_cur;
@@ -342,7 +366,7 @@ static void thread_func(void *data)
 
                if (limit_samples) {
                        nb_to_send = MIN(nb_to_send,
-                                     limit_samples - ctx->samples_counter);
+                                     limit_samples - devc->samples_counter);
                }
 
                /* Make sure we don't overflow. */
@@ -350,17 +374,17 @@ static void thread_func(void *data)
 
                if (nb_to_send) {
                        samples_generator(buf, nb_to_send, data);
-                       ctx->samples_counter += nb_to_send;
+                       devc->samples_counter += nb_to_send;
 
-                       g_io_channel_write_chars(ctx->channels[1], (gchar *)&buf,
+                       g_io_channel_write_chars(devc->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 && ctx->samples_counter >= limit_samples))
+                   (limit_samples && devc->samples_counter >= limit_samples))
                {
-                       close(ctx->pipe_fds[1]);
+                       close(devc->pipe_fds[1]);
                        thread_running = 0;
                }
 
@@ -371,19 +395,18 @@ static void thread_func(void *data)
 /* Callback handling data */
 static int receive_data(int fd, int revents, void *cb_data)
 {
-       struct context *ctx = cb_data;
+       struct dev_context *devc = cb_data;
        struct sr_datafeed_packet packet;
        struct sr_datafeed_logic logic;
        static uint64_t samples_received = 0;
        unsigned char c[BUFSIZE];
        gsize z;
 
-       /* Avoid compiler warnings. */
        (void)fd;
        (void)revents;
 
        do {
-               g_io_channel_read_chars(ctx->channels[0],
+               g_io_channel_read_chars(devc->channels[0],
                                        (gchar *)&c, BUFSIZE, &z, NULL);
 
                if (z > 0) {
@@ -392,18 +415,18 @@ static int receive_data(int fd, int revents, void *cb_data)
                        logic.length = z;
                        logic.unitsize = 1;
                        logic.data = c;
-                       sr_session_send(ctx->session_dev_id, &packet);
+                       sr_session_send(devc->session_dev_id, &packet);
                        samples_received += z;
                }
        } while (z > 0);
 
        if (!thread_running && z <= 0) {
                /* Make sure we don't receive more packets. */
-               g_io_channel_shutdown(ctx->channels[0], FALSE, NULL);
+               g_io_channel_shutdown(devc->channels[0], FALSE, NULL);
 
                /* Send last packet. */
                packet.type = SR_DF_END;
-               sr_session_send(ctx->session_dev_id, &packet);
+               sr_session_send(devc->session_dev_id, &packet);
 
                return FALSE;
        }
@@ -417,61 +440,59 @@ static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
        struct sr_datafeed_packet *packet;
        struct sr_datafeed_header *header;
        struct sr_datafeed_meta_logic meta;
-       struct context *ctx;
+       struct dev_context *devc;
 
        (void)sdi;
 
-       /* TODO: 'ctx' is never g_free()'d? */
-       if (!(ctx = g_try_malloc(sizeof(struct context)))) {
-               sr_err("demo: %s: ctx malloc failed", __func__);
+       /* TODO: 'devc' is never g_free()'d? */
+       if (!(devc = g_try_malloc(sizeof(struct dev_context)))) {
+               sr_err("%s: devc malloc failed", __func__);
                return SR_ERR_MALLOC;
        }
 
-       ctx->sample_generator = default_pattern;
-       ctx->session_dev_id = cb_data;
-       ctx->samples_counter = 0;
+       devc->sample_generator = default_pattern;
+       devc->session_dev_id = cb_data;
+       devc->samples_counter = 0;
 
-       if (pipe(ctx->pipe_fds)) {
+       if (pipe(devc->pipe_fds)) {
                /* TODO: Better error message. */
-               sr_err("demo: %s: pipe() failed", __func__);
+               sr_err("%s: pipe() failed", __func__);
                return SR_ERR;
        }
 
-       ctx->channels[0] = g_io_channel_unix_new(ctx->pipe_fds[0]);
-       ctx->channels[1] = g_io_channel_unix_new(ctx->pipe_fds[1]);
+       devc->channels[0] = g_io_channel_unix_new(devc->pipe_fds[0]);
+       devc->channels[1] = g_io_channel_unix_new(devc->pipe_fds[1]);
 
-       g_io_channel_set_flags(ctx->channels[0], G_IO_FLAG_NONBLOCK, NULL);
+       g_io_channel_set_flags(devc->channels[0], G_IO_FLAG_NONBLOCK, NULL);
 
        /* Set channel encoding to binary (default is UTF-8). */
-       g_io_channel_set_encoding(ctx->channels[0], NULL, NULL);
-       g_io_channel_set_encoding(ctx->channels[1], NULL, NULL);
+       g_io_channel_set_encoding(devc->channels[0], NULL, NULL);
+       g_io_channel_set_encoding(devc->channels[1], NULL, NULL);
 
        /* Make channels to unbuffered. */
-       g_io_channel_set_buffered(ctx->channels[0], FALSE);
-       g_io_channel_set_buffered(ctx->channels[1], FALSE);
+       g_io_channel_set_buffered(devc->channels[0], FALSE);
+       g_io_channel_set_buffered(devc->channels[1], FALSE);
 
-       sr_session_source_add_channel(ctx->channels[0], G_IO_IN | G_IO_ERR,
-                   40, receive_data, ctx);
+       sr_session_source_add_channel(devc->channels[0], G_IO_IN | G_IO_ERR,
+                   40, receive_data, devc);
 
        /* Run the demo thread. */
-       g_thread_init(NULL);
-       /* This must to be done between g_thread_init() & g_thread_create(). */
-       ctx->timer = g_timer_new();
+       devc->timer = g_timer_new();
        thread_running = 1;
-       my_thread =
-           g_thread_create((GThreadFunc)thread_func, ctx, TRUE, NULL);
+       my_thread = g_thread_try_new("sigrok demo generator",
+                       (GThreadFunc)thread_func, devc, NULL);
        if (!my_thread) {
-               sr_err("demo: %s: g_thread_create failed", __func__);
+               sr_err("%s: g_thread_try_new failed", __func__);
                return SR_ERR; /* TODO */
        }
 
        if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
-               sr_err("demo: %s: packet malloc failed", __func__);
+               sr_err("%s: packet malloc failed", __func__);
                return SR_ERR_MALLOC;
        }
 
        if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) {
-               sr_err("demo: %s: header malloc failed", __func__);
+               sr_err("%s: header malloc failed", __func__);
                return SR_ERR_MALLOC;
        }
 
@@ -479,14 +500,14 @@ static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
        packet->payload = header;
        header->feed_version = 1;
        gettimeofday(&header->starttime, NULL);
-       sr_session_send(ctx->session_dev_id, packet);
+       sr_session_send(devc->session_dev_id, packet);
 
        /* Send metadata about the SR_DF_LOGIC packets to come. */
        packet->type = SR_DF_META_LOGIC;
        packet->payload = &meta;
        meta.samplerate = cur_samplerate;
        meta.num_probes = NUM_PROBES;
-       sr_session_send(ctx->session_dev_id, packet);
+       sr_session_send(devc->session_dev_id, packet);
 
        g_free(header);
        g_free(packet);
@@ -494,16 +515,19 @@ static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
        return SR_OK;
 }
 
-static int hw_dev_acquisition_stop(const struct sr_dev_inst *sdi,
-               void *cb_data)
+static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 {
-       /* Avoid compiler warnings. */
-       (void)sdi;
+       struct dev_context *devc;
+
        (void)cb_data;
 
+       devc = sdi->priv;
+
        /* Stop generate thread. */
        thread_running = 0;
 
+       sr_session_source_remove_channel(devc->channels[0]);
+
        return SR_OK;
 }
 
@@ -514,11 +538,12 @@ SR_PRIV struct sr_dev_driver demo_driver_info = {
        .init = hw_init,
        .cleanup = hw_cleanup,
        .scan = hw_scan,
+       .dev_list = hw_dev_list,
        .dev_open = hw_dev_open,
        .dev_close = hw_dev_close,
        .info_get = hw_info_get,
        .dev_config_set = hw_dev_config_set,
        .dev_acquisition_start = hw_dev_acquisition_start,
        .dev_acquisition_stop = hw_dev_acquisition_stop,
-       .instances = NULL,
+       .priv = NULL,
 };