[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_HWOPT_CONN,
	SR_HWOPT_SERIALCOMM,
	0,
};

static const int hwcaps[] = {
	SR_HWCAP_SOUNDLEVELMETER,
	SR_HWCAP_LIMIT_SAMPLES,
	SR_HWCAP_CONTINUOUS,
	0,
};

static const char *probe_names[] = {
	"P1",
	NULL,
};

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)
{
	struct drv_context *drvc;

	if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
		sr_err("Driver context malloc failed.");
		return SR_ERR_MALLOC;
	}

	drvc->sr_ctx = sr_ctx;
	di->priv = drvc;

	return SR_OK;
}

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

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

	conn = serialcomm = NULL;
	for (l = options; l; l = l->next) {
		if (!(opt = l->data)) {
			sr_err("Invalid option data, skipping.");
			continue;
		}
		switch (opt->hwopt) {
		case SR_HWOPT_CONN:
			conn = opt->value;
			break;
		case SR_HWOPT_SERIALCOMM:
			serialcomm = opt->value;
			break;
		default:
			sr_err("Unknown option %d, skipping.", opt->hwopt);
			break;
		}
	}
	if (!conn) {
		sr_dbg("Couldn't determine connection options.");
		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, probe_names[0]);
	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 hw_info_get(int info_id, const void **data,
		       const struct sr_dev_inst *sdi)
{
	(void)sdi;

	switch (info_id) {
	case SR_DI_HWOPTS:
		*data = hwopts;
		break;
	case SR_DI_HWCAPS:
		*data = hwcaps;
		break;
	case SR_DI_NUM_PROBES:
		*data = GINT_TO_POINTER(1);
		break;
	case SR_DI_PROBE_NAMES:
		*data = probe_names;
		break;
	default:
		sr_err("Unknown info_id: %d.", info_id);
		return SR_ERR_ARG;
	}

	return SR_OK;
}

static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
			     const void *value)
{
	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 (hwcap) {
	case SR_HWCAP_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.", hwcap);
		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 sr_datafeed_meta_analog meta;
	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);

	/* Send metadata about the SR_DF_ANALOG packets to come. */
	sr_dbg("Sending SR_DF_META_ANALOG.");
	packet.type = SR_DF_META_ANALOG;
	packet.payload = &meta;
	meta.num_probes = 1;
	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,
	.dev_open = hw_dev_open,
	.dev_close = hw_dev_close,
	.info_get = hw_info_get,
	.dev_config_set = hw_dev_config_set,
	.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 UH	29	static const int hwopts[] = {
	30	SR_HWOPT_CONN,
	31	SR_HWOPT_SERIALCOMM,
	32	0,
	33	};
	34
	35	static const int hwcaps[] = {
	36	SR_HWCAP_SOUNDLEVELMETER,
	37	SR_HWCAP_LIMIT_SAMPLES,
	38	SR_HWCAP_CONTINUOUS,
	39	0,
	40	};
	41
	42	static const char *probe_names[] = {
	43	"P1",
	44	NULL,
	45	};
	46
aa2af324 UH	47	SR_PRIV struct sr_dev_driver tondaj_sl_814_driver_info;
	48	static struct sr_dev_driver *di = &tondaj_sl_814_driver_info;
	49
	50	/* Properly close and free all devices. */
	51	static int clear_instances(void)
	52	{
	53	struct sr_dev_inst *sdi;
	54	struct drv_context *drvc;
	55	struct dev_context *devc;
	56	GSList *l;
	57
	58	if (!(drvc = di->priv))
	59	return SR_OK;
	60
	61	for (l = drvc->instances; l; l = l->next) {
	62	if (!(sdi = l->data))
	63	continue;
	64	if (!(devc = sdi->priv))
	65	continue;
c073af80	66	sr_serial_dev_inst_free(devc->serial);
aa2af324 UH	67	sr_dev_inst_free(sdi);
	68	}
	69
	70	g_slist_free(drvc->instances);
	71	drvc->instances = NULL;
	72
	73	return SR_OK;
	74	}
	75
34f06b90	76	static int hw_init(struct sr_context *sr_ctx)
aa2af324 UH	77	{
	78	struct drv_context *drvc;
	79
	80	if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
	81	sr_err("Driver context malloc failed.");
	82	return SR_ERR_MALLOC;
	83	}
	84
1ebe4b4e	85	drvc->sr_ctx = sr_ctx;
aa2af324 UH	86	di->priv = drvc;
	87
	88	return SR_OK;
	89	}
	90
	91	static GSList hw_scan(GSList options)
	92	{
	93	struct drv_context *drvc;
c073af80 UH	94	struct dev_context *devc;
	95	struct sr_dev_inst *sdi;
	96	struct sr_hwopt *opt;
	97	struct sr_probe *probe;
	98	GSList devices, l;
	99	const char conn, serialcomm;
aa2af324 UH	100
	101	devices = NULL;
	102	drvc = di->priv;
	103	drvc->instances = NULL;
	104
c073af80 UH	105	conn = serialcomm = NULL;
	106	for (l = options; l; l = l->next) {
	107	if (!(opt = l->data)) {
	108	sr_err("Invalid option data, skipping.");
	109	continue;
	110	}
	111	switch (opt->hwopt) {
	112	case SR_HWOPT_CONN:
	113	conn = opt->value;
	114	break;
	115	case SR_HWOPT_SERIALCOMM:
	116	serialcomm = opt->value;
	117	break;
	118	default:
	119	sr_err("Unknown option %d, skipping.", opt->hwopt);
	120	break;
	121	}
	122	}
	123	if (!conn) {
	124	sr_dbg("Couldn't determine connection options.");
	125	return NULL;
	126	}
19ee7dff BV	127	if (!serialcomm)
19ee7dff BV	128	serialcomm = SERIALCOMM;
c073af80 UH	129
	130	if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, "Tondaj",
	131	"SL-814", NULL))) {
	132	sr_err("Failed to create device instance.");
	133	return NULL;
	134	}
	135
	136	if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
	137	sr_err("Device context malloc failed.");
	138	return NULL;
	139	}
	140
