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

SR_PRIV struct sr_dev_driver appa_55ii_driver_info;

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

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