[libsigrok.git] / src / hardware / arachnid-labs-re-load-pro / protocol.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2015-2016 Uwe Hermann <uwe@hermann-uwe.de>
 *
 * 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 2 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, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 */

#include <config.h>
#include <string.h>
#include "protocol.h"

#define READ_TIMEOUT_MS 1000

static int send_cmd(const struct sr_dev_inst *sdi, const char *cmd,
		char *replybuf, int replybufsize)
{
	char *bufptr;
	int len, ret;
	struct sr_serial_dev_inst *serial;

	serial = sdi->conn;

	/* Send the command (blocking, with timeout). */
	if ((ret = serial_write_blocking(serial, cmd,
			strlen(cmd), serial_timeout(serial,
			strlen(cmd)))) < (int)strlen(cmd)) {
		sr_err("Unable to send command.");
		return SR_ERR;
	}

	/* Read the reply (blocking, with timeout). */
	memset(replybuf, 0, replybufsize);
	bufptr = replybuf;
	len = replybufsize;
	ret = serial_readline(serial, &bufptr, &len, READ_TIMEOUT_MS);

	/* If we got 0 characters (possibly one \r or \n), retry once. */
	if (len == 0) {
		len = replybufsize;
		ret = serial_readline(serial, &bufptr, &len, READ_TIMEOUT_MS);
	}

	if (g_str_has_prefix((const char *)&bufptr, "err ")) {
		sr_err("Device replied with an error: '%s'.", bufptr);
		return SR_ERR;
	}

	return ret;
}

SR_PRIV int reloadpro_set_current_limit(const struct sr_dev_inst *sdi,
					float current)
{
	int ret, ma;
	char buf[100];
	char *cmd;

	if (current < 0 || current > 6) {
		sr_err("The current limit must be 0-6 A (was %f A).", current);
		return SR_ERR_ARG;
	}

	/* Hardware expects current in mA, integer (0..6000). */
	ma = (int)(current * 1000);

	sr_err("Setting current limit to %f A (%d mA).", current, ma);

	cmd = g_strdup_printf("set %d\n", ma);
	if ((ret = send_cmd(sdi, cmd, (char *)&buf, sizeof(buf))) < 0) {
		sr_err("Error sending current limit command: %d.", ret);
		g_free(cmd);
		return SR_ERR;
	}
	g_free(cmd);

	return SR_OK;
}

SR_PRIV int reloadpro_set_on_off(const struct sr_dev_inst *sdi, gboolean on)
{
	int ret;
	char buf[100];
	const char *cmd;

	cmd = (on) ? "on\n" : "off\n";
	if ((ret = send_cmd(sdi, cmd, (char *)&buf, sizeof(buf))) < 0) {
		sr_err("Error sending on/off command: %d.", ret);
		return SR_ERR;
	}

	return SR_OK;
}

SR_PRIV int reloadpro_get_current_limit(const struct sr_dev_inst *sdi,
					float *current)
{
	int ret;
	char buf[100];

	if ((ret = send_cmd(sdi, "set\n", (char *)&buf, sizeof(buf))) < 0) {
		sr_err("Error sending current limit query: %d.", ret);
		return SR_ERR;
	}

	/* Hardware sends current in mA, integer (0..6000). */
	*current = g_ascii_strtod(buf + 4, NULL) / 1000;

	return SR_OK;
}

SR_PRIV int reloadpro_get_voltage_current(const struct sr_dev_inst *sdi,
		float *voltage, float *current)
{
	int ret;
	char buf[100];
	char **tokens;

	if ((ret = send_cmd(sdi, "read\n", (char *)&buf, sizeof(buf))) < 0) {
		sr_err("Error sending voltage/current query: %d.", ret);
		return SR_ERR;
	}

	/* Reply: "read <current> <voltage>". */
	tokens = g_strsplit((const char *)&buf, " ", 3);
	if (voltage)
		*voltage = g_ascii_strtod(tokens[2], NULL) / 1000;
	if (current)
		*current = g_ascii_strtod(tokens[1], NULL) / 1000;
	g_strfreev(tokens);

	return SR_OK;
}

