[libsigrok.git] / src / 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 uint32_t scanopts[] = {
	SR_CONF_CONN,
	SR_CONF_SERIALCOMM,
};

static const uint32_t devopts[] = {
	SR_CONF_SOUNDLEVELMETER,
	SR_CONF_CONTINUOUS,
	SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
	SR_CONF_LIMIT_MSEC | SR_CONF_SET,
};

SR_PRIV struct sr_dev_driver colead_slm_driver_info;
static struct sr_dev_driver *di = &colead_slm_driver_info;

static int init(struct sr_context *sr_ctx)
{
	return std_init(sr_ctx, di, LOG_PREFIX);
}

static GSList *scan(GSList *options)
{
	struct drv_context *drvc;
	struct dev_context *devc;
	struct sr_dev_inst *sdi;
	struct sr_config *src;
	struct sr_channel *ch;
	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 = g_variant_get_string(src->data, NULL);
			break;
		case SR_CONF_SERIALCOMM:
			serialcomm = g_variant_get_string(src->data, NULL);
			break;
		}
	}
	if (!conn)
		return NULL;
	if (!serialcomm)
		serialcomm = SERIALCOMM;

	sdi = sr_dev_inst_new();
	sdi->status = SR_ST_INACTIVE;
	sdi->vendor = g_strdup("Colead");
	sdi->model = g_strdup("SL-5868P");

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

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

	sdi->inst_type = SR_INST_SERIAL;
	sdi->priv = devc;
	sdi->driver = di;
	if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "P1")))
		return NULL;
	sdi->channels = g_slist_append(sdi->channels, ch);
	drvc->instances = g_slist_append(drvc->instances, sdi);
	devices = g_slist_append(devices, sdi);

	return devices;
}

static GSList *dev_list(void)
{
	return ((struct drv_context *)(di->priv))->instances;
}

static int dev_open(struct sr_dev_inst *sdi)
{
	struct sr_serial_dev_inst *serial;

	serial = sdi->conn;
	if (serial_open(serial, SERIAL_RDWR) != SR_OK)
		return SR_ERR;

	sdi->status = SR_ST_ACTIVE;

	return SR_OK;
}

static int cleanup(void)
{
	return std_dev_clear(di, NULL);
}

