[libsigrok.git] / hardware / serial-dmm / protocol.c

/*
 * This file is part of the sigrok project.
 *
 * Copyright (C) 2012 Alexandru Gagniuc <mr.nuke.me@gmail.com>
 * Copyright (C) 2012 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 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 <stdlib.h>
#include <math.h>
#include <string.h>
#include <errno.h>
#include <glib.h>
#include "libsigrok.h"
#include "libsigrok-internal.h"
#include "protocol.h"

static void log_dmm_packet(const uint8_t *buf)
{
	sr_dbg("DMM packet: %02x %02x %02x %02x %02x %02x %02x"
	       " %02x %02x %02x %02x %02x %02x %02x",
	       buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6],
	       buf[7], buf[8], buf[9], buf[10], buf[11], buf[12], buf[13]);
}

SR_PRIV void dmm_details_dt4000zc(struct sr_datafeed_analog *analog, void *info)
{
	dmm_details_tp4000zc(analog, info); /* Same as TP4000ZC. */
}

SR_PRIV void dmm_details_tp4000zc(struct sr_datafeed_analog *analog, void *info)
{
	struct fs9721_info *info_local;

	info_local = (struct fs9721_info *)info;

	/* User-defined FS9721_LP3 flag 'c2c1_10' means temperature. */
	if (info_local->is_c2c1_10) {
		analog->mq = SR_MQ_TEMPERATURE;
		analog->unit = SR_UNIT_CELSIUS;
	}
}

SR_PRIV void dmm_details_va18b(struct sr_datafeed_analog *analog, void *info)
{
	struct fs9721_info *info_local;

	info_local = (struct fs9721_info *)info;

	/* User-defined FS9721_LP3 flag 'c2c1_01' means temperature. */
	if (info_local->is_c2c1_01) {
		analog->mq = SR_MQ_TEMPERATURE;
		analog->unit = SR_UNIT_CELSIUS;
	}
}

SR_PRIV void dmm_details_pce_dm32(struct sr_datafeed_analog *analog, void *info)
{
	struct fs9721_info *info_local;

	info_local = (struct fs9721_info *)info;

	/* User-defined FS9721_LP3 flag 'c2c1_01' means temperature (F). */
	if (info_local->is_c2c1_01) {
		analog->mq = SR_MQ_TEMPERATURE;
		analog->unit = SR_UNIT_FAHRENHEIT;
	}

	/* User-defined FS9721_LP3 flag 'c2c1_10' means temperature (C). */
	if (info_local->is_c2c1_10) {
		analog->mq = SR_MQ_TEMPERATURE;
		analog->unit = SR_UNIT_CELSIUS;
	}
}

static void handle_packet(const uint8_t *buf, struct sr_dev_inst *sdi,
			  int dmm, void *info)
{
	float floatval;
	struct sr_datafeed_packet packet;
	struct sr_datafeed_analog analog;
	struct dev_context *devc;

	log_dmm_packet(buf);
	devc = sdi->priv;

	memset(&analog, 0, sizeof(struct sr_datafeed_analog));

	analog.probes = sdi->probes;
	analog.num_samples = 1;
	analog.mq = -1;

	dmms[dmm].packet_parse(buf, &floatval, &analog, info);
	analog.data = &floatval;

	/* If this DMM needs additional handling, call the resp. function. */
	if (dmms[dmm].dmm_details)
		dmms[dmm].dmm_details(&analog, info);

	if (analog.mq != -1) {
		/* Got a measurement. */
		packet.type = SR_DF_ANALOG;
		packet.payload = &analog;
		sr_session_send(devc->cb_data, &packet);
		devc->num_samples++;
	}
}

static void handle_new_data(struct sr_dev_inst *sdi, int dmm, void *info)
{
	struct dev_context *devc;
	int len, i, offset = 0;

	devc = sdi->priv;

	/* Try to get as much data as the buffer can hold. */
	len = DMM_BUFSIZE - devc->buflen;
	len = serial_read(devc->serial, devc->buf + devc->buflen, len);
	if (len < 1) {
		sr_err("Serial port read error: %d.", len);
		return;
	}
	devc->buflen += len;

	/* Now look for packets in that data. */
	while ((devc->buflen - offset) >= dmms[dmm].packet_size) {
		if (dmms[dmm].packet_valid(devc->buf + offset)) {
			handle_packet(devc->buf + offset, sdi, dmm, info);
			offset += dmms[dmm].packet_size;
		} else {
			offset++;
		}
	}

	/* If we have any data left, move it to the beginning of our buffer. */
	for (i = 0; i < devc->buflen - offset; i++)
		devc->buf[i] = devc->buf[offset + i];
	devc->buflen -= offset;
}