static void handle_packet(const struct sr_dev_inst *sdi)
{
	float voltage, current;
	struct sr_datafeed_packet packet;
	struct sr_datafeed_analog analog;
	struct sr_analog_encoding encoding;
	struct sr_analog_meaning meaning;
	struct sr_analog_spec spec;
	struct dev_context *devc;
	char **tokens;
	GSList *l;

	devc = sdi->priv;

	if (g_str_has_prefix((const char *)devc->buf, "overtemp")) {
		sr_warn("Overtemperature condition!");
		devc->otp_active = TRUE;
		return;
	}

	if (g_str_has_prefix((const char *)devc->buf, "undervolt")) {
		sr_warn("Undervoltage condition!");
		devc->uvc_active = TRUE;
		return;
	}

	if (!g_str_has_prefix((const char *)devc->buf, "read ")) {
		sr_dbg("Unknown packet: '%s'.", devc->buf);
		return;
	}

	tokens = g_strsplit((const char *)devc->buf, " ", 3);
	voltage = g_ascii_strtod(tokens[2], NULL) / 1000;
	current = g_ascii_strtod(tokens[1], NULL) / 1000;
	g_strfreev(tokens);

	/* Begin frame. */
	packet.type = SR_DF_FRAME_BEGIN;
	packet.payload = NULL;
	sr_session_send(sdi, &packet);

	sr_analog_init(&analog, &encoding, &meaning, &spec, 4);

	packet.type = SR_DF_ANALOG;
	packet.payload = &analog;
	analog.num_samples = 1;

	/* Voltage */
	l = g_slist_copy(sdi->channels);
	l = g_slist_remove_link(l, g_slist_nth(l, 1));
	meaning.channels = l;
	meaning.mq = SR_MQ_VOLTAGE;
	meaning.mqflags = SR_MQFLAG_DC;
	meaning.unit = SR_UNIT_VOLT;
	analog.data = &voltage;
	sr_session_send(sdi, &packet);
	g_slist_free(l);

	/* Current */
	l = g_slist_copy(sdi->channels);
	l = g_slist_remove_link(l, g_slist_nth(l, 0));
	meaning.channels = l;
	meaning.mq = SR_MQ_CURRENT;
	meaning.mqflags = SR_MQFLAG_DC;
	meaning.unit = SR_UNIT_AMPERE;
	analog.data = &current;
	sr_session_send(sdi, &packet);
	g_slist_free(l);

	/* End frame. */
	packet.type = SR_DF_FRAME_END;
	packet.payload = NULL;
	sr_session_send(sdi, &packet);

	devc->num_samples++;
}

static void handle_new_data(const struct sr_dev_inst *sdi)
{
	int len;
	struct dev_context *devc;
	struct sr_serial_dev_inst *serial;

	devc = sdi->priv;
	serial = sdi->conn;

	/* Try to get as much data as the buffer can hold. */
	len = RELOADPRO_BUFSIZE - devc->buflen;
	len = serial_read_nonblocking(serial, devc->buf + devc->buflen, len);
	if (len == 0)
		return; /* No new bytes, nothing to do. */
	if (len < 0) {
		sr_err("Serial port read error: %d.", len);
		return;
	}
	devc->buflen += len;

	if (g_str_has_suffix((const char *)devc->buf, "\n")) {
		handle_packet(sdi);
		memset(devc->buf, 0, RELOADPRO_BUFSIZE);
		devc->buflen = 0;
	}
}

SR_PRIV int reloadpro_receive_data(int fd, int revents, void *cb_data)
{
	struct sr_dev_inst *sdi;
	struct dev_context *devc;
	int64_t t;

	(void)fd;

	sdi = cb_data;
	devc = sdi->priv;

	if (revents != G_IO_IN)
		return TRUE;

	handle_new_data(sdi);

	if (devc->limit_samples && (devc->num_samples >= devc->limit_samples)) {
		sr_info("Requested number of samples reached.");
		sdi->driver->dev_acquisition_stop(sdi);
		return TRUE;
	}

	if (devc->limit_msec) {
		t = (g_get_monotonic_time() - devc->starttime) / 1000;
		if (t > (int64_t)devc->limit_msec) {
			sr_info("Requested time limit reached.");
			sdi->driver->dev_acquisition_stop(sdi);
			return TRUE;
		}
	}

	return TRUE;
}
Commit	Line	Data
6e8d31d4 UH	1	/*
	2	* This file is part of the libsigrok project.
	3	*
803db07a	4	* Copyright (C) 2015-2016 Uwe Hermann <uwe@hermann-uwe.de>
6e8d31d4 UH	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 2 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, write to the Free Software
	18	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
	19	*/
	20
	21	#include <config.h>
