[libsigrok.git] / src / output / hex.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2014 Bert Vermeulen <bert@biot.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
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#include <config.h>
#include <stdlib.h>
#include <string.h>
#include <glib.h>
#include <libsigrok/libsigrok.h>
#include "libsigrok-internal.h"

#define LOG_PREFIX "output/hex"

#define DEFAULT_SAMPLES_PER_LINE 192

struct context {
	unsigned int num_enabled_channels;
	int spl;
	int bit_cnt;
	int spl_cnt;
	int trigger;
	uint64_t samplerate;
	int *channel_index;
	char **channel_names;
	char **line_values;
	uint8_t *sample_buf;
	gboolean header_done;
	GString **lines;
};

static int init(struct sr_output *o, GHashTable *options)
{
	struct context *ctx;
	struct sr_channel *ch;
	GSList *l;
	unsigned int i, j;

	if (!o || !o->sdi)
		return SR_ERR_ARG;

	ctx = g_malloc0(sizeof(struct context));
	o->priv = ctx;
	ctx->trigger = -1;
	ctx->spl = g_variant_get_uint32(g_hash_table_lookup(options, "width"));

	for (l = o->sdi->channels; l; l = l->next) {
		ch = l->data;
		if (ch->type != SR_CHANNEL_LOGIC)
			continue;
		if (!ch->enabled)
			continue;
		ctx->num_enabled_channels++;
	}
	ctx->channel_index = g_malloc(sizeof(int) * ctx->num_enabled_channels);
	ctx->channel_names = g_malloc(sizeof(char *) * ctx->num_enabled_channels);
	ctx->lines = g_malloc(sizeof(GString *) * ctx->num_enabled_channels);
	ctx->sample_buf = g_malloc(ctx->num_enabled_channels);

	j = 0;
	for (i = 0, l = o->sdi->channels; l; l = l->next, i++) {
		ch = l->data;
		if (ch->type != SR_CHANNEL_LOGIC)
			continue;
		if (!ch->enabled)
			continue;
		ctx->channel_index[j] = ch->index;
		ctx->channel_names[j] = ch->name;
		ctx->lines[j] = g_string_sized_new(80);
		ctx->sample_buf[j] = 0;
		g_string_printf(ctx->lines[j], "%s:", ch->name);
		j++;
	}

	return SR_OK;
}

static GString *gen_header(const struct sr_output *o)
{
	struct context *ctx;
	GVariant *gvar;
	GString *header;
	int num_channels;
	char *samplerate_s;

	ctx = o->priv;
	if (ctx->samplerate == 0) {
		if (sr_config_get(o->sdi->driver, o->sdi, NULL, SR_CONF_SAMPLERATE,
				&gvar) == SR_OK) {
			ctx->samplerate = g_variant_get_uint64(gvar);
			g_variant_unref(gvar);
		}
	}

	header = g_string_sized_new(512);
	g_string_printf(header, "%s %s\n", PACKAGE_NAME, SR_PACKAGE_VERSION_STRING);
	num_channels = g_slist_length(o->sdi->channels);
	g_string_append_printf(header, "Acquisition with %d/%d channels",
			ctx->num_enabled_channels, num_channels);
	if (ctx->samplerate != 0) {
		samplerate_s = sr_samplerate_string(ctx->samplerate);
		g_string_append_printf(header, " at %s", samplerate_s);
		g_free(samplerate_s);
	}
	g_string_append_printf(header, "\n");

	return header;
}

