[libsigrok.git] / src / hardware / lascar-el-usb / protocol.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 <stdlib.h>
#include <sys/time.h>
#include <string.h>
#include <math.h>
#include <glib.h>
#include <libsigrok/libsigrok.h>
#include "libsigrok-internal.h"
#include "protocol.h"

extern struct sr_dev_driver lascar_el_usb_driver_info;
struct sr_dev_driver *di = &lascar_el_usb_driver_info;

static const struct elusb_profile profiles[] = {
	{ 1, "EL-USB-1", LOG_UNSUPPORTED },
	{ 2, "EL-USB-1", LOG_UNSUPPORTED },
	{ 3, "EL-USB-2", LOG_TEMP_RH },
	{ 4, "EL-USB-3", LOG_UNSUPPORTED },
	{ 5, "EL-USB-4", LOG_UNSUPPORTED },
	{ 6, "EL-USB-3", LOG_UNSUPPORTED },
	{ 7, "EL-USB-4", LOG_UNSUPPORTED },
	{ 8, "EL-USB-LITE", LOG_UNSUPPORTED },
	{ 9, "EL-USB-CO", LOG_CO },
	{ 10, "EL-USB-TC", LOG_UNSUPPORTED },
	{ 11, "EL-USB-CO300", LOG_CO },
	{ 12, "EL-USB-2-LCD", LOG_TEMP_RH },
	{ 13, "EL-USB-2+", LOG_TEMP_RH },
	{ 14, "EL-USB-1-PRO", LOG_UNSUPPORTED },
	{ 15, "EL-USB-TC-LCD", LOG_UNSUPPORTED },
	{ 16, "EL-USB-2-LCD+", LOG_TEMP_RH },
	{ 17, "EL-USB-5", LOG_UNSUPPORTED },
	{ 18, "EL-USB-1-RCG", LOG_UNSUPPORTED },
	{ 19, "EL-USB-1-LCD", LOG_UNSUPPORTED },
	{ 20, "EL-OEM-3", LOG_UNSUPPORTED },
	{ 21, "EL-USB-1-LCD", LOG_UNSUPPORTED },
	ALL_ZERO
};

static libusb_device_handle *lascar_open(struct libusb_device *dev)
{
	libusb_device_handle *dev_hdl;
	int ret;

	if ((ret = libusb_open(dev, &dev_hdl)) != 0) {
		sr_dbg("failed to open device for scan: %s",
				libusb_error_name(ret));
		return NULL;
	}

	/* Some of these fail, but it needs doing -- some sort of mode
	 * setup for the SiLabs F32x. */
	libusb_control_transfer(dev_hdl, LIBUSB_REQUEST_TYPE_VENDOR,
			0x00, 0xffff, 0x00, NULL, 0, 50);
	libusb_control_transfer(dev_hdl, LIBUSB_REQUEST_TYPE_VENDOR,
			0x02, 0x0002, 0x00, NULL, 0, 50);
	libusb_control_transfer(dev_hdl, LIBUSB_REQUEST_TYPE_VENDOR,
			0x02, 0x0001, 0x00, NULL, 0, 50);

	return dev_hdl;
}

static void LIBUSB_CALL mark_xfer(struct libusb_transfer *xfer)
{

	xfer->user_data = GINT_TO_POINTER(1);

}

SR_PRIV int lascar_get_config(libusb_device_handle *dev_hdl,
		unsigned char *configblock, int *configlen)
{
	struct drv_context *drvc;
	struct libusb_transfer *xfer_in, *xfer_out;
	struct timeval tv;
	int64_t start;
	int buflen;
	unsigned char cmd[3], buf[MAX_CONFIGBLOCK_SIZE];

	sr_spew("Reading config block.");

	drvc = di->context;
	*configlen = 0;

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

	/* Flush anything the F321 still has queued. */
	while (libusb_bulk_transfer(dev_hdl, LASCAR_EP_IN, buf, 256, &buflen,
			5) == 0 && buflen > 0)
		;

	/* Keep a read request waiting in the wings, ready to pounce
	 * the moment the device sends something. */
	libusb_fill_bulk_transfer(xfer_in, dev_hdl, LASCAR_EP_IN,
			buf, 256, mark_xfer, 0, BULK_XFER_TIMEOUT);
	if (libusb_submit_transfer(xfer_in) != 0)
		goto cleanup;

	/* Request device configuration structure. */
	cmd[0] = 0x00;
	cmd[1] = 0xff;
	cmd[2] = 0xff;
	libusb_fill_bulk_transfer(xfer_out, dev_hdl, LASCAR_EP_OUT,
			cmd, 3, mark_xfer, 0, 100);
	if (libusb_submit_transfer(xfer_out) != 0)
		goto cleanup;

	tv.tv_sec = 0;
	tv.tv_usec = 0;
	start = g_get_monotonic_time();
	while (!xfer_in->user_data || !xfer_out->user_data) {
		if (g_get_monotonic_time() - start > SCAN_TIMEOUT) {
			start = 0;
			break;
		}
		g_usleep(SLEEP_US_LONG);
		libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
	}
	if (!start) {
		sr_dbg("no response");
		goto cleanup;
	}
	if (xfer_in->actual_length != 3) {
		sr_dbg("expected 3-byte header, got %d bytes", xfer_in->actual_length);
		goto cleanup;
	}

	/* Got configuration structure header. */
	sr_spew("Response to config request: 0x%.2x 0x%.2x 0x%.2x ",
			buf[0], buf[1], buf[2]);
	buflen = buf[1] | (buf[2] << 8);
	if (buf[0] != 0x02 || buflen > MAX_CONFIGBLOCK_SIZE) {
		sr_dbg("Invalid response to config request: "
				"0x%.2x 0x%.2x 0x%.2x ", buf[0], buf[1], buf[2]);
		libusb_close(dev_hdl);
		goto cleanup;
	}

	/* Get configuration structure. */
	xfer_in->length = buflen;
	xfer_in->user_data = 0;
	if (libusb_submit_transfer(xfer_in) != 0)
		goto cleanup;
	while (!xfer_in->user_data) {
		if (g_get_monotonic_time() - start > SCAN_TIMEOUT) {
			start = 0;
			break;
		}
		g_usleep(SLEEP_US_LONG);
		libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
	}
	if (!start) {
		sr_dbg("Timeout waiting for configuration structure.");
		goto cleanup;
	}
	if (xfer_in->actual_length != buflen) {
		sr_dbg("expected %d-byte structure, got %d bytes", buflen,
				xfer_in->actual_length);
		goto cleanup;
	}

	memcpy(configblock, buf, buflen);
	*configlen = buflen;

cleanup:
	if (!xfer_in->user_data || !xfer_out->user_data) {
		if (!xfer_in->user_data)
			libusb_cancel_transfer(xfer_in);
		if (!xfer_out->user_data)
			libusb_cancel_transfer(xfer_out);
		start = g_get_monotonic_time();
		while (!xfer_in->user_data || !xfer_out->user_data) {
			if (g_get_monotonic_time() - start > EVENTS_TIMEOUT)
				break;
			g_usleep(SLEEP_US_SHORT);
			libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
		}
	}
	libusb_free_transfer(xfer_in);
	libusb_free_transfer(xfer_out);

	return *configlen ? SR_OK : SR_ERR;
}

