[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;
	uint16_t model_id;

	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;
	}

	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, len)) {
		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 request;

	/* 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 < UM_POLL_PERIOD_MS)
		return SR_OK;

	/* Send another poll request. Update interval only on success. */
	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->cmd_sent_at = now;

	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 += 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 != UM_POLL_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;

	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;
	}

	(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
	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[] = {
323b32f4 GS	40	{ "V", { 2, BVT_BE_UINT16, 0.01, }, 2, SR_MQ_VOLTAGE, SR_UNIT_VOLT },
323b32f4 GS	41	{ "I", { 4, BVT_BE_UINT16, 0.001, }, 3, SR_MQ_CURRENT, SR_UNIT_AMPERE },
8b607a24 AS	42	{ "D+", { 96, BVT_BE_UINT16, 0.01, }, 2, SR_MQ_VOLTAGE, SR_UNIT_VOLT },
8b607a24 AS	43	{ "D-", { 98, BVT_BE_UINT16, 0.01, }, 2, SR_MQ_VOLTAGE, SR_UNIT_VOLT },
323b32f4	44	{ "T", { 10, BVT_BE_UINT16, 1.0, }, 0, SR_MQ_TEMPERATURE, SR_UNIT_CELSIUS },
8b607a24 AS	45	/* Threshold-based recording (mWh) */
8b607a24 AS	46	{ "E", { 106, BVT_BE_UINT32, 0.001, }, 3, SR_MQ_ENERGY, SR_UNIT_WATT_HOUR },
0988d4ae	47	ALL_ZERO,
8b607a24 AS	48	};
	49
	50	static const struct binary_analog_channel rdtech_um25c_channels[] = {
238a6ef2 GS	51	{ "V", { 2, BVT_BE_UINT16, 0.001, }, 3, SR_MQ_VOLTAGE, SR_UNIT_VOLT },
238a6ef2 GS	52	{ "I", { 4, BVT_BE_UINT16, 0.0001, }, 4, SR_MQ_CURRENT, SR_UNIT_AMPERE },
8b607a24 AS	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 },
0988d4ae	58	ALL_ZERO,
8b607a24 AS	59	};
8b607a24 AS	60
85accbc2	61	static gboolean csum_ok_fff1(const uint8_t *buf, size_t len)
8b607a24	62	{
85accbc2 GS	63	uint16_t csum_recv;
85accbc2 GS	64
8b607a24	65	if (len != UM_POLL_LEN)
85accbc2 GS	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;
8b607a24 AS	73	}
8b607a24 AS	74
85accbc2	75	static gboolean csum_ok_um34c(const uint8_t *buf, size_t len)
8b607a24 AS	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	};
fda34e5a	82
85accbc2 GS	83	size_t i;
85accbc2 GS	84	uint8_t csum_calc, csum_recv;
8b607a24 AS	85
8b607a24 AS	86	if (len != UM_POLL_LEN)
85accbc2	87	return FALSE;
8b607a24	88
85accbc2	89	csum_calc = 0;
8b607a24	90	for (i = 0; i < ARRAY_SIZE(positions); i++)
85accbc2 GS	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;
8b607a24	95
85accbc2	96	return TRUE;
8b607a24 AS	97	}
	98
	99	static const struct rdtech_um_profile um_profiles[] = {
85accbc2 GS	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, },
8b607a24 AS	103	};
	104
	105	static const struct rdtech_um_profile *find_profile(uint16_t id)
	106	{
	107	unsigned int i;
fda34e5a	108
8b607a24 AS	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;
fda34e5a	119	uint8_t request;
85accbc2	120	uint8_t buf[RDTECH_UM_BUFSIZE];
8b607a24	121	int len;
bcbf2b59	122	uint16_t model_id;
8b607a24	123
fda34e5a	124	request = UM_CMD_POLL;
8b607a24	125	if (serial_write_blocking(serial, &request, sizeof(request),
323b32f4	126	SERIAL_WRITE_TIMEOUT_MS) < 0) {
8b607a24 AS	127	sr_err("Unable to send probe request.");
	128	return NULL;
	129	}
	130
	131	len = serial_read_blocking(serial, buf, UM_POLL_LEN, UM_TIMEOUT_MS);
	132	if (len != UM_POLL_LEN) {
	133	sr_err("Failed to read probe response.");
	134	return NULL;
	135	}
	136
bcbf2b59 GS	137	model_id = read_u16be(&buf[0]);
bcbf2b59 GS	138	p = find_profile(model_id);
8b607a24	139	if (!p) {
bcbf2b59	140	sr_err("Unrecognized UM device (0x%.4" PRIx16 ").", model_id);
8b607a24 AS	141	return NULL;
	142	}
	143
85accbc2	144	if (!p->csum_ok(buf, len)) {
bcbf2b59	145	sr_err("Probe response fails checksum verification.");
8b607a24 AS	146	return NULL;
	147	}
	148
	149	return p;
	150	}
	151
