[libsigrok.git] / src / hardware / kern-scale / api.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2015 Uwe Hermann <uwe@hermann-uwe.de>
 *
 * 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 2 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, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 */

#include <config.h>
#include <glib.h>
#include <libsigrok/libsigrok.h>
#include "libsigrok-internal.h"
#include "protocol.h"

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

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

static int dev_clear(const struct sr_dev_driver *di)
{
	return std_dev_clear(di, NULL);
}

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 *di, GSList *options)
{
	struct scale_info *scale;
	struct sr_config *src;
	GSList *l, *devices;
	const char *conn, *serialcomm;
	struct sr_dev_inst *sdi;
	struct drv_context *drvc;
	struct dev_context *devc;
	struct sr_serial_dev_inst *serial;
	int ret;
	size_t len;
	uint8_t buf[128];

	scale = (struct scale_info *)di;

	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 = scale->conn;

	serial = sr_serial_dev_inst_new(conn, serialcomm);

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

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

	drvc = di->context;
	devices = NULL;
	serial_flush(serial);

	sr_spew("Set O1 mode (continuous values, stable and unstable ones).");
	if (serial_write_nonblocking(serial, "O1\r\n", 4) != 4)
		goto scan_cleanup;
	/* Device replies with "A00\r\n" (OK) or "E01\r\n" (Error). Ignore. */

	/* Let's get a bit of data and see if we can find a packet. */
	len = sizeof(buf);
	ret = serial_stream_detect(serial, buf, &len, scale->packet_size,
				   scale->packet_valid, 3000, scale->baudrate);
	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(scale->vendor);
	sdi->model = g_strdup(scale->device);
	devc = g_malloc0(sizeof(struct dev_context));
	sdi->inst_type = SR_INST_SERIAL;
	sdi->conn = serial;
	sdi->priv = devc;
	sdi->driver = di;
	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "Mass");
	drvc->instances = g_slist_append(drvc->instances, sdi);
	devices = g_slist_append(devices, sdi);

scan_cleanup:
	serial_close(serial);

	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 dev_clear(di);
}

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))
		return SR_ERR_BUG;

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

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

	devc = sdi->priv;
	serial = sdi->conn;

	sr_spew("Set O1 mode (continuous values, stable and unstable ones).");
	if (serial_write_nonblocking(serial, "O1\r\n", 4) != 4)
		return SR_ERR;
	/* Device replies with "A00\r\n" (OK) or "E01\r\n" (Error). Ignore. */

	devc->num_samples = 0;
	devc->starttime = g_get_monotonic_time();

	std_session_send_df_header(sdi, LOG_PREFIX);

	/* Poll every 50ms, or whenever some data comes in. */
	serial_source_add(sdi->session, serial, G_IO_IN, 50,
		      kern_scale_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);
}

#define SCALE(ID, CHIPSET, VENDOR, MODEL, CONN, BAUDRATE, PACKETSIZE, \
			VALID, PARSE) \
	&(struct scale_info) { \
		{ \
			.name = ID, \
			.longname = VENDOR " " MODEL, \
			.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 = std_serial_dev_open, \
			.dev_close = std_serial_dev_close, \
			.dev_acquisition_start = dev_acquisition_start, \
			.dev_acquisition_stop = dev_acquisition_stop, \
			.context = NULL, \
		}, \
		VENDOR, MODEL, CONN, BAUDRATE, PACKETSIZE, \
		VALID, PARSE, sizeof(struct CHIPSET##_info) \
	}

/*
 * Some scales have (user-configurable) 14-byte or 15-byte packets.
 * We transparently support both variants by specifying the larger value
 * below and due to the way the stream parser works.
 *
 * The scales have a standard baudrate (model dependent) as listed below,
 * but serial parameters are user-configurable. We support that by letting
 * the user override them via "serialcomm".
 */

SR_PRIV const struct scale_info *kern_scale_drivers[] = {
	SCALE(
		"kern-ew-6200-2nm", kern,
		"KERN", "EW 6200-2NM", "1200/8n2", 1200,
		15 /* (or 14) */, sr_kern_packet_valid, sr_kern_parse
	),
	NULL
};
Commit	Line	Data
9380ec2f UH	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2015 Uwe Hermann <uwe@hermann-uwe.de>
	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 2 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, write to the Free Software
	18	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
	19	*/
	20
6ec6c43b	21	#include <config.h>
607dcdea UH	22	#include <glib.h>
	23	#include <libsigrok/libsigrok.h>
	24	#include "libsigrok-internal.h"
9380ec2f UH	25	#include "protocol.h"
9380ec2f UH	26
607dcdea UH	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_SCALE,
	34	SR_CONF_CONTINUOUS,
	35	SR_CONF_LIMIT_SAMPLES \| SR_CONF_SET,
	36	SR_CONF_LIMIT_MSEC \| SR_CONF_SET,
	37	};
	38
	39	static int dev_clear(const struct sr_dev_driver *di)
	40	{
	41	return std_dev_clear(di, NULL);
	42	}
