[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_LIMIT_SAMPLES | SR_CONF_SET,
	SR_CONF_LIMIT_MSEC | SR_CONF_SET,
};

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

static struct sr_dev_driver center_309_driver_info;
static 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 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 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->sw_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)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;

	sr_sw_limits_acquisition_start(&devc->sw_limits);

	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_SCAN(X) \
static GSList *scan_##X(struct sr_dev_driver *d, GSList *options) { \
	(void)d; return scan(options, 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_SCAN(ID_UPPER) \
HW_DEV_ACQUISITION_START(ID_UPPER) \
static struct sr_dev_driver ID##_driver_info = { \
	.name = NAME, \
	.longname = LONGNAME, \
	.api_version = 1, \
	.init = std_init, \
	.cleanup = std_cleanup, \
	.scan = scan_##ID_UPPER, \
	.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_##ID_UPPER, \
	.dev_acquisition_stop = dev_acquisition_stop, \
	.context = NULL, \
}; \
SR_REGISTER_DEV_DRIVER(ID##_driver_info);

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
6ec6c43b	21	#include <config.h>
4433145f UH	22	#include "protocol.h"
4433145f UH	23
a0e0bb41	24	static const uint32_t scanopts[] = {
4a8bbed7 UH	25	SR_CONF_CONN,
	26	SR_CONF_SERIALCOMM,
	27	};
	28
6685e9a6	29	static const uint32_t drvopts[] = {
4a8bbed7	30	SR_CONF_THERMOMETER,
6685e9a6 UH	31	};
	32
	33	static const uint32_t devopts[] = {
e91bb0a6	34	SR_CONF_CONTINUOUS,
5827f61b BV	35	SR_CONF_LIMIT_SAMPLES \| SR_CONF_SET,
5827f61b BV	36	SR_CONF_LIMIT_MSEC \| SR_CONF_SET,
4a8bbed7 UH	37	};
4a8bbed7 UH	38
ba7dd8bb	39	static const char *channel_names[] = {
4a8bbed7	40	"T1", "T2", "T3", "T4",
4a8bbed7 UH	41	};
4a8bbed7 UH	42
dd5c48a6 LPC	43	static struct sr_dev_driver center_309_driver_info;
dd5c48a6 LPC	44	static struct sr_dev_driver voltcraft_k204_driver_info;
4a8bbed7 UH	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 UH	59	static GSList center_scan(const char conn, const char *serialcomm, int idx)
	60	{
	61	int i;
	62	struct sr_dev_inst *sdi;
4433145f	63	struct drv_context *drvc;
4a8bbed7	64	struct dev_context *devc;
4a8bbed7	65	struct sr_serial_dev_inst *serial;
4433145f UH	66	GSList *devices;
4433145f UH	67
91219afc	68	serial = sr_serial_dev_inst_new(conn, serialcomm);
4a8bbed7	69
258a2313	70	if (serial_open(serial, SERIAL_RDWR) != SR_OK)
4a8bbed7	71	return NULL;
4433145f	72
41812aca	73	drvc = center_devs[idx].di->context;
4433145f	74	devices = NULL;
4a8bbed7 UH	75	serial_flush(serial);
	76
	77	sr_info("Found device on port %s.", conn);
	78
aac29cc1	79	sdi = g_malloc0(sizeof(struct sr_dev_inst));
0af636be UH	80	sdi->status = SR_ST_INACTIVE;
	81	sdi->vendor = g_strdup(center_devs[idx].vendor);
	82	sdi->model = g_strdup(center_devs[idx].device);
f57d8ffe	83	devc = g_malloc0(sizeof(struct dev_context));
4a8bbed7 UH	84	sdi->inst_type = SR_INST_SERIAL;
4a8bbed7 UH	85	sdi->conn = serial;
4a8bbed7 UH	86	sdi->priv = devc;
	87	sdi->driver = center_devs[idx].di;
	88
0f34cb47 UH	89	for (i = 0; i < center_devs[idx].num_channels; i++)
0f34cb47 UH	90	sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, TRUE, channel_names[i]);
4a8bbed7 UH	91
	92	drvc->instances = g_slist_append(drvc->instances, sdi);
	93	devices = g_slist_append(devices, sdi);
	94
4a8bbed7	95	serial_close(serial);
4433145f UH	96
	97	return devices;
	98	}
	99
