[libsigrok.git] / src / hardware / uni-t-ut32x / protocol.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
 *
 * 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 <string.h>
#include <math.h>
#include "protocol.h"

extern struct sr_dev_driver uni_t_ut32x_driver_info;

static float parse_temperature(unsigned char *buf)
{
	float temp;
	int i;
	gboolean negative;

	negative = FALSE;
	temp = 0.0;
	for (i = 0; i < 4; i++) {
		if (buf[i] == 0x3a)
			continue;
		if (buf[i] == 0x3b) {
			if (negative) {
				sr_dbg("Double negative sign!");
				return NAN;
			} else {
				negative = TRUE;
				continue;
			}
		}
		if (buf[i] < 0x30 || buf[i] > 0x39) {
			sr_dbg("Invalid digit '%.2x'!", buf[i]);
			return NAN;
		}
		temp *= 10;
		temp += (buf[i] - 0x30);
	}
	temp /= 10;
	if (negative)
		temp = -temp;

	return temp;
}

static void process_packet(struct sr_dev_inst *sdi)
{
	struct dev_context *devc;
	struct sr_datafeed_packet packet;
	struct sr_datafeed_analog_old analog;
	GString *spew;
	float temp;
	int i;
	gboolean is_valid;

	devc = sdi->priv;
	sr_dbg("Received full 19-byte packet.");
	if (sr_log_loglevel_get() >= SR_LOG_SPEW) {
		spew = g_string_sized_new(60);
		for (i = 0; i < devc->packet_len; i++)
			g_string_append_printf(spew, "%.2x ", devc->packet[i]);
		sr_spew("%s", spew->str);
		g_string_free(spew, TRUE);
	}

	is_valid = TRUE;
	if (devc->packet[1] == 0x3b && devc->packet[2] == 0x3b
			&& devc->packet[3] == 0x3b && devc->packet[4] == 0x3b)
		/* No measurement: missing channel, empty storage location, ... */
		is_valid = FALSE;

	temp = parse_temperature(devc->packet + 1);
	if (isnan(temp))
		is_valid = FALSE;

	if (is_valid) {
		memset(&analog, 0, sizeof(struct sr_datafeed_analog_old));
		analog.mq = SR_MQ_TEMPERATURE;
		analog.mqflags = 0;
		switch (devc->packet[5] - 0x30) {
		case 1:
			analog.unit = SR_UNIT_CELSIUS;
			break;
		case 2:
			analog.unit = SR_UNIT_FAHRENHEIT;
			break;
		case 3:
			analog.unit = SR_UNIT_KELVIN;
			break;
		default:
			/* We can still pass on the measurement, whatever it is. */
			sr_dbg("Unknown unit 0x%.2x.", devc->packet[5]);
		}
		switch (devc->packet[13] - 0x30) {
		case 0:
			/* Channel T1. */
			analog.channels = g_slist_append(NULL, g_slist_nth_data(sdi->channels, 0));
			break;
		case 1:
			/* Channel T2. */
			analog.channels = g_slist_append(NULL, g_slist_nth_data(sdi->channels, 1));
			break;
		case 2:
		case 3:
			/* Channel T1-T2. */
			analog.channels = g_slist_append(NULL, g_slist_nth_data(sdi->channels, 2));
			analog.mqflags |= SR_MQFLAG_RELATIVE;
			break;
		default:
			sr_err("Unknown channel 0x%.2x.", devc->packet[13]);
			is_valid = FALSE;
		}
		if (is_valid) {
			analog.num_samples = 1;
			analog.data = &temp;
			packet.type = SR_DF_ANALOG_OLD;
			packet.payload = &analog;
			sr_session_send(devc->cb_data, &packet);
			g_slist_free(analog.channels);
		}
	}

	/* We count packets even if the temperature was invalid. This way
	 * a sample limit on "Memory" data source still works: unused
	 * memory slots come through as "----" measurements. */
	devc->num_samples++;
	if (devc->limit_samples && devc->num_samples >= devc->limit_samples) {
		sdi->driver->dev_acquisition_stop((struct sr_dev_inst *)sdi,
				devc->cb_data);
	}

}

