X-Git-Url: https://sigrok.org/gitweb/?p=libsigrok.git;a=blobdiff_plain;f=hardware%2Fdemo%2Fdemo.c;h=8a84e8ce65a3d6b7d4f407da0107703f510eb6e2;hp=f5f57b8d8093839f8d2b20acfda4a18d95daea41;hb=d261dbbfcc73;hpb=108a5bfbba72882d1bc903a0ae54d0a883ff0824

diff --git a/hardware/demo/demo.c b/hardware/demo/demo.c
index f5f57b8d..8a84e8ce 100644
--- a/hardware/demo/demo.c
+++ b/hardware/demo/demo.c
@@ -22,52 +22,100 @@
 #include <stdlib.h>
 #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"
+#include "sigrok.h"
+#include "sigrok-internal.h"
 
+/* TODO: Number of probes should be configurable. */
 #define NUM_PROBES             8
+
 #define DEMONAME               "Demo device"
-/* size of chunks to send through the session bus */
+
+/* The size of chunks to send through the session bus. */
+/* TODO: Should be configurable. */
 #define BUFSIZE                4096
 
+/* Supported patterns which we can generate */
 enum {
-	GENMODE_DEFAULT,
-	GENMODE_RANDOM,
-	GENMODE_INC,
+	/**
+	 * Pattern which spells "sigrok" using '0's (with '1's as "background")
+	 * when displayed using the 'bits' output format.
+	 */
+	PATTERN_SIGROK,
+
+	/** Pattern which consists of (pseudo-)random values on all probes. */
+	PATTERN_RANDOM,
+
+	/**
+	 * Pattern which consists of incrementing numbers.
+	 * TODO: Better description.
+	 */
+	PATTERN_INC,
+
+	/** Pattern where all probes have a low logic state. */
+	PATTERN_ALL_LOW,
+
+	/** Pattern where all probes have a high logic state. */
+	PATTERN_ALL_HIGH,
 };
 
-GIOChannel *channels[2];
+/* FIXME: Should not be global. */
+SR_PRIV GIOChannel *channels[2];
 
 struct databag {
 	int pipe_fds[2];
 	uint8_t sample_generator;
 	uint8_t thread_running;
 	uint64_t samples_counter;
-	int device_index;
-	gpointer session_device_id;
+	int dev_index;
+	gpointer session_data;
 	GTimer *timer;
 };
 
-static int capabilities[] = {
-	HWCAP_LOGIC_ANALYZER,
-	HWCAP_PATTERN_MODE,
-	HWCAP_LIMIT_SAMPLES,
-	HWCAP_LIMIT_MSEC,
-	HWCAP_CONTINUOUS
+static 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,
 };
 
