[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 devopts[] = {
	SR_CONF_THERMOMETER,
	SR_CONF_CONTINUOUS,
	SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
	SR_CONF_DATA_SOURCE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
};

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)
{
	struct drv_context *drvc;
	struct dev_context *devc;
	struct sr_dev_inst *sdi;
	struct sr_config *src;
	GSList *usb_devices, *devices, *l;
	unsigned int i;
	const char *conn;

	drvc = di->context;

	conn = 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;
		}
	}
	if (!conn)
		return NULL;

	devices = NULL;
	if ((usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn))) {
		/* We have a list of sr_usb_dev_inst matching the connection
		 * string. Wrap them in sr_dev_inst and we're done. */
		for (l = usb_devices; l; l = l->next) {
			sdi = g_malloc0(sizeof(struct sr_dev_inst));
			sdi->status = SR_ST_INACTIVE;
			sdi->vendor = g_strdup(VENDOR);
			sdi->model = g_strdup(MODEL);
			sdi->driver = di;
			sdi->inst_type = SR_INST_USB;
			sdi->conn = l->data;
			for (i = 0; i < ARRAY_SIZE(channel_names); i++)
				sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, TRUE,
						channel_names[i]);
			devc = g_malloc0(sizeof(struct dev_context));
			sdi->priv = devc;
			devc->limit_samples = 0;
			devc->data_source = DEFAULT_DATA_SOURCE;
			drvc->instances = g_slist_append(drvc->instances, sdi);
			devices = g_slist_append(devices, sdi);
		}
		g_slist_free(usb_devices);
	} else
		g_slist_free_full(usb_devices, g_free);

	return devices;
}

static int dev_open(struct sr_dev_inst *sdi)
{
	struct sr_dev_driver *di = sdi->driver;
	struct drv_context *drvc = di->context;
	struct sr_usb_dev_inst *usb;
	int ret;

	usb = sdi->conn;

	if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
		return SR_ERR;

/*
 * The libusb 1.0.9 Darwin backend is broken: it can report a kernel
 * driver being active, but detaching it always returns an error.
 */
#if !defined(__APPLE__)
	if (libusb_kernel_driver_active(usb->devhdl, USB_INTERFACE) == 1) {
		if ((ret = libusb_detach_kernel_driver(usb->devhdl, USB_INTERFACE)) < 0) {
			sr_err("failed to detach kernel driver: %s",
					libusb_error_name(ret));
			return SR_ERR;
		}
	}
#endif

	if ((ret = libusb_set_configuration(usb->devhdl, USB_CONFIGURATION))) {
		sr_err("Failed to set configuration: %s.", libusb_error_name(ret));
		return SR_ERR;
	}

	if ((ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE))) {
		sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
		return SR_ERR;
	}
	sdi->status = SR_ST_ACTIVE;

	return ret;
}