static int lascar_save_config(libusb_device_handle *dev_hdl,
		unsigned char *config, int configlen)
{
	struct drv_context *drvc;
	struct libusb_transfer *xfer_in, *xfer_out;
	struct timeval tv;
	int64_t start;
	int buflen, ret;
	unsigned char cmd[3], buf[256];

	sr_spew("Writing config block.");

	drvc = di->context;

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

	/* Flush anything the F321 still has queued. */
	while (libusb_bulk_transfer(dev_hdl, LASCAR_EP_IN, buf, 256, &buflen,
			5) == 0 && buflen > 0)
		;
	ret = SR_OK;

	/* Keep a read request waiting in the wings, ready to pounce
	 * the moment the device sends something. */
	libusb_fill_bulk_transfer(xfer_in, dev_hdl, LASCAR_EP_IN,
			buf, 256, mark_xfer, 0, BULK_XFER_TIMEOUT);
	if (libusb_submit_transfer(xfer_in) != 0) {
		ret = SR_ERR;
		goto cleanup;
	}

	/* Request device configuration structure. */
	cmd[0] = 0x01;
	cmd[1] = configlen & 0xff;
	cmd[2] = (configlen >> 8) & 0xff;
	libusb_fill_bulk_transfer(xfer_out, dev_hdl, LASCAR_EP_OUT,
			cmd, 3, mark_xfer, 0, 100);
	if (libusb_submit_transfer(xfer_out) != 0) {
		ret = SR_ERR;
		goto cleanup;
	}
	tv.tv_sec = 0;
	tv.tv_usec = 0;
	while (!xfer_out->user_data) {
		g_usleep(SLEEP_US_LONG);
		libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
	}

	libusb_fill_bulk_transfer(xfer_out, dev_hdl, LASCAR_EP_OUT,
			config, configlen, mark_xfer, 0, 100);
	if (libusb_submit_transfer(xfer_out) != 0) {
		ret = SR_ERR;
		goto cleanup;
	}
	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->actual_length != 1 || buf[0] != 0xff) {
		sr_dbg("unexpected response after transfer");
		ret = SR_ERR;
	}

cleanup:
	if (!xfer_in->user_data || !xfer_out->user_data) {
		if (!xfer_in->user_data)
			libusb_cancel_transfer(xfer_in);
		if (!xfer_out->user_data)
			libusb_cancel_transfer(xfer_out);
		start = g_get_monotonic_time();
		while (!xfer_in->user_data || !xfer_out->user_data) {
			if (g_get_monotonic_time() - start > EVENTS_TIMEOUT)
				break;
			g_usleep(SLEEP_US_SHORT);
			libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
		}
	}
	libusb_free_transfer(xfer_in);
	libusb_free_transfer(xfer_out);

	return ret;
}

static struct sr_dev_inst *lascar_identify(unsigned char *config)
{
	struct dev_context *devc;
	const struct elusb_profile *profile;
	struct sr_dev_inst *sdi;
	int modelid, i;
	char firmware[5];

	modelid = config[0];
	sdi = NULL;
	if (modelid) {
		profile = NULL;
		for (i = 0; profiles[i].modelid; i++) {
			if (profiles[i].modelid == modelid) {
				profile = &profiles[i];
				break;
			}
		}
		if (!profile) {
			sr_dbg("unknown EL-USB modelid %d", modelid);
			return NULL;
		}

		i = config[52] | (config[53] << 8);
		memcpy(firmware, config + 0x30, 4);
		firmware[4] = '\0';
		sr_dbg("found %s with firmware version %s serial %d",
				profile->modelname, firmware, i);

		if (profile->logformat == LOG_UNSUPPORTED) {
			sr_dbg("unsupported EL-USB logformat for %s", profile->modelname);
			return NULL;
		}

		sdi = g_malloc0(sizeof(struct sr_dev_inst));
		sdi->status = SR_ST_INACTIVE;
		sdi->vendor = g_strdup(LASCAR_VENDOR);
		sdi->model = g_strdup(profile->modelname);
		sdi->version = g_strdup(firmware);
		sdi->driver = di;

		if (profile->logformat == LOG_TEMP_RH) {
			/* Model this as two channels: temperature and humidity. */
			sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "Temp");
			sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "Hum");
		} else if (profile->logformat == LOG_CO) {
			sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "CO");
		} else {
			sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
		}

		devc = g_malloc0(sizeof(struct dev_context));
		sdi->priv = devc;
		devc->profile = profile;
	}

	return sdi;
}

