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

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2012 Alexandru Gagniuc <mr.nuke.me@gmail.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 "protocol.h"

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

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

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

static int hw_init(struct sr_context *sr_ctx)
{
	return std_hw_init(sr_ctx, di, DRIVER_LOG_DOMAIN);
}

static void free_instance(void *inst)
{
	struct sr_dev_inst *sdi;
	struct dev_context *devc;

	if (!(sdi = inst))
		return;
	if (!(devc = sdi->priv))
		return;
	sr_serial_dev_inst_free(devc->serial);
	sr_dev_inst_free(sdi);
}

/* Properly close and free all devices. */
static int clear_instances(void)
{
	struct drv_context *drvc;

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

	g_slist_free_full(drvc->instances, free_instance);
	drvc->instances = NULL;

	return SR_OK;
}

static GSList *brymen_scan(const char *conn, const char *serialcomm)
{
	struct sr_dev_inst *sdi;
	struct dev_context *devc;
	struct drv_context *drvc;
	struct sr_probe *probe;
	struct sr_serial_dev_inst *serial;
	GSList *devices;
	int ret;
	uint8_t buf[128];
	size_t len;

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

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

	sr_info("Probing port %s.", conn);

	devices = NULL;

	/* Request reading */
	if ((ret = brymen_packet_request(serial)) < 0) {
		sr_err("Unable to send command: %d.", ret);
		goto scan_cleanup;
	}

	len = 128;
	ret = brymen_stream_detect(serial, buf, &len, brymen_packet_length,
			     brymen_packet_is_valid, 1000, 9600);
	if (ret != SR_OK)
		goto scan_cleanup;

	sr_info("Found device on port %s.", conn);

	if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, "Brymen", "BM85x", "")))
		goto scan_cleanup;

	if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
		sr_err("Device context malloc failed.");
		goto scan_cleanup;
	}

	devc->serial = serial;
	drvc = di->priv;
	sdi->priv = devc;
	sdi->driver = di;

	if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
		goto scan_cleanup;

	sdi->probes = g_slist_append(sdi->probes, probe);
	drvc->instances = g_slist_append(drvc->instances, sdi);
	devices = g_slist_append(devices, sdi);

scan_cleanup:
	serial_close(serial);

	return devices;
}

static GSList *hw_scan(GSList *options)
{
	struct drv_context *drvc;
	struct sr_config *src;
	GSList *devices, *l;
	const char *conn, *serialcomm;

	(void)options;

	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 = src->value;
			break;
		case SR_CONF_SERIALCOMM:
			serialcomm = src->value;
			break;
		}
	}
	if (!conn) {
		return NULL;
	}

	if (serialcomm) {
		/* Use the provided comm specs. */
		devices = brymen_scan(conn, serialcomm);
	} else {
		/* But 9600/8n1 should work all of the time. */
		devices = brymen_scan(conn, "9600/8n1/dtr=1/rts=1");
	}

	return devices;
}

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

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

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

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

	sdi->status = SR_ST_ACTIVE;

	return SR_OK;
}

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

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

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

	return SR_OK;
}

static int hw_cleanup(void)
{
	clear_instances();

	return SR_OK;
}

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

	switch (key) {
	case SR_CONF_SCAN_OPTIONS:
		*data = hwopts;
		break;
	case SR_CONF_DEVICE_OPTIONS:
		*data = hwcaps;
		break;
	default:
		sr_err("Unknown config key: %d.", key);
		return SR_ERR_ARG;
	}

	return SR_OK;
}

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

	if (sdi->status != SR_ST_ACTIVE) {
		sr_err("Device inactive, can't set config options.");
		return SR_ERR;
	}

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

	ret = SR_OK;
	switch (id) {
	case SR_CONF_LIMIT_SAMPLES:
		devc->limit_samples = *(const uint64_t *)value;
		break;
	case SR_CONF_LIMIT_MSEC:
		devc->limit_msec = *(const uint64_t *)value;
		break;
	default:
		sr_err("Unknown hardware capability: %d.", id);
		ret = SR_ERR_ARG;
	}

	return ret;
}

static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
				    void *cb_data)
{
	struct sr_datafeed_packet packet;
	struct sr_datafeed_header header;
	struct dev_context *devc;

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

	sr_dbg("Starting acquisition.");

	devc->cb_data = cb_data;

	/*
	 * Reset the number of samples to take. If we've already collected our
	 * quota, but we start a new session, and don't reset this, we'll just
	 * quit without acquiring any new samples.
	 */
	devc->num_samples = 0;
	devc->starttime = g_get_monotonic_time();

	/* Send header packet to the session bus. */
	sr_dbg("Sending SR_DF_HEADER.");
	packet.type = SR_DF_HEADER;
	packet.payload = &header;
	header.feed_version = 1;
	gettimeofday(&header.starttime, NULL);
	sr_session_send(devc->cb_data, &packet);

	/* Poll every 50ms, or whenever some data comes in. */
	sr_source_add(devc->serial->fd, G_IO_IN, 50,
		      brymen_dmm_receive_data, (void *)sdi);

	return SR_OK;
}

