[libsigrok.git] / src / hardware / appa-55ii / protocol.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2013 Aurelien Jacobs <aurel@gnuage.org>
 *
 * 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 <string.h>
#include <math.h>
#include "protocol.h"

typedef enum {
    LIVE_DATA    = 0x00,
    LOG_METADATA = 0x11,
    LOG_DATA     = 0x14,
    LOG_START    = 0x18,
    LOG_END      = 0x19,
} packet_type;

static gboolean appa_55ii_checksum(const uint8_t *buf)
{
	int i, size, checksum;

	size = buf[3] + 4;
	checksum = 0;
	for (i = 0; i < size; i++)
		checksum += buf[i];

	return buf[size] == (checksum & 0xFF);
}

SR_PRIV gboolean appa_55ii_packet_valid(const uint8_t *buf)
{
	if (buf[0] == 0x55 && buf[1] == 0x55 && buf[3] <= 32
			&& appa_55ii_checksum(buf))
		return TRUE;

	return FALSE;
}

static uint64_t appa_55ii_flags(const uint8_t *buf)
{
	uint8_t disp_mode;
	uint64_t flags;

	disp_mode = buf[4 + 13];
	flags = 0;
	if ((disp_mode & 0xF0) == 0x20)
		flags |= SR_MQFLAG_HOLD;
	if ((disp_mode & 0x0C) == 0x04)
		flags |= SR_MQFLAG_MAX;
	if ((disp_mode & 0x0C) == 0x08)
		flags |= SR_MQFLAG_MIN;
	if ((disp_mode & 0x0C) == 0x0C)
		flags |= SR_MQFLAG_AVG;

	return flags;
}

static float appa_55ii_temp(const uint8_t *buf, int ch)
{
	const uint8_t *ptr;
	int16_t temp;
	uint8_t flags;

	ptr = buf + 4 + 14 + 3 * ch;
	temp = RL16(ptr);
	flags = ptr[2];

	if (flags & 0x60)
		return INFINITY;
	else if (flags & 1)
		return (float)temp / 10;
	else
		return (float)temp;
}

static void appa_55ii_live_data(struct sr_dev_inst *sdi, const uint8_t *buf)
{
	struct dev_context *devc;
	struct sr_datafeed_packet packet;
	struct sr_datafeed_analog analog;
	struct sr_channel *ch;
	float values[APPA_55II_NUM_CHANNELS], *val_ptr;
	int i;

	devc = sdi->priv;

	if (devc->data_source != DATA_SOURCE_LIVE)
		return;

	val_ptr = values;
	memset(&analog, 0, sizeof(struct sr_datafeed_analog));
	analog.num_samples = 1;
	analog.mq = SR_MQ_TEMPERATURE;
	analog.unit = SR_UNIT_CELSIUS;
	analog.mqflags = appa_55ii_flags(buf);
	analog.data = values;

	for (i = 0; i < APPA_55II_NUM_CHANNELS; i++) {
		ch = g_slist_nth_data(sdi->channels, i);
		if (!ch->enabled)
			continue;
		analog.channels = g_slist_append(analog.channels, ch);
		*val_ptr++ = appa_55ii_temp(buf, i);
	}

	packet.type = SR_DF_ANALOG;
	packet.payload = &analog;
	sr_session_send(devc->session_cb_data, &packet);
	g_slist_free(analog.channels);

	devc->num_samples++;
}

static void appa_55ii_log_metadata(struct sr_dev_inst *sdi, const uint8_t *buf)
{
	struct dev_context *devc;

	devc = sdi->priv;
	devc->num_log_records = (buf[5] << 8) + buf[4];
}