SR_PRIV struct sr_dev_inst *lascar_scan(int bus, int address)
{
	struct drv_context *drvc;
	struct sr_dev_inst *sdi;
	struct libusb_device **devlist;
	libusb_device_handle *dev_hdl;
	int dummy, i;
	int ret;
	unsigned char config[MAX_CONFIGBLOCK_SIZE];

	drvc = di->context;
	sdi = NULL;

	ret = libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
	if (ret < 0)
		return NULL;

	for (i = 0; devlist[i]; i++) {
		if (libusb_get_bus_number(devlist[i]) != bus ||
				libusb_get_device_address(devlist[i]) != address)
			continue;

		if (!(dev_hdl = lascar_open(devlist[i])))
			continue;

		if (lascar_get_config(dev_hdl, config, &dummy) != SR_OK)
			continue;

		libusb_close(dev_hdl);
		sdi = lascar_identify(config);
	}
	libusb_free_device_list(devlist, 1);

	return sdi;
}

static void lascar_el_usb_dispatch(struct sr_dev_inst *sdi, unsigned char *buf,
		int buflen)
{
	struct dev_context *devc;
	struct sr_datafeed_packet packet;
	struct sr_datafeed_analog_old analog;
	struct sr_channel *ch;
	float *temp, *rh;
	uint16_t s;
	int samples, samples_left, i, j;

	devc = sdi->priv;

	samples = buflen / devc->sample_size;
	samples_left = devc->logged_samples - devc->rcvd_samples;
	if (samples_left < samples)
		samples = samples_left;
	switch (devc->profile->logformat) {
	case LOG_TEMP_RH:
		packet.type = SR_DF_ANALOG_OLD;
		packet.payload = &analog;
		analog.mqflags = 0;
		if (!(temp = g_try_malloc(sizeof(float) * samples)))
			break;
		if (!(rh = g_try_malloc(sizeof(float) * samples)))
			break;
		for (i = 0, j = 0; i < samples; i++) {
			/* Both Celsius and Fahrenheit stored at base -40. */
			if (devc->temp_unit == 0)
				/* Celsius is stored in half-degree increments. */
				temp[j] = buf[i * 2] / 2 - 40;
			else
				temp[j] = buf[i * 2] - 40;

			rh[j] = buf[i * 2 + 1] / 2;

			if (temp[j] == 0.0 && rh[j] == 0.0)
				/* Skip invalid measurement. */
				continue;
			j++;
		}
		analog.num_samples = j;

		ch = sdi->channels->data;
		if (ch->enabled) {
			analog.channels = g_slist_append(NULL, ch);
			analog.mq = SR_MQ_TEMPERATURE;
			if (devc->temp_unit == 1)
				analog.unit = SR_UNIT_FAHRENHEIT;
			else
				analog.unit = SR_UNIT_CELSIUS;
			analog.data = temp;
			sr_session_send(sdi, &packet);
			g_slist_free(analog.channels);
		}

		ch = sdi->channels->next->data;
		if (ch->enabled) {
			analog.channels = g_slist_append(NULL, ch);
			analog.mq = SR_MQ_RELATIVE_HUMIDITY;
			analog.unit = SR_UNIT_PERCENTAGE;
			analog.data = rh;
			sr_session_send(sdi, &packet);
			g_slist_free(analog.channels);
		}

		g_free(temp);
		g_free(rh);
		break;
	case LOG_CO:
		packet.type = SR_DF_ANALOG_OLD;
		packet.payload = &analog;
		analog.channels = sdi->channels;
		analog.num_samples = samples;
		analog.mq = SR_MQ_CARBON_MONOXIDE;
		analog.unit = SR_UNIT_CONCENTRATION;
		analog.mqflags = 0;
		if (!(analog.data = g_try_malloc(sizeof(float) * samples)))
			break;
		for (i = 0; i < samples; i++) {
			s = (buf[i * 2] << 8) | buf[i * 2 + 1];
			analog.data[i] = (s * devc->co_high + devc->co_low) / (1000 * 1000);
			if (analog.data[i] < 0.0)
				analog.data[i] = 0.0;
		}
		sr_session_send(sdi, &packet);
		g_free(analog.data);
		break;
	default:
		/* How did we even get this far? */
		break;
	}
	devc->rcvd_samples += samples;

}

SR_PRIV int lascar_el_usb_handle_events(int fd, int revents, void *cb_data)
{
	struct drv_context *drvc = di->context;
	struct sr_dev_inst *sdi;
	struct timeval tv;

	(void)fd;
	(void)revents;

	sdi = cb_data;

	if (sdi->status == SR_ST_STOPPING) {
		usb_source_remove(sdi->session, drvc->sr_ctx);
		std_session_send_df_end(sdi, LOG_PREFIX);
	}

	memset(&tv, 0, sizeof(struct timeval));
	libusb_handle_events_timeout_completed(drvc->sr_ctx->libusb_ctx, &tv,
					       NULL);

	return TRUE;
}