static int receive_data(int fd, int revents, int dmm, void *info, void *cb_data)
{
	struct sr_dev_inst *sdi;
	struct dev_context *devc;
	int64_t time;
	int ret;

	(void)fd;

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

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

	if (revents == G_IO_IN) {
		/* Serial data arrived. */
		handle_new_data(sdi, dmm, info);
	} else {
		/* Timeout, send another packet request (if DMM needs it). */
		if (dmms[dmm].packet_request) {
			ret = dmms[dmm].packet_request(devc->serial);
			if (ret < 0) {
				sr_err("Failed to request packet: %d.", ret);
				return FALSE;
			}
		}
	}

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

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

	return TRUE;
}

#define RECEIVE_DATA(ID_UPPER, DMM_DRIVER) \
SR_PRIV int receive_data_##ID_UPPER(int fd, int revents, void *cb_data) { \
	struct DMM_DRIVER##_info info; \
	return receive_data(fd, revents, ID_UPPER, &info, cb_data); }

/* Driver-specific receive_data() wrappers */
RECEIVE_DATA(DIGITEK_DT4000ZC, fs9721)
RECEIVE_DATA(TEKPOWER_TP4000ZC, fs9721)
RECEIVE_DATA(METEX_ME31, metex14)
RECEIVE_DATA(PEAKTECH_3410, metex14)
RECEIVE_DATA(MASTECH_MAS345, metex14)
RECEIVE_DATA(VA_VA18B, fs9721)
RECEIVE_DATA(METEX_M3640D, metex14)
RECEIVE_DATA(PEAKTECH_4370, metex14)
RECEIVE_DATA(PCE_PCE_DM32, fs9721)
RECEIVE_DATA(RADIOSHACK_22_168, metex14)
RECEIVE_DATA(RADIOSHACK_22_805, metex14)
RECEIVE_DATA(RADIOSHACK_22_812, rs9lcd)
RECEIVE_DATA(VOLTCRAFT_VC820_SER, fs9721)
RECEIVE_DATA(VOLTCRAFT_VC840_SER, fs9721)
RECEIVE_DATA(UNI_T_UT61E_SER, es51922)
Commit	Line	Data
7dc55d93 AG	1	/*
	2	* This file is part of the sigrok project.
	3	*
	4	* Copyright (C) 2012 Alexandru Gagniuc <mr.nuke.me@gmail.com>
729b01f9	5	* Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
7dc55d93 AG	6	*
	7	* This program is free software: you can redistribute it and/or modify
	8	* it under the terms of the GNU General Public License as published by
	9	* the Free Software Foundation, either version 3 of the License, or
	10	* (at your option) any later version.
	11	*
	12	* This program is distributed in the hope that it will be useful,
	13	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	* GNU General Public License for more details.
	16	*
	17	* You should have received a copy of the GNU General Public License
	18	* along with this program. If not, see <http://www.gnu.org/licenses/>.
	19	*/
	20
7dc55d93 AG	21	#include <stdlib.h>
	22	#include <math.h>
	23	#include <string.h>
	24	#include <errno.h>
22f54192	25	#include <glib.h>
bbabddbd UH	26	#include "libsigrok.h"
	27	#include "libsigrok-internal.h"
	28	#include "protocol.h"
7dc55d93	29
6bef68a7 UH	30	static void log_dmm_packet(const uint8_t *buf)
	31	{
	32	sr_dbg("DMM packet: %02x %02x %02x %02x %02x %02x %02x"
	33	" %02x %02x %02x %02x %02x %02x %02x",
	34	buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6],
	35	buf[7], buf[8], buf[9], buf[10], buf[11], buf[12], buf[13]);
	36	}
	37
f086b830 UH	38	SR_PRIV void dmm_details_dt4000zc(struct sr_datafeed_analog analog, void info)
	39	{
	40	dmm_details_tp4000zc(analog, info); /* Same as TP4000ZC. */
	41	}
	42