c1f4f589	152	SR_PRIV int rdtech_um_poll(const struct sr_dev_inst *sdi, gboolean force)
8b607a24	153	{
fda34e5a	154	struct dev_context *devc;
c1f4f589	155	int64_t now, elapsed;
fda34e5a GS	156	struct sr_serial_dev_inst *serial;
fda34e5a GS	157	uint8_t request;
8b607a24	158
c1f4f589 GS	159	/* Check for expired intervals or forced requests. */
	160	devc = sdi->priv;
	161	now = g_get_monotonic_time() / 1000;
	162	elapsed = now - devc->cmd_sent_at;
	163	if (!force && elapsed < UM_POLL_PERIOD_MS)
	164	return SR_OK;
	165
	166	/* Send another poll request. Update interval only on success. */
fda34e5a GS	167	serial = sdi->conn;
fda34e5a GS	168	request = UM_CMD_POLL;
8b607a24	169	if (serial_write_blocking(serial, &request, sizeof(request),
323b32f4	170	SERIAL_WRITE_TIMEOUT_MS) < 0) {
8b607a24 AS	171	sr_err("Unable to send poll request.");
	172	return SR_ERR;
	173	}
c1f4f589	174	devc->cmd_sent_at = now;
8b607a24 AS	175
	176	return SR_OK;
	177	}
	178
	179	static void handle_poll_data(const struct sr_dev_inst *sdi)
	180	{
fda34e5a	181	struct dev_context *devc;
8b607a24 AS	182	int i;
	183	GSList *ch;
	184
fda34e5a	185	devc = sdi->priv;
85accbc2	186	sr_spew("Received poll packet (len: %zu).", devc->buflen);
8b607a24	187	if (devc->buflen != UM_POLL_LEN) {
85accbc2	188	sr_err("Unexpected poll packet length: %zu", devc->buflen);
8b607a24 AS	189	return;
	190	}
	191
323b32f4	192	for (ch = sdi->channels, i = 0; ch; ch = g_slist_next(ch), i++) {
8b607a24	193	bv_send_analog_channel(sdi, ch->data,
323b32f4 GS	194	&devc->profile->channels[i],
	195	devc->buf, devc->buflen);
	196	}
8b607a24 AS	197
	198	sr_sw_limits_update_samples_read(&devc->limits, 1);
	199	}
	200
	201	static void recv_poll_data(struct sr_dev_inst sdi, struct sr_serial_dev_inst serial)
	202	{
fda34e5a GS	203	struct dev_context *devc;
fda34e5a GS	204	const struct rdtech_um_profile *p;
8b607a24 AS	205	int len;
	206
	207	/* Serial data arrived. */
fda34e5a GS	208	devc = sdi->priv;
fda34e5a GS	209	p = devc->profile;
8b607a24 AS	210	while (devc->buflen < UM_POLL_LEN) {
	211	len = serial_read_nonblocking(serial, devc->buf + devc->buflen, 1);
	212	if (len < 1)
	213	return;
bcbf2b59	214	devc->buflen += len;
8b607a24 AS	215
	216	/* Check if the poll model ID matches the profile. */
	217	if (devc->buflen == 2 && RB16(devc->buf) != p->model_id) {
	218	sr_warn("Illegal model ID in poll response (0x%.4" PRIx16 "),"
	219	" skipping 1 byte.",
	220	RB16(devc->buf));
	221	devc->buflen--;
	222	memmove(devc->buf, devc->buf + 1, devc->buflen);
	223	}
	224	}
	225
bcbf2b59 GS	226	if (devc->buflen != UM_POLL_LEN)
	227	sr_warn("Skipping packet, unexpected receive length.");
	228	else if (!p->csum_ok(devc->buf, devc->buflen))
	229	sr_warn("Skipping packet, checksum verification failed.");
8b607a24	230	else
bcbf2b59	231	handle_poll_data(sdi);
8b607a24 AS	232	devc->buflen = 0;
	233	}
	234
	235	SR_PRIV int rdtech_um_receive_data(int fd, int revents, void *cb_data)
	236	{
	237	struct sr_dev_inst *sdi;
	238	struct dev_context *devc;
	239	struct sr_serial_dev_inst *serial;
8b607a24 AS	240
	241	(void)fd;
	242
	243	if (!(sdi = cb_data))
	244	return TRUE;
	245
	246	if (!(devc = sdi->priv))
	247	return TRUE;
	248
	249	serial = sdi->conn;
	250	if (revents == G_IO_IN)
	251	recv_poll_data(sdi, serial);
	252
	253	if (sr_sw_limits_check(&devc->limits)) {
	254	sr_dev_acquisition_stop(sdi);
	255	return TRUE;
	256	}
	257
c1f4f589	258	(void)rdtech_um_poll(sdi, FALSE);
8b607a24 AS	259
	260	return TRUE;
	261	}