static int receive(const struct sr_output *o, const struct sr_datafeed_packet *packet,
		GString **out)
{
	const struct sr_datafeed_meta *meta;
	const struct sr_datafeed_logic *logic;
	const struct sr_config *src;
	GSList *l;
	struct context *ctx;
	int idx, pos, offset;
	uint64_t i, j;
	gchar *p;

	*out = NULL;
	if (!o || !o->sdi)
		return SR_ERR_ARG;
	if (!(ctx = o->priv))
		return SR_ERR_ARG;

	switch (packet->type) {
	case SR_DF_META:
		meta = packet->payload;
		for (l = meta->config; l; l = l->next) {
			src = l->data;
			if (src->key != SR_CONF_SAMPLERATE)
				continue;
			ctx->samplerate = g_variant_get_uint64(src->data);
		}
		break;
	case SR_DF_TRIGGER:
		ctx->trigger = ctx->spl_cnt;
		break;
	case SR_DF_LOGIC:
		if (!ctx->header_done) {
			*out = gen_header(o);
			ctx->header_done = TRUE;
		} else
			*out = g_string_sized_new(512);

		logic = packet->payload;
		for (i = 0; i <= logic->length - logic->unitsize; i += logic->unitsize) {
			ctx->spl_cnt++;
			pos = ctx->spl_cnt & 7;
			for (j = 0; j < ctx->num_enabled_channels; j++) {
				idx = ctx->channel_index[j];
				p = logic->data + i + idx / 8;
				ctx->sample_buf[j] <<= 1;
				if (*p & (1 << (idx % 8)))
					ctx->sample_buf[j] |= 1;
				if (ctx->spl_cnt && pos == 0) {
					/* Buffered a byte's worth, output hex. */
					g_string_append_printf(ctx->lines[j], "%.2x ",
							ctx->sample_buf[j]);
					ctx->sample_buf[j] = 0;
				}

				if (ctx->spl_cnt == ctx->spl) {
					/* Flush line buffers. */
					g_string_append_len(*out, ctx->lines[j]->str, ctx->lines[j]->len);
					g_string_append_c(*out, '\n');
					if (j == ctx->num_enabled_channels - 1 && ctx->trigger > -1) {
						/*
						 * Each group of 8 bits occupies 2 hex digits plus
						 * 1 separator. Calculate the position of the byte
						 * which contains the trigger, then adjust for the
						 * trigger's bit position within that byte.
						 */
						offset = ctx->trigger / 8 * (2 + 1);
						offset += (ctx->trigger % 8) / 4;
						g_string_append_printf(*out, "T:%*s^ %d\n", offset, "", ctx->trigger);
						ctx->trigger = -1;
					}
					g_string_printf(ctx->lines[j], "%s:", ctx->channel_names[j]);
				}
			}
			if (ctx->spl_cnt == ctx->spl)
				/* Line buffers were already flushed. */
				ctx->spl_cnt = 0;
		}
		break;
	case SR_DF_END:
		if (ctx->spl_cnt) {
			/* Line buffers need flushing. */
			*out = g_string_sized_new(512);
			for (i = 0; i < ctx->num_enabled_channels; i++) {
				if (ctx->spl_cnt & 7)
					g_string_append_printf(ctx->lines[i], "%.2x ",
							ctx->sample_buf[i] << (8 - (ctx->spl_cnt & 7)));
				g_string_append_len(*out, ctx->lines[i]->str, ctx->lines[i]->len);
				g_string_append_c(*out, '\n');
			}
		}
		break;
	}

	return SR_OK;
}

static int cleanup(struct sr_output *o)
{
	struct context *ctx;
	unsigned int i;

	if (!o)
		return SR_ERR_ARG;

	if (!(ctx = o->priv))
		return SR_OK;

	g_free(ctx->channel_index);
	g_free(ctx->sample_buf);
	g_free(ctx->channel_names);
	for (i = 0; i < ctx->num_enabled_channels; i++)
		g_string_free(ctx->lines[i], TRUE);
	g_free(ctx->lines);
	g_free(ctx);
	o->priv = NULL;

	return SR_OK;
}

static struct sr_option options[] = {
	{ "width", "Width", "Number of samples per line", NULL, NULL },
	ALL_ZERO
};

static const struct sr_option *get_options(void)
{
	if (!options[0].def) {
		options[0].def = g_variant_new_uint32(DEFAULT_SAMPLES_PER_LINE);
		g_variant_ref_sink(options[0].def);
	}

	return options;
}