9380ec2f UH	43
	44	static int init(struct sr_dev_driver di, struct sr_context sr_ctx)
	45	{
	46	return std_init(sr_ctx, di, LOG_PREFIX);
	47	}
	48
	49	static GSList scan(struct sr_dev_driver di, GSList *options)
	50	{
607dcdea UH	51	struct scale_info *scale;
	52	struct sr_config *src;
	53	GSList l, devices;
	54	const char conn, serialcomm;
	55	struct sr_dev_inst *sdi;
9380ec2f	56	struct drv_context *drvc;
607dcdea UH	57	struct dev_context *devc;
	58	struct sr_serial_dev_inst *serial;
	59	int ret;
	60	size_t len;
	61	uint8_t buf[128];
	62
	63	scale = (struct scale_info *)di;
	64
	65	conn = serialcomm = NULL;
	66	for (l = options; l; l = l->next) {
	67	src = l->data;
	68	switch (src->key) {
	69	case SR_CONF_CONN:
	70	conn = g_variant_get_string(src->data, NULL);
	71	break;
	72	case SR_CONF_SERIALCOMM:
	73	serialcomm = g_variant_get_string(src->data, NULL);
	74	break;
	75	}
	76	}
	77	if (!conn)
	78	return NULL;
9380ec2f	79
607dcdea UH	80	if (!serialcomm)
607dcdea UH	81	serialcomm = scale->conn;
9380ec2f	82
607dcdea	83	serial = sr_serial_dev_inst_new(conn, serialcomm);
9380ec2f	84
607dcdea UH	85	if (serial_open(serial, SERIAL_RDWR) != SR_OK)
607dcdea UH	86	return NULL;
9380ec2f	87
607dcdea	88	sr_info("Probing serial port %s.", conn);
9380ec2f	89
607dcdea UH	90	drvc = di->context;
	91	devices = NULL;
	92	serial_flush(serial);
9380ec2f	93
607dcdea UH	94	sr_spew("Set O1 mode (continuous values, stable and unstable ones).");
	95	if (serial_write_nonblocking(serial, "O1\r\n", 4) != 4)
	96	goto scan_cleanup;
	97	/* Device replies with "A00\r\n" (OK) or "E01\r\n" (Error). Ignore. */
9380ec2f	98
607dcdea UH	99	/* Let's get a bit of data and see if we can find a packet. */
	100	len = sizeof(buf);
	101	ret = serial_stream_detect(serial, buf, &len, scale->packet_size,
	102	scale->packet_valid, 3000, scale->baudrate);
	103	if (ret != SR_OK)
	104	goto scan_cleanup;
9380ec2f	105
607dcdea	106	sr_info("Found device on port %s.", conn);
9380ec2f	107
607dcdea	108	sdi = g_malloc0(sizeof(struct sr_dev_inst));
9380ec2f	109	sdi->status = SR_ST_INACTIVE;
607dcdea UH	110	sdi->vendor = g_strdup(scale->vendor);
	111	sdi->model = g_strdup(scale->device);
	112	devc = g_malloc0(sizeof(struct dev_context));
	113	sdi->inst_type = SR_INST_SERIAL;
	114	sdi->conn = serial;
	115	sdi->priv = devc;
	116	sdi->driver = di;
	117	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "Mass");
	118	drvc->instances = g_slist_append(drvc->instances, sdi);
	119	devices = g_slist_append(devices, sdi);
	120
	121	scan_cleanup:
	122	serial_close(serial);
