[libsigrok.git] / 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 int32_t hwopts[] = {
	SR_CONF_CONN,
	SR_CONF_SERIALCOMM,
};

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

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 | SERIAL_NONBLOCK) != 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);

	if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, "APPA", "55II", "")))
		goto scan_cleanup;

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

	devc->data_source = DEFAULT_DATA_SOURCE;

	sdi->inst_type = SR_INST_SERIAL;
	sdi->conn = serial;
	sdi->priv = devc;
	sdi->driver = di;

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

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

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