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

/*
 * This file is part of the libsigrok 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]);
}

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.channels = sdi->channels;
	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;
	struct sr_serial_dev_inst *serial;

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

	/* Try to get as much data as the buffer can hold. */
	len = DMM_BUFSIZE - devc->buflen;
	len = serial_read(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;

	/* 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;
	struct sr_serial_dev_inst *serial;
	int64_t time;
	int ret;

	(void)fd;

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

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

	serial = sdi->conn;

	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(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(BBCGM_M2110, metex14) /* metex14_info used as a dummy. */
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(VA_VA40B, fs9721)
RECEIVE_DATA(METEX_M3640D, metex14)
RECEIVE_DATA(METEX_M4650CR, 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(TECPEL_DMM_8061_SER, fs9721)
RECEIVE_DATA(VOLTCRAFT_M3650CR, metex14)
RECEIVE_DATA(VOLTCRAFT_M3650D, metex14)
RECEIVE_DATA(VOLTCRAFT_M4650CR, metex14)
RECEIVE_DATA(VOLTCRAFT_ME42, metex14)
RECEIVE_DATA(VOLTCRAFT_VC820_SER, fs9721)
RECEIVE_DATA(VOLTCRAFT_VC830_SER, fs9922)
RECEIVE_DATA(VOLTCRAFT_VC840_SER, fs9721)
RECEIVE_DATA(UNI_T_UT60A_SER, fs9721)
RECEIVE_DATA(UNI_T_UT60E_SER, fs9721)
RECEIVE_DATA(UNI_T_UT60G_SER, es519xx)
RECEIVE_DATA(UNI_T_UT61B_SER, fs9922)
RECEIVE_DATA(UNI_T_UT61C_SER, fs9922)
RECEIVE_DATA(UNI_T_UT61D_SER, fs9922)
RECEIVE_DATA(UNI_T_UT61E_SER, es519xx)
RECEIVE_DATA(ISO_TECH_IDM103N, es519xx)
RECEIVE_DATA(TENMA_72_7745_SER, fs9721)
RECEIVE_DATA(TENMA_72_7750_SER, es519xx)
Commit	Line	Data
7dc55d93	1	/*
50985c20	2	* This file is part of the libsigrok project.
7dc55d93 AG	3	*
7dc55d93 AG	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
69e19dd7	38	static void handle_packet(const uint8_t buf, struct sr_dev_inst sdi,
729b01f9	39	int dmm, void *info)
7dc55d93	40	{
8c1adf37	41	float floatval;
7dc55d93	42	struct sr_datafeed_packet packet;
7c8a9e1e	43	struct sr_datafeed_analog analog;
69e19dd7	44	struct dev_context *devc;
7dc55d93	45
6bef68a7	46	log_dmm_packet(buf);
69e19dd7	47	devc = sdi->priv;
6bef68a7	48
7c8a9e1e	49	memset(&analog, 0, sizeof(struct sr_datafeed_analog));
bbabddbd	50
ba7dd8bb	51	analog.channels = sdi->channels;
7c8a9e1e UH	52	analog.num_samples = 1;
7c8a9e1e UH	53	analog.mq = -1;
7dc55d93	54
7c8a9e1e UH	55	dmms[dmm].packet_parse(buf, &floatval, &analog, info);
7c8a9e1e UH	56	analog.data = &floatval;
be5c1d3b	57
22f54192	58	/* If this DMM needs additional handling, call the resp. function. */
ce3777ad	59	if (dmms[dmm].dmm_details)
7c8a9e1e	60	dmms[dmm].dmm_details(&analog, info);
7dc55d93	61
7c8a9e1e	62	if (analog.mq != -1) {
7dc55d93	63	/* Got a measurement. */
7dc55d93	64	packet.type = SR_DF_ANALOG;
7c8a9e1e	65	packet.payload = &analog;
7dc55d93 AG	66	sr_session_send(devc->cb_data, &packet);
	67	devc->num_samples++;
	68	}
7dc55d93 AG	69	}
7dc55d93 AG	70
69e19dd7	71	static void handle_new_data(struct sr_dev_inst sdi, int dmm, void info)
7dc55d93	72	{
69e19dd7	73	struct dev_context *devc;
bbabddbd	74	int len, i, offset = 0;
1e1bfcd0	75	struct sr_serial_dev_inst *serial;
bbabddbd	76
69e19dd7	77	devc = sdi->priv;
1e1bfcd0	78	serial = sdi->conn;
69e19dd7	79
bbabddbd	80	/* Try to get as much data as the buffer can hold. */
7dc55d93	81	len = DMM_BUFSIZE - devc->buflen;
1e1bfcd0	82	len = serial_read(serial, devc->buf + devc->buflen, len);
66a43576 UH	83	if (len == 0)
	84	return; /* No new bytes, nothing to do. */
	85	if (len < 0) {
bbabddbd	86	sr_err("Serial port read error: %d.", len);
7dc55d93 AG	87	return;
	88	}
	89	devc->buflen += len;
	90
bbabddbd	91	/* Now look for packets in that data. */
729b01f9 UH	92	while ((devc->buflen - offset) >= dmms[dmm].packet_size) {
729b01f9 UH	93	if (dmms[dmm].packet_valid(devc->buf + offset)) {
69e19dd7	94	handle_packet(devc->buf + offset, sdi, dmm, info);
729b01f9	95	offset += dmms[dmm].packet_size;
7dc55d93 AG	96	} else {
	97	offset++;
	98	}
	99	}
	100
bbabddbd UH	101	/* If we have any data left, move it to the beginning of our buffer. */
bbabddbd UH	102	for (i = 0; i < devc->buflen - offset; i++)
7dc55d93 AG	103	devc->buf[i] = devc->buf[offset + i];
	104	devc->buflen -= offset;
	105	}
	106
729b01f9	107	static int receive_data(int fd, int revents, int dmm, void info, void cb_data)
7dc55d93	108	{
642e9d62	109	struct sr_dev_inst *sdi;
7dc55d93	110	struct dev_context *devc;
1e1bfcd0	111	struct sr_serial_dev_inst *serial;
f9b9bd63	112	int64_t time;
ce3777ad	113	int ret;
7dc55d93	114
d35afa87 BV	115	(void)fd;
d35afa87 BV	116
7dc55d93 AG	117	if (!(sdi = cb_data))
	118	return TRUE;
	119
	120	if (!(devc = sdi->priv))
	121	return TRUE;
	122
1e1bfcd0 UH	123	serial = sdi->conn;
1e1bfcd0 UH	124
bbabddbd	125	if (revents == G_IO_IN) {
7dc55d93	126	/* Serial data arrived. */
69e19dd7	127	handle_new_data(sdi, dmm, info);
ce3777ad UH	128	} else {
	129	/* Timeout, send another packet request (if DMM needs it). */
	130	if (dmms[dmm].packet_request) {
1e1bfcd0	131	ret = dmms[dmm].packet_request(serial);
ce3777ad UH	132	if (ret < 0) {
	133	sr_err("Failed to request packet: %d.", ret);
	134	return FALSE;
	135	}
	136	}
7dc55d93 AG	137	}
7dc55d93 AG	138
d55c89f5	139	if (devc->limit_samples && devc->num_samples >= devc->limit_samples) {
35e199da	140	sr_info("Requested number of samples reached.");
7dc55d93 AG	141	sdi->driver->dev_acquisition_stop(sdi, cb_data);
	142	return TRUE;
	143	}
	144
f9b9bd63 AG	145	if (devc->limit_msec) {
	146	time = (g_get_monotonic_time() - devc->starttime) / 1000;
	147	if (time > (int64_t)devc->limit_msec) {
35e199da	148	sr_info("Requested time limit reached.");
f9b9bd63 AG	149	sdi->driver->dev_acquisition_stop(sdi, cb_data);
	150	return TRUE;
	151	}
	152	}
	153
7dc55d93 AG	154	return TRUE;
7dc55d93 AG	155	}
729b01f9	156
22f54192	157	#define RECEIVE_DATA(ID_UPPER, DMM_DRIVER) \
dccfe015 UH	158	SR_PRIV int receive_data_##ID_UPPER(int fd, int revents, void *cb_data) { \
	159	struct DMM_DRIVER##_info info; \
	160	return receive_data(fd, revents, ID_UPPER, &info, cb_data); }
	161
	162	/* Driver-specific receive_data() wrappers */
