[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 hwopts[] = {
	SR_CONF_CONN,
	SR_CONF_SERIALCOMM,
};

static const uint32_t hwcaps[] = {
	SR_CONF_THERMOMETER,
	SR_CONF_LIMIT_SAMPLES,
	SR_CONF_LIMIT_MSEC,
	SR_CONF_CONTINUOUS,
};

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_channel *ch;
	struct sr_serial_dev_inst *serial;
	GSList *devices;

	if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
		return NULL;

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

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

	sr_info("Found device on port %s.", conn);

	if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, center_devs[idx].vendor,
				    center_devs[idx].device, NULL)))
		goto scan_cleanup;

	if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
		sr_err("Device context malloc failed.");
		goto scan_cleanup;
	}

	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++) {
		if (!(ch = sr_channel_new(i, SR_CHANNEL_ANALOG,
					   TRUE, channel_names[i])))
			goto scan_cleanup;
		sdi->channels = g_slist_append(sdi->channels, ch);
	}

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

scan_cleanup:
	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)sdi;
	(void)cg;

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