[libsigrok.git] / src / hardware / rdtech-um / protocol.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2018-2020 Andreas Sandberg <andreas@sandberg.pp.se>
 *
 * 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 <glib.h>
#include <libsigrok/libsigrok.h>
#include <math.h>
#include <stdlib.h>
#include <string.h>

#include "libsigrok-internal.h"
#include "protocol.h"

#define SERIAL_WRITE_TIMEOUT_MS 1

#define UM_POLL_LEN 130
#define UM_POLL_PERIOD_MS 100
#define UM_TIMEOUT_MS 1000

#define UM_CMD_POLL 0xf0

static const struct binary_analog_channel rdtech_default_channels[] = {
	{ "V", { 2, BVT_BE_UINT16, 0.01, }, 2, SR_MQ_VOLTAGE, SR_UNIT_VOLT },
	{ "I", { 4, BVT_BE_UINT16, 0.001, }, 3, SR_MQ_CURRENT, SR_UNIT_AMPERE },
	{ "D+", { 96, BVT_BE_UINT16, 0.01, }, 2, SR_MQ_VOLTAGE, SR_UNIT_VOLT },
	{ "D-", { 98, BVT_BE_UINT16, 0.01, }, 2, SR_MQ_VOLTAGE, SR_UNIT_VOLT },
	{ "T", { 10, BVT_BE_UINT16, 1.0, }, 0, SR_MQ_TEMPERATURE, SR_UNIT_CELSIUS },
	/* Threshold-based recording (mWh) */
	{ "E", { 106, BVT_BE_UINT32, 0.001, }, 3, SR_MQ_ENERGY, SR_UNIT_WATT_HOUR },
	ALL_ZERO,
};

static const struct binary_analog_channel rdtech_um25c_channels[] = {
	{ "V", { 2, BVT_BE_UINT16, 0.001, }, 3, SR_MQ_VOLTAGE, SR_UNIT_VOLT },
	{ "I", { 4, BVT_BE_UINT16, 0.0001, }, 4, SR_MQ_CURRENT, SR_UNIT_AMPERE },
	{ "D+", { 96, BVT_BE_UINT16, 0.01, }, 2, SR_MQ_VOLTAGE, SR_UNIT_VOLT },
	{ "D-", { 98, BVT_BE_UINT16, 0.01, }, 2, SR_MQ_VOLTAGE, SR_UNIT_VOLT },
	{ "T", { 10, BVT_BE_UINT16, 1.0, }, 0, SR_MQ_TEMPERATURE, SR_UNIT_CELSIUS },
	/* Threshold-based recording (mWh) */
	{ "E", { 106, BVT_BE_UINT32, 0.001, }, 3, SR_MQ_ENERGY, SR_UNIT_WATT_HOUR },
	ALL_ZERO,
};

static gboolean csum_ok_fff1(const uint8_t *buf, size_t len)
{
	uint16_t csum_recv;

	if (len != UM_POLL_LEN)
		return FALSE;

	csum_recv = read_u16be(&buf[len - sizeof(uint16_t)]);
	if (csum_recv != 0xfff1)
		return FALSE;

	return TRUE;
}

static gboolean csum_ok_um34c(const uint8_t *buf, size_t len)
{
	static const int positions[] = {
		1, 3, 7, 9, 15, 17, 19, 23, 31, 39, 41, 45, 49, 53,
		55, 57, 59, 63, 67, 69, 73, 79, 83, 89, 97, 99, 109,
		111, 113, 119, 121, 127,
	};

	size_t i;
	uint8_t csum_calc, csum_recv;

	if (len != UM_POLL_LEN)
		return FALSE;

	csum_calc = 0;
	for (i = 0; i < ARRAY_SIZE(positions); i++)
		csum_calc ^= buf[positions[i]];
	csum_recv = read_u8(&buf[len - sizeof(uint8_t)]);
	if (csum_recv != csum_calc)
		return FALSE;

	return TRUE;
}

static const struct rdtech_um_profile um_profiles[] = {
	{ "UM24C", RDTECH_UM24C, rdtech_default_channels, csum_ok_fff1, },
	{ "UM25C", RDTECH_UM25C, rdtech_um25c_channels, csum_ok_fff1, },
	{ "UM34C", RDTECH_UM34C, rdtech_default_channels, csum_ok_um34c, },
};

static const struct rdtech_um_profile *find_profile(uint16_t id)
{
	unsigned int i;

	for (i = 0; i < ARRAY_SIZE(um_profiles); i++) {
		if (um_profiles[i].model_id == id)
			return &um_profiles[i];
	}
	return NULL;
}

