[libsigrok.git] / src / hardware / appa-55ii / api.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2013 Aurelien Jacobs <aurel@gnuage.org>
 *
 * 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 3 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 <string.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_GET | SR_CONF_SET,
	SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
	SR_CONF_DATA_SOURCE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
};

static const char *data_sources[] = {
	"Live",
	"Memory",
};

SR_PRIV struct sr_dev_driver appa_55ii_driver_info;
static struct sr_dev_driver *di = &appa_55ii_driver_info;

static int init(struct sr_context *sr_ctx)
{
	return std_init(sr_ctx, di, LOG_PREFIX);
}

static GSList *scan(GSList *options)
{
	struct drv_context *drvc;
	struct dev_context *devc;
	struct sr_serial_dev_inst *serial;
	struct sr_dev_inst *sdi;
	struct sr_channel *ch;
	struct sr_config *src;
	GSList *devices, *l;
	const char *conn, *serialcomm;
	uint8_t buf[50];
	size_t len;

	len = sizeof(buf);
	devices = NULL;
	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 = "9600/8n1";

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

	sr_info("Probing serial port %s.", conn);

	drvc = di->priv;
	drvc->instances = NULL;
	serial_flush(serial);

	/* Let's get a bit of data and see if we can find a packet. */
	if (serial_stream_detect(serial, buf, &len, 25,
			appa_55ii_packet_valid, 500, 9600) != 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("APPA");
	sdi->model = g_strdup("55II");
	devc = g_malloc0(sizeof(struct dev_context));
	devc->data_source = DEFAULT_DATA_SOURCE;
	sdi->inst_type = SR_INST_SERIAL;
	sdi->conn = serial;
	sdi->priv = devc;
	sdi->driver = di;

	ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "T1");
	sdi->channels = g_slist_append(sdi->channels, ch);
	ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "T2");
	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 *dev_list(void)
{
	return ((struct drv_context *)(di->priv))->instances;
}

static int cleanup(void)
{
	return std_dev_clear(di, NULL);
}