SR_PRIV void LIBUSB_CALL uni_t_ut32x_receive_transfer(struct libusb_transfer *transfer)
{
	struct dev_context *devc;
	struct sr_dev_inst *sdi;
	int hid_payload_len, ret;

	sdi = transfer->user_data;
	devc = sdi->priv;
	if (transfer->actual_length == 8) {
		/* CH9325 encodes length in low nibble of first byte, with
		 * bytes 1-7 being the (padded) payload. */
		hid_payload_len = transfer->buffer[0] & 0x0f;
		memcpy(devc->packet + devc->packet_len, transfer->buffer + 1,
				hid_payload_len);
		devc->packet_len += hid_payload_len;
		if (devc->packet_len >= 2
				&& devc->packet[devc->packet_len - 2] == 0x0d
				&& devc->packet[devc->packet_len - 1] == 0x0a) {
			/* Got end of packet, but do we have a complete packet? */
			if (devc->packet_len == 19)
				process_packet(sdi);
			/* Either way, done with it. */
			devc->packet_len = 0;
		} else if (devc->packet_len > 19) {
			/* Guard against garbage from the device overrunning
			 * our packet buffer. */
			sr_dbg("Buffer overrun!");
			devc->packet_len = 0;
		}
	}

	/* Get the next transfer (unless we're shutting down). */
	if (sdi->status != SR_ST_STOPPING) {
		if ((ret = libusb_submit_transfer(devc->xfer)) != 0) {
			sr_dbg("Failed to resubmit transfer: %s", libusb_error_name(ret));
			sdi->status = SR_ST_STOPPING;
			libusb_free_transfer(devc->xfer);
		}
	} else
		libusb_free_transfer(devc->xfer);

}

SR_PRIV int uni_t_ut32x_handle_events(int fd, int revents, void *cb_data)
{
	struct drv_context *drvc;
	struct dev_context *devc;
	struct sr_dev_driver *di;
	struct sr_dev_inst *sdi;
	struct sr_usb_dev_inst *usb;
	struct timeval tv;
	int len, ret;
	unsigned char cmd[2];

	(void)fd;
	(void)revents;

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

	di = sdi->driver;
	drvc = di->context;

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

	memset(&tv, 0, sizeof(struct timeval));
	libusb_handle_events_timeout_completed(drvc->sr_ctx->libusb_ctx, &tv,
			NULL);

	if (sdi->status == SR_ST_STOPPING) {
		usb_source_remove(sdi->session, drvc->sr_ctx);
		std_session_send_df_header(cb_data, LOG_PREFIX);

		/* Tell the device to stop sending USB packets. */
		usb = sdi->conn;
		cmd[0] = 0x01;
		cmd[1] = CMD_STOP;
		ret = libusb_bulk_transfer(usb->devhdl, EP_OUT, cmd, 2, &len, 5);
		if (ret != 0 || len != 2) {
			/* Warning only, doesn't matter. */
			sr_dbg("Failed to send stop command: %s", libusb_error_name(ret));
		}

		sdi->status = SR_ST_ACTIVE;
		return TRUE;
	}

	return TRUE;
}
Commit	Line	Data
3877dde4 BV	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
	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