static void appa_55ii_log_data_parse(struct sr_dev_inst *sdi)
{
	struct dev_context *devc;
	struct sr_datafeed_packet packet;
	struct sr_datafeed_analog analog;
	struct sr_channel *ch;
	float values[APPA_55II_NUM_CHANNELS], *val_ptr;
	const uint8_t *buf;
	int16_t temp;
	int offset, i;

	devc = sdi->priv;
	offset = 0;

	while (devc->log_buf_len >= 20 && devc->num_log_records > 0) {
		buf = devc->log_buf + offset;
		val_ptr = values;

		/* FIXME: Timestamp should be sent in the packet. */
		sr_dbg("Timestamp: %02d:%02d:%02d", buf[2], buf[3], buf[4]);

		memset(&analog, 0, sizeof(struct sr_datafeed_analog));
		analog.num_samples = 1;
		analog.mq = SR_MQ_TEMPERATURE;
		analog.unit = SR_UNIT_CELSIUS;
		analog.data = values;

		for (i = 0; i < APPA_55II_NUM_CHANNELS; i++) {
			temp = RL16(buf + 12 + 2 * i);
			ch = g_slist_nth_data(sdi->channels, i);
			if (!ch->enabled)
				continue;
			analog.channels = g_slist_append(analog.channels, ch);
			*val_ptr++ = temp == 0x7FFF ? INFINITY : (float)temp / 10;
		}

		packet.type = SR_DF_ANALOG;
		packet.payload = &analog;
		sr_session_send(devc->session_cb_data, &packet);
		g_slist_free(analog.channels);

		devc->num_samples++;
		devc->log_buf_len -= 20;
		offset += 20;
		devc->num_log_records--;
	}

	memmove(devc->log_buf, devc->log_buf + offset, devc->log_buf_len);
}

static void appa_55ii_log_data(struct sr_dev_inst *sdi, const uint8_t *buf)
{
	struct dev_context *devc;
	const uint8_t *ptr;
	unsigned int size;
	int s;

	devc = sdi->priv;
	if (devc->data_source != DATA_SOURCE_MEMORY)
		return;

	ptr = buf + 4;
	size = buf[3];
	while (size > 0) {
		s = MIN(size, sizeof(devc->log_buf) - devc->log_buf_len);
		memcpy(devc->log_buf + devc->log_buf_len, ptr, s);
		devc->log_buf_len += s;
		size -= s;
		ptr += s;

		appa_55ii_log_data_parse(sdi);
	}
}

static void appa_55ii_log_end(struct sr_dev_inst *sdi)
{
	struct dev_context *devc;

	devc = sdi->priv;
	if (devc->data_source != DATA_SOURCE_MEMORY)
		return;

	sdi->driver->dev_acquisition_stop(sdi, devc->session_cb_data);
}

static const uint8_t *appa_55ii_parse_data(struct sr_dev_inst *sdi,
		const uint8_t *buf, int len)
{
	if (len < 5)
		/* Need more data. */
		return NULL;

	if (buf[0] != 0x55 || buf[1] != 0x55)
		/* Try to re-synchronize on a packet start. */
		return buf + 1;

	if (len < 5 + buf[3])
		/* Need more data. */
		return NULL;

	if (!appa_55ii_checksum(buf))
		/* Skip broken packet. */
		return buf + 4 + buf[3] + 1;

	switch ((packet_type)buf[2]) {
	case LIVE_DATA:
		appa_55ii_live_data(sdi, buf);
		break;
	case LOG_METADATA:
		appa_55ii_log_metadata(sdi, buf);
		break;
	case LOG_DATA:
		appa_55ii_log_data(sdi, buf);
		break;
	case LOG_START:
		break;
	case LOG_END:
		appa_55ii_log_end(sdi);
		break;
	default:
		sr_warn("Invalid packet type: 0x%02x.", buf[2]);
		break;
	}

	return buf + 4 + buf[3] + 1;
}