static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
		const struct sr_channel_group *cg)
{
	struct dev_context *devc = sdi->priv;

	(void)cg;

	switch (key) {
	case SR_CONF_LIMIT_SAMPLES:
		*data = g_variant_new_uint64(devc->limit_samples);
		break;
	case SR_CONF_LIMIT_MSEC:
		*data = g_variant_new_uint64(devc->limit_msec);
		break;
	case SR_CONF_DATA_SOURCE:
		*data = g_variant_new_string(data_sources[devc->data_source]);
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

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;
	const char *tmp_str;
	unsigned int i;

	(void)cg;

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

	if (!(devc = sdi->priv)) {
		sr_err("sdi->priv was NULL.");
		return SR_ERR_BUG;
	}

	switch (key) {
	case SR_CONF_LIMIT_SAMPLES:
		devc->limit_samples = g_variant_get_uint64(data);
		sr_dbg("Setting sample limit to %" PRIu64 ".", devc->limit_samples);
		break;
	case SR_CONF_LIMIT_MSEC:
		devc->limit_msec = g_variant_get_uint64(data);
		sr_dbg("Setting time limit to %" PRIu64 "ms.", devc->limit_msec);
		break;
	case SR_CONF_DATA_SOURCE: {
		tmp_str = g_variant_get_string(data, NULL);
		for (i = 0; i < ARRAY_SIZE(data_sources); i++)
			if (!strcmp(tmp_str, data_sources[i])) {
				devc->data_source = i;
				break;
			}
		if (i == ARRAY_SIZE(data_sources))
			return SR_ERR;
		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,
				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;
	case SR_CONF_DATA_SOURCE:
		*data = g_variant_new_strv(data_sources, ARRAY_SIZE(data_sources));
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

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

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

	if (!(devc = sdi->priv)) {
		sr_err("sdi->priv was NULL.");
		return SR_ERR_BUG;
	}

	devc->session_cb_data = cb_data;

	/*
	 * Reset the number of samples to take. If we've already collected our
	 * quota, but we start a new session, and don't reset this, we'll just
	 * quit without acquiring any new samples.
	 */
	devc->num_samples = 0;
	devc->start_time = g_get_monotonic_time();

	/* Send header packet to the session bus. */
	std_session_send_df_header(cb_data, LOG_PREFIX);

	/* Poll every 50ms, or whenever some data comes in. */
	serial_source_add(sdi->session, serial, G_IO_IN, 50,
			appa_55ii_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);
}

SR_PRIV struct sr_dev_driver appa_55ii_driver_info = {
	.name = "appa-55ii",
	.longname = "APPA 55II",
	.api_version = 1,
	.init = init,
	.cleanup = cleanup,
	.scan = scan,
	.dev_list = dev_list,
	.dev_clear = NULL,
	.config_get = config_get,
	.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 = dev_acquisition_stop,
	.priv = NULL,
};
Commit	Line	Data
5e7a8e57 AJ	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2013 Aurelien Jacobs <aurel@gnuage.org>
	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 3 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
81a9ab72	20	#include <string.h>
5e7a8e57 AJ	21	#include "protocol.h"
5e7a8e57 AJ	22
a0e0bb41	23	static const uint32_t scanopts[] = {
81a9ab72 AJ	24	SR_CONF_CONN,
	25	SR_CONF_SERIALCOMM,
	26	};
	27
42a47a9a	28	static const uint32_t drvopts[] = {
81a9ab72	29	SR_CONF_THERMOMETER,
42a47a9a BV	30	};
	31
	32	static const uint32_t devopts[] = {
	33	SR_CONF_CONTINUOUS \| SR_CONF_SET,
5827f61b BV	34	SR_CONF_LIMIT_SAMPLES \| SR_CONF_GET \| SR_CONF_SET,
	35	SR_CONF_LIMIT_MSEC \| SR_CONF_GET \| SR_CONF_SET,
	36	SR_CONF_DATA_SOURCE \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
81a9ab72 AJ	37	};
	38
	39	static const char *data_sources[] = {
	40	"Live",
	41	"Memory",
	42	};
	43
5e7a8e57 AJ	44	SR_PRIV struct sr_dev_driver appa_55ii_driver_info;
	45	static struct sr_dev_driver *di = &appa_55ii_driver_info;
	46
	47	static int init(struct sr_context *sr_ctx)
	48	{
	49	return std_init(sr_ctx, di, LOG_PREFIX);
	50	}
	51
	52	static GSList scan(GSList options)
	53	{
	54	struct drv_context *drvc;
81a9ab72 AJ	55	struct dev_context *devc;
	56	struct sr_serial_dev_inst *serial;
	57	struct sr_dev_inst *sdi;
ba7dd8bb	58	struct sr_channel *ch;
7574e58c BV	59	struct sr_config *src;
	60	GSList devices, l;
	61	const char conn, serialcomm;
81a9ab72	62	uint8_t buf[50];
7574e58c	63	size_t len;
81a9ab72	64
7574e58c BV	65	len = sizeof(buf);
	66	devices = NULL;
	67	conn = serialcomm = NULL;
81a9ab72	68	for (l = options; l; l = l->next) {
7574e58c	69	src = l->data;
81a9ab72 AJ	70	switch (src->key) {
	71	case SR_CONF_CONN:
	72	conn = g_variant_get_string(src->data, NULL);
	73	break;
	74	case SR_CONF_SERIALCOMM:
	75	serialcomm = g_variant_get_string(src->data, NULL);
	76	break;
	77	}
	78	}
	79	if (!conn)
	80	return NULL;
	81	if (!serialcomm)
	82	serialcomm = "9600/8n1";
	83
	84	if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
	85	return NULL;
25dd0831	86	if (serial_open(serial, SERIAL_RDONLY) != SR_OK)
81a9ab72	87	return NULL;
5e7a8e57	88
81a9ab72	89	sr_info("Probing serial port %s.", conn);
5e7a8e57	90
5e7a8e57 AJ	91	drvc = di->priv;
5e7a8e57 AJ	92	drvc->instances = NULL;
81a9ab72 AJ	93	serial_flush(serial);
	94
	95	/* Let's get a bit of data and see if we can find a packet. */
	96	if (serial_stream_detect(serial, buf, &len, 25,
7574e58c	97	appa_55ii_packet_valid, 500, 9600) != SR_OK)
81a9ab72 AJ	98	goto scan_cleanup;
	99
	100	sr_info("Found device on port %s.", conn);
	101
aac29cc1	102	sdi = g_malloc0(sizeof(struct sr_dev_inst));
0af636be UH	103	sdi->status = SR_ST_INACTIVE;
	104	sdi->vendor = g_strdup("APPA");
	105	sdi->model = g_strdup("55II");
f57d8ffe	106	devc = g_malloc0(sizeof(struct dev_context));
81a9ab72	107	devc->data_source = DEFAULT_DATA_SOURCE;
81a9ab72 AJ	108	sdi->inst_type = SR_INST_SERIAL;
	109	sdi->conn = serial;
	110	sdi->priv = devc;
	111	sdi->driver = di;
5e7a8e57	112
c368e6f3	113	ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "T1");
ba7dd8bb	114	sdi->channels = g_slist_append(sdi->channels, ch);
c368e6f3	115	ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "T2");
ba7dd8bb	116	sdi->channels = g_slist_append(sdi->channels, ch);
81a9ab72 AJ	117
	118	drvc->instances = g_slist_append(drvc->instances, sdi);
	119	devices = g_slist_append(devices, sdi);
	120
	121	scan_cleanup:
	122	serial_close(serial);
5e7a8e57 AJ	123
	124	return devices;
	125	}
	126
	127	static GSList *dev_list(void)
	128	{
	129	return ((struct drv_context *)(di->priv))->instances;
	130	}
	131
5e7a8e57 AJ	132	static int cleanup(void)
5e7a8e57 AJ	133	{
a6630742	134	return std_dev_clear(di, NULL);
5e7a8e57 AJ	135	}
5e7a8e57 AJ	136
584560f1	137	static int config_get(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
53b4680f	138	const struct sr_channel_group *cg)
5e7a8e57	139	{
81a9ab72	140	struct dev_context *devc = sdi->priv;
5e7a8e57	141
53b4680f	142	(void)cg;
5e7a8e57	143
5e7a8e57	144	switch (key) {
81a9ab72 AJ	145	case SR_CONF_LIMIT_SAMPLES:
	146	*data = g_variant_new_uint64(devc->limit_samples);
	147	break;
	148	case SR_CONF_LIMIT_MSEC:
	149	*data = g_variant_new_uint64(devc->limit_msec);
	150	break;
	151	case SR_CONF_DATA_SOURCE:
	152	*data = g_variant_new_string(data_sources[devc->data_source]);
	153	break;
5e7a8e57 AJ	154	default:
	155	return SR_ERR_NA;
	156	}
	157
81a9ab72	158	return SR_OK;
5e7a8e57 AJ	159	}
5e7a8e57 AJ	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)
5e7a8e57	163	{
81a9ab72	164	struct dev_context *devc;
7574e58c BV	165	const char *tmp_str;
7574e58c BV	166	unsigned int i;
5e7a8e57	167
53b4680f	168	(void)cg;
5e7a8e57 AJ	169
	170	if (sdi->status != SR_ST_ACTIVE)
	171	return SR_ERR_DEV_CLOSED;
	172
81a9ab72 AJ	173	if (!(devc = sdi->priv)) {
	174	sr_err("sdi->priv was NULL.");
	175	return SR_ERR_BUG;
	176	}
	177
5e7a8e57	178	switch (key) {
81a9ab72 AJ	179	case SR_CONF_LIMIT_SAMPLES:
	180	devc->limit_samples = g_variant_get_uint64(data);
	181	sr_dbg("Setting sample limit to %" PRIu64 ".", devc->limit_samples);
	182	break;
	183	case SR_CONF_LIMIT_MSEC:
	184	devc->limit_msec = g_variant_get_uint64(data);
	185	sr_dbg("Setting time limit to %" PRIu64 "ms.", devc->limit_msec);
	186	break;
	187	case SR_CONF_DATA_SOURCE: {
7574e58c BV	188	tmp_str = g_variant_get_string(data, NULL);
7574e58c BV	189	for (i = 0; i < ARRAY_SIZE(data_sources); i++)
81a9ab72 AJ	190	if (!strcmp(tmp_str, data_sources[i])) {
	191	devc->data_source = i;
	192	break;
	193	}
	194	if (i == ARRAY_SIZE(data_sources))
	195	return SR_ERR;
	196	break;
	197	}
5e7a8e57	198	default:
81a9ab72	199	return SR_ERR_NA;
5e7a8e57 AJ	200	}
5e7a8e57 AJ	201
81a9ab72	202	return SR_OK;
5e7a8e57 AJ	203	}
5e7a8e57 AJ	204
584560f1	205	static int config_list(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
53b4680f	206	const struct sr_channel_group *cg)
5e7a8e57	207	{
5e7a8e57	208	(void)sdi;
53b4680f	209	(void)cg;
5e7a8e57	210
5e7a8e57	211	switch (key) {
81a9ab72	212	case SR_CONF_SCAN_OPTIONS:
584560f1	213	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
a0e0bb41	214	scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
81a9ab72 AJ	215	break;
81a9ab72 AJ	216	case SR_CONF_DEVICE_OPTIONS:
42a47a9a BV	217	if (!sdi)
	218	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
	219	drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
	220	else
	221	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
	222	devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
81a9ab72 AJ	223	break;
	224	case SR_CONF_DATA_SOURCE:
	225	*data = g_variant_new_strv(data_sources, ARRAY_SIZE(data_sources));
	226	break;
5e7a8e57 AJ	227	default:
	228	return SR_ERR_NA;
	229	}
	230
81a9ab72	231	return SR_OK;
5e7a8e57 AJ	232	}
	233
	234	static int dev_acquisition_start(const struct sr_dev_inst *sdi,
7574e58c	235	void *cb_data)
5e7a8e57	236	{
7574e58c	237	struct sr_serial_dev_inst *serial;
81a9ab72	238	struct dev_context *devc;
5e7a8e57	239
7574e58c	240	serial = sdi->conn;
5e7a8e57 AJ	241	if (sdi->status != SR_ST_ACTIVE)
	242	return SR_ERR_DEV_CLOSED;
	243
81a9ab72 AJ	244	if (!(devc = sdi->priv)) {
	245	sr_err("sdi->priv was NULL.");
	246	return SR_ERR_BUG;
	247	}
5e7a8e57	248
81a9ab72	249	devc->session_cb_data = cb_data;
5e7a8e57	250
81a9ab72 AJ	251	/*
	252	* Reset the number of samples to take. If we've already collected our
	253	* quota, but we start a new session, and don't reset this, we'll just
	254	* quit without acquiring any new samples.
	255	*/
	256	devc->num_samples = 0;
	257	devc->start_time = g_get_monotonic_time();
5e7a8e57	258
81a9ab72 AJ	259	/* Send header packet to the session bus. */
81a9ab72 AJ	260	std_session_send_df_header(cb_data, LOG_PREFIX);
5e7a8e57	261
81a9ab72	262	/* Poll every 50ms, or whenever some data comes in. */
102f1239 BV	263	serial_source_add(sdi->session, serial, G_IO_IN, 50,
102f1239 BV	264	appa_55ii_receive_data, (void *)sdi);
5e7a8e57 AJ	265
	266	return SR_OK;
	267	}
	268
