[libsigrok.git] / src / hardware / center-3xx / protocol.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2013 Uwe Hermann <uwe@hermann-uwe.de>
 *
 * 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 2 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"

#define NUM_CHANNELS 4

struct center_info {
	float temp[NUM_CHANNELS];
	int digits[NUM_CHANNELS];
	gboolean rec, std, max, min, maxmin, t1t2, rel, hold, lowbat, celsius;
	gboolean memfull, autooff;
	gboolean mode_std, mode_rel, mode_max, mode_min, mode_maxmin;
};

static int center_send(struct sr_serial_dev_inst *serial, const char *cmd)
{
	int ret;

	if ((ret = serial_write_blocking(serial, cmd, strlen(cmd),
			serial_timeout(serial, strlen(cmd)))) < 0) {
		sr_err("Error sending '%s' command: %d.", cmd, ret);
		return SR_ERR;
	}

	return SR_OK;
}

SR_PRIV gboolean center_3xx_packet_valid(const uint8_t *buf)
{
	return (buf[0] == 0x02 && buf[44] == 0x03);
}

static void log_packet(const uint8_t *buf, int idx)
{
	int i;
	GString *s;

	s = g_string_sized_new(100);
	g_string_printf(s, "Packet: ");
	for (i = 0; i < center_devs[idx].packet_size; i++)
	        g_string_append_printf(s, "%02x ", buf[i]);
	sr_spew("%s", s->str);
	g_string_free(s, TRUE);
}

static int packet_parse(const uint8_t *buf, int idx, struct center_info *info)
{
	int i;
	uint16_t temp_u16;

	log_packet(buf, idx);

	/* Byte 0: Always 0x02. */

	/* Byte 1: Various status bits. */
	info->rec         = (buf[1] & (1 << 0)) != 0;
	info->mode_std    = (((buf[1] >> 1) & 0x3) == 0);
	info->mode_max    = (((buf[1] >> 1) & 0x3) == 1);
	info->mode_min    = (((buf[1] >> 1) & 0x3) == 2);
	info->mode_maxmin = (((buf[1] >> 1) & 0x3) == 3);
	/* TODO: Rel. Not available on all models. */
	info->t1t2        = (buf[1] & (1 << 3)) != 0;
	info->rel         = (buf[1] & (1 << 4)) != 0;
	info->hold        = (buf[1] & (1 << 5)) != 0;
	info->lowbat      = (buf[1] & (1 << 6)) != 0;
	info->celsius     = (buf[1] & (1 << 7)) != 0;

	/* Byte 2: Further status bits. */
	info->memfull     = (buf[2] & (1 << 0)) != 0;
	info->autooff     = (buf[2] & (1 << 7)) != 0;

	/* Byte 7+8/9+10/11+12/13+14: channel T1/T2/T3/T4 temperature. */
	for (i = 0; i < NUM_CHANNELS; i++) {
		temp_u16 = buf[8 + (i * 2)];
		temp_u16 |= ((uint16_t)buf[7 + (i * 2)] << 8);
		info->temp[i] = (float)temp_u16;
	}

	/* Byte 43: Specifies whether we need to divide the value(s) by 10. */
	for (i = 0; i < NUM_CHANNELS; i++) {
		/* Bit = 0: Divide by 10. Bit = 1: Don't divide by 10. */
		if ((buf[43] & (1 << i)) == 0) {
			info->temp[i] /= 10;
			info->digits[i] = 1;
		} else {
			info->digits[i] = 0;
		}
	}

	/* Bytes 39-42: Overflow/overlimit bits, depending on mode. */
	for (i = 0; i < NUM_CHANNELS; i++) {
		if (info->mode_std && ((buf[39] & (1 << i)) != 0))
			info->temp[i] = INFINITY;
		/* TODO: Rel. Not available on all models. */
		// if (info->mode_rel && ((buf[40] & (1 << i)) != 0))
		// 	info->temp[i] = INFINITY;
		if (info->mode_max && ((buf[41] & (1 << i)) != 0))
			info->temp[i] = INFINITY;
		if (info->mode_min && ((buf[42] & (1 << i)) != 0))
			info->temp[i] = INFINITY;
		/* TODO: Minmax? */
	}

	/* Byte 44: Always 0x03. */

	return SR_OK;
}

