[libsigrok.git] / src / hardware / openbench-logic-sniffer / protocol.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2013 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 "protocol.h"

SR_PRIV int send_shortcommand(struct sr_serial_dev_inst *serial,
		uint8_t command)
{
	char buf[1];

	sr_dbg("Sending cmd 0x%.2x.", command);
	buf[0] = command;
	if (serial_write_blocking(serial, buf, 1, serial_timeout(serial, 1)) != 1)
		return SR_ERR;

	if (serial_drain(serial) != 0)
		return SR_ERR;

	return SR_OK;
}

SR_PRIV int send_longcommand(struct sr_serial_dev_inst *serial,
		uint8_t command, uint8_t *data)
{
	char buf[5];

	sr_dbg("Sending cmd 0x%.2x data 0x%.2x%.2x%.2x%.2x.", command,
			data[0], data[1], data[2], data[3]);
	buf[0] = command;
	buf[1] = data[0];
	buf[2] = data[1];
	buf[3] = data[2];
	buf[4] = data[3];
	if (serial_write_blocking(serial, buf, 5, serial_timeout(serial, 1)) != 5)
		return SR_ERR;

	if (serial_drain(serial) != 0)
		return SR_ERR;

	return SR_OK;
}

SR_PRIV int ols_send_reset(struct sr_serial_dev_inst *serial)
{
	unsigned int i;

	for (i = 0; i < 5; i++) {
		if (send_shortcommand(serial, CMD_RESET) != SR_OK)
			return SR_ERR;
	}

	return SR_OK;
}

/* Configures the channel mask based on which channels are enabled. */
SR_PRIV void ols_channel_mask(const struct sr_dev_inst *sdi)
{
	struct dev_context *devc;
	struct sr_channel *channel;
	const GSList *l;

	devc = sdi->priv;

	devc->channel_mask = 0;
	for (l = sdi->channels; l; l = l->next) {
		channel = l->data;
		if (channel->enabled)
			devc->channel_mask |= 1 << channel->index;
	}
}

SR_PRIV int ols_convert_trigger(const struct sr_dev_inst *sdi)
{
	struct dev_context *devc;
	struct sr_trigger *trigger;
	struct sr_trigger_stage *stage;
	struct sr_trigger_match *match;
	const GSList *l, *m;
	int i;

	devc = sdi->priv;

	devc->num_stages = 0;
	for (i = 0; i < NUM_TRIGGER_STAGES; i++) {
		devc->trigger_mask[i] = 0;
		devc->trigger_value[i] = 0;
	}

	if (!(trigger = sr_session_trigger_get(sdi->session)))
		return SR_OK;

	devc->num_stages = g_slist_length(trigger->stages);
	if (devc->num_stages > NUM_TRIGGER_STAGES) {
		sr_err("This device only supports %d trigger stages.",
				NUM_TRIGGER_STAGES);
		return SR_ERR;
	}

	for (l = trigger->stages; l; l = l->next) {
		stage = l->data;
		for (m = stage->matches; m; m = m->next) {
			match = m->data;
			if (!match->channel->enabled)
				/* Ignore disabled channels with a trigger. */
				continue;
			devc->trigger_mask[stage->stage] |= 1 << match->channel->index;
			if (match->match == SR_TRIGGER_ONE)
				devc->trigger_value[stage->stage] |= 1 << match->channel->index;
		}
	}

	return SR_OK;
}

SR_PRIV struct dev_context *ols_dev_new(void)
{
	struct dev_context *devc;

	devc = g_malloc0(sizeof(struct dev_context));

	/* Device-specific settings */
	devc->max_samples = devc->max_samplerate = devc->protocol_version = 0;

	/* Acquisition settings */
	devc->limit_samples = devc->capture_ratio = 0;
	devc->trigger_at = -1;
	devc->flag_reg = 0;

	return devc;
}

static void ols_channel_new(struct sr_dev_inst *sdi, int num_chan)
{
	int i;

	for (i = 0; i < num_chan; i++)
		sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE,
				ols_channel_names[i]);
}