static int dev_close(struct sr_dev_inst *sdi)
{
	struct sr_usb_dev_inst *usb;

	usb = sdi->conn;
	if (!usb->devhdl)
		/*  Nothing to do. */
		return SR_OK;

	libusb_release_interface(usb->devhdl, USB_INTERFACE);
	libusb_close(usb->devhdl);
	usb->devhdl = NULL;
	sdi->status = SR_ST_INACTIVE;

	return SR_OK;
}

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:
		*data = g_variant_new_uint64(devc->limit_samples);
		break;
	case SR_CONF_DATA_SOURCE:
		if (devc->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 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;
	const char *tmp_str;

	(void)cg;

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

	devc = sdi->priv;

	switch (key) {
	case SR_CONF_LIMIT_SAMPLES:
		devc->limit_samples = g_variant_get_uint64(data);
		break;
	case SR_CONF_DATA_SOURCE:
		tmp_str = g_variant_get_string(data, NULL);
		if (!strcmp(tmp_str, "Live"))
			devc->data_source = DATA_SOURCE_LIVE;
		else if (!strcmp(tmp_str, "Memory"))
			devc->data_source = DATA_SOURCE_MEMORY;
		else
			return SR_ERR;
		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_DEVICE_OPTIONS:
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
				devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
		break;
	case SR_CONF_DATA_SOURCE:
		*data = g_variant_new_strv(data_sources, ARRAY_SIZE(data_sources));
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

static int dev_acquisition_start(const struct sr_dev_inst *sdi)
{
	struct sr_dev_driver *di = sdi->driver;
	struct drv_context *drvc;
	struct dev_context *devc;
	struct sr_usb_dev_inst *usb;
	int len, ret;
	unsigned char cmd[2];

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

	drvc = di->context;
	devc = sdi->priv;
	usb = sdi->conn;

	devc->num_samples = 0;
	devc->packet_len = 0;

	/* Configure serial port parameters on USB-UART interface
	 * chip inside the device (just baudrate 2400 actually). */
	cmd[0] = 0x09;
	cmd[1] = 0x60;
	ret = libusb_control_transfer(usb->devhdl, 0x21, 0x09, 0x0300, 0x00,
			cmd, 2, 5);
	if (ret != 2) {
		sr_dbg("Failed to configure CH9325: %s", libusb_error_name(ret));
		return SR_ERR;
	}

	std_session_send_df_header(sdi, LOG_PREFIX);

	if (!(devc->xfer = libusb_alloc_transfer(0)))
		return SR_ERR;

	/* Length of payload to follow. */
	cmd[0] = 0x01;
	if (devc->data_source == DATA_SOURCE_LIVE)
		cmd[1] = CMD_GET_LIVE;
	else
		cmd[1] = CMD_GET_STORED;

	ret = libusb_bulk_transfer(usb->devhdl, EP_OUT, cmd, 2, &len, 5);
	if (ret != 0 || len != 2) {
		sr_dbg("Failed to start acquisition: %s", libusb_error_name(ret));
		libusb_free_transfer(devc->xfer);
		return SR_ERR;
	}

	libusb_fill_bulk_transfer(devc->xfer, usb->devhdl, EP_IN, devc->buf,
			8, uni_t_ut32x_receive_transfer, (void *)sdi, 15);
	if (libusb_submit_transfer(devc->xfer) != 0) {
		libusb_free_transfer(devc->xfer);
		return SR_ERR;
	}

	usb_source_add(sdi->session, drvc->sr_ctx, 10,
			uni_t_ut32x_handle_events, (void *)sdi);

	return SR_OK;
}

static int dev_acquisition_stop(struct sr_dev_inst *sdi)
{
	if (sdi->status != SR_ST_ACTIVE)
		return SR_ERR_DEV_CLOSED;

	/* Signal USB transfer handler to clean up and stop. */
	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 = NULL,
	.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,
	.context = NULL,
};
SR_REGISTER_DEV_DRIVER(uni_t_ut32x_driver_info);
Commit	Line	Data
3877dde4 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
6ec6c43b	20	#include <config.h>
6513f97f	21	#include <string.h>
515ab088	22	#include "protocol.h"
6513f97f	23
f254bc4b	24	static const uint32_t devopts[] = {
6513f97f	25	SR_CONF_THERMOMETER,
6513f97f	26	SR_CONF_CONTINUOUS,
5827f61b BV	27	SR_CONF_LIMIT_SAMPLES \| SR_CONF_GET \| SR_CONF_SET,
5827f61b BV	28	SR_CONF_DATA_SOURCE \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
6513f97f BV	29	};
6513f97f BV	30
0f34cb47 UH	31	static const char *channel_names[] = {
0f34cb47 UH	32	"T1", "T2", "T1-T2",
6513f97f BV	33	};
	34
	35	static const char *data_sources[] = {
	36	"Live",
	37	"Memory",
	38	};
	39
4f840ce9	40	static GSList scan(struct sr_dev_driver di, GSList *options)
3877dde4 BV	41	{
3877dde4 BV	42	struct drv_context *drvc;
6513f97f BV	43	struct dev_context *devc;
6513f97f BV	44	struct sr_dev_inst *sdi;
6513f97f BV	45	struct sr_config *src;
6513f97f BV	46	GSList usb_devices, devices, *l;
07ffa5b3	47	unsigned int i;
6513f97f	48	const char *conn;
3877dde4	49
41812aca	50	drvc = di->context;
3877dde4	51
6513f97f BV	52	conn = NULL;
	53	for (l = options; l; l = l->next) {
	54	src = l->data;
	55	switch (src->key) {
	56	case SR_CONF_CONN:
	57	conn = g_variant_get_string(src->data, NULL);
	58	break;
	59	}
	60	}
	61	if (!conn)
	62	return NULL;
	63
	64	devices = NULL;
e196cb61	65	if ((usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn))) {
6513f97f BV	66	/* We have a list of sr_usb_dev_inst matching the connection
	67	* string. Wrap them in sr_dev_inst and we're done. */
	68	for (l = usb_devices; l; l = l->next) {
aac29cc1	69	sdi = g_malloc0(sizeof(struct sr_dev_inst));
0af636be UH	70	sdi->status = SR_ST_INACTIVE;
	71	sdi->vendor = g_strdup(VENDOR);
	72	sdi->model = g_strdup(MODEL);
6513f97f BV	73	sdi->driver = di;
	74	sdi->inst_type = SR_INST_USB;
	75	sdi->conn = l->data;
07ffa5b3	76	for (i = 0; i < ARRAY_SIZE(channel_names); i++)
0f34cb47 UH	77	sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, TRUE,
0f34cb47 UH	78	channel_names[i]);
f57d8ffe	79	devc = g_malloc0(sizeof(struct dev_context));
6513f97f BV	80	sdi->priv = devc;
	81	devc->limit_samples = 0;
	82	devc->data_source = DEFAULT_DATA_SOURCE;
	83	drvc->instances = g_slist_append(drvc->instances, sdi);
	84	devices = g_slist_append(devices, sdi);
	85	}
	86	g_slist_free(usb_devices);
	87	} else
	88	g_slist_free_full(usb_devices, g_free);
3877dde4 BV	89
	90	return devices;
	91	}
	92
