[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 <glib.h>
#include <libusb.h>
#include "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->priv;

	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->priv))->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->priv)) {
		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->priv) {
		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->priv))
		/* 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->priv) {
		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)) {
			/* Start logging. */
			ret = lascar_start_logging(sdi);
		} else {
			/* Stop logging. */
			ret = lascar_stop_logging(sdi);
		}
		break;
	case SR_CONF_LIMIT_SAMPLES:
		devc->limit_samples = g_variant_get_uint64(data);
		sr_dbg("Setting sample limit to %" PRIu64 ".",
		       devc->limit_samples);
		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 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 Celcius, we're all adults here. */
			devc->temp_unit = 0;
		} else
			sr_dbg("temperature unit is %s", devc->temp_unit
					? "Fahrenheit" : "Celcius");
		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->priv) {
		sr_err("Driver was not initialized.");
		return SR_ERR;
	}

	drvc = di->priv;
	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.");

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