[libsigrok.git] / hardware / colead-slm / protocol.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2012 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 <stdlib.h>
#include <glib.h>
#include "libsigrok.h"
#include "libsigrok-internal.h"
#include "protocol.h"
#include <errno.h>
#include <string.h>

static void process_packet(const struct sr_dev_inst *sdi)
{
	struct dev_context *devc;
	struct sr_datafeed_packet packet;
	struct sr_datafeed_analog analog;
	GString *dbg;
	float fvalue;
	int checksum, mode, i;

	devc = sdi->priv;
	if (sr_log_loglevel_get() >= SR_LOG_SPEW) {
		dbg = g_string_sized_new(128);
		g_string_printf(dbg, "received packet:");
		for (i = 0; i < 10; i++)
			g_string_append_printf(dbg, " %.2x", (devc->buf)[i]);
		sr_spew("%s", dbg->str);
		g_string_free(dbg, TRUE);
	}

	if (devc->buf[0] != 0x08 || devc->buf[1] != 0x04) {
		sr_dbg("invalid packet header.");
		return;
	}

	if (devc->buf[8] != 0x01) {
		sr_dbg("invalid measurement.");
		return;
	}

	checksum = 0;
	for (i = 0; i < 9; i++)
		checksum += devc->buf[i];
	if ((checksum & 0xff) != devc->buf[9]) {
		sr_dbg("invalid packet checksum.");
		return;
	}

	fvalue = 0.0;
	for (i = 3; i < 8; i++) {
		if (devc->buf[i] > 0x09)
			continue;
		fvalue *= 10;
		fvalue += devc->buf[i];
	}
	fvalue /= 10;

	memset(&analog, 0, sizeof(struct sr_datafeed_analog));
	analog.mq = SR_MQ_SOUND_PRESSURE_LEVEL;
	analog.unit = SR_UNIT_DECIBEL_SPL;
	analog.channels = sdi->channels;
	analog.num_samples = 1;
	analog.data = &fvalue;

	/* High nibble should only have 0x01 or 0x02. */
	mode = (devc->buf[2] >> 4) & 0x0f;
	if (mode == 0x02)
		analog.mqflags |= SR_MQFLAG_HOLD;
	else if (mode != 0x01) {
		sr_dbg("unknown measurement mode 0x%.2x", mode);
		return;
	}

	/* Low nibble has 14 combinations of direct/long-term average,
	 * time scale of that average, frequency weighting, and time
	 * weighting. */
	mode = devc->buf[2] & 0x0f;
	switch (mode) {
		case 0x0:
			analog.mqflags |= SR_MQFLAG_SPL_FREQ_WEIGHT_A \
					| SR_MQFLAG_SPL_TIME_WEIGHT_F;
			break;
		case 0x1:
			analog.mqflags |= SR_MQFLAG_SPL_FREQ_WEIGHT_A \
					| SR_MQFLAG_SPL_TIME_WEIGHT_S;
			break;
		case 0x2:
			analog.mqflags |= SR_MQFLAG_SPL_FREQ_WEIGHT_C \
					| SR_MQFLAG_SPL_TIME_WEIGHT_F;
			break;
		case 0x3:
			analog.mqflags |= SR_MQFLAG_SPL_FREQ_WEIGHT_C \
					| SR_MQFLAG_SPL_TIME_WEIGHT_S;
			break;
		case 0x4:
			analog.mqflags |= SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT \
					| SR_MQFLAG_SPL_TIME_WEIGHT_F;
			break;
		case 0x5:
			analog.mqflags |= SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT \
					| SR_MQFLAG_SPL_TIME_WEIGHT_S;
			break;
		case 0x6:
			analog.mqflags |= SR_MQFLAG_SPL_PCT_OVER_ALARM \
					| SR_MQFLAG_SPL_FREQ_WEIGHT_A \
					| SR_MQFLAG_SPL_TIME_WEIGHT_F;
			break;
		case 0x7:
			analog.mqflags |= SR_MQFLAG_SPL_PCT_OVER_ALARM \
					| SR_MQFLAG_SPL_FREQ_WEIGHT_A \
					| SR_MQFLAG_SPL_TIME_WEIGHT_S;
			break;
		case 0x8:
			/* 10-second mean, but we don't have MQ flags to express it. */
			analog.mqflags |= SR_MQFLAG_SPL_LAT \
					| SR_MQFLAG_SPL_FREQ_WEIGHT_A \
					| SR_MQFLAG_SPL_TIME_WEIGHT_F;
			break;
		case 0x9:
			/* Mean over a time period between 11 seconds and 24 hours.
			 * Which is so silly that there's no point in expressing
			 * either this or the previous case.  */
			analog.mqflags |= SR_MQFLAG_SPL_LAT \
					| SR_MQFLAG_SPL_FREQ_WEIGHT_A \
					| SR_MQFLAG_SPL_TIME_WEIGHT_F;
			break;
		case 0xa:
			/* 10-second mean. */
			analog.mqflags |= SR_MQFLAG_SPL_LAT \
					| SR_MQFLAG_SPL_FREQ_WEIGHT_A \
					| SR_MQFLAG_SPL_TIME_WEIGHT_S;
			break;
		case 0xb:
			/* Mean over a time period between 11 seconds and 24 hours. */
			analog.mqflags |= SR_MQFLAG_SPL_LAT \
					| SR_MQFLAG_SPL_FREQ_WEIGHT_A \
					| SR_MQFLAG_SPL_TIME_WEIGHT_S;
			break;
		case 0xc:
			/* Internal calibration on 1kHz sine at 94dB, not useful
			 * to anything but the device. */
			analog.mqflags |= SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT;
			break;
		case 0xd:
			/* Internal calibration on 1kHz sine at 94dB, not useful
			 * to anything but the device. */
			analog.mqflags |= SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT;
			break;
		default:
			sr_dbg("unknown configuration 0x%.2x", mode);
			return;
			break;
	}

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

	devc->num_samples++;

}

