[libsigrok.git] / hardware / fluke-dmm / api.c

/*
 * This file is part of the sigrok project.
 *
 * Copyright (C) 2012 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 <glib.h>
#include "libsigrok.h"
#include "libsigrok-internal.h"
#include "config.h"
#include "fluke-dmm.h"
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <string.h>
#include <errno.h>


SR_PRIV struct sr_dev_driver flukedmm_driver_info;
static struct sr_dev_driver *di = &flukedmm_driver_info;

static const struct flukedmm_profile supported_flukedmm[] = {
	{ FLUKE_187, "187" },
};


/* Properly close and free all devices. */
static int clear_instances(void)
{
	struct sr_dev_inst *sdi;
	struct drv_context *drvc;
	struct dev_context *devc;
	GSList *l;

	if (!(drvc = di->priv))
		return SR_OK;

	drvc = di->priv;
	for (l = drvc->instances; l; l = l->next) {
		if (!(sdi = l->data))
			continue;
		if (!(devc = sdi->priv))
			continue;
		sr_serial_dev_inst_free(devc->serial);
		sr_dev_inst_free(sdi);
	}
	g_slist_free(drvc->instances);
	drvc->instances = NULL;

	return SR_OK;
}

static int hw_init(void)
{
	struct drv_context *drvc;

	if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
		sr_err("fluke-dmm: driver context malloc failed.");
		return SR_ERR;
	}

	di->priv = drvc;

	return SR_OK;
}

static int serial_readline(int fd, char **buf, int *buflen, uint64_t timeout_ms)
{
	uint64_t start;
	int maxlen, len;

	timeout_ms *= 1000;
	start = g_get_monotonic_time();

	maxlen = *buflen;
	*buflen = len = 0;
	while(1) {
		len = maxlen - *buflen - 1;
		if (len < 1)
			break;
		len = serial_read(fd, *buf + *buflen, len);
		if (len > 0) {
			*buflen += len;
			*(*buf + *buflen) = '\0';
			if (*buflen > 0 && *(*buf + *buflen - 1) == '\r')
				/* End of line */
				break;
		}
		if (g_get_monotonic_time() - start > timeout_ms)
			/* Timeout */
			break;
		g_usleep(2000);
	}

	/* Strip CRLF */
	while (*buflen) {
		if (*(*buf + *buflen - 1) == '\r' || *(*buf + *buflen - 1) == '\n')
			*(*buf + --*buflen) = '\0';
		else
			break;
	}
	if (*buflen)
		sr_dbg("fluke-dmm: received '%s'", *buf);

	return SR_OK;
}

static GSList *hw_scan(GSList *options)
{
	struct sr_dev_inst *sdi;
	struct drv_context *drvc;
	struct dev_context *devc;
	struct sr_hwopt *opt;
	struct sr_probe *probe;
	GSList *l, *devices;
	int len, fd, i;
	const char *conn, *serialcomm;
	char *buf, **tokens;

	drvc = di->priv;
	drvc->instances = NULL;

	devices = NULL;
	conn = serialcomm = NULL;
	for (l = options; l; l = l->next) {
		opt = l->data;
		switch (opt->hwopt) {
		case SR_HWOPT_CONN:
			conn = opt->value;
			break;
		case SR_HWOPT_SERIALCOMM:
			serialcomm = opt->value;
			break;
		}
	}
	if (!conn) {
		sr_dbg("fluke-dmm: no serial port provided");
		return NULL;
	}
	if (!serialcomm) {
		sr_dbg("fluke-dmm: no serial communication parameters provided");
		return NULL;
	}

	if ((fd = serial_open(conn, O_RDWR|O_NONBLOCK)) == -1) {
		sr_err("fluke-dmm: unable to open %s: %s", conn, strerror(errno));
		return NULL;
	}

	if (serial_set_paramstr(fd, serialcomm) != SR_OK) {
		sr_err("fluke-dmm: unable to set serial parameters: %s",
				strerror(errno));
		return NULL;
	}

	serial_flush(fd);
	if (serial_write(fd, "ID\r", 3) == -1) {
		sr_err("fluke-dmm: unable to send identification string: %s",
				strerror(errno));
		return NULL;
	}

	len = 128;
	buf = g_try_malloc(len);
	serial_readline(fd, &buf, &len, 150);
	if (!len)
		return NULL;

	if (len < 2 || buf[0] != '0' || buf[1] != '\r') {
		sr_err("fluke-dmm: invalid response to identification string");
		return NULL;
	}

	tokens = g_strsplit(buf + 2, ",", 3);
	if (!strncmp("FLUKE", tokens[0], 5)
			&& tokens[1] && tokens[2]) {
		for (i = 0; supported_flukedmm[i].model; i++) {
			if (strcmp(supported_flukedmm[i].modelname, tokens[0]))
				continue;
			if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, "Fluke",
					tokens[0] + 6, tokens[1])))
				return NULL;
			if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
				sr_dbg("fluke-dmm: failed to malloc devc");
				return NULL;
			}
			devc->profile = &supported_flukedmm[i];
			devc->serial = sr_serial_dev_inst_new(conn, -1);
			sdi->priv = devc;
			sdi->driver = di;
			if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
				return NULL;
			sdi->probes = g_slist_append(sdi->probes, probe);
			drvc->instances = g_slist_append(drvc->instances, sdi);
			devices = g_slist_append(devices, sdi);
			break;
		}
	}
	g_strfreev(tokens);
	g_free(buf);

	serial_close(fd);

	return devices;
}