9380ec2f	123
607dcdea	124	return devices;
9380ec2f UH	125	}
9380ec2f UH	126
607dcdea	127	static GSList dev_list(const struct sr_dev_driver di)
9380ec2f	128	{
607dcdea	129	return ((struct drv_context *)(di->context))->instances;
9380ec2f UH	130	}
9380ec2f UH	131
607dcdea	132	static int cleanup(const struct sr_dev_driver *di)
9380ec2f	133	{
607dcdea	134	return dev_clear(di);
9380ec2f UH	135	}
	136
	137	static int config_set(uint32_t key, GVariant data, const struct sr_dev_inst sdi,
	138	const struct sr_channel_group *cg)
	139	{
607dcdea	140	struct dev_context *devc;
9380ec2f	141
9380ec2f UH	142	(void)cg;
	143
	144	if (sdi->status != SR_ST_ACTIVE)
	145	return SR_ERR_DEV_CLOSED;
	146
607dcdea UH	147	if (!(devc = sdi->priv))
	148	return SR_ERR_BUG;
	149
9380ec2f	150	switch (key) {
607dcdea UH	151	case SR_CONF_LIMIT_SAMPLES:
	152	devc->limit_samples = g_variant_get_uint64(data);
	153	break;
	154	case SR_CONF_LIMIT_MSEC:
	155	devc->limit_msec = g_variant_get_uint64(data);
	156	break;
9380ec2f	157	default:
607dcdea	158	return SR_ERR_NA;
9380ec2f UH	159	}
9380ec2f UH	160
607dcdea	161	return SR_OK;
9380ec2f UH	162	}
	163
	164	static int config_list(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
	165	const struct sr_channel_group *cg)
	166	{
9380ec2f	167	(void)sdi;
9380ec2f UH	168	(void)cg;
9380ec2f UH	169
9380ec2f	170	switch (key) {
607dcdea UH	171	case SR_CONF_SCAN_OPTIONS:
	172	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
	173	scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
	174	break;
	175	case SR_CONF_DEVICE_OPTIONS:
	176	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
	177	devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
	178	break;
9380ec2f UH	179	default:
	180	return SR_ERR_NA;
	181	}
	182
607dcdea	183	return SR_OK;
9380ec2f UH	184	}
9380ec2f UH	185
695dc859	186	static int dev_acquisition_start(const struct sr_dev_inst *sdi)
9380ec2f	187	{
607dcdea UH	188	struct dev_context *devc;
607dcdea UH	189	struct sr_serial_dev_inst *serial;
9380ec2f UH	190
	191	if (sdi->status != SR_ST_ACTIVE)
	192	return SR_ERR_DEV_CLOSED;
	193
208c1d35	194	devc = sdi->priv;
607dcdea UH	195	serial = sdi->conn;
	196
	197	sr_spew("Set O1 mode (continuous values, stable and unstable ones).");
	198	if (serial_write_nonblocking(serial, "O1\r\n", 4) != 4)
	199	return SR_ERR;
	200	/* Device replies with "A00\r\n" (OK) or "E01\r\n" (Error). Ignore. */
	201
	202	devc->num_samples = 0;
	203	devc->starttime = g_get_monotonic_time();
	204
695dc859	205	std_session_send_df_header(sdi, LOG_PREFIX);
607dcdea UH	206
	207	/* Poll every 50ms, or whenever some data comes in. */
	208	serial_source_add(sdi->session, serial, G_IO_IN, 50,
	209	kern_scale_receive_data, (void *)sdi);
	210
9380ec2f UH	211	return SR_OK;
	212	}
	213
695dc859	214	static int dev_acquisition_stop(struct sr_dev_inst *sdi)
9380ec2f	215	{
6525d819	216	return std_serial_dev_acquisition_stop(sdi, std_serial_dev_close,
607dcdea UH	217	sdi->conn, LOG_PREFIX);
607dcdea UH	218	}
9380ec2f	219
607dcdea UH	220	#define SCALE(ID, CHIPSET, VENDOR, MODEL, CONN, BAUDRATE, PACKETSIZE, \
	221	VALID, PARSE) \
	222	&(struct scale_info) { \
	223	{ \
	224	.name = ID, \
	225	.longname = VENDOR " " MODEL, \
	226	.api_version = 1, \
	227	.init = init, \
	228	.cleanup = cleanup, \
	229	.scan = scan, \
	230	.dev_list = dev_list, \
	231	.dev_clear = dev_clear, \
	232	.config_get = NULL, \
	233	.config_set = config_set, \
	234	.config_list = config_list, \
	235	.dev_open = std_serial_dev_open, \
	236	.dev_close = std_serial_dev_close, \
	237	.dev_acquisition_start = dev_acquisition_start, \
	238	.dev_acquisition_stop = dev_acquisition_stop, \
	239	.context = NULL, \
	240	}, \
	241	VENDOR, MODEL, CONN, BAUDRATE, PACKETSIZE, \
	242	VALID, PARSE, sizeof(struct CHIPSET##_info) \
	243	}
9380ec2f	244
607dcdea UH	245	/*
	246	* Some scales have (user-configurable) 14-byte or 15-byte packets.
	247	* We transparently support both variants by specifying the larger value
	248	* below and due to the way the stream parser works.
	249	*
	250	* The scales have a standard baudrate (model dependent) as listed below,
	251	* but serial parameters are user-configurable. We support that by letting
	252	* the user override them via "serialcomm".
	253	*/
9380ec2f	254
607dcdea UH	255	SR_PRIV const struct scale_info *kern_scale_drivers[] = {
	256	SCALE(
	257	"kern-ew-6200-2nm", kern,
	258	"KERN", "EW 6200-2NM", "1200/8n2", 1200,
	259	15 /* (or 14) */, sr_kern_packet_valid, sr_kern_parse
	260	),
	261	NULL
9380ec2f	262	};