[libsigrok.git] / hardware / cem-dt-885x / api.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2013 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 "protocol.h"

#define SERIALCOMM "9600/8n1"
/* 23ms is the longest interval between tokens. */
#define MAX_SCAN_TIME 25 * 1000

static const int32_t hwopts[] = {
	SR_CONF_CONN,
};

static const int32_t hwcaps[] = {
	SR_CONF_SOUNDLEVELMETER,
	SR_CONF_LIMIT_SAMPLES,
	SR_CONF_CONTINUOUS,
};


SR_PRIV struct sr_dev_driver cem_dt_885x_driver_info;
static struct sr_dev_driver *di = &cem_dt_885x_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_config *src;
	struct sr_serial_dev_inst *serial;
	struct sr_dev_inst *sdi;
	struct sr_probe *probe;
	GSList *l, *devices;
	gint64 start;
	const char *conn;
	unsigned char c;

	conn = NULL;
	for (l = options; l; l = l->next) {
		src = l->data;
		if (src->key == SR_CONF_CONN)
			conn = g_variant_get_string(src->data, NULL);
	}
	if (!conn)
		return NULL;

	if (!(serial = sr_serial_dev_inst_new(conn, SERIALCOMM)))
		return NULL;

	if (serial_open(serial, SERIAL_RDONLY | SERIAL_NONBLOCK) != SR_OK)
		return NULL;

	devices = NULL;
	drvc = di->priv;
	start = g_get_monotonic_time();
	while (g_get_monotonic_time() - start < MAX_SCAN_TIME) {
		if (serial_read(serial, &c, 1) == 1 && c == 0xa5) {
			/* Found one. */
			if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, "CEM",
					"DT-885x", NULL)))
				return NULL;

			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 (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "SPL")))
				return NULL;
			sdi->probes = g_slist_append(sdi->probes, probe);
			drvc->instances = g_slist_append(drvc->instances, sdi);
			devices = g_slist_append(devices, sdi);
			break;
		}
		/* It takes about 1ms for a byte to come in. */
		g_usleep(1000);
	}

	serial_close(serial);

	return devices;
}

static GSList *dev_list(void)
{
	struct drv_context *drvc;

	drvc = di->priv;

	return drvc->instances;
}

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

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 dev_close(struct sr_dev_inst *sdi)
{
	struct sr_serial_dev_inst *serial;

	serial = sdi->conn;
	if (serial && serial->fd != -1) {
		serial_close(serial);
		sdi->status = SR_ST_INACTIVE;
	}

	return SR_OK;
}

static int cleanup(void)
{
	return dev_clear();
}

static int config_get(int key, GVariant **data, const struct sr_dev_inst *sdi)
{
	struct dev_context *devc;

	if (!sdi)
		return SR_ERR_ARG;

	devc = sdi->priv;
	switch (key) {
	case SR_CONF_LIMIT_SAMPLES:
		*data = g_variant_new_uint64(devc->limit_samples);
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi)
{
	struct dev_context *devc;
	uint64_t tmp_u64;
	int ret;

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

	ret = SR_OK;
	switch (key) {
	case SR_CONF_LIMIT_SAMPLES:
		tmp_u64 = g_variant_get_uint64(data);
		devc->limit_samples = tmp_u64;
		ret = SR_OK;
		break;
	default:
		ret = SR_ERR_NA;
	}

	return ret;
}

static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
{
	int ret;

	(void)sdi;

	ret = SR_OK;
	switch (key) {
	case SR_CONF_SCAN_OPTIONS:
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
				hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
		break;
	case SR_CONF_DEVICE_OPTIONS:
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
				hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
		break;
	default:
		return SR_ERR_NA;
	}

	return ret;
}

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;
	devc->state = ST_INIT;
	devc->num_samples = 0;
	devc->buf_len = 0;

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

	/* Poll every 100ms, or whenever some data comes in. */
	serial = sdi->conn;
	sr_source_add(serial->fd, G_IO_IN, 150, cem_dt_885x_receive_data,
			(void *)sdi);

	return SR_OK;
}

static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
{
	(void)cb_data;

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

	return std_dev_acquisition_stop_serial(sdi, cb_data, dev_close,
			sdi->conn, LOG_PREFIX);

	return SR_OK;
}

SR_PRIV struct sr_dev_driver cem_dt_885x_driver_info = {
	.name = "cem-dt-885x",
	.longname = "CEM DT-885x",
	.api_version = 1,
	.init = init,
	.cleanup = cleanup,
	.scan = scan,
	.dev_list = dev_list,
	.dev_clear = dev_clear,
	.config_get = config_get,
	.config_set = config_set,
	.config_list = config_list,
	.dev_open = dev_open,
	.dev_close = dev_close,
	.dev_acquisition_start = dev_acquisition_start,
	.dev_acquisition_stop = dev_acquisition_stop,
	.priv = NULL,
};
Commit	Line	Data
8fa9368e BV	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2013 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 "protocol.h"
	21
