[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"

/* Read/write timeouts, poll request intervals. */
#define PROBE_TO_MS 1000
#define WRITE_TO_MS 1
#define POLL_PERIOD_MS 100

/* Expected receive data size for poll responses. */
#define POLL_RECV_LEN 130

/* Command code to request another poll response. */
#define UM_CMD_POLL 0xf0

static const struct binary_analog_channel 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 },
};

static const struct binary_analog_channel 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 },
};

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

	if (len != POLL_RECV_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 != POLL_RECV_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, ARRAY_AND_SIZE(default_channels), csum_ok_fff1, },
	{ "UM25C", RDTECH_UM25C, ARRAY_AND_SIZE(um25c_channels), csum_ok_fff1, },
	{ "UM34C", RDTECH_UM34C, ARRAY_AND_SIZE(default_channels), csum_ok_um34c, },
};

static const struct rdtech_um_profile *find_profile(uint16_t id)
{
	size_t i;
	const struct rdtech_um_profile *profile;

	for (i = 0; i < ARRAY_SIZE(um_profiles); i++) {
		profile = &um_profiles[i];
		if (profile->model_id == id)
			return profile;
	}
	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 req;
	int ret;
	uint8_t buf[RDTECH_UM_BUFSIZE];
	int rcvd;
	uint16_t model_id;

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

	rcvd = serial_read_blocking(serial, buf, POLL_RECV_LEN, PROBE_TO_MS);
	if (rcvd != POLL_RECV_LEN) {
		sr_err("Failed to read probe response.");
		return NULL;
	}

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

	if (!p->csum_ok(buf, rcvd)) {
		sr_err("Probe response fails checksum verification.");
		return NULL;
	}

	return p;
}

SR_PRIV int rdtech_um_poll(const struct sr_dev_inst *sdi, gboolean force)
{
	struct dev_context *devc;
	int64_t now, elapsed;
	struct sr_serial_dev_inst *serial;
	uint8_t req;
	int ret;

	/* Check for expired intervals or forced requests. */
	devc = sdi->priv;
	now = g_get_monotonic_time() / 1000;
	elapsed = now - devc->cmd_sent_at;
	if (!force && elapsed < POLL_PERIOD_MS)
		return SR_OK;

	/* Send another poll request. Update interval only on success. */
	serial = sdi->conn;
	req = UM_CMD_POLL;
	ret = serial_write_blocking(serial, &req, sizeof(req), WRITE_TO_MS);
	if (ret < 0) {
		sr_err("Unable to send poll request.");
		return SR_ERR;
	}
	devc->cmd_sent_at = now;

	return SR_OK;
}

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

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

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

	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 < POLL_RECV_LEN) {
		len = serial_read_nonblocking(serial, devc->buf + devc->buflen, 1);
		if (len < 1)
			return;
		devc->buflen += len;

		/* 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 != POLL_RECV_LEN)
		sr_warn("Skipping packet, unexpected receive length.");
	else if (!p->csum_ok(devc->buf, devc->buflen))
		sr_warn("Skipping packet, checksum verification failed.");
	else
		handle_poll_data(sdi);
	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;

	(void)fd;

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

	/* Drain and process receive data as it becomes available. */
	serial = sdi->conn;
	if (revents == G_IO_IN)
		recv_poll_data(sdi, serial);

	/* Check configured acquisition limits. */
	if (sr_sw_limits_check(&devc->limits)) {
		sr_dev_acquisition_stop(sdi);
		return TRUE;
	}

	/* Periodically emit measurement requests. */
	(void)rdtech_um_poll(sdi, FALSE);

	return TRUE;
}
Commit	Line	Data
8b607a24 AS	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>
dca972f8	21
8b607a24 AS	22	#include <glib.h>
8b607a24 AS	23	#include <libsigrok/libsigrok.h>
dca972f8 GS	24	#include <math.h>
	25	#include <stdlib.h>
	26	#include <string.h>
	27
8b607a24 AS	28	#include "libsigrok-internal.h"
	29	#include "protocol.h"
	30
ae33433b GS	31	/* Read/write timeouts, poll request intervals. */
	32	#define PROBE_TO_MS 1000
	33	#define WRITE_TO_MS 1
	34	#define POLL_PERIOD_MS 100
