[libsigrok.git] / src / hardware / tondaj-sl-814 / protocol.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2012 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, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 */

#include <string.h>
#include <glib.h>
#include "libsigrok.h"
#include "libsigrok-internal.h"
#include "protocol.h"

/* States */
enum {
	SEND_INIT,
	GET_INIT_REPLY,
	SEND_PACKET_REQUEST,
	GET_PACKET,
};

static void parse_packet(const uint8_t *buf, float *floatval,
			 struct sr_datafeed_analog *analog)
{
	gboolean is_a, is_fast;
	uint16_t intval;
	uint8_t level = 0, level_bits;

	/* Byte 0 [7:7]: 0 = A, 1 = C */
	is_a = ((buf[0] & (1 << 7)) == 0);

	/* Byte 0 [6:6]: Unknown/unused? */

	/* Byte 0 [5:4]: Level (00 = 40, 01 = 60, 10 = 80, 11 = 100) */
	level_bits = (buf[0] >> 4) & 0x03;
	if (level_bits == 0)
		level = 40;
	else if (level_bits == 1)
		level = 60;
	else if (level_bits == 2)
		level = 80;
	else if (level_bits == 3)
		level = 100;

	/* Byte 0 [3:3]: 0 = fast, 1 = slow */
	is_fast = ((buf[0] & (1 << 3)) == 0);

	/* Byte 0 [2:0]: value[10..8] */
	/* Byte 1 [7:0]: value[7..0] */
	intval = (buf[0] & 0x7) << 8;
	intval |= buf[1];

	*floatval = (float)intval;

	/* The value on the display always has one digit after the comma. */
	*floatval /= 10;

	analog->mq = SR_MQ_SOUND_PRESSURE_LEVEL;
	analog->unit = SR_UNIT_DECIBEL_SPL;

	if (is_a)
		analog->mqflags |= SR_MQFLAG_SPL_FREQ_WEIGHT_A;
	else
		analog->mqflags |= SR_MQFLAG_SPL_FREQ_WEIGHT_C;

	if (is_fast)
		analog->mqflags |= SR_MQFLAG_SPL_TIME_WEIGHT_F;
	else
		analog->mqflags |= SR_MQFLAG_SPL_TIME_WEIGHT_S;

	/* TODO: How to handle level? */
	(void)level;
}

static void decode_packet(struct sr_dev_inst *sdi)
{
	struct sr_datafeed_packet packet;
	struct sr_datafeed_analog analog;
	struct dev_context *devc;
	float floatval;

	devc = sdi->priv;
	memset(&analog, 0, sizeof(struct sr_datafeed_analog));

	parse_packet(devc->buf, &floatval, &analog);

	/* Send a sample packet with one analog value. */
	analog.channels = sdi->channels;
	analog.num_samples = 1;
	analog.data = &floatval;
	packet.type = SR_DF_ANALOG;
	packet.payload = &analog;
	sr_session_send(devc->cb_data, &packet);

	devc->num_samples++;
}

int tondaj_sl_814_receive_data(int fd, int revents, void *cb_data)
{
	struct sr_dev_inst *sdi;
	struct dev_context *devc;
	struct sr_serial_dev_inst *serial;
	uint8_t buf[3];
	int ret;

	(void)fd;
	(void)revents;

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

	/* TODO: Parts of this code need to be improved later. */

	/* State machine. */
	if (devc->state == SEND_INIT) {
		/* On the first run, send the "init" command. */
		buf[0] = 0x10;
		buf[1] = 0x04;
		buf[2] = 0x0d;
		sr_spew("Sending init command: %02x %02x %02x.",
			buf[0], buf[1], buf[2]);
		if ((ret = serial_write(serial, buf, 3)) < 0) {
			sr_err("Error sending init command: %d.", ret);
			return FALSE;
		}
		devc->state = GET_INIT_REPLY;
	} else if (devc->state == GET_INIT_REPLY) {
		/* If we just sent the "init" command, get its reply. */
		if ((ret = serial_read(serial, buf, 2)) < 0) {
			sr_err("Error reading init reply: %d.", ret);
			return FALSE;
		}
		sr_spew("Received init reply: %02x %02x.", buf[0], buf[1]);
		/* Expected reply: 0x05 0x0d */
		if (buf[0] != 0x05 || buf[1] != 0x0d) {
			sr_err("Received incorrect init reply, retrying.");
			devc->state = SEND_INIT;
			return TRUE;
		}
		devc->state = SEND_PACKET_REQUEST;
	} else if (devc->state == SEND_PACKET_REQUEST) {
		/* Request a packet (send 0x30 ZZ 0x0d). */
		buf[0] = 0x30;
		buf[1] = 0x00; /* ZZ */
		buf[2] = 0x0d;
		sr_spew("Sending data request command: %02x %02x %02x.",
			buf[0], buf[1], buf[2]);
		if ((ret = serial_write(serial, buf, 3)) < 0) {
			sr_err("Error sending request command: %d.", ret);
			return FALSE;
		}
		devc->buflen = 0;
		devc->state = GET_PACKET;
	} else if (devc->state == GET_PACKET) {
		/* Read a packet from the device. */
		ret = serial_read(serial, devc->buf + devc->buflen,
				  4 - devc->buflen);
		if (ret < 0) {
			sr_err("Error reading packet: %d.", ret);
			return TRUE;
		}

		devc->buflen += ret;

		/* Didn't receive all 4 bytes, yet. */
		if (devc->buflen != 4)
			return TRUE;

		sr_spew("Received packet: %02x %02x %02x %02x.", devc->buf[0],
			devc->buf[1], devc->buf[2], devc->buf[3]);

		/* Expected reply: AA BB ZZ+1 0x0d */
		if (devc->buf[2] != 0x01 || devc->buf[3] != 0x0d) {
			sr_err("Received incorrect request reply, retrying.");
			devc->state = SEND_PACKET_REQUEST;
			return TRUE;
		}

		decode_packet(sdi);

		devc->state = SEND_PACKET_REQUEST;
	} else {
		sr_err("Invalid state: %d.", devc->state);
		return FALSE;
	}

	/* Stop acquisition if we acquired enough samples. */
	if (devc->limit_samples && devc->num_samples >= devc->limit_samples) {
		sr_info("Requested number of samples reached.");
		sdi->driver->dev_acquisition_stop(sdi, cb_data);
	}

	return TRUE;
}
Commit	Line	Data
aa2af324	1	/*
50985c20	2	* This file is part of the libsigrok project.
aa2af324 UH	3	*
	4	* Copyright (C) 2012 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
	17	* along with this program; if not, write to the Free Software
	18	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
	19	*/
	20
