[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,
};

static GSList *brymen_scan(struct sr_dev_driver *di, const char *conn,
	const char *serialcomm)
{
	struct sr_dev_inst *sdi;
	struct dev_context *devc;
	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));
	sr_sw_limits_init(&devc->sw_limits);
	sdi->inst_type = SR_INST_SERIAL;
	sdi->conn = serial;
	sdi->priv = devc;
	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
	devices = g_slist_append(devices, sdi);

scan_cleanup:
	serial_close(serial);

	return std_scan_complete(di, 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;

	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(di, conn, serialcomm);
	} else {
		/* But 9600/8n1 should work all of the time. */
		devices = brymen_scan(di, conn, "9600/8n1/dtr=1/rts=1");
	}

	return devices;
}

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;

	devc = sdi->priv;

	return sr_sw_limits_config_set(&devc->sw_limits, key, data);
}

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)
{
	struct dev_context *devc;
	struct sr_serial_dev_inst *serial;

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

	devc = sdi->priv;

	sr_sw_limits_acquisition_start(&devc->sw_limits);
	std_session_send_df_header(sdi, 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)
{
	return std_serial_dev_acquisition_stop(sdi, std_serial_dev_close,
			sdi->conn, LOG_PREFIX);
}

static struct sr_dev_driver brymen_bm857_driver_info = {
	.name = "brymen-bm857",
	.longname = "Brymen BM857",
	.api_version = 1,
	.init = std_init,
	.cleanup = std_cleanup,
	.scan = scan,
	.dev_list = std_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,
};
SR_REGISTER_DEV_DRIVER(brymen_bm857_driver_info);
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	static GSList brymen_scan(struct sr_dev_driver di, const char *conn,
	36	const char *serialcomm)
	37	{
	38	struct sr_dev_inst *sdi;
	39	struct dev_context *devc;
	40	struct sr_serial_dev_inst *serial;
	41	GSList *devices;
	42	int ret;
	43	uint8_t buf[128];
	44	size_t len;
	45
	46	serial = sr_serial_dev_inst_new(conn, serialcomm);
	47
	48	if (serial_open(serial, SERIAL_RDWR) != SR_OK)
	49	return NULL;
	50
	51	sr_info("Probing port %s.", conn);
	52
	53	devices = NULL;
	54
	55	/* Request reading */
	56	if ((ret = brymen_packet_request(serial)) < 0) {
	57	sr_err("Unable to send command: %d.", ret);
	58	goto scan_cleanup;
	59	}
	60
	61	len = 128;
	62	ret = brymen_stream_detect(serial, buf, &len, brymen_packet_length,
	63	brymen_packet_is_valid, 1000, 9600);
	64	if (ret != SR_OK)
	65	goto scan_cleanup;
	66
	67	sr_info("Found device on port %s.", conn);
	68
	69	sdi = g_malloc0(sizeof(struct sr_dev_inst));
	70	sdi->status = SR_ST_INACTIVE;
	71	sdi->vendor = g_strdup("Brymen");
	72	sdi->model = g_strdup("BM85x");
	73	devc = g_malloc0(sizeof(struct dev_context));
	74	sr_sw_limits_init(&devc->sw_limits);
	75	sdi->inst_type = SR_INST_SERIAL;
	76	sdi->conn = serial;
	77	sdi->priv = devc;
	78	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
	79	devices = g_slist_append(devices, sdi);
	80
	81	scan_cleanup:
	82	serial_close(serial);
	83
	84	return std_scan_complete(di, devices);
	85	}
	86
	87	static GSList scan(struct sr_dev_driver di, GSList *options)
	88	{
	89	struct drv_context *drvc;
	90	struct sr_config *src;
	91	GSList devices, l;
	92	const char conn, serialcomm;
	93
	94	devices = NULL;
	95	drvc = di->context;
	96
	97	conn = serialcomm = NULL;
	98	for (l = options; l; l = l->next) {
	99	src = l->data;
	100	switch (src->key) {
	101	case SR_CONF_CONN:
	102	conn = g_variant_get_string(src->data, NULL);
	103	break;
	104	case SR_CONF_SERIALCOMM:
	105	serialcomm = g_variant_get_string(src->data, NULL);
	106	break;
	107	}
	108	}
	109	if (!conn)
	110	return NULL;
	111
	112	if (serialcomm) {
	113	/* Use the provided comm specs. */
	114	devices = brymen_scan(di, conn, serialcomm);
	115	} else {
	116	/* But 9600/8n1 should work all of the time. */
	117	devices = brymen_scan(di, conn, "9600/8n1/dtr=1/rts=1");
	118	}
	119
	120	return devices;
	121	}
	122
	123	static int config_set(uint32_t key, GVariant data, const struct sr_dev_inst sdi,
	124	const struct sr_channel_group *cg)
	125	{
	126	struct dev_context *devc;
	127
	128	(void)cg;
	129
	130	if (sdi->status != SR_ST_ACTIVE)
	131	return SR_ERR_DEV_CLOSED;
	132
	133	devc = sdi->priv;
	134
	135	return sr_sw_limits_config_set(&devc->sw_limits, key, data);
	136	}
	137
	138	static int config_list(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
	139	const struct sr_channel_group *cg)
	140	{
	141	(void)sdi;
	142	(void)cg;
	143
	144	switch (key) {
	145	case SR_CONF_SCAN_OPTIONS:
	146	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
	147	scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
	148	break;
	149	case SR_CONF_DEVICE_OPTIONS:
	150	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
	151	devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
	152	break;
	153	default:
	154	return SR_ERR_NA;
	155	}
	156
	157	return SR_OK;
	158	}
	159
	160	static int dev_acquisition_start(const struct sr_dev_inst *sdi)
	161	{
	162	struct dev_context *devc;
	163	struct sr_serial_dev_inst *serial;
	164
	165	if (sdi->status != SR_ST_ACTIVE)
	166	return SR_ERR_DEV_CLOSED;
	167
	168	devc = sdi->priv;
	169
	170	sr_sw_limits_acquisition_start(&devc->sw_limits);
	171	std_session_send_df_header(sdi, LOG_PREFIX);
	172
	173	/* Poll every 50ms, or whenever some data comes in. */
	174	serial = sdi->conn;
	175	serial_source_add(sdi->session, serial, G_IO_IN, 50,
	176	brymen_dmm_receive_data, (void *)sdi);
	177
	178	return SR_OK;
	179	}
	180
	181	static int dev_acquisition_stop(struct sr_dev_inst *sdi)
	182	{
	183	return std_serial_dev_acquisition_stop(sdi, std_serial_dev_close,
	184	sdi->conn, LOG_PREFIX);
	185	}
	186
	187	static struct sr_dev_driver brymen_bm857_driver_info = {
	188	.name = "brymen-bm857",
	189	.longname = "Brymen BM857",
	190	.api_version = 1,
	191	.init = std_init,
	192	.cleanup = std_cleanup,
	193	.scan = scan,
	194	.dev_list = std_dev_list,
	195	.dev_clear = NULL,
	196	.config_get = NULL,
	197	.config_set = config_set,
	198	.config_list = config_list,
	199	.dev_open = std_serial_dev_open,
	200	.dev_close = std_serial_dev_close,
	201	.dev_acquisition_start = dev_acquisition_start,
	202	.dev_acquisition_stop = dev_acquisition_stop,
	203	.context = NULL,
	204	};
	205	SR_REGISTER_DEV_DRIVER(brymen_bm857_driver_info);