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

static const int hwcaps[] = {
	SR_HWCAP_SOUNDLEVELMETER,
	SR_HWCAP_LIMIT_SAMPLES,
	SR_HWCAP_LIMIT_MSEC,
	SR_HWCAP_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)
{
	struct drv_context *drvc;

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

	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) {
		opt = l->data;
		switch (opt->hwopt) {
		case SR_HWOPT_CONN:
			conn = opt->value;
			break;
		case SR_HWOPT_SERIALCOMM:
			serialcomm = opt->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("failed to malloc devc");
		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 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:
		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)
		return SR_ERR;

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

	switch (hwcap) {
	case SR_HWCAP_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_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 capability: %d.", hwcap);
		return SR_ERR;
		break;
	}

	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;

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

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