[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 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));
	sr_sw_limits_init(&devc->limits);
	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 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->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;
	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. */

	sr_sw_limits_acquisition_start(&devc->limits);
	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 = std_init, \
			.cleanup = std_cleanup, \
			.scan = scan, \
			.dev_list = std_dev_list, \
			.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) \
	}).di

/*
 * 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_REGISTER_DEV_DRIVER_LIST(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
	)
);
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
9380ec2f UH	39	static GSList scan(struct sr_dev_driver di, GSList *options)
9380ec2f UH	40	{
607dcdea UH	41	struct scale_info *scale;
	42	struct sr_config *src;
	43	GSList l, devices;
	44	const char conn, serialcomm;
	45	struct sr_dev_inst *sdi;
9380ec2f	46	struct drv_context *drvc;
607dcdea UH	47	struct dev_context *devc;
	48	struct sr_serial_dev_inst *serial;
	49	int ret;
	50	size_t len;
	51	uint8_t buf[128];
	52
	53	scale = (struct scale_info *)di;
	54
	55	conn = serialcomm = NULL;
	56	for (l = options; l; l = l->next) {
	57	src = l->data;
	58	switch (src->key) {
	59	case SR_CONF_CONN:
	60	conn = g_variant_get_string(src->data, NULL);
	61	break;
	62	case SR_CONF_SERIALCOMM:
	63	serialcomm = g_variant_get_string(src->data, NULL);
	64	break;
	65	}
	66	}
	67	if (!conn)
	68	return NULL;
9380ec2f	69
607dcdea UH	70	if (!serialcomm)
607dcdea UH	71	serialcomm = scale->conn;
9380ec2f	72
607dcdea	73	serial = sr_serial_dev_inst_new(conn, serialcomm);
9380ec2f	74
607dcdea UH	75	if (serial_open(serial, SERIAL_RDWR) != SR_OK)
607dcdea UH	76	return NULL;
9380ec2f	77
607dcdea	78	sr_info("Probing serial port %s.", conn);
9380ec2f	79
607dcdea UH	80	drvc = di->context;
	81	devices = NULL;
	82	serial_flush(serial);
9380ec2f	83
607dcdea UH	84	sr_spew("Set O1 mode (continuous values, stable and unstable ones).");
	85	if (serial_write_nonblocking(serial, "O1\r\n", 4) != 4)
	86	goto scan_cleanup;
	87	/* Device replies with "A00\r\n" (OK) or "E01\r\n" (Error). Ignore. */
9380ec2f	88
607dcdea UH	89	/* Let's get a bit of data and see if we can find a packet. */
	90	len = sizeof(buf);
	91	ret = serial_stream_detect(serial, buf, &len, scale->packet_size,
	92	scale->packet_valid, 3000, scale->baudrate);
	93	if (ret != SR_OK)
	94	goto scan_cleanup;
9380ec2f	95
607dcdea	96	sr_info("Found device on port %s.", conn);
9380ec2f	97
607dcdea	98	sdi = g_malloc0(sizeof(struct sr_dev_inst));
9380ec2f	99	sdi->status = SR_ST_INACTIVE;
607dcdea UH	100	sdi->vendor = g_strdup(scale->vendor);
	101	sdi->model = g_strdup(scale->device);
	102	devc = g_malloc0(sizeof(struct dev_context));
7fc9dc31	103	sr_sw_limits_init(&devc->limits);
607dcdea UH	104	sdi->inst_type = SR_INST_SERIAL;
	105	sdi->conn = serial;
	106	sdi->priv = devc;
	107	sdi->driver = di;
	108	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "Mass");
	109	drvc->instances = g_slist_append(drvc->instances, sdi);
	110	devices = g_slist_append(devices, sdi);
	111
	112	scan_cleanup:
	113	serial_close(serial);