SR_PRIV struct sr_output_module output_hex = {
	.id = "hex",
	.name = "Hexadecimal",
	.desc = "Hexadecimal digits logic data",
	.exts = (const char*[]){"txt", NULL},
	.flags = 0,
	.options = get_options,
	.init = init,
	.receive = receive,
	.cleanup = cleanup,
};
Commit	Line	Data
8d3af2e8 BV	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2014 Bert Vermeulen <bert@biot.com>
	5	*
	6	* This program is free software: you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License as published by
	8	* the Free Software Foundation, either version 3 of the License, or
	9	* (at your option) any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License
	17	* along with this program. If not, see <http://www.gnu.org/licenses/>.
	18	*/
	19
6ec6c43b	20	#include <config.h>
8d3af2e8 BV	21	#include <stdlib.h>
	22	#include <string.h>
	23	#include <glib.h>
c1aae900	24	#include <libsigrok/libsigrok.h>
8d3af2e8 BV	25	#include "libsigrok-internal.h"
	26
	27	#define LOG_PREFIX "output/hex"
	28
	29	#define DEFAULT_SAMPLES_PER_LINE 192
	30
	31	struct context {
	32	unsigned int num_enabled_channels;
dcc55fe9	33	int spl;
8d3af2e8 BV	34	int bit_cnt;
	35	int spl_cnt;
	36	int trigger;
7bcbbfae	37	uint64_t samplerate;
8d3af2e8 BV	38	int *channel_index;
	39	char **channel_names;
	40	char **line_values;
	41	uint8_t *sample_buf;
7bcbbfae	42	gboolean header_done;
8d3af2e8	43	GString **lines;
8d3af2e8 BV	44	};
8d3af2e8 BV	45
a755b0e1	46	static int init(struct sr_output o, GHashTable options)
8d3af2e8 BV	47	{
	48	struct context *ctx;
	49	struct sr_channel *ch;
	50	GSList *l;
8d3af2e8	51	unsigned int i, j;
8d3af2e8 BV	52
	53	if (!o \|\| !o->sdi)
	54	return SR_ERR_ARG;
dba3e682	55
8d3af2e8	56	ctx = g_malloc0(sizeof(struct context));
d686c5ec	57	o->priv = ctx;
8d3af2e8	58	ctx->trigger = -1;
dcc55fe9	59	ctx->spl = g_variant_get_uint32(g_hash_table_lookup(options, "width"));
8d3af2e8 BV	60
	61	for (l = o->sdi->channels; l; l = l->next) {
	62	ch = l->data;
	63	if (ch->type != SR_CHANNEL_LOGIC)
	64	continue;
	65	if (!ch->enabled)
	66	continue;
	67	ctx->num_enabled_channels++;
	68	}
	69	ctx->channel_index = g_malloc(sizeof(int) * ctx->num_enabled_channels);
	70	ctx->channel_names = g_malloc(sizeof(char ) ctx->num_enabled_channels);
	71	ctx->lines = g_malloc(sizeof(GString ) ctx->num_enabled_channels);
	72	ctx->sample_buf = g_malloc(ctx->num_enabled_channels);
	73
	74	j = 0;
	75	for (i = 0, l = o->sdi->channels; l; l = l->next, i++) {
	76	ch = l->data;
	77	if (ch->type != SR_CHANNEL_LOGIC)
	78	continue;
	79	if (!ch->enabled)
	80	continue;
	81	ctx->channel_index[j] = ch->index;
	82	ctx->channel_names[j] = ch->name;
	83	ctx->lines[j] = g_string_sized_new(80);
	84	ctx->sample_buf[j] = 0;
	85	g_string_printf(ctx->lines[j], "%s:", ch->name);
	86	j++;
	87	}
	88
7bcbbfae BV	89	return SR_OK;
	90	}
	91