c073af80	21	#include <string.h>
aa2af324 UH	22	#include <glib.h>
	23	#include "libsigrok.h"
	24	#include "libsigrok-internal.h"
	25	#include "protocol.h"
	26
c073af80 UH	27	/* States */
	28	enum {
	29	SEND_INIT,
	30	GET_INIT_REPLY,
	31	SEND_PACKET_REQUEST,
	32	GET_PACKET,
	33	};
	34
	35	static void parse_packet(const uint8_t buf, float floatval,
	36	struct sr_datafeed_analog *analog)
	37	{
	38	gboolean is_a, is_fast;
	39	uint16_t intval;
	40	uint8_t level = 0, level_bits;
	41
	42	/* Byte 0 [7:7]: 0 = A, 1 = C */
	43	is_a = ((buf[0] & (1 << 7)) == 0);
	44
	45	/* Byte 0 [6:6]: Unknown/unused? */
	46
	47	/* Byte 0 [5:4]: Level (00 = 40, 01 = 60, 10 = 80, 11 = 100) */
	48	level_bits = (buf[0] >> 4) & 0x03;
	49	if (level_bits == 0)
	50	level = 40;
	51	else if (level_bits == 1)
	52	level = 60;
	53	else if (level_bits == 2)
	54	level = 80;
	55	else if (level_bits == 3)
	56	level = 100;
	57
	58	/* Byte 0 [3:3]: 0 = fast, 1 = slow */
	59	is_fast = ((buf[0] & (1 << 3)) == 0);
	60
	61	/* Byte 0 [2:0]: value[10..8] */
	62	/* Byte 1 [7:0]: value[7..0] */
	63	intval = (buf[0] & 0x7) << 8;
	64	intval \|= buf[1];
	65
	66	*floatval = (float)intval;
	67
	68	/* The value on the display always has one digit after the comma. */
	69	*floatval /= 10;
	70
	71	analog->mq = SR_MQ_SOUND_PRESSURE_LEVEL;
	72	analog->unit = SR_UNIT_DECIBEL_SPL;
	73
	74	if (is_a)
	75	analog->mqflags \|= SR_MQFLAG_SPL_FREQ_WEIGHT_A;
	76	else
	77	analog->mqflags \|= SR_MQFLAG_SPL_FREQ_WEIGHT_C;
	78
	79	if (is_fast)
	80	analog->mqflags \|= SR_MQFLAG_SPL_TIME_WEIGHT_F;
	81	else
	82	analog->mqflags \|= SR_MQFLAG_SPL_TIME_WEIGHT_S;
	83
	84	/* TODO: How to handle level? */
	85	(void)level;
	86	}
	87