-static const char *patternmodes[] = {
+static struct sr_samplerates samplerates = {
+	SR_HZ(1),
+	SR_GHZ(1),
+	SR_HZ(1),
+	NULL,
+};
+
+static const char *pattern_strings[] = {
+	"sigrok",
 	"random",
 	"incremental",
+	"all-low",
+	"all-high",
+	NULL,
+};
+
+/* 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",
 	NULL,
 };
 
-static uint8_t genmode_default[] = {
+static uint8_t pattern_sigrok[] = {
 	0x4c, 0x92, 0x92, 0x92, 0x64, 0x00, 0x00, 0x00,
 	0x82, 0xfe, 0xfe, 0x82, 0x00, 0x00, 0x00, 0x00,
 	0x7c, 0x82, 0x82, 0x92, 0x74, 0x00, 0x00, 0x00,
@@ -78,127 +126,157 @@ static uint8_t genmode_default[] = {
 	0xbe, 0xbe, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
 };
 
-/* List of struct sigrok_device_instance, maintained by opendev()/closedev(). */
-static GSList *device_instances = NULL;
-static uint64_t cur_samplerate = KHZ(200);
+/* Private, per-device-instance driver context. */
+/* TODO: struct context as with the other drivers. */
+
+/* List of struct sr_dev_inst, maintained by dev_open()/dev_close(). */
+static GSList *dev_insts = 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 int default_pattern = PATTERN_SIGROK;
 static GThread *my_thread;
 static int thread_running;
 
-static void hw_stop_acquisition(int device_index, gpointer session_device_id);
+static int hw_dev_acquisition_stop(int dev_index, gpointer session_data);
 
-static int hw_init(char *deviceinfo)
+static int hw_init(const char *devinfo)
 {
-	struct sigrok_device_instance *sdi;
+	struct sr_dev_inst *sdi;
 
 	/* Avoid compiler warnings. */
-	deviceinfo = deviceinfo;
+	(void)devinfo;
 
-	sdi = sigrok_device_instance_new(0, ST_ACTIVE, DEMONAME, NULL, NULL);
-	if (!sdi)
+	sdi = sr_dev_inst_new(0, SR_ST_ACTIVE, DEMONAME, NULL, NULL);
+	if (!sdi) {
+		sr_err("demo: %s: sr_dev_inst_new failed", __func__);
 		return 0;
+	}
 
-	device_instances = g_slist_append(device_instances, sdi);
+	dev_insts = g_slist_append(dev_insts, sdi);
 
 	return 1;
 }
 
-static int hw_opendev(int device_index)
+static int hw_dev_open(int dev_index)
 {
 	/* Avoid compiler warnings. */
-	device_index = device_index;
+	(void)dev_index;
 
 	/* Nothing needed so far. */
-	return SIGROK_OK;
+
+	return SR_OK;
 }
 
-static void hw_closedev(int device_index)
+static int hw_dev_close(int dev_index)
 {
 	/* Avoid compiler warnings. */
-	device_index = device_index;
+	(void)dev_index;
 
 	/* Nothing needed so far. */
+
+	return SR_OK;
 }
 
-static void hw_cleanup(void)
+static int hw_cleanup(void)
 {
 	/* Nothing needed so far. */
+	return SR_OK;
 }
 
-static void *hw_get_device_info(int device_index, int device_info_id)
+static void *hw_dev_info_get(int dev_index, int dev_info_id)
 {
-	struct sigrok_device_instance *sdi;
+	struct sr_dev_inst *sdi;
 	void *info = NULL;
 
-	if (!(sdi = get_sigrok_device_instance(device_instances, device_index)))
+	if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) {
+		sr_err("demo: %s: sdi was NULL", __func__);
 		return NULL;
+	}
 
-	switch (device_info_id) {
-	case DI_INSTANCE:
+	switch (dev_info_id) {
+	case SR_DI_INST:
 		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_PROBE_NAMES:
+		info = probe_names;
+		break;
+	case SR_DI_SAMPLERATES:
+		info = &samplerates;
+		break;
+	case SR_DI_CUR_SAMPLERATE:
 		info = &cur_samplerate;
 		break;
-	case DI_PATTERNMODES:
-		info = &patternmodes;
+	case SR_DI_PATTERNMODES:
+		info = &pattern_strings;
 		break;
 	}
 
 	return info;
 }
 
-static int hw_get_status(int device_index)
+static int hw_dev_status_get(int dev_index)
 {
 	/* Avoid compiler warnings. */
-	device_index = device_index;
+	(void)dev_index;
 
-	return ST_ACTIVE;
+	return SR_ST_ACTIVE;
 }
 
-static int *hw_get_capabilities(void)
+static int *hw_hwcap_get_all(void)
 {
-	return capabilities;
+	return hwcaps;
 }
 
-static int hw_set_configuration(int device_index, int capability, void *value)
+static int hw_dev_config_set(int dev_index, int hwcap, void *value)
 {
 	int ret;
-	uint64_t *tmp_u64;
 	char *stropt;
 
 	/* Avoid compiler warnings. */
-	device_index = device_index;
-
-	if (capability == HWCAP_PROBECONFIG) {
-		/* Nothing to do. */
-		ret = SIGROK_OK;
-	} else if (capability == HWCAP_LIMIT_SAMPLES) {
-		tmp_u64 = value;
-		limit_samples = *tmp_u64;
-		ret = SIGROK_OK;
-	} else if (capability == HWCAP_LIMIT_MSEC) {
-		tmp_u64 = value;
-		limit_msec = *tmp_u64;
-		ret = SIGROK_OK;
-	} else if (capability == HWCAP_PATTERN_MODE) {
+	(void)dev_index;
+
+	if (hwcap == SR_HWCAP_PROBECONFIG) {
+		/* Nothing to do, but must be supported */
+		ret = SR_OK;
+	} else if (hwcap == SR_HWCAP_SAMPLERATE) {
+		cur_samplerate = *(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;
+		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;
+		sr_dbg("demo: %s: setting limit_msec to %" PRIu64, __func__,
+		       limit_msec);
+		ret = SR_OK;
+	} else if (hwcap == SR_HWCAP_PATTERN_MODE) {
 		stropt = value;
-		if (!strcmp(stropt, "random")) {
-			default_genmode = GENMODE_RANDOM;
-			ret = SIGROK_OK;
+		ret = SR_OK;
+		if (!strcmp(stropt, "sigrok")) {
+			default_pattern = PATTERN_SIGROK;
+		} else if (!strcmp(stropt, "random")) {
+			default_pattern = PATTERN_RANDOM;
 		} else if (!strcmp(stropt, "incremental")) {
-			default_genmode = GENMODE_INC;
-			ret = SIGROK_OK;
+			default_pattern = PATTERN_INC;
+		} else if (!strcmp(stropt, "all-low")) {
+			default_pattern = PATTERN_ALL_LOW;
+		} else if (!strcmp(stropt, "all-high")) {
+			default_pattern = PATTERN_ALL_HIGH;
 		} else {
-			ret = SIGROK_ERR;
+			ret = SR_ERR;
 		}
+		sr_dbg("demo: %s: setting pattern to %d", __func__,
+		       default_pattern);
 	} else {
-		ret = SIGROK_ERR;
+		ret = SR_ERR;
 	}
 
 	return ret;
@@ -206,28 +284,38 @@ 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;
+	uint64_t i;
 
+	/* TODO: Needed? */
 	memset(buf, 0, size);
 
 	switch (mydata->sample_generator) {
-	case GENMODE_DEFAULT:
-		p = 0;
+	case PATTERN_SIGROK: /* sigrok pattern */
 		for (i = 0; i < size; i++) {
-			*(buf + i) = ~(genmode_default[p] >> 1);
+			*(buf + i) = ~(pattern_sigrok[p] >> 1);
 			if (++p == 64)
 				p = 0;
 		}
 		break;
-	case GENMODE_RANDOM: /* Random */
+	case PATTERN_RANDOM: /* Random */
 		for (i = 0; i < size; i++)
 			*(buf + i) = (uint8_t)(rand() & 0xff);
 		break;
-	case GENMODE_INC: /* Simple increment */
+	case PATTERN_INC: /* Simple increment */
 		for (i = 0; i < size; i++)
 			*(buf + i) = i;
 		break;
+	case PATTERN_ALL_LOW: /* All probes are low */
+		memset(buf, 0x00, size);
+		break;
+	case PATTERN_ALL_HIGH: /* All probes are high */
+		memset(buf, 0xff, size);
+		break;
+	default:
+		/* TODO: Error handling. */
+		break;
 	}
 }
 
@@ -238,7 +326,6 @@ static void thread_func(void *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);
@@ -252,9 +339,10 @@ static void thread_func(void *data)
 
 		nb_to_send = cur_samplerate * time_diff;
 
-		if (limit_samples)
+		if (limit_samples) {
 			nb_to_send = MIN(nb_to_send,
-					limit_samples - mydata->samples_counter);
+				      limit_samples - mydata->samples_counter);
+		}
 
 		/* Make sure we don't overflow. */
 		nb_to_send = MIN(nb_to_send, BUFSIZE);
@@ -264,7 +352,7 @@ static void thread_func(void *data)
 			mydata->samples_counter += nb_to_send;
 
 			g_io_channel_write_chars(channels[1], (gchar *)&buf,
-					nb_to_send, (gsize *)&bytes_written, NULL);
+				nb_to_send, (gsize *)&bytes_written, NULL);
 		}
 
 		/* Check if we're done. */
@@ -280,37 +368,40 @@ static void thread_func(void *data)
 }
 
 /* Callback handling data */
