[libsigrok.git] / src / hardware / zeroplus-logic-cube / api.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2010-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 "protocol.h"

#define USB_INTERFACE			0
#define USB_CONFIGURATION		1
#define NUM_TRIGGER_STAGES		4
#define PACKET_SIZE			2048	/* ?? */

//#define ZP_EXPERIMENTAL

struct zp_model {
	uint16_t vid;
	uint16_t pid;
	const char *model_name;
	unsigned int channels;
	unsigned int sample_depth;	/* In Ksamples/channel */
	unsigned int max_sampling_freq;
};

/*
 * Note -- 16032, 16064 and 16128 *usually* -- but not always -- have the
 * same 128K sample depth.
 */
static const struct zp_model zeroplus_models[] = {
	{0x0c12, 0x7002, "LAP-16128U",    16, 128,  200},
	{0x0c12, 0x7007, "LAP-16032U",    16, 32,   200},
	{0x0c12, 0x7009, "LAP-C(16064)",  16, 64,   100},
	{0x0c12, 0x700a, "LAP-C(16128)",  16, 128,  200},
	{0x0c12, 0x700b, "LAP-C(32128)",  32, 128,  200},
	{0x0c12, 0x700c, "LAP-C(321000)", 32, 1024, 200},
	{0x0c12, 0x700d, "LAP-C(322000)", 32, 2048, 200},
	{0x0c12, 0x700e, "LAP-C(16032)",  16, 32,   100},
	{0x0c12, 0x7016, "LAP-C(162000)", 16, 2048, 200},
	{0x0c12, 0x7025, "LAP-C(16128+)", 16, 128,  200},
	{0x0c12, 0x7064, "Logian-16L",    16, 128,  200},
	{0x0c12, 0x7100, "AKIP-9101",     16, 256,  200},
	ALL_ZERO
};

static const uint32_t drvopts[] = {
	SR_CONF_LOGIC_ANALYZER,
};

static const uint32_t devopts[] = {
	SR_CONF_LIMIT_SAMPLES | SR_CONF_SET | SR_CONF_LIST,
	SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
	SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
	SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
	SR_CONF_VOLTAGE_THRESHOLD | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
};

static const int32_t trigger_matches[] = {
	SR_TRIGGER_ZERO,
	SR_TRIGGER_ONE,
	SR_TRIGGER_RISING,
	SR_TRIGGER_FALLING,
	SR_TRIGGER_EDGE,
};

/*
 * ZEROPLUS LAP-C (16032) numbers the 16 channels A0-A7 and B0-B7.
 * We currently ignore other untested/unsupported devices here.
 */
static const char *channel_names[] = {
	"A0", "A1", "A2", "A3", "A4", "A5", "A6", "A7",
	"B0", "B1", "B2", "B3", "B4", "B5", "B6", "B7",
	"C0", "C1", "C2", "C3", "C4", "C5", "C6", "C7",
	"D0", "D1", "D2", "D3", "D4", "D5", "D6", "D7",
};

/*
 * The hardware supports more samplerates than these, but these are the
 * options hardcoded into the vendor's Windows GUI.
 */

static const uint64_t samplerates_100[] = {
	SR_HZ(100),
	SR_HZ(500),
	SR_KHZ(1),
	SR_KHZ(5),
	SR_KHZ(25),
	SR_KHZ(50),
	SR_KHZ(100),
	SR_KHZ(200),
	SR_KHZ(400),
	SR_KHZ(800),
	SR_MHZ(1),
	SR_MHZ(10),
	SR_MHZ(25),
	SR_MHZ(50),
	SR_MHZ(80),
	SR_MHZ(100),
};

const uint64_t samplerates_200[] = {
	SR_HZ(100),
	SR_HZ(500),
	SR_KHZ(1),
	SR_KHZ(5),
	SR_KHZ(25),
	SR_KHZ(50),
	SR_KHZ(100),
	SR_KHZ(200),
	SR_KHZ(400),
	SR_KHZ(800),
	SR_MHZ(1),
	SR_MHZ(10),
	SR_MHZ(25),
	SR_MHZ(50),
	SR_MHZ(80),
	SR_MHZ(100),
	SR_MHZ(150),
	SR_MHZ(200),
};

SR_PRIV int zp_set_samplerate(struct dev_context *devc, uint64_t samplerate)
{
	int i;

	for (i = 0; ARRAY_SIZE(samplerates_200); i++)
		if (samplerate == samplerates_200[i])
			break;

	if (i == ARRAY_SIZE(samplerates_200) || samplerate > devc->max_samplerate) {
		sr_err("Unsupported samplerate: %" PRIu64 "Hz.", samplerate);
		return SR_ERR_ARG;
	}

	sr_info("Setting samplerate to %" PRIu64 "Hz.", samplerate);

	if (samplerate >= SR_MHZ(1))
		analyzer_set_freq(samplerate / SR_MHZ(1), FREQ_SCALE_MHZ);
	else if (samplerate >= SR_KHZ(1))
		analyzer_set_freq(samplerate / SR_KHZ(1), FREQ_SCALE_KHZ);
	else
		analyzer_set_freq(samplerate, FREQ_SCALE_HZ);

	devc->cur_samplerate = samplerate;

	return SR_OK;
}

