[libsigrok.git] / src / hardware / lascar-el-usb / api.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2012 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 <glib.h>
#include <libusb.h>
#include <libsigrok/libsigrok.h>
#include "libsigrok-internal.h"
#include "protocol.h"

SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info;

static const uint32_t scanopts[] = {
	SR_CONF_CONN,
};

static const uint32_t devopts[] = {
	SR_CONF_THERMOMETER,
	SR_CONF_HYGROMETER,
	SR_CONF_CONN | SR_CONF_GET,
	SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
	SR_CONF_DATALOG | SR_CONF_GET | SR_CONF_SET,
};

static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
{
	return std_init(sr_ctx, di, LOG_PREFIX);
}

static GSList *scan(struct sr_dev_driver *di, GSList *options)
{
	struct drv_context *drvc;
	struct sr_dev_inst *sdi;
	struct sr_usb_dev_inst *usb;
	struct sr_config *src;
	GSList *usb_devices, *devices, *l;
	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) {
			usb = l->data;
			if (!(sdi = lascar_scan(usb->bus, usb->address))) {
				/* Not a Lascar EL-USB. */
				g_free(usb);
				continue;
			}
			sdi->inst_type = SR_INST_USB;
			sdi->conn = usb;
			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 GSList *dev_list(const struct sr_dev_driver *di)
{
	return ((struct drv_context *)(di->context))->instances;
}

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

	if (!(drvc = di->context)) {
		sr_err("Driver was not initialized.");
		return SR_ERR;
	}

	usb = sdi->conn;

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

	if ((ret = libusb_claim_interface(usb->devhdl, LASCAR_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_dev_driver *di = sdi->driver;
	struct sr_usb_dev_inst *usb;

	if (!di->context) {
		sr_err("Driver was not initialized.");
		return SR_ERR;
	}

	usb = sdi->conn;

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

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

	return SR_OK;
}

static int cleanup(const struct sr_dev_driver *di)
{
	int ret;
	struct drv_context *drvc;

	if (!(drvc = di->context))
		/* Can get called on an unused driver, doesn't matter. */
		return SR_OK;

	ret = std_dev_clear(di, NULL);
	g_free(drvc);

	return ret;
}

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;
	struct sr_usb_dev_inst *usb;
	int ret;
	char str[128];

	(void)cg;

	devc = sdi->priv;
	switch (key) {
	case SR_CONF_CONN:
		if (!sdi || !sdi->conn)
			return SR_ERR_ARG;
		usb = sdi->conn;
		snprintf(str, 128, "%d.%d", usb->bus, usb->address);
		*data = g_variant_new_string(str);
		break;
	case SR_CONF_DATALOG:
		if (!sdi)
			return SR_ERR_ARG;
		if ((ret = lascar_is_logging(sdi)) == -1)
			return SR_ERR;
		*data = g_variant_new_boolean(ret ? TRUE : FALSE);
		break;
	case SR_CONF_LIMIT_SAMPLES:
		*data = g_variant_new_uint64(devc->limit_samples);
		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 sr_dev_driver *di = sdi->driver;
	struct dev_context *devc;
	int ret;

	(void)cg;

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

	if (!di->context) {
		sr_err("Driver was not initialized.");
		return SR_ERR;
	}

	devc = sdi->priv;
	ret = SR_OK;
	switch (key) {
	case SR_CONF_DATALOG:
		if (g_variant_get_boolean(data))
			ret = lascar_start_logging(sdi);
		else
			ret = lascar_stop_logging(sdi);
		break;
	case SR_CONF_LIMIT_SAMPLES:
		devc->limit_samples = g_variant_get_uint64(data);
		break;
	default:
		ret = SR_ERR_NA;
	}

	return ret;
}

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_SCAN_OPTIONS:
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
				scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
		break;
	case SR_CONF_DEVICE_OPTIONS:
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
				devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

static void LIBUSB_CALL mark_xfer(struct libusb_transfer *xfer)
{

	if (xfer->status == LIBUSB_TRANSFER_COMPLETED)
		xfer->user_data = GINT_TO_POINTER(1);
	else
		xfer->user_data = GINT_TO_POINTER(-1);

}

/* The Lascar software, in its infinite ignorance, reads a set of four
 * bytes from the device config struct and interprets it as a float.
 * That only works because they only use windows, and only on x86. However
 * we may be running on any architecture, any operating system. So we have
 * to convert these four bytes as the Lascar software would on windows/x86,
 * to the local representation of a float.
 * The source format is little-endian, with IEEE 754-2008 BINARY32 encoding. */
static float binary32_le_to_float(unsigned char *buf)
{
	GFloatIEEE754 f;

	f.v_float = 0;
	f.mpn.sign = (buf[3] & 0x80) ? 1 : 0;
	f.mpn.biased_exponent = (buf[3] << 1) | (buf[2] >> 7);
	f.mpn.mantissa = buf[0] | (buf[1] << 8) | ((buf[2] & 0x7f) << 16);

	return f.v_float;
}

static int lascar_proc_config(const struct sr_dev_inst *sdi)
{
	struct dev_context *devc;
	struct sr_usb_dev_inst *usb;
	int dummy, ret;

	devc = sdi->priv;
	usb = sdi->conn;

	if (lascar_get_config(usb->devhdl, devc->config, &dummy) != SR_OK)
		return SR_ERR;

	ret = SR_OK;
	switch (devc->profile->logformat) {
	case LOG_TEMP_RH:
		devc->sample_size = 2;
		devc->temp_unit = devc->config[0x2e] | (devc->config[0x2f] << 8);
		if (devc->temp_unit != 0 && devc->temp_unit != 1) {
			sr_dbg("invalid temperature unit %d", devc->temp_unit);
			/* Default to Celsius, we're all adults here. */
			devc->temp_unit = 0;
		} else
			sr_dbg("temperature unit is %s", devc->temp_unit
					? "Fahrenheit" : "Celsius");
		break;
	case LOG_CO:
		devc->sample_size = 2;
		devc->co_high = binary32_le_to_float(devc->config + 0x24);
		devc->co_low = binary32_le_to_float(devc->config + 0x28);
		sr_dbg("EL-USB-CO calibration high %f low %f", devc->co_high,
				devc->co_low);
		break;
	default:
		ret = SR_ERR_ARG;
	}
	devc->logged_samples = devc->config[0x1e] | (devc->config[0x1f] << 8);
	sr_dbg("device log contains %d samples.", devc->logged_samples);

	return ret;
}

static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
{
	struct sr_dev_driver *di = sdi->driver;
	struct sr_datafeed_packet packet;
	struct sr_datafeed_meta meta;
	struct sr_config *src;
	struct dev_context *devc;
	struct drv_context *drvc;
	struct sr_usb_dev_inst *usb;
	struct libusb_transfer *xfer_in, *xfer_out;
	struct timeval tv;
	uint64_t interval;
	int ret;
	unsigned char cmd[3], resp[4], *buf;

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

	if (!di->context) {
		sr_err("Driver was not initialized.");
		return SR_ERR;
	}

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

	if (lascar_proc_config(sdi) != SR_OK)
		return SR_ERR;

	sr_dbg("Starting log retrieval.");

	std_session_send_df_header(cb_data, LOG_PREFIX);

	interval = (devc->config[0x1c] | (devc->config[0x1d] << 8)) * 1000;
	packet.type = SR_DF_META;
	packet.payload = &meta;
	src = sr_config_new(SR_CONF_SAMPLE_INTERVAL, g_variant_new_uint64(interval));
	meta.config = g_slist_append(NULL, src);
	sr_session_send(devc->cb_data, &packet);
	g_free(src);

	if (devc->logged_samples == 0) {
		/* This ensures the frontend knows the session is done. */
		std_session_send_df_end(devc->cb_data, LOG_PREFIX);
		return SR_OK;
	}

	if (!(xfer_in = libusb_alloc_transfer(0)) ||
			!(xfer_out = libusb_alloc_transfer(0)))
		return SR_ERR;

	libusb_control_transfer(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR,
			0x00, 0xffff, 0x00, NULL, 0, 50);
	libusb_control_transfer(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR,
			0x02, 0x0002, 0x00, NULL, 0, 50);
	libusb_control_transfer(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR,
			0x02, 0x0001, 0x00, NULL, 0, 50);

	/* Flush input. The F321 requires this. */
	while (libusb_bulk_transfer(usb->devhdl, LASCAR_EP_IN, resp,
			256, &ret, 5) == 0 && ret > 0)
		;

	libusb_fill_bulk_transfer(xfer_in, usb->devhdl, LASCAR_EP_IN,
			resp, sizeof(resp), mark_xfer, 0, BULK_XFER_TIMEOUT);
	if (libusb_submit_transfer(xfer_in) != 0) {
		libusb_free_transfer(xfer_in);
		libusb_free_transfer(xfer_out);
		return SR_ERR;
	}

	cmd[0] = 0x03;
	cmd[1] = 0xff;
	cmd[2] = 0xff;
	libusb_fill_bulk_transfer(xfer_out, usb->devhdl, LASCAR_EP_OUT,
			cmd, 3, mark_xfer, 0, 100);
	if (libusb_submit_transfer(xfer_out) != 0) {
		libusb_free_transfer(xfer_in);
		libusb_free_transfer(xfer_out);
		return SR_ERR;
	}

	tv.tv_sec = 0;
	tv.tv_usec = 0;
	while (!xfer_in->user_data || !xfer_out->user_data) {
		g_usleep(SLEEP_US_LONG);
		libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
	}
	if (xfer_in->user_data != GINT_TO_POINTER(1) ||
			xfer_out->user_data != GINT_TO_POINTER(1)) {
		sr_dbg("no response to log transfer request");
		libusb_free_transfer(xfer_in);
		libusb_free_transfer(xfer_out);
		return SR_ERR;
	}
	if (xfer_in->actual_length != 3 || xfer_in->buffer[0] != 2) {
		sr_dbg("invalid response to log transfer request");
		libusb_free_transfer(xfer_in);
		libusb_free_transfer(xfer_out);
		return SR_ERR;
	}
	devc->log_size = xfer_in->buffer[1] + (xfer_in->buffer[2] << 8);
	libusb_free_transfer(xfer_out);

	usb_source_add(sdi->session, drvc->sr_ctx, 100,
			lascar_el_usb_handle_events, (void *)sdi);

	buf = g_malloc(4096);
	libusb_fill_bulk_transfer(xfer_in, usb->devhdl, LASCAR_EP_IN,
			buf, 4096, lascar_el_usb_receive_transfer, cb_data, 100);
	if ((ret = libusb_submit_transfer(xfer_in) != 0)) {
		sr_err("Unable to submit transfer: %s.", libusb_error_name(ret));
		libusb_free_transfer(xfer_in);
		g_free(buf);
		return SR_ERR;
	}

	return SR_OK;
}

SR_PRIV int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
{
	struct sr_dev_driver *di = sdi->driver;
	(void)cb_data;

	if (!di->context) {
		sr_err("Driver was not initialized.");
		return SR_ERR;
	}

	if (sdi->status != SR_ST_ACTIVE) {
		sr_err("Device inactive, can't stop acquisition.");
		return SR_ERR;
	}

	sdi->status = SR_ST_STOPPING;
	/* TODO: free ongoing transfers? */

	return SR_OK;
}

SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info = {
	.name = "lascar-el-usb",
	.longname = "Lascar EL-USB",
	.api_version = 1,
	.init = init,
	.cleanup = cleanup,
	.scan = scan,
	.dev_list = 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
46697e38 BV	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2012 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>
46697e38	21	#include <glib.h>
851d5b22	22	#include <libusb.h>
c1aae900	23	#include <libsigrok/libsigrok.h>
46697e38 BV	24	#include "libsigrok-internal.h"
	25	#include "protocol.h"
	26
	27	SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info;
851d5b22	28
a0e0bb41	29	static const uint32_t scanopts[] = {
1953564a	30	SR_CONF_CONN,
851d5b22 BV	31	};
851d5b22 BV	32
f254bc4b	33	static const uint32_t devopts[] = {
1953564a BV	34	SR_CONF_THERMOMETER,
1953564a BV	35	SR_CONF_HYGROMETER,
5827f61b BV	36	SR_CONF_CONN \| SR_CONF_GET,
	37	SR_CONF_LIMIT_SAMPLES \| SR_CONF_GET \| SR_CONF_SET,
	38	SR_CONF_DATALOG \| SR_CONF_GET \| SR_CONF_SET,
851d5b22 BV	39	};
851d5b22 BV	40
4f840ce9	41	static int init(struct sr_dev_driver di, struct sr_context sr_ctx)
46697e38	42	{
f6beaac5	43	return std_init(sr_ctx, di, LOG_PREFIX);
46697e38 BV	44	}
46697e38 BV	45
4f840ce9	46	static GSList scan(struct sr_dev_driver di, GSList *options)
46697e38 BV	47	{
46697e38 BV	48	struct drv_context *drvc;
851d5b22 BV	49	struct sr_dev_inst *sdi;
851d5b22 BV	50	struct sr_usb_dev_inst *usb;
1987b8d6	51	struct sr_config *src;
851d5b22 BV	52	GSList usb_devices, devices, *l;
851d5b22 BV	53	const char *conn;
46697e38	54
41812aca	55	drvc = di->context;
46697e38	56
851d5b22 BV	57	conn = NULL;
851d5b22 BV	58	for (l = options; l; l = l->next) {
1987b8d6 BV	59	src = l->data;
1987b8d6 BV	60	switch (src->key) {
1953564a	61	case SR_CONF_CONN:
7faf69da	62	conn = g_variant_get_string(src->data, NULL);
851d5b22 BV	63	break;
	64	}
	65	}
	66	if (!conn)
	67	return NULL;
	68
	69	devices = NULL;
	70	if ((usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn))) {
	71	/* We have a list of sr_usb_dev_inst matching the connection
	72	* string. Wrap them in sr_dev_inst and we're done. */
	73	for (l = usb_devices; l; l = l->next) {
	74	usb = l->data;
	75	if (!(sdi = lascar_scan(usb->bus, usb->address))) {
	76	/* Not a Lascar EL-USB. */
	77	g_free(usb);
	78	continue;
	79	}
0f150649 BV	80	sdi->inst_type = SR_INST_USB;
0f150649 BV	81	sdi->conn = usb;
851d5b22 BV	82	drvc->instances = g_slist_append(drvc->instances, sdi);
	83	devices = g_slist_append(devices, sdi);
	84	}
	85	g_slist_free(usb_devices);
	86	} else
	87	g_slist_free_full(usb_devices, g_free);
46697e38 BV	88
	89	return devices;
	90	}
	91
4f840ce9	92	static GSList dev_list(const struct sr_dev_driver di)
46697e38	93	{
41812aca	94	return ((struct drv_context *)(di->context))->instances;
46697e38 BV	95	}
46697e38 BV	96
6078d2c9	97	static int dev_open(struct sr_dev_inst *sdi)
46697e38	98	{
4f840ce9	99	struct sr_dev_driver *di = sdi->driver;
6aa1eb4e	100	struct drv_context *drvc;
0f150649	101	struct sr_usb_dev_inst *usb;
6aa1eb4e	102	int ret;
46697e38	103
41812aca	104	if (!(drvc = di->context)) {
6aa1eb4e BV	105	sr_err("Driver was not initialized.");
	106	return SR_ERR;
	107	}
	108
0f150649 BV	109	usb = sdi->conn;
	110
	111	if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
6aa1eb4e BV	112	return SR_ERR;
6aa1eb4e BV	113
0f150649	114	if ((ret = libusb_claim_interface(usb->devhdl, LASCAR_INTERFACE))) {
6aa1eb4e BV	115	sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
	116	return SR_ERR;
	117	}
	118	sdi->status = SR_ST_ACTIVE;
	119
	120	return ret;
46697e38 BV	121	}
46697e38 BV	122
6078d2c9	123	static int dev_close(struct sr_dev_inst *sdi)
46697e38	124	{
4f840ce9	125	struct sr_dev_driver *di = sdi->driver;
0f150649	126	struct sr_usb_dev_inst *usb;
6aa1eb4e	127
41812aca	128	if (!di->context) {
6aa1eb4e BV	129	sr_err("Driver was not initialized.");
	130	return SR_ERR;
	131	}
	132
0f150649 BV	133	usb = sdi->conn;
	134
	135	if (!usb->devhdl)
6aa1eb4e BV	136	/* Nothing to do. */
	137	return SR_OK;
	138
0f150649 BV	139	libusb_release_interface(usb->devhdl, LASCAR_INTERFACE);
	140	libusb_close(usb->devhdl);
	141	usb->devhdl = NULL;
6aa1eb4e BV	142	sdi->status = SR_ST_INACTIVE;
6aa1eb4e BV	143
46697e38 BV	144	return SR_OK;
	145	}
	146
4f840ce9	147	static int cleanup(const struct sr_dev_driver *di)
46697e38	148	{
c9d622a4	149	int ret;
6aa1eb4e	150	struct drv_context *drvc;
46697e38	151
41812aca	152	if (!(drvc = di->context))
6aa1eb4e BV	153	/* Can get called on an unused driver, doesn't matter. */
	154	return SR_OK;
	155
a6630742	156	ret = std_dev_clear(di, NULL);
6aa1eb4e	157	g_free(drvc);
46697e38	158
c9d622a4	159	return ret;
46697e38 BV	160	}
46697e38 BV	161
584560f1	162	static int config_get(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
53b4680f	163	const struct sr_channel_group *cg)
361d1511 BV	164	{
361d1511 BV	165	struct dev_context *devc;
0f150649	166	struct sr_usb_dev_inst *usb;
361d1511	167	int ret;
0f150649	168	char str[128];
361d1511	169
53b4680f	170	(void)cg;
8f996b89	171
361d1511	172	devc = sdi->priv;
584560f1	173	switch (key) {
0f150649 BV	174	case SR_CONF_CONN:
	175	if (!sdi \|\| !sdi->conn)
	176	return SR_ERR_ARG;
	177	usb = sdi->conn;
	178	snprintf(str, 128, "%d.%d", usb->bus, usb->address);
	179	*data = g_variant_new_string(str);
	180	break;
361d1511 BV	181	case SR_CONF_DATALOG:
	182	if (!sdi)
	183	return SR_ERR_ARG;
	184	if ((ret = lascar_is_logging(sdi)) == -1)
	185	return SR_ERR;
7faf69da	186	*data = g_variant_new_boolean(ret ? TRUE : FALSE);
361d1511 BV	187	break;
361d1511 BV	188	case SR_CONF_LIMIT_SAMPLES:
7faf69da	189	*data = g_variant_new_uint64(devc->limit_samples);
361d1511 BV	190	break;
361d1511 BV	191	default:
bd6fbf62	192	return SR_ERR_NA;
361d1511 BV	193	}
	194
	195	return SR_OK;
	196	}
	197
584560f1	198	static int config_set(uint32_t key, GVariant data, const struct sr_dev_inst sdi,
53b4680f	199	const struct sr_channel_group *cg)
46697e38	200	{
4f840ce9	201	struct sr_dev_driver *di = sdi->driver;
6aa1eb4e	202	struct dev_context *devc;
46697e38 BV	203	int ret;
46697e38 BV	204
53b4680f	205	(void)cg;
8f996b89	206
e73ffd42 BV	207	if (sdi->status != SR_ST_ACTIVE)
	208	return SR_ERR_DEV_CLOSED;
	209
41812aca	210	if (!di->context) {
6aa1eb4e BV	211	sr_err("Driver was not initialized.");
	212	return SR_ERR;
	213	}
46697e38	214
6aa1eb4e	215	devc = sdi->priv;
46697e38	216	ret = SR_OK;
584560f1	217	switch (key) {
361d1511	218	case SR_CONF_DATALOG:
dcd438ee	219	if (g_variant_get_boolean(data))
361d1511	220	ret = lascar_start_logging(sdi);
dcd438ee	221	else
361d1511	222	ret = lascar_stop_logging(sdi);
361d1511	223	break;
1953564a	224	case SR_CONF_LIMIT_SAMPLES:
7faf69da	225	devc->limit_samples = g_variant_get_uint64(data);
6aa1eb4e	226	break;
46697e38	227	default:
bd6fbf62	228	ret = SR_ERR_NA;
46697e38 BV	229	}
	230
	231	return ret;
	232	}
	233
584560f1	234	static int config_list(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
53b4680f	235	const struct sr_channel_group *cg)
a1c743fc	236	{
a1c743fc	237	(void)sdi;
53b4680f	238	(void)cg;
a1c743fc BV	239
a1c743fc BV	240	switch (key) {
0d485e30	241	case SR_CONF_SCAN_OPTIONS:
584560f1	242	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
a0e0bb41	243	scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
0d485e30	244	break;
9a6517d1	245	case SR_CONF_DEVICE_OPTIONS:
584560f1	246	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
f254bc4b	247	devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
9a6517d1	248	break;
a1c743fc	249	default:
bd6fbf62	250	return SR_ERR_NA;
a1c743fc BV	251	}
	252
	253	return SR_OK;
	254	}
	255
55462b8b	256	static void LIBUSB_CALL mark_xfer(struct libusb_transfer *xfer)
6aa1eb4e BV	257	{
	258
	259	if (xfer->status == LIBUSB_TRANSFER_COMPLETED)
	260	xfer->user_data = GINT_TO_POINTER(1);
	261	else
	262	xfer->user_data = GINT_TO_POINTER(-1);
	263
	264	}
	265
	266	/* The Lascar software, in its infinite ignorance, reads a set of four
	267	* bytes from the device config struct and interprets it as a float.
	268	* That only works because they only use windows, and only on x86. However
	269	* we may be running on any architecture, any operating system. So we have
	270	* to convert these four bytes as the Lascar software would on windows/x86,
	271	* to the local representation of a float.
	272	* The source format is little-endian, with IEEE 754-2008 BINARY32 encoding. */
	273	static float binary32_le_to_float(unsigned char *buf)
	274	{
	275	GFloatIEEE754 f;
	276
	277	f.v_float = 0;
	278	f.mpn.sign = (buf[3] & 0x80) ? 1 : 0;
	279	f.mpn.biased_exponent = (buf[3] << 1) \| (buf[2] >> 7);
	280	f.mpn.mantissa = buf[0] \| (buf[1] << 8) \| ((buf[2] & 0x7f) << 16);
	281
	282	return f.v_float;
	283	}
	284
	285	static int lascar_proc_config(const struct sr_dev_inst *sdi)
	286	{
	287	struct dev_context *devc;
0f150649	288	struct sr_usb_dev_inst *usb;
361d1511	289	int dummy, ret;
6aa1eb4e BV	290
6aa1eb4e BV	291	devc = sdi->priv;
0f150649 BV	292	usb = sdi->conn;
	293
	294	if (lascar_get_config(usb->devhdl, devc->config, &dummy) != SR_OK)
6aa1eb4e BV	295	return SR_ERR;
	296
	297	ret = SR_OK;
	298	switch (devc->profile->logformat) {
	299	case LOG_TEMP_RH:
6787f404 BV	300	devc->sample_size = 2;
	301	devc->temp_unit = devc->config[0x2e] \| (devc->config[0x2f] << 8);
	302	if (devc->temp_unit != 0 && devc->temp_unit != 1) {
	303	sr_dbg("invalid temperature unit %d", devc->temp_unit);
f3f19d11	304	/* Default to Celsius, we're all adults here. */
6787f404 BV	305	devc->temp_unit = 0;
	306	} else
	307	sr_dbg("temperature unit is %s", devc->temp_unit
f3f19d11	308	? "Fahrenheit" : "Celsius");
6aa1eb4e BV	309	break;
	310	case LOG_CO:
	311	devc->sample_size = 2;
6787f404 BV	312	devc->co_high = binary32_le_to_float(devc->config + 0x24);
6787f404 BV	313	devc->co_low = binary32_le_to_float(devc->config + 0x28);
6aa1eb4e BV	314	sr_dbg("EL-USB-CO calibration high %f low %f", devc->co_high,
	315	devc->co_low);
	316	break;
	317	default:
	318	ret = SR_ERR_ARG;
	319	}
	320	devc->logged_samples = devc->config[0x1e] \| (devc->config[0x1f] << 8);
	321	sr_dbg("device log contains %d samples.", devc->logged_samples);
	322
	323	return ret;
	324	}
	325
6078d2c9	326	static int dev_acquisition_start(const struct sr_dev_inst sdi, void cb_data)
46697e38	327	{
4f840ce9	328	struct sr_dev_driver *di = sdi->driver;
6aa1eb4e	329	struct sr_datafeed_packet packet;
8e77bc20 BV	330	struct sr_datafeed_meta meta;
8e77bc20 BV	331	struct sr_config *src;
6aa1eb4e	332	struct dev_context *devc;
8e77bc20	333	struct drv_context *drvc;
0f150649	334	struct sr_usb_dev_inst *usb;
6aa1eb4e	335	struct libusb_transfer xfer_in, xfer_out;
6aa1eb4e	336	struct timeval tv;
8e77bc20	337	uint64_t interval;
6c60facc	338	int ret;
6aa1eb4e BV	339	unsigned char cmd[3], resp[4], *buf;
6aa1eb4e BV	340
e73ffd42 BV	341	if (sdi->status != SR_ST_ACTIVE)
	342	return SR_ERR_DEV_CLOSED;
	343
41812aca	344	if (!di->context) {
6aa1eb4e BV	345	sr_err("Driver was not initialized.");
	346	return SR_ERR;
	347	}
	348
41812aca	349	drvc = di->context;
6aa1eb4e	350	devc = sdi->priv;
0f150649	351	usb = sdi->conn;
6aa1eb4e BV	352	devc->cb_data = cb_data;
	353
	354	if (lascar_proc_config(sdi) != SR_OK)
	355	return SR_ERR;
	356
	357	sr_dbg("Starting log retrieval.");
	358
29a27196	359	std_session_send_df_header(cb_data, LOG_PREFIX);
6aa1eb4e	360
8e77bc20 BV	361	interval = (devc->config[0x1c] \| (devc->config[0x1d] << 8)) * 1000;
	362	packet.type = SR_DF_META;
	363	packet.payload = &meta;
7faf69da	364	src = sr_config_new(SR_CONF_SAMPLE_INTERVAL, g_variant_new_uint64(interval));
8e77bc20 BV	365	meta.config = g_slist_append(NULL, src);
	366	sr_session_send(devc->cb_data, &packet);
	367	g_free(src);
	368
6aa1eb4e BV	369	if (devc->logged_samples == 0) {
6aa1eb4e BV	370	/* This ensures the frontend knows the session is done. */
3be42bc2	371	std_session_send_df_end(devc->cb_data, LOG_PREFIX);
6aa1eb4e BV	372	return SR_OK;
	373	}
	374
	375	if (!(xfer_in = libusb_alloc_transfer(0)) \|\|
	376	!(xfer_out = libusb_alloc_transfer(0)))
	377	return SR_ERR;
	378
0f150649	379	libusb_control_transfer(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR,
6aa1eb4e	380	0x00, 0xffff, 0x00, NULL, 0, 50);
0f150649	381	libusb_control_transfer(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR,
6aa1eb4e	382	0x02, 0x0002, 0x00, NULL, 0, 50);
0f150649	383	libusb_control_transfer(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR,
6aa1eb4e BV	384	0x02, 0x0001, 0x00, NULL, 0, 50);
6aa1eb4e BV	385
6aa1eb4e	386	/* Flush input. The F321 requires this. */
0f150649	387	while (libusb_bulk_transfer(usb->devhdl, LASCAR_EP_IN, resp,
6aa1eb4e BV	388	256, &ret, 5) == 0 && ret > 0)
	389	;
	390
0f150649	391	libusb_fill_bulk_transfer(xfer_in, usb->devhdl, LASCAR_EP_IN,
1a46cc62	392	resp, sizeof(resp), mark_xfer, 0, BULK_XFER_TIMEOUT);
6aa1eb4e BV	393	if (libusb_submit_transfer(xfer_in) != 0) {
	394	libusb_free_transfer(xfer_in);
	395	libusb_free_transfer(xfer_out);
	396	return SR_ERR;
	397	}
	398
	399	cmd[0] = 0x03;
	400	cmd[1] = 0xff;
	401	cmd[2] = 0xff;
0f150649	402	libusb_fill_bulk_transfer(xfer_out, usb->devhdl, LASCAR_EP_OUT,
6aa1eb4e BV	403	cmd, 3, mark_xfer, 0, 100);
	404	if (libusb_submit_transfer(xfer_out) != 0) {
	405	libusb_free_transfer(xfer_in);
	406	libusb_free_transfer(xfer_out);
	407	return SR_ERR;
	408	}
	409
	410	tv.tv_sec = 0;
	411	tv.tv_usec = 0;
	412	while (!xfer_in->user_data \|\| !xfer_out->user_data) {
1a46cc62	413	g_usleep(SLEEP_US_LONG);
6aa1eb4e BV	414	libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
	415	}
	416	if (xfer_in->user_data != GINT_TO_POINTER(1) \|\|
9851d35b	417	xfer_out->user_data != GINT_TO_POINTER(1)) {
6aa1eb4e BV	418	sr_dbg("no response to log transfer request");
	419	libusb_free_transfer(xfer_in);
	420	libusb_free_transfer(xfer_out);
	421	return SR_ERR;
	422	}
	423	if (xfer_in->actual_length != 3 \|\| xfer_in->buffer[0] != 2) {
	424	sr_dbg("invalid response to log transfer request");
	425	libusb_free_transfer(xfer_in);
	426	libusb_free_transfer(xfer_out);
	427	return SR_ERR;
	428	}
	429	devc->log_size = xfer_in->buffer[1] + (xfer_in->buffer[2] << 8);
	430	libusb_free_transfer(xfer_out);
	431
102f1239 BV	432	usb_source_add(sdi->session, drvc->sr_ctx, 100,
102f1239 BV	433	lascar_el_usb_handle_events, (void *)sdi);
6aa1eb4e	434
a95f142e	435	buf = g_malloc(4096);
0f150649	436	libusb_fill_bulk_transfer(xfer_in, usb->devhdl, LASCAR_EP_IN,
6aa1eb4e BV	437	buf, 4096, lascar_el_usb_receive_transfer, cb_data, 100);
	438	if ((ret = libusb_submit_transfer(xfer_in) != 0)) {
	439	sr_err("Unable to submit transfer: %s.", libusb_error_name(ret));
	440	libusb_free_transfer(xfer_in);
	441	g_free(buf);
	442	return SR_ERR;
	443	}
46697e38 BV	444
	445	return SR_OK;
	446	}
	447
6078d2c9	448	SR_PRIV int dev_acquisition_stop(struct sr_dev_inst sdi, void cb_data)
46697e38	449	{
4f840ce9	450	struct sr_dev_driver *di = sdi->driver;
46697e38 BV	451	(void)cb_data;
46697e38 BV	452
41812aca	453	if (!di->context) {
6aa1eb4e BV	454	sr_err("Driver was not initialized.");
	455	return SR_ERR;
	456	}
	457
46697e38 BV	458	if (sdi->status != SR_ST_ACTIVE) {
	459	sr_err("Device inactive, can't stop acquisition.");
	460	return SR_ERR;
	461	}
	462
6aa1eb4e BV	463	sdi->status = SR_ST_STOPPING;
6aa1eb4e BV	464	/* TODO: free ongoing transfers? */
46697e38 BV	465
	466	return SR_OK;
	467	}
	468
	469	SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info = {
	470	.name = "lascar-el-usb",
	471	.longname = "Lascar EL-USB",
	472	.api_version = 1,
6078d2c9 UH	473	.init = init,
	474	.cleanup = cleanup,
	475	.scan = scan,
	476	.dev_list = dev_list,
a6630742	477	.dev_clear = NULL,
361d1511	478	.config_get = config_get,
035a1078	479	.config_set = config_set,
a1c743fc	480	.config_list = config_list,
6078d2c9 UH	481	.dev_open = dev_open,
	482	.dev_close = dev_close,
	483	.dev_acquisition_start = dev_acquisition_start,
	484	.dev_acquisition_stop = dev_acquisition_stop,
41812aca	485	.context = NULL,
46697e38	486	};