[libsigrok.git] / hardware / tondaj-sl-814 / api.c

/*
 * This file is part of the sigrok project.
 *
 * Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
 *
 * 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 2 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, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 */

#include <fcntl.h>
#include <glib.h>
#include "libsigrok.h"
#include "libsigrok-internal.h"
#include "protocol.h"

#define SERIALCOMM "9600/8e1"

static const int hwopts[] = {
	SR_CONF_CONN,
	SR_CONF_SERIALCOMM,
	0,
};

static const int hwcaps[] = {
	SR_CONF_SOUNDLEVELMETER,
	SR_CONF_LIMIT_SAMPLES,
	SR_CONF_CONTINUOUS,
	0,
};

SR_PRIV struct sr_dev_driver tondaj_sl_814_driver_info;
static struct sr_dev_driver *di = &tondaj_sl_814_driver_info;

/* Properly close and free all devices. */
static int clear_instances(void)
{
	struct sr_dev_inst *sdi;
	struct drv_context *drvc;
	struct dev_context *devc;
	GSList *l;

	if (!(drvc = di->priv))
		return SR_OK;

	for (l = drvc->instances; l; l = l->next) {
		if (!(sdi = l->data))
			continue;
		if (!(devc = sdi->priv))
			continue;
		sr_serial_dev_inst_free(devc->serial);
		sr_dev_inst_free(sdi);
	}

	g_slist_free(drvc->instances);
	drvc->instances = NULL;

	return SR_OK;
}

static int hw_init(struct sr_context *sr_ctx)
{
	return std_hw_init(sr_ctx, di, DRIVER_LOG_DOMAIN);
}

