[libsigrok.git] / hardware / zeroplus-logic-cube / zeroplus.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 <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/time.h>
#include <inttypes.h>
#include <glib.h>
#include <libusb.h>
#include "config.h"
#include "libsigrok.h"
#include "libsigrok-internal.h"
#include "analyzer.h"

#define USB_VENDOR			0x0c12

#define VENDOR_NAME			"ZEROPLUS"
#define MODEL_NAME			"Logic Cube LAP-C"
#define MODEL_VERSION			NULL

#define NUM_PROBES			16
#define USB_INTERFACE			0
#define USB_CONFIGURATION		1
#define NUM_TRIGGER_STAGES		4
#define TRIGGER_TYPES			"01"

#define PACKET_SIZE			2048	/* ?? */

typedef struct {
	unsigned short vid;
	unsigned short pid;
	char *model_name;
	unsigned int channels;
	unsigned int sample_depth;	/* In Ksamples/channel */
	unsigned int max_sampling_freq;
} model_t;

/*
 * Note -- 16032, 16064 and 16128 *usually* -- but not always -- have the
 * same 128K sample depth.
 */
static model_t 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 int hwcaps[] = {
	SR_HWCAP_LOGIC_ANALYZER,
	SR_HWCAP_SAMPLERATE,
	SR_HWCAP_CAPTURE_RATIO,

	/* These are really implemented in the driver, not the hardware. */
	SR_HWCAP_LIMIT_SAMPLES,
	0,
};

/*
 * 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[NUM_PROBES + 1] = {
	"A0",
	"A1",
	"A2",
	"A3",
	"A4",
	"A5",
	"A6",
	"A7",
	"B0",
	"B1",
	"B2",
	"B3",
	"B4",
	"B5",
	"B6",
	"B7",
	NULL,
};

/* List of struct sr_dev_inst, maintained by dev_open()/dev_close(). */
SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info;
static struct sr_dev_driver *zdi = &zeroplus_logic_cube_driver_info;

static libusb_context *usb_context = NULL;

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

/*
 * TODO: We shouldn't support 150MHz and 200MHz on devices that don't go up
 * that high.
 */
static const uint64_t supported_samplerates[] = {
	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),
	0,
};

static const struct sr_samplerates samplerates = {
	0,
	0,
	0,
	supported_samplerates,
};

/* Private driver context. */
struct drv_context {
	GSList *instances;
};

/* Private, per-device-instance driver context. */
struct dev_context {
	uint64_t cur_samplerate;
	uint64_t limit_samples;
	int num_channels; /* TODO: This isn't initialized before it's needed :( */
	uint64_t memory_size;
	uint8_t probe_mask;
	uint8_t trigger_mask[NUM_TRIGGER_STAGES];
	uint8_t trigger_value[NUM_TRIGGER_STAGES];
	// uint8_t trigger_buffer[NUM_TRIGGER_STAGES];

	/* TODO: this belongs in the device instance */
	struct sr_usb_dev_inst *usb;
};

static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
		const void *value);
static int hw_dev_close(struct sr_dev_inst *sdi);

static unsigned int get_memory_size(int type)
{
	if (type == MEMORY_SIZE_8K)
		return 8 * 1024;
	else if (type == MEMORY_SIZE_64K)
		return 64 * 1024;
	else if (type == MEMORY_SIZE_128K)
		return 128 * 1024;
	else if (type == MEMORY_SIZE_512K)
		return 512 * 1024;
	else
		return 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;
}

