[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, see <http://www.gnu.org/licenses/>.
 */

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

	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;
	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "Mass");
	devices = g_slist_append(devices, sdi);

scan_cleanup:
	serial_close(serial);

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

	/* 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;
}

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