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

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2013 Matthias Heidbrink <m-sigrok@heidbrink.biz>
 *
 * 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 "protocol.h"

static const int32_t hwopts[] = {
	SR_CONF_CONN,
	SR_CONF_SERIALCOMM,
};

static const int32_t hwcaps[] = {
	SR_CONF_MULTIMETER,
	SR_CONF_LIMIT_SAMPLES,
	SR_CONF_LIMIT_MSEC,
	SR_CONF_CONTINUOUS,
};

#define BUF_MAX 50

#define SERIALCOMM "4800/8n1/dtr=1/rts=0/flow=1"

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

static int init(struct sr_context *sr_ctx)
{
	return std_init(sr_ctx, di, LOG_PREFIX);
}

static GSList *scan(GSList *options)
{
	struct sr_dev_inst *sdi;
	struct drv_context *drvc;
	struct dev_context *devc;
	struct sr_config *src;
	struct sr_probe *probe;
	struct sr_serial_dev_inst *serial;
	GSList *l, *devices;
	int len, cnt;
	const char *conn, *serialcomm;
	char *buf;
	char fmttype[10];
	char req[10];
	int auxtype;

	devices = NULL;
	drvc = di->priv;
	drvc->instances = NULL;
	conn = serialcomm = NULL;

	for (l = options; l; l = l->next) {
		src = l->data;
		switch (src->key) {
		case SR_CONF_CONN:
			conn = g_variant_get_string(src->data, NULL);
			break;
		case SR_CONF_SERIALCOMM:
			serialcomm = g_variant_get_string(src->data, NULL);
			break;
		}
	}
	if (!conn)
		return NULL;
	if (!serialcomm)
		serialcomm = SERIALCOMM;

	if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
		return NULL;

	if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
		return NULL;

	serial_flush(serial);

	if (!(buf = g_try_malloc(BUF_MAX))) {
		sr_err("Serial buffer malloc failed.");
		return NULL;
	}

	snprintf(req, sizeof(req), "%s\r\n",
		 nmadmm_requests[NMADMM_REQ_IDN].req_str);
	for (cnt = 0; cnt < 7; cnt++) {
		if (serial_write(serial, req, strlen(req)) == -1) {
			sr_err("Unable to send identification request: %d %s.",
			       errno, strerror(errno));
			return NULL;
		}
		len = BUF_MAX;
		serial_readline(serial, &buf, &len, 1500);
		if (!len)
			continue;
		buf[BUF_MAX - 1] = '\0';

		/* Match ID string, e.g. "1834 065 V1.06,IF V1.02" (DM950) */
		if (g_regex_match_simple("^1834 [^,]*,IF V*", (char *)buf, 0, 0)) {
			auxtype = xgittoint(buf[7]);
				// TODO: Will this work with non-DM950?
			snprintf(fmttype, sizeof(fmttype), "DM9%d0", auxtype);
			sr_spew("Norma %s DMM %s detected!", fmttype, &buf[9]);

			if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE,
						"Norma", fmttype, buf + 9)))
				return NULL;
			if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
				sr_err("Device context malloc failed.");
				return NULL;
			}
			devc->type = auxtype;
			devc->version = g_strdup(&buf[9]);
			devc->elapsed_msec = g_timer_new();

			sdi->conn = serial;
			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;
		}

		/*
		 * The interface of the DM9x0 contains a cap that needs to
		 * charge for up to 10s before the interface works, if not
		 * powered externally. Therefore wait a little to improve
		 * chances.
		 */
		if (cnt == 3) {
			sr_info("Waiting 5s to allow interface to settle.");
			g_usleep(5 * 1000 * 1000);
		}
	}

	g_free(buf);

	serial_close(serial);
	if (!devices)
		sr_serial_dev_inst_free(serial);

	return devices;
}

static GSList *dev_list(void)
{
	return ((struct drv_context *)(di->priv))->instances;
}

static int dev_clear(void)
{
	return std_dev_clear(di, NULL);
}