19ee7dff BV	141	if (!(devc->serial = sr_serial_dev_inst_new(conn, serialcomm)))
19ee7dff BV	142	return NULL;
c073af80	143
a54dd31e	144	if (serial_open(devc->serial, SERIAL_RDWR \| SERIAL_NONBLOCK) != SR_OK)
c073af80	145	return NULL;
19ee7dff	146
c073af80 UH	147	sdi->priv = devc;
	148	sdi->driver = di;
	149	probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, probe_names[0]);
	150	if (!probe) {
	151	sr_err("Failed to create probe.");
	152	return NULL;
	153	}
	154	sdi->probes = g_slist_append(sdi->probes, probe);
	155	drvc->instances = g_slist_append(drvc->instances, sdi);
	156	devices = g_slist_append(devices, sdi);
aa2af324 UH	157
	158	return devices;
	159	}
	160
	161	static GSList *hw_dev_list(void)
	162	{
	163	struct drv_context *drvc;
	164
	165	drvc = di->priv;
	166
	167	return drvc->instances;
	168	}
	169
	170	static int hw_dev_open(struct sr_dev_inst *sdi)
	171	{
c073af80 UH	172	struct dev_context *devc;
	173
	174	devc = sdi->priv;
	175
a54dd31e	176	if (serial_open(devc->serial, SERIAL_RDWR \| SERIAL_NONBLOCK) != SR_OK)
c073af80	177	return SR_ERR;
c073af80 UH	178
c073af80 UH	179	sdi->status = SR_ST_ACTIVE;
aa2af324 UH	180
	181	return SR_OK;
	182	}
	183
	184	static int hw_dev_close(struct sr_dev_inst *sdi)
	185	{
c073af80 UH	186	struct dev_context *devc;
	187
	188	devc = sdi->priv;
	189
19ee7dff BV	190	if (devc->serial && devc->serial->fd != -1) {
	191	serial_close(devc->serial);
	192	sdi->status = SR_ST_INACTIVE;
c073af80 UH	193	}
c073af80 UH	194
aa2af324 UH	195	return SR_OK;
	196	}
	197
	198	static int hw_cleanup(void)
	199	{
	200	clear_instances();
	201
aa2af324 UH	202	return SR_OK;
	203	}
	204
	205	static int hw_info_get(int info_id, const void **data,
	206	const struct sr_dev_inst *sdi)
	207	{
c073af80 UH	208	(void)sdi;
c073af80 UH	209
aa2af324	210	switch (info_id) {
c073af80 UH	211	case SR_DI_HWOPTS:
	212	*data = hwopts;
	213	break;
	214	case SR_DI_HWCAPS:
	215	*data = hwcaps;
	216	break;
	217	case SR_DI_NUM_PROBES:
	218	*data = GINT_TO_POINTER(1);
	219	break;
	220	case SR_DI_PROBE_NAMES:
	221	*data = probe_names;
	222	break;
aa2af324 UH	223	default:
	224	sr_err("Unknown info_id: %d.", info_id);
	225	return SR_ERR_ARG;
	226	}
	227
	228	return SR_OK;
	229	}
	230
	231	static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
	232	const void *value)
	233	{
c073af80	234	struct dev_context *devc;
aa2af324 UH	235
	236	if (sdi->status != SR_ST_ACTIVE) {
	237	sr_err("Device inactive, can't set config options.");
	238	return SR_ERR;
	239	}
	240
c073af80 UH	241	devc = sdi->priv;
c073af80 UH	242
aa2af324	243	switch (hwcap) {
c073af80 UH	244	case SR_HWCAP_LIMIT_SAMPLES:
	245	devc->limit_samples = (const uint64_t )value;
	246	sr_dbg("Setting sample limit to %" PRIu64 ".",
	247	devc->limit_samples);
	248	break;
aa2af324 UH	249	default:
aa2af324 UH	250	sr_err("Unknown hardware capability: %d.", hwcap);
c073af80	251	return SR_ERR_ARG;
aa2af324 UH	252	}
aa2af324 UH	253
c073af80	254	return SR_OK;
aa2af324 UH	255	}
	256
	257	static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
	258	void *cb_data)
	259	{
c073af80 UH	260	struct sr_datafeed_packet packet;
	261	struct sr_datafeed_header header;
	262	struct sr_datafeed_meta_analog meta;
	263	struct dev_context *devc;
	264
	265	devc = sdi->priv;
	266	devc->cb_data = cb_data;
	267
	268	/* Send header packet to the session bus. */
	269	sr_dbg("Sending SR_DF_HEADER.");
	270	packet.type = SR_DF_HEADER;
	271	packet.payload = (uint8_t *)&header;
	272	header.feed_version = 1;
	273	gettimeofday(&header.starttime, NULL);
	274	sr_session_send(devc->cb_data, &packet);
	275
	276	/* Send metadata about the SR_DF_ANALOG packets to come. */
	277	sr_dbg("Sending SR_DF_META_ANALOG.");
	278	packet.type = SR_DF_META_ANALOG;
	279	packet.payload = &meta;
	280	meta.num_probes = 1;
	281	sr_session_send(devc->cb_data, &packet);
	282
	283	/* Poll every 500ms, or whenever some data comes in. */
	284	sr_source_add(devc->serial->fd, G_IO_IN, 500,
	285	tondaj_sl_814_receive_data, (void *)sdi);
aa2af324 UH	286
	287	return SR_OK;
	288	}
	289