static GSList *hw_dev_list(void)
{
	struct drv_context *drvc;

	drvc = di->priv;

	return drvc->instances;
}

static int hw_dev_open(struct sr_dev_inst *sdi)
{

	/* TODO */

	return SR_OK;
}

static int hw_dev_close(struct sr_dev_inst *sdi)
{

	/* TODO */

	return SR_OK;
}

static int hw_cleanup(void)
{

	clear_instances();

	/* TODO */

	return SR_OK;
}

static int hw_info_get(int info_id, const void **data,
       const struct sr_dev_inst *sdi)
{


	switch (info_id) {
	/* TODO */
	default:
		return SR_ERR_ARG;
	}

	return SR_OK;
}

static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
		const void *value)
{
	int ret;

	if (sdi->status != SR_ST_ACTIVE)
		return SR_ERR;

	ret = SR_OK;
	switch (hwcap) {
	/* TODO */
	default:
		ret = SR_ERR_ARG;
	}

	return ret;
}

static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
		void *cb_data)
{

	/* TODO */

	return SR_OK;
}

static int hw_dev_acquisition_stop(const struct sr_dev_inst *sdi,
		void *cb_data)
{

	(void)cb_data;

	if (sdi->status != SR_ST_ACTIVE)
		return SR_ERR;

	/* TODO */

	return SR_OK;
}

SR_PRIV struct sr_dev_driver flukedmm_driver_info = {
	.name = "fluke-dmm",
	.longname = "Fluke 18x/28x series DMMs",
	.api_version = 1,
	.init = hw_init,
	.cleanup = hw_cleanup,
	.scan = hw_scan,
	.dev_list = hw_dev_list,
	.dev_clear = clear_instances,
	.dev_open = hw_dev_open,
	.dev_close = hw_dev_close,
	.info_get = hw_info_get,
	.dev_config_set = hw_dev_config_set,
	.dev_acquisition_start = hw_dev_acquisition_start,
	.dev_acquisition_stop = hw_dev_acquisition_stop,
	.priv = NULL,
};
Commit	Line	Data
883a2e9e BV	1	/*
	2	* This file is part of the sigrok project.
	3	*
	4	* Copyright (C) 2012 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
	20	#include <glib.h>
	21	#include "libsigrok.h"
	22	#include "libsigrok-internal.h"
	23	#include "config.h"
4f958423 BV	24	#include "fluke-dmm.h"
	25	#include <sys/types.h>
	26	#include <sys/stat.h>
	27	#include <fcntl.h>
	28	#include <string.h>
	29	#include <errno.h>
883a2e9e BV	30
883a2e9e BV	31
e7edd64f BV	32	SR_PRIV struct sr_dev_driver flukedmm_driver_info;
e7edd64f BV	33	static struct sr_dev_driver *di = &flukedmm_driver_info;
883a2e9e	34
4f958423 BV	35	static const struct flukedmm_profile supported_flukedmm[] = {
	36	{ FLUKE_187, "187" },
	37	};
	38
883a2e9e BV	39
	40	/* Properly close and free all devices. */
	41	static int clear_instances(void)
	42	{
	43	struct sr_dev_inst *sdi;
	44	struct drv_context *drvc;
	45	struct dev_context *devc;
	46	GSList *l;
	47
4f958423 BV	48	if (!(drvc = di->priv))
	49	return SR_OK;
	50
883a2e9e BV	51	drvc = di->priv;
883a2e9e BV	52	for (l = drvc->instances; l; l = l->next) {
4f958423	53	if (!(sdi = l->data))
883a2e9e	54	continue;
4f958423	55	if (!(devc = sdi->priv))
883a2e9e	56	continue;
4f958423	57	sr_serial_dev_inst_free(devc->serial);
883a2e9e BV	58	sr_dev_inst_free(sdi);
883a2e9e BV	59	}
883a2e9e BV	60	g_slist_free(drvc->instances);
	61	drvc->instances = NULL;
	62
	63	return SR_OK;
	64	}
	65
	66	static int hw_init(void)
	67	{
	68	struct drv_context *drvc;
	69
	70	if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
4f958423	71	sr_err("fluke-dmm: driver context malloc failed.");
883a2e9e BV	72	return SR_ERR;
	73	}
	74