SR_PRIV void LIBUSB_CALL lascar_el_usb_receive_transfer(struct libusb_transfer *transfer)
{
	struct dev_context *devc;
	struct sr_dev_inst *sdi;
	int ret;
	gboolean packet_has_error;

	sdi = transfer->user_data;
	devc = sdi->priv;

	packet_has_error = FALSE;
	switch (transfer->status) {
	case LIBUSB_TRANSFER_NO_DEVICE:
		/* USB device was unplugged. */
		dev_acquisition_stop(sdi);
		return;
	case LIBUSB_TRANSFER_COMPLETED:
	case LIBUSB_TRANSFER_TIMED_OUT: /* We may have received some data though */
		break;
	default:
		packet_has_error = TRUE;
		break;
	}

	if (!packet_has_error) {
		if (devc->rcvd_samples < devc->logged_samples)
			lascar_el_usb_dispatch(sdi, transfer->buffer,
					transfer->actual_length);
		devc->rcvd_bytes += transfer->actual_length;
		sr_spew("received %d/%d bytes (%d/%d samples)",
				devc->rcvd_bytes, devc->log_size,
				devc->rcvd_samples, devc->logged_samples);
		if (devc->rcvd_bytes >= devc->log_size)
			dev_acquisition_stop(sdi);
	}

	if (sdi->status == SR_ST_ACTIVE) {
		/* Send the same request again. */
		if ((ret = libusb_submit_transfer(transfer) != 0)) {
			sr_err("Unable to resubmit transfer: %s.",
			       libusb_error_name(ret));
			g_free(transfer->buffer);
			libusb_free_transfer(transfer);
			dev_acquisition_stop(sdi);
		}
	} else {
		/* This was the last transfer we're going to receive, so
		 * clean up now. */
		g_free(transfer->buffer);
		libusb_free_transfer(transfer);
	}

}

static int get_flags(unsigned char *configblock)
{
	int flags;

	flags = (configblock[32] | (configblock[33] << 8)) & 0x1fff;
	sr_spew("Read flags (0x%.4x).", flags);

	return flags;
}

static int set_flags(unsigned char *configblock, int flags)
{

	sr_spew("Setting flags to 0x%.4x.", flags);
	configblock[32] = flags & 0xff;
	configblock[33] = (flags >> 8) & 0x1f;

	return flags;
}

SR_PRIV int lascar_is_logging(const struct sr_dev_inst *sdi)
{
	struct dev_context *devc;
	struct sr_usb_dev_inst *usb;
	int dummy, flags, ret;

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

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

	flags = get_flags(devc->config);
	if (flags & 0x0100)
		ret = 1;
	else
		ret = 0;

	return ret;
}

SR_PRIV int lascar_start_logging(const struct sr_dev_inst *sdi)
{
	struct dev_context *devc;
	struct sr_usb_dev_inst *usb;
	int len, flags, ret;

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

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

	/* Turn on logging. */
	flags = get_flags(devc->config);
	flags |= 0x0100;
	set_flags(devc->config, flags);

	/* Start logging in 0 seconds. */
	memset(devc->config + 24, 0, 4);

	ret = lascar_save_config(usb->devhdl, devc->config, len);
	sr_info("Started internal logging.");

	return ret;
}