SR_PRIV int colead_slm_receive_data(int fd, int revents, void *cb_data)
{
	const struct sr_dev_inst *sdi;
	struct dev_context *devc;
	struct sr_serial_dev_inst *serial;
	int len;
	char buf[128];

	(void)fd;

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

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

	if (revents != G_IO_IN)
		/* Timeout event. */
		return TRUE;

	serial = sdi->conn;
	if (devc->state == IDLE) {
		if (serial_read(serial, buf, 128) != 1 || buf[0] != 0x10)
			/* Nothing there, or caught the tail end of a previous packet,
			 * or some garbage. Unless it's a single "data ready" byte,
			 * we don't want it. */
			return TRUE;
		/* Got 0x10, "measurement ready". */
		if (serial_write(serial, "\x20", 1) == -1)
			sr_err("unable to send command: %s", strerror(errno));
		else {
			devc->state = COMMAND_SENT;
			devc->buflen = 0;
		}
	} else {
		len = serial_read(serial, devc->buf + devc->buflen,
				10 - devc->buflen);
		if (len < 1)
			return TRUE;
		devc->buflen += len;
		if (devc->buflen > 10) {
			sr_dbg("buffer overrun");
			devc->state = IDLE;
			return TRUE;
		}
		if (devc->buflen == 10) {
			/* If we got here, we're sure the device sent a "data ready"
			 * notification, we asked for data, and got it. */
			process_packet(sdi);
			devc->state = IDLE;
		}
	}

	return TRUE;
}
Commit	Line	Data
4d729ddc BV	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2012 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
	20	#include <stdlib.h>
	21	#include <glib.h>
	22	#include "libsigrok.h"
	23	#include "libsigrok-internal.h"
	24	#include "protocol.h"
a8d09e13 BV	25	#include <errno.h>
	26	#include <string.h>
	27