static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
		const struct sr_channel_group *cg)
{
	struct dev_context *devc;

	(void)cg;

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

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

	switch (key) {
	case SR_CONF_LIMIT_MSEC:
		/* TODO: not yet implemented */
		if (g_variant_get_uint64(data) == 0) {
			sr_err("LIMIT_MSEC can't be 0.");
			return SR_ERR;
		}
		devc->limit_msec = g_variant_get_uint64(data);;
		sr_dbg("Setting time limit to %" PRIu64 "ms.",
		       devc->limit_msec);
		break;
	case SR_CONF_LIMIT_SAMPLES:
		devc->limit_samples = g_variant_get_uint64(data);
		sr_dbg("Setting sample limit to %" PRIu64 ".",
		       devc->limit_samples);
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
		const struct sr_channel_group *cg)
{
	(void)sdi;
	(void)cg;

	switch (key) {
	case SR_CONF_SCAN_OPTIONS:
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
				scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
		break;
	case SR_CONF_DEVICE_OPTIONS:
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
				devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
{
	struct dev_context *devc;
	struct sr_serial_dev_inst *serial;

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

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

	devc->cb_data = cb_data;

	/* Send header packet to the session bus. */
	std_session_send_df_header(cb_data, LOG_PREFIX);

	/* Poll every 150ms, or whenever some data comes in. */
	serial = sdi->conn;
	serial_source_add(sdi->session, serial, G_IO_IN, 150,
			colead_slm_receive_data, (void *)sdi);

	return SR_OK;
}

static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
{
	return std_serial_dev_acquisition_stop(sdi, cb_data, std_serial_dev_close,
			sdi->conn, LOG_PREFIX);
}

SR_PRIV struct sr_dev_driver colead_slm_driver_info = {
	.name = "colead-slm",
	.longname = "Colead SLM",
	.api_version = 1,
	.init = init,
	.cleanup = cleanup,
	.scan = scan,
	.dev_list = dev_list,
	.dev_clear = NULL,
	.config_get = NULL,
	.config_set = config_set,
	.config_list = config_list,
	.dev_open = dev_open,
	.dev_close = std_serial_dev_close,
	.dev_acquisition_start = dev_acquisition_start,
	.dev_acquisition_stop = dev_acquisition_stop,
	.priv = NULL,
};
Commit	Line	Data
	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"
	24	#include <sys/types.h>
	25	#include <sys/stat.h>
	26	#include <fcntl.h>
	27	#include <errno.h>
	28	#include <string.h>
	29
	30	/* The Colead SL-5868P uses this. */
	31	#define SERIALCOMM "2400/8n1"
	32
	33	static const uint32_t scanopts[] = {
	34	SR_CONF_CONN,
	35	SR_CONF_SERIALCOMM,
	36	};
	37
	38	static const uint32_t devopts[] = {
	39	SR_CONF_SOUNDLEVELMETER,
	40	SR_CONF_CONTINUOUS,
	41	SR_CONF_LIMIT_SAMPLES \| SR_CONF_SET,
	42	SR_CONF_LIMIT_MSEC \| SR_CONF_SET,
	43	};
	44
	45	SR_PRIV struct sr_dev_driver colead_slm_driver_info;
	46	static struct sr_dev_driver *di = &colead_slm_driver_info;
	47
	48	static int init(struct sr_context *sr_ctx)
	49	{
	50	return std_init(sr_ctx, di, LOG_PREFIX);
	51	}
	52
	53	static GSList scan(GSList options)
	54	{
	55	struct drv_context *drvc;
	56	struct dev_context *devc;
	57	struct sr_dev_inst *sdi;
	58	struct sr_config *src;
	59	struct sr_channel *ch;
	60	GSList devices, l;
	61	const char conn, serialcomm;
	62
	63	drvc = di->priv;
	64	drvc->instances = NULL;
	65
	66	devices = NULL;
	67
	68	conn = serialcomm = NULL;
	69	for (l = options; l; l = l->next) {
	70	src = l->data;
	71	switch (src->key) {
	72	case SR_CONF_CONN:
	73	conn = g_variant_get_string(src->data, NULL);
	74	break;
	75	case SR_CONF_SERIALCOMM:
	76	serialcomm = g_variant_get_string(src->data, NULL);
	77	break;
	78	}
	79	}
	80	if (!conn)
	81	return NULL;
	82	if (!serialcomm)
	83	serialcomm = SERIALCOMM;
	84
	85	sdi = sr_dev_inst_new();
	86	sdi->status = SR_ST_INACTIVE;
	87	sdi->vendor = g_strdup("Colead");
	88	sdi->model = g_strdup("SL-5868P");
	89
	90	if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
	91	sr_dbg("Device context malloc failed.");
	92	return NULL;
	93	}
	94
	95	if (!(sdi->conn = sr_serial_dev_inst_new(conn, serialcomm)))
	96	return NULL;
	97
	98	sdi->inst_type = SR_INST_SERIAL;
	99	sdi->priv = devc;
	100	sdi->driver = di;
	101	if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "P1")))
	102	return NULL;
	103	sdi->channels = g_slist_append(sdi->channels, ch);
	104	drvc->instances = g_slist_append(drvc->instances, sdi);
	105	devices = g_slist_append(devices, sdi);
	106
	107	return devices;
	108	}
	109
	110	static GSList *dev_list(void)
	111	{
	112	return ((struct drv_context *)(di->priv))->instances;
	113	}
	114
	115	static int dev_open(struct sr_dev_inst *sdi)
	116	{
	117	struct sr_serial_dev_inst *serial;
	118
	119	serial = sdi->conn;
	120	if (serial_open(serial, SERIAL_RDWR) != SR_OK)
	121	return SR_ERR;
	122
	123	sdi->status = SR_ST_ACTIVE;
	124
	125	return SR_OK;
	126	}
	127
	128	static int cleanup(void)
	129	{
	130	return std_dev_clear(di, NULL);
	131	}
	132
	133	static int config_set(uint32_t key, GVariant data, const struct sr_dev_inst sdi,
	134	const struct sr_channel_group *cg)
	135	{
	136	struct dev_context *devc;
	137
	138	(void)cg;
	139
	140	if (sdi->status != SR_ST_ACTIVE)
	141	return SR_ERR_DEV_CLOSED;
	142
	143	if (!(devc = sdi->priv)) {
	144	sr_err("sdi->priv was NULL.");
	145	return SR_ERR_BUG;
	146	}
	147
	148	switch (key) {
	149	case SR_CONF_LIMIT_MSEC:
	150	/* TODO: not yet implemented */
	151	if (g_variant_get_uint64(data) == 0) {
	152	sr_err("LIMIT_MSEC can't be 0.");
	153	return SR_ERR;
	154	}
	155	devc->limit_msec = g_variant_get_uint64(data);;
	156	sr_dbg("Setting time limit to %" PRIu64 "ms.",
	157	devc->limit_msec);
	158	break;
	159	case SR_CONF_LIMIT_SAMPLES:
	160	devc->limit_samples = g_variant_get_uint64(data);
	161	sr_dbg("Setting sample limit to %" PRIu64 ".",
	162	devc->limit_samples);
	163	break;
	164	default:
	165	return SR_ERR_NA;
	166	}
	167
	168	return SR_OK;
	169	}
	170
	171	static int config_list(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
	172	const struct sr_channel_group *cg)
	173	{
	174	(void)sdi;
	175	(void)cg;
	176
	177	switch (key) {
	178	case SR_CONF_SCAN_OPTIONS:
	179	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
	180	scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
	181	break;
	182	case SR_CONF_DEVICE_OPTIONS:
	183	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
	184	devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
	185	break;
	186	default:
	187	return SR_ERR_NA;
	188	}
	189
	190	return SR_OK;
	191	}
	192
	193	static int dev_acquisition_start(const struct sr_dev_inst sdi, void cb_data)
	194	{
	195	struct dev_context *devc;
	196	struct sr_serial_dev_inst *serial;
	197
	198	if (sdi->status != SR_ST_ACTIVE)
	199	return SR_ERR_DEV_CLOSED;
	200
	201	if (!(devc = sdi->priv)) {
	202	sr_err("sdi->priv was NULL.");
	203	return SR_ERR_BUG;
	204	}
	205
	206	devc->cb_data = cb_data;
	207
	208	/* Send header packet to the session bus. */
	209	std_session_send_df_header(cb_data, LOG_PREFIX);
	210
	211	/* Poll every 150ms, or whenever some data comes in. */
	212	serial = sdi->conn;
	213	serial_source_add(sdi->session, serial, G_IO_IN, 150,
	214	colead_slm_receive_data, (void *)sdi);
	215
	216	return SR_OK;
	217	}
	218
	219	static int dev_acquisition_stop(struct sr_dev_inst sdi, void cb_data)
	220	{
	221	return std_serial_dev_acquisition_stop(sdi, cb_data, std_serial_dev_close,
	222	sdi->conn, LOG_PREFIX);
	223	}
	224
	225	SR_PRIV struct sr_dev_driver colead_slm_driver_info = {
	226	.name = "colead-slm",
	227	.longname = "Colead SLM",
	228	.api_version = 1,
	229	.init = init,
	230	.cleanup = cleanup,
	231	.scan = scan,
	232	.dev_list = dev_list,
	233	.dev_clear = NULL,
	234	.config_get = NULL,
	235	.config_set = config_set,
	236	.config_list = config_list,
	237	.dev_open = dev_open,
	238	.dev_close = std_serial_dev_close,
	239	.dev_acquisition_start = dev_acquisition_start,
	240	.dev_acquisition_stop = dev_acquisition_stop,
	241	.priv = NULL,
	242	};