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

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