SR_PRIV int lascar_stop_logging(const struct sr_dev_inst *sdi)
{
	struct dev_context *devc;
	struct sr_usb_dev_inst *usb;
	int len, flags, ret;

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

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

	flags = get_flags(devc->config);
	flags &= ~0x0100;
	set_flags(devc->config, flags);

	ret = lascar_save_config(usb->devhdl, devc->config, len);
	sr_info("Stopped internal logging.");

	return ret;
}
Commit	Line	Data
	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 <config.h>
	21	#include <stdlib.h>
	22	#include <sys/time.h>
	23	#include <string.h>
	24	#include <math.h>
	25	#include <glib.h>
	26	#include <libsigrok/libsigrok.h>
	27	#include "libsigrok-internal.h"
	28	#include "protocol.h"
	29
	30	extern struct sr_dev_driver lascar_el_usb_driver_info;
	31	struct sr_dev_driver *di = &lascar_el_usb_driver_info;
	32
	33	static const struct elusb_profile profiles[] = {
	34	{ 1, "EL-USB-1", LOG_UNSUPPORTED },
	35	{ 2, "EL-USB-1", LOG_UNSUPPORTED },
	36	{ 3, "EL-USB-2", LOG_TEMP_RH },
	37	{ 4, "EL-USB-3", LOG_UNSUPPORTED },
	38	{ 5, "EL-USB-4", LOG_UNSUPPORTED },
	39	{ 6, "EL-USB-3", LOG_UNSUPPORTED },
	40	{ 7, "EL-USB-4", LOG_UNSUPPORTED },
	41	{ 8, "EL-USB-LITE", LOG_UNSUPPORTED },
	42	{ 9, "EL-USB-CO", LOG_CO },
	43	{ 10, "EL-USB-TC", LOG_UNSUPPORTED },
	44	{ 11, "EL-USB-CO300", LOG_CO },
	45	{ 12, "EL-USB-2-LCD", LOG_TEMP_RH },
	46	{ 13, "EL-USB-2+", LOG_TEMP_RH },
	47	{ 14, "EL-USB-1-PRO", LOG_UNSUPPORTED },
	48	{ 15, "EL-USB-TC-LCD", LOG_UNSUPPORTED },
	49	{ 16, "EL-USB-2-LCD+", LOG_TEMP_RH },
	50	{ 17, "EL-USB-5", LOG_UNSUPPORTED },
	51	{ 18, "EL-USB-1-RCG", LOG_UNSUPPORTED },
	52	{ 19, "EL-USB-1-LCD", LOG_UNSUPPORTED },
	53	{ 20, "EL-OEM-3", LOG_UNSUPPORTED },
	54	{ 21, "EL-USB-1-LCD", LOG_UNSUPPORTED },
	55	ALL_ZERO
	56	};
	57
	58	static libusb_device_handle lascar_open(struct libusb_device dev)
	59	{
	60	libusb_device_handle *dev_hdl;
	61	int ret;
	62
	63	if ((ret = libusb_open(dev, &dev_hdl)) != 0) {
	64	sr_dbg("failed to open device for scan: %s",
	65	libusb_error_name(ret));
	66	return NULL;
	67	}
	68
	69	/* Some of these fail, but it needs doing -- some sort of mode
	70	* setup for the SiLabs F32x. */
	71	libusb_control_transfer(dev_hdl, LIBUSB_REQUEST_TYPE_VENDOR,
	72	0x00, 0xffff, 0x00, NULL, 0, 50);
	73	libusb_control_transfer(dev_hdl, LIBUSB_REQUEST_TYPE_VENDOR,
	74	0x02, 0x0002, 0x00, NULL, 0, 50);
	75	libusb_control_transfer(dev_hdl, LIBUSB_REQUEST_TYPE_VENDOR,
	76	0x02, 0x0001, 0x00, NULL, 0, 50);
	77
	78	return dev_hdl;
	79	}
	80
	81	static void LIBUSB_CALL mark_xfer(struct libusb_transfer *xfer)
	82	{
	83
	84	xfer->user_data = GINT_TO_POINTER(1);
	85
	86	}
	87
	88	SR_PRIV int lascar_get_config(libusb_device_handle *dev_hdl,
	89	unsigned char configblock, int configlen)
	90	{
	91	struct drv_context *drvc;
	92	struct libusb_transfer xfer_in, xfer_out;
	93	struct timeval tv;
	94	int64_t start;
	95	int buflen;
	96	unsigned char cmd[3], buf[MAX_CONFIGBLOCK_SIZE];
	97
	98	sr_spew("Reading config block.");
	99
	100	drvc = di->context;
	101	*configlen = 0;
	102
	103	if (!(xfer_in = libusb_alloc_transfer(0)) \|\|
	104	!(xfer_out = libusb_alloc_transfer(0)))
	105	return SR_ERR;
	106
	107	/* Flush anything the F321 still has queued. */
	108	while (libusb_bulk_transfer(dev_hdl, LASCAR_EP_IN, buf, 256, &buflen,
	109	5) == 0 && buflen > 0)
	110	;
	111
	112	/* Keep a read request waiting in the wings, ready to pounce
	113	* the moment the device sends something. */
	114	libusb_fill_bulk_transfer(xfer_in, dev_hdl, LASCAR_EP_IN,
	115	buf, 256, mark_xfer, 0, BULK_XFER_TIMEOUT);
	116	if (libusb_submit_transfer(xfer_in) != 0)
	117	goto cleanup;
	118
	119	/* Request device configuration structure. */
	120	cmd[0] = 0x00;
	121	cmd[1] = 0xff;
	122	cmd[2] = 0xff;
	123	libusb_fill_bulk_transfer(xfer_out, dev_hdl, LASCAR_EP_OUT,
	124	cmd, 3, mark_xfer, 0, 100);
	125	if (libusb_submit_transfer(xfer_out) != 0)
	126	goto cleanup;
	127
	128	tv.tv_sec = 0;
	129	tv.tv_usec = 0;
	130	start = g_get_monotonic_time();
	131	while (!xfer_in->user_data \|\| !xfer_out->user_data) {
	132	if (g_get_monotonic_time() - start > SCAN_TIMEOUT) {
	133	start = 0;
	134	break;
	135	}
	136	g_usleep(SLEEP_US_LONG);
	137	libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
	138	}
	139	if (!start) {
	140	sr_dbg("no response");
	141	goto cleanup;
	142	}
	143	if (xfer_in->actual_length != 3) {
	144	sr_dbg("expected 3-byte header, got %d bytes", xfer_in->actual_length);
	145	goto cleanup;
	146	}
	147
	148	/* Got configuration structure header. */
	149	sr_spew("Response to config request: 0x%.2x 0x%.2x 0x%.2x ",
	150	buf[0], buf[1], buf[2]);
	151	buflen = buf[1] \| (buf[2] << 8);
	152	if (buf[0] != 0x02 \|\| buflen > MAX_CONFIGBLOCK_SIZE) {
	153	sr_dbg("Invalid response to config request: "
	154	"0x%.2x 0x%.2x 0x%.2x ", buf[0], buf[1], buf[2]);
	155	libusb_close(dev_hdl);
	156	goto cleanup;
	157	}
	158
	159	/* Get configuration structure. */
	160	xfer_in->length = buflen;
	161	xfer_in->user_data = 0;
	162	if (libusb_submit_transfer(xfer_in) != 0)
	163	goto cleanup;
	164	while (!xfer_in->user_data) {
	165	if (g_get_monotonic_time() - start > SCAN_TIMEOUT) {
	166	start = 0;
	167	break;
	168	}
	169	g_usleep(SLEEP_US_LONG);
	170	libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
	171	}
	172	if (!start) {
	173	sr_dbg("Timeout waiting for configuration structure.");
	174	goto cleanup;
	175	}
	176	if (xfer_in->actual_length != buflen) {
	177	sr_dbg("expected %d-byte structure, got %d bytes", buflen,
	178	xfer_in->actual_length);
	179	goto cleanup;
	180	}
	181
	182	memcpy(configblock, buf, buflen);
	183	*configlen = buflen;
	184
	185	cleanup:
	186	if (!xfer_in->user_data \|\| !xfer_out->user_data) {
	187	if (!xfer_in->user_data)
	188	libusb_cancel_transfer(xfer_in);
	189	if (!xfer_out->user_data)
	190	libusb_cancel_transfer(xfer_out);
	191	start = g_get_monotonic_time();
	192	while (!xfer_in->user_data \|\| !xfer_out->user_data) {
	193	if (g_get_monotonic_time() - start > EVENTS_TIMEOUT)
	194	break;
	195	g_usleep(SLEEP_US_SHORT);
	196	libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
	197	}
	198	}
	199	libusb_free_transfer(xfer_in);
	200	libusb_free_transfer(xfer_out);
	201
	202	return *configlen ? SR_OK : SR_ERR;
	203	}
	204
	205	static int lascar_save_config(libusb_device_handle *dev_hdl,
	206	unsigned char *config, int configlen)
	207	{
	208	struct drv_context *drvc;
	209	struct libusb_transfer xfer_in, xfer_out;
	210	struct timeval tv;
	211	int64_t start;
	212	int buflen, ret;
	213	unsigned char cmd[3], buf[256];
	214
	215	sr_spew("Writing config block.");
	216
	217	drvc = di->context;
	218
	219	if (!(xfer_in = libusb_alloc_transfer(0)) \|\|
	220	!(xfer_out = libusb_alloc_transfer(0)))
	221	return SR_ERR;
	222
	223	/* Flush anything the F321 still has queued. */
	224	while (libusb_bulk_transfer(dev_hdl, LASCAR_EP_IN, buf, 256, &buflen,
	225	5) == 0 && buflen > 0)
	226	;
	227	ret = SR_OK;
	228
	229	/* Keep a read request waiting in the wings, ready to pounce
	230	* the moment the device sends something. */
	231	libusb_fill_bulk_transfer(xfer_in, dev_hdl, LASCAR_EP_IN,
	232	buf, 256, mark_xfer, 0, BULK_XFER_TIMEOUT);
	233	if (libusb_submit_transfer(xfer_in) != 0) {
	234	ret = SR_ERR;
	235	goto cleanup;
	236	}
	237
	238	/* Request device configuration structure. */
	239	cmd[0] = 0x01;
	240	cmd[1] = configlen & 0xff;
	241	cmd[2] = (configlen >> 8) & 0xff;
	242	libusb_fill_bulk_transfer(xfer_out, dev_hdl, LASCAR_EP_OUT,
	243	cmd, 3, mark_xfer, 0, 100);
	244	if (libusb_submit_transfer(xfer_out) != 0) {
	245	ret = SR_ERR;
	246	goto cleanup;
	247	}
	248	tv.tv_sec = 0;
	249	tv.tv_usec = 0;
	250	while (!xfer_out->user_data) {
	251	g_usleep(SLEEP_US_LONG);
	252	libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
	253	}
	254
	255	libusb_fill_bulk_transfer(xfer_out, dev_hdl, LASCAR_EP_OUT,
	256	config, configlen, mark_xfer, 0, 100);
	257	if (libusb_submit_transfer(xfer_out) != 0) {
	258	ret = SR_ERR;
	259	goto cleanup;
	260	}
	261	while (!xfer_in->user_data \|\| !xfer_out->user_data) {
	262	g_usleep(SLEEP_US_LONG);
	263	libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
	264	}
	265
	266	if (xfer_in->actual_length != 1 \|\| buf[0] != 0xff) {
	267	sr_dbg("unexpected response after transfer");
	268	ret = SR_ERR;
	269	}
	270
	271	cleanup:
	272	if (!xfer_in->user_data \|\| !xfer_out->user_data) {
	273	if (!xfer_in->user_data)
	274	libusb_cancel_transfer(xfer_in);
	275	if (!xfer_out->user_data)
	276	libusb_cancel_transfer(xfer_out);
	277	start = g_get_monotonic_time();
	278	while (!xfer_in->user_data \|\| !xfer_out->user_data) {
	279	if (g_get_monotonic_time() - start > EVENTS_TIMEOUT)
	280	break;
	281	g_usleep(SLEEP_US_SHORT);
	282	libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
	283	}
	284	}
	285	libusb_free_transfer(xfer_in);
	286	libusb_free_transfer(xfer_out);
	287
	288	return ret;
	289	}
	290
	291	static struct sr_dev_inst lascar_identify(unsigned char config)
	292	{
	293	struct dev_context *devc;
	294	const struct elusb_profile *profile;
	295	struct sr_dev_inst *sdi;
	296	int modelid, i;
	297	char firmware[5];
	298
	299	modelid = config[0];
	300	sdi = NULL;
	301	if (modelid) {
	302	profile = NULL;
	303	for (i = 0; profiles[i].modelid; i++) {
	304	if (profiles[i].modelid == modelid) {
	305	profile = &profiles[i];
	306	break;
	307	}
	308	}
	309	if (!profile) {
	310	sr_dbg("unknown EL-USB modelid %d", modelid);
	311	return NULL;
	312	}
	313
	314	i = config[52] \| (config[53] << 8);
	315	memcpy(firmware, config + 0x30, 4);
	316	firmware[4] = '\0';
	317	sr_dbg("found %s with firmware version %s serial %d",
	318	profile->modelname, firmware, i);
	319
	320	if (profile->logformat == LOG_UNSUPPORTED) {
	321	sr_dbg("unsupported EL-USB logformat for %s", profile->modelname);
	322	return NULL;
	323	}
	324
	325	sdi = g_malloc0(sizeof(struct sr_dev_inst));
	326	sdi->status = SR_ST_INACTIVE;
	327	sdi->vendor = g_strdup(LASCAR_VENDOR);
	328	sdi->model = g_strdup(profile->modelname);
	329	sdi->version = g_strdup(firmware);
	330	sdi->driver = di;
	331
	332	if (profile->logformat == LOG_TEMP_RH) {
	333	/* Model this as two channels: temperature and humidity. */
	334	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "Temp");
	335	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "Hum");
	336	} else if (profile->logformat == LOG_CO) {
	337	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "CO");
	338	} else {
	339	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
	340	}
	341
	342	devc = g_malloc0(sizeof(struct dev_context));
	343	sdi->priv = devc;
	344	devc->profile = profile;
	345	}
	346
	347	return sdi;
	348	}
	349
	350	SR_PRIV struct sr_dev_inst *lascar_scan(int bus, int address)
	351	{
	352	struct drv_context *drvc;
	353	struct sr_dev_inst *sdi;
	354	struct libusb_device **devlist;
	355	libusb_device_handle *dev_hdl;
	356	int dummy, i;
	357	int ret;
	358	unsigned char config[MAX_CONFIGBLOCK_SIZE];
	359
	360	drvc = di->context;
	361	sdi = NULL;
	362
	363	ret = libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
	364	if (ret < 0)
	365	return NULL;
	366
	367	for (i = 0; devlist[i]; i++) {
	368	if (libusb_get_bus_number(devlist[i]) != bus \|\|
	369	libusb_get_device_address(devlist[i]) != address)
	370	continue;
	371
	372	if (!(dev_hdl = lascar_open(devlist[i])))
	373	continue;
	374
	375	if (lascar_get_config(dev_hdl, config, &dummy) != SR_OK)
	376	continue;
	377
	378	libusb_close(dev_hdl);
	379	sdi = lascar_identify(config);
	380	}
	381	libusb_free_device_list(devlist, 1);
	382
	383	return sdi;
	384	}
	385
	386	static void lascar_el_usb_dispatch(struct sr_dev_inst sdi, unsigned char buf,
	387	int buflen)
	388	{
	389	struct dev_context *devc;
	390	struct sr_datafeed_packet packet;
	391	struct sr_datafeed_analog_old analog;
	392	struct sr_channel *ch;
	393	float temp, rh;
	394	uint16_t s;
	395	int samples, samples_left, i, j;
	396
	397	devc = sdi->priv;
	398
	399	samples = buflen / devc->sample_size;
	400	samples_left = devc->logged_samples - devc->rcvd_samples;
	401	if (samples_left < samples)
	402	samples = samples_left;
	403	switch (devc->profile->logformat) {
	404	case LOG_TEMP_RH:
	405	packet.type = SR_DF_ANALOG_OLD;
	406	packet.payload = &analog;
	407	analog.mqflags = 0;
	408	if (!(temp = g_try_malloc(sizeof(float) * samples)))
	409	break;
	410	if (!(rh = g_try_malloc(sizeof(float) * samples)))
	411	break;
	412	for (i = 0, j = 0; i < samples; i++) {
	413	/* Both Celsius and Fahrenheit stored at base -40. */
	414	if (devc->temp_unit == 0)
	415	/* Celsius is stored in half-degree increments. */
	416	temp[j] = buf[i * 2] / 2 - 40;
	417	else
	418	temp[j] = buf[i * 2] - 40;
	419
	420	rh[j] = buf[i * 2 + 1] / 2;
	421
	422	if (temp[j] == 0.0 && rh[j] == 0.0)
	423	/* Skip invalid measurement. */
	424	continue;
	425	j++;
	426	}
	427	analog.num_samples = j;
	428
	429	ch = sdi->channels->data;
	430	if (ch->enabled) {
	431	analog.channels = g_slist_append(NULL, ch);
	432	analog.mq = SR_MQ_TEMPERATURE;
	433	if (devc->temp_unit == 1)
	434	analog.unit = SR_UNIT_FAHRENHEIT;
	435	else
	436	analog.unit = SR_UNIT_CELSIUS;
	437	analog.data = temp;
	438	sr_session_send(sdi, &packet);
	439	g_slist_free(analog.channels);
	440	}
	441
	442	ch = sdi->channels->next->data;
	443	if (ch->enabled) {
	444	analog.channels = g_slist_append(NULL, ch);
	445	analog.mq = SR_MQ_RELATIVE_HUMIDITY;
	446	analog.unit = SR_UNIT_PERCENTAGE;
	447	analog.data = rh;
	448	sr_session_send(sdi, &packet);
	449	g_slist_free(analog.channels);
	450	}
	451
	452	g_free(temp);
	453	g_free(rh);
	454	break;
	455	case LOG_CO:
	456	packet.type = SR_DF_ANALOG_OLD;
	457	packet.payload = &analog;
	458	analog.channels = sdi->channels;
	459	analog.num_samples = samples;
	460	analog.mq = SR_MQ_CARBON_MONOXIDE;
	461	analog.unit = SR_UNIT_CONCENTRATION;
	462	analog.mqflags = 0;
	463	if (!(analog.data = g_try_malloc(sizeof(float) * samples)))
	464	break;
	465	for (i = 0; i < samples; i++) {
	466	s = (buf[i * 2] << 8) \| buf[i * 2 + 1];
	467	analog.data[i] = (s * devc->co_high + devc->co_low) / (1000 * 1000);
	468	if (analog.data[i] < 0.0)
	469	analog.data[i] = 0.0;
	470	}
	471	sr_session_send(sdi, &packet);
	472	g_free(analog.data);
	473	break;
	474	default:
	475	/* How did we even get this far? */
	476	break;
	477	}
	478	devc->rcvd_samples += samples;
	479
	480	}
	481
	482	SR_PRIV int lascar_el_usb_handle_events(int fd, int revents, void *cb_data)
	483	{
	484	struct drv_context *drvc = di->context;
	485	struct sr_dev_inst *sdi;
	486	struct timeval tv;
	487
	488	(void)fd;
	489	(void)revents;
	490
	491	sdi = cb_data;
	492
	493	if (sdi->status == SR_ST_STOPPING) {
	494	usb_source_remove(sdi->session, drvc->sr_ctx);
	495	std_session_send_df_end(sdi, LOG_PREFIX);
	496	}
	497
	498	memset(&tv, 0, sizeof(struct timeval));
	499	libusb_handle_events_timeout_completed(drvc->sr_ctx->libusb_ctx, &tv,
	500	NULL);
	501
	502	return TRUE;
	503	}
	504
	505	SR_PRIV void LIBUSB_CALL lascar_el_usb_receive_transfer(struct libusb_transfer *transfer)
	506	{
	507	struct dev_context *devc;
	508	struct sr_dev_inst *sdi;
	509	int ret;
	510	gboolean packet_has_error;
	511
	512	sdi = transfer->user_data;
	513	devc = sdi->priv;
	514
	515	packet_has_error = FALSE;
	516	switch (transfer->status) {
	517	case LIBUSB_TRANSFER_NO_DEVICE:
	518	/* USB device was unplugged. */
	519	dev_acquisition_stop(sdi);
	520	return;
	521	case LIBUSB_TRANSFER_COMPLETED:
	522	case LIBUSB_TRANSFER_TIMED_OUT: /* We may have received some data though */
	523	break;
	524	default:
	525	packet_has_error = TRUE;
	526	break;
	527	}
	528
	529	if (!packet_has_error) {
	530	if (devc->rcvd_samples < devc->logged_samples)
	531	lascar_el_usb_dispatch(sdi, transfer->buffer,
	532	transfer->actual_length);
	533	devc->rcvd_bytes += transfer->actual_length;
	534	sr_spew("received %d/%d bytes (%d/%d samples)",
	535	devc->rcvd_bytes, devc->log_size,
	536	devc->rcvd_samples, devc->logged_samples);
	537	if (devc->rcvd_bytes >= devc->log_size)
	538	dev_acquisition_stop(sdi);
	539	}
	540
	541	if (sdi->status == SR_ST_ACTIVE) {
	542	/* Send the same request again. */
	543	if ((ret = libusb_submit_transfer(transfer) != 0)) {
	544	sr_err("Unable to resubmit transfer: %s.",
	545	libusb_error_name(ret));
	546	g_free(transfer->buffer);
	547	libusb_free_transfer(transfer);
	548	dev_acquisition_stop(sdi);
	549	}
	550	} else {
	551	/* This was the last transfer we're going to receive, so
	552	* clean up now. */
	553	g_free(transfer->buffer);
	554	libusb_free_transfer(transfer);
	555	}
	556
	557	}
	558
	559	static int get_flags(unsigned char *configblock)
	560	{
	561	int flags;
	562
	563	flags = (configblock[32] \| (configblock[33] << 8)) & 0x1fff;
	564	sr_spew("Read flags (0x%.4x).", flags);
	565
	566	return flags;
	567	}
	568
	569	static int set_flags(unsigned char *configblock, int flags)
	570	{
	571
	572	sr_spew("Setting flags to 0x%.4x.", flags);
	573	configblock[32] = flags & 0xff;
	574	configblock[33] = (flags >> 8) & 0x1f;
	575
	576	return flags;
	577	}
	578
	579	SR_PRIV int lascar_is_logging(const struct sr_dev_inst *sdi)
	580	{
	581	struct dev_context *devc;
	582	struct sr_usb_dev_inst *usb;
	583	int dummy, flags, ret;
	584
	585	devc = sdi->priv;
	586	usb = sdi->conn;
	587
	588	if (lascar_get_config(usb->devhdl, devc->config, &dummy) != SR_OK)
	589	return -1;
	590
	591	flags = get_flags(devc->config);
	592	if (flags & 0x0100)
	593	ret = 1;
	594	else
	595	ret = 0;
	596
	597	return ret;
	598	}
	599
	600	SR_PRIV int lascar_start_logging(const struct sr_dev_inst *sdi)
	601	{
	602	struct dev_context *devc;
	603	struct sr_usb_dev_inst *usb;
	604	int len, flags, ret;
	605
	606	devc = sdi->priv;
	607	usb = sdi->conn;
	608
	609	if (lascar_get_config(usb->devhdl, devc->config, &len) != SR_OK)
	610	return SR_ERR;
	611
	612	/* Turn on logging. */
	613	flags = get_flags(devc->config);
	614	flags \|= 0x0100;
	615	set_flags(devc->config, flags);
	616
	617	/* Start logging in 0 seconds. */
	618	memset(devc->config + 24, 0, 4);
	619
	620	ret = lascar_save_config(usb->devhdl, devc->config, len);
	621	sr_info("Started internal logging.");
	622
	623	return ret;
	624	}
	625
	626	SR_PRIV int lascar_stop_logging(const struct sr_dev_inst *sdi)
	627	{
	628	struct dev_context *devc;
	629	struct sr_usb_dev_inst *usb;
	630	int len, flags, ret;
	631
	632	devc = sdi->priv;
	633	usb = sdi->conn;
	634
	635	if (lascar_get_config(usb->devhdl, devc->config, &len) != SR_OK)
	636	return SR_ERR;
	637
	638	flags = get_flags(devc->config);
	639	flags &= ~0x0100;
	640	set_flags(devc->config, flags);
	641
	642	ret = lascar_save_config(usb->devhdl, devc->config, len);
	643	sr_info("Stopped internal logging.");
	644
	645	return ret;
	646	}