static int handle_packet(const uint8_t *buf, struct sr_dev_inst *sdi, int idx)
{
	struct sr_datafeed_packet packet;
	struct sr_datafeed_analog analog;
	struct sr_analog_encoding encoding;
	struct sr_analog_meaning meaning;
	struct sr_analog_spec spec;
	struct dev_context *devc;
	struct center_info info;
	GSList *l;
	int i, ret;

	devc = sdi->priv;

	/* Note: digits/spec_digits will be overridden later. */
	sr_analog_init(&analog, &encoding, &meaning, &spec, 0);
	memset(&info, 0, sizeof(struct center_info));

	ret = packet_parse(buf, idx, &info);
	if (ret < 0) {
		sr_err("Failed to parse packet.");
		return SR_ERR;
	}

	/* Common values for all 4 channels. */
	packet.type = SR_DF_ANALOG;
	packet.payload = &analog;
	analog.meaning->mq = SR_MQ_TEMPERATURE;
	analog.meaning->unit = (info.celsius) ? SR_UNIT_CELSIUS : SR_UNIT_FAHRENHEIT;
	analog.num_samples = 1;

	/* Send the values for T1 - T4. */
	for (i = 0; i < NUM_CHANNELS; i++) {
		l = NULL;
		l = g_slist_append(l, g_slist_nth_data(sdi->channels, i));
		analog.meaning->channels = l;
		analog.encoding->digits = info.digits[i];
		analog.spec->spec_digits = info.digits[i];
		analog.data = &(info.temp[i]);
		sr_session_send(sdi, &packet);
		g_slist_free(l);
	}

	sr_sw_limits_update_samples_read(&devc->sw_limits, 1);

	return SR_OK;
}

/* Return TRUE if a full packet was parsed, FALSE otherwise. */
static gboolean handle_new_data(struct sr_dev_inst *sdi, int idx)
{
	struct dev_context *devc;
	struct sr_serial_dev_inst *serial;
	int len, i, offset = 0, ret = FALSE;

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

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

	devc->buflen += len;

	/* Now look for packets in that data. */
	while ((devc->buflen - offset) >= center_devs[idx].packet_size) {
		if (center_devs[idx].packet_valid(devc->buf + offset)) {
			handle_packet(devc->buf + offset, sdi, idx);
			offset += center_devs[idx].packet_size;
			ret = TRUE;
		} else {
			offset++;
		}
	}

	/* If we have any data left, move it to the beginning of our buffer. */
	for (i = 0; i < devc->buflen - offset; i++)
		devc->buf[i] = devc->buf[offset + i];
	devc->buflen -= offset;

	return ret;
}

static int receive_data(int fd, int revents, int idx, void *cb_data)
{
	struct sr_dev_inst *sdi;
	struct dev_context *devc;
	static gboolean request_new_packet = TRUE;
	struct sr_serial_dev_inst *serial;

	(void)fd;

	if (!(sdi = cb_data))
		return TRUE;

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

	serial = sdi->conn;

	if (revents == G_IO_IN) {
		/* New data arrived. */
		request_new_packet = handle_new_data(sdi, idx);
	} else {
		/*
		 * Timeout. Send "A" to request a packet, but then don't send
		 * further "A" commands until we received a full packet first.
		 */
		if (request_new_packet) {
			center_send(serial, "A");
			request_new_packet = FALSE;
		}
	}

	if (sr_sw_limits_check(&devc->sw_limits))
		sr_dev_acquisition_stop(sdi);

	return TRUE;
}

