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

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_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->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;
			devices = g_slist_append(devices, sdi);
		}
		g_slist_free(usb_devices);
	} else
		g_slist_free_full(usb_devices, g_free);

	return std_scan_complete(di, 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;
	}

	return SR_OK;
}

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

	usb = sdi->conn;

	if (!usb->devhdl)
		return SR_ERR_BUG;

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

	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;

	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)
{
	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(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];

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

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