a755b0e1	92	static GString gen_header(const struct sr_output o)
7bcbbfae BV	93	{
	94	struct context *ctx;
	95	GVariant *gvar;
	96	GString *header;
	97	int num_channels;
	98	char *samplerate_s;
	99
d686c5ec	100	ctx = o->priv;
7bcbbfae BV	101	if (ctx->samplerate == 0) {
	102	if (sr_config_get(o->sdi->driver, o->sdi, NULL, SR_CONF_SAMPLERATE,
	103	&gvar) == SR_OK) {
	104	ctx->samplerate = g_variant_get_uint64(gvar);
	105	g_variant_unref(gvar);
	106	}
	107	}
	108
	109	header = g_string_sized_new(512);
b9eb8e1a	110	g_string_printf(header, "%s %s\n", PACKAGE_NAME, SR_PACKAGE_VERSION_STRING);
8d3af2e8	111	num_channels = g_slist_length(o->sdi->channels);
7bcbbfae BV	112	g_string_append_printf(header, "Acquisition with %d/%d channels",
	113	ctx->num_enabled_channels, num_channels);
	114	if (ctx->samplerate != 0) {
	115	samplerate_s = sr_samplerate_string(ctx->samplerate);
	116	g_string_append_printf(header, " at %s", samplerate_s);
8d3af2e8	117	g_free(samplerate_s);
8d3af2e8	118	}
7bcbbfae	119	g_string_append_printf(header, "\n");
8d3af2e8	120
7bcbbfae	121	return header;
8d3af2e8 BV	122	}
8d3af2e8 BV	123
a755b0e1	124	static int receive(const struct sr_output o, const struct sr_datafeed_packet packet,
dba3e682	125	GString **out)
8d3af2e8	126	{
7bcbbfae	127	const struct sr_datafeed_meta *meta;
8d3af2e8	128	const struct sr_datafeed_logic *logic;
7bcbbfae BV	129	const struct sr_config *src;
7bcbbfae BV	130	GSList *l;
8d3af2e8 BV	131	struct context *ctx;
	132	int idx, pos, offset;
	133	uint64_t i, j;
	134	gchar *p;
	135
8d3af2e8 BV	136	*out = NULL;
	137	if (!o \|\| !o->sdi)
	138	return SR_ERR_ARG;
d686c5ec	139	if (!(ctx = o->priv))
8d3af2e8 BV	140	return SR_ERR_ARG;
	141
	142	switch (packet->type) {
7bcbbfae BV	143	case SR_DF_META:
	144	meta = packet->payload;
	145	for (l = meta->config; l; l = l->next) {
	146	src = l->data;
	147	if (src->key != SR_CONF_SAMPLERATE)
	148	continue;
	149	ctx->samplerate = g_variant_get_uint64(src->data);
	150	}
	151	break;
8d3af2e8 BV	152	case SR_DF_TRIGGER:
	153	ctx->trigger = ctx->spl_cnt;
	154	break;
	155	case SR_DF_LOGIC:
7bcbbfae BV	156	if (!ctx->header_done) {
	157	*out = gen_header(o);
	158	ctx->header_done = TRUE;
8d3af2e8 BV	159	} else
	160	*out = g_string_sized_new(512);
	161
	162	logic = packet->payload;
	163	for (i = 0; i <= logic->length - logic->unitsize; i += logic->unitsize) {
	164	ctx->spl_cnt++;
	165	pos = ctx->spl_cnt & 7;
	166	for (j = 0; j < ctx->num_enabled_channels; j++) {
	167	idx = ctx->channel_index[j];
	168	p = logic->data + i + idx / 8;
	169	ctx->sample_buf[j] <<= 1;
	170	if (*p & (1 << (idx % 8)))
	171	ctx->sample_buf[j] \|= 1;
	172	if (ctx->spl_cnt && pos == 0) {
	173	/* Buffered a byte's worth, output hex. */
	174	g_string_append_printf(ctx->lines[j], "%.2x ",
	175	ctx->sample_buf[j]);
	176	ctx->sample_buf[j] = 0;
	177	}
	178
dcc55fe9	179	if (ctx->spl_cnt == ctx->spl) {
8d3af2e8 BV	180	/* Flush line buffers. */
	181	g_string_append_len(*out, ctx->lines[j]->str, ctx->lines[j]->len);
	182	g_string_append_c(*out, '\n');
405b9c10	183	if (j == ctx->num_enabled_channels - 1 && ctx->trigger > -1) {
67b345b9 GS	184	/*
	185	* Each group of 8 bits occupies 2 hex digits plus
	186	* 1 separator. Calculate the position of the byte
	187	* which contains the trigger, then adjust for the
	188	* trigger's bit position within that byte.
	189	*/
	190	offset = ctx->trigger / 8 * (2 + 1);
	191	offset += (ctx->trigger % 8) / 4;
8d3af2e8 BV	192	g_string_append_printf(out, "T:%s^ %d\n", offset, "", ctx->trigger);
	193	ctx->trigger = -1;
	194	}
	195	g_string_printf(ctx->lines[j], "%s:", ctx->channel_names[j]);
	196	}
	197	}
dcc55fe9	198	if (ctx->spl_cnt == ctx->spl)
8d3af2e8 BV	199	/* Line buffers were already flushed. */
	200	ctx->spl_cnt = 0;
	201	}
	202	break;
	203	case SR_DF_END:
	204	if (ctx->spl_cnt) {
	205	/* Line buffers need flushing. */
	206	*out = g_string_sized_new(512);
	207	for (i = 0; i < ctx->num_enabled_channels; i++) {
	208	if (ctx->spl_cnt & 7)
	209	g_string_append_printf(ctx->lines[i], "%.2x ",
	210	ctx->sample_buf[i] << (8 - (ctx->spl_cnt & 7)));
	211	g_string_append_len(*out, ctx->lines[i]->str, ctx->lines[i]->len);
	212	g_string_append_c(*out, '\n');
	213	}
	214	}
	215	break;
	216	}
	217
	218	return SR_OK;
	219	}
	220
	221	static int cleanup(struct sr_output *o)
	222	{
	223	struct context *ctx;
	224	unsigned int i;
	225
	226	if (!o)
	227	return SR_ERR_ARG;
	228
d686c5ec	229	if (!(ctx = o->priv))
8d3af2e8 BV	230	return SR_OK;
8d3af2e8 BV	231
8d3af2e8 BV	232	g_free(ctx->channel_index);
	233	g_free(ctx->sample_buf);
	234	g_free(ctx->channel_names);
	235	for (i = 0; i < ctx->num_enabled_channels; i++)
	236	g_string_free(ctx->lines[i], TRUE);
	237	g_free(ctx->lines);
8d3af2e8	238	g_free(ctx);
d686c5ec	239	o->priv = NULL;
8d3af2e8 BV	240
	241	return SR_OK;
	242	}
	243
a755b0e1 BV	244	static struct sr_option options[] = {
a755b0e1 BV	245	{ "width", "Width", "Number of samples per line", NULL, NULL },
1685c276	246	ALL_ZERO
a755b0e1 BV	247	};
a755b0e1 BV	248
af7d656d	249	static const struct sr_option *get_options(void)
a755b0e1	250	{
950043c3 BV	251	if (!options[0].def) {
	252	options[0].def = g_variant_new_uint32(DEFAULT_SAMPLES_PER_LINE);
	253	g_variant_ref_sink(options[0].def);
	254	}
a755b0e1 BV	255
	256	return options;
	257	}
	258
	259	SR_PRIV struct sr_output_module output_hex = {
8d3af2e8	260	.id = "hex",
a755b0e1	261	.name = "Hexadecimal",
b20eb520	262	.desc = "Hexadecimal digits logic data",
8a174d23	263	.exts = (const char*[]){"txt", NULL},
3cd4b381	264	.flags = 0,
a755b0e1	265	.options = get_options,
8d3af2e8 BV	266	.init = init,
	267	.receive = receive,
	268	.cleanup = cleanup,
	269	};