#define RECEIVE_DATA(ID_UPPER) \
SR_PRIV int receive_data_##ID_UPPER(int fd, int revents, void *cb_data) { \
	return receive_data(fd, revents, ID_UPPER, cb_data); }

/* Driver-specific receive_data() wrappers */
RECEIVE_DATA(CENTER_309)
RECEIVE_DATA(VOLTCRAFT_K204)
Commit	Line	Data
4433145f UH	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2013 Uwe Hermann <uwe@hermann-uwe.de>
	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 2 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
2ea1fdf1	17	* along with this program; if not, see <http://www.gnu.org/licenses/>.
4433145f UH	18	*/
4433145f UH	19
6ec6c43b	20	#include <config.h>
4433145f UH	21	#include "protocol.h"
4433145f UH	22
07ffa5b3 UH	23	#define NUM_CHANNELS 4
07ffa5b3 UH	24
4a8bbed7	25	struct center_info {
07ffa5b3	26	float temp[NUM_CHANNELS];
0a2ffa3e	27	int digits[NUM_CHANNELS];
4a8bbed7 UH	28	gboolean rec, std, max, min, maxmin, t1t2, rel, hold, lowbat, celsius;
	29	gboolean memfull, autooff;
	30	gboolean mode_std, mode_rel, mode_max, mode_min, mode_maxmin;
	31	};
	32
	33	static int center_send(struct sr_serial_dev_inst serial, const char cmd)