a8d09e13 BV	28	static void process_packet(const struct sr_dev_inst *sdi)
	29	{
	30	struct dev_context *devc;
	31	struct sr_datafeed_packet packet;
	32	struct sr_datafeed_analog analog;
	33	GString *dbg;
	34	float fvalue;
	35	int checksum, mode, i;
	36
	37	devc = sdi->priv;
	38	if (sr_log_loglevel_get() >= SR_LOG_SPEW) {
	39	dbg = g_string_sized_new(128);
	40	g_string_printf(dbg, "received packet:");
	41	for (i = 0; i < 10; i++)
	42	g_string_append_printf(dbg, " %.2x", (devc->buf)[i]);
	43	sr_spew("%s", dbg->str);
	44	g_string_free(dbg, TRUE);
	45	}
	46
	47	if (devc->buf[0] != 0x08 \|\| devc->buf[1] != 0x04) {
	48	sr_dbg("invalid packet header.");
	49	return;
	50	}
	51
	52	if (devc->buf[8] != 0x01) {
	53	sr_dbg("invalid measurement.");
	54	return;
	55	}
	56
	57	checksum = 0;
	58	for (i = 0; i < 9; i++)
	59	checksum += devc->buf[i];
	60	if ((checksum & 0xff) != devc->buf[9]) {
	61	sr_dbg("invalid packet checksum.");
	62	return;
	63	}
	64
	65	fvalue = 0.0;
	66	for (i = 3; i < 8; i++) {
	67	if (devc->buf[i] > 0x09)
	68	continue;
	69	fvalue *= 10;
	70	fvalue += devc->buf[i];
	71	}
	72	fvalue /= 10;
	73
	74	memset(&analog, 0, sizeof(struct sr_datafeed_analog));
	75	analog.mq = SR_MQ_SOUND_PRESSURE_LEVEL;
	76	analog.unit = SR_UNIT_DECIBEL_SPL;
ba7dd8bb	77	analog.channels = sdi->channels;
a8d09e13 BV	78	analog.num_samples = 1;
	79	analog.data = &fvalue;
	80
	81	/* High nibble should only have 0x01 or 0x02. */
	82	mode = (devc->buf[2] >> 4) & 0x0f;
	83	if (mode == 0x02)
	84	analog.mqflags \|= SR_MQFLAG_HOLD;
	85	else if (mode != 0x01) {
	86	sr_dbg("unknown measurement mode 0x%.2x", mode);
	87	return;
	88	}
	89
	90	/* Low nibble has 14 combinations of direct/long-term average,
	91	* time scale of that average, frequency weighting, and time
	92	* weighting. */
	93	mode = devc->buf[2] & 0x0f;
	94	switch (mode) {
	95	case 0x0:
	96	analog.mqflags \|= SR_MQFLAG_SPL_FREQ_WEIGHT_A \
	97	\| SR_MQFLAG_SPL_TIME_WEIGHT_F;
	98	break;
	99	case 0x1:
	100	analog.mqflags \|= SR_MQFLAG_SPL_FREQ_WEIGHT_A \
	101	\| SR_MQFLAG_SPL_TIME_WEIGHT_S;
	102	break;
	103	case 0x2:
	104	analog.mqflags \|= SR_MQFLAG_SPL_FREQ_WEIGHT_C \
	105	\| SR_MQFLAG_SPL_TIME_WEIGHT_F;
	106	break;
	107	case 0x3:
	108	analog.mqflags \|= SR_MQFLAG_SPL_FREQ_WEIGHT_C \
	109	\| SR_MQFLAG_SPL_TIME_WEIGHT_S;
	110	break;
	111	case 0x4:
	112	analog.mqflags \|= SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT \
	113	\| SR_MQFLAG_SPL_TIME_WEIGHT_F;
	114	break;
	115	case 0x5:
	116	analog.mqflags \|= SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT \
	117	\| SR_MQFLAG_SPL_TIME_WEIGHT_S;
	118	break;
	119	case 0x6:
	120	analog.mqflags \|= SR_MQFLAG_SPL_PCT_OVER_ALARM \
	121	\| SR_MQFLAG_SPL_FREQ_WEIGHT_A \
	122	\| SR_MQFLAG_SPL_TIME_WEIGHT_F;
	123	break;
	124	case 0x7:
	125	analog.mqflags \|= SR_MQFLAG_SPL_PCT_OVER_ALARM \
	126	\| SR_MQFLAG_SPL_FREQ_WEIGHT_A \
	127	\| SR_MQFLAG_SPL_TIME_WEIGHT_S;
	128	break;
	129	case 0x8:
	130	/* 10-second mean, but we don't have MQ flags to express it. */
	131	analog.mqflags \|= SR_MQFLAG_SPL_LAT \
	132	\| SR_MQFLAG_SPL_FREQ_WEIGHT_A \
	133	\| SR_MQFLAG_SPL_TIME_WEIGHT_F;
	134	break;
	135	case 0x9:
	136	/* Mean over a time period between 11 seconds and 24 hours.
	137	* Which is so silly that there's no point in expressing
	138	* either this or the previous case. */
	139	analog.mqflags \|= SR_MQFLAG_SPL_LAT \
	140	\| SR_MQFLAG_SPL_FREQ_WEIGHT_A \
	141	\| SR_MQFLAG_SPL_TIME_WEIGHT_F;
142	break;
143	case 0xa:
144	/* 10-second mean. */
145	analog.mqflags \|= SR_MQFLAG_SPL_LAT \
146	\| SR_MQFLAG_SPL_FREQ_WEIGHT_A \
147	\| SR_MQFLAG_SPL_TIME_WEIGHT_S;
148	break;
149	case 0xb:
150	/* Mean over a time period between 11 seconds and 24 hours. */
151	analog.mqflags \|= SR_MQFLAG_SPL_LAT \
152	\| SR_MQFLAG_SPL_FREQ_WEIGHT_A \
153	\| SR_MQFLAG_SPL_TIME_WEIGHT_S;
154	break;
155	case 0xc:
156	/* Internal calibration on 1kHz sine at 94dB, not useful
157	* to anything but the device. */
158	analog.mqflags \|= SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT;
159	break;
160	case 0xd:
161	/* Internal calibration on 1kHz sine at 94dB, not useful
162	* to anything but the device. */
163	analog.mqflags \|= SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT;
164	break;
165	default:
166	sr_dbg("unknown configuration 0x%.2x", mode);
167	return;
168	break;
169	}
170
171	packet.type = SR_DF_ANALOG;
172	packet.payload = &analog;
173	sr_session_send(devc->cb_data, &packet);
174
175	devc->num_samples++;
176
177	}
4d729ddc BV	178
	179	SR_PRIV int colead_slm_receive_data(int fd, int revents, void *cb_data)
	180	{
	181	const struct sr_dev_inst *sdi;
	182	struct dev_context *devc;
aa706635	183	struct sr_serial_dev_inst *serial;
a8d09e13 BV	184	int len;
a8d09e13 BV	185	char buf[128];
4d729ddc	186
f306ca61 BV	187	(void)fd;
f306ca61 BV	188
4d729ddc BV	189	if (!(sdi = cb_data))
	190	return TRUE;
	191
	192	if (!(devc = sdi->priv))
	193	return TRUE;
	194
a8d09e13 BV	195	if (revents != G_IO_IN)
	196	/* Timeout event. */
	197	return TRUE;
	198
aa706635	199	serial = sdi->conn;
a8d09e13	200	if (devc->state == IDLE) {
aa706635	201	if (serial_read(serial, buf, 128) != 1 \|\| buf[0] != 0x10)
a8d09e13 BV	202	/* Nothing there, or caught the tail end of a previous packet,
	203	* or some garbage. Unless it's a single "data ready" byte,
	204	* we don't want it. */
	205	return TRUE;
	206	/* Got 0x10, "measurement ready". */
aa706635	207	if (serial_write(serial, "\x20", 1) == -1)
a8d09e13 BV	208	sr_err("unable to send command: %s", strerror(errno));
	209	else {
	210	devc->state = COMMAND_SENT;
	211	devc->buflen = 0;
	212	}
	213	} else {
aa706635	214	len = serial_read(serial, devc->buf + devc->buflen,
f306ca61	215	10 - devc->buflen);
a8d09e13 BV	216	if (len < 1)
	217	return TRUE;
	218	devc->buflen += len;
	219	if (devc->buflen > 10) {
	220	sr_dbg("buffer overrun");
	221	devc->state = IDLE;
	222	return TRUE;
	223	}
	224	if (devc->buflen == 10) {
	225	/* If we got here, we're sure the device sent a "data ready"
	226	* notification, we asked for data, and got it. */
	227	process_packet(sdi);
	228	devc->state = IDLE;
	229	}
4d729ddc BV	230	}
	231
	232	return TRUE;
	233	}