[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_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",
};

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;
	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 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:
	case SR_CONF_LIMIT_MSEC:
		return sr_sw_limits_config_get(&devc->limits, key, data);
	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;

	devc = sdi->priv;

	switch (key) {
	case SR_CONF_LIMIT_SAMPLES:
		return sr_sw_limits_config_set(&devc->limits, key, data);
	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;

	sr_sw_limits_acquisition_start(&devc->limits);

	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);
}

static struct sr_dev_driver appa_55ii_driver_info = {
	.name = "appa-55ii",
	.longname = "APPA 55II",
	.api_version = 1,
	.init = std_init,
	.cleanup = std_cleanup,
	.scan = scan,
	.dev_list = std_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,
};
SR_REGISTER_DEV_DRIVER(appa_55ii_driver_info);
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,
	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	static GSList scan(struct sr_dev_driver di, GSList *options)
	46	{
	47	struct drv_context *drvc;
	48	struct dev_context *devc;
	49	struct sr_serial_dev_inst *serial;
	50	struct sr_dev_inst *sdi;
	51	struct sr_config *src;
	52	GSList devices, l;
	53	const char conn, serialcomm;
	54	uint8_t buf[50];
	55	size_t len;
	56
	57	len = sizeof(buf);
	58	devices = NULL;
	59	conn = serialcomm = NULL;
	60	for (l = options; l; l = l->next) {
	61	src = l->data;
	62	switch (src->key) {
	63	case SR_CONF_CONN:
	64	conn = g_variant_get_string(src->data, NULL);
	65	break;
	66	case SR_CONF_SERIALCOMM:
	67	serialcomm = g_variant_get_string(src->data, NULL);
	68	break;
	69	}
	70	}
	71	if (!conn)
	72	return NULL;
	73	if (!serialcomm)
	74	serialcomm = "9600/8n1";
	75
	76	serial = sr_serial_dev_inst_new(conn, serialcomm);
	77
	78	if (serial_open(serial, SERIAL_RDONLY) != SR_OK)
	79	return NULL;
	80
	81	sr_info("Probing serial port %s.", conn);
	82
	83	drvc = di->context;
	84	serial_flush(serial);
	85
	86	/* Let's get a bit of data and see if we can find a packet. */
	87	if (serial_stream_detect(serial, buf, &len, 25,
	88	appa_55ii_packet_valid, 500, 9600) != SR_OK)
	89	goto scan_cleanup;
	90
	91	sr_info("Found device on port %s.", conn);
	92
	93	sdi = g_malloc0(sizeof(struct sr_dev_inst));
	94	sdi->status = SR_ST_INACTIVE;
	95	sdi->vendor = g_strdup("APPA");
	96	sdi->model = g_strdup("55II");
	97	devc = g_malloc0(sizeof(struct dev_context));
	98	devc->data_source = DEFAULT_DATA_SOURCE;
	99	sdi->inst_type = SR_INST_SERIAL;
	100	sdi->conn = serial;
	101	sdi->priv = devc;
	102	sdi->driver = di;
	103
	104	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "T1");
	105	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "T2");
	106
	107	drvc->instances = g_slist_append(drvc->instances, sdi);
	108	devices = g_slist_append(devices, sdi);
	109
	110	scan_cleanup:
	111	serial_close(serial);
	112
	113	return devices;
	114	}
	115
	116	static int config_get(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
	117	const struct sr_channel_group *cg)
	118	{
	119	struct dev_context *devc = sdi->priv;
	120
	121	(void)cg;
	122
	123	switch (key) {
	124	case SR_CONF_LIMIT_SAMPLES:
	125	case SR_CONF_LIMIT_MSEC:
	126	return sr_sw_limits_config_get(&devc->limits, key, data);
	127	case SR_CONF_DATA_SOURCE:
	128	*data = g_variant_new_string(data_sources[devc->data_source]);
	129	break;
	130	default:
	131	return SR_ERR_NA;
	132	}
	133
	134	return SR_OK;
	135	}
	136
	137	static int config_set(uint32_t key, GVariant data, const struct sr_dev_inst sdi,
	138	const struct sr_channel_group *cg)
	139	{
	140	struct dev_context *devc;
	141	const char *tmp_str;
	142	unsigned int i;
	143
	144	(void)cg;
	145
	146	if (sdi->status != SR_ST_ACTIVE)
	147	return SR_ERR_DEV_CLOSED;
	148
	149	devc = sdi->priv;
	150
	151	switch (key) {
	152	case SR_CONF_LIMIT_SAMPLES:
	153	return sr_sw_limits_config_set(&devc->limits, key, data);
	154	case SR_CONF_DATA_SOURCE: {
	155	tmp_str = g_variant_get_string(data, NULL);
	156	for (i = 0; i < ARRAY_SIZE(data_sources); i++)
	157	if (!strcmp(tmp_str, data_sources[i])) {
	158	devc->data_source = i;
	159	break;
	160	}
	161	if (i == ARRAY_SIZE(data_sources))
	162	return SR_ERR;
	163	break;
	164	}
	165	default:
	166	return SR_ERR_NA;
	167	}
	168
	169	return SR_OK;
	170	}
	171
	172	static int config_list(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
	173	const struct sr_channel_group *cg)
	174	{
	175	(void)cg;
	176
	177	switch (key) {
	178	case SR_CONF_SCAN_OPTIONS:
	179	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
	180	scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
	181	break;
	182	case SR_CONF_DEVICE_OPTIONS:
	183	if (!sdi)
	184	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
	185	drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
	186	else
	187	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
	188	devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
	189	break;
	190	case SR_CONF_DATA_SOURCE:
	191	*data = g_variant_new_strv(data_sources, ARRAY_SIZE(data_sources));
	192	break;
	193	default:
	194	return SR_ERR_NA;
	195	}
	196
	197	return SR_OK;
	198	}
	199
	200	static int dev_acquisition_start(const struct sr_dev_inst *sdi)
	201	{
	202	struct sr_serial_dev_inst *serial;
	203	struct dev_context *devc;
	204
	205	serial = sdi->conn;
	206	if (sdi->status != SR_ST_ACTIVE)
	207	return SR_ERR_DEV_CLOSED;
	208
	209	devc = sdi->priv;
	210
	211	sr_sw_limits_acquisition_start(&devc->limits);
	212
	213	std_session_send_df_header(sdi, LOG_PREFIX);
	214
	215	/* Poll every 50ms, or whenever some data comes in. */
	216	serial_source_add(sdi->session, serial, G_IO_IN, 50,
	217	appa_55ii_receive_data, (void *)sdi);
	218
	219	return SR_OK;
	220	}
	221
	222	static int dev_acquisition_stop(struct sr_dev_inst *sdi)
	223	{
	224	return std_serial_dev_acquisition_stop(sdi,
	225	std_serial_dev_close, sdi->conn, LOG_PREFIX);
	226	}
	227
	228	static struct sr_dev_driver appa_55ii_driver_info = {
	229	.name = "appa-55ii",
	230	.longname = "APPA 55II",
	231	.api_version = 1,
	232	.init = std_init,
	233	.cleanup = std_cleanup,
	234	.scan = scan,
	235	.dev_list = std_dev_list,
	236	.dev_clear = NULL,
	237	.config_get = config_get,
	238	.config_set = config_set,
	239	.config_list = config_list,
	240	.dev_open = std_serial_dev_open,
	241	.dev_close = std_serial_dev_close,
	242	.dev_acquisition_start = dev_acquisition_start,
	243	.dev_acquisition_stop = dev_acquisition_stop,
	244	.context = NULL,
	245	};
	246	SR_REGISTER_DEV_DRIVER(appa_55ii_driver_info);