[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 int poll_csum_fff1(char buf[], int len)
{
	if (len != UM_POLL_LEN)
		return 0;
	else
		return RB16(&buf[len - 2]) == 0xFFF1;
}

static int poll_csum_um34c(char buf[], int 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,
	};
	unsigned int i;
	uint8_t csum = 0;

	if (len != UM_POLL_LEN)
		return 0;

	for (i = 0; i < ARRAY_SIZE(positions); i++)
		csum ^= buf[positions[i]];

	return csum == (uint8_t)buf[len - 1];
}

static const struct rdtech_um_profile um_profiles[] = {
	{ "UM24C", RDTECH_UM24C, rdtech_default_channels, &poll_csum_fff1, },
	{ "UM25C", RDTECH_UM25C, rdtech_um25c_channels, &poll_csum_fff1, },
	{ "UM34C", RDTECH_UM34C, rdtech_default_channels, &poll_csum_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;
	static const uint8_t request = UM_CMD_POLL;
	char buf[RDTECH_UM_BUFSIZE];
	int len;

	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->poll_csum(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 = sdi->priv;
	struct sr_serial_dev_inst *serial = sdi->conn;
	static const uint8_t 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 = g_get_monotonic_time() / 1000;

	return SR_OK;
}

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

	sr_spew("Received poll packet (len: %d).", devc->buflen);
	if (devc->buflen != UM_POLL_LEN) {
		sr_err("Unexpected poll packet length: %i", 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 = sdi->priv;
	const struct rdtech_um_profile *p = devc->profile;
	int len;

	/* Serial data arrived. */
	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->poll_csum(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
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	};
	60
	61	static int poll_csum_fff1(char buf[], int len)
	62	{
	63	if (len != UM_POLL_LEN)
	64	return 0;
	65	else
	66	return RB16(&buf[len - 2]) == 0xFFF1;
	67	}
	68
	69	static int poll_csum_um34c(char buf[], int len)
	70	{
	71	static const int positions[] = {
	72	1, 3, 7, 9, 15, 17, 19, 23, 31, 39, 41, 45, 49, 53,
	73	55, 57, 59, 63, 67, 69, 73, 79, 83, 89, 97, 99, 109,
	74	111, 113, 119, 121, 127,
	75	};
	76	unsigned int i;
	77	uint8_t csum = 0;
	78
	79	if (len != UM_POLL_LEN)
	80	return 0;
	81
	82	for (i = 0; i < ARRAY_SIZE(positions); i++)
	83	csum ^= buf[positions[i]];
	84
	85	return csum == (uint8_t)buf[len - 1];
	86	}
	87
	88	static const struct rdtech_um_profile um_profiles[] = {
	89	{ "UM24C", RDTECH_UM24C, rdtech_default_channels, &poll_csum_fff1, },
	90	{ "UM25C", RDTECH_UM25C, rdtech_um25c_channels, &poll_csum_fff1, },
	91	{ "UM34C", RDTECH_UM34C, rdtech_default_channels, &poll_csum_um34c, },
	92	};
	93
	94	static const struct rdtech_um_profile *find_profile(uint16_t id)
	95	{
	96	unsigned int i;
	97	for (i = 0; i < ARRAY_SIZE(um_profiles); i++) {
	98	if (um_profiles[i].model_id == id)
	99	return &um_profiles[i];
	100	}
	101	return NULL;
	102	}
	103
	104	SR_PRIV const struct rdtech_um_profile rdtech_um_probe(struct sr_serial_dev_inst serial)
	105	{
	106	const struct rdtech_um_profile *p;
	107	static const uint8_t request = UM_CMD_POLL;
	108	char buf[RDTECH_UM_BUFSIZE];
	109	int len;
	110
	111	if (serial_write_blocking(serial, &request, sizeof(request),
323b32f4	112	SERIAL_WRITE_TIMEOUT_MS) < 0) {
8b607a24 AS	113	sr_err("Unable to send probe request.");
	114	return NULL;
	115	}
	116
	117	len = serial_read_blocking(serial, buf, UM_POLL_LEN, UM_TIMEOUT_MS);
	118	if (len != UM_POLL_LEN) {
	119	sr_err("Failed to read probe response.");
	120	return NULL;
	121	}
	122
	123	p = find_profile(RB16(&buf[0]));
	124	if (!p) {
	125	sr_err("Unrecognized UM device (0x%.4" PRIx16 ")!", RB16(&buf[0]));
	126	return NULL;
	127	}
	128
	129	if (!p->poll_csum(buf, len)) {
	130	sr_err("Probe response contains illegal checksum or end marker.\n");
	131	return NULL;
	132	}
	133
	134	return p;
	135	}
	136
	137	SR_PRIV int rdtech_um_poll(const struct sr_dev_inst *sdi)
	138	{
	139	struct dev_context *devc = sdi->priv;
	140	struct sr_serial_dev_inst *serial = sdi->conn;
	141	static const uint8_t request = UM_CMD_POLL;
	142
	143	if (serial_write_blocking(serial, &request, sizeof(request),
323b32f4	144	SERIAL_WRITE_TIMEOUT_MS) < 0) {
8b607a24 AS	145	sr_err("Unable to send poll request.");
	146	return SR_ERR;
	147	}
	148
	149	devc->cmd_sent_at = g_get_monotonic_time() / 1000;
	150
	151	return SR_OK;
	152	}
	153
	154	static void handle_poll_data(const struct sr_dev_inst *sdi)
	155	{
	156	struct dev_context *devc = sdi->priv;
	157	int i;
	158	GSList *ch;
	159
	160	sr_spew("Received poll packet (len: %d).", devc->buflen);
	161	if (devc->buflen != UM_POLL_LEN) {
	162	sr_err("Unexpected poll packet length: %i", devc->buflen);
	163	return;
	164	}
	165
323b32f4	166	for (ch = sdi->channels, i = 0; ch; ch = g_slist_next(ch), i++) {
8b607a24	167	bv_send_analog_channel(sdi, ch->data,
323b32f4 GS	168	&devc->profile->channels[i],
	169	devc->buf, devc->buflen);
	170	}
8b607a24 AS	171
	172	sr_sw_limits_update_samples_read(&devc->limits, 1);
	173	}
	174
	175	static void recv_poll_data(struct sr_dev_inst sdi, struct sr_serial_dev_inst serial)
	176	{
	177	struct dev_context *devc = sdi->priv;
	178	const struct rdtech_um_profile *p = devc->profile;
	179	int len;
	180
	181	/* Serial data arrived. */
	182	while (devc->buflen < UM_POLL_LEN) {
	183	len = serial_read_nonblocking(serial, devc->buf + devc->buflen, 1);
	184	if (len < 1)
	185	return;
	186
	187	devc->buflen++;
	188
	189	/* Check if the poll model ID matches the profile. */
	190	if (devc->buflen == 2 && RB16(devc->buf) != p->model_id) {
	191	sr_warn("Illegal model ID in poll response (0x%.4" PRIx16 "),"
	192	" skipping 1 byte.",
	193	RB16(devc->buf));
	194	devc->buflen--;
	195	memmove(devc->buf, devc->buf + 1, devc->buflen);
	196	}
	197	}
	198
	199	if (devc->buflen == UM_POLL_LEN && p->poll_csum(devc->buf, devc->buflen))
	200	handle_poll_data(sdi);
	201	else
	202	sr_warn("Skipping packet with illegal checksum / end marker.");
	203
	204	devc->buflen = 0;
	205	}
	206
	207	SR_PRIV int rdtech_um_receive_data(int fd, int revents, void *cb_data)
	208	{
	209	struct sr_dev_inst *sdi;
	210	struct dev_context *devc;
	211	struct sr_serial_dev_inst *serial;
	212	int64_t now, elapsed;
	213
	214	(void)fd;
	215
	216	if (!(sdi = cb_data))
	217	return TRUE;
	218
	219	if (!(devc = sdi->priv))
	220	return TRUE;
	221
	222	serial = sdi->conn;
	223	if (revents == G_IO_IN)
	224	recv_poll_data(sdi, serial);
	225
	226	if (sr_sw_limits_check(&devc->limits)) {
	227	sr_dev_acquisition_stop(sdi);
	228	return TRUE;
	229	}
	230
	231	now = g_get_monotonic_time() / 1000;
	232	elapsed = now - devc->cmd_sent_at;
	233
	234	if (elapsed > UM_POLL_PERIOD_MS)
235	rdtech_um_poll(sdi);
236
237	return TRUE;
238	}