[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",
};

SR_PRIV struct sr_dev_driver uni_t_ut32x_driver_info;

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;
	drvc->instances = NULL;

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

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