8b607a24	35
ae33433b GS	36	/* Expected receive data size for poll responses. */
ae33433b GS	37	#define POLL_RECV_LEN 130
8b607a24	38
ae33433b	39	/* Command code to request another poll response. */
8b607a24 AS	40	#define UM_CMD_POLL 0xf0
8b607a24 AS	41
7cfa93b0	42	static const struct binary_analog_channel default_channels[] = {
323b32f4 GS	43	{ "V", { 2, BVT_BE_UINT16, 0.01, }, 2, SR_MQ_VOLTAGE, SR_UNIT_VOLT },
323b32f4 GS	44	{ "I", { 4, BVT_BE_UINT16, 0.001, }, 3, SR_MQ_CURRENT, SR_UNIT_AMPERE },
8b607a24 AS	45	{ "D+", { 96, BVT_BE_UINT16, 0.01, }, 2, SR_MQ_VOLTAGE, SR_UNIT_VOLT },
8b607a24 AS	46	{ "D-", { 98, BVT_BE_UINT16, 0.01, }, 2, SR_MQ_VOLTAGE, SR_UNIT_VOLT },
323b32f4	47	{ "T", { 10, BVT_BE_UINT16, 1.0, }, 0, SR_MQ_TEMPERATURE, SR_UNIT_CELSIUS },
8b607a24 AS	48	/* Threshold-based recording (mWh) */
8b607a24 AS	49	{ "E", { 106, BVT_BE_UINT32, 0.001, }, 3, SR_MQ_ENERGY, SR_UNIT_WATT_HOUR },
8b607a24 AS	50	};
8b607a24 AS	51
7cfa93b0	52	static const struct binary_analog_channel um25c_channels[] = {
238a6ef2 GS	53	{ "V", { 2, BVT_BE_UINT16, 0.001, }, 3, SR_MQ_VOLTAGE, SR_UNIT_VOLT },
238a6ef2 GS	54	{ "I", { 4, BVT_BE_UINT16, 0.0001, }, 4, SR_MQ_CURRENT, SR_UNIT_AMPERE },
8b607a24 AS	55	{ "D+", { 96, BVT_BE_UINT16, 0.01, }, 2, SR_MQ_VOLTAGE, SR_UNIT_VOLT },
	56	{ "D-", { 98, BVT_BE_UINT16, 0.01, }, 2, SR_MQ_VOLTAGE, SR_UNIT_VOLT },
	57	{ "T", { 10, BVT_BE_UINT16, 1.0, }, 0, SR_MQ_TEMPERATURE, SR_UNIT_CELSIUS },
	58	/* Threshold-based recording (mWh) */
	59	{ "E", { 106, BVT_BE_UINT32, 0.001, }, 3, SR_MQ_ENERGY, SR_UNIT_WATT_HOUR },
8b607a24 AS	60	};
8b607a24 AS	61
85accbc2	62	static gboolean csum_ok_fff1(const uint8_t *buf, size_t len)
8b607a24	63	{
85accbc2 GS	64	uint16_t csum_recv;
85accbc2 GS	65
ae33433b	66	if (len != POLL_RECV_LEN)
85accbc2 GS	67	return FALSE;
	68
	69	csum_recv = read_u16be(&buf[len - sizeof(uint16_t)]);
	70	if (csum_recv != 0xfff1)
	71	return FALSE;
	72
	73	return TRUE;
8b607a24 AS	74	}
8b607a24 AS	75
85accbc2	76	static gboolean csum_ok_um34c(const uint8_t *buf, size_t len)
8b607a24 AS	77	{
	78	static const int positions[] = {
	79	1, 3, 7, 9, 15, 17, 19, 23, 31, 39, 41, 45, 49, 53,
	80	55, 57, 59, 63, 67, 69, 73, 79, 83, 89, 97, 99, 109,
	81	111, 113, 119, 121, 127,
	82	};
fda34e5a	83
85accbc2 GS	84	size_t i;
85accbc2 GS	85	uint8_t csum_calc, csum_recv;
8b607a24	86
ae33433b	87	if (len != POLL_RECV_LEN)
85accbc2	88	return FALSE;
8b607a24	89
85accbc2	90	csum_calc = 0;
8b607a24	91	for (i = 0; i < ARRAY_SIZE(positions); i++)
85accbc2 GS	92	csum_calc ^= buf[positions[i]];
	93	csum_recv = read_u8(&buf[len - sizeof(uint8_t)]);
	94	if (csum_recv != csum_calc)
	95	return FALSE;
8b607a24	96
85accbc2	97	return TRUE;
8b607a24 AS	98	}
	99
	100	static const struct rdtech_um_profile um_profiles[] = {
7cfa93b0 GS	101	{ "UM24C", RDTECH_UM24C, ARRAY_AND_SIZE(default_channels), csum_ok_fff1, },
	102	{ "UM25C", RDTECH_UM25C, ARRAY_AND_SIZE(um25c_channels), csum_ok_fff1, },
	103	{ "UM34C", RDTECH_UM34C, ARRAY_AND_SIZE(default_channels), csum_ok_um34c, },
8b607a24 AS	104	};
	105
	106	static const struct rdtech_um_profile *find_profile(uint16_t id)
	107	{
4441e573 GS	108	size_t i;
4441e573 GS	109	const struct rdtech_um_profile *profile;
fda34e5a	110
8b607a24	111	for (i = 0; i < ARRAY_SIZE(um_profiles); i++) {
4441e573 GS	112	profile = &um_profiles[i];
	113	if (profile->model_id == id)
	114	return profile;
8b607a24 AS	115	}
	116	return NULL;
	117	}
	118
	119	SR_PRIV const struct rdtech_um_profile rdtech_um_probe(struct sr_serial_dev_inst serial)
	120	{
	121	const struct rdtech_um_profile *p;
ae33433b GS	122	uint8_t req;
ae33433b GS	123	int ret;
85accbc2	124	uint8_t buf[RDTECH_UM_BUFSIZE];
4441e573	125	int rcvd;
bcbf2b59	126	uint16_t model_id;
8b607a24	127
ae33433b GS	128	req = UM_CMD_POLL;
	129	ret = serial_write_blocking(serial, &req, sizeof(req), WRITE_TO_MS);
	130	if (ret < 0) {
	131	sr_err("Failed to send probe request.");
8b607a24 AS	132	return NULL;
	133	}
	134
ae33433b GS	135	rcvd = serial_read_blocking(serial, buf, POLL_RECV_LEN, PROBE_TO_MS);
ae33433b GS	136	if (rcvd != POLL_RECV_LEN) {
8b607a24 AS	137	sr_err("Failed to read probe response.");
	138	return NULL;
	139	}
	140
bcbf2b59 GS	141	model_id = read_u16be(&buf[0]);
bcbf2b59 GS	142	p = find_profile(model_id);
8b607a24	143	if (!p) {
bcbf2b59	144	sr_err("Unrecognized UM device (0x%.4" PRIx16 ").", model_id);
8b607a24 AS	145	return NULL;
	146	}
	147
4441e573	148	if (!p->csum_ok(buf, rcvd)) {
bcbf2b59	149	sr_err("Probe response fails checksum verification.");
8b607a24 AS	150	return NULL;
	151	}
	152
	153	return p;
	154	}
	155
