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

	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;

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

	devices = g_slist_append(devices, sdi);

scan_cleanup:
	serial_close(serial);

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