static GSList *scan(struct sr_dev_driver *di, GSList *options)
{
	struct sr_dev_inst *sdi;
	struct drv_context *drvc;
	struct dev_context *devc;
	const struct zp_model *prof;
	struct libusb_device_descriptor des;
	struct libusb_device_handle *hdl;
	libusb_device **devlist;
	GSList *devices;
	int ret, i, j;
	char serial_num[64], connection_id[64];

	(void)options;

	drvc = di->context;

	devices = NULL;

	/* Find all ZEROPLUS analyzers and add them to device list. */
	libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist); /* TODO: Errors. */

	for (i = 0; devlist[i]; i++) {
		libusb_get_device_descriptor(devlist[i], &des);

		if ((ret = libusb_open(devlist[i], &hdl)) < 0)
			continue;

		if (des.iSerialNumber == 0) {
			serial_num[0] = '\0';
		} else if ((ret = libusb_get_string_descriptor_ascii(hdl,
				des.iSerialNumber, (unsigned char *) serial_num,
				sizeof(serial_num))) < 0) {
			sr_warn("Failed to get serial number string descriptor: %s.",
				libusb_error_name(ret));
			continue;
		}

		libusb_close(hdl);

		if (usb_get_port_path(devlist[i], connection_id, sizeof(connection_id)) < 0)
			continue;

		prof = NULL;
		for (j = 0; j < zeroplus_models[j].vid; j++) {
			if (des.idVendor == zeroplus_models[j].vid &&
				des.idProduct == zeroplus_models[j].pid) {
				prof = &zeroplus_models[j];
			}
		}

		if (!prof)
			continue;
		sr_info("Found ZEROPLUS %s.", prof->model_name);

		sdi = g_malloc0(sizeof(struct sr_dev_inst));
		sdi->status = SR_ST_INACTIVE;
		sdi->vendor = g_strdup("ZEROPLUS");
		sdi->model = g_strdup(prof->model_name);
		sdi->serial_num = g_strdup(serial_num);
		sdi->connection_id = g_strdup(connection_id);

		devc = g_malloc0(sizeof(struct dev_context));
		sdi->priv = devc;
		devc->prof = prof;
		devc->num_channels = prof->channels;
#ifdef ZP_EXPERIMENTAL
		devc->max_sample_depth = 128 * 1024;
		devc->max_samplerate = 200;
#else
		devc->max_sample_depth = prof->sample_depth * 1024;
		devc->max_samplerate = prof->max_sampling_freq;
#endif
		devc->max_samplerate *= SR_MHZ(1);
		devc->memory_size = MEMORY_SIZE_8K;
		// memset(devc->trigger_buffer, 0, NUM_TRIGGER_STAGES);

		for (j = 0; j < devc->num_channels; j++)
			sr_channel_new(sdi, j, SR_CHANNEL_LOGIC, TRUE,
					channel_names[j]);

		devices = g_slist_append(devices, sdi);
		sdi->inst_type = SR_INST_USB;
		sdi->conn = sr_usb_dev_inst_new(
			libusb_get_bus_number(devlist[i]),
			libusb_get_device_address(devlist[i]), NULL);
	}
	libusb_free_device_list(devlist, 1);

	return std_scan_complete(di, devices);
}

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

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

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

	ret = libusb_set_configuration(usb->devhdl, USB_CONFIGURATION);
	if (ret < 0) {
		sr_err("Unable to set USB configuration %d: %s.",
		       USB_CONFIGURATION, libusb_error_name(ret));
		return SR_ERR;
	}

	ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
	if (ret != 0) {
		sr_err("Unable to claim interface: %s.",
		       libusb_error_name(ret));
		return SR_ERR;
	}

	/* Set default configuration after power on. */
	if (analyzer_read_status(usb->devhdl) == 0)
		analyzer_configure(usb->devhdl);

	analyzer_reset(usb->devhdl);
	analyzer_initialize(usb->devhdl);

	//analyzer_set_memory_size(MEMORY_SIZE_512K);
	// analyzer_set_freq(g_freq, g_freq_scale);
	analyzer_set_trigger_count(1);
	// analyzer_set_ramsize_trigger_address((((100 - g_pre_trigger)
	// * get_memory_size(g_memory_size)) / 100) >> 2);

#if 0
	if (g_double_mode == 1)
		analyzer_set_compression(COMPRESSION_DOUBLE);
	else if (g_compression == 1)
		analyzer_set_compression(COMPRESSION_ENABLE);
	else
#endif
	analyzer_set_compression(COMPRESSION_NONE);

	if (devc->cur_samplerate == 0) {
		/* Samplerate hasn't been set. Default to 1MHz. */
		analyzer_set_freq(1, FREQ_SCALE_MHZ);
		devc->cur_samplerate = SR_MHZ(1);
	}

	if (devc->cur_threshold == 0)
		set_voltage_threshold(devc, 1.5);

	return SR_OK;
}