69e19dd7	88	static void decode_packet(struct sr_dev_inst *sdi)
aa2af324	89	{
c073af80 UH	90	struct sr_datafeed_packet packet;
c073af80 UH	91	struct sr_datafeed_analog analog;
69e19dd7	92	struct dev_context *devc;
c073af80 UH	93	float floatval;
c073af80 UH	94
69e19dd7	95	devc = sdi->priv;
c073af80 UH	96	memset(&analog, 0, sizeof(struct sr_datafeed_analog));
	97
	98	parse_packet(devc->buf, &floatval, &analog);
	99
	100	/* Send a sample packet with one analog value. */
ba7dd8bb	101	analog.channels = sdi->channels;
c073af80 UH	102	analog.num_samples = 1;
	103	analog.data = &floatval;
	104	packet.type = SR_DF_ANALOG;
	105	packet.payload = &analog;
	106	sr_session_send(devc->cb_data, &packet);
	107
	108	devc->num_samples++;
	109	}
	110
	111	int tondaj_sl_814_receive_data(int fd, int revents, void *cb_data)
	112	{
	113	struct sr_dev_inst *sdi;
aa2af324	114	struct dev_context *devc;
a5e44c32	115	struct sr_serial_dev_inst *serial;
c073af80 UH	116	uint8_t buf[3];
	117	int ret;
	118
f4284934	119	(void)fd;
c073af80 UH	120	(void)revents;
	121
	122	sdi = cb_data;
a5e44c32	123	serial = sdi->conn;
c073af80	124	devc = sdi->priv;
aa2af324	125
c073af80	126	/* TODO: Parts of this code need to be improved later. */
aa2af324	127
c073af80 UH	128	/* State machine. */
	129	if (devc->state == SEND_INIT) {
	130	/* On the first run, send the "init" command. */
	131	buf[0] = 0x10;
	132	buf[1] = 0x04;
	133	buf[2] = 0x0d;
	134	sr_spew("Sending init command: %02x %02x %02x.",
	135	buf[0], buf[1], buf[2]);
a5e44c32	136	if ((ret = serial_write(serial, buf, 3)) < 0) {
c073af80 UH	137	sr_err("Error sending init command: %d.", ret);
	138	return FALSE;
	139	}
	140	devc->state = GET_INIT_REPLY;
	141	} else if (devc->state == GET_INIT_REPLY) {
	142	/* If we just sent the "init" command, get its reply. */
a5e44c32	143	if ((ret = serial_read(serial, buf, 2)) < 0) {
c073af80 UH	144	sr_err("Error reading init reply: %d.", ret);
	145	return FALSE;
	146	}
	147	sr_spew("Received init reply: %02x %02x.", buf[0], buf[1]);
	148	/* Expected reply: 0x05 0x0d */
	149	if (buf[0] != 0x05 \|\| buf[1] != 0x0d) {
	150	sr_err("Received incorrect init reply, retrying.");
	151	devc->state = SEND_INIT;
	152	return TRUE;
	153	}
	154	devc->state = SEND_PACKET_REQUEST;
	155	} else if (devc->state == SEND_PACKET_REQUEST) {
	156	/* Request a packet (send 0x30 ZZ 0x0d). */
	157	buf[0] = 0x30;
	158	buf[1] = 0x00; /* ZZ */
	159	buf[2] = 0x0d;
	160	sr_spew("Sending data request command: %02x %02x %02x.",
	161	buf[0], buf[1], buf[2]);
a5e44c32	162	if ((ret = serial_write(serial, buf, 3)) < 0) {
c073af80 UH	163	sr_err("Error sending request command: %d.", ret);
	164	return FALSE;
	165	}
	166	devc->buflen = 0;
	167	devc->state = GET_PACKET;
	168	} else if (devc->state == GET_PACKET) {
	169	/* Read a packet from the device. */
a5e44c32	170	ret = serial_read(serial, devc->buf + devc->buflen,
c073af80 UH	171	4 - devc->buflen);
	172	if (ret < 0) {
	173	sr_err("Error reading packet: %d.", ret);
	174	return TRUE;
	175	}
	176
	177	devc->buflen += ret;
	178
	179	/* Didn't receive all 4 bytes, yet. */
	180	if (devc->buflen != 4)
	181	return TRUE;
	182
	183	sr_spew("Received packet: %02x %02x %02x %02x.", devc->buf[0],
	184	devc->buf[1], devc->buf[2], devc->buf[3]);
	185
	186	/* Expected reply: AA BB ZZ+1 0x0d */
	187	if (devc->buf[2] != 0x01 \|\| devc->buf[3] != 0x0d) {
	188	sr_err("Received incorrect request reply, retrying.");
	189	devc->state = SEND_PACKET_REQUEST;
	190	return TRUE;
	191	}
	192
69e19dd7	193	decode_packet(sdi);
c073af80 UH	194
	195	devc->state = SEND_PACKET_REQUEST;
	196	} else {
	197	sr_err("Invalid state: %d.", devc->state);
	198	return FALSE;
	199	}
aa2af324	200
c073af80	201	/* Stop acquisition if we acquired enough samples. */
35e199da UH	202	if (devc->limit_samples && devc->num_samples >= devc->limit_samples) {
	203	sr_info("Requested number of samples reached.");
	204	sdi->driver->dev_acquisition_stop(sdi, cb_data);
aa2af324 UH	205	}
	206
	207	return TRUE;
	208	}