7fb8279c BV	22	#define SERIALCOMM "9600/8n1"
	23	/* 23ms is the longest interval between tokens. */
	24	#define MAX_SCAN_TIME 25 * 1000
	25
	26	static const int32_t hwopts[] = {
	27	SR_CONF_CONN,
	28	};
	29
	30	static const int32_t hwcaps[] = {
	31	SR_CONF_SOUNDLEVELMETER,
	32	SR_CONF_LIMIT_SAMPLES,
	33	SR_CONF_CONTINUOUS,
	34	};
	35
	36
8fa9368e BV	37	SR_PRIV struct sr_dev_driver cem_dt_885x_driver_info;
	38	static struct sr_dev_driver *di = &cem_dt_885x_driver_info;
	39
	40
	41	static int init(struct sr_context *sr_ctx)
	42	{
	43	return std_init(sr_ctx, di, LOG_PREFIX);
	44	}
	45
	46	static GSList scan(GSList options)
	47	{
	48	struct drv_context *drvc;
7fb8279c BV	49	struct dev_context *devc;
	50	struct sr_config *src;
	51	struct sr_serial_dev_inst *serial;
	52	struct sr_dev_inst *sdi;
	53	struct sr_probe *probe;
	54	GSList l, devices;
	55	gint64 start;
	56	const char *conn;
	57	unsigned char c;
	58
	59	conn = NULL;
	60	for (l = options; l; l = l->next) {
	61	src = l->data;
	62	if (src->key == SR_CONF_CONN)
	63	conn = g_variant_get_string(src->data, NULL);
	64	}
	65	if (!conn)
	66	return NULL;
	67
	68	if (!(serial = sr_serial_dev_inst_new(conn, SERIALCOMM)))
	69	return NULL;
8fa9368e	70
7fb8279c BV	71	if (serial_open(serial, SERIAL_RDONLY \| SERIAL_NONBLOCK) != SR_OK)
7fb8279c BV	72	return NULL;
8fa9368e BV	73
	74	devices = NULL;
	75	drvc = di->priv;
7fb8279c BV	76	start = g_get_monotonic_time();
	77	while (g_get_monotonic_time() - start < MAX_SCAN_TIME) {
	78	if (serial_read(serial, &c, 1) == 1 && c == 0xa5) {
	79	/* Found one. */
	80	if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, "CEM",
	81	"DT-885x", NULL)))
	82	return NULL;
	83
	84	if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
	85	sr_dbg("Device context malloc failed.");
	86	return NULL;
	87	}
	88
	89	if (!(sdi->conn = sr_serial_dev_inst_new(conn, SERIALCOMM)))
	90	return NULL;
	91
	92	sdi->inst_type = SR_INST_SERIAL;
	93	sdi->priv = devc;
	94	sdi->driver = di;
e37c4b39	95	if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "SPL")))
7fb8279c BV	96	return NULL;
	97	sdi->probes = g_slist_append(sdi->probes, probe);
	98	drvc->instances = g_slist_append(drvc->instances, sdi);
	99	devices = g_slist_append(devices, sdi);
	100	break;
	101	}
	102	/* It takes about 1ms for a byte to come in. */
	103	g_usleep(1000);
	104	}
