[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 drvopts[] = {
	SR_CONF_SCALE,
};

static const uint32_t devopts[] = {
	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;

	sr_spew("Set O1 mode (continuous values, stable and unstable ones).");
	if (serial_write_blocking(serial, "O1\r\n", 4, 0) < 0)
		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, NULL, NULL, 3000);
	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;

	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)
{
	return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
}

static int dev_acquisition_start(const struct sr_dev_inst *sdi)
{
	struct dev_context *devc;
	struct sr_serial_dev_inst *serial;

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

	sr_spew("Set O1 mode (continuous values, stable and unstable ones).");
	if (serial_write_blocking(serial, "O1\r\n", 4, 0) < 0)
		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);

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