static GSList *hw_scan(GSList *options)
{
	struct drv_context *drvc;
	struct dev_context *devc;
	struct sr_dev_inst *sdi;
	struct sr_config *src;
	struct sr_probe *probe;
	GSList *devices, *l;
	const char *conn, *serialcomm;

	drvc = di->priv;
	drvc->instances = NULL;

	devices = NULL;

	conn = serialcomm = NULL;
	for (l = options; l; l = l->next) {
		if (!(src = l->data)) {
			sr_err("Invalid option data, skipping.");
			continue;
		}
		switch (src->key) {
		case SR_CONF_CONN:
			conn = src->value;
			break;
		case SR_CONF_SERIALCOMM:
			serialcomm = src->value;
			break;
		default:
			sr_err("Unknown option %d, skipping.", src->key);
			break;
		}
	}
	if (!conn)
		return NULL;
	if (!serialcomm)
		serialcomm = SERIALCOMM;

	if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, "Tondaj",
				    "SL-814", NULL))) {
		sr_err("Failed to create device instance.");
		return NULL;
	}

	if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
		sr_err("Device context malloc failed.");
		return NULL;
	}

	if (!(devc->serial = sr_serial_dev_inst_new(conn, serialcomm)))
		return NULL;

	if (serial_open(devc->serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
		return NULL;

	sdi->priv = devc;
	sdi->driver = di;
	probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1");
	if (!probe) {
		sr_err("Failed to create probe.");
		return NULL;
	}
	sdi->probes = g_slist_append(sdi->probes, probe);
	drvc->instances = g_slist_append(drvc->instances, sdi);
	devices = g_slist_append(devices, sdi);

	return devices;
}

static GSList *hw_dev_list(void)
{
	struct drv_context *drvc;

	drvc = di->priv;

	return drvc->instances;
}

static int hw_dev_open(struct sr_dev_inst *sdi)
{
	struct dev_context *devc;

	devc = sdi->priv;

	if (serial_open(devc->serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
		return SR_ERR;

	sdi->status = SR_ST_ACTIVE;

	return SR_OK;
}

static int hw_dev_close(struct sr_dev_inst *sdi)
{
	struct dev_context *devc;

	devc = sdi->priv;

	if (devc->serial && devc->serial->fd != -1) {
		serial_close(devc->serial);
		sdi->status = SR_ST_INACTIVE;
	}

	return SR_OK;
}

static int hw_cleanup(void)
{
	clear_instances();

	return SR_OK;
}

static int config_set(int id, const void *value, const struct sr_dev_inst *sdi)
{
	struct dev_context *devc;

	if (sdi->status != SR_ST_ACTIVE) {
		sr_err("Device inactive, can't set config options.");
		return SR_ERR;
	}

	devc = sdi->priv;

	switch (id) {
	case SR_CONF_LIMIT_SAMPLES:
		devc->limit_samples = *(const uint64_t *)value;
		sr_dbg("Setting sample limit to %" PRIu64 ".",
		       devc->limit_samples);
		break;
	default:
		sr_err("Unknown hardware capability: %d.", id);
		return SR_ERR_ARG;
	}

	return SR_OK;
}

static int config_list(int key, const void **data, const struct sr_dev_inst *sdi)
{

	(void)sdi;

	switch (key) {
	case SR_CONF_SCAN_OPTIONS:
		*data = hwopts;
		break;
	case SR_CONF_DEVICE_OPTIONS:
		*data = hwcaps;
		break;
	default:
		return SR_ERR_ARG;
	}

	return SR_OK;
}

static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
				    void *cb_data)
{
	struct sr_datafeed_packet packet;
	struct sr_datafeed_header header;
	struct dev_context *devc;

	devc = sdi->priv;
	devc->cb_data = cb_data;

	/* Send header packet to the session bus. */
	sr_dbg("Sending SR_DF_HEADER.");
	packet.type = SR_DF_HEADER;
	packet.payload = (uint8_t *)&header;
	header.feed_version = 1;
	gettimeofday(&header.starttime, NULL);
	sr_session_send(devc->cb_data, &packet);

	/* Poll every 500ms, or whenever some data comes in. */
	sr_source_add(devc->serial->fd, G_IO_IN, 500,
		      tondaj_sl_814_receive_data, (void *)sdi);

	return SR_OK;
}

static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
{
	int ret, final_ret;
	struct sr_datafeed_packet packet;
	struct dev_context *devc;

	final_ret = SR_OK;

	if (sdi->status != SR_ST_ACTIVE) {
		sr_err("Device inactive, can't stop acquisition.");
		return SR_ERR;
	}

	devc = sdi->priv;

	if ((ret = sr_source_remove(devc->serial->fd)) < 0) {
		sr_err("Error removing source: %d.", ret);
		final_ret = SR_ERR;
	}
	
	if ((ret = hw_dev_close(sdi)) < 0) {
		sr_err("Error closing device: %d.", ret);
		final_ret = SR_ERR;
	}

	/* Send end packet to the session bus. */
	sr_dbg("Sending SR_DF_END.");
	packet.type = SR_DF_END;
	sr_session_send(cb_data, &packet);

	return final_ret;
}

SR_PRIV struct sr_dev_driver tondaj_sl_814_driver_info = {
	.name = "tondaj-sl-814",
	.longname = "Tondaj SL-814",
	.api_version = 1,
	.init = hw_init,
	.cleanup = hw_cleanup,
	.scan = hw_scan,
	.dev_list = hw_dev_list,
	.dev_clear = clear_instances,
	.config_set = config_set,
	.config_list = config_list,
	.dev_open = hw_dev_open,
	.dev_close = hw_dev_close,
	.dev_acquisition_start = hw_dev_acquisition_start,
	.dev_acquisition_stop = hw_dev_acquisition_stop,
	.priv = NULL,
};
Commit	Line	Data
aa2af324 UH	1	/*
	2	* This file is part of the sigrok project.
	3	*
	4	* Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
	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 2 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, write to the Free Software
	18	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
	19	*/
	20
c073af80	21	#include <fcntl.h>
aa2af324 UH	22	#include <glib.h>
	23	#include "libsigrok.h"
	24	#include "libsigrok-internal.h"
	25	#include "protocol.h"
	26
19ee7dff BV	27	#define SERIALCOMM "9600/8e1"
19ee7dff BV	28
c073af80	29	static const int hwopts[] = {
1953564a BV	30	SR_CONF_CONN,
1953564a BV	31	SR_CONF_SERIALCOMM,
c073af80 UH	32	0,
	33	};
	34
	35	static const int hwcaps[] = {
1953564a BV	36	SR_CONF_SOUNDLEVELMETER,
	37	SR_CONF_LIMIT_SAMPLES,
	38	SR_CONF_CONTINUOUS,
c073af80 UH	39	0,
	40	};
	41
aa2af324 UH	42	SR_PRIV struct sr_dev_driver tondaj_sl_814_driver_info;
	43	static struct sr_dev_driver *di = &tondaj_sl_814_driver_info;
	44
	45	/* Properly close and free all devices. */
	46	static int clear_instances(void)
	47	{
	48	struct sr_dev_inst *sdi;
	49	struct drv_context *drvc;
	50	struct dev_context *devc;
	51	GSList *l;
	52
	53	if (!(drvc = di->priv))
	54	return SR_OK;
	55
	56	for (l = drvc->instances; l; l = l->next) {
	57	if (!(sdi = l->data))
	58	continue;
	59	if (!(devc = sdi->priv))
	60	continue;
c073af80	61	sr_serial_dev_inst_free(devc->serial);
aa2af324 UH	62	sr_dev_inst_free(sdi);
	63	}
	64
	65	g_slist_free(drvc->instances);
	66	drvc->instances = NULL;
	67
	68	return SR_OK;
	69	}
	70
34f06b90	71	static int hw_init(struct sr_context *sr_ctx)
aa2af324	72	{
063e7aef	73	return std_hw_init(sr_ctx, di, DRIVER_LOG_DOMAIN);
aa2af324 UH	74	}
	75
	76	static GSList hw_scan(GSList options)
	77	{
	78	struct drv_context *drvc;
c073af80 UH	79	struct dev_context *devc;
c073af80 UH	80	struct sr_dev_inst *sdi;
1987b8d6	81	struct sr_config *src;
c073af80 UH	82	struct sr_probe *probe;
	83	GSList devices, l;
	84	const char conn, serialcomm;
aa2af324	85
aa2af324 UH	86	drvc = di->priv;
	87	drvc->instances = NULL;
	88
4b97c74e UH	89	devices = NULL;
4b97c74e UH	90
c073af80 UH	91	conn = serialcomm = NULL;
c073af80 UH	92	for (l = options; l; l = l->next) {
1987b8d6	93	if (!(src = l->data)) {
c073af80 UH	94	sr_err("Invalid option data, skipping.");
	95	continue;
	96	}
1987b8d6	97	switch (src->key) {
1953564a	98	case SR_CONF_CONN:
1987b8d6	99	conn = src->value;
c073af80	100	break;
1953564a	101	case SR_CONF_SERIALCOMM:
1987b8d6	102	serialcomm = src->value;
c073af80 UH	103	break;
c073af80 UH	104	default:
1987b8d6	105	sr_err("Unknown option %d, skipping.", src->key);
c073af80 UH	106	break;
	107	}
	108	}
80bc6632	109	if (!conn)
c073af80	110	return NULL;
19ee7dff BV	111	if (!serialcomm)
19ee7dff BV	112	serialcomm = SERIALCOMM;
c073af80 UH	113
	114	if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, "Tondaj",
	115	"SL-814", NULL))) {
	116	sr_err("Failed to create device instance.");
	117	return NULL;
	118	}
	119
	120	if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
	121	sr_err("Device context malloc failed.");
	122	return NULL;
	123	}
	124
