[libsigrok.git] / src / hardware / pce-322a / api.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2016 George Hopkins <george-hopkins@null.net>
 * Copyright (C) 2016 Matthieu Guillaumin <matthieu@guillaum.in>
 *
 * 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 <string.h>
#include <config.h>
#include "protocol.h"

#define SERIALCOMM "115200/8n1"

static const uint32_t scanopts[] = {
	SR_CONF_CONN,
};

static const uint32_t drvopts[] = {
	SR_CONF_SOUNDLEVELMETER,
};

static const uint32_t devopts[] = {
	SR_CONF_CONTINUOUS | SR_CONF_SET,
	SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
	SR_CONF_SPL_WEIGHT_FREQ | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
	SR_CONF_SPL_WEIGHT_TIME | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
	SR_CONF_SPL_MEASUREMENT_RANGE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
	SR_CONF_POWER_OFF | SR_CONF_GET | SR_CONF_SET,
	SR_CONF_DATA_SOURCE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
};

static const char *weight_freq[] = {
	"A", "C",
};

static const char *weight_time[] = {
	"F", "S",
};

static const uint64_t meas_ranges[][2] = {
	{ 30, 130 },
	{ 30, 80 },
	{ 50, 100 },
	{ 80, 130 },
};

static const char *data_sources[] = {
	"Live", "Memory",
};

static GSList *scan(struct sr_dev_driver *di, GSList *options)
{
	struct dev_context *devc;
	struct sr_config *src;
	struct sr_serial_dev_inst *serial;
	struct sr_dev_inst *sdi;
	GSList *l;
	const char *conn;

	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;

	serial = sr_serial_dev_inst_new(conn, SERIALCOMM);

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

	sdi = g_malloc0(sizeof(struct sr_dev_inst));
	sdi->status = SR_ST_INACTIVE;
	sdi->vendor = g_strdup("PCE");
	sdi->model = g_strdup("PCE-322A");
	devc = g_malloc0(sizeof(struct dev_context));
	devc->cur_mqflags = SR_MQFLAG_SPL_TIME_WEIGHT_F | SR_MQFLAG_SPL_FREQ_WEIGHT_A;
	sdi->conn = sr_serial_dev_inst_new(conn, SERIALCOMM);
	sdi->inst_type = SR_INST_SERIAL;
	sdi->priv = devc;
	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "SPL");

	serial_close(serial);

	return std_scan_complete(di, g_slist_append(NULL, sdi));
}