static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
{
	struct sr_datafeed_packet packet;
	struct dev_context *devc;

	if (sdi->status != SR_ST_ACTIVE) {
		sr_err("Device inactive, can't stop acquisition.");
		return SR_ERR;
	}

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

	sr_dbg("Stopping acquisition.");

	sr_source_remove(devc->serial->fd);
	hw_dev_close((struct sr_dev_inst *)sdi);

	/* Send end packet to the session bus. */
	sr_dbg("Sending SR_DF_END.");
	packet.type = SR_DF_END;
	sr_session_send(cb_data, &packet);

	return SR_OK;
}

SR_PRIV struct sr_dev_driver brymen_bm857_driver_info = {
	.name = "brymen-bm857",
	.longname = "Brymen BM857",
	.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,
	.config_list = config_list,
	.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
20cbc785 AG	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2012 Alexandru Gagniuc <mr.nuke.me@gmail.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
20cbc785 AG	20	#include "protocol.h"
20cbc785 AG	21
601fb67c AG	22	static const int hwopts[] = {
	23	SR_CONF_CONN,
	24	SR_CONF_SERIALCOMM,
	25	0,
	26	};
	27
	28	static const int hwcaps[] = {
	29	SR_CONF_MULTIMETER,
	30	SR_CONF_LIMIT_SAMPLES,
	31	SR_CONF_CONTINUOUS,
	32	SR_CONF_LIMIT_MSEC,
	33	0,
	34	};
	35
c5d6f5cc UH	36	SR_PRIV struct sr_dev_driver brymen_bm857_driver_info;
c5d6f5cc UH	37	static struct sr_dev_driver *di = &brymen_bm857_driver_info;
20cbc785	38
601fb67c AG	39	static int hw_init(struct sr_context *sr_ctx)
601fb67c AG	40	{
943e94f5	41	return std_hw_init(sr_ctx, di, DRIVER_LOG_DOMAIN);
601fb67c AG	42	}
	43
	44	static void free_instance(void *inst)
	45	{
	46	struct sr_dev_inst *sdi;
	47	struct dev_context *devc;
c5d6f5cc	48
601fb67c AG	49	if (!(sdi = inst))
	50	return;
	51	if (!(devc = sdi->priv))
	52	return;
	53	sr_serial_dev_inst_free(devc->serial);
	54	sr_dev_inst_free(sdi);
	55	}
	56
20cbc785 AG	57	/* Properly close and free all devices. */
	58	static int clear_instances(void)
	59	{
20cbc785	60	struct drv_context *drvc;
20cbc785 AG	61
	62	if (!(drvc = di->priv))
	63	return SR_OK;
	64
601fb67c	65	g_slist_free_full(drvc->instances, free_instance);
20cbc785 AG	66	drvc->instances = NULL;
	67
	68	return SR_OK;
	69	}
	70
601fb67c	71	static GSList brymen_scan(const char conn, const char *serialcomm)
20cbc785	72	{
601fb67c AG	73	struct sr_dev_inst *sdi;
601fb67c AG	74	struct dev_context *devc;
20cbc785	75	struct drv_context *drvc;
601fb67c AG	76	struct sr_probe *probe;
	77	struct sr_serial_dev_inst *serial;
	78	GSList *devices;
	79	int ret;
c5d6f5cc UH	80	uint8_t buf[128];
c5d6f5cc UH	81	size_t len;
20cbc785	82
601fb67c AG	83	if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
	84	return NULL;
	85
c5d6f5cc	86	if (serial_open(serial, SERIAL_RDWR \| SERIAL_NONBLOCK) != SR_OK)
601fb67c AG	87	return NULL;
	88
	89	sr_info("Probing port %s.", conn);
	90
	91	devices = NULL;
	92
	93	/* Request reading */
c5d6f5cc UH	94	if ((ret = brymen_packet_request(serial)) < 0) {
c5d6f5cc UH	95	sr_err("Unable to send command: %d.", ret);
601fb67c	96	goto scan_cleanup;
20cbc785 AG	97	}
20cbc785 AG	98
c5d6f5cc	99	len = 128;
601fb67c AG	100	ret = brymen_stream_detect(serial, buf, &len, brymen_packet_length,
	101	brymen_packet_is_valid, 1000, 9600);
	102	if (ret != SR_OK)
	103	goto scan_cleanup;
20cbc785	104
601fb67c AG	105	sr_info("Found device on port %s.", conn);
	106
	107	if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, "Brymen", "BM85x", "")))
	108	goto scan_cleanup;
	109
	110	if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
	111	sr_err("Device context malloc failed.");
	112	goto scan_cleanup;
	113	}
	114
	115	devc->serial = serial;
	116	drvc = di->priv;
	117	sdi->priv = devc;
	118	sdi->driver = di;
	119
	120	if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
	121	goto scan_cleanup;
	122
	123	sdi->probes = g_slist_append(sdi->probes, probe);
	124	drvc->instances = g_slist_append(drvc->instances, sdi);
	125	devices = g_slist_append(devices, sdi);
	126