static int dev_open(struct sr_dev_inst *sdi)
{
	struct sr_serial_dev_inst *serial;

	serial = sdi->conn;
	if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
		return SR_ERR;

	sdi->status = SR_ST_ACTIVE;

	return SR_OK;
}

static int dev_close(struct sr_dev_inst *sdi)
{
	struct sr_serial_dev_inst *serial;
	struct dev_context *devc;

	serial = sdi->conn;
	if (serial && serial->fd != -1) {
		serial_close(serial);
		sdi->status = SR_ST_INACTIVE;
	}

	/* Free dynamically allocated resources. */
	if ((devc = sdi->priv) && devc->version) {
		g_free(devc->version);
		devc->version = NULL;
		g_timer_destroy(devc->elapsed_msec);
	}

	return SR_OK;
}

static int cleanup(void)
{
	return dev_clear();
}

static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi)
{
	struct dev_context *devc;

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

	if (!(devc = sdi->priv)) {
		sr_err("sdi->priv was NULL.");
		return SR_ERR_BUG;
	}

	switch (key) {
	case SR_CONF_LIMIT_MSEC:
		/* TODO: not yet implemented */
		if (g_variant_get_uint64(data) == 0) {
			sr_err("LIMIT_MSEC can't be 0.");
			return SR_ERR;
		}
		devc->limit_msec = g_variant_get_uint64(data);
		sr_dbg("Setting time limit to %" PRIu64 "ms.",
		       devc->limit_msec);
		break;
	case SR_CONF_LIMIT_SAMPLES:
		devc->limit_samples = g_variant_get_uint64(data);
		sr_dbg("Setting sample limit to %" PRIu64 ".",
		       devc->limit_samples);
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
{
	(void)sdi;

	switch (key) {
	case SR_CONF_SCAN_OPTIONS:
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
				hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
		break;
	case SR_CONF_DEVICE_OPTIONS:
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
				hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

static int dev_acquisition_start(const struct sr_dev_inst *sdi,
				    void *cb_data)
{
	struct dev_context *devc;
	struct sr_serial_dev_inst *serial;

	(void)sdi;
	(void)cb_data;

	if (!sdi || !cb_data || !(devc = sdi->priv))
		return SR_ERR_BUG;

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

	devc->cb_data = cb_data;

	/* Send header packet to the session bus. */
	std_session_send_df_header(cb_data, LOG_PREFIX);

	/* Start timer, if required. */
	if (devc->limit_msec)
		g_timer_start(devc->elapsed_msec);

	/* Poll every 100ms, or whenever some data comes in. */
	serial = sdi->conn;
	sr_source_add(serial->fd, G_IO_IN, 100, norma_dmm_receive_data,
		      (void *)sdi);

	return SR_OK;
}

static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
{
	struct dev_context *devc;

	/* Stop timer, if required. */
	if (sdi && (devc = sdi->priv) && devc->limit_msec)
		g_timer_stop(devc->elapsed_msec);

	return std_dev_acquisition_stop_serial(sdi, cb_data, dev_close,
			sdi->conn, LOG_PREFIX);
}

SR_PRIV struct sr_dev_driver norma_dmm_driver_info = {
	.name = "norma-dmm",
	.longname = "Norma DM9x0 / Siemens B102x DMMs",
	.api_version = 1,
	.init = init,
	.cleanup = cleanup,
	.scan = scan,
	.dev_list = dev_list,
	.dev_clear = dev_clear,
	.config_get = NULL,
	.config_set = config_set,
	.config_list = config_list,
	.dev_open = dev_open,
	.dev_close = dev_close,
	.dev_acquisition_start = dev_acquisition_start,
	.dev_acquisition_stop = dev_acquisition_stop,
	.priv = NULL,
};
Commit	Line	Data
bfd48770 MH	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2013 Matthias Heidbrink <m-sigrok@heidbrink.biz>
	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 "protocol.h"
	21
f8e76e2e MH	22	static const int32_t hwopts[] = {
	23	SR_CONF_CONN,
	24	SR_CONF_SERIALCOMM,
	25	};
	26
	27	static const int32_t hwcaps[] = {
	28	SR_CONF_MULTIMETER,
	29	SR_CONF_LIMIT_SAMPLES,
	30	SR_CONF_LIMIT_MSEC,
	31	SR_CONF_CONTINUOUS,
	32	};
	33
e790bd5c	34	#define BUF_MAX 50
f8e76e2e MH	35
	36	#define SERIALCOMM "4800/8n1/dtr=1/rts=0/flow=1"
	37
bfd48770 MH	38	SR_PRIV struct sr_dev_driver norma_dmm_driver_info;
	39	static struct sr_dev_driver *di = &norma_dmm_driver_info;
	40
	41	static int init(struct sr_context *sr_ctx)
	42	{
	43	return std_init(sr_ctx, di, LOG_PREFIX);
	44	}
	45
	46	static GSList scan(GSList options)
	47	{
f8e76e2e	48	struct sr_dev_inst *sdi;
bfd48770	49	struct drv_context *drvc;
f8e76e2e MH	50	struct dev_context *devc;
	51	struct sr_config *src;
	52	struct sr_probe *probe;
	53	struct sr_serial_dev_inst *serial;
	54	GSList l, devices;
	55	int len, cnt;
	56	const char conn, serialcomm;
	57	char *buf;
	58	char fmttype[10];
	59	char req[10];
	60	int auxtype;
	61
bfd48770 MH	62	devices = NULL;
	63	drvc = di->priv;
	64	drvc->instances = NULL;
f8e76e2e MH	65	conn = serialcomm = NULL;
	66
	67	for (l = options; l; l = l->next) {
	68	src = l->data;
	69	switch (src->key) {
	70	case SR_CONF_CONN:
	71	conn = g_variant_get_string(src->data, NULL);
	72	break;
	73	case SR_CONF_SERIALCOMM:
	74	serialcomm = g_variant_get_string(src->data, NULL);
	75	break;
	76	}
	77	}
	78	if (!conn)
	79	return NULL;
	80	if (!serialcomm)
	81	serialcomm = SERIALCOMM;
	82
	83	if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
	84	return NULL;
	85
	86	if (serial_open(serial, SERIAL_RDWR \| SERIAL_NONBLOCK) != SR_OK)
	87	return NULL;
	88
	89	serial_flush(serial);
bfd48770	90
e790bd5c	91	if (!(buf = g_try_malloc(BUF_MAX))) {
f8e76e2e MH	92	sr_err("Serial buffer malloc failed.");
	93	return NULL;
	94	}
	95
	96	snprintf(req, sizeof(req), "%s\r\n",
e790bd5c	97	nmadmm_requests[NMADMM_REQ_IDN].req_str);
f8e76e2e MH	98	for (cnt = 0; cnt < 7; cnt++) {
	99	if (serial_write(serial, req, strlen(req)) == -1) {
	100	sr_err("Unable to send identification request: %d %s.",
e790bd5c	101	errno, strerror(errno));
f8e76e2e MH	102	return NULL;
	103	}
	104	len = BUF_MAX;
	105	serial_readline(serial, &buf, &len, 1500);
	106	if (!len)
	107	continue;
e790bd5c	108	buf[BUF_MAX - 1] = '\0';
f8e76e2e	109
e790bd5c UH	110	/* Match ID string, e.g. "1834 065 V1.06,IF V1.02" (DM950) */
e790bd5c UH	111	if (g_regex_match_simple("^1834 [^,],IF V", (char *)buf, 0, 0)) {
f8e76e2e MH	112	auxtype = xgittoint(buf[7]);
	113	// TODO: Will this work with non-DM950?
	114	snprintf(fmttype, sizeof(fmttype), "DM9%d0", auxtype);
	115	sr_spew("Norma %s DMM %s detected!", fmttype, &buf[9]);
	116
	117	if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE,
	118	"Norma", fmttype, buf + 9)))
	119	return NULL;
e790bd5c	120	if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
f8e76e2e MH	121	sr_err("Device context malloc failed.");
	122	return NULL;
	123	}
	124	devc->type = auxtype;
	125	devc->version = g_strdup(&buf[9]);
	126	devc->elapsed_msec = g_timer_new();
	127
	128	sdi->conn = serial;
	129	sdi->priv = devc;
	130	sdi->driver = di;
	131	if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE,
	132	"P1")))
	133	return NULL;
	134	sdi->probes = g_slist_append(sdi->probes, probe);
	135	drvc->instances = g_slist_append(drvc->instances, sdi);
	136	devices = g_slist_append(devices, sdi);
	137	break;
	138	}
