[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 devopts[] = {
	SR_CONF_THERMOMETER,
	SR_CONF_CONTINUOUS,
	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 = sr_dev_inst_new();
	sdi->status = SR_ST_INACTIVE;
	sdi->vendor = g_strdup("APPA");
	sdi->model = g_strdup("55II");

	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_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "T1")))
		goto scan_cleanup;
	sdi->channels = g_slist_append(sdi->channels, ch);
	if (!(ch = sr_channel_new(0, SR_CHANNEL_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(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:
		*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
f254bc4b	28	static const uint32_t devopts[] = {
81a9ab72	29	SR_CONF_THERMOMETER,
81a9ab72	30	SR_CONF_CONTINUOUS,
5827f61b BV	31	SR_CONF_LIMIT_SAMPLES \| SR_CONF_GET \| SR_CONF_SET,
	32	SR_CONF_LIMIT_MSEC \| SR_CONF_GET \| SR_CONF_SET,
	33	SR_CONF_DATA_SOURCE \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
81a9ab72 AJ	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;
25dd0831	83	if (serial_open(serial, SERIAL_RDONLY) != SR_OK)
81a9ab72	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
0af636be UH	99	sdi = sr_dev_inst_new();
	100	sdi->status = SR_ST_INACTIVE;
	101	sdi->vendor = g_strdup("APPA");
	102	sdi->model = g_strdup("55II");
81a9ab72 AJ	103
	104	if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
	105	sr_err("Device context malloc failed.");
	106	goto scan_cleanup;
	107	}
	108
	109	devc->data_source = DEFAULT_DATA_SOURCE;
	110
	111	sdi->inst_type = SR_INST_SERIAL;
	112	sdi->conn = serial;
	113	sdi->priv = devc;
	114	sdi->driver = di;
5e7a8e57	115
3f239f08	116	if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "T1")))
81a9ab72	117	goto scan_cleanup;
ba7dd8bb	118	sdi->channels = g_slist_append(sdi->channels, ch);
3f239f08	119	if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "T2")))
81a9ab72	120	goto scan_cleanup;
ba7dd8bb	121	sdi->channels = g_slist_append(sdi->channels, ch);
81a9ab72 AJ	122
	123	drvc->instances = g_slist_append(drvc->instances, sdi);
	124	devices = g_slist_append(devices, sdi);
	125
	126	scan_cleanup:
	127	serial_close(serial);
5e7a8e57 AJ	128
	129	return devices;
	130	}
	131
	132	static GSList *dev_list(void)
	133	{
	134	return ((struct drv_context *)(di->priv))->instances;
	135	}
	136
