[libsigrok.git] / src / 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/>.
 */

/** @file
 *  Norma DM9x0/Siemens B102x DMMs driver.
 *  @internal
 */

#include "protocol.h"

static const uint32_t scanopts[] = {
	SR_CONF_CONN,
	SR_CONF_SERIALCOMM,
};

static const uint32_t devopts[] = {
	SR_CONF_MULTIMETER,
	SR_CONF_CONTINUOUS,
	SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
	SR_CONF_LIMIT_MSEC | SR_CONF_SET,
};

#define BUF_MAX 50

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

SR_PRIV struct sr_dev_driver norma_dmm_driver_info;
SR_PRIV struct sr_dev_driver siemens_b102x_driver_info;

static const char* get_brandstr(struct sr_dev_driver* drv)
{
	if (drv == &norma_dmm_driver_info)
		return "Norma";
	else
		return "Siemens";
}

static const char* get_typestr(int type, struct sr_dev_driver* drv)
{
	static const char* nameref[5][2] = {
		{"DM910", "B1024"},
		{"DM920", "B1025"},
		{"DM930", "B1026"},
		{"DM940", "B1027"},
		{"DM950", "B1028"}};

	if ((type < 1) || (type > 5))
		return "Unknown type!";

	return nameref[type-1][(drv == &siemens_b102x_driver_info)];
}

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

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

	devices = NULL;
	drvc = drv->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;

	serial = sr_serial_dev_inst_new(conn, serialcomm);

	if (serial_open(serial, SERIAL_RDWR) != 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);
	g_usleep(150 * 1000); /* Wait a little to allow serial port to settle. */
	for (cnt = 0; cnt < 7; cnt++) {
		if (serial_write_blocking(serial, req, strlen(req), 0) < 0) {
			sr_err("Unable to send identification request.");
			return NULL;
		}
		len = BUF_MAX;
		serial_readline(serial, &buf, &len, NMADMM_TIMEOUT_MS);
		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]);
			sr_spew("%s %s DMM %s detected!", get_brandstr(drv), get_typestr(auxtype, drv), buf + 9);

			sdi = g_malloc0(sizeof(struct sr_dev_inst));
			sdi->status = SR_ST_INACTIVE;
			sdi->vendor = g_strdup(get_brandstr(drv));
			sdi->model = g_strdup(get_typestr(auxtype, drv));
			sdi->version = g_strdup(buf + 9);
			devc = g_malloc0(sizeof(struct dev_context));
			devc->type = auxtype;
			devc->version = g_strdup(&buf[9]);
			devc->elapsed_msec = g_timer_new();
			sdi->conn = serial;
			sdi->priv = devc;
			sdi->driver = drv;
			sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
			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(const struct sr_dev_driver *di)
{
	return ((struct drv_context *)(di->priv))->instances;
}

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

	std_serial_dev_close(sdi);

	/* 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(const struct sr_dev_driver *di)
{
	return std_dev_clear(di, NULL);
}

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

	(void)cg;

	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:
		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(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
		const struct sr_channel_group *cg)
{
	(void)sdi;
	(void)cg;

	switch (key) {
	case SR_CONF_SCAN_OPTIONS:
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
				scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
		break;
	case SR_CONF_DEVICE_OPTIONS:
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
				devopts, ARRAY_SIZE(devopts), sizeof(uint32_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;

	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;
	serial_source_add(sdi->session, serial, 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_serial_dev_acquisition_stop(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 DMMs",
	.api_version = 1,
	.init = init,
	.cleanup = cleanup,
	.scan = scan,
	.dev_list = dev_list,
	.dev_clear = NULL,
	.config_get = NULL,
	.config_set = config_set,
	.config_list = config_list,
	.dev_open = std_serial_dev_open,
	.dev_close = dev_close,
	.dev_acquisition_start = dev_acquisition_start,
	.dev_acquisition_stop = dev_acquisition_stop,
	.priv = NULL,
};


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