19ee7dff BV	125	if (!(devc->serial = sr_serial_dev_inst_new(conn, serialcomm)))
19ee7dff BV	126	return NULL;
c073af80	127
a54dd31e	128	if (serial_open(devc->serial, SERIAL_RDWR \| SERIAL_NONBLOCK) != SR_OK)
c073af80	129	return NULL;
19ee7dff	130
c073af80 UH	131	sdi->priv = devc;
c073af80 UH	132	sdi->driver = di;
6b8d6f93	133	probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1");
c073af80 UH	134	if (!probe) {
	135	sr_err("Failed to create probe.");
	136	return NULL;
	137	}
	138	sdi->probes = g_slist_append(sdi->probes, probe);
	139	drvc->instances = g_slist_append(drvc->instances, sdi);
	140	devices = g_slist_append(devices, sdi);
aa2af324 UH	141
	142	return devices;
	143	}
	144
	145	static GSList *hw_dev_list(void)
	146	{
	147	struct drv_context *drvc;
	148
	149	drvc = di->priv;
	150
	151	return drvc->instances;
	152	}
	153
	154	static int hw_dev_open(struct sr_dev_inst *sdi)
	155	{
c073af80 UH	156	struct dev_context *devc;
	157
	158	devc = sdi->priv;
	159
a54dd31e	160	if (serial_open(devc->serial, SERIAL_RDWR \| SERIAL_NONBLOCK) != SR_OK)
c073af80	161	return SR_ERR;
c073af80 UH	162
c073af80 UH	163	sdi->status = SR_ST_ACTIVE;
aa2af324 UH	164
	165	return SR_OK;
	166	}
	167
	168	static int hw_dev_close(struct sr_dev_inst *sdi)
	169	{
c073af80 UH	170	struct dev_context *devc;
	171
	172	devc = sdi->priv;
	173
19ee7dff BV	174	if (devc->serial && devc->serial->fd != -1) {
	175	serial_close(devc->serial);
	176	sdi->status = SR_ST_INACTIVE;
c073af80 UH	177	}
c073af80 UH	178
aa2af324 UH	179	return SR_OK;
	180	}
	181
	182	static int hw_cleanup(void)
	183	{
	184	clear_instances();
	185
aa2af324 UH	186	return SR_OK;
	187	}
	188
