[libsigrok.git] / src / 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 <config.h>
#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,
};

SR_PRIV struct sr_dev_driver brymen_bm857_driver_info;
static struct sr_dev_driver *di = &brymen_bm857_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 *brymen_scan(const char *conn, const char *serialcomm)
{
	struct sr_dev_inst *sdi;
	struct dev_context *devc;
	struct drv_context *drvc;
	struct sr_serial_dev_inst *serial;
	GSList *devices;
	int ret;
	uint8_t buf[128];
	size_t len;

	serial = sr_serial_dev_inst_new(conn, serialcomm);

	if (serial_open(serial, SERIAL_RDWR) != 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);

	sdi = g_malloc0(sizeof(struct sr_dev_inst));
	sdi->status = SR_ST_INACTIVE;
	sdi->vendor = g_strdup("Brymen");
	sdi->model = g_strdup("BM85x");
	devc = g_malloc0(sizeof(struct dev_context));
	sdi->inst_type = SR_INST_SERIAL;
	sdi->conn = serial;
	drvc = di->context;
	sdi->priv = devc;
	sdi->driver = di;
	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
	drvc->instances = g_slist_append(drvc->instances, sdi);
	devices = g_slist_append(devices, sdi);

scan_cleanup:
	serial_close(serial);

	return devices;
}

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

	devices = NULL;
	drvc = di->context;
	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) {
		/* 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 *dev_list(const struct sr_dev_driver *di)
{
	return ((struct drv_context *)(di->context))->instances;
}

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;
	int ret;

	(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;
	}

	ret = SR_OK;
	switch (key) {
	case SR_CONF_LIMIT_SAMPLES:
		devc->limit_samples = g_variant_get_uint64(data);
		break;
	case SR_CONF_LIMIT_MSEC:
		devc->limit_msec = g_variant_get_uint64(data);
		break;
	default:
		ret = SR_ERR_NA;
	}

	return ret;
}

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->status != SR_ST_ACTIVE)
		return SR_ERR_DEV_CLOSED;

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

	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();

	std_session_send_df_header(cb_data, LOG_PREFIX);

	/* Poll every 50ms, or whenever some data comes in. */
	serial = sdi->conn;
	serial_source_add(sdi->session, serial, G_IO_IN, 50,
			brymen_dmm_receive_data, (void *)sdi);

	return SR_OK;
}

static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
{
	return std_serial_dev_acquisition_stop(sdi, cb_data, std_serial_dev_close,
			sdi->conn, LOG_PREFIX);
}