c1f4f589	156	SR_PRIV int rdtech_um_poll(const struct sr_dev_inst *sdi, gboolean force)
8b607a24	157	{
fda34e5a	158	struct dev_context *devc;
c1f4f589	159	int64_t now, elapsed;
fda34e5a	160	struct sr_serial_dev_inst *serial;
ae33433b GS	161	uint8_t req;
ae33433b GS	162	int ret;
8b607a24	163
c1f4f589 GS	164	/* Check for expired intervals or forced requests. */
	165	devc = sdi->priv;
	166	now = g_get_monotonic_time() / 1000;
	167	elapsed = now - devc->cmd_sent_at;
ae33433b	168	if (!force && elapsed < POLL_PERIOD_MS)
c1f4f589 GS	169	return SR_OK;
	170
	171	/* Send another poll request. Update interval only on success. */
fda34e5a	172	serial = sdi->conn;
ae33433b GS	173	req = UM_CMD_POLL;
	174	ret = serial_write_blocking(serial, &req, sizeof(req), WRITE_TO_MS);
	175	if (ret < 0) {
8b607a24 AS	176	sr_err("Unable to send poll request.");
	177	return SR_ERR;
	178	}
c1f4f589	179	devc->cmd_sent_at = now;
8b607a24 AS	180
	181	return SR_OK;
	182	}
	183
	184	static void handle_poll_data(const struct sr_dev_inst *sdi)
	185	{
fda34e5a	186	struct dev_context *devc;
4441e573	187	size_t ch_idx;
8b607a24 AS	188	GSList *ch;
8b607a24 AS	189
fda34e5a	190	devc = sdi->priv;
85accbc2	191	sr_spew("Received poll packet (len: %zu).", devc->buflen);
ae33433b	192	if (devc->buflen != POLL_RECV_LEN) {
85accbc2	193	sr_err("Unexpected poll packet length: %zu", devc->buflen);
8b607a24 AS	194	return;
	195	}
	196
4441e573 GS	197	ch_idx = 0;
4441e573 GS	198	for (ch = sdi->channels; ch; ch = g_slist_next(ch)) {
8b607a24	199	bv_send_analog_channel(sdi, ch->data,
4441e573	200	&devc->profile->channels[ch_idx],
323b32f4	201	devc->buf, devc->buflen);
4441e573	202	ch_idx++;
323b32f4	203	}
8b607a24 AS	204
	205	sr_sw_limits_update_samples_read(&devc->limits, 1);
	206	}
	207
	208	static void recv_poll_data(struct sr_dev_inst sdi, struct sr_serial_dev_inst serial)
	209	{
fda34e5a GS	210	struct dev_context *devc;
fda34e5a GS	211	const struct rdtech_um_profile *p;
8b607a24 AS	212	int len;
	213
	214	/* Serial data arrived. */
fda34e5a GS	215	devc = sdi->priv;
fda34e5a GS	216	p = devc->profile;
ae33433b	217	while (devc->buflen < POLL_RECV_LEN) {
8b607a24 AS	218	len = serial_read_nonblocking(serial, devc->buf + devc->buflen, 1);
	219	if (len < 1)
	220	return;
bcbf2b59	221	devc->buflen += len;
8b607a24 AS	222
	223	/* Check if the poll model ID matches the profile. */
	224	if (devc->buflen == 2 && RB16(devc->buf) != p->model_id) {
	225	sr_warn("Illegal model ID in poll response (0x%.4" PRIx16 "),"
	226	" skipping 1 byte.",
	227	RB16(devc->buf));
	228	devc->buflen--;
	229	memmove(devc->buf, devc->buf + 1, devc->buflen);
	230	}
	231	}
	232
ae33433b	233	if (devc->buflen != POLL_RECV_LEN)
bcbf2b59 GS	234	sr_warn("Skipping packet, unexpected receive length.");
	235	else if (!p->csum_ok(devc->buf, devc->buflen))
	236	sr_warn("Skipping packet, checksum verification failed.");
8b607a24	237	else
bcbf2b59	238	handle_poll_data(sdi);
8b607a24 AS	239	devc->buflen = 0;
	240	}
	241
	242	SR_PRIV int rdtech_um_receive_data(int fd, int revents, void *cb_data)
	243	{
	244	struct sr_dev_inst *sdi;
	245	struct dev_context *devc;
	246	struct sr_serial_dev_inst *serial;
8b607a24 AS	247
	248	(void)fd;
	249
	250	if (!(sdi = cb_data))
	251	return TRUE;
8b607a24 AS	252	if (!(devc = sdi->priv))
	253	return TRUE;
	254
ae33433b	255	/* Drain and process receive data as it becomes available. */
8b607a24 AS	256	serial = sdi->conn;
	257	if (revents == G_IO_IN)
	258	recv_poll_data(sdi, serial);
	259
ae33433b	260	/* Check configured acquisition limits. */
8b607a24 AS	261	if (sr_sw_limits_check(&devc->limits)) {
	262	sr_dev_acquisition_stop(sdi);
	263	return TRUE;
	264	}
	265
ae33433b	266	/* Periodically emit measurement requests. */
c1f4f589	267	(void)rdtech_um_poll(sdi, FALSE);
8b607a24 AS	268
	269	return TRUE;
	270	}