035a1078	189	static int config_set(int id, const void value, const struct sr_dev_inst sdi)
aa2af324	190	{
c073af80	191	struct dev_context *devc;
aa2af324 UH	192
	193	if (sdi->status != SR_ST_ACTIVE) {
	194	sr_err("Device inactive, can't set config options.");
	195	return SR_ERR;
	196	}
	197
c073af80 UH	198	devc = sdi->priv;
c073af80 UH	199
035a1078	200	switch (id) {
1953564a	201	case SR_CONF_LIMIT_SAMPLES:
c073af80 UH	202	devc->limit_samples = (const uint64_t )value;
	203	sr_dbg("Setting sample limit to %" PRIu64 ".",
	204	devc->limit_samples);
	205	break;
aa2af324	206	default:
035a1078	207	sr_err("Unknown hardware capability: %d.", id);
c073af80	208	return SR_ERR_ARG;
aa2af324 UH	209	}
aa2af324 UH	210
c073af80	211	return SR_OK;
aa2af324 UH	212	}
aa2af324 UH	213
a1c743fc BV	214	static int config_list(int key, const void *data, const struct sr_dev_inst sdi)
	215	{
	216
	217	(void)sdi;
	218
	219	switch (key) {
0d485e30 BV	220	case SR_CONF_SCAN_OPTIONS:
	221	*data = hwopts;
	222	break;
9a6517d1 BV	223	case SR_CONF_DEVICE_OPTIONS:
	224	*data = hwcaps;
	225	break;
a1c743fc BV	226	default:
	227	return SR_ERR_ARG;
	228	}
	229
	230	return SR_OK;
	231	}
	232
aa2af324 UH	233	static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
	234	void *cb_data)
	235	{
c073af80 UH	236	struct sr_datafeed_packet packet;
c073af80 UH	237	struct sr_datafeed_header header;
c073af80 UH	238	struct dev_context *devc;
	239
	240	devc = sdi->priv;
	241	devc->cb_data = cb_data;
	242
	243	/* Send header packet to the session bus. */
	244	sr_dbg("Sending SR_DF_HEADER.");
	245	packet.type = SR_DF_HEADER;
	246	packet.payload = (uint8_t *)&header;
	247	header.feed_version = 1;
	248	gettimeofday(&header.starttime, NULL);
	249	sr_session_send(devc->cb_data, &packet);
	250
c073af80 UH	251	/* Poll every 500ms, or whenever some data comes in. */
	252	sr_source_add(devc->serial->fd, G_IO_IN, 500,
	253	tondaj_sl_814_receive_data, (void *)sdi);
aa2af324 UH	254
	255	return SR_OK;
	256	}
	257
c073af80	258	static int hw_dev_acquisition_stop(struct sr_dev_inst sdi, void cb_data)
aa2af324	259	{
c073af80 UH	260	int ret, final_ret;
	261	struct sr_datafeed_packet packet;
	262	struct dev_context *devc;
	263
	264	final_ret = SR_OK;
aa2af324 UH	265
	266	if (sdi->status != SR_ST_ACTIVE) {
	267	sr_err("Device inactive, can't stop acquisition.");
	268	return SR_ERR;
	269	}
	270
c073af80	271	devc = sdi->priv;
aa2af324	272
c073af80 UH	273	if ((ret = sr_source_remove(devc->serial->fd)) < 0) {
	274	sr_err("Error removing source: %d.", ret);
	275	final_ret = SR_ERR;
	276	}
	277
	278	if ((ret = hw_dev_close(sdi)) < 0) {
	279	sr_err("Error closing device: %d.", ret);
	280	final_ret = SR_ERR;
	281	}
	282
	283	/* Send end packet to the session bus. */
	284	sr_dbg("Sending SR_DF_END.");
	285	packet.type = SR_DF_END;
	286	sr_session_send(cb_data, &packet);
	287
	288	return final_ret;
aa2af324 UH	289	}
	290
	291	SR_PRIV struct sr_dev_driver tondaj_sl_814_driver_info = {
	292	.name = "tondaj-sl-814",
	293	.longname = "Tondaj SL-814",
	294	.api_version = 1,
	295	.init = hw_init,
	296	.cleanup = hw_cleanup,
	297	.scan = hw_scan,
	298	.dev_list = hw_dev_list,
	299	.dev_clear = clear_instances,
035a1078	300	.config_set = config_set,
a1c743fc	301	.config_list = config_list,
aa2af324 UH	302	.dev_open = hw_dev_open,
aa2af324 UH	303	.dev_close = hw_dev_close,
aa2af324 UH	304	.dev_acquisition_start = hw_dev_acquisition_start,
	305	.dev_acquisition_stop = hw_dev_acquisition_stop,
	306	.priv = NULL,
	307	};