9380ec2f	114
607dcdea	115	return devices;
9380ec2f UH	116	}
9380ec2f UH	117
9380ec2f UH	118	static int config_set(uint32_t key, GVariant data, const struct sr_dev_inst sdi,
	119	const struct sr_channel_group *cg)
	120	{
607dcdea	121	struct dev_context *devc;
9380ec2f	122
9380ec2f UH	123	(void)cg;
	124
	125	if (sdi->status != SR_ST_ACTIVE)
	126	return SR_ERR_DEV_CLOSED;
	127
b0baddef	128	devc = sdi->priv;
607dcdea	129
7fc9dc31	130	return sr_sw_limits_config_set(&devc->limits, key, data);
9380ec2f UH	131	}
	132
	133	static int config_list(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
	134	const struct sr_channel_group *cg)
	135	{
9380ec2f	136	(void)sdi;
9380ec2f UH	137	(void)cg;
9380ec2f UH	138
9380ec2f	139	switch (key) {
607dcdea UH	140	case SR_CONF_SCAN_OPTIONS:
	141	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
	142	scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
	143	break;
	144	case SR_CONF_DEVICE_OPTIONS:
	145	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
	146	devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
	147	break;
9380ec2f UH	148	default:
	149	return SR_ERR_NA;
	150	}
	151
607dcdea	152	return SR_OK;
9380ec2f UH	153	}
9380ec2f UH	154
695dc859	155	static int dev_acquisition_start(const struct sr_dev_inst *sdi)
9380ec2f	156	{
607dcdea UH	157	struct dev_context *devc;
607dcdea UH	158	struct sr_serial_dev_inst *serial;
9380ec2f UH	159
	160	if (sdi->status != SR_ST_ACTIVE)
	161	return SR_ERR_DEV_CLOSED;
	162
208c1d35	163	devc = sdi->priv;
607dcdea UH	164	serial = sdi->conn;
	165
	166	sr_spew("Set O1 mode (continuous values, stable and unstable ones).");
	167	if (serial_write_nonblocking(serial, "O1\r\n", 4) != 4)
	168	return SR_ERR;
	169	/* Device replies with "A00\r\n" (OK) or "E01\r\n" (Error). Ignore. */
	170
7fc9dc31	171	sr_sw_limits_acquisition_start(&devc->limits);
695dc859	172	std_session_send_df_header(sdi, LOG_PREFIX);
607dcdea UH	173
	174	/* Poll every 50ms, or whenever some data comes in. */
	175	serial_source_add(sdi->session, serial, G_IO_IN, 50,
	176	kern_scale_receive_data, (void *)sdi);
	177
9380ec2f UH	178	return SR_OK;
	179	}
	180
695dc859	181	static int dev_acquisition_stop(struct sr_dev_inst *sdi)
9380ec2f	182	{
6525d819	183	return std_serial_dev_acquisition_stop(sdi, std_serial_dev_close,
607dcdea UH	184	sdi->conn, LOG_PREFIX);
607dcdea UH	185	}
9380ec2f	186
607dcdea UH	187	#define SCALE(ID, CHIPSET, VENDOR, MODEL, CONN, BAUDRATE, PACKETSIZE, \
607dcdea UH	188	VALID, PARSE) \
dd5c48a6	189	&((struct scale_info) { \
607dcdea UH	190	{ \
	191	.name = ID, \
	192	.longname = VENDOR " " MODEL, \
	193	.api_version = 1, \
c2fdcc25	194	.init = std_init, \
700d6b64	195	.cleanup = std_cleanup, \
607dcdea	196	.scan = scan, \
c01bf34c	197	.dev_list = std_dev_list, \
607dcdea UH	198	.config_get = NULL, \
	199	.config_set = config_set, \
	200	.config_list = config_list, \
	201	.dev_open = std_serial_dev_open, \
	202	.dev_close = std_serial_dev_close, \
	203	.dev_acquisition_start = dev_acquisition_start, \
	204	.dev_acquisition_stop = dev_acquisition_stop, \
	205	.context = NULL, \
	206	}, \
	207	VENDOR, MODEL, CONN, BAUDRATE, PACKETSIZE, \
	208	VALID, PARSE, sizeof(struct CHIPSET##_info) \
dd5c48a6	209	}).di
9380ec2f	210
607dcdea UH	211	/*
	212	* Some scales have (user-configurable) 14-byte or 15-byte packets.
	213	* We transparently support both variants by specifying the larger value
	214	* below and due to the way the stream parser works.
	215	*
	216	* The scales have a standard baudrate (model dependent) as listed below,
	217	* but serial parameters are user-configurable. We support that by letting
	218	* the user override them via "serialcomm".
	219	*/
9380ec2f	220
dd5c48a6	221	SR_REGISTER_DEV_DRIVER_LIST(kern_scale_drivers,
607dcdea UH	222	SCALE(
	223	"kern-ew-6200-2nm", kern,
	224	"KERN", "EW 6200-2NM", "1200/8n2", 1200,
	225	15 /* (or 14) */, sr_kern_packet_valid, sr_kern_parse
dd5c48a6 LPC	226	)
dd5c48a6 LPC	227	);