static int dev_close(struct sr_dev_inst *sdi)
{
	struct sr_usb_dev_inst *usb;

	usb = sdi->conn;

	if (!usb->devhdl)
		return SR_ERR_BUG;

	sr_info("Closing device on %d.%d (logical) / %s (physical) interface %d.",
		usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
	libusb_release_interface(usb->devhdl, USB_INTERFACE);
	libusb_reset_device(usb->devhdl);
	libusb_close(usb->devhdl);
	usb->devhdl = NULL;

	return SR_OK;
}

static int config_get(uint32_t key, GVariant **data,
	const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
{
	struct dev_context *devc;

	(void)cg;

	if (!sdi)
		return SR_ERR_ARG;

	devc = sdi->priv;

	switch (key) {
	case SR_CONF_SAMPLERATE:
		*data = g_variant_new_uint64(devc->cur_samplerate);
		break;
	case SR_CONF_CAPTURE_RATIO:
		*data = g_variant_new_uint64(devc->capture_ratio);
		break;
	case SR_CONF_VOLTAGE_THRESHOLD:
		*data = std_gvar_tuple_double(devc->cur_threshold, devc->cur_threshold);
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

static int config_set(uint32_t key, GVariant *data,
	const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
{
	struct dev_context *devc;
	gdouble low, high;

	(void)cg;

	devc = sdi->priv;

	switch (key) {
	case SR_CONF_SAMPLERATE:
		return zp_set_samplerate(devc, g_variant_get_uint64(data));
	case SR_CONF_LIMIT_SAMPLES:
		return set_limit_samples(devc, g_variant_get_uint64(data));
	case SR_CONF_CAPTURE_RATIO:
		devc->capture_ratio = g_variant_get_uint64(data);
		break;
	case SR_CONF_VOLTAGE_THRESHOLD:
		g_variant_get(data, "(dd)", &low, &high);
		return set_voltage_threshold(devc, (low + high) / 2.0);
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

static int config_list(uint32_t key, GVariant **data,
	const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
{
	struct dev_context *devc;

	switch (key) {
	case SR_CONF_DEVICE_OPTIONS:
		return STD_CONFIG_LIST(key, data, sdi, cg, NO_OPTS, drvopts, devopts);
	case SR_CONF_SAMPLERATE:
		devc = sdi->priv;
		if (devc->prof->max_sampling_freq == 100)
			*data = std_gvar_samplerates(ARRAY_AND_SIZE(samplerates_100));
		else if (devc->prof->max_sampling_freq == 200)
			*data = std_gvar_samplerates(ARRAY_AND_SIZE(samplerates_200));
		else {
			sr_err("Internal error: Unknown max. samplerate: %d.",
			       devc->prof->max_sampling_freq);
			return SR_ERR_ARG;
		}
		break;
	case SR_CONF_TRIGGER_MATCH:
		*data = std_gvar_array_i32(ARRAY_AND_SIZE(trigger_matches));
		break;
	case SR_CONF_VOLTAGE_THRESHOLD:
		*data = std_gvar_min_max_step_thresholds(-6.0, 6.0, 0.1);
		break;
	case SR_CONF_LIMIT_SAMPLES:
		if (!sdi)
			return SR_ERR_ARG;
		devc = sdi->priv;
		*data = std_gvar_tuple_u64(0, devc->max_sample_depth);
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

static int dev_acquisition_start(const struct sr_dev_inst *sdi)
{
	struct dev_context *devc;
	struct sr_usb_dev_inst *usb;
	struct sr_datafeed_packet packet;
	struct sr_datafeed_logic logic;
	unsigned int samples_read;
	int res;
	unsigned int packet_num, n;
	unsigned char *buf;
	unsigned int status;
	unsigned int stop_address;
	unsigned int now_address;
	unsigned int trigger_address;
	unsigned int trigger_offset;
	unsigned int triggerbar;
	unsigned int ramsize_trigger;
	unsigned int memory_size;
	unsigned int valid_samples;
	unsigned int discard;
	int trigger_now;

	devc = sdi->priv;

	if (analyzer_add_triggers(sdi) != SR_OK) {
		sr_err("Failed to configure triggers.");
		return SR_ERR;
	}

	usb = sdi->conn;

	set_triggerbar(devc);

	/* Push configured settings to device. */
	analyzer_configure(usb->devhdl);

	analyzer_start(usb->devhdl);
	sr_info("Waiting for data.");
	analyzer_wait_data(usb->devhdl);

	status = analyzer_read_status(usb->devhdl);
	stop_address = analyzer_get_stop_address(usb->devhdl);
	now_address = analyzer_get_now_address(usb->devhdl);
	trigger_address = analyzer_get_trigger_address(usb->devhdl);

	triggerbar = analyzer_get_triggerbar_address();
	ramsize_trigger = analyzer_get_ramsize_trigger_address();

	n = get_memory_size(devc->memory_size);
	memory_size = n / 4;

	sr_info("Status = 0x%x.", status);
	sr_info("Stop address       = 0x%x.", stop_address);
	sr_info("Now address        = 0x%x.", now_address);
	sr_info("Trigger address    = 0x%x.", trigger_address);
	sr_info("Triggerbar address = 0x%x.", triggerbar);
	sr_info("Ramsize trigger    = 0x%x.", ramsize_trigger);
	sr_info("Memory size        = 0x%x.", memory_size);

	std_session_send_df_header(sdi);

	/* Check for empty capture */
	if ((status & STATUS_READY) && !stop_address) {
		std_session_send_df_end(sdi);
		return SR_OK;
	}

	buf = g_malloc(PACKET_SIZE);

	/* Check if the trigger is in the samples we are throwing away */
	trigger_now = now_address == trigger_address ||
		((now_address + 1) % memory_size) == trigger_address;

	/*
	 * STATUS_READY doesn't clear until now_address advances past
	 * addr 0, but for our logic, clear it in that case
	 */
	if (!now_address)
		status &= ~STATUS_READY;

	analyzer_read_start(usb->devhdl);

	/* Calculate how much data to discard */
	discard = 0;
	if (status & STATUS_READY) {
		/*
		 * We haven't wrapped around, we need to throw away data from
		 * our current position to the end of the buffer.
		 * Additionally, the first two samples captured are always
		 * bogus.
		 */
		discard += memory_size - now_address + 2;
		now_address = 2;
	}

	/* If we have more samples than we need, discard them */
	valid_samples = (stop_address - now_address) % memory_size;
	if (valid_samples > ramsize_trigger + triggerbar) {
		discard += valid_samples - (ramsize_trigger + triggerbar);
		now_address += valid_samples - (ramsize_trigger + triggerbar);
	}

	sr_info("Need to discard %d samples.", discard);

	/* Calculate how far in the trigger is */
	if (trigger_now)
		trigger_offset = 0;
	else
		trigger_offset = (trigger_address - now_address) % memory_size;

	/* Recalculate the number of samples available */
	valid_samples = (stop_address - now_address) % memory_size;

	/* Send the incoming transfer to the session bus. */
	samples_read = 0;
	for (packet_num = 0; packet_num < n / PACKET_SIZE; packet_num++) {
		unsigned int len;
		unsigned int buf_offset;

		res = analyzer_read_data(usb->devhdl, buf, PACKET_SIZE);
		if (res != PACKET_SIZE)
			sr_warn("Tried to read %d bytes, actually read %d.",
				PACKET_SIZE, res);

		if (discard >= PACKET_SIZE / 4) {
			discard -= PACKET_SIZE / 4;
			continue;
		}

		len = PACKET_SIZE - discard * 4;
		buf_offset = discard * 4;
		discard = 0;

		/* Check if we've read all the samples */
		if (samples_read + len / 4 >= valid_samples)
			len = (valid_samples - samples_read) * 4;
		if (!len)
			break;

		if (samples_read < trigger_offset &&
		    samples_read + len / 4 > trigger_offset) {
			/* Send out samples remaining before trigger */
			packet.type = SR_DF_LOGIC;
			packet.payload = &logic;
			logic.length = (trigger_offset - samples_read) * 4;
			logic.unitsize = 4;
			logic.data = buf + buf_offset;
			sr_session_send(sdi, &packet);
			len -= logic.length;
			samples_read += logic.length / 4;
			buf_offset += logic.length;
		}

		if (samples_read == trigger_offset)
			std_session_send_df_trigger(sdi);

		/* Send out data (or data after trigger) */
		packet.type = SR_DF_LOGIC;
		packet.payload = &logic;
		logic.length = len;
		logic.unitsize = 4;
		logic.data = buf + buf_offset;
		sr_session_send(sdi, &packet);
		samples_read += len / 4;
	}
	analyzer_read_stop(usb->devhdl);
	g_free(buf);

	std_session_send_df_end(sdi);

	return SR_OK;
}

static int dev_acquisition_stop(struct sr_dev_inst *sdi)
{
	struct sr_usb_dev_inst *usb;

	std_session_send_df_end(sdi);

	usb = sdi->conn;
	analyzer_reset(usb->devhdl);
	/* TODO: Need to cancel and free any queued up transfers. */

	return SR_OK;
}

static struct sr_dev_driver zeroplus_logic_cube_driver_info = {
	.name = "zeroplus-logic-cube",
	.longname = "ZEROPLUS Logic Cube LAP-C series",
	.api_version = 1,
	.init = std_init,
	.cleanup = std_cleanup,
	.scan = scan,
	.dev_list = std_dev_list,
	.dev_clear = std_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,
	.context = NULL,
};
SR_REGISTER_DEV_DRIVER(zeroplus_logic_cube_driver_info);
Commit	Line	Data
	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2010-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 "protocol.h"
	22
	23	#define USB_INTERFACE 0
	24	#define USB_CONFIGURATION 1
	25	#define NUM_TRIGGER_STAGES 4
	26	#define PACKET_SIZE 2048 /* ?? */
	27
	28	//#define ZP_EXPERIMENTAL
	29
	30	struct zp_model {
	31	uint16_t vid;
	32	uint16_t pid;
	33	const char *model_name;
	34	unsigned int channels;
	35	unsigned int sample_depth; /* In Ksamples/channel */
	36	unsigned int max_sampling_freq;
	37	};
	38
	39	/*
	40	* Note -- 16032, 16064 and 16128 usually -- but not always -- have the
	41	* same 128K sample depth.
	42	*/
	43	static const struct zp_model zeroplus_models[] = {
	44	{0x0c12, 0x7002, "LAP-16128U", 16, 128, 200},
	45	{0x0c12, 0x7007, "LAP-16032U", 16, 32, 200},
	46	{0x0c12, 0x7009, "LAP-C(16064)", 16, 64, 100},
	47	{0x0c12, 0x700a, "LAP-C(16128)", 16, 128, 200},
	48	{0x0c12, 0x700b, "LAP-C(32128)", 32, 128, 200},
	49	{0x0c12, 0x700c, "LAP-C(321000)", 32, 1024, 200},
	50	{0x0c12, 0x700d, "LAP-C(322000)", 32, 2048, 200},
	51	{0x0c12, 0x700e, "LAP-C(16032)", 16, 32, 100},
	52	{0x0c12, 0x7016, "LAP-C(162000)", 16, 2048, 200},
	53	{0x0c12, 0x7025, "LAP-C(16128+)", 16, 128, 200},
	54	{0x0c12, 0x7064, "Logian-16L", 16, 128, 200},
	55	{0x0c12, 0x7100, "AKIP-9101", 16, 256, 200},
	56	ALL_ZERO
	57	};
	58
	59	static const uint32_t drvopts[] = {
	60	SR_CONF_LOGIC_ANALYZER,
	61	};
	62
	63	static const uint32_t devopts[] = {
	64	SR_CONF_LIMIT_SAMPLES \| SR_CONF_SET \| SR_CONF_LIST,
	65	SR_CONF_SAMPLERATE \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
	66	SR_CONF_TRIGGER_MATCH \| SR_CONF_LIST,
	67	SR_CONF_CAPTURE_RATIO \| SR_CONF_GET \| SR_CONF_SET,
	68	SR_CONF_VOLTAGE_THRESHOLD \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
	69	};
	70
	71	static const int32_t trigger_matches[] = {
	72	SR_TRIGGER_ZERO,
	73	SR_TRIGGER_ONE,
	74	SR_TRIGGER_RISING,
	75	SR_TRIGGER_FALLING,
	76	SR_TRIGGER_EDGE,
	77	};
	78
	79	/*
	80	* ZEROPLUS LAP-C (16032) numbers the 16 channels A0-A7 and B0-B7.
	81	* We currently ignore other untested/unsupported devices here.
	82	*/
	83	static const char *channel_names[] = {
	84	"A0", "A1", "A2", "A3", "A4", "A5", "A6", "A7",
	85	"B0", "B1", "B2", "B3", "B4", "B5", "B6", "B7",
	86	"C0", "C1", "C2", "C3", "C4", "C5", "C6", "C7",
	87	"D0", "D1", "D2", "D3", "D4", "D5", "D6", "D7",
	88	};
	89
	90	/*
	91	* The hardware supports more samplerates than these, but these are the
	92	* options hardcoded into the vendor's Windows GUI.
	93	*/
	94
	95	static const uint64_t samplerates_100[] = {
	96	SR_HZ(100),
	97	SR_HZ(500),
	98	SR_KHZ(1),
	99	SR_KHZ(5),
	100	SR_KHZ(25),
	101	SR_KHZ(50),
	102	SR_KHZ(100),
	103	SR_KHZ(200),
	104	SR_KHZ(400),
	105	SR_KHZ(800),
	106	SR_MHZ(1),
	107	SR_MHZ(10),
	108	SR_MHZ(25),
	109	SR_MHZ(50),
	110	SR_MHZ(80),
	111	SR_MHZ(100),
	112	};
	113
	114	const uint64_t samplerates_200[] = {
	115	SR_HZ(100),
	116	SR_HZ(500),
	117	SR_KHZ(1),
	118	SR_KHZ(5),
	119	SR_KHZ(25),
	120	SR_KHZ(50),
	121	SR_KHZ(100),
	122	SR_KHZ(200),
	123	SR_KHZ(400),
	124	SR_KHZ(800),
	125	SR_MHZ(1),
	126	SR_MHZ(10),
	127	SR_MHZ(25),
	128	SR_MHZ(50),
	129	SR_MHZ(80),
	130	SR_MHZ(100),
	131	SR_MHZ(150),
	132	SR_MHZ(200),
	133	};
	134
	135	SR_PRIV int zp_set_samplerate(struct dev_context *devc, uint64_t samplerate)
	136	{
	137	int i;
	138
	139	for (i = 0; ARRAY_SIZE(samplerates_200); i++)
	140	if (samplerate == samplerates_200[i])
	141	break;
	142
	143	if (i == ARRAY_SIZE(samplerates_200) \|\| samplerate > devc->max_samplerate) {
	144	sr_err("Unsupported samplerate: %" PRIu64 "Hz.", samplerate);
	145	return SR_ERR_ARG;
	146	}
	147
	148	sr_info("Setting samplerate to %" PRIu64 "Hz.", samplerate);
	149
	150	if (samplerate >= SR_MHZ(1))
	151	analyzer_set_freq(samplerate / SR_MHZ(1), FREQ_SCALE_MHZ);
	152	else if (samplerate >= SR_KHZ(1))
	153	analyzer_set_freq(samplerate / SR_KHZ(1), FREQ_SCALE_KHZ);
	154	else
	155	analyzer_set_freq(samplerate, FREQ_SCALE_HZ);
	156
	157	devc->cur_samplerate = samplerate;
	158
	159	return SR_OK;
	160	}
	161
	162	static GSList scan(struct sr_dev_driver di, GSList *options)
	163	{
	164	struct sr_dev_inst *sdi;
	165	struct drv_context *drvc;
	166	struct dev_context *devc;
	167	const struct zp_model *prof;
	168	struct libusb_device_descriptor des;
	169	struct libusb_device_handle *hdl;
	170	libusb_device **devlist;
	171	GSList *devices;
	172	int ret, i, j;
	173	char serial_num[64], connection_id[64];
	174
	175	(void)options;
	176
	177	drvc = di->context;
	178
	179	devices = NULL;
	180
	181	/* Find all ZEROPLUS analyzers and add them to device list. */
	182	libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist); /* TODO: Errors. */
	183
	184	for (i = 0; devlist[i]; i++) {
	185	libusb_get_device_descriptor(devlist[i], &des);
	186
	187	if ((ret = libusb_open(devlist[i], &hdl)) < 0)
	188	continue;
	189
	190	if (des.iSerialNumber == 0) {
	191	serial_num[0] = '\0';
	192	} else if ((ret = libusb_get_string_descriptor_ascii(hdl,
	193	des.iSerialNumber, (unsigned char *) serial_num,
	194	sizeof(serial_num))) < 0) {
	195	sr_warn("Failed to get serial number string descriptor: %s.",
	196	libusb_error_name(ret));
	197	continue;
	198	}
	199
	200	libusb_close(hdl);
	201
	202	if (usb_get_port_path(devlist[i], connection_id, sizeof(connection_id)) < 0)
	203	continue;
	204
	205	prof = NULL;
	206	for (j = 0; j < zeroplus_models[j].vid; j++) {
	207	if (des.idVendor == zeroplus_models[j].vid &&
	208	des.idProduct == zeroplus_models[j].pid) {
	209	prof = &zeroplus_models[j];
	210	}
	211	}
	212
	213	if (!prof)
	214	continue;
	215	sr_info("Found ZEROPLUS %s.", prof->model_name);
	216
	217	sdi = g_malloc0(sizeof(struct sr_dev_inst));
	218	sdi->status = SR_ST_INACTIVE;
	219	sdi->vendor = g_strdup("ZEROPLUS");
	220	sdi->model = g_strdup(prof->model_name);
	221	sdi->serial_num = g_strdup(serial_num);
	222	sdi->connection_id = g_strdup(connection_id);
	223
	224	devc = g_malloc0(sizeof(struct dev_context));
	225	sdi->priv = devc;
	226	devc->prof = prof;
	227	devc->num_channels = prof->channels;
	228	#ifdef ZP_EXPERIMENTAL
	229	devc->max_sample_depth = 128 * 1024;
	230	devc->max_samplerate = 200;
	231	#else
	232	devc->max_sample_depth = prof->sample_depth * 1024;
	233	devc->max_samplerate = prof->max_sampling_freq;
	234	#endif
	235	devc->max_samplerate *= SR_MHZ(1);
	236	devc->memory_size = MEMORY_SIZE_8K;
	237	// memset(devc->trigger_buffer, 0, NUM_TRIGGER_STAGES);
	238
	239	for (j = 0; j < devc->num_channels; j++)
	240	sr_channel_new(sdi, j, SR_CHANNEL_LOGIC, TRUE,
	241	channel_names[j]);
	242
	243	devices = g_slist_append(devices, sdi);
	244	sdi->inst_type = SR_INST_USB;
	245	sdi->conn = sr_usb_dev_inst_new(
	246	libusb_get_bus_number(devlist[i]),
	247	libusb_get_device_address(devlist[i]), NULL);
	248	}
	249	libusb_free_device_list(devlist, 1);
	250
	251	return std_scan_complete(di, devices);
	252	}
	253
	254	static int dev_open(struct sr_dev_inst *sdi)
	255	{
	256	struct sr_dev_driver *di = sdi->driver;
	257	struct dev_context *devc;
	258	struct drv_context *drvc;
	259	struct sr_usb_dev_inst *usb;
	260	int ret;
	261
	262	drvc = di->context;
	263	usb = sdi->conn;
	264	devc = sdi->priv;
	265
	266	ret = sr_usb_open(drvc->sr_ctx->libusb_ctx, usb);
	267	if (ret != SR_OK)
	268	return ret;
	269
	270	ret = libusb_set_configuration(usb->devhdl, USB_CONFIGURATION);
	271	if (ret < 0) {
	272	sr_err("Unable to set USB configuration %d: %s.",
	273	USB_CONFIGURATION, libusb_error_name(ret));
	274	return SR_ERR;
	275	}
	276
	277	ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
	278	if (ret != 0) {
	279	sr_err("Unable to claim interface: %s.",
	280	libusb_error_name(ret));
	281	return SR_ERR;
	282	}
	283
	284	/* Set default configuration after power on. */
	285	if (analyzer_read_status(usb->devhdl) == 0)
	286	analyzer_configure(usb->devhdl);
	287
	288	analyzer_reset(usb->devhdl);
	289	analyzer_initialize(usb->devhdl);
	290
	291	//analyzer_set_memory_size(MEMORY_SIZE_512K);
	292	// analyzer_set_freq(g_freq, g_freq_scale);
	293	analyzer_set_trigger_count(1);
	294	// analyzer_set_ramsize_trigger_address((((100 - g_pre_trigger)
	295	// * get_memory_size(g_memory_size)) / 100) >> 2);
	296
	297	#if 0
	298	if (g_double_mode == 1)
	299	analyzer_set_compression(COMPRESSION_DOUBLE);
	300	else if (g_compression == 1)
	301	analyzer_set_compression(COMPRESSION_ENABLE);
	302	else
	303	#endif
	304	analyzer_set_compression(COMPRESSION_NONE);
	305
	306	if (devc->cur_samplerate == 0) {
	307	/* Samplerate hasn't been set. Default to 1MHz. */
	308	analyzer_set_freq(1, FREQ_SCALE_MHZ);
	309	devc->cur_samplerate = SR_MHZ(1);
	310	}
	311
	312	if (devc->cur_threshold == 0)
	313	set_voltage_threshold(devc, 1.5);
	314
	315	return SR_OK;
	316	}
	317
	318	static int dev_close(struct sr_dev_inst *sdi)
	319	{
	320	struct sr_usb_dev_inst *usb;
	321
	322	usb = sdi->conn;
	323
	324	if (!usb->devhdl)
	325	return SR_ERR_BUG;
	326
	327	sr_info("Closing device on %d.%d (logical) / %s (physical) interface %d.",
	328	usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
	329	libusb_release_interface(usb->devhdl, USB_INTERFACE);
	330	libusb_reset_device(usb->devhdl);
	331	libusb_close(usb->devhdl);
	332	usb->devhdl = NULL;
	333
	334	return SR_OK;
	335	}
	336
	337	static int config_get(uint32_t key, GVariant **data,
	338	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
	339	{
	340	struct dev_context *devc;
	341
	342	(void)cg;
	343
	344	if (!sdi)
	345	return SR_ERR_ARG;
	346
	347	devc = sdi->priv;
	348
	349	switch (key) {
	350	case SR_CONF_SAMPLERATE:
	351	*data = g_variant_new_uint64(devc->cur_samplerate);
	352	break;
	353	case SR_CONF_CAPTURE_RATIO:
	354	*data = g_variant_new_uint64(devc->capture_ratio);
	355	break;
	356	case SR_CONF_VOLTAGE_THRESHOLD:
	357	*data = std_gvar_tuple_double(devc->cur_threshold, devc->cur_threshold);
	358	break;
	359	default:
	360	return SR_ERR_NA;
	361	}
	362
	363	return SR_OK;
	364	}
	365
	366	static int config_set(uint32_t key, GVariant *data,
	367	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
	368	{
	369	struct dev_context *devc;
	370	gdouble low, high;
	371
	372	(void)cg;
	373
	374	devc = sdi->priv;
	375
	376	switch (key) {
	377	case SR_CONF_SAMPLERATE:
	378	return zp_set_samplerate(devc, g_variant_get_uint64(data));
	379	case SR_CONF_LIMIT_SAMPLES:
	380	return set_limit_samples(devc, g_variant_get_uint64(data));
	381	case SR_CONF_CAPTURE_RATIO:
	382	devc->capture_ratio = g_variant_get_uint64(data);
	383	break;
	384	case SR_CONF_VOLTAGE_THRESHOLD:
	385	g_variant_get(data, "(dd)", &low, &high);
	386	return set_voltage_threshold(devc, (low + high) / 2.0);
	387	default:
	388	return SR_ERR_NA;
	389	}
	390
	391	return SR_OK;
	392	}
	393
	394	static int config_list(uint32_t key, GVariant **data,
	395	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
	396	{
	397	struct dev_context *devc;
	398
	399	switch (key) {
	400	case SR_CONF_DEVICE_OPTIONS:
	401	return STD_CONFIG_LIST(key, data, sdi, cg, NO_OPTS, drvopts, devopts);
	402	case SR_CONF_SAMPLERATE:
	403	devc = sdi->priv;
	404	if (devc->prof->max_sampling_freq == 100)
	405	*data = std_gvar_samplerates(ARRAY_AND_SIZE(samplerates_100));
	406	else if (devc->prof->max_sampling_freq == 200)
	407	*data = std_gvar_samplerates(ARRAY_AND_SIZE(samplerates_200));
	408	else {
	409	sr_err("Internal error: Unknown max. samplerate: %d.",
	410	devc->prof->max_sampling_freq);
	411	return SR_ERR_ARG;
	412	}
	413	break;
	414	case SR_CONF_TRIGGER_MATCH:
	415	*data = std_gvar_array_i32(ARRAY_AND_SIZE(trigger_matches));
	416	break;
	417	case SR_CONF_VOLTAGE_THRESHOLD:
	418	*data = std_gvar_min_max_step_thresholds(-6.0, 6.0, 0.1);
	419	break;
	420	case SR_CONF_LIMIT_SAMPLES:
	421	if (!sdi)
	422	return SR_ERR_ARG;
	423	devc = sdi->priv;
	424	*data = std_gvar_tuple_u64(0, devc->max_sample_depth);
	425	break;
	426	default:
	427	return SR_ERR_NA;
	428	}
	429
	430	return SR_OK;
	431	}
	432
	433	static int dev_acquisition_start(const struct sr_dev_inst *sdi)
	434	{
	435	struct dev_context *devc;
	436	struct sr_usb_dev_inst *usb;
	437	struct sr_datafeed_packet packet;
	438	struct sr_datafeed_logic logic;
	439	unsigned int samples_read;
	440	int res;
	441	unsigned int packet_num, n;
	442	unsigned char *buf;
	443	unsigned int status;
	444	unsigned int stop_address;
	445	unsigned int now_address;
	446	unsigned int trigger_address;
	447	unsigned int trigger_offset;
	448	unsigned int triggerbar;
	449	unsigned int ramsize_trigger;
	450	unsigned int memory_size;
	451	unsigned int valid_samples;
	452	unsigned int discard;
	453	int trigger_now;
	454
	455	devc = sdi->priv;
	456
	457	if (analyzer_add_triggers(sdi) != SR_OK) {
	458	sr_err("Failed to configure triggers.");
	459	return SR_ERR;
	460	}
	461
	462	usb = sdi->conn;
	463
	464	set_triggerbar(devc);
	465
	466	/* Push configured settings to device. */
	467	analyzer_configure(usb->devhdl);
	468
	469	analyzer_start(usb->devhdl);
	470	sr_info("Waiting for data.");
	471	analyzer_wait_data(usb->devhdl);
	472
	473	status = analyzer_read_status(usb->devhdl);
	474	stop_address = analyzer_get_stop_address(usb->devhdl);
	475	now_address = analyzer_get_now_address(usb->devhdl);
	476	trigger_address = analyzer_get_trigger_address(usb->devhdl);
	477
	478	triggerbar = analyzer_get_triggerbar_address();
	479	ramsize_trigger = analyzer_get_ramsize_trigger_address();
	480
	481	n = get_memory_size(devc->memory_size);
	482	memory_size = n / 4;
	483
	484	sr_info("Status = 0x%x.", status);
	485	sr_info("Stop address = 0x%x.", stop_address);
	486	sr_info("Now address = 0x%x.", now_address);
	487	sr_info("Trigger address = 0x%x.", trigger_address);
	488	sr_info("Triggerbar address = 0x%x.", triggerbar);
	489	sr_info("Ramsize trigger = 0x%x.", ramsize_trigger);
	490	sr_info("Memory size = 0x%x.", memory_size);
	491
	492	std_session_send_df_header(sdi);
	493
	494	/* Check for empty capture */
	495	if ((status & STATUS_READY) && !stop_address) {
	496	std_session_send_df_end(sdi);
	497	return SR_OK;
	498	}
	499
	500	buf = g_malloc(PACKET_SIZE);
	501
	502	/* Check if the trigger is in the samples we are throwing away */
	503	trigger_now = now_address == trigger_address \|\|
	504	((now_address + 1) % memory_size) == trigger_address;
	505
	506	/*
	507	* STATUS_READY doesn't clear until now_address advances past
	508	* addr 0, but for our logic, clear it in that case
	509	*/
	510	if (!now_address)
	511	status &= ~STATUS_READY;
	512
	513	analyzer_read_start(usb->devhdl);
	514
	515	/* Calculate how much data to discard */
	516	discard = 0;
	517	if (status & STATUS_READY) {
	518	/*
	519	* We haven't wrapped around, we need to throw away data from
	520	* our current position to the end of the buffer.
	521	* Additionally, the first two samples captured are always
	522	* bogus.
	523	*/
	524	discard += memory_size - now_address + 2;
	525	now_address = 2;
	526	}
	527
	528	/* If we have more samples than we need, discard them */
	529	valid_samples = (stop_address - now_address) % memory_size;
	530	if (valid_samples > ramsize_trigger + triggerbar) {
	531	discard += valid_samples - (ramsize_trigger + triggerbar);
	532	now_address += valid_samples - (ramsize_trigger + triggerbar);
	533	}
	534
	535	sr_info("Need to discard %d samples.", discard);
	536
	537	/* Calculate how far in the trigger is */
	538	if (trigger_now)
	539	trigger_offset = 0;
	540	else
	541	trigger_offset = (trigger_address - now_address) % memory_size;
	542
	543	/* Recalculate the number of samples available */
	544	valid_samples = (stop_address - now_address) % memory_size;
	545
	546	/* Send the incoming transfer to the session bus. */
	547	samples_read = 0;
	548	for (packet_num = 0; packet_num < n / PACKET_SIZE; packet_num++) {
	549	unsigned int len;
	550	unsigned int buf_offset;
	551
	552	res = analyzer_read_data(usb->devhdl, buf, PACKET_SIZE);
	553	if (res != PACKET_SIZE)
	554	sr_warn("Tried to read %d bytes, actually read %d.",
	555	PACKET_SIZE, res);
	556
	557	if (discard >= PACKET_SIZE / 4) {
	558	discard -= PACKET_SIZE / 4;
	559	continue;
	560	}
	561
	562	len = PACKET_SIZE - discard * 4;
	563	buf_offset = discard * 4;
	564	discard = 0;
	565
	566	/* Check if we've read all the samples */
	567	if (samples_read + len / 4 >= valid_samples)
	568	len = (valid_samples - samples_read) * 4;
	569	if (!len)
	570	break;
	571
	572	if (samples_read < trigger_offset &&
	573	samples_read + len / 4 > trigger_offset) {
	574	/* Send out samples remaining before trigger */
	575	packet.type = SR_DF_LOGIC;
	576	packet.payload = &logic;
	577	logic.length = (trigger_offset - samples_read) * 4;
	578	logic.unitsize = 4;
	579	logic.data = buf + buf_offset;
	580	sr_session_send(sdi, &packet);
	581	len -= logic.length;
	582	samples_read += logic.length / 4;
	583	buf_offset += logic.length;
	584	}
	585
	586	if (samples_read == trigger_offset)
	587	std_session_send_df_trigger(sdi);
	588
	589	/* Send out data (or data after trigger) */
	590	packet.type = SR_DF_LOGIC;
	591	packet.payload = &logic;
	592	logic.length = len;
	593	logic.unitsize = 4;
	594	logic.data = buf + buf_offset;
	595	sr_session_send(sdi, &packet);
	596	samples_read += len / 4;
	597	}
	598	analyzer_read_stop(usb->devhdl);
	599	g_free(buf);
	600
	601	std_session_send_df_end(sdi);
	602
	603	return SR_OK;
	604	}
	605
	606	static int dev_acquisition_stop(struct sr_dev_inst *sdi)
	607	{
	608	struct sr_usb_dev_inst *usb;
	609
	610	std_session_send_df_end(sdi);
	611
	612	usb = sdi->conn;
	613	analyzer_reset(usb->devhdl);
	614	/* TODO: Need to cancel and free any queued up transfers. */
	615
	616	return SR_OK;
	617	}
	618
	619	static struct sr_dev_driver zeroplus_logic_cube_driver_info = {
	620	.name = "zeroplus-logic-cube",
	621	.longname = "ZEROPLUS Logic Cube LAP-C series",
	622	.api_version = 1,
	623	.init = std_init,
	624	.cleanup = std_cleanup,
	625	.scan = scan,
	626	.dev_list = std_dev_list,
	627	.dev_clear = std_dev_clear,
	628	.config_get = config_get,
	629	.config_set = config_set,
	630	.config_list = config_list,
	631	.dev_open = dev_open,
	632	.dev_close = dev_close,
	633	.dev_acquisition_start = dev_acquisition_start,
	634	.dev_acquisition_stop = dev_acquisition_stop,
	635	.context = NULL,
	636	};
	637	SR_REGISTER_DEV_DRIVER(zeroplus_logic_cube_driver_info);