803db07a	22	#include <string.h>
6e8d31d4 UH	23	#include "protocol.h"
6e8d31d4 UH	24
803db07a UH	25	#define READ_TIMEOUT_MS 1000
	26
	27	static int send_cmd(const struct sr_dev_inst sdi, const char cmd,
	28	char *replybuf, int replybufsize)
	29	{
	30	char *bufptr;
	31	int len, ret;
	32	struct sr_serial_dev_inst *serial;
	33
	34	serial = sdi->conn;
	35
	36	/* Send the command (blocking, with timeout). */
	37	if ((ret = serial_write_blocking(serial, cmd,
	38	strlen(cmd), serial_timeout(serial,
	39	strlen(cmd)))) < (int)strlen(cmd)) {
	40	sr_err("Unable to send command.");
	41	return SR_ERR;
	42	}
	43
	44	/* Read the reply (blocking, with timeout). */
	45	memset(replybuf, 0, replybufsize);
	46	bufptr = replybuf;
	47	len = replybufsize;
	48	ret = serial_readline(serial, &bufptr, &len, READ_TIMEOUT_MS);
	49
	50	/* If we got 0 characters (possibly one \r or \n), retry once. */
	51	if (len == 0) {
	52	len = replybufsize;
	53	ret = serial_readline(serial, &bufptr, &len, READ_TIMEOUT_MS);
	54	}
	55
	56	if (g_str_has_prefix((const char *)&bufptr, "err ")) {
	57	sr_err("Device replied with an error: '%s'.", bufptr);
	58	return SR_ERR;
	59	}
	60
	61	return ret;
	62	}
	63
	64	SR_PRIV int reloadpro_set_current_limit(const struct sr_dev_inst *sdi,
	65	float current)
	66	{
	67	int ret, ma;
	68	char buf[100];
	69	char *cmd;
	70
	71	if (current < 0 \|\| current > 6) {
	72	sr_err("The current limit must be 0-6 A (was %f A).", current);
	73	return SR_ERR_ARG;
	74	}
	75
	76	/* Hardware expects current in mA, integer (0..6000). */
	77	ma = (int)(current * 1000);
	78
	79	sr_err("Setting current limit to %f A (%d mA).", current, ma);
	80
	81	cmd = g_strdup_printf("set %d\n", ma);
	82	if ((ret = send_cmd(sdi, cmd, (char *)&buf, sizeof(buf))) < 0) {
	83	sr_err("Error sending current limit command: %d.", ret);
	84	g_free(cmd);
	85	return SR_ERR;
	86	}
	87	g_free(cmd);
	88
89	return SR_OK;
90	}
91
8501448c UH	92	SR_PRIV int reloadpro_set_on_off(const struct sr_dev_inst *sdi, gboolean on)
	93	{
	94	int ret;
	95	char buf[100];
	96	const char *cmd;
	97
	98	cmd = (on) ? "on\n" : "off\n";
	99	if ((ret = send_cmd(sdi, cmd, (char *)&buf, sizeof(buf))) < 0) {
	100	sr_err("Error sending on/off command: %d.", ret);
	101	return SR_ERR;
	102	}
	103
	104	return SR_OK;
	105	}
	106
803db07a UH	107	SR_PRIV int reloadpro_get_current_limit(const struct sr_dev_inst *sdi,
	108	float *current)
	109	{
	110	int ret;
	111	char buf[100];
	112
	113	if ((ret = send_cmd(sdi, "set\n", (char *)&buf, sizeof(buf))) < 0) {
	114	sr_err("Error sending current limit query: %d.", ret);
	115	return SR_ERR;
	116	}
	117
	118	/* Hardware sends current in mA, integer (0..6000). */
	119	*current = g_ascii_strtod(buf + 4, NULL) / 1000;
	120
	121	return SR_OK;
	122	}
	123
	124	SR_PRIV int reloadpro_get_voltage_current(const struct sr_dev_inst *sdi,
	125	float voltage, float current)
	126	{
	127	int ret;
	128	char buf[100];
	129	char **tokens;
	130
	131	if ((ret = send_cmd(sdi, "read\n", (char *)&buf, sizeof(buf))) < 0) {
	132	sr_err("Error sending voltage/current query: %d.", ret);
	133	return SR_ERR;
	134	}
	135
	136	/* Reply: "read <current> <voltage>". */
	137	tokens = g_strsplit((const char *)&buf, " ", 3);
	138	if (voltage)
	139	*voltage = g_ascii_strtod(tokens[2], NULL) / 1000;
	140	if (current)
	141	*current = g_ascii_strtod(tokens[1], NULL) / 1000;
	142	g_strfreev(tokens);
	143
	144	return SR_OK;
	145	}
	146
	147	static void handle_packet(const struct sr_dev_inst *sdi)
