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

/*
 * This file is part of the sigrok 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 "protocol.h"

#define VENDOR_NAME			"ZEROPLUS"
#define USB_INTERFACE			0
#define USB_CONFIGURATION		1
#define NUM_TRIGGER_STAGES		4
#define TRIGGER_TYPE 			"01"
#define PACKET_SIZE			2048	/* ?? */

//#define ZP_EXPERIMENTAL

struct zp_model {
	uint16_t vid;
	uint16_t pid;
	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, 0x7009, "LAP-C(16064)",  16, 64,   100},
	{0x0c12, 0x700a, "LAP-C(16128)",  16, 128,  200},
	/* TODO: We don't know anything about these.
	{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},
	{ 0, 0, 0, 0, 0, 0 }
};

static const int32_t hwcaps[] = {
	SR_CONF_LOGIC_ANALYZER,
	SR_CONF_SAMPLERATE,
	SR_CONF_CAPTURE_RATIO,
	SR_CONF_LIMIT_SAMPLES,
};

/*
 * ZEROPLUS LAP-C (16032) numbers the 16 probes A0-A7 and B0-B7.
 * We currently ignore other untested/unsupported devices here.
 */
static const char *probe_names[] = {
	"A0", "A1", "A2", "A3", "A4", "A5", "A6", "A7",
	"B0", "B1", "B2", "B3", "B4", "B5", "B6", "B7",
	NULL,
};

SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info;
static struct sr_dev_driver *di = &zeroplus_logic_cube_driver_info;

/*
 * 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),
};

static int hw_dev_close(struct sr_dev_inst *sdi);

#if 0
static int configure_probes(const struct sr_dev_inst *sdi)
{
	struct dev_context *devc;
	const struct sr_probe *probe;
	const GSList *l;
	int probe_bit, stage, i;
	char *tc;

	/* Note: sdi and sdi->priv are non-NULL, the caller checked this. */
	devc = sdi->priv;

	devc->probe_mask = 0;
	for (i = 0; i < NUM_TRIGGER_STAGES; i++) {
		devc->trigger_mask[i] = 0;
		devc->trigger_value[i] = 0;
	}

	stage = -1;
	for (l = sdi->probes; l; l = l->next) {
		probe = (struct sr_probe *)l->data;
		if (probe->enabled == FALSE)
			continue;
		probe_bit = 1 << (probe->index);
		devc->probe_mask |= probe_bit;

		if (probe->trigger) {
			stage = 0;
			for (tc = probe->trigger; *tc; tc++) {
				devc->trigger_mask[stage] |= probe_bit;
				if (*tc == '1')
					devc->trigger_value[stage] |= probe_bit;
				stage++;
				if (stage > NUM_TRIGGER_STAGES)
					return SR_ERR;
			}
		}
	}

	return SR_OK;
}
#endif

static int configure_probes(const struct sr_dev_inst *sdi)
{
	struct dev_context *devc;
	const GSList *l;
	const struct sr_probe *probe;
	char *tc;
	int type;

	/* Note: sdi and sdi->priv are non-NULL, the caller checked this. */
	devc = sdi->priv;

	for (l = sdi->probes; l; l = l->next) {
		probe = (struct sr_probe *)l->data;
		if (probe->enabled == FALSE)
			continue;

		if ((tc = probe->trigger)) {
			switch (*tc) {
			case '1':
				type = TRIGGER_HIGH;
				break;
			case '0':
				type = TRIGGER_LOW;
				break;
#if 0
			case 'r':
				type = TRIGGER_POSEDGE;
				break;
			case 'f':
				type = TRIGGER_NEGEDGE;
				break;
			case 'c':
				type = TRIGGER_ANYEDGE;
				break;
#endif
			default:
				return SR_ERR;
			}
			analyzer_add_trigger(probe->index, type);
			devc->trigger = 1;
		}
	}

	return SR_OK;
}

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 int clear_instances(void)
{
	GSList *l;
	struct sr_dev_inst *sdi;
	struct drv_context *drvc;
	struct dev_context *devc;

	drvc = di->priv;
	for (l = drvc->instances; l; l = l->next) {
		sdi = l->data;
		if (!(devc = sdi->priv)) {
			/* Log error, but continue cleaning up the rest. */
			sr_err("%s: sdi->priv was NULL, continuing", __func__);
			continue;
		}
		sr_usb_dev_inst_free(devc->usb);
		/* Properly close all devices... */
		hw_dev_close(sdi);
		/* ...and free all their memory. */
		sr_dev_inst_free(sdi);
	}
	g_slist_free(drvc->instances);
	drvc->instances = NULL;

	return SR_OK;
}

static int hw_init(struct sr_context *sr_ctx)
{
	return std_hw_init(sr_ctx, di, "zeroplus: ");
}

