[libsigrok.git] / 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_inst *lascar_scan(int bus, int address);
SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info;
static struct sr_dev_driver *di = &lascar_el_usb_driver_info;

static const int32_t hwopts[] = {
	SR_CONF_CONN,
};

static const int32_t hwcaps[] = {
	SR_CONF_THERMOMETER,
	SR_CONF_HYGROMETER,
	SR_CONF_DATALOG,
	SR_CONF_LIMIT_SAMPLES,
};

static int dev_clear(void)
{
	return std_dev_clear(di, NULL);
}

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

static GSList *scan(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(void)
{
	return ((struct drv_context *)(di->priv))->instances;
}

static int dev_open(struct sr_dev_inst *sdi)
{
	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_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(void)
{
	int ret;
	struct drv_context *drvc;

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

	ret = dev_clear();
	g_free(drvc);
	di->priv = NULL;

	return ret;
}

static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi)
{
	struct dev_context *devc;
	struct sr_usb_dev_inst *usb;
	int ret;
	char str[128];

	devc = sdi->priv;
	switch (id) {
	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(int id, GVariant *data, const struct sr_dev_inst *sdi)
{
	struct dev_context *devc;
	int ret;

	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 (id) {
	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(int key, GVariant **data, const struct sr_dev_inst *sdi)
{

	(void)sdi;

	switch (key) {
	case SR_CONF_SCAN_OPTIONS:
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
				hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
		break;
	case SR_CONF_DEVICE_OPTIONS:
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
				hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_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_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;
	const struct libusb_pollfd **pfd;
	struct timeval tv;
	uint64_t interval;
	int ret, i;
	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);

	pfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
	for (i = 0; pfd[i]; i++) {
		/* Handle USB events every 100ms, for decent latency. */
		sr_source_add(pfd[i]->fd, pfd[i]->events, 100,
				lascar_el_usb_handle_events, (void *)sdi);
		/* We'll need to remove this fd later. */
		devc->usbfd[i] = pfd[i]->fd;
	}
	devc->usbfd[i] = -1;

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