SR_PRIV int appa_55ii_receive_data(int fd, int revents, void *cb_data)
{
	struct sr_dev_inst *sdi;
	struct dev_context *devc;
	struct sr_serial_dev_inst *serial;
	int64_t time;
	const uint8_t *ptr, *next_ptr, *end_ptr;
	int len;

	(void)fd;

	if (!(sdi = cb_data) || !(devc = sdi->priv) || revents != G_IO_IN)
		return TRUE;
	serial = sdi->conn;

	/* Try to get as much data as the buffer can hold. */
	len = sizeof(devc->buf) - devc->buf_len;
	len = serial_read_nonblocking(serial, devc->buf + devc->buf_len, len);
	if (len < 1) {
		sr_err("Serial port read error: %d.", len);
		return FALSE;
	}
	devc->buf_len += len;

	/* Now look for packets in that data. */
	ptr = devc->buf;
	end_ptr = ptr + devc->buf_len;
	while ((next_ptr = appa_55ii_parse_data(sdi, ptr, end_ptr - ptr)))
		ptr = next_ptr;

	/* If we have any data left, move it to the beginning of our buffer. */
	memmove(devc->buf, ptr, end_ptr - ptr);
	devc->buf_len -= ptr - devc->buf;

	/* If buffer is full and no valid packet was found, wipe buffer. */
	if (devc->buf_len >= sizeof(devc->buf)) {
		devc->buf_len = 0;
		return FALSE;
	}

	if (devc->limit_samples && devc->num_samples >= devc->limit_samples) {
		sr_info("Requested number of samples reached.");
		sdi->driver->dev_acquisition_stop(sdi, devc->session_cb_data);
		return TRUE;
	}

	if (devc->limit_msec) {
		time = (g_get_monotonic_time() - devc->start_time) / 1000;
		if (time > (int64_t)devc->limit_msec) {
			sr_info("Requested time limit reached.");
			sdi->driver->dev_acquisition_stop(sdi,
					devc->session_cb_data);
			return TRUE;
		}
	}

	return TRUE;
}
Commit	Line	Data
5e7a8e57 AJ	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2013 Aurelien Jacobs <aurel@gnuage.org>
	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>
81a9ab72 AJ	21	#include <string.h>
81a9ab72 AJ	22	#include <math.h>
5e7a8e57 AJ	23	#include "protocol.h"
5e7a8e57 AJ	24
81a9ab72 AJ	25	typedef enum {
	26	LIVE_DATA = 0x00,
	27	LOG_METADATA = 0x11,
	28	LOG_DATA = 0x14,
	29	LOG_START = 0x18,
	30	LOG_END = 0x19,
9ee78f23	31	} packet_type;
81a9ab72 AJ	32
	33	static gboolean appa_55ii_checksum(const uint8_t *buf)
	34	{
7574e58c BV	35	int i, size, checksum;
	36
	37	size = buf[3] + 4;
	38	checksum = 0;
	39	for (i = 0; i < size; i++)
81a9ab72	40	checksum += buf[i];
7574e58c	41
81a9ab72 AJ	42	return buf[size] == (checksum & 0xFF);
	43	}
	44
	45	SR_PRIV gboolean appa_55ii_packet_valid(const uint8_t *buf)
	46	{
	47	if (buf[0] == 0x55 && buf[1] == 0x55 && buf[3] <= 32
7574e58c	48	&& appa_55ii_checksum(buf))
81a9ab72	49	return TRUE;
7574e58c	50
81a9ab72 AJ	51	return FALSE;
	52	}
	53
	54	static uint64_t appa_55ii_flags(const uint8_t *buf)
	55	{
7574e58c BV	56	uint8_t disp_mode;
	57	uint64_t flags;
	58
	59	disp_mode = buf[4 + 13];
	60	flags = 0;
	61	if ((disp_mode & 0xF0) == 0x20)
	62	flags \|= SR_MQFLAG_HOLD;
	63	if ((disp_mode & 0x0C) == 0x04)
	64	flags \|= SR_MQFLAG_MAX;
	65	if ((disp_mode & 0x0C) == 0x08)
	66	flags \|= SR_MQFLAG_MIN;
	67	if ((disp_mode & 0x0C) == 0x0C)
	68	flags \|= SR_MQFLAG_AVG;
81a9ab72 AJ	69
	70	return flags;
	71	}
	72