static GSList *hw_scan(GSList *options)
{
	struct sr_dev_inst *sdi;
	struct sr_probe *probe;
	struct drv_context *drvc;
	struct dev_context *devc;
	const struct zp_model *prof;
	struct libusb_device_descriptor des;
	libusb_device **devlist;
	GSList *devices;
	int ret, devcnt, i, j;

	(void)options;

	drvc = di->priv;

	devices = NULL;

	clear_instances();

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

	for (i = 0; devlist[i]; i++) {
		ret = libusb_get_device_descriptor(devlist[i], &des);
		if (ret != 0) {
			sr_err("Failed to get device descriptor: %s.",
			       libusb_error_name(ret));
			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];
			}
		}
		/* Skip if the device was not found. */
		if (!prof)
			continue;
		sr_info("Found ZEROPLUS %s.", prof->model_name);

		/* Register the device with libsigrok. */
		if (!(sdi = sr_dev_inst_new(devcnt, SR_ST_INACTIVE,
				VENDOR_NAME, prof->model_name, NULL))) {
			sr_err("%s: sr_dev_inst_new failed", __func__);
			return NULL;
		}
		sdi->driver = di;

		/* Allocate memory for our private driver context. */
		if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
			sr_err("Device context malloc failed.");
			return NULL;
		}

		sdi->priv = devc;
		devc->prof = prof;
		devc->num_channels = prof->channels;
#ifdef ZP_EXPERIMENTAL
		devc->max_memory_size = 128 * 1024;
		devc->max_samplerate = 200;
#else
		devc->max_memory_size = 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);

		/* Fill in probelist according to this device's profile. */
		for (j = 0; j < devc->num_channels; j++) {
			if (!(probe = sr_probe_new(j, SR_PROBE_LOGIC, TRUE,
					probe_names[j])))
				return NULL;
			sdi->probes = g_slist_append(sdi->probes, probe);
		}

		devices = g_slist_append(devices, sdi);
		drvc->instances = g_slist_append(drvc->instances, sdi);
		devc->usb = sr_usb_dev_inst_new(
			libusb_get_bus_number(devlist[i]),
			libusb_get_device_address(devlist[i]), NULL);
		devcnt++;

	}
	libusb_free_device_list(devlist, 1);

	return devices;
}

static GSList *hw_dev_list(void)
{
	return ((struct drv_context *)(di->priv))->instances;
}

static int hw_dev_open(struct sr_dev_inst *sdi)
{
	struct dev_context *devc;
	struct drv_context *drvc;
	libusb_device **devlist, *dev;
	struct libusb_device_descriptor des;
	int device_count, ret, i;

	drvc = di->priv;

	if (!(devc = sdi->priv)) {
		sr_err("%s: sdi->priv was NULL", __func__);
		return SR_ERR_ARG;
	}

	device_count = libusb_get_device_list(drvc->sr_ctx->libusb_ctx,
					      &devlist);
	if (device_count < 0) {
		sr_err("Failed to retrieve device list.");
		return SR_ERR;
	}

	dev = NULL;
	for (i = 0; i < device_count; i++) {
		if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
			sr_err("Failed to get device descriptor: %s.",
			       libusb_error_name(ret));
			continue;
		}
		if (libusb_get_bus_number(devlist[i]) == devc->usb->bus
		    && libusb_get_device_address(devlist[i]) == devc->usb->address) {
			dev = devlist[i];
			break;
		}
	}
	if (!dev) {
		sr_err("Device on bus %d address %d disappeared!",
		       devc->usb->bus, devc->usb->address);
		return SR_ERR;
	}

	if (!(ret = libusb_open(dev, &(devc->usb->devhdl)))) {
		sdi->status = SR_ST_ACTIVE;
		sr_info("Opened device %d on %d.%d interface %d.",
			sdi->index, devc->usb->bus,
			devc->usb->address, USB_INTERFACE);
	} else {
		sr_err("Failed to open device: %s.", libusb_error_name(ret));
		return SR_ERR;
	}

	ret = libusb_set_configuration(devc->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(devc->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(devc->usb->devhdl) == 0)
		analyzer_configure(devc->usb->devhdl);

	analyzer_reset(devc->usb->devhdl);
	analyzer_initialize(devc->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);
	}

	return SR_OK;
}

static int hw_dev_close(struct sr_dev_inst *sdi)
{
	struct dev_context *devc;

	devc = sdi->priv;

	if (!devc->usb->devhdl)
		return SR_ERR;

	sr_info("Closing device %d on %d.%d interface %d.", sdi->index,
		devc->usb->bus, devc->usb->address, USB_INTERFACE);
	libusb_release_interface(devc->usb->devhdl, USB_INTERFACE);
	libusb_reset_device(devc->usb->devhdl);
	libusb_close(devc->usb->devhdl);
	devc->usb->devhdl = NULL;
	sdi->status = SR_ST_INACTIVE;

	return SR_OK;
}

static int hw_cleanup(void)
{
	struct drv_context *drvc;

	if (!(drvc = di->priv))
		return SR_OK;

	clear_instances();

	return SR_OK;
}