c073af80	290	static int hw_dev_acquisition_stop(struct sr_dev_inst sdi, void cb_data)
aa2af324	291	{
c073af80 UH	292	int ret, final_ret;
	293	struct sr_datafeed_packet packet;
	294	struct dev_context *devc;
	295
	296	final_ret = SR_OK;
aa2af324 UH	297
	298	if (sdi->status != SR_ST_ACTIVE) {
	299	sr_err("Device inactive, can't stop acquisition.");
	300	return SR_ERR;
	301	}
	302
c073af80	303	devc = sdi->priv;
aa2af324	304
c073af80 UH	305	if ((ret = sr_source_remove(devc->serial->fd)) < 0) {
	306	sr_err("Error removing source: %d.", ret);
	307	final_ret = SR_ERR;
	308	}
	309
	310	if ((ret = hw_dev_close(sdi)) < 0) {
	311	sr_err("Error closing device: %d.", ret);
	312	final_ret = SR_ERR;
	313	}
	314
	315	/* Send end packet to the session bus. */
	316	sr_dbg("Sending SR_DF_END.");
	317	packet.type = SR_DF_END;
	318	sr_session_send(cb_data, &packet);
	319
	320	return final_ret;
aa2af324 UH	321	}
	322
	323	SR_PRIV struct sr_dev_driver tondaj_sl_814_driver_info = {
	324	.name = "tondaj-sl-814",
	325	.longname = "Tondaj SL-814",
	326	.api_version = 1,
	327	.init = hw_init,
	328	.cleanup = hw_cleanup,
	329	.scan = hw_scan,
	330	.dev_list = hw_dev_list,
	331	.dev_clear = clear_instances,
	332	.dev_open = hw_dev_open,
	333	.dev_close = hw_dev_close,
	334	.info_get = hw_info_get,
	335	.dev_config_set = hw_dev_config_set,
	336	.dev_acquisition_start = hw_dev_acquisition_start,
	337	.dev_acquisition_stop = hw_dev_acquisition_stop,
	338	.priv = NULL,
	339	};