SR_PRIV struct sr_dev_driver brymen_bm857_driver_info = {
	.name = "brymen-bm857",
	.longname = "Brymen BM857",
	.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 = std_serial_dev_close,
	.dev_acquisition_start = dev_acquisition_start,
	.dev_acquisition_stop = dev_acquisition_stop,
	.context = NULL,
};
Commit	Line	Data
	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
	20	#include <config.h>
	21	#include "protocol.h"
	22
	23	static const uint32_t scanopts[] = {
	24	SR_CONF_CONN,
	25	SR_CONF_SERIALCOMM,
	26	};
	27
	28	static const uint32_t devopts[] = {
	29	SR_CONF_MULTIMETER,
	30	SR_CONF_CONTINUOUS,
	31	SR_CONF_LIMIT_SAMPLES \| SR_CONF_SET,
	32	SR_CONF_LIMIT_MSEC \| SR_CONF_SET,
	33	};
	34
	35	SR_PRIV struct sr_dev_driver brymen_bm857_driver_info;
	36	static struct sr_dev_driver *di = &brymen_bm857_driver_info;
	37
	38	static int init(struct sr_dev_driver di, struct sr_context sr_ctx)
	39	{
	40	return std_init(sr_ctx, di, LOG_PREFIX);
	41	}
	42
	43	static GSList brymen_scan(const char conn, const char *serialcomm)
	44	{
	45	struct sr_dev_inst *sdi;
	46	struct dev_context *devc;
	47	struct drv_context *drvc;
	48	struct sr_serial_dev_inst *serial;
	49	GSList *devices;
	50	int ret;
	51	uint8_t buf[128];
	52	size_t len;
	53
	54	serial = sr_serial_dev_inst_new(conn, serialcomm);
	55
	56	if (serial_open(serial, SERIAL_RDWR) != SR_OK)
	57	return NULL;
	58
	59	sr_info("Probing port %s.", conn);
	60
	61	devices = NULL;
	62
	63	/* Request reading */
	64	if ((ret = brymen_packet_request(serial)) < 0) {
	65	sr_err("Unable to send command: %d.", ret);
	66	goto scan_cleanup;
	67	}
	68
	69	len = 128;
	70	ret = brymen_stream_detect(serial, buf, &len, brymen_packet_length,
	71	brymen_packet_is_valid, 1000, 9600);
	72	if (ret != SR_OK)
	73	goto scan_cleanup;
	74
	75	sr_info("Found device on port %s.", conn);
	76
	77	sdi = g_malloc0(sizeof(struct sr_dev_inst));
	78	sdi->status = SR_ST_INACTIVE;
	79	sdi->vendor = g_strdup("Brymen");
	80	sdi->model = g_strdup("BM85x");
	81	devc = g_malloc0(sizeof(struct dev_context));
	82	sdi->inst_type = SR_INST_SERIAL;
	83	sdi->conn = serial;
	84	drvc = di->context;
	85	sdi->priv = devc;
	86	sdi->driver = di;
	87	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
	88	drvc->instances = g_slist_append(drvc->instances, sdi);
	89	devices = g_slist_append(devices, sdi);
	90
	91	scan_cleanup:
	92	serial_close(serial);
	93
	94	return devices;
	95	}
	96
	97	static GSList scan(struct sr_dev_driver di, GSList *options)
	98	{
	99	struct drv_context *drvc;
	100	struct sr_config *src;
	101	GSList devices, l;
	102	const char conn, serialcomm;
	103
	104	devices = NULL;
	105	drvc = di->context;
	106	drvc->instances = NULL;
	107
	108	conn = serialcomm = NULL;
	109	for (l = options; l; l = l->next) {
	110	src = l->data;
	111	switch (src->key) {
	112	case SR_CONF_CONN:
	113	conn = g_variant_get_string(src->data, NULL);
	114	break;
	115	case SR_CONF_SERIALCOMM:
	116	serialcomm = g_variant_get_string(src->data, NULL);
	117	break;
	118	}
	119	}
	120	if (!conn)
	121	return NULL;
	122
	123	if (serialcomm) {
	124	/* Use the provided comm specs. */
	125	devices = brymen_scan(conn, serialcomm);
	126	} else {
	127	/* But 9600/8n1 should work all of the time. */
	128	devices = brymen_scan(conn, "9600/8n1/dtr=1/rts=1");
	129	}
	130
	131	return devices;
	132	}
	133
	134	static GSList dev_list(const struct sr_dev_driver di)
	135	{
	136	return ((struct drv_context *)(di->context))->instances;
	137	}
	138
	139	static int cleanup(const struct sr_dev_driver *di)
	140	{
	141	return std_dev_clear(di, NULL);
	142	}
	143
	144	static int config_set(uint32_t key, GVariant data, const struct sr_dev_inst sdi,
	145	const struct sr_channel_group *cg)
	146	{
	147	struct dev_context *devc;
	148	int ret;
	149
	150	(void)cg;
	151
	152	if (sdi->status != SR_ST_ACTIVE)
	153	return SR_ERR_DEV_CLOSED;
	154
	155	if (!(devc = sdi->priv)) {
	156	sr_err("sdi->priv was NULL.");
	157	return SR_ERR_BUG;
	158	}
	159
	160	ret = SR_OK;
	161	switch (key) {
	162	case SR_CONF_LIMIT_SAMPLES:
	163	devc->limit_samples = g_variant_get_uint64(data);
	164	break;
	165	case SR_CONF_LIMIT_MSEC:
	166	devc->limit_msec = g_variant_get_uint64(data);
	167	break;
	168	default:
	169	ret = SR_ERR_NA;
	170	}
	171
	172	return ret;
	173	}
	174
	175	static int config_list(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
	176	const struct sr_channel_group *cg)
	177	{
	178	(void)sdi;
	179	(void)cg;
	180
	181	switch (key) {
	182	case SR_CONF_SCAN_OPTIONS:
	183	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
	184	scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
	185	break;
	186	case SR_CONF_DEVICE_OPTIONS:
	187	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
	188	devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
	189	break;
	190	default:
	191	return SR_ERR_NA;
	192	}
	193
	194	return SR_OK;
	195	}
	196
	197	static int dev_acquisition_start(const struct sr_dev_inst sdi, void cb_data)
	198	{
	199	struct dev_context *devc;
	200	struct sr_serial_dev_inst *serial;
	201
	202	if (sdi->status != SR_ST_ACTIVE)
	203	return SR_ERR_DEV_CLOSED;
	204
	205	if (!(devc = sdi->priv)) {
	206	sr_err("sdi->priv was NULL.");
	207	return SR_ERR_BUG;
	208	}
	209
	210	devc->cb_data = cb_data;
	211
	212	/*
	213	* Reset the number of samples to take. If we've already collected our
	214	* quota, but we start a new session, and don't reset this, we'll just
	215	* quit without acquiring any new samples.
	216	*/
	217	devc->num_samples = 0;
	218	devc->starttime = g_get_monotonic_time();
	219
	220	std_session_send_df_header(cb_data, LOG_PREFIX);
	221
	222	/* Poll every 50ms, or whenever some data comes in. */
	223	serial = sdi->conn;
	224	serial_source_add(sdi->session, serial, G_IO_IN, 50,
	225	brymen_dmm_receive_data, (void *)sdi);
	226
	227	return SR_OK;
	228	}
	229
	230	static int dev_acquisition_stop(struct sr_dev_inst sdi, void cb_data)
	231	{
	232	return std_serial_dev_acquisition_stop(sdi, cb_data, std_serial_dev_close,
	233	sdi->conn, LOG_PREFIX);
	234	}
	235
	236	SR_PRIV struct sr_dev_driver brymen_bm857_driver_info = {
	237	.name = "brymen-bm857",
	238	.longname = "Brymen BM857",
	239	.api_version = 1,
	240	.init = init,
	241	.cleanup = cleanup,
	242	.scan = scan,
	243	.dev_list = dev_list,
	244	.dev_clear = NULL,
	245	.config_get = NULL,
	246	.config_set = config_set,
	247	.config_list = config_list,
	248	.dev_open = std_serial_dev_open,
	249	.dev_close = std_serial_dev_close,
	250	.dev_acquisition_start = dev_acquisition_start,
	251	.dev_acquisition_stop = dev_acquisition_stop,
	252	.context = NULL,
	253	};