static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi)
{
	struct dev_context *devc;

	switch (id) {
	case SR_CONF_SAMPLERATE:
		if (sdi) {
			devc = sdi->priv;
			*data = g_variant_new_uint64(devc->cur_samplerate);
			sr_spew("Returning samplerate: %" PRIu64 "Hz.",
				devc->cur_samplerate);
		} else
			return SR_ERR;
		break;
	default:
		return SR_ERR_ARG;
	}

	return SR_OK;
}

static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi)
{
	struct dev_context *devc;

	if (!sdi) {
		sr_err("%s: sdi was NULL", __func__);
		return SR_ERR_ARG;
	}

	if (!(devc = sdi->priv)) {
		sr_err("%s: sdi->priv was NULL", __func__);
		return SR_ERR_ARG;
	}

	switch (id) {
	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:
		return set_capture_ratio(devc, g_variant_get_uint64(data));
	default:
		return SR_ERR;
	}

	return SR_OK;
}

static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
{
	struct dev_context *devc;
	GVariant *gvar;
	GVariantBuilder gvb;

	switch (key) {
	case SR_CONF_DEVICE_OPTIONS:
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
				hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
		break;
	case SR_CONF_SAMPLERATE:
		devc = sdi->priv;
		g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
		if (devc->prof->max_sampling_freq == 100) {
			gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
					samplerates_100, ARRAY_SIZE(samplerates_100),
					sizeof(uint64_t));
		} else if (devc->prof->max_sampling_freq == 200) {
			gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
					samplerates_200, ARRAY_SIZE(samplerates_200),
					sizeof(uint64_t));
		} else {
			sr_err("Internal error: Unknown max. samplerate: %d.",
			       devc->prof->max_sampling_freq);
			return SR_ERR_ARG;
		}
		g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
		*data = g_variant_builder_end(&gvb);
		break;
	case SR_CONF_TRIGGER_TYPE:
		*data = g_variant_new_string(TRIGGER_TYPE);
		break;
	default:
		return SR_ERR_ARG;
	}

	return SR_OK;
}

static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
		void *cb_data)
{
	struct sr_datafeed_packet packet;
	struct sr_datafeed_logic logic;
	//uint64_t samples_read;
	int res;
	unsigned int packet_num, n;
	unsigned char *buf;
	struct dev_context *devc;

	if (!(devc = sdi->priv)) {
		sr_err("%s: sdi->priv was NULL", __func__);
		return SR_ERR_ARG;
	}

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

	set_triggerbar(devc);

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

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

	sr_info("Stop address    = 0x%x.",
		analyzer_get_stop_address(devc->usb->devhdl));
	sr_info("Now address     = 0x%x.",
		analyzer_get_now_address(devc->usb->devhdl));
	sr_info("Trigger address = 0x%x.",
		analyzer_get_trigger_address(devc->usb->devhdl));

	/* Send header packet to the session bus. */
	std_session_send_df_header(cb_data, DRIVER_LOG_DOMAIN);

	if (!(buf = g_try_malloc(PACKET_SIZE))) {
		sr_err("Packet buffer malloc failed.");
		return SR_ERR_MALLOC;
	}

	//samples_read = 0;
	analyzer_read_start(devc->usb->devhdl);
	/* Send the incoming transfer to the session bus. */
	n = get_memory_size(devc->memory_size);
	if (devc->max_memory_size * 4 < n)
		n = devc->max_memory_size * 4;
	for (packet_num = 0; packet_num < n / PACKET_SIZE; packet_num++) {
		res = analyzer_read_data(devc->usb->devhdl, buf, PACKET_SIZE);
		sr_info("Tried to read %d bytes, actually read %d bytes.",
			PACKET_SIZE, res);

		packet.type = SR_DF_LOGIC;
		packet.payload = &logic;
		logic.length = PACKET_SIZE;
		logic.unitsize = 4;
		logic.data = buf;
		sr_session_send(cb_data, &packet);
		//samples_read += res / 4;
	}
	analyzer_read_stop(devc->usb->devhdl);
	g_free(buf);

	packet.type = SR_DF_END;
	sr_session_send(cb_data, &packet);

	return SR_OK;
}

/* TODO: This stops acquisition on ALL devices, ignoring dev_index. */
static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
{
	struct sr_datafeed_packet packet;
	struct dev_context *devc;

	packet.type = SR_DF_END;
	sr_session_send(cb_data, &packet);

	if (!(devc = sdi->priv)) {
		sr_err("%s: sdi->priv was NULL", __func__);
		return SR_ERR_BUG;
	}

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

	return SR_OK;
}

SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info = {
	.name = "zeroplus-logic-cube",
	.longname = "ZEROPLUS Logic Cube LAP-C series",
	.api_version = 1,
	.init = hw_init,
	.cleanup = hw_cleanup,
	.scan = hw_scan,
	.dev_list = hw_dev_list,
	.dev_clear = hw_cleanup,
	.config_get = config_get,
	.config_set = config_set,
	.config_list = config_list,
	.dev_open = hw_dev_open,
	.dev_close = hw_dev_close,
	.dev_acquisition_start = hw_dev_acquisition_start,
	.dev_acquisition_stop = hw_dev_acquisition_stop,
	.priv = NULL,
};
Commit	Line	Data
	1	/*
	2	* This file is part of the sigrok 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 "protocol.h"
	21
	22	#define VENDOR_NAME "ZEROPLUS"
	23	#define USB_INTERFACE 0
	24	#define USB_CONFIGURATION 1
	25	#define NUM_TRIGGER_STAGES 4
	26	#define TRIGGER_TYPE "01"
	27	#define PACKET_SIZE 2048 /* ?? */
	28
	29	//#define ZP_EXPERIMENTAL
	30
	31	struct zp_model {
	32	uint16_t vid;
	33	uint16_t pid;
	34	char *model_name;
	35	unsigned int channels;
	36	unsigned int sample_depth; /* In Ksamples/channel */
	37	unsigned int max_sampling_freq;
	38	};
	39
	40	/*
	41	* Note -- 16032, 16064 and 16128 usually -- but not always -- have the
	42	* same 128K sample depth.
	43	*/
	44	static const struct zp_model zeroplus_models[] = {
	45	{0x0c12, 0x7009, "LAP-C(16064)", 16, 64, 100},
	46	{0x0c12, 0x700a, "LAP-C(16128)", 16, 128, 200},
	47	/* TODO: We don't know anything about these.
	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	*/
	52	{0x0c12, 0x700e, "LAP-C(16032)", 16, 32, 100},
	53	{0x0c12, 0x7016, "LAP-C(162000)", 16, 2048, 200},
	54	{ 0, 0, 0, 0, 0, 0 }
	55	};
	56
	57	static const int32_t hwcaps[] = {
	58	SR_CONF_LOGIC_ANALYZER,
	59	SR_CONF_SAMPLERATE,
	60	SR_CONF_CAPTURE_RATIO,
	61	SR_CONF_LIMIT_SAMPLES,
	62	};
	63
	64	/*
	65	* ZEROPLUS LAP-C (16032) numbers the 16 probes A0-A7 and B0-B7.
	66	* We currently ignore other untested/unsupported devices here.
	67	*/
	68	static const char *probe_names[] = {
	69	"A0", "A1", "A2", "A3", "A4", "A5", "A6", "A7",
	70	"B0", "B1", "B2", "B3", "B4", "B5", "B6", "B7",
	71	NULL,
	72	};
	73
	74	SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info;
	75	static struct sr_dev_driver *di = &zeroplus_logic_cube_driver_info;
	76
	77	/*
	78	* The hardware supports more samplerates than these, but these are the
	79	* options hardcoded into the vendor's Windows GUI.
	80	*/
	81
	82	static const uint64_t samplerates_100[] = {
	83	SR_HZ(100),
	84	SR_HZ(500),
	85	SR_KHZ(1),
	86	SR_KHZ(5),
	87	SR_KHZ(25),
	88	SR_KHZ(50),
	89	SR_KHZ(100),
	90	SR_KHZ(200),
	91	SR_KHZ(400),
	92	SR_KHZ(800),
	93	SR_MHZ(1),
	94	SR_MHZ(10),
	95	SR_MHZ(25),
	96	SR_MHZ(50),
	97	SR_MHZ(80),
	98	SR_MHZ(100),
	99	};
	100
	101	const uint64_t samplerates_200[] = {
	102	SR_HZ(100),
	103	SR_HZ(500),
	104	SR_KHZ(1),
	105	SR_KHZ(5),
	106	SR_KHZ(25),
	107	SR_KHZ(50),
	108	SR_KHZ(100),
	109	SR_KHZ(200),
	110	SR_KHZ(400),
	111	SR_KHZ(800),
	112	SR_MHZ(1),
	113	SR_MHZ(10),
	114	SR_MHZ(25),
	115	SR_MHZ(50),
	116	SR_MHZ(80),
	117	SR_MHZ(100),
	118	SR_MHZ(150),
	119	SR_MHZ(200),
	120	};
	121
	122	static int hw_dev_close(struct sr_dev_inst *sdi);
	123
	124	#if 0
	125	static int configure_probes(const struct sr_dev_inst *sdi)
	126	{
	127	struct dev_context *devc;
	128	const struct sr_probe *probe;
	129	const GSList *l;
	130	int probe_bit, stage, i;
	131	char *tc;
	132
	133	/* Note: sdi and sdi->priv are non-NULL, the caller checked this. */
	134	devc = sdi->priv;
	135
	136	devc->probe_mask = 0;
	137	for (i = 0; i < NUM_TRIGGER_STAGES; i++) {
	138	devc->trigger_mask[i] = 0;
	139	devc->trigger_value[i] = 0;
	140	}
	141
	142	stage = -1;
	143	for (l = sdi->probes; l; l = l->next) {
	144	probe = (struct sr_probe *)l->data;
	145	if (probe->enabled == FALSE)
	146	continue;
	147	probe_bit = 1 << (probe->index);
	148	devc->probe_mask \|= probe_bit;
	149
	150	if (probe->trigger) {
	151	stage = 0;
	152	for (tc = probe->trigger; *tc; tc++) {
	153	devc->trigger_mask[stage] \|= probe_bit;
	154	if (*tc == '1')
	155	devc->trigger_value[stage] \|= probe_bit;
	156	stage++;
	157	if (stage > NUM_TRIGGER_STAGES)
	158	return SR_ERR;
	159	}
	160	}
	161	}
	162
	163	return SR_OK;
	164	}
	165	#endif
	166
	167	static int configure_probes(const struct sr_dev_inst *sdi)
	168	{
	169	struct dev_context *devc;
	170	const GSList *l;
	171	const struct sr_probe *probe;
	172	char *tc;
	173	int type;
	174
	175	/* Note: sdi and sdi->priv are non-NULL, the caller checked this. */
	176	devc = sdi->priv;
	177
	178	for (l = sdi->probes; l; l = l->next) {
	179	probe = (struct sr_probe *)l->data;
	180	if (probe->enabled == FALSE)
	181	continue;
	182
	183	if ((tc = probe->trigger)) {
	184	switch (*tc) {
	185	case '1':
	186	type = TRIGGER_HIGH;
	187	break;
	188	case '0':
	189	type = TRIGGER_LOW;
	190	break;
	191	#if 0
	192	case 'r':
	193	type = TRIGGER_POSEDGE;
	194	break;
	195	case 'f':
	196	type = TRIGGER_NEGEDGE;
	197	break;
	198	case 'c':
	199	type = TRIGGER_ANYEDGE;
	200	break;
	201	#endif
	202	default:
	203	return SR_ERR;
	204	}
	205	analyzer_add_trigger(probe->index, type);
	206	devc->trigger = 1;
	207	}
	208	}
	209
	210	return SR_OK;
	211	}
	212
	213	SR_PRIV int zp_set_samplerate(struct dev_context *devc, uint64_t samplerate)
	214	{
	215	int i;
	216
	217	for (i = 0; ARRAY_SIZE(samplerates_200); i++)
	218	if (samplerate == samplerates_200[i])
	219	break;
	220
	221	if (i == ARRAY_SIZE(samplerates_200) \|\| samplerate > devc->max_samplerate) {
	222	sr_err("Unsupported samplerate: %" PRIu64 "Hz.", samplerate);
	223	return SR_ERR_ARG;
	224	}
	225
	226	sr_info("Setting samplerate to %" PRIu64 "Hz.", samplerate);
	227
	228	if (samplerate >= SR_MHZ(1))
	229	analyzer_set_freq(samplerate / SR_MHZ(1), FREQ_SCALE_MHZ);
	230	else if (samplerate >= SR_KHZ(1))
	231	analyzer_set_freq(samplerate / SR_KHZ(1), FREQ_SCALE_KHZ);
	232	else
	233	analyzer_set_freq(samplerate, FREQ_SCALE_HZ);
	234
	235	devc->cur_samplerate = samplerate;
	236
	237	return SR_OK;
	238	}
	239
	240	static int clear_instances(void)
	241	{
	242	GSList *l;
	243	struct sr_dev_inst *sdi;
	244	struct drv_context *drvc;
	245	struct dev_context *devc;
	246
	247	drvc = di->priv;
	248	for (l = drvc->instances; l; l = l->next) {
	249	sdi = l->data;
	250	if (!(devc = sdi->priv)) {
	251	/* Log error, but continue cleaning up the rest. */
	252	sr_err("%s: sdi->priv was NULL, continuing", __func__);
	253	continue;
	254	}
	255	sr_usb_dev_inst_free(devc->usb);
	256	/* Properly close all devices... */
	257	hw_dev_close(sdi);
	258	/* ...and free all their memory. */
	259	sr_dev_inst_free(sdi);
	260	}
	261	g_slist_free(drvc->instances);
	262	drvc->instances = NULL;
	263
	264	return SR_OK;
	265	}
	266
	267	static int hw_init(struct sr_context *sr_ctx)
	268	{
	269	return std_hw_init(sr_ctx, di, "zeroplus: ");
	270	}
	271
	272	static GSList hw_scan(GSList options)
	273	{
	274	struct sr_dev_inst *sdi;
	275	struct sr_probe *probe;
	276	struct drv_context *drvc;
	277	struct dev_context *devc;
	278	const struct zp_model *prof;
	279	struct libusb_device_descriptor des;
	280	libusb_device **devlist;
	281	GSList *devices;
	282	int ret, devcnt, i, j;
	283
	284	(void)options;
	285
	286	drvc = di->priv;
	287
	288	devices = NULL;
	289
	290	clear_instances();
	291
	292	/* Find all ZEROPLUS analyzers and add them to device list. */
	293	devcnt = 0;
	294	libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist); /* TODO: Errors. */
	295
	296	for (i = 0; devlist[i]; i++) {
	297	ret = libusb_get_device_descriptor(devlist[i], &des);
	298	if (ret != 0) {
	299	sr_err("Failed to get device descriptor: %s.",
	300	libusb_error_name(ret));
	301	continue;
	302	}
	303
	304	prof = NULL;
	305	for (j = 0; j < zeroplus_models[j].vid; j++) {
	306	if (des.idVendor == zeroplus_models[j].vid &&
	307	des.idProduct == zeroplus_models[j].pid) {
	308	prof = &zeroplus_models[j];
	309	}
	310	}
	311	/* Skip if the device was not found. */
	312	if (!prof)
	313	continue;
	314	sr_info("Found ZEROPLUS %s.", prof->model_name);
	315
	316	/* Register the device with libsigrok. */
	317	if (!(sdi = sr_dev_inst_new(devcnt, SR_ST_INACTIVE,
	318	VENDOR_NAME, prof->model_name, NULL))) {
	319	sr_err("%s: sr_dev_inst_new failed", __func__);
	320	return NULL;
	321	}
	322	sdi->driver = di;
	323
	324	/* Allocate memory for our private driver context. */
	325	if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
	326	sr_err("Device context malloc failed.");
	327	return NULL;
	328	}
	329
	330	sdi->priv = devc;
	331	devc->prof = prof;
	332	devc->num_channels = prof->channels;
	333	#ifdef ZP_EXPERIMENTAL
	334	devc->max_memory_size = 128 * 1024;
	335	devc->max_samplerate = 200;
	336	#else
	337	devc->max_memory_size = prof->sample_depth * 1024;
	338	devc->max_samplerate = prof->max_sampling_freq;
	339	#endif
	340	devc->max_samplerate *= SR_MHZ(1);
	341	devc->memory_size = MEMORY_SIZE_8K;
	342	// memset(devc->trigger_buffer, 0, NUM_TRIGGER_STAGES);
	343
	344	/* Fill in probelist according to this device's profile. */
	345	for (j = 0; j < devc->num_channels; j++) {
	346	if (!(probe = sr_probe_new(j, SR_PROBE_LOGIC, TRUE,
	347	probe_names[j])))
	348	return NULL;
	349	sdi->probes = g_slist_append(sdi->probes, probe);
	350	}
	351
	352	devices = g_slist_append(devices, sdi);
	353	drvc->instances = g_slist_append(drvc->instances, sdi);
	354	devc->usb = sr_usb_dev_inst_new(
	355	libusb_get_bus_number(devlist[i]),
	356	libusb_get_device_address(devlist[i]), NULL);
	357	devcnt++;
	358
	359	}
	360	libusb_free_device_list(devlist, 1);
	361
	362	return devices;
	363	}
	364
	365	static GSList *hw_dev_list(void)
	366	{
	367	return ((struct drv_context *)(di->priv))->instances;
	368	}
	369
	370	static int hw_dev_open(struct sr_dev_inst *sdi)
	371	{
	372	struct dev_context *devc;
	373	struct drv_context *drvc;
	374	libusb_device *devlist, dev;
	375	struct libusb_device_descriptor des;
	376	int device_count, ret, i;
	377
	378	drvc = di->priv;
	379
	380	if (!(devc = sdi->priv)) {
	381	sr_err("%s: sdi->priv was NULL", __func__);
	382	return SR_ERR_ARG;
	383	}
	384
	385	device_count = libusb_get_device_list(drvc->sr_ctx->libusb_ctx,
	386	&devlist);
	387	if (device_count < 0) {
	388	sr_err("Failed to retrieve device list.");
	389	return SR_ERR;
	390	}
	391
	392	dev = NULL;
	393	for (i = 0; i < device_count; i++) {
	394	if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
	395	sr_err("Failed to get device descriptor: %s.",
	396	libusb_error_name(ret));
	397	continue;
	398	}
	399	if (libusb_get_bus_number(devlist[i]) == devc->usb->bus
	400	&& libusb_get_device_address(devlist[i]) == devc->usb->address) {
	401	dev = devlist[i];
	402	break;
	403	}
	404	}
	405	if (!dev) {
	406	sr_err("Device on bus %d address %d disappeared!",
	407	devc->usb->bus, devc->usb->address);
	408	return SR_ERR;
	409	}
	410
	411	if (!(ret = libusb_open(dev, &(devc->usb->devhdl)))) {
	412	sdi->status = SR_ST_ACTIVE;
	413	sr_info("Opened device %d on %d.%d interface %d.",
	414	sdi->index, devc->usb->bus,
	415	devc->usb->address, USB_INTERFACE);
	416	} else {
	417	sr_err("Failed to open device: %s.", libusb_error_name(ret));
	418	return SR_ERR;
	419	}
	420
	421	ret = libusb_set_configuration(devc->usb->devhdl, USB_CONFIGURATION);
	422	if (ret < 0) {
	423	sr_err("Unable to set USB configuration %d: %s.",
	424	USB_CONFIGURATION, libusb_error_name(ret));
	425	return SR_ERR;
	426	}
	427
	428	ret = libusb_claim_interface(devc->usb->devhdl, USB_INTERFACE);
	429	if (ret != 0) {
	430	sr_err("Unable to claim interface: %s.",
	431	libusb_error_name(ret));
	432	return SR_ERR;
	433	}
	434
	435	/* Set default configuration after power on. */
	436	if (analyzer_read_status(devc->usb->devhdl) == 0)
	437	analyzer_configure(devc->usb->devhdl);
	438
	439	analyzer_reset(devc->usb->devhdl);
	440	analyzer_initialize(devc->usb->devhdl);
	441
	442	//analyzer_set_memory_size(MEMORY_SIZE_512K);
	443	// analyzer_set_freq(g_freq, g_freq_scale);
	444	analyzer_set_trigger_count(1);
	445	// analyzer_set_ramsize_trigger_address((((100 - g_pre_trigger)
	446	// * get_memory_size(g_memory_size)) / 100) >> 2);
	447
	448	#if 0
	449	if (g_double_mode == 1)
	450	analyzer_set_compression(COMPRESSION_DOUBLE);
	451	else if (g_compression == 1)
	452	analyzer_set_compression(COMPRESSION_ENABLE);
	453	else
	454	#endif
	455	analyzer_set_compression(COMPRESSION_NONE);
	456
	457	if (devc->cur_samplerate == 0) {
	458	/* Samplerate hasn't been set. Default to 1MHz. */
	459	analyzer_set_freq(1, FREQ_SCALE_MHZ);
	460	devc->cur_samplerate = SR_MHZ(1);
	461	}
	462
	463	return SR_OK;
	464	}
	465
	466	static int hw_dev_close(struct sr_dev_inst *sdi)
	467	{
	468	struct dev_context *devc;
	469
	470	devc = sdi->priv;
	471
	472	if (!devc->usb->devhdl)
	473	return SR_ERR;
	474
	475	sr_info("Closing device %d on %d.%d interface %d.", sdi->index,
	476	devc->usb->bus, devc->usb->address, USB_INTERFACE);
	477	libusb_release_interface(devc->usb->devhdl, USB_INTERFACE);
	478	libusb_reset_device(devc->usb->devhdl);
	479	libusb_close(devc->usb->devhdl);
	480	devc->usb->devhdl = NULL;
	481	sdi->status = SR_ST_INACTIVE;
	482
	483	return SR_OK;
	484	}
	485
	486	static int hw_cleanup(void)
	487	{
	488	struct drv_context *drvc;
	489
	490	if (!(drvc = di->priv))
	491	return SR_OK;
	492
	493	clear_instances();
	494
	495	return SR_OK;
	496	}
	497
	498	static int config_get(int id, GVariant *data, const struct sr_dev_inst sdi)
	499	{
	500	struct dev_context *devc;
	501
	502	switch (id) {
	503	case SR_CONF_SAMPLERATE:
	504	if (sdi) {
	505	devc = sdi->priv;
	506	*data = g_variant_new_uint64(devc->cur_samplerate);
	507	sr_spew("Returning samplerate: %" PRIu64 "Hz.",
	508	devc->cur_samplerate);
	509	} else
	510	return SR_ERR;
	511	break;
	512	default:
	513	return SR_ERR_ARG;
	514	}
	515
	516	return SR_OK;
	517	}
	518
	519	static int config_set(int id, GVariant data, const struct sr_dev_inst sdi)
	520	{
	521	struct dev_context *devc;
	522
	523	if (!sdi) {
	524	sr_err("%s: sdi was NULL", __func__);
	525	return SR_ERR_ARG;
	526	}
	527
	528	if (!(devc = sdi->priv)) {
	529	sr_err("%s: sdi->priv was NULL", __func__);
	530	return SR_ERR_ARG;
	531	}
	532
	533	switch (id) {
	534	case SR_CONF_SAMPLERATE:
	535	return zp_set_samplerate(devc, g_variant_get_uint64(data));
	536	case SR_CONF_LIMIT_SAMPLES:
	537	return set_limit_samples(devc, g_variant_get_uint64(data));
	538	case SR_CONF_CAPTURE_RATIO:
	539	return set_capture_ratio(devc, g_variant_get_uint64(data));
	540	default:
	541	return SR_ERR;
	542	}
	543
	544	return SR_OK;
	545	}
	546
	547	static int config_list(int key, GVariant *data, const struct sr_dev_inst sdi)
	548	{
	549	struct dev_context *devc;
	550	GVariant *gvar;
	551	GVariantBuilder gvb;
	552
	553	switch (key) {
	554	case SR_CONF_DEVICE_OPTIONS:
	555	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
	556	hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
	557	break;
	558	case SR_CONF_SAMPLERATE:
	559	devc = sdi->priv;
	560	g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
	561	if (devc->prof->max_sampling_freq == 100) {
	562	gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
	563	samplerates_100, ARRAY_SIZE(samplerates_100),
	564	sizeof(uint64_t));
	565	} else if (devc->prof->max_sampling_freq == 200) {
	566	gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
	567	samplerates_200, ARRAY_SIZE(samplerates_200),
	568	sizeof(uint64_t));
	569	} else {
	570	sr_err("Internal error: Unknown max. samplerate: %d.",
	571	devc->prof->max_sampling_freq);
	572	return SR_ERR_ARG;
	573	}
	574	g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
	575	*data = g_variant_builder_end(&gvb);
	576	break;
	577	case SR_CONF_TRIGGER_TYPE:
	578	*data = g_variant_new_string(TRIGGER_TYPE);
	579	break;
	580	default:
	581	return SR_ERR_ARG;
	582	}
	583
	584	return SR_OK;
	585	}
	586
	587	static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
	588	void *cb_data)
	589	{
	590	struct sr_datafeed_packet packet;
	591	struct sr_datafeed_logic logic;
	592	//uint64_t samples_read;
	593	int res;
	594	unsigned int packet_num, n;
	595	unsigned char *buf;
	596	struct dev_context *devc;
	597
	598	if (!(devc = sdi->priv)) {
	599	sr_err("%s: sdi->priv was NULL", __func__);
	600	return SR_ERR_ARG;
	601	}
	602
	603	if (configure_probes(sdi) != SR_OK) {
	604	sr_err("Failed to configure probes.");
	605	return SR_ERR;
	606	}
	607
	608	set_triggerbar(devc);
	609
	610	/* Push configured settings to device. */
	611	analyzer_configure(devc->usb->devhdl);
	612
	613	analyzer_start(devc->usb->devhdl);
	614	sr_info("Waiting for data.");
	615	analyzer_wait_data(devc->usb->devhdl);
	616
	617	sr_info("Stop address = 0x%x.",
	618	analyzer_get_stop_address(devc->usb->devhdl));
	619	sr_info("Now address = 0x%x.",
	620	analyzer_get_now_address(devc->usb->devhdl));
	621	sr_info("Trigger address = 0x%x.",
	622	analyzer_get_trigger_address(devc->usb->devhdl));
	623
	624	/* Send header packet to the session bus. */
	625	std_session_send_df_header(cb_data, DRIVER_LOG_DOMAIN);
	626
	627	if (!(buf = g_try_malloc(PACKET_SIZE))) {
	628	sr_err("Packet buffer malloc failed.");
	629	return SR_ERR_MALLOC;
	630	}
	631
	632	//samples_read = 0;
	633	analyzer_read_start(devc->usb->devhdl);
	634	/* Send the incoming transfer to the session bus. */
	635	n = get_memory_size(devc->memory_size);
	636	if (devc->max_memory_size * 4 < n)
	637	n = devc->max_memory_size * 4;
	638	for (packet_num = 0; packet_num < n / PACKET_SIZE; packet_num++) {
	639	res = analyzer_read_data(devc->usb->devhdl, buf, PACKET_SIZE);
	640	sr_info("Tried to read %d bytes, actually read %d bytes.",
	641	PACKET_SIZE, res);
	642
	643	packet.type = SR_DF_LOGIC;
	644	packet.payload = &logic;
	645	logic.length = PACKET_SIZE;
	646	logic.unitsize = 4;
	647	logic.data = buf;
	648	sr_session_send(cb_data, &packet);
	649	//samples_read += res / 4;
	650	}
	651	analyzer_read_stop(devc->usb->devhdl);
	652	g_free(buf);
	653
	654	packet.type = SR_DF_END;
	655	sr_session_send(cb_data, &packet);
	656
	657	return SR_OK;
	658	}
	659
	660	/* TODO: This stops acquisition on ALL devices, ignoring dev_index. */
	661	static int hw_dev_acquisition_stop(struct sr_dev_inst sdi, void cb_data)
	662	{
	663	struct sr_datafeed_packet packet;
	664	struct dev_context *devc;
	665
	666	packet.type = SR_DF_END;
	667	sr_session_send(cb_data, &packet);
	668
	669	if (!(devc = sdi->priv)) {
	670	sr_err("%s: sdi->priv was NULL", __func__);
	671	return SR_ERR_BUG;
	672	}
	673
	674	analyzer_reset(devc->usb->devhdl);
	675	/* TODO: Need to cancel and free any queued up transfers. */
	676
	677	return SR_OK;
	678	}
	679
	680	SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info = {
	681	.name = "zeroplus-logic-cube",
	682	.longname = "ZEROPLUS Logic Cube LAP-C series",
	683	.api_version = 1,
	684	.init = hw_init,
	685	.cleanup = hw_cleanup,
	686	.scan = hw_scan,
	687	.dev_list = hw_dev_list,
	688	.dev_clear = hw_cleanup,
	689	.config_get = config_get,
	690	.config_set = config_set,
	691	.config_list = config_list,
	692	.dev_open = hw_dev_open,
	693	.dev_close = hw_dev_close,
	694	.dev_acquisition_start = hw_dev_acquisition_start,
	695	.dev_acquisition_stop = hw_dev_acquisition_stop,
	696	.priv = NULL,
	697	};