SR_PRIV struct sr_dev_inst *get_metadata(struct sr_serial_dev_inst *serial)
{
	struct sr_dev_inst *sdi;
	struct dev_context *devc;
	uint32_t tmp_int;
	uint8_t key, type, token;
	int delay_ms;
	GString *tmp_str, *devname, *version;
	guchar tmp_c;

	sdi = g_malloc0(sizeof(struct sr_dev_inst));
	sdi->status = SR_ST_INACTIVE;
	devc = ols_dev_new();
	sdi->priv = devc;

	devname = g_string_new("");
	version = g_string_new("");

	key = 0xff;
	while (key) {
		delay_ms = serial_timeout(serial, 1);
		if (serial_read_blocking(serial, &key, 1, delay_ms) != 1)
			break;
		if (key == 0x00) {
			sr_dbg("Got metadata key 0x00, metadata ends.");
			break;
		}
		type = key >> 5;
		token = key & 0x1f;
		switch (type) {
		case 0:
			/* NULL-terminated string */
			tmp_str = g_string_new("");
			delay_ms = serial_timeout(serial, 1);
			while (serial_read_blocking(serial, &tmp_c, 1, delay_ms) == 1 && tmp_c != '\0')
				g_string_append_c(tmp_str, tmp_c);
			sr_dbg("Got metadata key 0x%.2x value '%s'.",
			       key, tmp_str->str);
			switch (token) {
			case 0x01:
				/* Device name */
				devname = g_string_append(devname, tmp_str->str);
				break;
			case 0x02:
				/* FPGA firmware version */
				if (version->len)
					g_string_append(version, ", ");
				g_string_append(version, "FPGA version ");
				g_string_append(version, tmp_str->str);
				break;
			case 0x03:
				/* Ancillary version */
				if (version->len)
					g_string_append(version, ", ");
				g_string_append(version, "Ancillary version ");
				g_string_append(version, tmp_str->str);
				break;
			default:
				sr_info("ols: unknown token 0x%.2x: '%s'",
					token, tmp_str->str);
				break;
			}
			g_string_free(tmp_str, TRUE);
			break;
		case 1:
			/* 32-bit unsigned integer */
			delay_ms = serial_timeout(serial, 4);
			if (serial_read_blocking(serial, &tmp_int, 4, delay_ms) != 4)
				break;
			tmp_int = RB32(&tmp_int);
			sr_dbg("Got metadata key 0x%.2x value 0x%.8x.",
			       key, tmp_int);
			switch (token) {
			case 0x00:
				/* Number of usable channels */
				ols_channel_new(sdi, tmp_int);
				break;
			case 0x01:
				/* Amount of sample memory available (bytes) */
				devc->max_samples = tmp_int;
				break;
			case 0x02:
				/* Amount of dynamic memory available (bytes) */
				/* what is this for? */
				break;
			case 0x03:
				/* Maximum sample rate (Hz) */
				devc->max_samplerate = tmp_int;
				break;
			case 0x04:
				/* protocol version */
				devc->protocol_version = tmp_int;
				break;
			default:
				sr_info("Unknown token 0x%.2x: 0x%.8x.",
					token, tmp_int);
				break;
			}
			break;
		case 2:
			/* 8-bit unsigned integer */
			delay_ms = serial_timeout(serial, 1);
			if (serial_read_blocking(serial, &tmp_c, 1, delay_ms) != 1)
				break;
			sr_dbg("Got metadata key 0x%.2x value 0x%.2x.",
			       key, tmp_c);
			switch (token) {
			case 0x00:
				/* Number of usable channels */
				ols_channel_new(sdi, tmp_c);
				break;
			case 0x01:
				/* protocol version */
				devc->protocol_version = tmp_c;
				break;
			default:
				sr_info("Unknown token 0x%.2x: 0x%.2x.",
					token, tmp_c);
				break;
			}
			break;
		default:
			/* unknown type */
			break;
		}
	}

	sdi->model = devname->str;
	sdi->version = version->str;
	g_string_free(devname, FALSE);
	g_string_free(version, FALSE);

	return sdi;
}

SR_PRIV int ols_set_samplerate(const struct sr_dev_inst *sdi,
		const uint64_t samplerate)
{
	struct dev_context *devc;

	devc = sdi->priv;
	if (devc->max_samplerate && samplerate > devc->max_samplerate)
		return SR_ERR_SAMPLERATE;

	if (samplerate > CLOCK_RATE) {
		sr_info("Enabling demux mode.");
		devc->flag_reg |= FLAG_DEMUX;
		devc->flag_reg &= ~FLAG_FILTER;
		devc->max_channels = NUM_CHANNELS / 2;
		devc->cur_samplerate_divider = (CLOCK_RATE * 2 / samplerate) - 1;
	} else {
		sr_info("Disabling demux mode.");
		devc->flag_reg &= ~FLAG_DEMUX;
		devc->flag_reg |= FLAG_FILTER;
		devc->max_channels = NUM_CHANNELS;
		devc->cur_samplerate_divider = (CLOCK_RATE / samplerate) - 1;
	}

	/* Calculate actual samplerate used and complain if it is different
	 * from the requested.
	 */
	devc->cur_samplerate = CLOCK_RATE / (devc->cur_samplerate_divider + 1);
	if (devc->flag_reg & FLAG_DEMUX)
		devc->cur_samplerate *= 2;
	if (devc->cur_samplerate != samplerate)
		sr_info("Can't match samplerate %" PRIu64 ", using %"
		       PRIu64 ".", samplerate, devc->cur_samplerate);

	return SR_OK;
}