3877dde4 BV	93	static int dev_open(struct sr_dev_inst *sdi)
3877dde4 BV	94	{
4f840ce9	95	struct sr_dev_driver *di = sdi->driver;
efa98402	96	struct drv_context *drvc = di->context;
6513f97f BV	97	struct sr_usb_dev_inst *usb;
	98	int ret;
	99
6513f97f BV	100	usb = sdi->conn;
	101
	102	if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
	103	return SR_ERR;
	104
	105	/*
f3f19d11	106	* The libusb 1.0.9 Darwin backend is broken: it can report a kernel
6513f97f BV	107	* driver being active, but detaching it always returns an error.
	108	*/
	109	#if !defined(__APPLE__)
d6ff054a BV	110	if (libusb_kernel_driver_active(usb->devhdl, USB_INTERFACE) == 1) {
d6ff054a BV	111	if ((ret = libusb_detach_kernel_driver(usb->devhdl, USB_INTERFACE)) < 0) {
6513f97f BV	112	sr_err("failed to detach kernel driver: %s",
	113	libusb_error_name(ret));
	114	return SR_ERR;
	115	}
	116	}
	117	#endif
3877dde4	118
d6ff054a	119	if ((ret = libusb_set_configuration(usb->devhdl, USB_CONFIGURATION))) {
6513f97f BV	120	sr_err("Failed to set configuration: %s.", libusb_error_name(ret));
	121	return SR_ERR;
	122	}
3877dde4	123
6513f97f BV	124	if ((ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE))) {
	125	sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
	126	return SR_ERR;
	127	}