4433145f	34	{
4a8bbed7 UH	35	int ret;
4a8bbed7 UH	36
84d328ac UH	37	if ((ret = serial_write_blocking(serial, cmd, strlen(cmd),
84d328ac UH	38	serial_timeout(serial, strlen(cmd)))) < 0) {
4a8bbed7 UH	39	sr_err("Error sending '%s' command: %d.", cmd, ret);
	40	return SR_ERR;
	41	}
	42
	43	return SR_OK;
	44	}
	45
	46	SR_PRIV gboolean center_3xx_packet_valid(const uint8_t *buf)
	47	{
	48	return (buf[0] == 0x02 && buf[44] == 0x03);
	49	}
	50
	51	static void log_packet(const uint8_t *buf, int idx)
	52	{
	53	int i;
	54	GString *s;
	55
	56	s = g_string_sized_new(100);
	57	g_string_printf(s, "Packet: ");
	58	for (i = 0; i < center_devs[idx].packet_size; i++)
	59	g_string_append_printf(s, "%02x ", buf[i]);
	60	sr_spew("%s", s->str);
	61	g_string_free(s, TRUE);
	62	}
	63
	64	static int packet_parse(const uint8_t buf, int idx, struct center_info info)
	65	{
	66	int i;
	67	uint16_t temp_u16;
	68
	69	log_packet(buf, idx);
	70
	71	/* Byte 0: Always 0x02. */
	72
	73	/* Byte 1: Various status bits. */
	74	info->rec = (buf[1] & (1 << 0)) != 0;
	75	info->mode_std = (((buf[1] >> 1) & 0x3) == 0);
	76	info->mode_max = (((buf[1] >> 1) & 0x3) == 1);
	77	info->mode_min = (((buf[1] >> 1) & 0x3) == 2);
	78	info->mode_maxmin = (((buf[1] >> 1) & 0x3) == 3);
	79	/* TODO: Rel. Not available on all models. */
	80	info->t1t2 = (buf[1] & (1 << 3)) != 0;
	81	info->rel = (buf[1] & (1 << 4)) != 0;
	82	info->hold = (buf[1] & (1 << 5)) != 0;
	83	info->lowbat = (buf[1] & (1 << 6)) != 0;
	84	info->celsius = (buf[1] & (1 << 7)) != 0;
	85
	86	/* Byte 2: Further status bits. */
	87	info->memfull = (buf[2] & (1 << 0)) != 0;
	88	info->autooff = (buf[2] & (1 << 7)) != 0;
	89
	90	/* Byte 7+8/9+10/11+12/13+14: channel T1/T2/T3/T4 temperature. */
07ffa5b3	91	for (i = 0; i < NUM_CHANNELS; i++) {
4a8bbed7 UH	92	temp_u16 = buf[8 + (i * 2)];
	93	temp_u16 \|= ((uint16_t)buf[7 + (i * 2)] << 8);
	94	info->temp[i] = (float)temp_u16;
	95	}
	96
	97	/* Byte 43: Specifies whether we need to divide the value(s) by 10. */
07ffa5b3	98	for (i = 0; i < NUM_CHANNELS; i++) {
4a8bbed7	99	/* Bit = 0: Divide by 10. Bit = 1: Don't divide by 10. */
0a2ffa3e	100	if ((buf[43] & (1 << i)) == 0) {
4a8bbed7	101	info->temp[i] /= 10;
0a2ffa3e AJ	102	info->digits[i] = 1;
	103	} else {
	104	info->digits[i] = 0;
	105	}
4a8bbed7 UH	106	}
	107
	108	/* Bytes 39-42: Overflow/overlimit bits, depending on mode. */
07ffa5b3	109	for (i = 0; i < NUM_CHANNELS; i++) {
4a8bbed7 UH	110	if (info->mode_std && ((buf[39] & (1 << i)) != 0))
	111	info->temp[i] = INFINITY;
	112	/* TODO: Rel. Not available on all models. */
	113	// if (info->mode_rel && ((buf[40] & (1 << i)) != 0))
	114	// info->temp[i] = INFINITY;
	115	if (info->mode_max && ((buf[41] & (1 << i)) != 0))
	116	info->temp[i] = INFINITY;
	117	if (info->mode_min && ((buf[42] & (1 << i)) != 0))
	118	info->temp[i] = INFINITY;
	119	/* TODO: Minmax? */
	120	}
	121
	122	/* Byte 44: Always 0x03. */
	123
	124	return SR_OK;
	125	}
	126
	127	static int handle_packet(const uint8_t buf, struct sr_dev_inst sdi, int idx)
	128	{
	129	struct sr_datafeed_packet packet;
d4f59ce8 UH	130	struct sr_datafeed_analog analog;
	131	struct sr_analog_encoding encoding;
	132	struct sr_analog_meaning meaning;
	133	struct sr_analog_spec spec;
4a8bbed7 UH	134	struct dev_context *devc;
	135	struct center_info info;
	136	GSList *l;
	137	int i, ret;
	138
	139	devc = sdi->priv;
4433145f	140
869c8375	141	/* Note: digits/spec_digits will be overridden later. */
d4f59ce8	142	sr_analog_init(&analog, &encoding, &meaning, &spec, 0);
4a8bbed7 UH	143	memset(&info, 0, sizeof(struct center_info));
	144
	145	ret = packet_parse(buf, idx, &info);
	146	if (ret < 0) {
	147	sr_err("Failed to parse packet.");
	148	return SR_ERR;
	149	}
	150
ba7dd8bb	151	/* Common values for all 4 channels. */
d4f59ce8	152	packet.type = SR_DF_ANALOG;
4a8bbed7	153	packet.payload = &analog;
d4f59ce8 UH	154	analog.meaning->mq = SR_MQ_TEMPERATURE;
d4f59ce8 UH	155	analog.meaning->unit = (info.celsius) ? SR_UNIT_CELSIUS : SR_UNIT_FAHRENHEIT;
4a8bbed7 UH	156	analog.num_samples = 1;
	157
	158	/* Send the values for T1 - T4. */
07ffa5b3	159	for (i = 0; i < NUM_CHANNELS; i++) {
4a8bbed7	160	l = NULL;
ba7dd8bb	161	l = g_slist_append(l, g_slist_nth_data(sdi->channels, i));
d4f59ce8	162	analog.meaning->channels = l;
0a2ffa3e AJ	163	analog.encoding->digits = info.digits[i];
0a2ffa3e AJ	164	analog.spec->spec_digits = info.digits[i];
4a8bbed7	165	analog.data = &(info.temp[i]);
695dc859	166	sr_session_send(sdi, &packet);
4a8bbed7 UH	167	g_slist_free(l);
	168	}
	169
838f6906	170	sr_sw_limits_update_samples_read(&devc->sw_limits, 1);
4a8bbed7 UH	171
	172	return SR_OK;
	173	}
	174
	175	/* Return TRUE if a full packet was parsed, FALSE otherwise. */
	176	static gboolean handle_new_data(struct sr_dev_inst *sdi, int idx)
	177	{
	178	struct dev_context *devc;
	179	struct sr_serial_dev_inst *serial;
	180	int len, i, offset = 0, ret = FALSE;
	181
	182	devc = sdi->priv;
	183	serial = sdi->conn;
	184
	185	/* Try to get as much data as the buffer can hold. */
	186	len = SERIAL_BUFSIZE - devc->buflen;
3582ce8a	187	len = serial_read_nonblocking(serial, devc->buf + devc->buflen, len);
4a8bbed7 UH	188	if (len < 1) {
	189	sr_err("Serial port read error: %d.", len);
	190	return FALSE;
	191	}
	192
	193	devc->buflen += len;
	194
	195	/* Now look for packets in that data. */
	196	while ((devc->buflen - offset) >= center_devs[idx].packet_size) {
	197	if (center_devs[idx].packet_valid(devc->buf + offset)) {
	198	handle_packet(devc->buf + offset, sdi, idx);
	199	offset += center_devs[idx].packet_size;
	200	ret = TRUE;
	201	} else {
	202	offset++;
	203	}
	204	}
	205
	206	/* If we have any data left, move it to the beginning of our buffer. */
	207	for (i = 0; i < devc->buflen - offset; i++)
	208	devc->buf[i] = devc->buf[offset + i];
	209	devc->buflen -= offset;
	210
	211	return ret;
	212	}
	213
	214	static int receive_data(int fd, int revents, int idx, void *cb_data)
	215	{
	216	struct sr_dev_inst *sdi;
4433145f	217	struct dev_context *devc;
4a8bbed7 UH	218	static gboolean request_new_packet = TRUE;
	219	struct sr_serial_dev_inst *serial;
	220
	221	(void)fd;
4433145f UH	222
	223	if (!(sdi = cb_data))
	224	return TRUE;
	225
	226	if (!(devc = sdi->priv))
	227	return TRUE;
	228
4a8bbed7 UH	229	serial = sdi->conn;
4a8bbed7 UH	230
4433145f	231	if (revents == G_IO_IN) {
4a8bbed7 UH	232	/* New data arrived. */
	233	request_new_packet = handle_new_data(sdi, idx);
	234	} else {
	235	/*
	236	* Timeout. Send "A" to request a packet, but then don't send
	237	* further "A" commands until we received a full packet first.
	238	*/
	239	if (request_new_packet) {
	240	center_send(serial, "A");
	241	request_new_packet = FALSE;
	242	}
	243	}
	244
838f6906	245	if (sr_sw_limits_check(&devc->sw_limits))
d2f7c417	246	sr_dev_acquisition_stop(sdi);
4433145f UH	247
	248	return TRUE;
	249	}
4a8bbed7 UH	250
	251	#define RECEIVE_DATA(ID_UPPER) \
	252	SR_PRIV int receive_data_##ID_UPPER(int fd, int revents, void *cb_data) { \
	253	return receive_data(fd, revents, ID_UPPER, cb_data); }
	254
	255	/* Driver-specific receive_data() wrappers */
	256	RECEIVE_DATA(CENTER_309)
	257	RECEIVE_DATA(VOLTCRAFT_K204)