SR_PRIV void abort_acquisition(const struct sr_dev_inst *sdi)
{
	struct sr_serial_dev_inst *serial;

	serial = sdi->conn;
	serial_source_remove(sdi->session, serial);

	std_session_send_df_end(sdi);
}

SR_PRIV int ols_receive_data(int fd, int revents, void *cb_data)
{
	struct dev_context *devc;
	struct sr_dev_inst *sdi;
	struct sr_serial_dev_inst *serial;
	struct sr_datafeed_packet packet;
	struct sr_datafeed_logic logic;
	uint32_t sample;
	int num_ols_changrp, offset, j;
	unsigned int i;
	unsigned char byte;

	(void)fd;

	sdi = cb_data;
	serial = sdi->conn;
	devc = sdi->priv;

	if (devc->num_transfers == 0 && revents == 0) {
		/* Ignore timeouts as long as we haven't received anything */
		return TRUE;
	}

	if (devc->num_transfers++ == 0) {
		devc->raw_sample_buf = g_try_malloc(devc->limit_samples * 4);
		if (!devc->raw_sample_buf) {
			sr_err("Sample buffer malloc failed.");
			return FALSE;
		}
		/* fill with 1010... for debugging */
		memset(devc->raw_sample_buf, 0x82, devc->limit_samples * 4);
	}

	num_ols_changrp = 0;
	for (i = 0x20; i > 0x02; i >>= 1) {
		if ((devc->flag_reg & i) == 0) {
			num_ols_changrp++;
		}
	}

	if (revents == G_IO_IN && devc->num_samples < devc->limit_samples) {
		if (serial_read_nonblocking(serial, &byte, 1) != 1)
			return FALSE;
		devc->cnt_bytes++;

		/* Ignore it if we've read enough. */
		if (devc->num_samples >= devc->limit_samples)
			return TRUE;

		devc->sample[devc->num_bytes++] = byte;
		sr_spew("Received byte 0x%.2x.", byte);
		if (devc->num_bytes == num_ols_changrp) {
			devc->cnt_samples++;
			devc->cnt_samples_rle++;
			/*
			 * Got a full sample. Convert from the OLS's little-endian
			 * sample to the local format.
			 */
			sample = devc->sample[0] | (devc->sample[1] << 8) \
					| (devc->sample[2] << 16) | (devc->sample[3] << 24);
			sr_dbg("Received sample 0x%.*x.", devc->num_bytes * 2, sample);
			if (devc->flag_reg & FLAG_RLE) {
				/*
				 * In RLE mode the high bit of the sample is the
				 * "count" flag, meaning this sample is the number
				 * of times the previous sample occurred.
				 */
				if (devc->sample[devc->num_bytes - 1] & 0x80) {
					/* Clear the high bit. */
					sample &= ~(0x80 << (devc->num_bytes - 1) * 8);
					devc->rle_count = sample;
					devc->cnt_samples_rle += devc->rle_count;
					sr_dbg("RLE count: %u.", devc->rle_count);
					devc->num_bytes = 0;
					return TRUE;
				}
			}
			devc->num_samples += devc->rle_count + 1;
			if (devc->num_samples > devc->limit_samples) {
				/* Save us from overrunning the buffer. */
				devc->rle_count -= devc->num_samples - devc->limit_samples;
				devc->num_samples = devc->limit_samples;
			}

			if (num_ols_changrp < 4) {
				/*
				 * Some channel groups may have been turned
				 * off, to speed up transfer between the
				 * hardware and the PC. Expand that here before
				 * submitting it over the session bus --
				 * whatever is listening on the bus will be
				 * expecting a full 32-bit sample, based on
				 * the number of channels.
				 */
				j = 0;
				memset(devc->tmp_sample, 0, 4);
				for (i = 0; i < 4; i++) {
					if (((devc->flag_reg >> 2) & (1 << i)) == 0) {
						/*
						 * This channel group was
						 * enabled, copy from received
						 * sample.
						 */
						devc->tmp_sample[i] = devc->sample[j++];
					} else if (devc->flag_reg & FLAG_DEMUX && (i > 2)) {
						/* group 2 & 3 get added to 0 & 1 */
						devc->tmp_sample[i - 2] = devc->sample[j++];
					}
				}
				memcpy(devc->sample, devc->tmp_sample, 4);
				sr_spew("Expanded sample: 0x%.8x.", sample);
			}

			/*
			 * the OLS sends its sample buffer backwards.
			 * store it in reverse order here, so we can dump
			 * this on the session bus later.
			 */
			offset = (devc->limit_samples - devc->num_samples) * 4;
			for (i = 0; i <= devc->rle_count; i++) {
				memcpy(devc->raw_sample_buf + offset + (i * 4),
				       devc->sample, 4);
			}
			memset(devc->sample, 0, 4);
			devc->num_bytes = 0;
			devc->rle_count = 0;
		}
	} else {
		/*
		 * This is the main loop telling us a timeout was reached, or
		 * we've acquired all the samples we asked for -- we're done.
		 * Send the (properly-ordered) buffer to the frontend.
		 */
		sr_dbg("Received %d bytes, %d samples, %d decompressed samples.",
				devc->cnt_bytes, devc->cnt_samples,
				devc->cnt_samples_rle);
		if (devc->trigger_at != -1) {
			/*
			 * A trigger was set up, so we need to tell the frontend
			 * about it.
			 */
			if (devc->trigger_at > 0) {
				/* There are pre-trigger samples, send those first. */
				packet.type = SR_DF_LOGIC;
				packet.payload = &logic;
				logic.length = devc->trigger_at * 4;
				logic.unitsize = 4;
				logic.data = devc->raw_sample_buf +
					(devc->limit_samples - devc->num_samples) * 4;
				sr_session_send(sdi, &packet);
			}

			/* Send the trigger. */
			packet.type = SR_DF_TRIGGER;
			sr_session_send(sdi, &packet);

			/* Send post-trigger samples. */
			packet.type = SR_DF_LOGIC;
			packet.payload = &logic;
			logic.length = (devc->num_samples * 4) - (devc->trigger_at * 4);
			logic.unitsize = 4;
			logic.data = devc->raw_sample_buf + devc->trigger_at * 4 +
				(devc->limit_samples - devc->num_samples) * 4;
			sr_session_send(sdi, &packet);
		} else {
			/* no trigger was used */
			packet.type = SR_DF_LOGIC;
			packet.payload = &logic;
			logic.length = devc->num_samples * 4;
			logic.unitsize = 4;
			logic.data = devc->raw_sample_buf +
				(devc->limit_samples - devc->num_samples) * 4;
			sr_session_send(sdi, &packet);
		}
		g_free(devc->raw_sample_buf);

		serial_flush(serial);
		abort_acquisition(sdi);
	}

	return TRUE;
}
Commit	Line	Data
0aba65da	1	/*
50985c20	2	* This file is part of the libsigrok project.
0aba65da	3	*
13d8e03c	4	* Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
0aba65da UH	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>
515ab088	21	#include "protocol.h"
0aba65da	22
0aba65da UH	23	SR_PRIV int send_shortcommand(struct sr_serial_dev_inst *serial,
	24	uint8_t command)
	25	{
	26	char buf[1];
	27
	28	sr_dbg("Sending cmd 0x%.2x.", command);
	29	buf[0] = command;
f4d3a4fb	30	if (serial_write_blocking(serial, buf, 1, serial_timeout(serial, 1)) != 1)
0aba65da UH	31	return SR_ERR;
0aba65da UH	32
bce75f94 UJ	33	if (serial_drain(serial) != 0)
	34	return SR_ERR;
	35
0aba65da UH	36	return SR_OK;
	37	}
	38
	39	SR_PRIV int send_longcommand(struct sr_serial_dev_inst *serial,
016e72f3	40	uint8_t command, uint8_t *data)
0aba65da UH	41	{
	42	char buf[5];
	43
016e72f3 BV	44	sr_dbg("Sending cmd 0x%.2x data 0x%.2x%.2x%.2x%.2x.", command,
016e72f3 BV	45	data[0], data[1], data[2], data[3]);
0aba65da	46	buf[0] = command;
016e72f3 BV	47	buf[1] = data[0];
	48	buf[2] = data[1];
	49	buf[3] = data[2];
	50	buf[4] = data[3];
f4d3a4fb	51	if (serial_write_blocking(serial, buf, 5, serial_timeout(serial, 1)) != 5)
0aba65da UH	52	return SR_ERR;
0aba65da UH	53
bce75f94 UJ	54	if (serial_drain(serial) != 0)
	55	return SR_ERR;
	56
0aba65da UH	57	return SR_OK;
	58	}
	59
244995a2 GGM	60	SR_PRIV int ols_send_reset(struct sr_serial_dev_inst *serial)
	61	{
	62	unsigned int i;
	63
	64	for (i = 0; i < 5; i++) {
	65	if (send_shortcommand(serial, CMD_RESET) != SR_OK)
	66	return SR_ERR;
	67	}
	68
	69	return SR_OK;
	70	}
	71
91fd0f72 BV	72	/* Configures the channel mask based on which channels are enabled. */
91fd0f72 BV	73	SR_PRIV void ols_channel_mask(const struct sr_dev_inst *sdi)
0aba65da UH	74	{
0aba65da UH	75	struct dev_context *devc;
91fd0f72	76	struct sr_channel *channel;
0aba65da	77	const GSList *l;
0aba65da UH	78
	79	devc = sdi->priv;
	80
ba7dd8bb	81	devc->channel_mask = 0;
91fd0f72 BV	82	for (l = sdi->channels; l; l = l->next) {
	83	channel = l->data;
	84	if (channel->enabled)
	85	devc->channel_mask \|= 1 << channel->index;
	86	}
	87	}
	88
	89	SR_PRIV int ols_convert_trigger(const struct sr_dev_inst *sdi)
	90	{
	91	struct dev_context *devc;
	92	struct sr_trigger *trigger;
	93	struct sr_trigger_stage *stage;
	94	struct sr_trigger_match *match;
	95	const GSList l, m;
	96	int i;
	97
	98	devc = sdi->priv;
	99
	100	devc->num_stages = 0;
0aba65da UH	101	for (i = 0; i < NUM_TRIGGER_STAGES; i++) {
	102	devc->trigger_mask[i] = 0;
	103	devc->trigger_value[i] = 0;
	104	}
	105
0812c40e	106	if (!(trigger = sr_session_trigger_get(sdi->session)))
91fd0f72	107	return SR_OK;
0aba65da	108
91fd0f72 BV	109	devc->num_stages = g_slist_length(trigger->stages);
	110	if (devc->num_stages > NUM_TRIGGER_STAGES) {
	111	sr_err("This device only supports %d trigger stages.",
	112	NUM_TRIGGER_STAGES);
	113	return SR_ERR;
	114	}
b1de0407	115
91fd0f72 BV	116	for (l = trigger->stages; l; l = l->next) {
	117	stage = l->data;
	118	for (m = stage->matches; m; m = m->next) {
	119	match = m->data;
	120	if (!match->channel->enabled)
	121	/* Ignore disabled channels with a trigger. */
	122	continue;
	123	devc->trigger_mask[stage->stage] \|= 1 << match->channel->index;
	124	if (match->match == SR_TRIGGER_ONE)
	125	devc->trigger_value[stage->stage] \|= 1 << match->channel->index;
0aba65da	126	}
0aba65da UH	127	}
	128
	129	return SR_OK;
	130	}
	131
