[libsigrok.git] / hardware / colead-slm / api.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
 *
 * 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 <glib.h>
#include "libsigrok.h"
#include "libsigrok-internal.h"
#include "protocol.h"
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <errno.h>
#include <string.h>

/* The Colead SL-5868P uses this. */
#define SERIALCOMM "2400/8n1"

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

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

SR_PRIV struct sr_dev_driver colead_slm_driver_info;
static struct sr_dev_driver *di = &colead_slm_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) {
		src = l->data;
		switch (src->key) {
		case SR_CONF_CONN:
			conn = src->value;
			break;
		case SR_CONF_SERIALCOMM:
			serialcomm = src->value;
			break;
		}
	}
	if (!conn)
		return NULL;
	if (!serialcomm)
		serialcomm = SERIALCOMM;

	if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, "Colead",
			"SL-5868P", NULL)))
		return NULL;

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

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

	sdi->priv = devc;
	sdi->driver = di;
	if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
		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;

	if (!(devc = sdi->priv)) {
		sr_err("sdi->priv was NULL.");
		return SR_ERR_BUG;
	}

	if (serial_open(devc->serial, SERIAL_RDWR) != 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;

	if (!(devc = sdi->priv)) {
		sr_err("sdi->priv was NULL.");
		return SR_ERR_BUG;
	}

	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)
		return SR_ERR;

	if (!(devc = sdi->priv)) {
		sr_err("sdi->priv was NULL.");
		return SR_ERR_BUG;
	}

	switch (id) {
	case SR_CONF_LIMIT_MSEC:
		/* TODO: not yet implemented */
		if (*(const uint64_t *)value == 0) {
			sr_err("LIMIT_MSEC can't be 0.");
			return SR_ERR;
		}
		devc->limit_msec = *(const uint64_t *)value;
		sr_dbg("Setting time limit to %" PRIu64 "ms.",
		       devc->limit_msec);
		break;
	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 capability: %d.", id);
		return SR_ERR;
		break;
	}

	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;

	if (!(devc = sdi->priv)) {
		sr_err("sdi->priv was NULL.");
		return SR_ERR_BUG;
	}

	sr_dbg("Starting acquisition.");

	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 150ms, or whenever some data comes in. */
	sr_source_add(devc->serial->fd, G_IO_IN, 150, colead_slm_receive_data,
			(void *)sdi);

	return SR_OK;
}

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

	if (sdi->status != SR_ST_ACTIVE)
		return SR_ERR;

	if (!(devc = sdi->priv)) {
		sr_err("sdi->priv was NULL.");
		return SR_ERR_BUG;
	}

	sr_dbg("Stopping acquisition.");

	sr_source_remove(devc->serial->fd);
	hw_dev_close((struct sr_dev_inst *)sdi);

	/* 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 SR_OK;
}

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