ba7dd8bb	73	static float appa_55ii_temp(const uint8_t *buf, int ch)
81a9ab72	74	{
7574e58c BV	75	const uint8_t *ptr;
	76	int16_t temp;
	77	uint8_t flags;
	78
ba7dd8bb	79	ptr = buf + 4 + 14 + 3 * ch;
7574e58c BV	80	temp = RL16(ptr);
	81	flags = ptr[2];
	82
	83	if (flags & 0x60)
	84	return INFINITY;
	85	else if (flags & 1)
	86	return (float)temp / 10;
	87	else
	88	return (float)temp;
81a9ab72 AJ	89	}
	90
	91	static void appa_55ii_live_data(struct sr_dev_inst sdi, const uint8_t buf)
	92	{
76b4d4f4	93	struct dev_context *devc;
81a9ab72	94	struct sr_datafeed_packet packet;
7574e58c	95	struct sr_datafeed_analog analog;
ba7dd8bb	96	struct sr_channel *ch;
3f239f08	97	float values[APPA_55II_NUM_CHANNELS], *val_ptr;
81a9ab72 AJ	98	int i;
81a9ab72 AJ	99
76b4d4f4 UH	100	devc = sdi->priv;
76b4d4f4 UH	101
81a9ab72 AJ	102	if (devc->data_source != DATA_SOURCE_LIVE)
	103	return;
	104
7574e58c	105	val_ptr = values;
d0148a50	106	memset(&analog, 0, sizeof(struct sr_datafeed_analog));
81a9ab72 AJ	107	analog.num_samples = 1;
	108	analog.mq = SR_MQ_TEMPERATURE;
	109	analog.unit = SR_UNIT_CELSIUS;
	110	analog.mqflags = appa_55ii_flags(buf);
	111	analog.data = values;
	112
3f239f08	113	for (i = 0; i < APPA_55II_NUM_CHANNELS; i++) {
ba7dd8bb UH	114	ch = g_slist_nth_data(sdi->channels, i);
ba7dd8bb UH	115	if (!ch->enabled)
81a9ab72	116	continue;
ba7dd8bb	117	analog.channels = g_slist_append(analog.channels, ch);
81a9ab72 AJ	118	*val_ptr++ = appa_55ii_temp(buf, i);
	119	}
	120
	121	packet.type = SR_DF_ANALOG;
	122	packet.payload = &analog;
	123	sr_session_send(devc->session_cb_data, &packet);
ba7dd8bb	124	g_slist_free(analog.channels);
81a9ab72 AJ	125
	126	devc->num_samples++;
	127	}
	128
	129	static void appa_55ii_log_metadata(struct sr_dev_inst sdi, const uint8_t buf)
	130	{
7574e58c BV	131	struct dev_context *devc;
	132
	133	devc = sdi->priv;
81a9ab72 AJ	134	devc->num_log_records = (buf[5] << 8) + buf[4];
	135	}
	136
	137	static void appa_55ii_log_data_parse(struct sr_dev_inst *sdi)
	138	{
7574e58c BV	139	struct dev_context *devc;
7574e58c BV	140	struct sr_datafeed_packet packet;
76b4d4f4	141	struct sr_datafeed_analog analog;
ba7dd8bb	142	struct sr_channel *ch;
3f239f08	143	float values[APPA_55II_NUM_CHANNELS], *val_ptr;
7574e58c BV	144	const uint8_t *buf;
	145	int16_t temp;
	146	int offset, i;
	147
	148	devc = sdi->priv;
	149	offset = 0;
81a9ab72 AJ	150
81a9ab72 AJ	151	while (devc->log_buf_len >= 20 && devc->num_log_records > 0) {
7574e58c BV	152	buf = devc->log_buf + offset;
7574e58c BV	153	val_ptr = values;
81a9ab72	154
76b4d4f4	155	/* FIXME: Timestamp should be sent in the packet. */
81a9ab72 AJ	156	sr_dbg("Timestamp: %02d:%02d:%02d", buf[2], buf[3], buf[4]);
81a9ab72 AJ	157
d0148a50	158	memset(&analog, 0, sizeof(struct sr_datafeed_analog));
81a9ab72 AJ	159	analog.num_samples = 1;
	160	analog.mq = SR_MQ_TEMPERATURE;
	161	analog.unit = SR_UNIT_CELSIUS;
	162	analog.data = values;
	163
3f239f08	164	for (i = 0; i < APPA_55II_NUM_CHANNELS; i++) {
7574e58c	165	temp = RL16(buf + 12 + 2 * i);
ba7dd8bb UH	166	ch = g_slist_nth_data(sdi->channels, i);
ba7dd8bb UH	167	if (!ch->enabled)
81a9ab72	168	continue;
ba7dd8bb	169	analog.channels = g_slist_append(analog.channels, ch);
81a9ab72 AJ	170	*val_ptr++ = temp == 0x7FFF ? INFINITY : (float)temp / 10;
	171	}
	172
	173	packet.type = SR_DF_ANALOG;
	174	packet.payload = &analog;
	175	sr_session_send(devc->session_cb_data, &packet);
ba7dd8bb	176	g_slist_free(analog.channels);
81a9ab72 AJ	177
	178	devc->num_samples++;
	179	devc->log_buf_len -= 20;
	180	offset += 20;
	181	devc->num_log_records--;
	182	}
	183
	184	memmove(devc->log_buf, devc->log_buf + offset, devc->log_buf_len);
	185	}
	186
	187	static void appa_55ii_log_data(struct sr_dev_inst sdi, const uint8_t buf)
	188	{
7574e58c BV	189	struct dev_context *devc;
	190	const uint8_t *ptr;
	191	unsigned int size;
	192	int s;
81a9ab72	193
7574e58c	194	devc = sdi->priv;
81a9ab72 AJ	195	if (devc->data_source != DATA_SOURCE_MEMORY)
	196	return;
	197
76b4d4f4	198	ptr = buf + 4;
7574e58c	199	size = buf[3];
81a9ab72	200	while (size > 0) {
7574e58c	201	s = MIN(size, sizeof(devc->log_buf) - devc->log_buf_len);
81a9ab72 AJ	202	memcpy(devc->log_buf + devc->log_buf_len, ptr, s);
	203	devc->log_buf_len += s;
	204	size -= s;
	205	ptr += s;
	206
	207	appa_55ii_log_data_parse(sdi);
	208	}
	209	}
	210
	211	static void appa_55ii_log_end(struct sr_dev_inst *sdi)
	212	{
7574e58c	213	struct dev_context *devc;
81a9ab72	214
7574e58c	215	devc = sdi->priv;
81a9ab72 AJ	216	if (devc->data_source != DATA_SOURCE_MEMORY)
	217	return;
	218
	219	sdi->driver->dev_acquisition_stop(sdi, devc->session_cb_data);
	220	}
	221
	222	static const uint8_t appa_55ii_parse_data(struct sr_dev_inst sdi,
7574e58c	223	const uint8_t *buf, int len)
81a9ab72 AJ	224	{
81a9ab72 AJ	225	if (len < 5)
7574e58c BV	226	/* Need more data. */
7574e58c BV	227	return NULL;
81a9ab72 AJ	228
81a9ab72 AJ	229	if (buf[0] != 0x55 \|\| buf[1] != 0x55)
7574e58c BV	230	/* Try to re-synchronize on a packet start. */
7574e58c BV	231	return buf + 1;
81a9ab72	232
7574e58c BV	233	if (len < 5 + buf[3])
	234	/* Need more data. */
	235	return NULL;
81a9ab72 AJ	236
81a9ab72 AJ	237	if (!appa_55ii_checksum(buf))
7574e58c BV	238	/* Skip broken packet. */
7574e58c BV	239	return buf + 4 + buf[3] + 1;
81a9ab72	240
9ee78f23	241	switch ((packet_type)buf[2]) {
7574e58c BV	242	case LIVE_DATA:
	243	appa_55ii_live_data(sdi, buf);
	244	break;
	245	case LOG_METADATA:
	246	appa_55ii_log_metadata(sdi, buf);
	247	break;
	248	case LOG_DATA:
	249	appa_55ii_log_data(sdi, buf);
	250	break;
	251	case LOG_START:
	252	break;
	253	case LOG_END:
	254	appa_55ii_log_end(sdi);
	255	break;
76b4d4f4 UH	256	default:
	257	sr_warn("Invalid packet type: 0x%02x.", buf[2]);
	258	break;
81a9ab72 AJ	259	}
	260
	261	return buf + 4 + buf[3] + 1;
	262	}
	263