0aba65da UH	132	SR_PRIV struct dev_context *ols_dev_new(void)
	133	{
	134	struct dev_context *devc;
	135
f57d8ffe	136	devc = g_malloc0(sizeof(struct dev_context));
0aba65da	137
bf256783 BV	138	/* Device-specific settings */
	139	devc->max_samples = devc->max_samplerate = devc->protocol_version = 0;
	140
	141	/* Acquisition settings */
	142	devc->limit_samples = devc->capture_ratio = 0;
0aba65da	143	devc->trigger_at = -1;
bf256783 BV	144	devc->flag_reg = 0;
bf256783 BV	145
0aba65da UH	146	return devc;
	147	}
	148
4a34a74d WS	149	static void ols_channel_new(struct sr_dev_inst *sdi, int num_chan)
	150	{
	151	int i;
	152
	153	for (i = 0; i < num_chan; i++)
	154	sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE,
	155	ols_channel_names[i]);
	156	}
	157
0aba65da UH	158	SR_PRIV struct sr_dev_inst get_metadata(struct sr_serial_dev_inst serial)
	159	{
	160	struct sr_dev_inst *sdi;
	161	struct dev_context *devc;
4a34a74d	162	uint32_t tmp_int;
0aba65da	163	uint8_t key, type, token;
f4d3a4fb	164	int delay_ms;
0aba65da UH	165	GString tmp_str, devname, *version;
	166	guchar tmp_c;
	167
aac29cc1	168	sdi = g_malloc0(sizeof(struct sr_dev_inst));
0af636be	169	sdi->status = SR_ST_INACTIVE;
0aba65da UH	170	devc = ols_dev_new();
	171	sdi->priv = devc;
	172
	173	devname = g_string_new("");
	174	version = g_string_new("");
	175
	176	key = 0xff;
	177	while (key) {
f4d3a4fb BV	178	delay_ms = serial_timeout(serial, 1);
f4d3a4fb BV	179	if (serial_read_blocking(serial, &key, 1, delay_ms) != 1)
0aba65da	180	break;
625763e2 BV	181	if (key == 0x00) {
	182	sr_dbg("Got metadata key 0x00, metadata ends.");
	183	break;
	184	}
0aba65da UH	185	type = key >> 5;
	186	token = key & 0x1f;
	187	switch (type) {
	188	case 0:
	189	/* NULL-terminated string */
	190	tmp_str = g_string_new("");
f4d3a4fb BV	191	delay_ms = serial_timeout(serial, 1);
f4d3a4fb BV	192	while (serial_read_blocking(serial, &tmp_c, 1, delay_ms) == 1 && tmp_c != '\0')
0aba65da UH	193	g_string_append_c(tmp_str, tmp_c);
	194	sr_dbg("Got metadata key 0x%.2x value '%s'.",
	195	key, tmp_str->str);
	196	switch (token) {
	197	case 0x01:
	198	/* Device name */
	199	devname = g_string_append(devname, tmp_str->str);
	200	break;
	201	case 0x02:
	202	/* FPGA firmware version */
	203	if (version->len)
	204	g_string_append(version, ", ");
	205	g_string_append(version, "FPGA version ");
	206	g_string_append(version, tmp_str->str);
	207	break;
	208	case 0x03:
	209	/* Ancillary version */
	210	if (version->len)
	211	g_string_append(version, ", ");
	212	g_string_append(version, "Ancillary version ");
	213	g_string_append(version, tmp_str->str);
	214	break;
	215	default:
	216	sr_info("ols: unknown token 0x%.2x: '%s'",
	217	token, tmp_str->str);
	218	break;
	219	}
	220	g_string_free(tmp_str, TRUE);
	221	break;
	222	case 1:
	223	/* 32-bit unsigned integer */
f4d3a4fb BV	224	delay_ms = serial_timeout(serial, 4);
f4d3a4fb BV	225	if (serial_read_blocking(serial, &tmp_int, 4, delay_ms) != 4)
0aba65da	226	break;
016e72f3	227	tmp_int = RB32(&tmp_int);
0aba65da UH	228	sr_dbg("Got metadata key 0x%.2x value 0x%.8x.",
	229	key, tmp_int);
	230	switch (token) {
	231	case 0x00:
ba7dd8bb	232	/* Number of usable channels */
4a34a74d	233	ols_channel_new(sdi, tmp_int);
0aba65da UH	234	break;
	235	case 0x01:
	236	/* Amount of sample memory available (bytes) */
	237	devc->max_samples = tmp_int;
	238	break;
	239	case 0x02:
	240	/* Amount of dynamic memory available (bytes) */
	241	/* what is this for? */
	242	break;
	243	case 0x03:
f3f19d11	244	/* Maximum sample rate (Hz) */
0aba65da UH	245	devc->max_samplerate = tmp_int;
	246	break;
	247	case 0x04:
	248	/* protocol version */
	249	devc->protocol_version = tmp_int;
	250	break;
	251	default:
	252	sr_info("Unknown token 0x%.2x: 0x%.8x.",
	253	token, tmp_int);
	254	break;
	255	}
	256	break;
	257	case 2:
	258	/* 8-bit unsigned integer */
f4d3a4fb BV	259	delay_ms = serial_timeout(serial, 1);
f4d3a4fb BV	260	if (serial_read_blocking(serial, &tmp_c, 1, delay_ms) != 1)
0aba65da UH	261	break;
	262	sr_dbg("Got metadata key 0x%.2x value 0x%.2x.",
	263	key, tmp_c);
	264	switch (token) {
	265	case 0x00:
ba7dd8bb	266	/* Number of usable channels */
4a34a74d	267	ols_channel_new(sdi, tmp_c);
0aba65da UH	268	break;
	269	case 0x01:
	270	/* protocol version */
	271	devc->protocol_version = tmp_c;
	272	break;
	273	default:
	274	sr_info("Unknown token 0x%.2x: 0x%.2x.",
	275	token, tmp_c);
	276	break;
	277	}
	278	break;
	279	default:
	280	/* unknown type */
	281	break;
	282	}
	283	}
	284
	285	sdi->model = devname->str;
	286	sdi->version = version->str;
	287	g_string_free(devname, FALSE);
	288	g_string_free(version, FALSE);
	289
	290	return sdi;
	291	}
	292
	293	SR_PRIV int ols_set_samplerate(const struct sr_dev_inst *sdi,
e46aa4f6	294	const uint64_t samplerate)
0aba65da UH	295	{
	296	struct dev_context *devc;
	297
	298	devc = sdi->priv;
e46aa4f6	299	if (devc->max_samplerate && samplerate > devc->max_samplerate)
0aba65da UH	300	return SR_ERR_SAMPLERATE;
	301
	302	if (samplerate > CLOCK_RATE) {
6ebe0039	303	sr_info("Enabling demux mode.");
0aba65da	304	devc->flag_reg \|= FLAG_DEMUX;
6ebe0039	305	devc->flag_reg &= ~FLAG_FILTER;
3f239f08	306	devc->max_channels = NUM_CHANNELS / 2;
0aba65da UH	307	devc->cur_samplerate_divider = (CLOCK_RATE * 2 / samplerate) - 1;
0aba65da UH	308	} else {
6ebe0039	309	sr_info("Disabling demux mode.");
0aba65da	310	devc->flag_reg &= ~FLAG_DEMUX;
6a53bde6	311	devc->flag_reg \|= FLAG_FILTER;
3f239f08	312	devc->max_channels = NUM_CHANNELS;
0aba65da UH	313	devc->cur_samplerate_divider = (CLOCK_RATE / samplerate) - 1;
	314	}
	315
	316	/* Calculate actual samplerate used and complain if it is different
	317	* from the requested.
	318	*/
	319	devc->cur_samplerate = CLOCK_RATE / (devc->cur_samplerate_divider + 1);
	320	if (devc->flag_reg & FLAG_DEMUX)
	321	devc->cur_samplerate *= 2;
	322	if (devc->cur_samplerate != samplerate)
e46aa4f6	323	sr_info("Can't match samplerate %" PRIu64 ", using %"
0aba65da UH	324	PRIu64 ".", samplerate, devc->cur_samplerate);
	325
	326	return SR_OK;
	327	}
	328
	329	SR_PRIV void abort_acquisition(const struct sr_dev_inst *sdi)
	330	{
459a0f26	331	struct sr_serial_dev_inst *serial;
0aba65da	332
459a0f26	333	serial = sdi->conn;
102f1239	334	serial_source_remove(sdi->session, serial);
0aba65da	335
bee2b016	336	std_session_send_df_end(sdi);
0aba65da UH	337	}
	338
	339	SR_PRIV int ols_receive_data(int fd, int revents, void *cb_data)
	340	{
459a0f26	341	struct dev_context *devc;
625763e2	342	struct sr_dev_inst *sdi;
459a0f26	343	struct sr_serial_dev_inst *serial;
0aba65da UH	344	struct sr_datafeed_packet packet;
0aba65da UH	345	struct sr_datafeed_logic logic;
fe9ac252	346	uint32_t sample;
91fd0f72	347	int num_ols_changrp, offset, j;
b1de0407	348	unsigned int i;
0aba65da	349	unsigned char byte;
625763e2 BV	350
	351	(void)fd;
	352
	353	sdi = cb_data;
	354	serial = sdi->conn;
	355	devc = sdi->priv;
0aba65da	356
8105e829 DE	357	if (devc->num_transfers == 0 && revents == 0) {
	358	/* Ignore timeouts as long as we haven't received anything */
	359	return TRUE;
	360	}
	361
0aba65da	362	if (devc->num_transfers++ == 0) {
0aba65da UH	363	devc->raw_sample_buf = g_try_malloc(devc->limit_samples * 4);
	364	if (!devc->raw_sample_buf) {
	365	sr_err("Sample buffer malloc failed.");
	366	return FALSE;
	367	}
	368	/* fill with 1010... for debugging */
	369	memset(devc->raw_sample_buf, 0x82, devc->limit_samples * 4);
	370	}
	371
91fd0f72	372	num_ols_changrp = 0;
be15c51e	373	for (i = 0x20; i > 0x02; i >>= 1) {
f51acd69	374	if ((devc->flag_reg & i) == 0) {
91fd0f72	375	num_ols_changrp++;
f51acd69	376	}
0aba65da UH	377	}
0aba65da UH	378
faf72024	379	if (revents == G_IO_IN && devc->num_samples < devc->limit_samples) {
9f5d4c3c	380	if (serial_read_nonblocking(serial, &byte, 1) != 1)
0aba65da	381	return FALSE;
625763e2	382	devc->cnt_bytes++;
0aba65da UH	383
	384	/* Ignore it if we've read enough. */
	385	if (devc->num_samples >= devc->limit_samples)
	386	return TRUE;
	387
	388	devc->sample[devc->num_bytes++] = byte;
6d16fdfb	389	sr_spew("Received byte 0x%.2x.", byte);
91fd0f72	390	if (devc->num_bytes == num_ols_changrp) {
625763e2 BV	391	devc->cnt_samples++;
	392	devc->cnt_samples_rle++;
	393	/*
	394	* Got a full sample. Convert from the OLS's little-endian
	395	* sample to the local format.
	396	*/
fe9ac252 BV	397	sample = devc->sample[0] \| (devc->sample[1] << 8) \
fe9ac252 BV	398	\| (devc->sample[2] << 16) \| (devc->sample[3] << 24);
625763e2	399	sr_dbg("Received sample 0x%.x.", devc->num_bytes 2, sample);
0aba65da UH	400	if (devc->flag_reg & FLAG_RLE) {
0aba65da UH	401	/*
00d04d3b BV	402	* In RLE mode the high bit of the sample is the
	403	* "count" flag, meaning this sample is the number
	404	* of times the previous sample occurred.
0aba65da UH	405	*/
0aba65da UH	406	if (devc->sample[devc->num_bytes - 1] & 0x80) {
00d04d3b BV	407	/* Clear the high bit. */
00d04d3b BV	408	sample &= ~(0x80 << (devc->num_bytes - 1) * 8);
fe9ac252	409	devc->rle_count = sample;
625763e2	410	devc->cnt_samples_rle += devc->rle_count;
00d04d3b	411	sr_dbg("RLE count: %u.", devc->rle_count);
0aba65da UH	412	devc->num_bytes = 0;
	413	return TRUE;
	414	}
	415	}
	416	devc->num_samples += devc->rle_count + 1;
	417	if (devc->num_samples > devc->limit_samples) {
	418	/* Save us from overrunning the buffer. */
	419	devc->rle_count -= devc->num_samples - devc->limit_samples;
	420	devc->num_samples = devc->limit_samples;
	421	}
	422
91fd0f72	423	if (num_ols_changrp < 4) {
0aba65da UH	424	/*
	425	* Some channel groups may have been turned
	426	* off, to speed up transfer between the
	427	* hardware and the PC. Expand that here before
	428	* submitting it over the session bus --
	429	* whatever is listening on the bus will be
	430	* expecting a full 32-bit sample, based on
ba7dd8bb	431	* the number of channels.
0aba65da UH	432	*/
	433	j = 0;
	434	memset(devc->tmp_sample, 0, 4);
	435	for (i = 0; i < 4; i++) {
	436	if (((devc->flag_reg >> 2) & (1 << i)) == 0) {
	437	/*
	438	* This channel group was
	439	* enabled, copy from received
	440	* sample.
	441	*/
	442	devc->tmp_sample[i] = devc->sample[j++];
f51acd69	443	} else if (devc->flag_reg & FLAG_DEMUX && (i > 2)) {
b1de0407	444	/* group 2 & 3 get added to 0 & 1 */
f51acd69	445	devc->tmp_sample[i - 2] = devc->sample[j++];
0aba65da UH	446	}
	447	}
	448	memcpy(devc->sample, devc->tmp_sample, 4);
625763e2	449	sr_spew("Expanded sample: 0x%.8x.", sample);
0aba65da UH	450	}
0aba65da UH	451
625763e2 BV	452	/*
625763e2 BV	453	* the OLS sends its sample buffer backwards.
0aba65da UH	454	* store it in reverse order here, so we can dump
	455	* this on the session bus later.
	456	*/
	457	offset = (devc->limit_samples - devc->num_samples) * 4;
	458	for (i = 0; i <= devc->rle_count; i++) {
	459	memcpy(devc->raw_sample_buf + offset + (i * 4),
	460	devc->sample, 4);
	461	}
	462	memset(devc->sample, 0, 4);
	463	devc->num_bytes = 0;
	464	devc->rle_count = 0;
	465	}
	466	} else {
	467	/*
	468	* This is the main loop telling us a timeout was reached, or
	469	* we've acquired all the samples we asked for -- we're done.
	470	* Send the (properly-ordered) buffer to the frontend.
	471	*/
625763e2 BV	472	sr_dbg("Received %d bytes, %d samples, %d decompressed samples.",
	473	devc->cnt_bytes, devc->cnt_samples,
	474	devc->cnt_samples_rle);
0aba65da	475	if (devc->trigger_at != -1) {
625763e2 BV	476	/*
625763e2 BV	477	* A trigger was set up, so we need to tell the frontend
0aba65da UH	478	* about it.
	479	*/
	480	if (devc->trigger_at > 0) {
625763e2	481	/* There are pre-trigger samples, send those first. */
0aba65da UH	482	packet.type = SR_DF_LOGIC;
	483	packet.payload = &logic;
	484	logic.length = devc->trigger_at * 4;
	485	logic.unitsize = 4;
	486	logic.data = devc->raw_sample_buf +
	487	(devc->limit_samples - devc->num_samples) * 4;
695dc859	488	sr_session_send(sdi, &packet);
0aba65da UH	489	}
0aba65da UH	490
625763e2	491	/* Send the trigger. */
0aba65da	492	packet.type = SR_DF_TRIGGER;
695dc859	493	sr_session_send(sdi, &packet);
0aba65da	494
625763e2	495	/* Send post-trigger samples. */
0aba65da UH	496	packet.type = SR_DF_LOGIC;
	497	packet.payload = &logic;
	498	logic.length = (devc->num_samples * 4) - (devc->trigger_at * 4);
	499	logic.unitsize = 4;
	500	logic.data = devc->raw_sample_buf + devc->trigger_at * 4 +
	501	(devc->limit_samples - devc->num_samples) * 4;
695dc859	502	sr_session_send(sdi, &packet);
0aba65da UH	503	} else {
	504	/* no trigger was used */
	505	packet.type = SR_DF_LOGIC;
	506	packet.payload = &logic;
	507	logic.length = devc->num_samples * 4;
	508	logic.unitsize = 4;
	509	logic.data = devc->raw_sample_buf +
	510	(devc->limit_samples - devc->num_samples) * 4;
695dc859	511	sr_session_send(sdi, &packet);
0aba65da UH	512	}
	513	g_free(devc->raw_sample_buf);
	514
459a0f26	515	serial_flush(serial);
0aba65da	516	abort_acquisition(sdi);
0aba65da UH	517	}
	518
	519	return TRUE;
	520	}