[libsigrok.git] / src / hardware / center-3xx / api.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2013 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 "protocol.h"

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

static const uint32_t drvopts[] = {
	SR_CONF_THERMOMETER,
};

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

static const char *channel_names[] = {
	"T1", "T2", "T3", "T4",
};

SR_PRIV struct sr_dev_driver center_309_driver_info;
SR_PRIV struct sr_dev_driver voltcraft_k204_driver_info;

SR_PRIV const struct center_dev_info center_devs[] = {
	{
		"Center", "309", "9600/8n1", 4, 32000, 45,
		center_3xx_packet_valid,
		&center_309_driver_info, receive_data_CENTER_309,
	},
	{
		"Voltcraft", "K204", "9600/8n1", 4, 32000, 45,
		center_3xx_packet_valid,
		&voltcraft_k204_driver_info, receive_data_VOLTCRAFT_K204,
	},
};

static int init(struct sr_context *sr_ctx, int idx)
{
	return std_init(sr_ctx, center_devs[idx].di, LOG_PREFIX);
}

static GSList *center_scan(const char *conn, const char *serialcomm, int idx)
{
	int i;
	struct sr_dev_inst *sdi;
	struct drv_context *drvc;
	struct dev_context *devc;
	struct sr_serial_dev_inst *serial;
	GSList *devices;

	serial = sr_serial_dev_inst_new(conn, serialcomm);

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

	drvc = center_devs[idx].di->context;
	devices = NULL;
	serial_flush(serial);

	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(center_devs[idx].vendor);
	sdi->model = g_strdup(center_devs[idx].device);
	devc = g_malloc0(sizeof(struct dev_context));
	sdi->inst_type = SR_INST_SERIAL;
	sdi->conn = serial;
	sdi->priv = devc;
	sdi->driver = center_devs[idx].di;

	for (i = 0; i < center_devs[idx].num_channels; i++)
		sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, TRUE, channel_names[i]);

	drvc->instances = g_slist_append(drvc->instances, sdi);
	devices = g_slist_append(devices, sdi);

	serial_close(serial);

	return devices;
}

static GSList *scan(GSList *options, int idx)
{
	struct sr_config *src;
	GSList *l, *devices;
	const char *conn, *serialcomm;

	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 = center_scan(conn, serialcomm, idx);
	} else {
		/* Try the default. */
		devices = center_scan(conn, center_devs[idx].conn, idx);
	}

	return devices;
}

static GSList *dev_list(int idx)
{
	return ((struct drv_context *)(center_devs[idx].di->context))->instances;
}

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;

	switch (key) {
	case SR_CONF_LIMIT_SAMPLES:
		if (g_variant_get_uint64(data) == 0)
			return SR_ERR_ARG;
		devc->limit_samples = g_variant_get_uint64(data);
		break;
	case SR_CONF_LIMIT_MSEC:
		if (g_variant_get_uint64(data) == 0)
			return SR_ERR_ARG;
		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)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:
		if (!sdi)
			*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
				drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
		else
			*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, int idx)
{
	struct dev_context *devc;
	struct sr_serial_dev_inst *serial;

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

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

	std_session_send_df_header(sdi, LOG_PREFIX);

	/* Poll every 500ms, or whenever some data comes in. */
	serial = sdi->conn;
	serial_source_add(sdi->session, serial, G_IO_IN, 500,
		      center_devs[idx].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);
}

/* Driver-specific API function wrappers */
#define HW_INIT(X) \
static int init_##X(struct sr_dev_driver *d, \
	struct sr_context *sr_ctx) { (void)d; return init(sr_ctx, X); }
#define HW_SCAN(X) \
static GSList *scan_##X(struct sr_dev_driver *d, GSList *options) { \
	(void)d; return scan(options, X); }
#define HW_DEV_LIST(X) \
static GSList *dev_list_##X(const struct sr_dev_driver *d) { \
	(void)d; return dev_list(X); }
#define HW_DEV_ACQUISITION_START(X) \
static int dev_acquisition_start_##X(const struct sr_dev_inst *sdi \
) { return dev_acquisition_start(sdi, X); }

/* Driver structs and API function wrappers */
#define DRV(ID, ID_UPPER, NAME, LONGNAME) \
HW_INIT(ID_UPPER) \
HW_SCAN(ID_UPPER) \
HW_DEV_LIST(ID_UPPER) \
HW_DEV_ACQUISITION_START(ID_UPPER) \
SR_PRIV struct sr_dev_driver ID##_driver_info = { \
	.name = NAME, \
	.longname = LONGNAME, \
	.api_version = 1, \
	.init = init_##ID_UPPER, \
	.cleanup = std_cleanup, \
	.scan = scan_##ID_UPPER, \
	.dev_list = dev_list_##ID_UPPER, \
	.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_##ID_UPPER, \
	.dev_acquisition_stop = dev_acquisition_stop, \
	.context = NULL, \
};