4a8bbed7	100	static GSList scan(GSList options, int idx)
4433145f	101	{
4a8bbed7 UH	102	struct sr_config *src;
	103	GSList l, devices;
	104	const char conn, serialcomm;
	105
	106	conn = serialcomm = NULL;
	107	for (l = options; l; l = l->next) {
	108	src = l->data;
	109	switch (src->key) {
	110	case SR_CONF_CONN:
	111	conn = g_variant_get_string(src->data, NULL);
	112	break;
	113	case SR_CONF_SERIALCOMM:
	114	serialcomm = g_variant_get_string(src->data, NULL);
	115	break;
	116	}
	117	}
	118	if (!conn)
	119	return NULL;
	120
	121	if (serialcomm) {
	122	/* Use the provided comm specs. */
	123	devices = center_scan(conn, serialcomm, idx);
	124	} else {
	125	/* Try the default. */
	126	devices = center_scan(conn, center_devs[idx].conn, idx);
	127	}
	128
	129	return devices;
4433145f UH	130	}
4433145f UH	131
584560f1	132	static int config_set(uint32_t key, GVariant data, const struct sr_dev_inst sdi,
53b4680f	133	const struct sr_channel_group *cg)
4433145f	134	{
4a8bbed7	135	struct dev_context *devc;
4433145f	136
53b4680f	137	(void)cg;
d3c74a6f	138
4433145f UH	139	if (sdi->status != SR_ST_ACTIVE)
	140	return SR_ERR_DEV_CLOSED;
	141
4a8bbed7 UH	142	devc = sdi->priv;
4a8bbed7 UH	143
838f6906	144	return sr_sw_limits_config_set(&devc->sw_limits, key, data);
4433145f UH	145	}
4433145f UH	146
584560f1	147	static int config_list(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
53b4680f	148	const struct sr_channel_group *cg)
4433145f	149	{
53b4680f	150	(void)cg;
4433145f	151
4433145f	152	switch (key) {
4a8bbed7	153	case SR_CONF_SCAN_OPTIONS:
584560f1	154	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
a0e0bb41	155	scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
4a8bbed7 UH	156	break;
4a8bbed7 UH	157	case SR_CONF_DEVICE_OPTIONS:
6685e9a6 UH	158	if (!sdi)
	159	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
	160	drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
	161	else
	162	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
f254bc4b	163	devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
4a8bbed7	164	break;
4433145f UH	165	default:
	166	return SR_ERR_NA;
	167	}
	168
4a8bbed7	169	return SR_OK;
4433145f UH	170	}
4433145f UH	171
695dc859	172	static int dev_acquisition_start(const struct sr_dev_inst *sdi, int idx)
4433145f	173	{
4a8bbed7 UH	174	struct dev_context *devc;
4a8bbed7 UH	175	struct sr_serial_dev_inst *serial;
4433145f UH	176
	177	if (sdi->status != SR_ST_ACTIVE)
	178	return SR_ERR_DEV_CLOSED;
	179
4a8bbed7	180	devc = sdi->priv;
838f6906 LPC	181
838f6906 LPC	182	sr_sw_limits_acquisition_start(&devc->sw_limits);
4a8bbed7	183
695dc859	184	std_session_send_df_header(sdi, LOG_PREFIX);
4a8bbed7 UH	185
	186	/* Poll every 500ms, or whenever some data comes in. */
	187	serial = sdi->conn;
102f1239	188	serial_source_add(sdi->session, serial, G_IO_IN, 500,
4a8bbed7 UH	189	center_devs[idx].receive_data, (void *)sdi);
4a8bbed7 UH	190
4433145f UH	191	return SR_OK;
	192	}
	193
695dc859	194	static int dev_acquisition_stop(struct sr_dev_inst *sdi)
4433145f	195	{
6525d819	196	return std_serial_dev_acquisition_stop(sdi,
d43b0908	197	std_serial_dev_close, sdi->conn, LOG_PREFIX);
4433145f UH	198	}
4433145f UH	199
4a8bbed7	200	/* Driver-specific API function wrappers */
4a8bbed7	201	#define HW_SCAN(X) \
4f840ce9	202	static GSList scan_##X(struct sr_dev_driver d, GSList *options) { \
1a863916	203	(void)d; return scan(options, X); }
4a8bbed7	204	#define HW_DEV_ACQUISITION_START(X) \
695dc859 UH	205	static int dev_acquisition_start_##X(const struct sr_dev_inst *sdi \
695dc859 UH	206	) { return dev_acquisition_start(sdi, X); }
4a8bbed7 UH	207
	208	/* Driver structs and API function wrappers */
	209	#define DRV(ID, ID_UPPER, NAME, LONGNAME) \
4a8bbed7	210	HW_SCAN(ID_UPPER) \
4a8bbed7	211	HW_DEV_ACQUISITION_START(ID_UPPER) \
dd5c48a6	212	static struct sr_dev_driver ID##_driver_info = { \
4a8bbed7 UH	213	.name = NAME, \
	214	.longname = LONGNAME, \
	215	.api_version = 1, \
c2fdcc25	216	.init = std_init, \
700d6b64	217	.cleanup = std_cleanup, \
4a8bbed7	218	.scan = scan_##ID_UPPER, \
c01bf34c	219	.dev_list = std_dev_list, \
4a8bbed7 UH	220	.config_get = NULL, \
	221	.config_set = config_set, \
	222	.config_list = config_list, \
854434de	223	.dev_open = std_serial_dev_open, \
bf2c987f	224	.dev_close = std_serial_dev_close, \
4a8bbed7 UH	225	.dev_acquisition_start = dev_acquisition_start_##ID_UPPER, \
4a8bbed7 UH	226	.dev_acquisition_stop = dev_acquisition_stop, \
41812aca	227	.context = NULL, \
dd5c48a6 LPC	228	}; \
dd5c48a6 LPC	229	SR_REGISTER_DEV_DRIVER(ID##_driver_info);
4a8bbed7 UH	230
	231	DRV(center_309, CENTER_309, "center-309", "Center 309")
	232	DRV(voltcraft_k204, VOLTCRAFT_K204, "voltcraft-k204", "Voltcraft K204")