X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=hardware%2Fdemo%2Fdemo.c;h=e511c0a6fac22340ee8a860cac571836ae0d0b22;hb=a533743dd1680bb53f29b6a01cccbc5380027e77;hp=aa3f57d4a919f8c920aab54864531b0af68c8cca;hpb=ea9cfed7a55260ab97f57150b57c42a28c3a85a7;p=libsigrok.git

diff --git a/hardware/demo/demo.c b/hardware/demo/demo.c
index aa3f57d4..e511c0a6 100644
--- a/hardware/demo/demo.c
+++ b/hardware/demo/demo.c
@@ -66,17 +66,17 @@ enum {
 /* FIXME: Should not be global. */
 SR_PRIV GIOChannel *channels[2];
 
-struct databag {
+struct context {
 	int pipe_fds[2];
 	uint8_t sample_generator;
 	uint8_t thread_running;
 	uint64_t samples_counter;
 	int dev_index;
-	gpointer session_data;
+	void *session_dev_id;
 	GTimer *timer;
 };
 
-static int hwcaps[] = {
+static const int hwcaps[] = {
 	SR_HWCAP_LOGIC_ANALYZER,
 	SR_HWCAP_DEMO_DEV,
 	SR_HWCAP_SAMPLERATE,
@@ -86,7 +86,7 @@ static int hwcaps[] = {
 	SR_HWCAP_CONTINUOUS,
 };
 
-static struct sr_samplerates samplerates = {
+static const struct sr_samplerates samplerates = {
 	SR_HZ(1),
 	SR_GHZ(1),
 	SR_HZ(1),
@@ -102,6 +102,7 @@ static const char *pattern_strings[] = {
 	NULL,
 };
 
+/* We name the probes 0-7 on our demo driver. */
 static const char *probe_names[NUM_PROBES + 1] = {
 	"0",
 	"1",
@@ -137,7 +138,7 @@ static int default_pattern = PATTERN_SIGROK;
 static GThread *my_thread;
 static int thread_running;
 
-static int hw_dev_acquisition_stop(int dev_index, gpointer session_data);
+static int hw_dev_acquisition_stop(int dev_index, void *cb_data);
 
 static int hw_init(const char *devinfo)
 {
@@ -183,10 +184,10 @@ static int hw_cleanup(void)
 	return SR_OK;
 }
 
-static void *hw_dev_info_get(int dev_index, int dev_info_id)
+static const void *hw_dev_info_get(int dev_index, int dev_info_id)
 {
 	struct sr_dev_inst *sdi;
-	void *info = NULL;
+	const void *info = NULL;
 
 	if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) {
 		sr_err("demo: %s: sdi was NULL", __func__);
@@ -209,7 +210,7 @@ static void *hw_dev_info_get(int dev_index, int dev_info_id)
 	case SR_DI_CUR_SAMPLERATE:
 		info = &cur_samplerate;
 		break;
-	case SR_DI_PATTERNMODES:
+	case SR_DI_PATTERNS:
 		info = &pattern_strings;
 		break;
 	}
@@ -225,15 +226,15 @@ static int hw_dev_status_get(int dev_index)
 	return SR_ST_ACTIVE;
 }
 
-static int *hw_hwcap_get_all(void)
+static const int *hw_hwcap_get_all(void)
 {
 	return hwcaps;
 }
 
-static int hw_dev_config_set(int dev_index, int hwcap, void *value)
+static int hw_dev_config_set(int dev_index, int hwcap, const void *value)
 {
 	int ret;
-	char *stropt;
+	const char *stropt;
 
 	/* Avoid compiler warnings. */
 	(void)dev_index;
@@ -242,17 +243,17 @@ static int hw_dev_config_set(int dev_index, int hwcap, void *value)
 		/* Nothing to do, but must be supported */
 		ret = SR_OK;
 	} else if (hwcap == SR_HWCAP_SAMPLERATE) {
-		cur_samplerate = *(uint64_t *)value;
+		cur_samplerate = *(const uint64_t *)value;
 		sr_dbg("demo: %s: setting samplerate to %" PRIu64, __func__,
 		       cur_samplerate);
 		ret = SR_OK;
 	} else if (hwcap == SR_HWCAP_LIMIT_SAMPLES) {
-		limit_samples = *(uint64_t *)value;
+		limit_samples = *(const uint64_t *)value;
 		sr_dbg("demo: %s: setting limit_samples to %" PRIu64, __func__,
 		       limit_samples);
 		ret = SR_OK;
 	} else if (hwcap == SR_HWCAP_LIMIT_MSEC) {
-		limit_msec = *(uint64_t *)value;
+		limit_msec = *(const uint64_t *)value;
 		sr_dbg("demo: %s: setting limit_msec to %" PRIu64, __func__,
 		       limit_msec);
 		ret = SR_OK;
@@ -284,13 +285,13 @@ static int hw_dev_config_set(int dev_index, int hwcap, void *value)
 static void samples_generator(uint8_t *buf, uint64_t size, void *data)
 {
 	static uint64_t p = 0;
-	struct databag *mydata = data;
+	struct context *ctx = data;
 	uint64_t i;
 
 	/* TODO: Needed? */
 	memset(buf, 0, size);
 
-	switch (mydata->sample_generator) {
+	switch (ctx->sample_generator) {
 	case PATTERN_SIGROK: /* sigrok pattern */
 		for (i = 0; i < size; i++) {
 			*(buf + i) = ~(pattern_sigrok[p] >> 1);
@@ -313,7 +314,8 @@ static void samples_generator(uint8_t *buf, uint64_t size, void *data)
 		memset(buf, 0xff, size);
 		break;
 	default:
-		/* TODO: Error handling. */
+		sr_err("demo: %s: unknown pattern %d", __func__,
+		       ctx->sample_generator);
 		break;
 	}
 }
@@ -321,17 +323,17 @@ static void samples_generator(uint8_t *buf, uint64_t size, void *data)
 /* Thread function */
 static void thread_func(void *data)
 {
-	struct databag *mydata = 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(mydata->timer, NULL);
+	time_last = g_timer_elapsed(ctx->timer, NULL);
 
 	while (thread_running) {
 		/* Rate control */
-		time_cur = g_timer_elapsed(mydata->timer, NULL);
+		time_cur = g_timer_elapsed(ctx->timer, NULL);
 
 		time_diff = time_cur - time_last;
 		time_last = time_cur;
@@ -340,7 +342,7 @@ static void thread_func(void *data)
 
 		if (limit_samples) {
 			nb_to_send = MIN(nb_to_send,
-				      limit_samples - mydata->samples_counter);
+				      limit_samples - ctx->samples_counter);
 		}
 
 		/* Make sure we don't overflow. */
@@ -348,7 +350,7 @@ static void thread_func(void *data)
 
 		if (nb_to_send) {
 			samples_generator(buf, nb_to_send, data);
-			mydata->samples_counter += nb_to_send;
+			ctx->samples_counter += nb_to_send;
 
 			g_io_channel_write_chars(channels[1], (gchar *)&buf,
 				nb_to_send, (gsize *)&bytes_written, NULL);
@@ -356,9 +358,9 @@ static void thread_func(void *data)
 
 		/* Check if we're done. */
 		if ((limit_msec && time_cur * 1000 > limit_msec) ||
-		    (limit_samples && mydata->samples_counter >= limit_samples))
+		    (limit_samples && ctx->samples_counter >= limit_samples))
 		{
-			close(mydata->pipe_fds[1]);
+			close(ctx->pipe_fds[1]);
 			thread_running = 0;
 		}
 
@@ -367,7 +369,7 @@ static void thread_func(void *data)
 }
 
 /* Callback handling data */
-static int receive_data(int fd, int revents, void *session_data)
+static int receive_data(int fd, int revents, void *cb_data)
 {
 	struct sr_datafeed_packet packet;
 	struct sr_datafeed_logic logic;
@@ -389,18 +391,18 @@ static int receive_data(int fd, int revents, void *session_data)
 			logic.length = z;
 			logic.unitsize = 1;
 			logic.data = c;
-			sr_session_bus(session_data, &packet);
+			sr_session_send(cb_data, &packet);
 			samples_received += z;
 		}
 	} while (z > 0);
 
 	if (!thread_running && z <= 0) {
 		/* Make sure we don't receive more packets. */
-		g_io_channel_close(channels[0]);
+		g_io_channel_shutdown(channels[0], FALSE, NULL);
 
 		/* Send last packet. */
 		packet.type = SR_DF_END;
-		sr_session_bus(session_data, &packet);
+		sr_session_send(cb_data, &packet);
 
 		return FALSE;
 	}
@@ -408,31 +410,32 @@ static int receive_data(int fd, int revents, void *session_data)
 	return TRUE;
 }
 
-static int hw_dev_acquisition_start(int dev_index, gpointer session_data)
+static int hw_dev_acquisition_start(int dev_index, void *cb_data)
 {
 	struct sr_datafeed_packet *packet;
 	struct sr_datafeed_header *header;
-	struct databag *mydata;
+	struct sr_datafeed_meta_logic meta;
+	struct context *ctx;
 
-	/* TODO: 'mydata' is never g_free()'d? */
-	if (!(mydata = g_try_malloc(sizeof(struct databag)))) {
-		sr_err("demo: %s: mydata malloc failed", __func__);
+	/* TODO: 'ctx' is never g_free()'d? */
+	if (!(ctx = g_try_malloc(sizeof(struct context)))) {
+		sr_err("demo: %s: ctx malloc failed", __func__);
 		return SR_ERR_MALLOC;
 	}
 
-	mydata->sample_generator = default_pattern;
-	mydata->session_data = session_data;
-	mydata->dev_index = dev_index;
-	mydata->samples_counter = 0;
+	ctx->sample_generator = default_pattern;
+	ctx->session_dev_id = cb_data;
+	ctx->dev_index = dev_index;
+	ctx->samples_counter = 0;
 
-	if (pipe(mydata->pipe_fds)) {
+	if (pipe(ctx->pipe_fds)) {
 		/* TODO: Better error message. */
 		sr_err("demo: %s: pipe() failed", __func__);
 		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]);
+	channels[0] = g_io_channel_unix_new(ctx->pipe_fds[0]);
+	channels[1] = g_io_channel_unix_new(ctx->pipe_fds[1]);
 
 	/* Set channel encoding to binary (default is UTF-8). */
 	g_io_channel_set_encoding(channels[0], NULL, NULL);
@@ -442,16 +445,16 @@ static int hw_dev_acquisition_start(int dev_index, gpointer session_data)
 	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_data);
+	sr_source_add(ctx->pipe_fds[0], G_IO_IN | G_IO_ERR, 40,
+		      receive_data, ctx->session_dev_id);
 
 	/* Run the demo thread. */
 	g_thread_init(NULL);
 	/* This must to be done between g_thread_init() & g_thread_create(). */
-	mydata->timer = g_timer_new();
+	ctx->timer = g_timer_new();
 	thread_running = 1;
 	my_thread =
-	    g_thread_create((GThreadFunc)thread_func, mydata, TRUE, NULL);
+	    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 */
@@ -471,20 +474,27 @@ static int hw_dev_acquisition_start(int dev_index, gpointer session_data)
 	packet->payload = header;
 	header->feed_version = 1;
 	gettimeofday(&header->starttime, NULL);
-	header->samplerate = cur_samplerate;
-	header->num_logic_probes = NUM_PROBES;
-	sr_session_bus(session_data, packet);
+	sr_session_send(ctx->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);
+
 	g_free(header);
 	g_free(packet);
 
 	return SR_OK;
 }
 
-static int hw_dev_acquisition_stop(int dev_index, gpointer session_data)
+/* TODO: This stops acquisition on ALL devices, ignoring dev_index. */
+static int hw_dev_acquisition_stop(int dev_index, void *cb_data)
 {
 	/* Avoid compiler warnings. */
 	(void)dev_index;
-	(void)session_data;
+	(void)cb_data;
 
 	/* Stop generate thread. */
 	thread_running = 0;
@@ -492,7 +502,7 @@ static int hw_dev_acquisition_stop(int dev_index, gpointer session_data)
 	return SR_OK;
 }
 
-SR_PRIV struct sr_dev_plugin demo_plugin_info = {
+SR_PRIV struct sr_dev_driver demo_driver_info = {
 	.name = "demo",
 	.longname = "Demo driver and pattern generator",
 	.api_version = 1,