6ec6c43b	20	#include <config.h>
d6ff054a BV	21	#include <string.h>
d6ff054a BV	22	#include <math.h>
515ab088	23	#include "protocol.h"
d6ff054a BV	24
d6ff054a BV	25	extern struct sr_dev_driver uni_t_ut32x_driver_info;
d6ff054a BV	26
d6ff054a BV	27	static float parse_temperature(unsigned char *buf)
3877dde4	28	{
d6ff054a BV	29	float temp;
	30	int i;
	31	gboolean negative;
	32
	33	negative = FALSE;
	34	temp = 0.0;
	35	for (i = 0; i < 4; i++) {
	36	if (buf[i] == 0x3a)
	37	continue;
	38	if (buf[i] == 0x3b) {
	39	if (negative) {
	40	sr_dbg("Double negative sign!");
	41	return NAN;
	42	} else {
	43	negative = TRUE;
	44	continue;
	45	}
	46	}
	47	if (buf[i] < 0x30 \|\| buf[i] > 0x39) {
	48	sr_dbg("Invalid digit '%.2x'!", buf[i]);
	49	return NAN;
	50	}
	51	temp *= 10;
	52	temp += (buf[i] - 0x30);
	53	}
	54	temp /= 10;
	55	if (negative)
	56	temp = -temp;
3877dde4	57
d6ff054a BV	58	return temp;
	59	}
	60
	61	static void process_packet(struct sr_dev_inst *sdi)
	62	{
3877dde4	63	struct dev_context *devc;
d6ff054a	64	struct sr_datafeed_packet packet;
5faebab2	65	struct sr_datafeed_analog_old analog;
d6ff054a BV	66	GString *spew;
	67	float temp;
	68	int i;
	69	gboolean is_valid;
3877dde4	70
d6ff054a BV	71	devc = sdi->priv;
	72	sr_dbg("Received full 19-byte packet.");
	73	if (sr_log_loglevel_get() >= SR_LOG_SPEW) {
	74	spew = g_string_sized_new(60);
	75	for (i = 0; i < devc->packet_len; i++)
	76	g_string_append_printf(spew, "%.2x ", devc->packet[i]);
	77	sr_spew("%s", spew->str);
	78	g_string_free(spew, TRUE);
	79	}
3877dde4	80
d6ff054a BV	81	is_valid = TRUE;
	82	if (devc->packet[1] == 0x3b && devc->packet[2] == 0x3b
	83	&& devc->packet[3] == 0x3b && devc->packet[4] == 0x3b)
ba7dd8bb	84	/* No measurement: missing channel, empty storage location, ... */
d6ff054a	85	is_valid = FALSE;
3877dde4	86
d6ff054a BV	87	temp = parse_temperature(devc->packet + 1);
	88	if (isnan(temp))
	89	is_valid = FALSE;
	90
	91	if (is_valid) {
5faebab2	92	memset(&analog, 0, sizeof(struct sr_datafeed_analog_old));
d6ff054a BV	93	analog.mq = SR_MQ_TEMPERATURE;
	94	analog.mqflags = 0;
	95	switch (devc->packet[5] - 0x30) {
	96	case 1:
	97	analog.unit = SR_UNIT_CELSIUS;
	98	break;
	99	case 2:
	100	analog.unit = SR_UNIT_FAHRENHEIT;
	101	break;
	102	case 3:
	103	analog.unit = SR_UNIT_KELVIN;
	104	break;
	105	default:
	106	/* We can still pass on the measurement, whatever it is. */
	107	sr_dbg("Unknown unit 0x%.2x.", devc->packet[5]);
	108	}
	109	switch (devc->packet[13] - 0x30) {
	110	case 0:
ba7dd8bb UH	111	/* Channel T1. */
ba7dd8bb UH	112	analog.channels = g_slist_append(NULL, g_slist_nth_data(sdi->channels, 0));
d6ff054a BV	113	break;
d6ff054a BV	114	case 1:
ba7dd8bb UH	115	/* Channel T2. */
ba7dd8bb UH	116	analog.channels = g_slist_append(NULL, g_slist_nth_data(sdi->channels, 1));
d6ff054a BV	117	break;
	118	case 2:
	119	case 3:
ba7dd8bb UH	120	/* Channel T1-T2. */
ba7dd8bb UH	121	analog.channels = g_slist_append(NULL, g_slist_nth_data(sdi->channels, 2));
d6ff054a BV	122	analog.mqflags \|= SR_MQFLAG_RELATIVE;
	123	break;
	124	default:
ba7dd8bb	125	sr_err("Unknown channel 0x%.2x.", devc->packet[13]);
d6ff054a BV	126	is_valid = FALSE;
	127	}
	128	if (is_valid) {
	129	analog.num_samples = 1;
	130	analog.data = &temp;
5faebab2	131	packet.type = SR_DF_ANALOG_OLD;
d6ff054a BV	132	packet.payload = &analog;
d6ff054a BV	133	sr_session_send(devc->cb_data, &packet);
ba7dd8bb	134	g_slist_free(analog.channels);
d6ff054a BV	135	}
	136	}
	137
	138	/* We count packets even if the temperature was invalid. This way
	139	* a sample limit on "Memory" data source still works: unused
	140	* memory slots come through as "----" measurements. */
	141	devc->num_samples++;
	142	if (devc->limit_samples && devc->num_samples >= devc->limit_samples) {
	143	sdi->driver->dev_acquisition_stop((struct sr_dev_inst *)sdi,
	144	devc->cb_data);
3877dde4 BV	145	}
3877dde4 BV	146
3877dde4	147	}
6513f97f	148
55462b8b	149	SR_PRIV void LIBUSB_CALL uni_t_ut32x_receive_transfer(struct libusb_transfer *transfer)
6513f97f	150	{
d6ff054a BV	151	struct dev_context *devc;
	152	struct sr_dev_inst *sdi;
	153	int hid_payload_len, ret;
	154
	155	sdi = transfer->user_data;
	156	devc = sdi->priv;
	157	if (transfer->actual_length == 8) {
	158	/* CH9325 encodes length in low nibble of first byte, with
	159	* bytes 1-7 being the (padded) payload. */
	160	hid_payload_len = transfer->buffer[0] & 0x0f;
	161	memcpy(devc->packet + devc->packet_len, transfer->buffer + 1,
	162	hid_payload_len);
	163	devc->packet_len += hid_payload_len;
	164	if (devc->packet_len >= 2
	165	&& devc->packet[devc->packet_len - 2] == 0x0d
	166	&& devc->packet[devc->packet_len - 1] == 0x0a) {
	167	/* Got end of packet, but do we have a complete packet? */
	168	if (devc->packet_len == 19)
	169	process_packet(sdi);
	170	/* Either way, done with it. */
	171	devc->packet_len = 0;
	172	} else if (devc->packet_len > 19) {
	173	/* Guard against garbage from the device overrunning
	174	* our packet buffer. */
	175	sr_dbg("Buffer overrun!");
	176	devc->packet_len = 0;
	177	}
	178	}
	179
	180	/* Get the next transfer (unless we're shutting down). */
	181	if (sdi->status != SR_ST_STOPPING) {
	182	if ((ret = libusb_submit_transfer(devc->xfer)) != 0) {
	183	sr_dbg("Failed to resubmit transfer: %s", libusb_error_name(ret));
	184	sdi->status = SR_ST_STOPPING;
	185	libusb_free_transfer(devc->xfer);
	186	}
	187	} else
	188	libusb_free_transfer(devc->xfer);
6513f97f BV	189
	190	}
	191
