[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 "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",
	NULL,
};

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 dev_clear(int idx)
{
	return std_dev_clear(center_devs[idx].di, NULL);
}

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->priv;
	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->priv))->instances;
}

static int cleanup(int idx)
{
	return dev_clear(idx);
}

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,
				    void *cb_data, 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->cb_data = cb_data;
	devc->num_samples = 0;
	devc->starttime = g_get_monotonic_time();

	/* Send header packet to the session bus. */
	std_session_send_df_header(cb_data, 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, void *cb_data)
{
	return std_serial_dev_acquisition_stop(sdi, cb_data,
			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_CLEANUP(X) \
static int cleanup_##X(const struct sr_dev_driver *d) { \
	(void)d; return cleanup(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_CLEAR(X) \
static int dev_clear_##X(const struct sr_dev_driver *d) { \
	(void)d; return dev_clear(X); }
#define HW_DEV_ACQUISITION_START(X) \
static int dev_acquisition_start_##X(const struct sr_dev_inst *sdi, \
void *cb_data) { return dev_acquisition_start(sdi, cb_data, X); }

/* Driver structs and API function wrappers */
#define DRV(ID, ID_UPPER, NAME, LONGNAME) \
HW_INIT(ID_UPPER) \
HW_CLEANUP(ID_UPPER) \
HW_SCAN(ID_UPPER) \
HW_DEV_LIST(ID_UPPER) \
HW_DEV_CLEAR(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 = cleanup_##ID_UPPER, \
	.scan = scan_##ID_UPPER, \
	.dev_list = dev_list_##ID_UPPER, \
	.dev_clear = dev_clear_##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, \
	.priv = NULL, \
};

DRV(center_309, CENTER_309, "center-309", "Center 309")
DRV(voltcraft_k204, VOLTCRAFT_K204, "voltcraft-k204", "Voltcraft K204")
Commit	Line	Data
4433145f UH	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 "protocol.h"
	22
a0e0bb41	23	static const uint32_t scanopts[] = {
4a8bbed7 UH	24	SR_CONF_CONN,
	25	SR_CONF_SERIALCOMM,
	26	};
	27
6685e9a6	28	static const uint32_t drvopts[] = {
4a8bbed7	29	SR_CONF_THERMOMETER,
6685e9a6 UH	30	};
	31
	32	static const uint32_t devopts[] = {
	33	SR_CONF_CONTINUOUS \| SR_CONF_SET,
5827f61b BV	34	SR_CONF_LIMIT_SAMPLES \| SR_CONF_SET,
5827f61b BV	35	SR_CONF_LIMIT_MSEC \| SR_CONF_SET,
4a8bbed7 UH	36	};
4a8bbed7 UH	37
ba7dd8bb	38	static const char *channel_names[] = {
4a8bbed7 UH	39	"T1", "T2", "T3", "T4",
	40	NULL,
	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	};
4433145f	58
4a8bbed7	59	static int dev_clear(int idx)
4433145f	60	{
4a8bbed7	61	return std_dev_clear(center_devs[idx].di, NULL);
4433145f UH	62	}
4433145f UH	63
4a8bbed7	64	static int init(struct sr_context *sr_ctx, int idx)
4433145f	65	{
4a8bbed7 UH	66	return std_init(sr_ctx, center_devs[idx].di, LOG_PREFIX);
	67	}
	68
	69	static GSList center_scan(const char conn, const char *serialcomm, int idx)
	70	{
	71	int i;
	72	struct sr_dev_inst *sdi;
4433145f	73	struct drv_context *drvc;
4a8bbed7	74	struct dev_context *devc;
4a8bbed7	75	struct sr_serial_dev_inst *serial;
4433145f UH	76	GSList *devices;
4433145f UH	77
91219afc	78	serial = sr_serial_dev_inst_new(conn, serialcomm);
4a8bbed7	79
258a2313	80	if (serial_open(serial, SERIAL_RDWR) != SR_OK)
4a8bbed7	81	return NULL;
4433145f	82
4a8bbed7	83	drvc = center_devs[idx].di->priv;
4433145f	84	devices = NULL;
4a8bbed7 UH	85	serial_flush(serial);
	86
	87	sr_info("Found device on port %s.", conn);
	88
aac29cc1	89	sdi = g_malloc0(sizeof(struct sr_dev_inst));
0af636be UH	90	sdi->status = SR_ST_INACTIVE;
	91	sdi->vendor = g_strdup(center_devs[idx].vendor);
	92	sdi->model = g_strdup(center_devs[idx].device);
f57d8ffe	93	devc = g_malloc0(sizeof(struct dev_context));
4a8bbed7 UH	94	sdi->inst_type = SR_INST_SERIAL;
4a8bbed7 UH	95	sdi->conn = serial;
4a8bbed7 UH	96	sdi->priv = devc;
	97	sdi->driver = center_devs[idx].di;
	98
	99	for (i = 0; i < center_devs[idx].num_channels; i++) {
5e23fcab	100	sr_channel_new(sdi, i, SR_CHANNEL_ANALOG,
c368e6f3	101	TRUE, channel_names[i]);
4a8bbed7 UH	102	}
	103
	104	drvc->instances = g_slist_append(drvc->instances, sdi);
	105	devices = g_slist_append(devices, sdi);
	106
4a8bbed7	107	serial_close(serial);
4433145f UH	108
	109	return devices;
	110	}
	111
4a8bbed7	112	static GSList scan(GSList options, int idx)
4433145f	113	{
4a8bbed7 UH	114	struct sr_config *src;
	115	GSList l, devices;
	116	const char conn, serialcomm;
	117
	118	conn = serialcomm = NULL;
	119	for (l = options; l; l = l->next) {
	120	src = l->data;
	121	switch (src->key) {
	122	case SR_CONF_CONN:
	123	conn = g_variant_get_string(src->data, NULL);
	124	break;
	125	case SR_CONF_SERIALCOMM:
	126	serialcomm = g_variant_get_string(src->data, NULL);
	127	break;
	128	}
	129	}
	130	if (!conn)
	131	return NULL;
	132
	133	if (serialcomm) {
	134	/* Use the provided comm specs. */
	135	devices = center_scan(conn, serialcomm, idx);
	136	} else {
	137	/* Try the default. */
	138	devices = center_scan(conn, center_devs[idx].conn, idx);
	139	}
	140
	141	return devices;
4433145f UH	142	}
4433145f UH	143
4a8bbed7	144	static GSList *dev_list(int idx)
4433145f	145	{
4a8bbed7	146	return ((struct drv_context *)(center_devs[idx].di->priv))->instances;
4433145f UH	147	}
4433145f UH	148
4a8bbed7	149	static int cleanup(int idx)
4433145f	150	{
4a8bbed7	151	return dev_clear(idx);
4433145f UH	152	}
4433145f UH	153
584560f1	154	static int config_set(uint32_t key, GVariant data, const struct sr_dev_inst sdi,
53b4680f	155	const struct sr_channel_group *cg)
4433145f	156	{
4a8bbed7	157	struct dev_context *devc;
4433145f	158
53b4680f	159	(void)cg;
d3c74a6f	160
4433145f UH	161	if (sdi->status != SR_ST_ACTIVE)
	162	return SR_ERR_DEV_CLOSED;
	163
4a8bbed7 UH	164	devc = sdi->priv;
4a8bbed7 UH	165
584560f1	166	switch (key) {
4a8bbed7 UH	167	case SR_CONF_LIMIT_SAMPLES:
	168	if (g_variant_get_uint64(data) == 0)
	169	return SR_ERR_ARG;
	170	devc->limit_samples = g_variant_get_uint64(data);
	171	break;
	172	case SR_CONF_LIMIT_MSEC:
	173	if (g_variant_get_uint64(data) == 0)
	174	return SR_ERR_ARG;
	175	devc->limit_msec = g_variant_get_uint64(data);
	176	break;
4433145f	177	default:
4a8bbed7	178	return SR_ERR_NA;
4433145f UH	179	}
4433145f UH	180
4a8bbed7	181	return SR_OK;
4433145f UH	182	}
4433145f UH	183
584560f1	184	static int config_list(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
53b4680f	185	const struct sr_channel_group *cg)
4433145f	186	{
53b4680f	187	(void)cg;
4433145f	188
4433145f	189	switch (key) {
4a8bbed7	190	case SR_CONF_SCAN_OPTIONS:
584560f1	191	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
a0e0bb41	192	scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
4a8bbed7 UH	193	break;
4a8bbed7 UH	194	case SR_CONF_DEVICE_OPTIONS:
6685e9a6 UH	195	if (!sdi)
	196	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
	197	drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
	198	else
	199	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
f254bc4b	200	devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
4a8bbed7	201	break;
4433145f UH	202	default:
	203	return SR_ERR_NA;
	204	}
	205
4a8bbed7	206	return SR_OK;
4433145f UH	207	}
	208
	209	static int dev_acquisition_start(const struct sr_dev_inst *sdi,
4a8bbed7	210	void *cb_data, int idx)
4433145f	211	{
4a8bbed7 UH	212	struct dev_context *devc;
4a8bbed7 UH	213	struct sr_serial_dev_inst *serial;
4433145f UH	214
	215	if (sdi->status != SR_ST_ACTIVE)
	216	return SR_ERR_DEV_CLOSED;
	217
4a8bbed7 UH	218	devc = sdi->priv;
	219	devc->cb_data = cb_data;
	220	devc->num_samples = 0;
	221	devc->starttime = g_get_monotonic_time();
	222
	223	/* Send header packet to the session bus. */
	224	std_session_send_df_header(cb_data, LOG_PREFIX);
	225
	226	/* Poll every 500ms, or whenever some data comes in. */
	227	serial = sdi->conn;
102f1239	228	serial_source_add(sdi->session, serial, G_IO_IN, 500,
4a8bbed7 UH	229	center_devs[idx].receive_data, (void *)sdi);
4a8bbed7 UH	230
4433145f UH	231	return SR_OK;
	232	}
	233
	234	static int dev_acquisition_stop(struct sr_dev_inst sdi, void cb_data)
	235	{
d43b0908 BV	236	return std_serial_dev_acquisition_stop(sdi, cb_data,
d43b0908 BV	237	std_serial_dev_close, sdi->conn, LOG_PREFIX);
4433145f UH	238	}
4433145f UH	239
4a8bbed7 UH	240	/* Driver-specific API function wrappers */
4a8bbed7 UH	241	#define HW_INIT(X) \
4f840ce9	242	static int init_##X(struct sr_dev_driver *d, \
1a863916	243	struct sr_context *sr_ctx) { (void)d; return init(sr_ctx, X); }
4a8bbed7	244	#define HW_CLEANUP(X) \
4f840ce9	245	static int cleanup_##X(const struct sr_dev_driver *d) { \
1a863916	246	(void)d; return cleanup(X); }
4a8bbed7	247	#define HW_SCAN(X) \
4f840ce9	248	static GSList scan_##X(struct sr_dev_driver d, GSList *options) { \
1a863916	249	(void)d; return scan(options, X); }
4a8bbed7	250	#define HW_DEV_LIST(X) \
4f840ce9	251	static GSList dev_list_##X(const struct sr_dev_driver d) { \
1a863916	252	(void)d; return dev_list(X); }
4a8bbed7	253	#define HW_DEV_CLEAR(X) \
4f840ce9	254	static int dev_clear_##X(const struct sr_dev_driver *d) { \
1a863916	255	(void)d; return dev_clear(X); }
4a8bbed7 UH	256	#define HW_DEV_ACQUISITION_START(X) \
	257	static int dev_acquisition_start_##X(const struct sr_dev_inst *sdi, \
	258	void *cb_data) { return dev_acquisition_start(sdi, cb_data, X); }
	259
	260	/* Driver structs and API function wrappers */
	261	#define DRV(ID, ID_UPPER, NAME, LONGNAME) \
	262	HW_INIT(ID_UPPER) \
	263	HW_CLEANUP(ID_UPPER) \
	264	HW_SCAN(ID_UPPER) \
	265	HW_DEV_LIST(ID_UPPER) \
	266	HW_DEV_CLEAR(ID_UPPER) \
	267	HW_DEV_ACQUISITION_START(ID_UPPER) \
	268	SR_PRIV struct sr_dev_driver ID##_driver_info = { \
	269	.name = NAME, \
	270	.longname = LONGNAME, \
	271	.api_version = 1, \
	272	.init = init_##ID_UPPER, \
	273	.cleanup = cleanup_##ID_UPPER, \
	274	.scan = scan_##ID_UPPER, \
	275	.dev_list = dev_list_##ID_UPPER, \
	276	.dev_clear = dev_clear_##ID_UPPER, \
	277	.config_get = NULL, \
	278	.config_set = config_set, \
	279	.config_list = config_list, \
854434de	280	.dev_open = std_serial_dev_open, \
bf2c987f	281	.dev_close = std_serial_dev_close, \
4a8bbed7 UH	282	.dev_acquisition_start = dev_acquisition_start_##ID_UPPER, \
	283	.dev_acquisition_stop = dev_acquisition_stop, \
	284	.priv = NULL, \
4433145f	285	};
4a8bbed7 UH	286
	287	DRV(center_309, CENTER_309, "center-309", "Center 309")
	288	DRV(voltcraft_k204, VOLTCRAFT_K204, "voltcraft-k204", "Voltcraft K204")