825da8b2	163	RECEIVE_DATA(BBCGM_M2110, metex14) /* metex14_info used as a dummy. */
22f54192 UH	164	RECEIVE_DATA(DIGITEK_DT4000ZC, fs9721)
	165	RECEIVE_DATA(TEKPOWER_TP4000ZC, fs9721)
	166	RECEIVE_DATA(METEX_ME31, metex14)
	167	RECEIVE_DATA(PEAKTECH_3410, metex14)
	168	RECEIVE_DATA(MASTECH_MAS345, metex14)
	169	RECEIVE_DATA(VA_VA18B, fs9721)
d327972b	170	RECEIVE_DATA(VA_VA40B, fs9721)
22f54192	171	RECEIVE_DATA(METEX_M3640D, metex14)
88f544f2	172	RECEIVE_DATA(METEX_M4650CR, metex14)
22f54192 UH	173	RECEIVE_DATA(PEAKTECH_4370, metex14)
	174	RECEIVE_DATA(PCE_PCE_DM32, fs9721)
	175	RECEIVE_DATA(RADIOSHACK_22_168, metex14)
3864648b	176	RECEIVE_DATA(RADIOSHACK_22_805, metex14)
22f54192	177	RECEIVE_DATA(RADIOSHACK_22_812, rs9lcd)
b38e08fb	178	RECEIVE_DATA(TECPEL_DMM_8061_SER, fs9721)
e83437ae	179	RECEIVE_DATA(VOLTCRAFT_M3650CR, metex14)
5f2a4aff	180	RECEIVE_DATA(VOLTCRAFT_M3650D, metex14)
2b83d7fe	181	RECEIVE_DATA(VOLTCRAFT_M4650CR, metex14)
1656e47d	182	RECEIVE_DATA(VOLTCRAFT_ME42, metex14)
14766619	183	RECEIVE_DATA(VOLTCRAFT_VC820_SER, fs9721)
6045b91a	184	RECEIVE_DATA(VOLTCRAFT_VC830_SER, fs9922)
14766619	185	RECEIVE_DATA(VOLTCRAFT_VC840_SER, fs9721)
a7a163a7 FK	186	RECEIVE_DATA(UNI_T_UT60A_SER, fs9721)
a7a163a7 FK	187	RECEIVE_DATA(UNI_T_UT60E_SER, fs9721)
4104ef81	188	RECEIVE_DATA(UNI_T_UT60G_SER, es519xx)
7cb69b18	189	RECEIVE_DATA(UNI_T_UT61B_SER, fs9922)
5f985df2	190	RECEIVE_DATA(UNI_T_UT61C_SER, fs9922)
ae3a59de	191	RECEIVE_DATA(UNI_T_UT61D_SER, fs9922)
d97824e5	192	RECEIVE_DATA(UNI_T_UT61E_SER, es519xx)
df6b0f99	193	RECEIVE_DATA(ISO_TECH_IDM103N, es519xx)
2710cb53	194	RECEIVE_DATA(TENMA_72_7745_SER, fs9721)
d9e79c51	195	RECEIVE_DATA(TENMA_72_7750_SER, es519xx)