3877dde4 BV	128	sdi->status = SR_ST_ACTIVE;
3877dde4 BV	129
6513f97f	130	return ret;
3877dde4 BV	131	}
	132
	133	static int dev_close(struct sr_dev_inst *sdi)
	134	{
6513f97f	135	struct sr_usb_dev_inst *usb;
3877dde4	136
6513f97f BV	137	usb = sdi->conn;
	138	if (!usb->devhdl)
	139	/* Nothing to do. */
	140	return SR_OK;
3877dde4	141
6513f97f BV	142	libusb_release_interface(usb->devhdl, USB_INTERFACE);
	143	libusb_close(usb->devhdl);
	144	usb->devhdl = NULL;
3877dde4 BV	145	sdi->status = SR_ST_INACTIVE;
	146
	147	return SR_OK;
	148	}
	149
584560f1	150	static int config_get(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
53b4680f	151	const struct sr_channel_group *cg)
3877dde4	152	{
6513f97f	153	struct dev_context *devc;
3877dde4	154
53b4680f	155	(void)cg;
d3c74a6f	156
6513f97f	157	devc = sdi->priv;
3877dde4	158	switch (key) {
6513f97f BV	159	case SR_CONF_LIMIT_SAMPLES:
	160	*data = g_variant_new_uint64(devc->limit_samples);
	161	break;
	162	case SR_CONF_DATA_SOURCE:
	163	if (devc->data_source == DATA_SOURCE_LIVE)
	164	*data = g_variant_new_string("Live");
	165	else
	166	*data = g_variant_new_string("Memory");
	167	break;
3877dde4 BV	168	default:
	169	return SR_ERR_NA;
	170	}
	171
6513f97f	172	return SR_OK;
3877dde4 BV	173	}
3877dde4 BV	174
584560f1	175	static int config_set(uint32_t key, GVariant data, const struct sr_dev_inst sdi,
53b4680f	176	const struct sr_channel_group *cg)
3877dde4	177	{
6513f97f	178	struct dev_context *devc;
6513f97f	179	const char *tmp_str;
3877dde4	180
53b4680f	181	(void)cg;
d3c74a6f	182
3877dde4 BV	183	if (sdi->status != SR_ST_ACTIVE)
	184	return SR_ERR_DEV_CLOSED;
	185
6513f97f	186	devc = sdi->priv;
dcd438ee	187
3877dde4	188	switch (key) {
6513f97f BV	189	case SR_CONF_LIMIT_SAMPLES:
6513f97f BV	190	devc->limit_samples = g_variant_get_uint64(data);
6513f97f BV	191	break;
	192	case SR_CONF_DATA_SOURCE:
	193	tmp_str = g_variant_get_string(data, NULL);
	194	if (!strcmp(tmp_str, "Live"))
	195	devc->data_source = DATA_SOURCE_LIVE;
	196	else if (!strcmp(tmp_str, "Memory"))
	197	devc->data_source = DATA_SOURCE_MEMORY;
	198	else
	199	return SR_ERR;
	200	break;
3877dde4	201	default:
dcd438ee	202	return SR_ERR_NA;
3877dde4 BV	203	}
3877dde4 BV	204
dcd438ee	205	return SR_OK;
3877dde4 BV	206	}
3877dde4 BV	207
584560f1	208	static int config_list(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
53b4680f	209	const struct sr_channel_group *cg)
3877dde4	210	{
3877dde4	211	(void)sdi;
53b4680f	212	(void)cg;
3877dde4	213
3877dde4	214	switch (key) {
6513f97f	215	case SR_CONF_DEVICE_OPTIONS:
584560f1	216	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
f254bc4b	217	devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
6513f97f BV	218	break;
	219	case SR_CONF_DATA_SOURCE:
	220	*data = g_variant_new_strv(data_sources, ARRAY_SIZE(data_sources));
	221	break;
3877dde4 BV	222	default:
	223	return SR_ERR_NA;
	224	}
	225
6513f97f	226	return SR_OK;
3877dde4 BV	227	}
3877dde4 BV	228
695dc859	229	static int dev_acquisition_start(const struct sr_dev_inst *sdi)
3877dde4	230	{
4f840ce9	231	struct sr_dev_driver *di = sdi->driver;
6513f97f BV	232	struct drv_context *drvc;
	233	struct dev_context *devc;
	234	struct sr_usb_dev_inst *usb;
6c60facc	235	int len, ret;
6513f97f	236	unsigned char cmd[2];
3877dde4 BV	237
	238	if (sdi->status != SR_ST_ACTIVE)
	239	return SR_ERR_DEV_CLOSED;
	240
41812aca	241	drvc = di->context;
6513f97f BV	242	devc = sdi->priv;
	243	usb = sdi->conn;
	244
6513f97f	245	devc->num_samples = 0;
d6ff054a BV	246	devc->packet_len = 0;
	247
	248	/* Configure serial port parameters on USB-UART interface
	249	* chip inside the device (just baudrate 2400 actually). */
	250	cmd[0] = 0x09;
	251	cmd[1] = 0x60;
	252	ret = libusb_control_transfer(usb->devhdl, 0x21, 0x09, 0x0300, 0x00,
	253	cmd, 2, 5);
	254	if (ret != 2) {
	255	sr_dbg("Failed to configure CH9325: %s", libusb_error_name(ret));
	256	return SR_ERR;
	257	}
6513f97f	258
695dc859	259	std_session_send_df_header(sdi, LOG_PREFIX);
6513f97f BV	260
	261	if (!(devc->xfer = libusb_alloc_transfer(0)))
	262	return SR_ERR;
	263
6513f97f BV	264	/* Length of payload to follow. */
	265	cmd[0] = 0x01;
	266	if (devc->data_source == DATA_SOURCE_LIVE)
	267	cmd[1] = CMD_GET_LIVE;
	268	else
	269	cmd[1] = CMD_GET_STORED;
	270
	271	ret = libusb_bulk_transfer(usb->devhdl, EP_OUT, cmd, 2, &len, 5);
	272	if (ret != 0 \|\| len != 2) {
	273	sr_dbg("Failed to start acquisition: %s", libusb_error_name(ret));
	274	libusb_free_transfer(devc->xfer);
	275	return SR_ERR;
	276	}
	277
	278	libusb_fill_bulk_transfer(devc->xfer, usb->devhdl, EP_IN, devc->buf,
d6ff054a	279	8, uni_t_ut32x_receive_transfer, (void *)sdi, 15);
6513f97f BV	280	if (libusb_submit_transfer(devc->xfer) != 0) {
	281	libusb_free_transfer(devc->xfer);
	282	return SR_ERR;
	283	}
3877dde4	284
102f1239 BV	285	usb_source_add(sdi->session, drvc->sr_ctx, 10,
102f1239 BV	286	uni_t_ut32x_handle_events, (void *)sdi);
d6ff054a	287
3877dde4 BV	288	return SR_OK;
	289	}
	290