8fa9368e	105
7fb8279c	106	serial_close(serial);
8fa9368e BV	107
	108	return devices;
	109	}
	110
	111	static GSList *dev_list(void)
	112	{
	113	struct drv_context *drvc;
	114
	115	drvc = di->priv;
	116
	117	return drvc->instances;
	118	}
	119
	120	static int dev_clear(void)
	121	{
	122	return std_dev_clear(di, NULL);
	123	}
	124
	125	static int dev_open(struct sr_dev_inst *sdi)
	126	{
7fb8279c	127	struct sr_serial_dev_inst *serial;
8fa9368e	128
7fb8279c BV	129	serial = sdi->conn;
	130	if (serial_open(serial, SERIAL_RDWR) != SR_OK)
	131	return SR_ERR;
8fa9368e BV	132
	133	sdi->status = SR_ST_ACTIVE;
	134
	135	return SR_OK;
	136	}
	137
	138	static int dev_close(struct sr_dev_inst *sdi)
	139	{
7fb8279c	140	struct sr_serial_dev_inst *serial;
8fa9368e	141
7fb8279c BV	142	serial = sdi->conn;
	143	if (serial && serial->fd != -1) {
	144	serial_close(serial);
	145	sdi->status = SR_ST_INACTIVE;
	146	}
8fa9368e BV	147
	148	return SR_OK;
	149	}
	150
	151	static int cleanup(void)
	152	{
7fb8279c	153	return dev_clear();
8fa9368e BV	154	}
	155
	156	static int config_get(int key, GVariant *data, const struct sr_dev_inst sdi)
	157	{
7fb8279c	158	struct dev_context *devc;
8fa9368e	159
7fb8279c BV	160	if (!sdi)
7fb8279c BV	161	return SR_ERR_ARG;
8fa9368e	162
7fb8279c	163	devc = sdi->priv;
8fa9368e	164	switch (key) {
7fb8279c BV	165	case SR_CONF_LIMIT_SAMPLES:
	166	*data = g_variant_new_uint64(devc->limit_samples);
	167	break;
8fa9368e BV	168	default:
	169	return SR_ERR_NA;
	170	}
	171
7fb8279c	172	return SR_OK;
8fa9368e BV	173	}
	174
	175	static int config_set(int key, GVariant data, const struct sr_dev_inst sdi)
	176	{
7fb8279c BV	177	struct dev_context *devc;
7fb8279c BV	178	uint64_t tmp_u64;
8fa9368e BV	179	int ret;
8fa9368e BV	180
8fa9368e BV	181	if (sdi->status != SR_ST_ACTIVE)
	182	return SR_ERR_DEV_CLOSED;
	183
7fb8279c BV	184	if (!(devc = sdi->priv)) {
	185	sr_err("sdi->priv was NULL.");
	186	return SR_ERR_BUG;
	187	}
	188
8fa9368e BV	189	ret = SR_OK;
8fa9368e BV	190	switch (key) {
7fb8279c BV	191	case SR_CONF_LIMIT_SAMPLES:
	192	tmp_u64 = g_variant_get_uint64(data);
	193	devc->limit_samples = tmp_u64;
	194	ret = SR_OK;
	195	break;
8fa9368e BV	196	default:
	197	ret = SR_ERR_NA;
	198	}
	199
	200	return ret;
	201	}
	202
	203	static int config_list(int key, GVariant *data, const struct sr_dev_inst sdi)
	204	{
	205	int ret;
	206
	207	(void)sdi;
8fa9368e BV	208
	209	ret = SR_OK;
	210	switch (key) {
7fb8279c BV	211	case SR_CONF_SCAN_OPTIONS:
	212	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
	213	hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
	214	break;
	215	case SR_CONF_DEVICE_OPTIONS:
	216	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
	217	hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
	218	break;
8fa9368e BV	219	default:
	220	return SR_ERR_NA;
	221	}
	222
	223	return ret;
	224	}
	225
e37c4b39	226	static int dev_acquisition_start(const struct sr_dev_inst sdi, void cb_data)
8fa9368e	227	{
e37c4b39 BV	228	struct dev_context *devc;
e37c4b39 BV	229	struct sr_serial_dev_inst *serial;
8fa9368e BV	230
	231	if (sdi->status != SR_ST_ACTIVE)
	232	return SR_ERR_DEV_CLOSED;
	233
e37c4b39 BV	234	if (!(devc = sdi->priv)) {
	235	sr_err("sdi->priv was NULL.");
	236	return SR_ERR_BUG;
	237	}
	238
	239	devc->cb_data = cb_data;
	240	devc->state = ST_INIT;
	241	devc->num_samples = 0;
	242	devc->buf_len = 0;
	243
	244	/* Send header packet to the session bus. */
	245	std_session_send_df_header(cb_data, LOG_PREFIX);
	246
	247	/* Poll every 100ms, or whenever some data comes in. */
	248	serial = sdi->conn;
	249	sr_source_add(serial->fd, G_IO_IN, 150, cem_dt_885x_receive_data,
	250	(void *)sdi);
8fa9368e BV	251
	252	return SR_OK;
	253	}
	254
	255	static int dev_acquisition_stop(struct sr_dev_inst sdi, void cb_data)
	256	{
	257	(void)cb_data;
	258
	259	if (sdi->status != SR_ST_ACTIVE)
	260	return SR_ERR_DEV_CLOSED;
	261
e37c4b39 BV	262	return std_dev_acquisition_stop_serial(sdi, cb_data, dev_close,
e37c4b39 BV	263	sdi->conn, LOG_PREFIX);
8fa9368e BV	264
	265	return SR_OK;
	266	}
	267
	268	SR_PRIV struct sr_dev_driver cem_dt_885x_driver_info = {
	269	.name = "cem-dt-885x",
	270	.longname = "CEM DT-885x",
	271	.api_version = 1,
	272	.init = init,
	273	.cleanup = cleanup,
	274	.scan = scan,
	275	.dev_list = dev_list,
	276	.dev_clear = dev_clear,
	277	.config_get = config_get,
	278	.config_set = config_set,
	279	.config_list = config_list,
	280	.dev_open = dev_open,
	281	.dev_close = dev_close,
	282	.dev_acquisition_start = dev_acquisition_start,
	283	.dev_acquisition_stop = dev_acquisition_stop,
	284	.priv = NULL,
	285	};