static void clear_instances(void)
{
	GSList *l;
	struct sr_dev_inst *sdi;
	struct drv_context *drvc;
	struct dev_context *devc;

	drvc = zdi->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("zeroplus: %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;

}

/*
 * API callbacks
 */

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

	if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
		sr_err("zeroplus: driver context malloc failed.");
		return SR_ERR;
	}
	zdi->priv = drvc;

	if (libusb_init(&usb_context) != 0) {
		sr_err("zp: Failed to initialize USB.");
		return 0;
	}

	return SR_OK;
}

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

	(void)options;
	drvc = zdi->priv;
	devices = NULL;

	clear_instances();

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

	for (i = 0; devlist[i]; i++) {
		ret = libusb_get_device_descriptor(devlist[i], &des);
		if (ret != 0) {
			sr_err("zp: failed to get device descriptor: %d", 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("zp: Found ZEROPLUS model %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("zp: %s: sr_dev_inst_new failed", __func__);
			return NULL;
		}
		sdi->driver = zdi;

		/* Allocate memory for our private driver context. */
		if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
			sr_err("zp: %s: devc malloc failed", __func__);
			return 0;
		}
		sdi->priv = devc;
		devc->num_channels = prof->channels;
		devc->memory_size = prof->sample_depth * 1024;
		// 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 int hw_dev_open(struct sr_dev_inst *sdi)
{
	struct dev_context *devc;
	libusb_device **devlist, *dev;
	struct libusb_device_descriptor des;
	int device_count, ret, i;

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

	device_count = libusb_get_device_list(usb_context, &devlist);
	if (device_count < 0) {
		sr_err("zp: 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("fx2lafw: Failed to get device descriptor: %d.",
			       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("zp: opened device %d on %d.%d interface %d",
			sdi->index, devc->usb->bus,
			devc->usb->address, USB_INTERFACE);
	} else {
		sr_err("zp: failed to open device: %d", ret);
		return SR_ERR;
	}

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

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

	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);
	analyzer_set_ramsize_trigger_address(
		(100 * get_memory_size(MEMORY_SIZE_512K) / 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 the slowest one. */
		if (hw_dev_config_set(sdi, SR_HWCAP_SAMPLERATE,
		     &samplerates.list[0]) == SR_ERR)
			return SR_ERR;
	}

	return SR_OK;
}

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

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

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

	sr_info("zp: 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 = zdi->priv))
		return SR_OK;

	clear_instances();

	if (usb_context)
		libusb_exit(usb_context);
	usb_context = NULL;

	return SR_OK;
}

static int hw_info_get(int info_id, const void **data,
       const struct sr_dev_inst *sdi)
{
	struct dev_context *devc;

	switch (info_id) {
	case SR_DI_HWCAPS:
		*data = hwcaps;
		break;
	case SR_DI_NUM_PROBES:
		if (sdi) {
			devc = sdi->priv;
			*data = GINT_TO_POINTER(devc->num_channels);
			sr_spew("zp: %s: Returning number of channels: %d.",
					__func__, devc->num_channels);
		} else
			return SR_ERR;
		break;
	case SR_DI_PROBE_NAMES:
		*data = probe_names;
		sr_spew("zp: %s: Returning probenames.", __func__);
		break;
	case SR_DI_SAMPLERATES:
		*data = &samplerates;
		sr_spew("zp: %s: Returning samplerates.", __func__);
		break;
	case SR_DI_TRIGGER_TYPES:
		*data = TRIGGER_TYPES;
		sr_spew("zp: %s: Returning triggertypes: %s.", __func__, TRIGGER_TYPES);
		break;
	case SR_DI_CUR_SAMPLERATE:
		if (sdi) {
			devc = sdi->priv;
			*data = &devc->cur_samplerate;
			sr_spew("zp: %s: Returning samplerate: %" PRIu64 "Hz.",
				__func__, devc->cur_samplerate);
		} else
			return SR_ERR;
		break;
	default:
		return SR_ERR_ARG;
	}

	return SR_OK;
}

static int set_samplerate(const struct sr_dev_inst *sdi, uint64_t samplerate)
{
	struct dev_context *devc;

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

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

	sr_info("zp: 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 hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
		const void *value)
{
	struct dev_context *devc;

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

	switch (hwcap) {
	case SR_HWCAP_SAMPLERATE:
		return set_samplerate(sdi, *(const uint64_t *)value);
	case SR_HWCAP_LIMIT_SAMPLES:
		devc->limit_samples = *(const uint64_t *)value;
		return SR_OK;
	default:
		return SR_ERR;
	}
}

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;
	struct sr_datafeed_header header;
	struct sr_datafeed_meta_logic meta;
	uint64_t samples_read;
	int res;
	unsigned int packet_num;
	unsigned char *buf;
	struct dev_context *devc;

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

	if (configure_probes(sdi) != SR_OK) {
		sr_err("zp: failed to configured probes");
		return SR_ERR;
	}

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

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

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

	packet.type = SR_DF_HEADER;
	packet.payload = &header;
	header.feed_version = 1;
	gettimeofday(&header.starttime, NULL);
	sr_session_send(cb_data, &packet);

	/* Send metadata about the SR_DF_LOGIC packets to come. */
	packet.type = SR_DF_META_LOGIC;
	packet.payload = &meta;
	meta.samplerate = devc->cur_samplerate;
	meta.num_probes = devc->num_channels;
	sr_session_send(cb_data, &packet);

	if (!(buf = g_try_malloc(PACKET_SIZE))) {
		sr_err("zp: %s: buf malloc failed", __func__);
		return SR_ERR_MALLOC;
	}

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