[libsigrok.git] / 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 int32_t hwopts[] = {
	SR_CONF_CONN,
	SR_CONF_SERIALCOMM,
};

static const int32_t hwcaps[] = {
	SR_CONF_THERMOMETER,
	SR_CONF_LIMIT_SAMPLES,
	SR_CONF_LIMIT_MSEC,
	SR_CONF_CONTINUOUS,
	SR_CONF_DATA_SOURCE,
};

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_probe *probe;
	GSList *devices = NULL, *l;
	const char *conn = NULL, *serialcomm = NULL;
	uint8_t buf[50];
	size_t len = sizeof(buf);

	for (l = options; l; l = l->next) {
		struct sr_config *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 | SERIAL_NONBLOCK) != 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);

	if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, "APPA", "55II", "")))
		goto scan_cleanup;

	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 (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "T1")))
		goto scan_cleanup;
	sdi->probes = g_slist_append(sdi->probes, probe);
	if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "T2")))
		goto scan_cleanup;
	sdi->probes = g_slist_append(sdi->probes, probe);

	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 dev_clear(void)
{
	return std_dev_clear(di, NULL);
}

static int cleanup(void)
{
	return dev_clear();
}

static int config_get(int key, GVariant **data, const struct sr_dev_inst *sdi,
                      const struct sr_probe_group *probe_group)
{
	struct dev_context *devc = sdi->priv;

	(void)probe_group;

	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(int key, GVariant *data, const struct sr_dev_inst *sdi,
		const struct sr_probe_group *probe_group)
{
	struct dev_context *devc;

	(void)probe_group;

	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: {
		const char *tmp_str = g_variant_get_string(data, NULL);
		unsigned int i;
		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(int key, GVariant **data, const struct sr_dev_inst *sdi,
		const struct sr_probe_group *probe_group)
{
	(void)sdi;
	(void)probe_group;

	switch (key) {
	case SR_CONF_SCAN_OPTIONS:
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
				hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
		break;
	case SR_CONF_DEVICE_OPTIONS:
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
				hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_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 = sdi->conn;
	struct dev_context *devc;

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