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

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