729b01f9 UH	43	SR_PRIV void dmm_details_tp4000zc(struct sr_datafeed_analog analog, void info)
	44	{
	45	struct fs9721_info *info_local;
	46
	47	info_local = (struct fs9721_info *)info;
	48
	49	/* User-defined FS9721_LP3 flag 'c2c1_10' means temperature. */
	50	if (info_local->is_c2c1_10) {
	51	analog->mq = SR_MQ_TEMPERATURE;
6dca2f16 UH	52	analog->unit = SR_UNIT_CELSIUS;
	53	}
	54	}
	55
	56	SR_PRIV void dmm_details_va18b(struct sr_datafeed_analog analog, void info)
	57	{
	58	struct fs9721_info *info_local;
	59
	60	info_local = (struct fs9721_info *)info;
	61
	62	/* User-defined FS9721_LP3 flag 'c2c1_01' means temperature. */
	63	if (info_local->is_c2c1_01) {
	64	analog->mq = SR_MQ_TEMPERATURE;
729b01f9 UH	65	analog->unit = SR_UNIT_CELSIUS;
	66	}
	67	}
	68
d4bd66a0 UH	69	SR_PRIV void dmm_details_pce_dm32(struct sr_datafeed_analog analog, void info)
	70	{
	71	struct fs9721_info *info_local;
	72
	73	info_local = (struct fs9721_info *)info;
	74
	75	/* User-defined FS9721_LP3 flag 'c2c1_01' means temperature (F). */
	76	if (info_local->is_c2c1_01) {
	77	analog->mq = SR_MQ_TEMPERATURE;
	78	analog->unit = SR_UNIT_FAHRENHEIT;
	79	}
	80
	81	/* User-defined FS9721_LP3 flag 'c2c1_10' means temperature (C). */
	82	if (info_local->is_c2c1_10) {
	83	analog->mq = SR_MQ_TEMPERATURE;
	84	analog->unit = SR_UNIT_CELSIUS;
	85	}
	86	}
	87
69e19dd7	88	static void handle_packet(const uint8_t buf, struct sr_dev_inst sdi,
729b01f9	89	int dmm, void *info)
7dc55d93	90	{
8c1adf37	91	float floatval;
7dc55d93	92	struct sr_datafeed_packet packet;
7c8a9e1e	93	struct sr_datafeed_analog analog;
69e19dd7	94	struct dev_context *devc;
7dc55d93	95
6bef68a7	96	log_dmm_packet(buf);
69e19dd7	97	devc = sdi->priv;
6bef68a7	98
7c8a9e1e	99	memset(&analog, 0, sizeof(struct sr_datafeed_analog));
bbabddbd	100
7c8a9e1e UH	101	analog.probes = sdi->probes;
	102	analog.num_samples = 1;
	103	analog.mq = -1;
7dc55d93	104
7c8a9e1e UH	105	dmms[dmm].packet_parse(buf, &floatval, &analog, info);
7c8a9e1e UH	106	analog.data = &floatval;
be5c1d3b	107
22f54192	108	/* If this DMM needs additional handling, call the resp. function. */
ce3777ad	109	if (dmms[dmm].dmm_details)
7c8a9e1e	110	dmms[dmm].dmm_details(&analog, info);
7dc55d93	111
7c8a9e1e	112	if (analog.mq != -1) {
7dc55d93	113	/* Got a measurement. */
7dc55d93	114	packet.type = SR_DF_ANALOG;
7c8a9e1e	115	packet.payload = &analog;
7dc55d93 AG	116	sr_session_send(devc->cb_data, &packet);
	117	devc->num_samples++;
	118	}
7dc55d93 AG	119	}
7dc55d93 AG	120
69e19dd7	121	static void handle_new_data(struct sr_dev_inst sdi, int dmm, void info)
7dc55d93	122	{
69e19dd7	123	struct dev_context *devc;
bbabddbd	124	int len, i, offset = 0;
bbabddbd	125
69e19dd7 BV	126	devc = sdi->priv;
69e19dd7 BV	127
bbabddbd	128	/* Try to get as much data as the buffer can hold. */
7dc55d93	129	len = DMM_BUFSIZE - devc->buflen;
d35afa87	130	len = serial_read(devc->serial, devc->buf + devc->buflen, len);
7dc55d93	131	if (len < 1) {
bbabddbd	132	sr_err("Serial port read error: %d.", len);
7dc55d93 AG	133	return;
	134	}
	135	devc->buflen += len;
	136
bbabddbd	137	/* Now look for packets in that data. */
729b01f9 UH	138	while ((devc->buflen - offset) >= dmms[dmm].packet_size) {
729b01f9 UH	139	if (dmms[dmm].packet_valid(devc->buf + offset)) {
69e19dd7	140	handle_packet(devc->buf + offset, sdi, dmm, info);
729b01f9	141	offset += dmms[dmm].packet_size;
7dc55d93 AG	142	} else {
	143	offset++;
	144	}
	145	}
	146
bbabddbd UH	147	/* If we have any data left, move it to the beginning of our buffer. */
bbabddbd UH	148	for (i = 0; i < devc->buflen - offset; i++)
7dc55d93 AG	149	devc->buf[i] = devc->buf[offset + i];
	150	devc->buflen -= offset;
	151	}
	152