-static int receive_data(int fd, int revents, void *user_data)
+static int receive_data(int fd, int revents, void *session_data)
 {
-	struct datafeed_packet packet;
-	char c[BUFSIZE];
+	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. */
-	fd = fd;
-	revents = revents;
+	(void)fd;
+	(void)revents;
 
 	do {
 		g_io_channel_read_chars(channels[0],
 				        (gchar *)&c, BUFSIZE, &z, NULL);
 
 		if (z > 0) {
-			packet.type = DF_LOGIC;
-			packet.length = z;
-			packet.unitsize = 1;
-			packet.payload = c;
-			session_bus(user_data, &packet);
+			packet.type = SR_DF_LOGIC;
+			packet.payload = &logic;
+			logic.length = z;
+			logic.unitsize = 1;
+			logic.data = c;
+			sr_session_bus(session_data, &packet);
+			samples_received += z;
 		}
 	} while (z > 0);
 
-	if (!thread_running && z <= 0)
-	{
-		/* Make sure we don't receive more packets */
+	if (!thread_running && z <= 0) {
+		/* Make sure we don't receive more packets. */
 		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(session_data, &packet);
 
 		return FALSE;
 	}
@@ -318,23 +409,28 @@ static int receive_data(int fd, int revents, void *user_data)
 	return TRUE;
 }
 
-static int hw_start_acquisition(int device_index, gpointer session_device_id)
+static int hw_dev_acquisition_start(int dev_index, gpointer session_data)
 {
-	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;
-	mydata->device_index = device_index;
+	mydata->sample_generator = default_pattern;
+	mydata->session_data = session_data;
+	mydata->dev_index = dev_index;
 	mydata->samples_counter = 0;
 
-	if (pipe(mydata->pipe_fds))
-		return SIGROK_ERR;
+	if (pipe(mydata->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]);
@@ -347,60 +443,68 @@ 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_data);
 
 	/* 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();
 	thread_running = 1;
 	my_thread =
 	    g_thread_create((GThreadFunc)thread_func, mydata, TRUE, NULL);
-	if (!my_thread)
-		return SIGROK_ERR;
+	if (!my_thread) {
+		sr_err("demo: %s: g_thread_create failed", __func__);
+		return SR_ERR; /* TODO */
+	}
+
+	if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
+		sr_err("demo: %s: packet malloc failed", __func__);
+		return SR_ERR_MALLOC;
+	}
 