5e7a8e57 AJ	137	static int cleanup(void)
5e7a8e57 AJ	138	{
a6630742	139	return std_dev_clear(di, NULL);
5e7a8e57 AJ	140	}
5e7a8e57 AJ	141
584560f1	142	static int config_get(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
53b4680f	143	const struct sr_channel_group *cg)
5e7a8e57	144	{
81a9ab72	145	struct dev_context *devc = sdi->priv;
5e7a8e57	146
53b4680f	147	(void)cg;
5e7a8e57	148
5e7a8e57	149	switch (key) {
81a9ab72 AJ	150	case SR_CONF_LIMIT_SAMPLES:
	151	*data = g_variant_new_uint64(devc->limit_samples);
	152	break;
	153	case SR_CONF_LIMIT_MSEC:
	154	*data = g_variant_new_uint64(devc->limit_msec);
	155	break;
	156	case SR_CONF_DATA_SOURCE:
	157	*data = g_variant_new_string(data_sources[devc->data_source]);
	158	break;
5e7a8e57 AJ	159	default:
	160	return SR_ERR_NA;
	161	}
	162
81a9ab72	163	return SR_OK;
5e7a8e57 AJ	164	}
5e7a8e57 AJ	165
584560f1	166	static int config_set(uint32_t key, GVariant data, const struct sr_dev_inst sdi,
53b4680f	167	const struct sr_channel_group *cg)
5e7a8e57	168	{
81a9ab72	169	struct dev_context *devc;
7574e58c BV	170	const char *tmp_str;
7574e58c BV	171	unsigned int i;
5e7a8e57	172
53b4680f	173	(void)cg;
5e7a8e57 AJ	174
	175	if (sdi->status != SR_ST_ACTIVE)
	176	return SR_ERR_DEV_CLOSED;
	177
81a9ab72 AJ	178	if (!(devc = sdi->priv)) {
	179	sr_err("sdi->priv was NULL.");
	180	return SR_ERR_BUG;
	181	}
	182
5e7a8e57	183	switch (key) {
81a9ab72 AJ	184	case SR_CONF_LIMIT_SAMPLES:
	185	devc->limit_samples = g_variant_get_uint64(data);
	186	sr_dbg("Setting sample limit to %" PRIu64 ".", devc->limit_samples);
	187	break;
	188	case SR_CONF_LIMIT_MSEC:
	189	devc->limit_msec = g_variant_get_uint64(data);
	190	sr_dbg("Setting time limit to %" PRIu64 "ms.", devc->limit_msec);
	191	break;
	192	case SR_CONF_DATA_SOURCE: {
7574e58c BV	193	tmp_str = g_variant_get_string(data, NULL);
7574e58c BV	194	for (i = 0; i < ARRAY_SIZE(data_sources); i++)
81a9ab72 AJ	195	if (!strcmp(tmp_str, data_sources[i])) {
	196	devc->data_source = i;
	197	break;
	198	}
	199	if (i == ARRAY_SIZE(data_sources))
	200	return SR_ERR;
	201	break;
	202	}
5e7a8e57	203	default:
81a9ab72	204	return SR_ERR_NA;
5e7a8e57 AJ	205	}
5e7a8e57 AJ	206
81a9ab72	207	return SR_OK;
5e7a8e57 AJ	208	}
5e7a8e57 AJ	209
584560f1	210	static int config_list(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
53b4680f	211	const struct sr_channel_group *cg)
5e7a8e57	212	{
5e7a8e57	213	(void)sdi;
53b4680f	214	(void)cg;
5e7a8e57	215
5e7a8e57	216	switch (key) {
81a9ab72	217	case SR_CONF_SCAN_OPTIONS:
584560f1	218	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
a0e0bb41	219	scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
81a9ab72 AJ	220	break;
81a9ab72 AJ	221	case SR_CONF_DEVICE_OPTIONS:
584560f1	222	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
f254bc4b	223	devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
81a9ab72 AJ	224	break;
	225	case SR_CONF_DATA_SOURCE:
	226	*data = g_variant_new_strv(data_sources, ARRAY_SIZE(data_sources));
	227	break;
5e7a8e57 AJ	228	default:
	229	return SR_ERR_NA;
	230	}
	231
81a9ab72	232	return SR_OK;
5e7a8e57 AJ	233	}
	234
	235	static int dev_acquisition_start(const struct sr_dev_inst *sdi,
7574e58c	236	void *cb_data)
5e7a8e57	237	{
7574e58c	238	struct sr_serial_dev_inst *serial;
81a9ab72	239	struct dev_context *devc;
5e7a8e57	240
7574e58c	241	serial = sdi->conn;
5e7a8e57 AJ	242	if (sdi->status != SR_ST_ACTIVE)
	243	return SR_ERR_DEV_CLOSED;
	244
81a9ab72 AJ	245	if (!(devc = sdi->priv)) {
	246	sr_err("sdi->priv was NULL.");
	247	return SR_ERR_BUG;
	248	}
5e7a8e57	249
81a9ab72	250	devc->session_cb_data = cb_data;
5e7a8e57	251
81a9ab72 AJ	252	/*
	253	* Reset the number of samples to take. If we've already collected our
	254	* quota, but we start a new session, and don't reset this, we'll just
	255	* quit without acquiring any new samples.
	256	*/
	257	devc->num_samples = 0;
	258	devc->start_time = g_get_monotonic_time();
5e7a8e57	259
81a9ab72 AJ	260	/* Send header packet to the session bus. */
81a9ab72 AJ	261	std_session_send_df_header(cb_data, LOG_PREFIX);
5e7a8e57	262
81a9ab72	263	/* Poll every 50ms, or whenever some data comes in. */
102f1239 BV	264	serial_source_add(sdi->session, serial, G_IO_IN, 50,
102f1239 BV	265	appa_55ii_receive_data, (void *)sdi);
5e7a8e57 AJ	266
	267	return SR_OK;
	268	}
	269
81a9ab72 AJ	270	static int dev_acquisition_stop(struct sr_dev_inst sdi, void cb_data)
81a9ab72 AJ	271	{
76b4d4f4 UH	272	return std_serial_dev_acquisition_stop(sdi, cb_data,
76b4d4f4 UH	273	std_serial_dev_close, sdi->conn, LOG_PREFIX);
81a9ab72 AJ	274	}
81a9ab72 AJ	275
5e7a8e57 AJ	276	SR_PRIV struct sr_dev_driver appa_55ii_driver_info = {
	277	.name = "appa-55ii",
	278	.longname = "APPA 55II",
	279	.api_version = 1,
	280	.init = init,
	281	.cleanup = cleanup,
	282	.scan = scan,
	283	.dev_list = dev_list,
a6630742	284	.dev_clear = NULL,
5e7a8e57 AJ	285	.config_get = config_get,
	286	.config_set = config_set,
	287	.config_list = config_list,
81a9ab72 AJ	288	.dev_open = std_serial_dev_open,
81a9ab72 AJ	289	.dev_close = std_serial_dev_close,
5e7a8e57 AJ	290	.dev_acquisition_start = dev_acquisition_start,
5e7a8e57 AJ	291	.dev_acquisition_stop = dev_acquisition_stop,
76b4d4f4	292	.priv = NULL,
5e7a8e57	293	};