DRV(center_309, CENTER_309, "center-309", "Center 309")
DRV(voltcraft_k204, VOLTCRAFT_K204, "voltcraft-k204", "Voltcraft K204")
Commit	Line	Data
	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2013 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
	21	#include <config.h>
	22	#include "protocol.h"
	23
	24	static const uint32_t scanopts[] = {
	25	SR_CONF_CONN,
	26	SR_CONF_SERIALCOMM,
	27	};
	28
	29	static const uint32_t drvopts[] = {
	30	SR_CONF_THERMOMETER,
	31	};
	32
	33	static const uint32_t devopts[] = {
	34	SR_CONF_CONTINUOUS \| SR_CONF_SET,
	35	SR_CONF_LIMIT_SAMPLES \| SR_CONF_SET,
	36	SR_CONF_LIMIT_MSEC \| SR_CONF_SET,
	37	};
	38
	39	static const char *channel_names[] = {
	40	"T1", "T2", "T3", "T4",
	41	};
	42
	43	SR_PRIV struct sr_dev_driver center_309_driver_info;
	44	SR_PRIV struct sr_dev_driver voltcraft_k204_driver_info;
	45
	46	SR_PRIV const struct center_dev_info center_devs[] = {
	47	{
	48	"Center", "309", "9600/8n1", 4, 32000, 45,
	49	center_3xx_packet_valid,
	50	&center_309_driver_info, receive_data_CENTER_309,
	51	},
	52	{
	53	"Voltcraft", "K204", "9600/8n1", 4, 32000, 45,
	54	center_3xx_packet_valid,
	55	&voltcraft_k204_driver_info, receive_data_VOLTCRAFT_K204,
	56	},
	57	};
	58
	59	static int init(struct sr_context *sr_ctx, int idx)
	60	{
	61	return std_init(sr_ctx, center_devs[idx].di, LOG_PREFIX);
	62	}
	63
	64	static GSList center_scan(const char conn, const char *serialcomm, int idx)
	65	{
	66	int i;
	67	struct sr_dev_inst *sdi;
	68	struct drv_context *drvc;
	69	struct dev_context *devc;
	70	struct sr_serial_dev_inst *serial;
	71	GSList *devices;
	72
	73	serial = sr_serial_dev_inst_new(conn, serialcomm);
	74
	75	if (serial_open(serial, SERIAL_RDWR) != SR_OK)
	76	return NULL;
	77
	78	drvc = center_devs[idx].di->context;
	79	devices = NULL;
	80	serial_flush(serial);
	81
	82	sr_info("Found device on port %s.", conn);
	83
	84	sdi = g_malloc0(sizeof(struct sr_dev_inst));
	85	sdi->status = SR_ST_INACTIVE;
	86	sdi->vendor = g_strdup(center_devs[idx].vendor);
	87	sdi->model = g_strdup(center_devs[idx].device);
	88	devc = g_malloc0(sizeof(struct dev_context));
	89	sdi->inst_type = SR_INST_SERIAL;
	90	sdi->conn = serial;
	91	sdi->priv = devc;
	92	sdi->driver = center_devs[idx].di;
	93
	94	for (i = 0; i < center_devs[idx].num_channels; i++)
	95	sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, TRUE, channel_names[i]);
	96
	97	drvc->instances = g_slist_append(drvc->instances, sdi);
	98	devices = g_slist_append(devices, sdi);
	99
	100	serial_close(serial);
	101
	102	return devices;
	103	}
	104
	105	static GSList scan(GSList options, int idx)
	106	{
	107	struct sr_config *src;
	108	GSList l, devices;
	109	const char conn, serialcomm;
	110
	111	conn = serialcomm = NULL;
	112	for (l = options; l; l = l->next) {
	113	src = l->data;
	114	switch (src->key) {
	115	case SR_CONF_CONN:
	116	conn = g_variant_get_string(src->data, NULL);
	117	break;
	118	case SR_CONF_SERIALCOMM:
	119	serialcomm = g_variant_get_string(src->data, NULL);
	120	break;
	121	}
	122	}
	123	if (!conn)
	124	return NULL;
	125
	126	if (serialcomm) {
	127	/* Use the provided comm specs. */
	128	devices = center_scan(conn, serialcomm, idx);
	129	} else {
	130	/* Try the default. */
	131	devices = center_scan(conn, center_devs[idx].conn, idx);
	132	}
	133
	134	return devices;
	135	}
	136
	137	static GSList *dev_list(int idx)
	138	{
	139	return ((struct drv_context *)(center_devs[idx].di->context))->instances;
	140	}
	141
	142	static int config_set(uint32_t key, GVariant data, const struct sr_dev_inst sdi,
	143	const struct sr_channel_group *cg)
	144	{
	145	struct dev_context *devc;
	146
	147	(void)cg;
	148
	149	if (sdi->status != SR_ST_ACTIVE)
	150	return SR_ERR_DEV_CLOSED;
	151
	152	devc = sdi->priv;
	153
	154	switch (key) {
	155	case SR_CONF_LIMIT_SAMPLES:
	156	if (g_variant_get_uint64(data) == 0)
	157	return SR_ERR_ARG;
	158	devc->limit_samples = g_variant_get_uint64(data);
	159	break;
	160	case SR_CONF_LIMIT_MSEC:
	161	if (g_variant_get_uint64(data) == 0)
	162	return SR_ERR_ARG;
	163	devc->limit_msec = g_variant_get_uint64(data);
	164	break;
	165	default:
	166	return SR_ERR_NA;
	167	}
	168
	169	return SR_OK;
	170	}
	171
	172	static int config_list(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
	173	const struct sr_channel_group *cg)
	174	{
	175	(void)cg;
	176
	177	switch (key) {
	178	case SR_CONF_SCAN_OPTIONS:
	179	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
	180	scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
	181	break;
	182	case SR_CONF_DEVICE_OPTIONS:
	183	if (!sdi)
	184	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
	185	drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
	186	else
	187	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
	188	devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
	189	break;
	190	default:
	191	return SR_ERR_NA;
	192	}
	193
	194	return SR_OK;
	195	}
	196
	197	static int dev_acquisition_start(const struct sr_dev_inst *sdi, int idx)
	198	{
	199	struct dev_context *devc;
	200	struct sr_serial_dev_inst *serial;
	201
	202	if (sdi->status != SR_ST_ACTIVE)
	203	return SR_ERR_DEV_CLOSED;
	204
	205	devc = sdi->priv;
	206	devc->num_samples = 0;
	207	devc->starttime = g_get_monotonic_time();
	208
	209	std_session_send_df_header(sdi, LOG_PREFIX);
	210
	211	/* Poll every 500ms, or whenever some data comes in. */
	212	serial = sdi->conn;
	213	serial_source_add(sdi->session, serial, G_IO_IN, 500,
	214	center_devs[idx].receive_data, (void *)sdi);
	215
	216	return SR_OK;
	217	}
	218
	219	static int dev_acquisition_stop(struct sr_dev_inst *sdi)
	220	{
	221	return std_serial_dev_acquisition_stop(sdi,
	222	std_serial_dev_close, sdi->conn, LOG_PREFIX);
	223	}
	224
	225	/* Driver-specific API function wrappers */
	226	#define HW_INIT(X) \
	227	static int init_##X(struct sr_dev_driver *d, \
	228	struct sr_context *sr_ctx) { (void)d; return init(sr_ctx, X); }
	229	#define HW_SCAN(X) \
	230	static GSList scan_##X(struct sr_dev_driver d, GSList *options) { \
	231	(void)d; return scan(options, X); }
	232	#define HW_DEV_LIST(X) \
	233	static GSList dev_list_##X(const struct sr_dev_driver d) { \
	234	(void)d; return dev_list(X); }
	235	#define HW_DEV_ACQUISITION_START(X) \
	236	static int dev_acquisition_start_##X(const struct sr_dev_inst *sdi \
	237	) { return dev_acquisition_start(sdi, X); }
	238
	239	/* Driver structs and API function wrappers */
	240	#define DRV(ID, ID_UPPER, NAME, LONGNAME) \
	241	HW_INIT(ID_UPPER) \
	242	HW_SCAN(ID_UPPER) \
	243	HW_DEV_LIST(ID_UPPER) \
	244	HW_DEV_ACQUISITION_START(ID_UPPER) \
	245	SR_PRIV struct sr_dev_driver ID##_driver_info = { \
	246	.name = NAME, \
	247	.longname = LONGNAME, \
	248	.api_version = 1, \
	249	.init = init_##ID_UPPER, \
	250	.cleanup = std_cleanup, \
	251	.scan = scan_##ID_UPPER, \
	252	.dev_list = dev_list_##ID_UPPER, \
	253	.config_get = NULL, \
	254	.config_set = config_set, \
	255	.config_list = config_list, \
	256	.dev_open = std_serial_dev_open, \
	257	.dev_close = std_serial_dev_close, \
	258	.dev_acquisition_start = dev_acquisition_start_##ID_UPPER, \
	259	.dev_acquisition_stop = dev_acquisition_stop, \
	260	.context = NULL, \
	261	};
	262
	263	DRV(center_309, CENTER_309, "center-309", "Center 309")
	264	DRV(voltcraft_k204, VOLTCRAFT_K204, "voltcraft-k204", "Voltcraft K204")