883a2e9e BV	75	di->priv = drvc;
	76
	77	return SR_OK;
	78	}
	79
4f958423 BV	80	static int serial_readline(int fd, char *buf, int buflen, uint64_t timeout_ms)
	81	{
	82	uint64_t start;
	83	int maxlen, len;
	84
	85	timeout_ms *= 1000;
	86	start = g_get_monotonic_time();
	87
	88	maxlen = *buflen;
	89	*buflen = len = 0;
	90	while(1) {
	91	len = maxlen - *buflen - 1;
	92	if (len < 1)
	93	break;
	94	len = serial_read(fd, buf + buflen, len);
	95	if (len > 0) {
	96	*buflen += len;
	97	(buf + *buflen) = '\0';
	98	if (buflen > 0 && (buf + buflen - 1) == '\r')
	99	/* End of line */
	100	break;
	101	}
	102	if (g_get_monotonic_time() - start > timeout_ms)
	103	/* Timeout */
	104	break;
	105	g_usleep(2000);
	106	}
	107
	108	/* Strip CRLF */
	109	while (*buflen) {
	110	if ((buf + buflen - 1) == '\r' \|\| (buf + buflen - 1) == '\n')
	111	(buf + --*buflen) = '\0';
	112	else
	113	break;
	114	}
	115	if (*buflen)
	116	sr_dbg("fluke-dmm: received '%s'", *buf);
	117
	118	return SR_OK;
	119	}
	120
883a2e9e BV	121	static GSList hw_scan(GSList options)
883a2e9e BV	122	{
4f958423	123	struct sr_dev_inst *sdi;
883a2e9e	124	struct drv_context *drvc;
4f958423 BV	125	struct dev_context *devc;
	126	struct sr_hwopt *opt;
	127	struct sr_probe *probe;
	128	GSList l, devices;
	129	int len, fd, i;
	130	const char conn, serialcomm;
	131	char buf, *tokens;
883a2e9e	132
883a2e9e BV	133	drvc = di->priv;
	134	drvc->instances = NULL;
	135
4f958423 BV	136	devices = NULL;
	137	conn = serialcomm = NULL;
	138	for (l = options; l; l = l->next) {
	139	opt = l->data;
	140	switch (opt->hwopt) {
	141	case SR_HWOPT_CONN:
	142	conn = opt->value;
	143	break;
	144	case SR_HWOPT_SERIALCOMM:
	145	serialcomm = opt->value;
	146	break;
	147	}
	148	}
	149	if (!conn) {
	150	sr_dbg("fluke-dmm: no serial port provided");
	151	return NULL;
	152	}
	153	if (!serialcomm) {
	154	sr_dbg("fluke-dmm: no serial communication parameters provided");
	155	return NULL;
	156	}
	157
	158	if ((fd = serial_open(conn, O_RDWR\|O_NONBLOCK)) == -1) {
	159	sr_err("fluke-dmm: unable to open %s: %s", conn, strerror(errno));
	160	return NULL;
	161	}
	162
	163	if (serial_set_paramstr(fd, serialcomm) != SR_OK) {
	164	sr_err("fluke-dmm: unable to set serial parameters: %s",
	165	strerror(errno));
	166	return NULL;
	167	}
	168
	169	serial_flush(fd);
	170	if (serial_write(fd, "ID\r", 3) == -1) {
	171	sr_err("fluke-dmm: unable to send identification string: %s",
	172	strerror(errno));
	173	return NULL;
	174	}
	175
	176	len = 128;
	177	buf = g_try_malloc(len);
	178	serial_readline(fd, &buf, &len, 150);
	179	if (!len)
	180	return NULL;
	181
	182	if (len < 2 \|\| buf[0] != '0' \|\| buf[1] != '\r') {
	183	sr_err("fluke-dmm: invalid response to identification string");
	184	return NULL;
	185	}
	186
	187	tokens = g_strsplit(buf + 2, ",", 3);
	188	if (!strncmp("FLUKE", tokens[0], 5)
	189	&& tokens[1] && tokens[2]) {
	190	for (i = 0; supported_flukedmm[i].model; i++) {
	191	if (strcmp(supported_flukedmm[i].modelname, tokens[0]))
	192	continue;
	193	if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, "Fluke",
	194	tokens[0] + 6, tokens[1])))
	195	return NULL;
	196	if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
	197	sr_dbg("fluke-dmm: failed to malloc devc");
	198	return NULL;
	199	}
