[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 <config.h>
#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 int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
{
	return std_init(sr_ctx, di, LOG_PREFIX);
}

static GSList *scan(struct sr_dev_driver *di, GSList *options)
{
	struct drv_context *drvc;
	struct dev_context *devc;
	struct sr_serial_dev_inst *serial;
	struct sr_dev_inst *sdi;
	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";

	serial = sr_serial_dev_inst_new(conn, serialcomm);

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

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

	drvc = di->context;
	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;

	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "T1");
	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "T2");

	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(const struct sr_dev_driver *di)
{
	return ((struct drv_context *)(di->context))->instances;
}

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);
		break;
	case SR_CONF_LIMIT_MSEC:
		devc->limit_msec = g_variant_get_uint64(data);
		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)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)
{
	struct sr_serial_dev_inst *serial;
	struct dev_context *devc;

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

	devc = sdi->priv;

	/*
	 * 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();

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