729b01f9	153	static int receive_data(int fd, int revents, int dmm, void info, void cb_data)
7dc55d93	154	{
642e9d62	155	struct sr_dev_inst *sdi;
7dc55d93	156	struct dev_context *devc;
f9b9bd63	157	int64_t time;
ce3777ad	158	int ret;
7dc55d93	159
d35afa87 BV	160	(void)fd;
d35afa87 BV	161
7dc55d93 AG	162	if (!(sdi = cb_data))
	163	return TRUE;
	164
	165	if (!(devc = sdi->priv))
	166	return TRUE;
	167
bbabddbd	168	if (revents == G_IO_IN) {
7dc55d93	169	/* Serial data arrived. */
69e19dd7	170	handle_new_data(sdi, dmm, info);
ce3777ad UH	171	} else {
	172	/* Timeout, send another packet request (if DMM needs it). */
	173	if (dmms[dmm].packet_request) {
	174	ret = dmms[dmm].packet_request(devc->serial);
	175	if (ret < 0) {
	176	sr_err("Failed to request packet: %d.", ret);
	177	return FALSE;
	178	}
	179	}
7dc55d93 AG	180	}
7dc55d93 AG	181
d55c89f5	182	if (devc->limit_samples && devc->num_samples >= devc->limit_samples) {
35e199da	183	sr_info("Requested number of samples reached.");
7dc55d93 AG	184	sdi->driver->dev_acquisition_stop(sdi, cb_data);
	185	return TRUE;
	186	}
	187
f9b9bd63 AG	188	if (devc->limit_msec) {
	189	time = (g_get_monotonic_time() - devc->starttime) / 1000;
	190	if (time > (int64_t)devc->limit_msec) {
35e199da	191	sr_info("Requested time limit reached.");
f9b9bd63 AG	192	sdi->driver->dev_acquisition_stop(sdi, cb_data);
	193	return TRUE;
	194	}
	195	}
	196
7dc55d93 AG	197	return TRUE;
7dc55d93 AG	198	}
729b01f9	199
22f54192	200	#define RECEIVE_DATA(ID_UPPER, DMM_DRIVER) \
dccfe015 UH	201	SR_PRIV int receive_data_##ID_UPPER(int fd, int revents, void *cb_data) { \
	202	struct DMM_DRIVER##_info info; \
	203	return receive_data(fd, revents, ID_UPPER, &info, cb_data); }
	204
	205	/* Driver-specific receive_data() wrappers */
22f54192 UH	206	RECEIVE_DATA(DIGITEK_DT4000ZC, fs9721)
	207	RECEIVE_DATA(TEKPOWER_TP4000ZC, fs9721)
	208	RECEIVE_DATA(METEX_ME31, metex14)
	209	RECEIVE_DATA(PEAKTECH_3410, metex14)
	210	RECEIVE_DATA(MASTECH_MAS345, metex14)
	211	RECEIVE_DATA(VA_VA18B, fs9721)
	212	RECEIVE_DATA(METEX_M3640D, metex14)
	213	RECEIVE_DATA(PEAKTECH_4370, metex14)
	214	RECEIVE_DATA(PCE_PCE_DM32, fs9721)
	215	RECEIVE_DATA(RADIOSHACK_22_168, metex14)
3864648b	216	RECEIVE_DATA(RADIOSHACK_22_805, metex14)
22f54192	217	RECEIVE_DATA(RADIOSHACK_22_812, rs9lcd)
14766619 UH	218	RECEIVE_DATA(VOLTCRAFT_VC820_SER, fs9721)
14766619 UH	219	RECEIVE_DATA(VOLTCRAFT_VC840_SER, fs9721)
986fde75	220	RECEIVE_DATA(UNI_T_UT61E_SER, es51922)