[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 int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
{
	return std_init(di, sr_ctx);
}

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