6e8d31d4	148	{
803db07a UH	149	float voltage, current;
803db07a UH	150	struct sr_datafeed_packet packet;
6e68da51 UH	151	struct sr_datafeed_analog analog;
	152	struct sr_analog_encoding encoding;
	153	struct sr_analog_meaning meaning;
	154	struct sr_analog_spec spec;
6e8d31d4	155	struct dev_context *devc;
803db07a UH	156	char **tokens;
	157	GSList *l;
	158
	159	devc = sdi->priv;
	160
	161	if (g_str_has_prefix((const char *)devc->buf, "overtemp")) {
2217be1d	162	sr_warn("Overtemperature condition!");
803db07a UH	163	devc->otp_active = TRUE;
	164	return;
	165	}
	166
2217be1d UH	167	if (g_str_has_prefix((const char *)devc->buf, "undervolt")) {
	168	sr_warn("Undervoltage condition!");
	169	devc->uvc_active = TRUE;
	170	return;
	171	}
	172
803db07a UH	173	if (!g_str_has_prefix((const char *)devc->buf, "read ")) {
	174	sr_dbg("Unknown packet: '%s'.", devc->buf);
	175	return;
	176	}
	177
	178	tokens = g_strsplit((const char *)devc->buf, " ", 3);
	179	voltage = g_ascii_strtod(tokens[2], NULL) / 1000;
	180	current = g_ascii_strtod(tokens[1], NULL) / 1000;
	181	g_strfreev(tokens);
	182
803db07a UH	183	/* Begin frame. */
803db07a UH	184	packet.type = SR_DF_FRAME_BEGIN;
6e68da51	185	packet.payload = NULL;
803db07a UH	186	sr_session_send(sdi, &packet);
803db07a UH	187
6e68da51 UH	188	sr_analog_init(&analog, &encoding, &meaning, &spec, 4);
	189
	190	packet.type = SR_DF_ANALOG;
803db07a UH	191	packet.payload = &analog;
	192	analog.num_samples = 1;
	193
	194	/* Voltage */
	195	l = g_slist_copy(sdi->channels);
	196	l = g_slist_remove_link(l, g_slist_nth(l, 1));
6e68da51 UH	197	meaning.channels = l;
	198	meaning.mq = SR_MQ_VOLTAGE;
	199	meaning.mqflags = SR_MQFLAG_DC;
	200	meaning.unit = SR_UNIT_VOLT;
803db07a UH	201	analog.data = &voltage;
	202	sr_session_send(sdi, &packet);
	203	g_slist_free(l);
	204
	205	/* Current */
	206	l = g_slist_copy(sdi->channels);
	207	l = g_slist_remove_link(l, g_slist_nth(l, 0));
6e68da51 UH	208	meaning.channels = l;
	209	meaning.mq = SR_MQ_CURRENT;
	210	meaning.mqflags = SR_MQFLAG_DC;
	211	meaning.unit = SR_UNIT_AMPERE;
803db07a UH	212	analog.data = &current;
	213	sr_session_send(sdi, &packet);
	214	g_slist_free(l);
	215
	216	/* End frame. */
	217	packet.type = SR_DF_FRAME_END;
6e68da51	218	packet.payload = NULL;
803db07a UH	219	sr_session_send(sdi, &packet);
	220
	221	devc->num_samples++;
	222	}
	223
	224	static void handle_new_data(const struct sr_dev_inst *sdi)
	225	{
	226	int len;
	227	struct dev_context *devc;
	228	struct sr_serial_dev_inst *serial;
	229
	230	devc = sdi->priv;
	231	serial = sdi->conn;
	232
	233	/* Try to get as much data as the buffer can hold. */
	234	len = RELOADPRO_BUFSIZE - devc->buflen;
	235	len = serial_read_nonblocking(serial, devc->buf + devc->buflen, len);
	236	if (len == 0)
	237	return; /* No new bytes, nothing to do. */
	238	if (len < 0) {
	239	sr_err("Serial port read error: %d.", len);
	240	return;
	241	}
	242	devc->buflen += len;
	243
	244	if (g_str_has_suffix((const char *)devc->buf, "\n")) {
	245	handle_packet(sdi);
	246	memset(devc->buf, 0, RELOADPRO_BUFSIZE);
	247	devc->buflen = 0;
	248	}
	249	}
	250
	251	SR_PRIV int reloadpro_receive_data(int fd, int revents, void *cb_data)
	252	{
	253	struct sr_dev_inst *sdi;
	254	struct dev_context *devc;
	255	int64_t t;
6e8d31d4 UH	256
	257	(void)fd;
	258
803db07a UH	259	sdi = cb_data;
	260	devc = sdi->priv;
	261
	262	if (revents != G_IO_IN)
6e8d31d4 UH	263	return TRUE;
6e8d31d4 UH	264
803db07a UH	265	handle_new_data(sdi);
	266
	267	if (devc->limit_samples && (devc->num_samples >= devc->limit_samples)) {
	268	sr_info("Requested number of samples reached.");
695dc859	269	sdi->driver->dev_acquisition_stop(sdi);
6e8d31d4	270	return TRUE;
803db07a	271	}
6e8d31d4	272
803db07a UH	273	if (devc->limit_msec) {
	274	t = (g_get_monotonic_time() - devc->starttime) / 1000;
	275	if (t > (int64_t)devc->limit_msec) {
	276	sr_info("Requested time limit reached.");
695dc859	277	sdi->driver->dev_acquisition_stop(sdi);
803db07a UH	278	return TRUE;
803db07a UH	279	}
6e8d31d4 UH	280	}
	281
	282	return TRUE;
	283	}