[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>

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

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

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

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

	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 (!(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 (!serialcomm)
		/* The Colead SL-5868P uses this. */
		serialcomm = "2400/8n1";

	devc->serial = sr_serial_dev_inst_new(conn, -1);
	devc->serialcomm = g_strdup(serialcomm);
	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;
	}

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