SR_PRIV const struct rdtech_um_profile *rdtech_um_probe(struct sr_serial_dev_inst *serial)
{
	const struct rdtech_um_profile *p;
	uint8_t request;
	uint8_t buf[RDTECH_UM_BUFSIZE];
	int len;

	request = UM_CMD_POLL;
	if (serial_write_blocking(serial, &request, sizeof(request),
			SERIAL_WRITE_TIMEOUT_MS) < 0) {
		sr_err("Unable to send probe request.");
		return NULL;
	}

	len = serial_read_blocking(serial, buf, UM_POLL_LEN, UM_TIMEOUT_MS);
	if (len != UM_POLL_LEN) {
		sr_err("Failed to read probe response.");
		return NULL;
	}

	p = find_profile(RB16(&buf[0]));
	if (!p) {
		sr_err("Unrecognized UM device (0x%.4" PRIx16 ")!", RB16(&buf[0]));
		return NULL;
	}

	if (!p->csum_ok(buf, len)) {
		sr_err("Probe response contains illegal checksum or end marker.\n");
		return NULL;
	}

	return p;
}

SR_PRIV int rdtech_um_poll(const struct sr_dev_inst *sdi)
{
	struct dev_context *devc;
	struct sr_serial_dev_inst *serial;
	uint8_t request;

	serial = sdi->conn;
	request = UM_CMD_POLL;
	if (serial_write_blocking(serial, &request, sizeof(request),
			SERIAL_WRITE_TIMEOUT_MS) < 0) {
		sr_err("Unable to send poll request.");
		return SR_ERR;
	}

	devc = sdi->priv;
	devc->cmd_sent_at = g_get_monotonic_time() / 1000;

	return SR_OK;
}

static void handle_poll_data(const struct sr_dev_inst *sdi)
{
	struct dev_context *devc;
	int i;
	GSList *ch;

	devc = sdi->priv;
	sr_spew("Received poll packet (len: %zu).", devc->buflen);
	if (devc->buflen != UM_POLL_LEN) {
		sr_err("Unexpected poll packet length: %zu", devc->buflen);
		return;
	}

	for (ch = sdi->channels, i = 0; ch; ch = g_slist_next(ch), i++) {
		bv_send_analog_channel(sdi, ch->data,
			&devc->profile->channels[i],
			devc->buf, devc->buflen);
	}

	sr_sw_limits_update_samples_read(&devc->limits, 1);
}

static void recv_poll_data(struct sr_dev_inst *sdi, struct sr_serial_dev_inst *serial)
{
	struct dev_context *devc;
	const struct rdtech_um_profile *p;
	int len;

	/* Serial data arrived. */
	devc = sdi->priv;
	p = devc->profile;
	while (devc->buflen < UM_POLL_LEN) {
		len = serial_read_nonblocking(serial, devc->buf + devc->buflen, 1);
		if (len < 1)
			return;

		devc->buflen++;

		/* Check if the poll model ID matches the profile. */
		if (devc->buflen == 2 && RB16(devc->buf) != p->model_id) {
			sr_warn("Illegal model ID in poll response (0x%.4" PRIx16 "),"
				" skipping 1 byte.",
				RB16(devc->buf));
			devc->buflen--;
			memmove(devc->buf, devc->buf + 1, devc->buflen);
		}
	}

	if (devc->buflen == UM_POLL_LEN && p->csum_ok(devc->buf, devc->buflen))
		handle_poll_data(sdi);
	else
		sr_warn("Skipping packet with illegal checksum / end marker.");

	devc->buflen = 0;
}