81a9ab72 AJ	269	static int dev_acquisition_stop(struct sr_dev_inst sdi, void cb_data)
81a9ab72 AJ	270	{
76b4d4f4 UH	271	return std_serial_dev_acquisition_stop(sdi, cb_data,
76b4d4f4 UH	272	std_serial_dev_close, sdi->conn, LOG_PREFIX);
81a9ab72 AJ	273	}
81a9ab72 AJ	274
5e7a8e57 AJ	275	SR_PRIV struct sr_dev_driver appa_55ii_driver_info = {
	276	.name = "appa-55ii",
	277	.longname = "APPA 55II",
	278	.api_version = 1,
	279	.init = init,
	280	.cleanup = cleanup,
	281	.scan = scan,
	282	.dev_list = dev_list,
a6630742	283	.dev_clear = NULL,
5e7a8e57 AJ	284	.config_get = config_get,
	285	.config_set = config_set,
	286	.config_list = config_list,
81a9ab72 AJ	287	.dev_open = std_serial_dev_open,
81a9ab72 AJ	288	.dev_close = std_serial_dev_close,
5e7a8e57 AJ	289	.dev_acquisition_start = dev_acquisition_start,
5e7a8e57 AJ	290	.dev_acquisition_stop = dev_acquisition_stop,
76b4d4f4	291	.priv = NULL,
5e7a8e57	292	};