static int config_get(uint32_t key, GVariant **data,
	const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
{
	struct dev_context *devc;
	uint64_t low, high;
	uint64_t tmp;
	int ret;

	(void)cg;

	if (!sdi)
		return SR_ERR_ARG;

	devc = sdi->priv;
	ret = SR_OK;
	switch (key) {
	case SR_CONF_LIMIT_SAMPLES:
		*data = g_variant_new_uint64(devc->limit_samples);
		break;
	case SR_CONF_SPL_WEIGHT_FREQ:
		tmp = pce_322a_weight_freq_get(sdi);
		if (tmp == SR_MQFLAG_SPL_FREQ_WEIGHT_A)
			*data = g_variant_new_string("A");
		else if (tmp == SR_MQFLAG_SPL_FREQ_WEIGHT_C)
			*data = g_variant_new_string("C");
		else
			return SR_ERR;
		break;
	case SR_CONF_SPL_WEIGHT_TIME:
		tmp = pce_322a_weight_time_get(sdi);
		if (tmp == SR_MQFLAG_SPL_TIME_WEIGHT_F)
			*data = g_variant_new_string("F");
		else if (tmp == SR_MQFLAG_SPL_TIME_WEIGHT_S)
			*data = g_variant_new_string("S");
		else
			return SR_ERR;
		break;
	case SR_CONF_SPL_MEASUREMENT_RANGE:
		if ((ret = pce_322a_meas_range_get(sdi, &low, &high)) == SR_OK)
			*data = std_gvar_tuple_u64(low, high);
		break;
	case SR_CONF_POWER_OFF:
		*data = g_variant_new_boolean(FALSE);
		break;
	case SR_CONF_DATA_SOURCE:
		if (devc->cur_data_source == DATA_SOURCE_LIVE)
			*data = g_variant_new_string("Live");
		else
			*data = g_variant_new_string("Memory");
		break;
	default:
		return SR_ERR_NA;
	}

	return ret;
}

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;
	uint64_t tmp_u64;
	int ret, idx;

	(void)cg;

	devc = sdi->priv;

	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;
	case SR_CONF_SPL_WEIGHT_FREQ:
		if ((idx = std_str_idx(data, ARRAY_AND_SIZE(weight_freq))) < 0)
			return SR_ERR_ARG;
		ret = pce_322a_weight_freq_set(sdi, (weight_freq[idx][0] == 'A') ?
			SR_MQFLAG_SPL_FREQ_WEIGHT_A : SR_MQFLAG_SPL_FREQ_WEIGHT_C);
		break;
	case SR_CONF_SPL_WEIGHT_TIME:
		if ((idx = std_str_idx(data, ARRAY_AND_SIZE(weight_time))) < 0)
			return SR_ERR_ARG;
		ret = pce_322a_weight_time_set(sdi, (weight_time[idx][0] == 'F') ?
			SR_MQFLAG_SPL_TIME_WEIGHT_F : SR_MQFLAG_SPL_TIME_WEIGHT_S);
		break;
	case SR_CONF_SPL_MEASUREMENT_RANGE:
		if ((idx = std_u64_tuple_idx(data, ARRAY_AND_SIZE(meas_ranges))) < 0)
			return SR_ERR_ARG;
		ret = pce_322a_meas_range_set(sdi, meas_ranges[idx][0], meas_ranges[idx][1]);
		break;
	case SR_CONF_POWER_OFF:
		if (g_variant_get_boolean(data))
			ret = pce_322a_power_off(sdi);
		break;
	case SR_CONF_DATA_SOURCE:
		if ((idx = std_str_idx(data, ARRAY_AND_SIZE(data_sources))) < 0)
			return SR_ERR_ARG;
		devc->cur_data_source = idx;
		break;
	default:
		ret = SR_ERR_NA;
	}

	return ret;
}