d6ff054a BV	192	SR_PRIV int uni_t_ut32x_handle_events(int fd, int revents, void *cb_data)
	193	{
	194	struct drv_context *drvc;
	195	struct dev_context *devc;
4f840ce9	196	struct sr_dev_driver *di;
d6ff054a	197	struct sr_dev_inst *sdi;
d6ff054a BV	198	struct sr_usb_dev_inst *usb;
d6ff054a BV	199	struct timeval tv;
6c60facc	200	int len, ret;
d6ff054a BV	201	unsigned char cmd[2];
	202
	203	(void)fd;
	204	(void)revents;
8bd3daa4	205
d6ff054a BV	206	if (!(sdi = cb_data))
	207	return TRUE;
	208
4f840ce9	209	di = sdi->driver;
41812aca	210	drvc = di->context;
4f840ce9	211
d6ff054a BV	212	if (!(devc = sdi->priv))
	213	return TRUE;
	214
	215	memset(&tv, 0, sizeof(struct timeval));
	216	libusb_handle_events_timeout_completed(drvc->sr_ctx->libusb_ctx, &tv,
	217	NULL);
	218
	219	if (sdi->status == SR_ST_STOPPING) {
102f1239	220	usb_source_remove(sdi->session, drvc->sr_ctx);
3be42bc2	221	std_session_send_df_header(cb_data, LOG_PREFIX);
d6ff054a BV	222
	223	/* Tell the device to stop sending USB packets. */
	224	usb = sdi->conn;
	225	cmd[0] = 0x01;
	226	cmd[1] = CMD_STOP;
	227	ret = libusb_bulk_transfer(usb->devhdl, EP_OUT, cmd, 2, &len, 5);
	228	if (ret != 0 \|\| len != 2) {
	229	/* Warning only, doesn't matter. */
	230	sr_dbg("Failed to send stop command: %s", libusb_error_name(ret));
	231	}
	232
	233	sdi->status = SR_ST_ACTIVE;
	234	return TRUE;
	235	}
	236
	237	return TRUE;
	238	}