200	devc->profile = &supported_flukedmm[i];
201	devc->serial = sr_serial_dev_inst_new(conn, -1);
202	sdi->priv = devc;
203	sdi->driver = di;
204	if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
205	return NULL;
206	sdi->probes = g_slist_append(sdi->probes, probe);
207	drvc->instances = g_slist_append(drvc->instances, sdi);
208	devices = g_slist_append(devices, sdi);
209	break;
210	}
211	}
212	g_strfreev(tokens);
213	g_free(buf);
214
215	serial_close(fd);
883a2e9e BV	216
	217	return devices;
	218	}
	219
	220	static GSList *hw_dev_list(void)
	221	{
	222	struct drv_context *drvc;
	223
	224	drvc = di->priv;
	225
	226	return drvc->instances;
	227	}
	228
	229	static int hw_dev_open(struct sr_dev_inst *sdi)
	230	{
	231
	232	/* TODO */
	233
	234	return SR_OK;
	235	}
	236
	237	static int hw_dev_close(struct sr_dev_inst *sdi)
	238	{
	239
	240	/* TODO */
	241
	242	return SR_OK;
	243	}
	244
	245	static int hw_cleanup(void)
	246	{
	247
	248	clear_instances();
	249
	250	/* TODO */
	251
	252	return SR_OK;
	253	}
	254
	255	static int hw_info_get(int info_id, const void **data,
	256	const struct sr_dev_inst *sdi)
	257	{
	258
	259
	260	switch (info_id) {
	261	/* TODO */
	262	default:
	263	return SR_ERR_ARG;
	264	}
	265
	266	return SR_OK;
	267	}
	268
	269	static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
	270	const void *value)
	271	{
	272	int ret;
	273
	274	if (sdi->status != SR_ST_ACTIVE)
	275	return SR_ERR;
	276
	277	ret = SR_OK;
	278	switch (hwcap) {
	279	/* TODO */
280	default:
281	ret = SR_ERR_ARG;
282	}
283
284	return ret;
285	}
286
287	static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
288	void *cb_data)
289	{
290
291	/* TODO */
292
293	return SR_OK;
294	}
295
296	static int hw_dev_acquisition_stop(const struct sr_dev_inst *sdi,
297	void *cb_data)
298	{
299
300	(void)cb_data;
301
302	if (sdi->status != SR_ST_ACTIVE)
303	return SR_ERR;
304
305	/* TODO */
306
307	return SR_OK;
308	}
309
e7edd64f	310	SR_PRIV struct sr_dev_driver flukedmm_driver_info = {
883a2e9e BV	311	.name = "fluke-dmm",
	312	.longname = "Fluke 18x/28x series DMMs",
	313	.api_version = 1,
	314	.init = hw_init,
	315	.cleanup = hw_cleanup,
	316	.scan = hw_scan,
	317	.dev_list = hw_dev_list,
	318	.dev_clear = clear_instances,
	319	.dev_open = hw_dev_open,
	320	.dev_close = hw_dev_close,
	321	.info_get = hw_info_get,
	322	.dev_config_set = hw_dev_config_set,
	323	.dev_acquisition_start = hw_dev_acquisition_start,
	324	.dev_acquisition_stop = hw_dev_acquisition_stop,
	325	.priv = NULL,
	326	};