[libsigrok.git] / src / hardware / uni-t-ut32x / 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 <config.h>
#include <string.h>
#include "protocol.h"

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

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

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

/*
 * BEWARE! "T1-T2" looks like a range, and is probably not a good
 * channel name. Using it in sigrok-cli -C specs is troublesome. Use
 * "delta" instead? -- But OTOH channels are not selected by the
 * software. Instead received packets just reflect the one channel
 * that manually was selected by the user via the device's buttons.
 * So the name is not a blocker, and it matches the labels on the
 * device and in the manual. So we can get away with it.
 */
static const char *channel_names[] = {
	"T1", "T2", "T1-T2",
};

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

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

	/*
	 * Implementor's note: Do _not_ add a default conn value here,
	 * always expect users to specify the connection. Otherwise the
	 * UT32x driver's scan routine results in false positives, will
	 * match _any_ UT-D04 cable which uses the same USB HID chip.
	 */
	conn = NULL;
	serialcomm = "2400/8n1";
	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;

	devices = NULL;
	serial = sr_serial_dev_inst_new(conn, serialcomm);
	rc = serial_open(serial, SERIAL_RDWR);
	serial_flush(serial);
	/* Cannot query/identify the device. Successful open shall suffice. */
	serial_close(serial);
	if (rc != SR_OK) {
		sr_serial_dev_inst_free(serial);
		return devices;
	}

	sdi = g_malloc0(sizeof(*sdi));
	sdi->status = SR_ST_INACTIVE;
	sdi->vendor = g_strdup("UNI-T");
	sdi->model = g_strdup("UT32x");
	sdi->inst_type = SR_INST_SERIAL;
	sdi->conn = serial;
	devc = g_malloc0(sizeof(*devc));
	sdi->priv = devc;
	sr_sw_limits_init(&devc->limits);
	devc->data_source = DEFAULT_DATA_SOURCE;
	for (i = 0; i < ARRAY_SIZE(channel_names); i++) {
		sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, TRUE,
				channel_names[i]);
	}
	devices = g_slist_append(devices, sdi);

	serial_close(serial);
	if (!devices)
		sr_serial_dev_inst_free(serial);

	return std_scan_complete(di, devices);
}

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;

	(void)cg;

	devc = sdi->priv;
	switch (key) {
	case SR_CONF_LIMIT_SAMPLES:
	case SR_CONF_LIMIT_MSEC:
		return sr_sw_limits_config_get(&devc->limits, key, data);
	case SR_CONF_DATA_SOURCE:
		*data = g_variant_new_string(data_sources[devc->data_source]);
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

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;
	int idx;

	(void)cg;

	devc = sdi->priv;

	switch (key) {
	case SR_CONF_LIMIT_SAMPLES:
	case SR_CONF_LIMIT_MSEC:
		return sr_sw_limits_config_set(&devc->limits, key, data);
	case SR_CONF_DATA_SOURCE:
		if ((idx = std_str_idx(data, ARRAY_AND_SIZE(data_sources))) < 0)
			return SR_ERR_ARG;
		devc->data_source = idx;
		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)
{
	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_DATA_SOURCE:
		*data = g_variant_new_strv(ARRAY_AND_SIZE(data_sources));
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

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

	devc = sdi->priv;
	serial = sdi->conn;

	sr_sw_limits_acquisition_start(&devc->limits);
	devc->packet_len = 0;
	std_session_send_df_header(sdi);

	if (devc->data_source == DATA_SOURCE_LIVE)
		cmd = CMD_GET_LIVE;
	else
		cmd = CMD_GET_STORED;
	serial_write_blocking(serial, &cmd, sizeof(cmd), 0);

	serial_source_add(sdi->session, serial, G_IO_IN, 10,
			ut32x_handle_events, (void *)sdi);

	return SR_OK;
}

static int dev_acquisition_stop(struct sr_dev_inst *sdi)
{
	/* Have the reception routine stop the acquisition. */
	sdi->status = SR_ST_STOPPING;

	return SR_OK;
}

static struct sr_dev_driver uni_t_ut32x_driver_info = {
	.name = "uni-t-ut32x",
	.longname = "UNI-T UT32x",
	.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 = std_serial_dev_open,
	.dev_close = std_serial_dev_close,
	.dev_acquisition_start = dev_acquisition_start,
	.dev_acquisition_stop = dev_acquisition_stop,
	.context = NULL,
};
SR_REGISTER_DEV_DRIVER(uni_t_ut32x_driver_info);
Commit	Line	Data
	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 <config.h>
	21	#include <string.h>
	22	#include "protocol.h"
	23
	24	static const uint32_t scanopts[] = {
	25	SR_CONF_CONN,
	26	SR_CONF_SERIALCOMM,
	27	};
	28
	29	static const uint32_t drvopts[] = {
	30	SR_CONF_THERMOMETER,
	31	};
	32
	33	static const uint32_t devopts[] = {
	34	SR_CONF_CONTINUOUS,
	35	SR_CONF_LIMIT_SAMPLES \| SR_CONF_GET \| SR_CONF_SET,
	36	SR_CONF_LIMIT_MSEC \| SR_CONF_GET \| SR_CONF_SET,
	37	SR_CONF_DATA_SOURCE \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
	38	};
	39
	40	/*
	41	* BEWARE! "T1-T2" looks like a range, and is probably not a good
	42	* channel name. Using it in sigrok-cli -C specs is troublesome. Use
	43	* "delta" instead? -- But OTOH channels are not selected by the
	44	* software. Instead received packets just reflect the one channel
	45	* that manually was selected by the user via the device's buttons.
	46	* So the name is not a blocker, and it matches the labels on the
	47	* device and in the manual. So we can get away with it.
	48	*/
	49	static const char *channel_names[] = {
	50	"T1", "T2", "T1-T2",
	51	};
	52
	53	static const char *data_sources[] = {
	54	"Live", "Memory",
	55	};
	56
	57	static GSList scan(struct sr_dev_driver di, GSList *options)
	58	{
	59	const char conn, serialcomm;
	60	struct sr_config *src;
	61	GSList l, devices;
	62	struct sr_serial_dev_inst *serial;
	63	int rc;
	64	struct sr_dev_inst *sdi;
	65	struct dev_context *devc;
	66	size_t i;
	67
	68	/*
	69	* Implementor's note: Do _not_ add a default conn value here,
	70	* always expect users to specify the connection. Otherwise the
	71	* UT32x driver's scan routine results in false positives, will
	72	* match _any_ UT-D04 cable which uses the same USB HID chip.
	73	*/
	74	conn = NULL;
	75	serialcomm = "2400/8n1";
	76	for (l = options; l; l = l->next) {
	77	src = l->data;
	78	switch (src->key) {
	79	case SR_CONF_CONN:
	80	conn = g_variant_get_string(src->data, NULL);
	81	break;
	82	case SR_CONF_SERIALCOMM:
	83	serialcomm = g_variant_get_string(src->data, NULL);
	84	break;
	85	}
	86	}
	87	if (!conn)
	88	return NULL;
	89
	90	devices = NULL;
	91	serial = sr_serial_dev_inst_new(conn, serialcomm);
	92	rc = serial_open(serial, SERIAL_RDWR);
	93	serial_flush(serial);
	94	/* Cannot query/identify the device. Successful open shall suffice. */
	95	serial_close(serial);
	96	if (rc != SR_OK) {
	97	sr_serial_dev_inst_free(serial);
	98	return devices;
	99	}
	100
	101	sdi = g_malloc0(sizeof(*sdi));
	102	sdi->status = SR_ST_INACTIVE;
	103	sdi->vendor = g_strdup("UNI-T");
	104	sdi->model = g_strdup("UT32x");
	105	sdi->inst_type = SR_INST_SERIAL;
	106	sdi->conn = serial;
	107	devc = g_malloc0(sizeof(*devc));
	108	sdi->priv = devc;
	109	sr_sw_limits_init(&devc->limits);
	110	devc->data_source = DEFAULT_DATA_SOURCE;
	111	for (i = 0; i < ARRAY_SIZE(channel_names); i++) {
	112	sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, TRUE,
	113	channel_names[i]);
	114	}
	115	devices = g_slist_append(devices, sdi);
	116
	117	serial_close(serial);
	118	if (!devices)
	119	sr_serial_dev_inst_free(serial);
	120
	121	return std_scan_complete(di, devices);
	122	}
	123
	124	static int config_get(uint32_t key, GVariant **data,
	125	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
	126	{
	127	struct dev_context *devc;
	128
	129	(void)cg;
	130
	131	devc = sdi->priv;
	132	switch (key) {
	133	case SR_CONF_LIMIT_SAMPLES:
	134	case SR_CONF_LIMIT_MSEC:
	135	return sr_sw_limits_config_get(&devc->limits, key, data);
	136	case SR_CONF_DATA_SOURCE:
	137	*data = g_variant_new_string(data_sources[devc->data_source]);
	138	break;
	139	default:
	140	return SR_ERR_NA;
	141	}
	142
	143	return SR_OK;
	144	}
	145
	146	static int config_set(uint32_t key, GVariant *data,
	147	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
	148	{
	149	struct dev_context *devc;
	150	int idx;
	151
	152	(void)cg;
	153
	154	devc = sdi->priv;
	155
	156	switch (key) {
	157	case SR_CONF_LIMIT_SAMPLES:
	158	case SR_CONF_LIMIT_MSEC:
	159	return sr_sw_limits_config_set(&devc->limits, key, data);
	160	case SR_CONF_DATA_SOURCE:
	161	if ((idx = std_str_idx(data, ARRAY_AND_SIZE(data_sources))) < 0)
	162	return SR_ERR_ARG;
	163	devc->data_source = idx;
	164	break;
	165	default:
	166	return SR_ERR_NA;
	167	}
	168
	169	return SR_OK;
	170	}
	171
	172	static int config_list(uint32_t key, GVariant **data,
	173	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
	174	{
	175	switch (key) {
	176	case SR_CONF_SCAN_OPTIONS:
	177	case SR_CONF_DEVICE_OPTIONS:
	178	return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
	179	case SR_CONF_DATA_SOURCE:
	180	*data = g_variant_new_strv(ARRAY_AND_SIZE(data_sources));
	181	break;
	182	default:
	183	return SR_ERR_NA;
	184	}
	185
	186	return SR_OK;
	187	}
	188
	189	static int dev_acquisition_start(const struct sr_dev_inst *sdi)
	190	{
	191	struct dev_context *devc;
	192	struct sr_serial_dev_inst *serial;
	193	uint8_t cmd;
	194
	195	devc = sdi->priv;
	196	serial = sdi->conn;
	197
	198	sr_sw_limits_acquisition_start(&devc->limits);
	199	devc->packet_len = 0;
	200	std_session_send_df_header(sdi);
	201
	202	if (devc->data_source == DATA_SOURCE_LIVE)
	203	cmd = CMD_GET_LIVE;
	204	else
	205	cmd = CMD_GET_STORED;
	206	serial_write_blocking(serial, &cmd, sizeof(cmd), 0);
	207
	208	serial_source_add(sdi->session, serial, G_IO_IN, 10,
	209	ut32x_handle_events, (void *)sdi);
	210
	211	return SR_OK;
	212	}
	213
	214	static int dev_acquisition_stop(struct sr_dev_inst *sdi)
	215	{
	216	/* Have the reception routine stop the acquisition. */
	217	sdi->status = SR_ST_STOPPING;
	218
	219	return SR_OK;
	220	}
	221
	222	static struct sr_dev_driver uni_t_ut32x_driver_info = {
	223	.name = "uni-t-ut32x",
	224	.longname = "UNI-T UT32x",
	225	.api_version = 1,
	226	.init = std_init,
	227	.cleanup = std_cleanup,
	228	.scan = scan,
	229	.dev_list = std_dev_list,
	230	.dev_clear = std_dev_clear,
	231	.config_get = config_get,
	232	.config_set = config_set,
	233	.config_list = config_list,
	234	.dev_open = std_serial_dev_open,
	235	.dev_close = std_serial_dev_close,
	236	.dev_acquisition_start = dev_acquisition_start,
	237	.dev_acquisition_stop = dev_acquisition_stop,
	238	.context = NULL,
	239	};
	240	SR_REGISTER_DEV_DRIVER(uni_t_ut32x_driver_info);