695dc859	291	static int dev_acquisition_stop(struct sr_dev_inst *sdi)
3877dde4	292	{
3877dde4 BV	293	if (sdi->status != SR_ST_ACTIVE)
	294	return SR_ERR_DEV_CLOSED;
	295
d6ff054a BV	296	/* Signal USB transfer handler to clean up and stop. */
d6ff054a BV	297	sdi->status = SR_ST_STOPPING;
3877dde4 BV	298
	299	return SR_OK;
	300	}
	301
dd5c48a6	302	static struct sr_dev_driver uni_t_ut32x_driver_info = {
3877dde4 BV	303	.name = "uni-t-ut32x",
	304	.longname = "UNI-T UT32x",
	305	.api_version = 1,
c2fdcc25	306	.init = std_init,
700d6b64	307	.cleanup = std_cleanup,
3877dde4	308	.scan = scan,
c01bf34c	309	.dev_list = std_dev_list,
a6630742	310	.dev_clear = NULL,
3877dde4 BV	311	.config_get = config_get,
	312	.config_set = config_set,
	313	.config_list = config_list,
	314	.dev_open = dev_open,
	315	.dev_close = dev_close,
	316	.dev_acquisition_start = dev_acquisition_start,
	317	.dev_acquisition_stop = dev_acquisition_stop,
41812aca	318	.context = NULL,
3877dde4	319	};
dd5c48a6	320	SR_REGISTER_DEV_DRIVER(uni_t_ut32x_driver_info);