[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 <config.h>
#include <glib.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <string.h>
#include <libsigrok/libsigrok.h>
#include "libsigrok-internal.h"
#include "protocol.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 int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
{
	return std_init(sr_ctx, di, LOG_PREFIX);
}

static GSList *scan(struct sr_dev_driver *di, GSList *options)
{
	struct drv_context *drvc;
	struct dev_context *devc;
	struct sr_dev_inst *sdi;
	struct sr_config *src;
	GSList *devices, *l;
	const char *conn, *serialcomm;

	drvc = di->context;
	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 = g_malloc0(sizeof(struct sr_dev_inst));
	sdi->status = SR_ST_INACTIVE;
	sdi->vendor = g_strdup("Colead");
	sdi->model = g_strdup("SL-5868P");
	devc = g_malloc0(sizeof(struct dev_context));
	sdi->conn = sr_serial_dev_inst_new(conn, serialcomm);
	sdi->inst_type = SR_INST_SERIAL;
	sdi->priv = devc;
	sdi->driver = di;
	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
	drvc->instances = g_slist_append(drvc->instances, sdi);
	devices = g_slist_append(devices, sdi);

	return devices;
}

static GSList *dev_list(const struct sr_dev_driver *di)
{
	return ((struct drv_context *)(di->context))->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(const struct sr_dev_driver *di)
{
	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 */
		devc->limit_msec = g_variant_get_uint64(data);;
		break;
	case SR_CONF_LIMIT_SAMPLES:
		devc->limit_samples = g_variant_get_uint64(data);
		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;

	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,
	.context = 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 <config.h>
	21	#include <glib.h>
	22	#include <sys/types.h>
	23	#include <sys/stat.h>
	24	#include <fcntl.h>
	25	#include <string.h>
	26	#include <libsigrok/libsigrok.h>
	27	#include "libsigrok-internal.h"
	28	#include "protocol.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
	47	static int init(struct sr_dev_driver di, struct sr_context sr_ctx)
	48	{
	49	return std_init(sr_ctx, di, LOG_PREFIX);
	50	}
	51
	52	static GSList scan(struct sr_dev_driver di, GSList *options)
	53	{
	54	struct drv_context *drvc;
	55	struct dev_context *devc;
	56	struct sr_dev_inst *sdi;
	57	struct sr_config *src;
	58	GSList devices, l;
	59	const char conn, serialcomm;
	60
	61	drvc = di->context;
	62	drvc->instances = NULL;
	63
	64	devices = NULL;
	65
	66	conn = serialcomm = NULL;
	67	for (l = options; l; l = l->next) {
	68	src = l->data;
	69	switch (src->key) {
	70	case SR_CONF_CONN:
	71	conn = g_variant_get_string(src->data, NULL);
	72	break;
	73	case SR_CONF_SERIALCOMM:
	74	serialcomm = g_variant_get_string(src->data, NULL);
	75	break;
	76	}
	77	}
	78	if (!conn)
	79	return NULL;
	80	if (!serialcomm)
	81	serialcomm = SERIALCOMM;
	82
	83	sdi = g_malloc0(sizeof(struct sr_dev_inst));
	84	sdi->status = SR_ST_INACTIVE;
	85	sdi->vendor = g_strdup("Colead");
	86	sdi->model = g_strdup("SL-5868P");
	87	devc = g_malloc0(sizeof(struct dev_context));
	88	sdi->conn = sr_serial_dev_inst_new(conn, serialcomm);
	89	sdi->inst_type = SR_INST_SERIAL;
	90	sdi->priv = devc;
	91	sdi->driver = di;
	92	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
	93	drvc->instances = g_slist_append(drvc->instances, sdi);
	94	devices = g_slist_append(devices, sdi);
	95
	96	return devices;
	97	}
	98
	99	static GSList dev_list(const struct sr_dev_driver di)
	100	{
	101	return ((struct drv_context *)(di->context))->instances;
	102	}
	103
	104	static int dev_open(struct sr_dev_inst *sdi)
	105	{
	106	struct sr_serial_dev_inst *serial;
	107
	108	serial = sdi->conn;
	109	if (serial_open(serial, SERIAL_RDWR) != SR_OK)
	110	return SR_ERR;
	111
	112	sdi->status = SR_ST_ACTIVE;
	113
	114	return SR_OK;
	115	}
	116
	117	static int cleanup(const struct sr_dev_driver *di)
	118	{
	119	return std_dev_clear(di, NULL);
	120	}
	121
	122	static int config_set(uint32_t key, GVariant data, const struct sr_dev_inst sdi,
	123	const struct sr_channel_group *cg)
	124	{
	125	struct dev_context *devc;
	126
	127	(void)cg;
	128
	129	if (sdi->status != SR_ST_ACTIVE)
	130	return SR_ERR_DEV_CLOSED;
	131
	132	if (!(devc = sdi->priv)) {
	133	sr_err("sdi->priv was NULL.");
	134	return SR_ERR_BUG;
	135	}
	136
	137	switch (key) {
	138	case SR_CONF_LIMIT_MSEC:
	139	/* TODO: not yet implemented */
	140	devc->limit_msec = g_variant_get_uint64(data);;
	141	break;
	142	case SR_CONF_LIMIT_SAMPLES:
	143	devc->limit_samples = g_variant_get_uint64(data);
	144	break;
	145	default:
	146	return SR_ERR_NA;
	147	}
	148
	149	return SR_OK;
	150	}
	151
	152	static int config_list(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
	153	const struct sr_channel_group *cg)
	154	{
	155	(void)sdi;
	156	(void)cg;
	157
	158	switch (key) {
	159	case SR_CONF_SCAN_OPTIONS:
	160	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
	161	scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
	162	break;
	163	case SR_CONF_DEVICE_OPTIONS:
	164	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
	165	devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
	166	break;
	167	default:
	168	return SR_ERR_NA;
	169	}
	170
	171	return SR_OK;
	172	}
	173
	174	static int dev_acquisition_start(const struct sr_dev_inst sdi, void cb_data)
	175	{
	176	struct dev_context *devc;
	177	struct sr_serial_dev_inst *serial;
	178
	179	if (sdi->status != SR_ST_ACTIVE)
	180	return SR_ERR_DEV_CLOSED;
	181
	182	if (!(devc = sdi->priv)) {
	183	sr_err("sdi->priv was NULL.");
	184	return SR_ERR_BUG;
	185	}
	186
	187	devc->cb_data = cb_data;
	188
	189	std_session_send_df_header(cb_data, LOG_PREFIX);
	190
	191	/* Poll every 150ms, or whenever some data comes in. */
	192	serial = sdi->conn;
	193	serial_source_add(sdi->session, serial, G_IO_IN, 150,
	194	colead_slm_receive_data, (void *)sdi);
	195
	196	return SR_OK;
	197	}
	198
	199	static int dev_acquisition_stop(struct sr_dev_inst sdi, void cb_data)
	200	{
	201	return std_serial_dev_acquisition_stop(sdi, cb_data, std_serial_dev_close,
	202	sdi->conn, LOG_PREFIX);
	203	}
	204
	205	SR_PRIV struct sr_dev_driver colead_slm_driver_info = {
	206	.name = "colead-slm",
	207	.longname = "Colead SLM",
	208	.api_version = 1,
	209	.init = init,
	210	.cleanup = cleanup,
	211	.scan = scan,
	212	.dev_list = dev_list,
	213	.dev_clear = NULL,
	214	.config_get = NULL,
	215	.config_set = config_set,
	216	.config_list = config_list,
	217	.dev_open = dev_open,
	218	.dev_close = std_serial_dev_close,
	219	.dev_acquisition_start = dev_acquisition_start,
	220	.dev_acquisition_stop = dev_acquisition_stop,
	221	.context = NULL,
	222	};