e790bd5c UH	139
	140	/*
	141	* The interface of the DM9x0 contains a cap that needs to
	142	* charge for up to 10s before the interface works, if not
	143	* powered externally. Therefore wait a little to improve
	144	* chances.
	145	*/
f8e76e2e MH	146	if (cnt == 3) {
	147	sr_info("Waiting 5s to allow interface to settle.");
	148	g_usleep(5 * 1000 * 1000);
	149	}
	150	}
	151
	152	g_free(buf);
	153
	154	serial_close(serial);
	155	if (!devices)
	156	sr_serial_dev_inst_free(serial);
bfd48770 MH	157
	158	return devices;
	159	}
	160
	161	static GSList *dev_list(void)
	162	{
	163	return ((struct drv_context *)(di->priv))->instances;
	164	}
	165
	166	static int dev_clear(void)
	167	{
	168	return std_dev_clear(di, NULL);
	169	}
	170
	171	static int dev_open(struct sr_dev_inst *sdi)
	172	{
f8e76e2e	173	struct sr_serial_dev_inst *serial;
bfd48770	174
f8e76e2e MH	175	serial = sdi->conn;
	176	if (serial_open(serial, SERIAL_RDWR \| SERIAL_NONBLOCK) != SR_OK)
	177	return SR_ERR;
bfd48770 MH	178
	179	sdi->status = SR_ST_ACTIVE;
	180
	181	return SR_OK;
	182	}
	183
	184	static int dev_close(struct sr_dev_inst *sdi)
	185	{
f8e76e2e MH	186	struct sr_serial_dev_inst *serial;
f8e76e2e MH	187	struct dev_context *devc;
bfd48770	188
f8e76e2e MH	189	serial = sdi->conn;
	190	if (serial && serial->fd != -1) {
	191	serial_close(serial);
	192	sdi->status = SR_ST_INACTIVE;
	193	}
bfd48770	194
e790bd5c	195	/* Free dynamically allocated resources. */
f8e76e2e MH	196	if ((devc = sdi->priv) && devc->version) {
	197	g_free(devc->version);
	198	devc->version = NULL;
	199	g_timer_destroy(devc->elapsed_msec);
	200	}
bfd48770 MH	201
	202	return SR_OK;
	203	}
	204
	205	static int cleanup(void)
	206	{
f8e76e2e	207	return dev_clear();
bfd48770 MH	208	}
bfd48770 MH	209
bfd48770 MH	210	static int config_set(int key, GVariant data, const struct sr_dev_inst sdi)
bfd48770 MH	211	{
f8e76e2e	212	struct dev_context *devc;
bfd48770 MH	213
	214	if (sdi->status != SR_ST_ACTIVE)
	215	return SR_ERR_DEV_CLOSED;
	216
f8e76e2e MH	217	if (!(devc = sdi->priv)) {
	218	sr_err("sdi->priv was NULL.");
	219	return SR_ERR_BUG;
	220	}
	221
bfd48770	222	switch (key) {
f8e76e2e MH	223	case SR_CONF_LIMIT_MSEC:
	224	/* TODO: not yet implemented */
	225	if (g_variant_get_uint64(data) == 0) {
	226	sr_err("LIMIT_MSEC can't be 0.");
	227	return SR_ERR;
	228	}
	229	devc->limit_msec = g_variant_get_uint64(data);
	230	sr_dbg("Setting time limit to %" PRIu64 "ms.",
	231	devc->limit_msec);
	232	break;
	233	case SR_CONF_LIMIT_SAMPLES:
	234	devc->limit_samples = g_variant_get_uint64(data);
	235	sr_dbg("Setting sample limit to %" PRIu64 ".",
	236	devc->limit_samples);
	237	break;
bfd48770	238	default:
f8e76e2e	239	return SR_ERR_NA;
bfd48770 MH	240	}
bfd48770 MH	241
f8e76e2e	242	return SR_OK;
bfd48770 MH	243	}
	244
	245	static int config_list(int key, GVariant *data, const struct sr_dev_inst sdi)
	246	{
bfd48770	247	(void)sdi;
bfd48770	248
bfd48770	249	switch (key) {
f8e76e2e MH	250	case SR_CONF_SCAN_OPTIONS:
	251	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
	252	hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
	253	break;
	254	case SR_CONF_DEVICE_OPTIONS:
	255	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
	256	hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
	257	break;
bfd48770 MH	258	default:
	259	return SR_ERR_NA;
	260	}
	261
f8e76e2e	262	return SR_OK;
bfd48770 MH	263	}
	264
	265	static int dev_acquisition_start(const struct sr_dev_inst *sdi,
	266	void *cb_data)
	267	{
f8e76e2e MH	268	struct dev_context *devc;
	269	struct sr_serial_dev_inst *serial;
	270
bfd48770 MH	271	(void)sdi;
	272	(void)cb_data;
	273
f8e76e2e MH	274	if (!sdi \|\| !cb_data \|\| !(devc = sdi->priv))
	275	return SR_ERR_BUG;
	276
bfd48770 MH	277	if (sdi->status != SR_ST_ACTIVE)
	278	return SR_ERR_DEV_CLOSED;
	279
f8e76e2e MH	280	devc->cb_data = cb_data;
	281
	282	/* Send header packet to the session bus. */
	283	std_session_send_df_header(cb_data, LOG_PREFIX);
	284
	285	/* Start timer, if required. */
	286	if (devc->limit_msec)
	287	g_timer_start(devc->elapsed_msec);
	288
	289	/* Poll every 100ms, or whenever some data comes in. */
	290	serial = sdi->conn;
	291	sr_source_add(serial->fd, G_IO_IN, 100, norma_dmm_receive_data,
	292	(void *)sdi);
bfd48770 MH	293
	294	return SR_OK;
	295	}
	296
	297	static int dev_acquisition_stop(struct sr_dev_inst sdi, void cb_data)
	298	{
f8e76e2e	299	struct dev_context *devc;
bfd48770	300
f8e76e2e MH	301	/* Stop timer, if required. */
	302	if (sdi && (devc = sdi->priv) && devc->limit_msec)
	303	g_timer_stop(devc->elapsed_msec);
bfd48770	304
f8e76e2e MH	305	return std_dev_acquisition_stop_serial(sdi, cb_data, dev_close,
f8e76e2e MH	306	sdi->conn, LOG_PREFIX);
bfd48770 MH	307	}
	308
	309	SR_PRIV struct sr_dev_driver norma_dmm_driver_info = {
	310	.name = "norma-dmm",
e790bd5c	311	.longname = "Norma DM9x0 / Siemens B102x DMMs",
bfd48770 MH	312	.api_version = 1,
	313	.init = init,
	314	.cleanup = cleanup,
	315	.scan = scan,
	316	.dev_list = dev_list,
	317	.dev_clear = dev_clear,
f8e76e2e	318	.config_get = NULL,
bfd48770 MH	319	.config_set = config_set,
	320	.config_list = config_list,
	321	.dev_open = dev_open,
	322	.dev_close = dev_close,
	323	.dev_acquisition_start = dev_acquisition_start,
	324	.dev_acquisition_stop = dev_acquisition_stop,
	325	.priv = NULL,
	326	};