static int config_list(uint32_t key, GVariant **data,
	const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
{
	switch (key) {
	case SR_CONF_SCAN_OPTIONS:
	case SR_CONF_DEVICE_OPTIONS:
		return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
	case SR_CONF_SPL_WEIGHT_FREQ:
		*data = g_variant_new_strv(ARRAY_AND_SIZE(weight_freq));
		break;
	case SR_CONF_SPL_WEIGHT_TIME:
		*data = g_variant_new_strv(ARRAY_AND_SIZE(weight_time));
		break;
	case SR_CONF_SPL_MEASUREMENT_RANGE:
		*data = std_gvar_tuple_array(ARRAY_AND_SIZE(meas_ranges));
		break;
	case SR_CONF_DATA_SOURCE:
		*data = g_variant_new_strv(ARRAY_AND_SIZE(data_sources));
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

static int dev_open(struct sr_dev_inst *sdi)
{
	int ret;

	ret = std_serial_dev_open(sdi);
	if (ret != SR_OK)
		return ret;

	return pce_322a_connect(sdi);
}

static int dev_close(struct sr_dev_inst *sdi)
{
	/*
	 * Ensure device gets properly disconnected even when there was
	 * no acquisition.
	 */
	pce_322a_disconnect(sdi);

	return std_serial_dev_close(sdi);
}

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

	devc = sdi->priv;
	devc->buffer_len = 0;
	devc->memory_state = MEM_STATE_REQUEST_MEMORY_USAGE;

	std_session_send_df_header(sdi);

	serial = sdi->conn;
	serial_source_add(sdi->session, serial, G_IO_IN, 150,
			pce_322a_receive_data, (void *)sdi);

	return SR_OK;
}

static struct sr_dev_driver pce_322a_driver_info = {
	.name = "pce-322a",
	.longname = "PCE PCE-322A",
	.api_version = 1,
	.init = std_init,
	.cleanup = std_cleanup,
	.scan = scan,
	.dev_list = std_dev_list,
	.dev_clear = std_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 = std_serial_dev_acquisition_stop,
	.context = NULL,
};
SR_REGISTER_DEV_DRIVER(pce_322a_driver_info);
Commit	Line	Data
	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2016 George Hopkins <george-hopkins@null.net>
	5	* Copyright (C) 2016 Matthieu Guillaumin <matthieu@guillaum.in>
	6	*
	7	* This program is free software: you can redistribute it and/or modify
	8	* it under the terms of the GNU General Public License as published by
	9	* the Free Software Foundation, either version 3 of the License, or
	10	* (at your option) any later version.
	11	*
	12	* This program is distributed in the hope that it will be useful,
	13	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	* GNU General Public License for more details.
	16	*
	17	* You should have received a copy of the GNU General Public License
	18	* along with this program. If not, see <http://www.gnu.org/licenses/>.
	19	*/
	20
	21	#include <string.h>
	22	#include <config.h>
	23	#include "protocol.h"
	24
	25	#define SERIALCOMM "115200/8n1"
	26
	27	static const uint32_t scanopts[] = {
	28	SR_CONF_CONN,
	29	};
	30
	31	static const uint32_t drvopts[] = {
	32	SR_CONF_SOUNDLEVELMETER,
	33	};
	34
	35	static const uint32_t devopts[] = {
	36	SR_CONF_CONTINUOUS \| SR_CONF_SET,
	37	SR_CONF_LIMIT_SAMPLES \| SR_CONF_GET \| SR_CONF_SET,
	38	SR_CONF_SPL_WEIGHT_FREQ \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
	39	SR_CONF_SPL_WEIGHT_TIME \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
	40	SR_CONF_SPL_MEASUREMENT_RANGE \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
	41	SR_CONF_POWER_OFF \| SR_CONF_GET \| SR_CONF_SET,
	42	SR_CONF_DATA_SOURCE \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
	43	};
	44
	45	static const char *weight_freq[] = {
	46	"A", "C",
	47	};
	48
	49	static const char *weight_time[] = {
	50	"F", "S",
	51	};
	52
	53	static const uint64_t meas_ranges[][2] = {
	54	{ 30, 130 },
	55	{ 30, 80 },
	56	{ 50, 100 },
	57	{ 80, 130 },
	58	};
	59
	60	static const char *data_sources[] = {
	61	"Live", "Memory",
	62	};
	63
	64	static GSList scan(struct sr_dev_driver di, GSList *options)
	65	{
	66	struct dev_context *devc;
	67	struct sr_config *src;
	68	struct sr_serial_dev_inst *serial;
	69	struct sr_dev_inst *sdi;
	70	GSList *l;
	71	const char *conn;
	72
	73	conn = NULL;
	74	for (l = options; l; l = l->next) {
	75	src = l->data;
	76	if (src->key == SR_CONF_CONN)
	77	conn = g_variant_get_string(src->data, NULL);
	78	}
	79	if (!conn)
	80	return NULL;
	81
	82	serial = sr_serial_dev_inst_new(conn, SERIALCOMM);
	83
	84	if (serial_open(serial, SERIAL_RDONLY) != SR_OK)
	85	return NULL;
	86
	87	sdi = g_malloc0(sizeof(struct sr_dev_inst));
	88	sdi->status = SR_ST_INACTIVE;
	89	sdi->vendor = g_strdup("PCE");
	90	sdi->model = g_strdup("PCE-322A");
	91	devc = g_malloc0(sizeof(struct dev_context));
	92	devc->cur_mqflags = SR_MQFLAG_SPL_TIME_WEIGHT_F \| SR_MQFLAG_SPL_FREQ_WEIGHT_A;
	93	sdi->conn = sr_serial_dev_inst_new(conn, SERIALCOMM);
	94	sdi->inst_type = SR_INST_SERIAL;
	95	sdi->priv = devc;
	96	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "SPL");
	97
	98	serial_close(serial);
	99
	100	return std_scan_complete(di, g_slist_append(NULL, sdi));
	101	}
	102
	103	static int config_get(uint32_t key, GVariant **data,
	104	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
	105	{
	106	struct dev_context *devc;
	107	uint64_t low, high;
	108	uint64_t tmp;
	109	int ret;
	110
	111	(void)cg;
	112
	113	if (!sdi)
	114	return SR_ERR_ARG;
	115
	116	devc = sdi->priv;
	117	ret = SR_OK;
	118	switch (key) {
	119	case SR_CONF_LIMIT_SAMPLES:
	120	*data = g_variant_new_uint64(devc->limit_samples);
	121	break;
	122	case SR_CONF_SPL_WEIGHT_FREQ:
	123	tmp = pce_322a_weight_freq_get(sdi);
	124	if (tmp == SR_MQFLAG_SPL_FREQ_WEIGHT_A)
	125	*data = g_variant_new_string("A");
	126	else if (tmp == SR_MQFLAG_SPL_FREQ_WEIGHT_C)
	127	*data = g_variant_new_string("C");
	128	else
	129	return SR_ERR;
	130	break;
	131	case SR_CONF_SPL_WEIGHT_TIME:
	132	tmp = pce_322a_weight_time_get(sdi);
	133	if (tmp == SR_MQFLAG_SPL_TIME_WEIGHT_F)
	134	*data = g_variant_new_string("F");
	135	else if (tmp == SR_MQFLAG_SPL_TIME_WEIGHT_S)
	136	*data = g_variant_new_string("S");
	137	else
	138	return SR_ERR;
	139	break;
	140	case SR_CONF_SPL_MEASUREMENT_RANGE:
	141	if ((ret = pce_322a_meas_range_get(sdi, &low, &high)) == SR_OK)
	142	*data = std_gvar_tuple_u64(low, high);
	143	break;
	144	case SR_CONF_POWER_OFF:
	145	*data = g_variant_new_boolean(FALSE);
	146	break;
	147	case SR_CONF_DATA_SOURCE:
	148	if (devc->cur_data_source == DATA_SOURCE_LIVE)
	149	*data = g_variant_new_string("Live");
	150	else
	151	*data = g_variant_new_string("Memory");
	152	break;
	153	default:
	154	return SR_ERR_NA;
	155	}
	156
	157	return ret;
	158	}
	159
	160	static int config_set(uint32_t key, GVariant data, const struct sr_dev_inst sdi,
	161	const struct sr_channel_group *cg)
	162	{
	163	struct dev_context *devc;
	164	uint64_t tmp_u64;
	165	int ret, idx;
	166
	167	(void)cg;
	168
	169	devc = sdi->priv;
	170
	171	ret = SR_OK;
	172	switch (key) {
	173	case SR_CONF_LIMIT_SAMPLES:
	174	tmp_u64 = g_variant_get_uint64(data);
	175	devc->limit_samples = tmp_u64;
	176	ret = SR_OK;
	177	break;
	178	case SR_CONF_SPL_WEIGHT_FREQ:
	179	if ((idx = std_str_idx(data, ARRAY_AND_SIZE(weight_freq))) < 0)
	180	return SR_ERR_ARG;
	181	ret = pce_322a_weight_freq_set(sdi, (weight_freq[idx][0] == 'A') ?
	182	SR_MQFLAG_SPL_FREQ_WEIGHT_A : SR_MQFLAG_SPL_FREQ_WEIGHT_C);
	183	break;
	184	case SR_CONF_SPL_WEIGHT_TIME:
	185	if ((idx = std_str_idx(data, ARRAY_AND_SIZE(weight_time))) < 0)
	186	return SR_ERR_ARG;
	187	ret = pce_322a_weight_time_set(sdi, (weight_time[idx][0] == 'F') ?
	188	SR_MQFLAG_SPL_TIME_WEIGHT_F : SR_MQFLAG_SPL_TIME_WEIGHT_S);
	189	break;
	190	case SR_CONF_SPL_MEASUREMENT_RANGE:
	191	if ((idx = std_u64_tuple_idx(data, ARRAY_AND_SIZE(meas_ranges))) < 0)
	192	return SR_ERR_ARG;
	193	ret = pce_322a_meas_range_set(sdi, meas_ranges[idx][0], meas_ranges[idx][1]);
	194	break;
	195	case SR_CONF_POWER_OFF:
	196	if (g_variant_get_boolean(data))
	197	ret = pce_322a_power_off(sdi);
	198	break;
	199	case SR_CONF_DATA_SOURCE:
	200	if ((idx = std_str_idx(data, ARRAY_AND_SIZE(data_sources))) < 0)
	201	return SR_ERR_ARG;
	202	devc->cur_data_source = idx;
	203	break;
	204	default:
	205	ret = SR_ERR_NA;
	206	}
	207
	208	return ret;
	209	}
	210
	211	static int config_list(uint32_t key, GVariant **data,
	212	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
	213	{
	214	switch (key) {
	215	case SR_CONF_SCAN_OPTIONS:
	216	case SR_CONF_DEVICE_OPTIONS:
	217	return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
	218	case SR_CONF_SPL_WEIGHT_FREQ:
	219	*data = g_variant_new_strv(ARRAY_AND_SIZE(weight_freq));
	220	break;
	221	case SR_CONF_SPL_WEIGHT_TIME:
	222	*data = g_variant_new_strv(ARRAY_AND_SIZE(weight_time));
	223	break;
	224	case SR_CONF_SPL_MEASUREMENT_RANGE:
	225	*data = std_gvar_tuple_array(ARRAY_AND_SIZE(meas_ranges));
	226	break;
	227	case SR_CONF_DATA_SOURCE:
	228	*data = g_variant_new_strv(ARRAY_AND_SIZE(data_sources));
	229	break;
	230	default:
	231	return SR_ERR_NA;
	232	}
	233
	234	return SR_OK;
	235	}
	236
	237	static int dev_open(struct sr_dev_inst *sdi)
	238	{
	239	int ret;
	240
	241	ret = std_serial_dev_open(sdi);
	242	if (ret != SR_OK)
	243	return ret;
	244
	245	return pce_322a_connect(sdi);
	246	}
	247
	248	static int dev_close(struct sr_dev_inst *sdi)
	249	{
	250	/*
	251	* Ensure device gets properly disconnected even when there was
	252	* no acquisition.
	253	*/
	254	pce_322a_disconnect(sdi);
	255
	256	return std_serial_dev_close(sdi);
	257	}
	258
	259	static int dev_acquisition_start(const struct sr_dev_inst *sdi)
	260	{
	261	struct dev_context *devc;
	262	struct sr_serial_dev_inst *serial;
	263
	264	devc = sdi->priv;
	265	devc->buffer_len = 0;
	266	devc->memory_state = MEM_STATE_REQUEST_MEMORY_USAGE;
	267
	268	std_session_send_df_header(sdi);
	269
	270	serial = sdi->conn;
	271	serial_source_add(sdi->session, serial, G_IO_IN, 150,
	272	pce_322a_receive_data, (void *)sdi);
	273
	274	return SR_OK;
	275	}
	276
	277	static struct sr_dev_driver pce_322a_driver_info = {
	278	.name = "pce-322a",
	279	.longname = "PCE PCE-322A",
	280	.api_version = 1,
	281	.init = std_init,
	282	.cleanup = std_cleanup,
	283	.scan = scan,
	284	.dev_list = std_dev_list,
	285	.dev_clear = std_dev_clear,
	286	.config_get = config_get,
	287	.config_set = config_set,
	288	.config_list = config_list,
	289	.dev_open = dev_open,
	290	.dev_close = dev_close,
	291	.dev_acquisition_start = dev_acquisition_start,
	292	.dev_acquisition_stop = std_serial_dev_acquisition_stop,
	293	.context = NULL,
	294	};
	295	SR_REGISTER_DEV_DRIVER(pce_322a_driver_info);