-	packet = malloc(sizeof(struct datafeed_packet));
-	header = malloc(sizeof(struct datafeed_header));
-	if (!packet || !header)
-		return SIGROK_ERR_MALLOC;
+	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->payload = (unsigned char *)header;
+	packet->type = SR_DF_HEADER;
+	packet->payload = header;
 	header->feed_version = 1;
 	gettimeofday(&header->starttime, NULL);
 	header->samplerate = cur_samplerate;
-	header->protocol_id = 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_data, 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)
+static int hw_dev_acquisition_stop(int dev_index, gpointer session_data)
 {
 	/* Avoid compiler warnings. */
-	device_index = device_index;
-	session_device_id = session_device_id;
+	(void)dev_index;
+	(void)session_data;
 
 	/* Stop generate thread. */
 	thread_running = 0;
+
+	return SR_OK;
 }
 
-struct device_plugin demo_plugin_info = {
-	"demo",
-	1,
-	hw_init,
-	hw_cleanup,
-	hw_opendev,
-	hw_closedev,
-	hw_get_device_info,
-	hw_get_status,
-	hw_get_capabilities,
-	hw_set_configuration,
-	hw_start_acquisition,
-	hw_stop_acquisition,
+SR_PRIV struct sr_dev_plugin demo_plugin_info = {
+	.name = "demo",
+	.longname = "Demo driver and pattern generator",
+	.api_version = 1,
+	.init = hw_init,
+	.cleanup = hw_cleanup,
+	.dev_open = hw_dev_open,
+	.dev_close = hw_dev_close,
+	.dev_info_get = hw_dev_info_get,
+	.dev_status_get = hw_dev_status_get,
+	.hwcap_get_all = hw_hwcap_get_all,
+	.dev_config_set = hw_dev_config_set,
+	.dev_acquisition_start = hw_dev_acquisition_start,
+	.dev_acquisition_stop = hw_dev_acquisition_stop,
 };