601fb67c AG	127	scan_cleanup:
	128	serial_close(serial);
	129
	130	return devices;
20cbc785 AG	131	}
	132
	133	static GSList hw_scan(GSList options)
	134	{
	135	struct drv_context *drvc;
601fb67c AG	136	struct sr_config *src;
	137	GSList devices, l;
	138	const char conn, serialcomm;
20cbc785 AG	139
	140	(void)options;
	141
	142	devices = NULL;
	143	drvc = di->priv;
	144	drvc->instances = NULL;
	145
601fb67c AG	146	conn = serialcomm = NULL;
	147	for (l = options; l; l = l->next) {
	148	src = l->data;
	149	switch (src->key) {
c5d6f5cc UH	150	case SR_CONF_CONN:
	151	conn = src->value;
	152	break;
	153	case SR_CONF_SERIALCOMM:
	154	serialcomm = src->value;
	155	break;
601fb67c AG	156	}
	157	}
	158	if (!conn) {
	159	return NULL;
	160	}
	161
	162	if (serialcomm) {
	163	/* Use the provided comm specs. */
	164	devices = brymen_scan(conn, serialcomm);
	165	} else {
c5d6f5cc	166	/* But 9600/8n1 should work all of the time. */
601fb67c AG	167	devices = brymen_scan(conn, "9600/8n1/dtr=1/rts=1");
601fb67c AG	168	}
20cbc785 AG	169
	170	return devices;
	171	}
	172
	173	static GSList *hw_dev_list(void)
	174	{
0e94d524	175	return ((struct drv_context *)(di->priv))->instances;
20cbc785 AG	176	}
	177
	178	static int hw_dev_open(struct sr_dev_inst *sdi)
	179	{
601fb67c AG	180	struct dev_context *devc;
	181
	182	if (!(devc = sdi->priv)) {
	183	sr_err("sdi->priv was NULL.");
	184	return SR_ERR_BUG;
	185	}
	186
	187	if (serial_open(devc->serial, SERIAL_RDWR \| SERIAL_NONBLOCK) != SR_OK)
	188	return SR_ERR;
	189
	190	sdi->status = SR_ST_ACTIVE;
20cbc785 AG	191
	192	return SR_OK;
	193	}
	194
	195	static int hw_dev_close(struct sr_dev_inst *sdi)
	196	{
601fb67c AG	197	struct dev_context *devc;
	198
	199	if (!(devc = sdi->priv)) {
	200	sr_err("sdi->priv was NULL.");
	201	return SR_ERR_BUG;
	202	}
	203
	204	if (devc->serial && devc->serial->fd != -1) {
	205	serial_close(devc->serial);
	206	sdi->status = SR_ST_INACTIVE;
	207	}
20cbc785 AG	208
	209	return SR_OK;
	210	}
	211
	212	static int hw_cleanup(void)
	213	{
	214	clear_instances();
	215
20cbc785 AG	216	return SR_OK;
	217	}
	218
601fb67c	219	static int config_list(int key, const void **data,
20cbc785 AG	220	const struct sr_dev_inst *sdi)
20cbc785 AG	221	{
601fb67c AG	222	(void)sdi;
	223
	224	switch (key) {
c5d6f5cc UH	225	case SR_CONF_SCAN_OPTIONS:
	226	*data = hwopts;
	227	break;
	228	case SR_CONF_DEVICE_OPTIONS:
	229	*data = hwcaps;
	230	break;
20cbc785	231	default:
601fb67c	232	sr_err("Unknown config key: %d.", key);
20cbc785 AG	233	return SR_ERR_ARG;
	234	}
	235
	236	return SR_OK;
	237	}
	238
