*
* Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
* Copyright (C) 2011 Olivier Fauchon <olivier@aixmarseille.com>
+ * Copyright (C) 2012 Alexandru Gagniuc <mr.nuke.me@gmail.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 "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
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;
- uint8_t thread_running;
uint64_t samples_counter;
void *session_dev_id;
- GTimer *timer;
+ int64_t starttime;
};
static const int hwcaps[] = {
- SR_HWCAP_LOGIC_ANALYZER,
- SR_HWCAP_DEMO_DEV,
- SR_HWCAP_SAMPLERATE,
- SR_HWCAP_PATTERN_MODE,
- SR_HWCAP_LIMIT_SAMPLES,
- SR_HWCAP_LIMIT_MSEC,
- SR_HWCAP_CONTINUOUS,
+ SR_CONF_LOGIC_ANALYZER,
+ SR_CONF_DEMO_DEV,
+ SR_CONF_SAMPLERATE,
+ SR_CONF_PATTERN_MODE,
+ SR_CONF_LIMIT_SAMPLES,
+ SR_CONF_LIMIT_MSEC,
+ SR_CONF_CONTINUOUS,
};
static const struct sr_samplerates samplerates = {
/* We name the probes 0-7 on our demo driver. */
static const char *probe_names[NUM_PROBES + 1] = {
- "0",
- "1",
- "2",
- "3",
- "4",
- "5",
- "6",
- "7",
+ "0", "1", "2", "3", "4", "5", "6", "7",
NULL,
};
/* List of struct sr_dev_inst, maintained by dev_open()/dev_close(). */
SR_PRIV struct sr_dev_driver demo_driver_info;
-static struct sr_dev_driver *ddi = &demo_driver_info;
+static struct sr_dev_driver *di = &demo_driver_info;
static uint64_t cur_samplerate = SR_KHZ(200);
static uint64_t limit_samples = 0;
static uint64_t limit_msec = 0;
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 clear_instances(void)
+{
+ /* Nothing needed so far. */
+
+ return SR_OK;
+}
-static int hw_init(void)
+static int hw_init(struct sr_context *sr_ctx)
{
+ 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;
+ }
+ drvc->sr_ctx = sr_ctx;
+ di->priv = drvc;
return SR_OK;
}
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 = di->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;
+ sdi->driver = di;
+
+ for (i = 0; probe_names[i]; i++) {
+ if (!(probe = sr_probe_new(i, SR_PROBE_LOGIC, 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 = di->priv;
+
+ return drvc->instances;
+}
+
static int hw_dev_open(struct sr_dev_inst *sdi)
{
- /* Avoid compiler warnings. */
(void)sdi;
/* Nothing needed so far. */
static int hw_dev_close(struct sr_dev_inst *sdi)
{
- /* Avoid compiler warnings. */
(void)sdi;
/* Nothing needed so far. */
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;
- case SR_DI_NUM_PROBES:
- *data = GINT_TO_POINTER(NUM_PROBES);
- break;
- case SR_DI_PROBE_NAMES:
- *data = probe_names;
- break;
case SR_DI_SAMPLERATES:
*data = &samplerates;
break;
(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_CONF_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) {
+ } else if (hwcap == SR_CONF_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) {
+ } else if (hwcap == SR_CONF_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) {
+ } else if (hwcap == SR_CONF_PATTERN_MODE) {
stropt = value;
ret = SR_OK;
if (!strcmp(stropt, "sigrok")) {
} 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;
}
return ret;
}
-static void samples_generator(uint8_t *buf, uint64_t size, void *data)
+static void samples_generator(uint8_t *buf, uint64_t size,
+ struct dev_context *devc)
{
static uint64_t p = 0;
- struct context *ctx = 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);
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;
}
}
-/* Thread function */
-static void thread_func(void *data)
-{
- struct context *ctx = 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);
-
- while (thread_running) {
- /* Rate control */
- time_cur = g_timer_elapsed(ctx->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 = MIN(nb_to_send,
- limit_samples - ctx->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);
- ctx->samples_counter += nb_to_send;
-
- g_io_channel_write_chars(ctx->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))
- {
- close(ctx->pipe_fds[1]);
- thread_running = 0;
- }
-
- g_usleep(10);
- }
-}
-
/* 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;
+ uint8_t buf[BUFSIZE];
+ static uint64_t samples_to_send, expected_samplenum, sending_now;
+ int64_t time, elapsed;
- /* Avoid compiler warnings. */
(void)fd;
(void)revents;
- do {
- g_io_channel_read_chars(ctx->channels[0],
- (gchar *)&c, BUFSIZE, &z, NULL);
-
- if (z > 0) {
- packet.type = SR_DF_LOGIC;
- packet.payload = &logic;
- logic.length = z;
- logic.unitsize = 1;
- logic.data = c;
- sr_session_send(ctx->session_dev_id, &packet);
- samples_received += z;
- }
- } while (z > 0);
+ /* How many "virtual" samples should we have collected by now? */
+ time = g_get_monotonic_time();
+ elapsed = time - devc->starttime;
+ expected_samplenum = elapsed * cur_samplerate / 1000000;
+ /* Of those, how many do we still have to send? */
+ samples_to_send = expected_samplenum - devc->samples_counter;
- if (!thread_running && z <= 0) {
- /* Make sure we don't receive more packets. */
- g_io_channel_shutdown(ctx->channels[0], FALSE, NULL);
+ if (limit_samples) {
+ samples_to_send = MIN(samples_to_send,
+ limit_samples - devc->samples_counter);
+ }
- /* Send last packet. */
- packet.type = SR_DF_END;
- sr_session_send(ctx->session_dev_id, &packet);
+ while (samples_to_send > 0) {
+ sending_now = MIN(samples_to_send, sizeof(buf));
+ samples_to_send -= sending_now;
+ samples_generator(buf, sending_now, devc);
+
+ packet.type = SR_DF_LOGIC;
+ packet.payload = &logic;
+ logic.length = sending_now;
+ logic.unitsize = 1;
+ logic.data = buf;
+ sr_session_send(devc->session_dev_id, &packet);
+ devc->samples_counter += sending_now;
+ }
- return FALSE;
+ if (limit_samples && devc->samples_counter >= limit_samples) {
+ sr_info("Requested number of samples reached.");
+ hw_dev_acquisition_stop(NULL, cb_data);
+ return TRUE;
}
return TRUE;
{
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__);
+ sr_dbg("Starting acquisition.");
+
+ /* 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)) {
+ /*
+ * Setting two channels connected by a pipe is a remnant from when the
+ * demo driver generated data in a thread, and collected and sent the
+ * data in the main program loop.
+ * They are kept here because it provides a convenient way of setting
+ * up a timeout-based polling mechanism.
+ */
+ 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);
-
- sr_session_source_add_channel(ctx->channels[0], G_IO_IN | G_IO_ERR,
- 40, receive_data, ctx);
-
- /* 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();
- thread_running = 1;
- my_thread =
- g_thread_create((GThreadFunc)thread_func, ctx, TRUE, NULL);
- if (!my_thread) {
- sr_err("demo: %s: g_thread_create failed", __func__);
- return SR_ERR; /* TODO */
- }
+ g_io_channel_set_buffered(devc->channels[0], FALSE);
+ g_io_channel_set_buffered(devc->channels[1], FALSE);
+
+ sr_session_source_add_channel(devc->channels[0], G_IO_IN | G_IO_ERR,
+ 40, receive_data, devc);
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;
}
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);
+ /* We use this timestamp to decide how many more samples to send. */
+ devc->starttime = g_get_monotonic_time();
g_free(header);
g_free(packet);
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. */
+ struct dev_context *devc;
+ struct sr_datafeed_packet packet;
+
(void)sdi;
- (void)cb_data;
- /* Stop generate thread. */
- thread_running = 0;
+ devc = cb_data;
+
+ sr_dbg("Stopping aquisition.");
+
+ sr_session_source_remove_channel(devc->channels[0]);
+ g_io_channel_shutdown(devc->channels[0], FALSE, NULL);
+
+ /* Send last packet. */
+ packet.type = SR_DF_END;
+ sr_session_send(devc->session_dev_id, &packet);
return SR_OK;
}
.init = hw_init,
.cleanup = hw_cleanup,
.scan = hw_scan,
+ .dev_list = hw_dev_list,
+ .dev_clear = clear_instances,
.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,
};
projects / libsigrok.git / blobdiff