SR_PRIV int rdtech_um_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 now, elapsed;

	(void)fd;

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

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

	serial = sdi->conn;
	if (revents == G_IO_IN)
		recv_poll_data(sdi, serial);

	if (sr_sw_limits_check(&devc->limits)) {
		sr_dev_acquisition_stop(sdi);
		return TRUE;
	}

	now = g_get_monotonic_time() / 1000;
	elapsed = now - devc->cmd_sent_at;

	if (elapsed > UM_POLL_PERIOD_MS)
		rdtech_um_poll(sdi);

	return TRUE;
}
Commit	Line	Data
	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2018-2020 Andreas Sandberg <andreas@sandberg.pp.se>
	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 <config.h>
	21
	22	#include <glib.h>
	23	#include <libsigrok/libsigrok.h>
	24	#include <math.h>
	25	#include <stdlib.h>
	26	#include <string.h>
	27
	28	#include "libsigrok-internal.h"
	29	#include "protocol.h"
	30
	31	#define SERIAL_WRITE_TIMEOUT_MS 1
	32
	33	#define UM_POLL_LEN 130
	34	#define UM_POLL_PERIOD_MS 100
	35	#define UM_TIMEOUT_MS 1000
	36
	37	#define UM_CMD_POLL 0xf0
	38
	39	static const struct binary_analog_channel rdtech_default_channels[] = {
	40	{ "V", { 2, BVT_BE_UINT16, 0.01, }, 2, SR_MQ_VOLTAGE, SR_UNIT_VOLT },
	41	{ "I", { 4, BVT_BE_UINT16, 0.001, }, 3, SR_MQ_CURRENT, SR_UNIT_AMPERE },
	42	{ "D+", { 96, BVT_BE_UINT16, 0.01, }, 2, SR_MQ_VOLTAGE, SR_UNIT_VOLT },
	43	{ "D-", { 98, BVT_BE_UINT16, 0.01, }, 2, SR_MQ_VOLTAGE, SR_UNIT_VOLT },
	44	{ "T", { 10, BVT_BE_UINT16, 1.0, }, 0, SR_MQ_TEMPERATURE, SR_UNIT_CELSIUS },
	45	/* Threshold-based recording (mWh) */
	46	{ "E", { 106, BVT_BE_UINT32, 0.001, }, 3, SR_MQ_ENERGY, SR_UNIT_WATT_HOUR },
	47	ALL_ZERO,
	48	};
	49
	50	static const struct binary_analog_channel rdtech_um25c_channels[] = {
	51	{ "V", { 2, BVT_BE_UINT16, 0.001, }, 3, SR_MQ_VOLTAGE, SR_UNIT_VOLT },
	52	{ "I", { 4, BVT_BE_UINT16, 0.0001, }, 4, SR_MQ_CURRENT, SR_UNIT_AMPERE },
	53	{ "D+", { 96, BVT_BE_UINT16, 0.01, }, 2, SR_MQ_VOLTAGE, SR_UNIT_VOLT },
	54	{ "D-", { 98, BVT_BE_UINT16, 0.01, }, 2, SR_MQ_VOLTAGE, SR_UNIT_VOLT },
	55	{ "T", { 10, BVT_BE_UINT16, 1.0, }, 0, SR_MQ_TEMPERATURE, SR_UNIT_CELSIUS },
	56	/* Threshold-based recording (mWh) */
	57	{ "E", { 106, BVT_BE_UINT32, 0.001, }, 3, SR_MQ_ENERGY, SR_UNIT_WATT_HOUR },
	58	ALL_ZERO,
	59	};
	60
	61	static gboolean csum_ok_fff1(const uint8_t *buf, size_t len)
	62	{
	63	uint16_t csum_recv;
	64
	65	if (len != UM_POLL_LEN)
	66	return FALSE;
	67
	68	csum_recv = read_u16be(&buf[len - sizeof(uint16_t)]);
	69	if (csum_recv != 0xfff1)
	70	return FALSE;
	71
	72	return TRUE;
	73	}
	74
	75	static gboolean csum_ok_um34c(const uint8_t *buf, size_t len)
	76	{
	77	static const int positions[] = {
	78	1, 3, 7, 9, 15, 17, 19, 23, 31, 39, 41, 45, 49, 53,
	79	55, 57, 59, 63, 67, 69, 73, 79, 83, 89, 97, 99, 109,
	80	111, 113, 119, 121, 127,
	81	};
	82
	83	size_t i;
	84	uint8_t csum_calc, csum_recv;
	85
	86	if (len != UM_POLL_LEN)
	87	return FALSE;
	88
	89	csum_calc = 0;
	90	for (i = 0; i < ARRAY_SIZE(positions); i++)
	91	csum_calc ^= buf[positions[i]];
	92	csum_recv = read_u8(&buf[len - sizeof(uint8_t)]);
	93	if (csum_recv != csum_calc)
	94	return FALSE;
	95
	96	return TRUE;
	97	}
	98
	99	static const struct rdtech_um_profile um_profiles[] = {
	100	{ "UM24C", RDTECH_UM24C, rdtech_default_channels, csum_ok_fff1, },
	101	{ "UM25C", RDTECH_UM25C, rdtech_um25c_channels, csum_ok_fff1, },
	102	{ "UM34C", RDTECH_UM34C, rdtech_default_channels, csum_ok_um34c, },
	103	};
	104
	105	static const struct rdtech_um_profile *find_profile(uint16_t id)
	106	{
	107	unsigned int i;
	108
	109	for (i = 0; i < ARRAY_SIZE(um_profiles); i++) {
	110	if (um_profiles[i].model_id == id)
	111	return &um_profiles[i];
	112	}
	113	return NULL;
	114	}
	115
	116	SR_PRIV const struct rdtech_um_profile rdtech_um_probe(struct sr_serial_dev_inst serial)
	117	{
	118	const struct rdtech_um_profile *p;
	119	uint8_t request;
	120	uint8_t buf[RDTECH_UM_BUFSIZE];
	121	int len;
	122
	123	request = UM_CMD_POLL;
	124	if (serial_write_blocking(serial, &request, sizeof(request),
	125	SERIAL_WRITE_TIMEOUT_MS) < 0) {
	126	sr_err("Unable to send probe request.");
	127	return NULL;
	128	}
	129
	130	len = serial_read_blocking(serial, buf, UM_POLL_LEN, UM_TIMEOUT_MS);
	131	if (len != UM_POLL_LEN) {
	132	sr_err("Failed to read probe response.");
	133	return NULL;
	134	}
	135
	136	p = find_profile(RB16(&buf[0]));
	137	if (!p) {
	138	sr_err("Unrecognized UM device (0x%.4" PRIx16 ")!", RB16(&buf[0]));
	139	return NULL;
	140	}
	141
	142	if (!p->csum_ok(buf, len)) {
	143	sr_err("Probe response contains illegal checksum or end marker.\n");
	144	return NULL;
	145	}
	146
	147	return p;
	148	}
	149
	150	SR_PRIV int rdtech_um_poll(const struct sr_dev_inst *sdi)
	151	{
	152	struct dev_context *devc;
	153	struct sr_serial_dev_inst *serial;
	154	uint8_t request;
	155
	156	serial = sdi->conn;
	157	request = UM_CMD_POLL;
	158	if (serial_write_blocking(serial, &request, sizeof(request),
	159	SERIAL_WRITE_TIMEOUT_MS) < 0) {
	160	sr_err("Unable to send poll request.");
	161	return SR_ERR;
	162	}
	163
	164	devc = sdi->priv;
	165	devc->cmd_sent_at = g_get_monotonic_time() / 1000;
	166
	167	return SR_OK;
	168	}
	169
	170	static void handle_poll_data(const struct sr_dev_inst *sdi)
	171	{
	172	struct dev_context *devc;
	173	int i;
	174	GSList *ch;
	175
	176	devc = sdi->priv;
	177	sr_spew("Received poll packet (len: %zu).", devc->buflen);
	178	if (devc->buflen != UM_POLL_LEN) {
	179	sr_err("Unexpected poll packet length: %zu", devc->buflen);
	180	return;
	181	}
	182
	183	for (ch = sdi->channels, i = 0; ch; ch = g_slist_next(ch), i++) {
	184	bv_send_analog_channel(sdi, ch->data,
	185	&devc->profile->channels[i],
	186	devc->buf, devc->buflen);
	187	}
	188
	189	sr_sw_limits_update_samples_read(&devc->limits, 1);
	190	}
	191
	192	static void recv_poll_data(struct sr_dev_inst sdi, struct sr_serial_dev_inst serial)
	193	{
	194	struct dev_context *devc;
	195	const struct rdtech_um_profile *p;
	196	int len;
	197
	198	/* Serial data arrived. */
	199	devc = sdi->priv;
	200	p = devc->profile;
	201	while (devc->buflen < UM_POLL_LEN) {
	202	len = serial_read_nonblocking(serial, devc->buf + devc->buflen, 1);
	203	if (len < 1)
	204	return;
	205
	206	devc->buflen++;
	207
	208	/* Check if the poll model ID matches the profile. */
	209	if (devc->buflen == 2 && RB16(devc->buf) != p->model_id) {
	210	sr_warn("Illegal model ID in poll response (0x%.4" PRIx16 "),"
	211	" skipping 1 byte.",
	212	RB16(devc->buf));
	213	devc->buflen--;
	214	memmove(devc->buf, devc->buf + 1, devc->buflen);
	215	}
	216	}
	217
	218	if (devc->buflen == UM_POLL_LEN && p->csum_ok(devc->buf, devc->buflen))
	219	handle_poll_data(sdi);
	220	else
	221	sr_warn("Skipping packet with illegal checksum / end marker.");
	222
	223	devc->buflen = 0;
	224	}
	225
	226	SR_PRIV int rdtech_um_receive_data(int fd, int revents, void *cb_data)
	227	{
	228	struct sr_dev_inst *sdi;
	229	struct dev_context *devc;
	230	struct sr_serial_dev_inst *serial;
	231	int64_t now, elapsed;
	232
	233	(void)fd;
	234
	235	if (!(sdi = cb_data))
	236	return TRUE;
	237
	238	if (!(devc = sdi->priv))
	239	return TRUE;
	240
	241	serial = sdi->conn;
	242	if (revents == G_IO_IN)
	243	recv_poll_data(sdi, serial);
	244
	245	if (sr_sw_limits_check(&devc->limits)) {
	246	sr_dev_acquisition_stop(sdi);
	247	return TRUE;
	248	}
	249
	250	now = g_get_monotonic_time() / 1000;
	251	elapsed = now - devc->cmd_sent_at;
	252
	253	if (elapsed > UM_POLL_PERIOD_MS)
	254	rdtech_um_poll(sdi);
	255
	256	return TRUE;
	257	}