601fb67c AG	239	static int hw_dev_config_set(int id, const void *value,
601fb67c AG	240	const struct sr_dev_inst *sdi)
20cbc785	241	{
601fb67c	242	struct dev_context *devc;
20cbc785 AG	243	int ret;
	244
	245	if (sdi->status != SR_ST_ACTIVE) {
	246	sr_err("Device inactive, can't set config options.");
	247	return SR_ERR;
	248	}
	249
601fb67c AG	250	if (!(devc = sdi->priv)) {
	251	sr_err("sdi->priv was NULL.");
	252	return SR_ERR_BUG;
	253	}
	254
20cbc785	255	ret = SR_OK;
601fb67c	256	switch (id) {
c5d6f5cc UH	257	case SR_CONF_LIMIT_SAMPLES:
c5d6f5cc UH	258	devc->limit_samples = (const uint64_t )value;
601fb67c	259	break;
c5d6f5cc UH	260	case SR_CONF_LIMIT_MSEC:
c5d6f5cc UH	261	devc->limit_msec = (const uint64_t )value;
601fb67c	262	break;
20cbc785	263	default:
601fb67c	264	sr_err("Unknown hardware capability: %d.", id);
20cbc785 AG	265	ret = SR_ERR_ARG;
	266	}
	267
	268	return ret;
	269	}
	270
	271	static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
	272	void *cb_data)
	273	{
601fb67c AG	274	struct sr_datafeed_packet packet;
	275	struct sr_datafeed_header header;
	276	struct dev_context *devc;
	277
	278	if (!(devc = sdi->priv)) {
	279	sr_err("sdi->priv was NULL.");
	280	return SR_ERR_BUG;
	281	}
	282
	283	sr_dbg("Starting acquisition.");
	284
	285	devc->cb_data = cb_data;
	286
	287	/*
	288	* Reset the number of samples to take. If we've already collected our
	289	* quota, but we start a new session, and don't reset this, we'll just
	290	* quit without acquiring any new samples.
	291	*/
	292	devc->num_samples = 0;
	293	devc->starttime = g_get_monotonic_time();
	294
	295	/* Send header packet to the session bus. */
	296	sr_dbg("Sending SR_DF_HEADER.");
	297	packet.type = SR_DF_HEADER;
	298	packet.payload = &header;
	299	header.feed_version = 1;
	300	gettimeofday(&header.starttime, NULL);
	301	sr_session_send(devc->cb_data, &packet);
	302
	303	/* Poll every 50ms, or whenever some data comes in. */
	304	sr_source_add(devc->serial->fd, G_IO_IN, 50,
	305	brymen_dmm_receive_data, (void *)sdi);
20cbc785 AG	306
	307	return SR_OK;
	308	}
	309
601fb67c	310	static int hw_dev_acquisition_stop(struct sr_dev_inst sdi, void cb_data)
20cbc785	311	{
601fb67c AG	312	struct sr_datafeed_packet packet;
601fb67c AG	313	struct dev_context *devc;
20cbc785 AG	314
	315	if (sdi->status != SR_ST_ACTIVE) {
	316	sr_err("Device inactive, can't stop acquisition.");
	317	return SR_ERR;
	318	}
	319
601fb67c AG	320	if (!(devc = sdi->priv)) {
	321	sr_err("sdi->priv was NULL.");
	322	return SR_ERR_BUG;
	323	}
	324
	325	sr_dbg("Stopping acquisition.");
	326
	327	sr_source_remove(devc->serial->fd);
	328	hw_dev_close((struct sr_dev_inst *)sdi);
	329
	330	/* Send end packet to the session bus. */
	331	sr_dbg("Sending SR_DF_END.");
	332	packet.type = SR_DF_END;
	333	sr_session_send(cb_data, &packet);
20cbc785 AG	334
	335	return SR_OK;
	336	}
	337
c5d6f5cc UH	338	SR_PRIV struct sr_dev_driver brymen_bm857_driver_info = {
	339	.name = "brymen-bm857",
	340	.longname = "Brymen BM857",
20cbc785 AG	341	.api_version = 1,
	342	.init = hw_init,
	343	.cleanup = hw_cleanup,
	344	.scan = hw_scan,
	345	.dev_list = hw_dev_list,
	346	.dev_clear = clear_instances,
	347	.dev_open = hw_dev_open,
	348	.dev_close = hw_dev_close,
601fb67c AG	349	.config_list = config_list,
601fb67c AG	350	.config_set = hw_dev_config_set,
20cbc785 AG	351	.dev_acquisition_start = hw_dev_acquisition_start,
	352	.dev_acquisition_stop = hw_dev_acquisition_stop,
	353	.priv = NULL,
	354	};