5e7a8e57 AJ	264	SR_PRIV int appa_55ii_receive_data(int fd, int revents, void *cb_data)
5e7a8e57 AJ	265	{
81a9ab72	266	struct sr_dev_inst *sdi;
5e7a8e57	267	struct dev_context *devc;
81a9ab72	268	struct sr_serial_dev_inst *serial;
7574e58c	269	int64_t time;
81a9ab72 AJ	270	const uint8_t ptr, next_ptr, *end_ptr;
81a9ab72 AJ	271	int len;
5e7a8e57 AJ	272
	273	(void)fd;
	274
81a9ab72	275	if (!(sdi = cb_data) \|\| !(devc = sdi->priv) \|\| revents != G_IO_IN)
5e7a8e57	276	return TRUE;
81a9ab72 AJ	277	serial = sdi->conn;
	278
	279	/* Try to get as much data as the buffer can hold. */
	280	len = sizeof(devc->buf) - devc->buf_len;
25dd0831	281	len = serial_read_nonblocking(serial, devc->buf + devc->buf_len, len);
81a9ab72 AJ	282	if (len < 1) {
	283	sr_err("Serial port read error: %d.", len);
	284	return FALSE;
	285	}
	286	devc->buf_len += len;
	287
	288	/* Now look for packets in that data. */
	289	ptr = devc->buf;
	290	end_ptr = ptr + devc->buf_len;
	291	while ((next_ptr = appa_55ii_parse_data(sdi, ptr, end_ptr - ptr)))
	292	ptr = next_ptr;
5e7a8e57	293
81a9ab72 AJ	294	/* If we have any data left, move it to the beginning of our buffer. */
	295	memmove(devc->buf, ptr, end_ptr - ptr);
	296	devc->buf_len -= ptr - devc->buf;
	297
	298	/* If buffer is full and no valid packet was found, wipe buffer. */
	299	if (devc->buf_len >= sizeof(devc->buf)) {
	300	devc->buf_len = 0;
	301	return FALSE;
	302	}
	303
	304	if (devc->limit_samples && devc->num_samples >= devc->limit_samples) {
	305	sr_info("Requested number of samples reached.");
	306	sdi->driver->dev_acquisition_stop(sdi, devc->session_cb_data);
5e7a8e57	307	return TRUE;
81a9ab72	308	}
5e7a8e57	309
81a9ab72	310	if (devc->limit_msec) {
7574e58c	311	time = (g_get_monotonic_time() - devc->start_time) / 1000;
81a9ab72 AJ	312	if (time > (int64_t)devc->limit_msec) {
81a9ab72 AJ	313	sr_info("Requested time limit reached.");
76b4d4f4 UH	314	sdi->driver->dev_acquisition_stop(sdi,
76b4d4f4 UH	315	devc->session_cb_data);
81a9ab72 AJ	316	return TRUE;
81a9ab72 AJ	317	}
5e7a8e57 AJ	318	}
	319
	320	return TRUE;
	321	}