X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=hardware%2Ffx2lafw%2Ffx2lafw.c;h=359df017a56f223817453ce5be5f330b8af15b08;hb=9031ce63f3cee037ffc3e565cf324cafe38522f5;hp=f37557755d8fcfe42ae5d75b7d9ff8c4832fb411;hpb=f302a082567d10f90cd20fca5a7abd68d7267d96;p=libsigrok.git

diff --git a/hardware/fx2lafw/fx2lafw.c b/hardware/fx2lafw/fx2lafw.c
index f3755775..359df017 100644
--- a/hardware/fx2lafw/fx2lafw.c
+++ b/hardware/fx2lafw/fx2lafw.c
@@ -19,12 +19,225 @@
 
 #include <stdio.h>
 #include <stdlib.h>
-
+#include <inttypes.h>
+#include <glib.h>
+#include <libusb.h>
 #include "config.h"
 #include "sigrok.h"
 #include "sigrok-internal.h"
 #include "fx2lafw.h"
+#include "command.h"
+
+static struct fx2lafw_profile supported_fx2[] = {
+	/* USBee AX */
+	{ 0x08a9, 0x0014, "CWAV", "USBee AX", NULL, 8 },
+	{ 0, 0, 0, 0, 0, 0 }
+};
+
+static int fx2lafw_capabilities[] = {
+	SR_HWCAP_LOGIC_ANALYZER,
+	SR_HWCAP_SAMPLERATE,
+
+	/* These are really implemented in the driver, not the hardware. */
+	SR_HWCAP_LIMIT_SAMPLES,
+	SR_HWCAP_CONTINUOUS,
+	0,
+};
+
+static const char *fx2lafw_probe_names[] = {
+	"D0",
+	"D1",
+	"D2",
+	"D3",
+	"D4",
+	"D5",
+	"D6",
+	"D7",
+	NULL,
+};
+
+static uint64_t fx2lafw_supported_samplerates[] = {
+	SR_MHZ(1),
+	SR_MHZ(2),
+	SR_MHZ(3),
+	SR_MHZ(4),
+	SR_MHZ(6),
+	SR_MHZ(8),
+	SR_MHZ(12),
+	SR_MHZ(16),
+	SR_MHZ(24),
+};
+
+static struct sr_samplerates fx2lafw_samplerates = {
+	SR_MHZ(1),
+	SR_MHZ(24),
+	SR_HZ(0),
+	fx2lafw_supported_samplerates,
+};
+
+static GSList *dev_insts = NULL;
+static libusb_context *usb_context = NULL;
+
+static int hw_dev_config_set(int dev_index, int hwcap, void *value);
+static int hw_dev_acquisition_stop(int dev_index, void *session_dev_id);
+
+/**
+ * Check the USB configuration to determine if this is an fx2lafw device.
+ *
+ * @return TRUE if the device's configuration profile match fx2lafw
+ *         configuration, FALSE otherwise.
+ */
+static gboolean check_conf_profile(libusb_device *dev)
+{
+	struct libusb_device_descriptor des;
+	struct libusb_config_descriptor *conf_dsc = NULL;
+	const struct libusb_interface_descriptor *intf_dsc;
+	gboolean ret = FALSE;
+
+	while (!ret) {
+		/* Assume it's not a Saleae Logic unless proven wrong. */
+		ret = 0;
+
+		if (libusb_get_device_descriptor(dev, &des) != 0)
+			break;
+
+		if (des.bNumConfigurations != 1)
+			/* Need exactly 1 configuration. */
+			break;
+
+		if (libusb_get_config_descriptor(dev, 0, &conf_dsc) != 0)
+			break;
+
+		if (conf_dsc->bNumInterfaces != 1)
+			/* Need exactly 1 interface. */
+			break;
+
+		if (conf_dsc->interface[0].num_altsetting != 1)
+			/* Need just one alternate setting. */
+			break;
+
+		intf_dsc = &(conf_dsc->interface[0].altsetting[0]);
+		if (intf_dsc->bNumEndpoints != 2)
+			/* Need exactly 2 end points. */
+			break;
+
+		if ((intf_dsc->endpoint[0].bEndpointAddress & 0x8f) !=
+		    (2 | LIBUSB_ENDPOINT_IN)) // 0x82
+			/* The first endpoint should be 2 (inbound). */
+			break;
+
+		/* TODO: Check the debug channel... */
+
+		/* If we made it here, it must be an fx2lafw. */
+		ret = TRUE;
+	}
+
+	if (conf_dsc)
+		libusb_free_config_descriptor(conf_dsc);
+
+	return ret;
+}
 
+static int fx2lafw_open_dev(int dev_index)
+{
+	libusb_device **devlist;
+	struct libusb_device_descriptor des;
+	struct sr_dev_inst *sdi;
+	struct context *ctx;
+	int err, skip, i;
+
+	if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
+		return SR_ERR;
+	ctx = sdi->priv;
+
+	if (sdi->status == SR_ST_ACTIVE)
+		/* already in use */
+		return SR_ERR;
+
+	skip = 0;
+	libusb_get_device_list(usb_context, &devlist);
+	for (i = 0; devlist[i]; i++) {
+		if ((err = libusb_get_device_descriptor(devlist[i], &des))) {
+			sr_err("fx2lafw: failed to get device descriptor: %d", err);
+			continue;
+		}
+
+		if (des.idVendor != ctx->profile->vid
+		    || des.idProduct != ctx->profile->pid)
+			continue;
+
+		if (sdi->status == SR_ST_INITIALIZING) {
+			if (skip != dev_index) {
+				/* Skip devices of this type that aren't the one we want. */
+				skip += 1;
+				continue;
+			}
+		} else if (sdi->status == SR_ST_INACTIVE) {
+			/*
+			 * This device is fully enumerated, so we need to find
+			 * this device by vendor, product, bus and address.
+			 */
+			if (libusb_get_bus_number(devlist[i]) != ctx->usb->bus
+				|| libusb_get_device_address(devlist[i]) != ctx->usb->address)
+				/* this is not the one */
+				continue;
+		}
+
+		if (!(err = libusb_open(devlist[i], &ctx->usb->devhdl))) {
+			if (ctx->usb->address == 0xff)
+				/*
+				 * first time we touch this device after firmware upload,
+				 * so we don't know the address yet.
+				 */
+				ctx->usb->address = libusb_get_device_address(devlist[i]);
+
+			sdi->status = SR_ST_ACTIVE;
+			sr_info("fx2lafw: opened device %d on %d.%d interface %d",
+				sdi->index, ctx->usb->bus,
+				ctx->usb->address, USB_INTERFACE);
+		} else {
+			sr_err("fx2lafw: failed to open device: %d", err);
+		}
+
+		/* if we made it here, we handled the device one way or another */
+		break;
+	}
+	libusb_free_device_list(devlist, 1);
+
+	if (sdi->status != SR_ST_ACTIVE)
+		return SR_ERR;
+
+	return SR_OK;
+}
+
+static void close_dev(struct sr_dev_inst *sdi)
+{
+	struct context *ctx;
+
+	ctx = sdi->priv;
+
+	if (ctx->usb->devhdl == NULL)
+		return;
+
+	sr_info("fx2lafw: closing device %d on %d.%d interface %d", sdi->index,
+		ctx->usb->bus, ctx->usb->address, USB_INTERFACE);
+	libusb_release_interface(ctx->usb->devhdl, USB_INTERFACE);
+	libusb_close(ctx->usb->devhdl);
+	ctx->usb->devhdl = NULL;
+	sdi->status = SR_ST_INACTIVE;
+}
+
+static struct context *fx2lafw_device_new(void)
+{
+	struct context *ctx;
+
+	if (!(ctx = g_try_malloc0(sizeof(struct context)))) {
+		sr_err("fx2lafw: %s: ctx malloc failed", __func__);
+		return NULL;
+	}
+
+	return ctx;
+}
 
 /*
  * API callbacks
@@ -32,69 +245,442 @@
 
 static int hw_init(const char *deviceinfo)
 {
+	struct sr_dev_inst *sdi;
+	struct libusb_device_descriptor des;
+	struct fx2lafw_profile *fx2lafw_prof;
+	struct context *ctx;
+	libusb_device **devlist;
+	int err;
+	int devcnt = 0;
+	int i, j;
+
+	/* Avoid compiler warnings. */
 	(void)deviceinfo;
-	return 0;
+
+	if (libusb_init(&usb_context) != 0) {
+		sr_warn("Failed to initialize USB.");
+		return 0;
+	}
+
+	/* Find all fx2lafw compatible devices and upload firware to all of them. */
+	libusb_get_device_list(usb_context, &devlist);
+	for (i = 0; devlist[i]; i++) {
+
+		if ((err = libusb_get_device_descriptor(
+			devlist[i], &des)) != 0) {
+			sr_warn("failed to get device descriptor: %d", err);
+			continue;
+		}
+
+		fx2lafw_prof = NULL;
+		for (j = 0; supported_fx2[j].vid; j++) {
+			if (des.idVendor == supported_fx2[j].vid &&
+				des.idProduct == supported_fx2[j].pid) {
+				fx2lafw_prof = &supported_fx2[j];
+			}
+		}
+
+		/* Skip if the device was not found */
+		if(!fx2lafw_prof)
+			continue;
+
+		sdi = sr_dev_inst_new(devcnt, SR_ST_INITIALIZING,
+			fx2lafw_prof->vendor, fx2lafw_prof->model,
+			fx2lafw_prof->model_version);
+		if(!sdi)
+			return 0;
+
+		ctx = fx2lafw_device_new();
+		ctx->profile = fx2lafw_prof;
+		sdi->priv = ctx;
+		dev_insts = g_slist_append(dev_insts, sdi);
+
+		if (check_conf_profile(devlist[i])) {
+			/* Already has the firmware, so fix the new address. */
+			sr_dbg("fx2lafw: Found a fx2lafw device.");
+			sdi->status = SR_ST_INACTIVE;
+			ctx->usb = sr_usb_dev_inst_new
+			    (libusb_get_bus_number(devlist[i]),
+			     libusb_get_device_address(devlist[i]), NULL);
+		} else {
+			if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION, FIRMWARE) == SR_OK)
+				/* Remember when the firmware on this device was updated */
+				g_get_current_time(&ctx->fw_updated);
+			else
+				sr_err("fx2lafw: firmware upload failed for "
+				       "device %d", devcnt);
+			ctx->usb = sr_usb_dev_inst_new
+				(libusb_get_bus_number(devlist[i]), 0xff, NULL);
+		}
+
+		devcnt++;
+	}
+	libusb_free_device_list(devlist, 1);
+
+	return devcnt;
 }
 
-static int hw_dev_open(int device_index)
+static int hw_dev_open(int dev_index)
 {
-	(void)device_index;
+	GTimeVal cur_time;
+	struct sr_dev_inst *sdi;
+	struct context *ctx;
+	int timediff, err;
+
+	if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
+		return SR_ERR;
+	ctx = sdi->priv;
+
+	/*
+	 * if the firmware was recently uploaded, wait up to MAX_RENUM_DELAY ms
+	 * for the FX2 to renumerate
+	 */
+	err = 0;
+	if (GTV_TO_MSEC(ctx->fw_updated) > 0) {
+		sr_info("fx2lafw: waiting for device to reset");
+		/* takes at least 300ms for the FX2 to be gone from the USB bus */
+		g_usleep(300 * 1000);
+		timediff = 0;
+		while (timediff < MAX_RENUM_DELAY) {
+			if ((err = fx2lafw_open_dev(dev_index)) == SR_OK)
+				break;
+			g_usleep(100 * 1000);
+			g_get_current_time(&cur_time);
+			timediff = GTV_TO_MSEC(cur_time) - GTV_TO_MSEC(ctx->fw_updated);
+		}
+		sr_info("fx2lafw: device came back after %d ms", timediff);
+	} else {
+		err = fx2lafw_open_dev(dev_index);
+	}
+
+	if (err != SR_OK) {
+		sr_err("fx2lafw: unable to open device");
+		return SR_ERR;
+	}
+	ctx = sdi->priv;
+
+	err = libusb_claim_interface(ctx->usb->devhdl, USB_INTERFACE);
+	if (err != 0) {
+		sr_err("fx2lafw: Unable to claim interface: %d", err);
+		return SR_ERR;
+	}
+
+	if (ctx->cur_samplerate == 0) {
+		/* Samplerate hasn't been set; default to the slowest one. */
+		if (hw_dev_config_set(dev_index, SR_HWCAP_SAMPLERATE,
+		    &fx2lafw_supported_samplerates[0]) == SR_ERR)
+			return SR_ERR;
+	}
+
 	return SR_OK;
 }
 
-static int hw_dev_close(int device_index)
+static int hw_dev_close(int dev_index)
 {
-	(void)device_index;
+	struct sr_dev_inst *sdi;
+
+	if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) {
+		sr_err("fx2lafw: %s: sdi was NULL", __func__);
+		return SR_ERR_BUG;
+	}
+
+	/* TODO */
+	close_dev(sdi);
+
 	return SR_OK;
 }
 
 static int hw_cleanup(void)
 {
-	return SR_OK;
+	GSList *l;
+	struct sr_dev_inst *sdi;
+	struct context *ctx;
+	int ret = SR_OK;
+
+	for(l = dev_insts; l; l = l->next) {
+		if (!(sdi = l->data)) {
+			/* Log error, but continue cleaning up the rest. */
+			sr_err("fx2lafw: %s: sdi was NULL, continuing", __func__);
+			ret = SR_ERR_BUG;
+			continue;
+		}
+		if (!(ctx = sdi->priv)) {
+			/* Log error, but continue cleaning up the rest. */
+			sr_err("fx2lafw: %s: sdi->priv was NULL, continuing",
+			       __func__);
+			ret = SR_ERR_BUG;
+			continue;
+		}
+		close_dev(sdi);
+		sdi = l->data;
+		sr_dev_inst_free(sdi);
+	}
+
+	g_slist_free(dev_insts);
+	dev_insts = NULL;
+
+	if(usb_context)
+		libusb_exit(usb_context);
+	usb_context = NULL;
+
+	return ret;
 }
 
-static void *hw_dev_info_get(int device_index, int device_info_id)
+static void *hw_dev_info_get(int dev_index, int dev_info_id)
 {
-	(void)device_index;
-	(void)device_info_id;
+	struct sr_dev_inst *sdi;
+	struct context *ctx;
+
+	if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
+		return NULL;
+	ctx = sdi->priv;
+
+	switch (dev_info_id) {
+	case SR_DI_INST:
+		return sdi;
+	case SR_DI_NUM_PROBES:
+		return GINT_TO_POINTER(ctx->profile->num_probes);
+	case SR_DI_PROBE_NAMES:
+		return fx2lafw_probe_names;
+	case SR_DI_SAMPLERATES:
+		return &fx2lafw_samplerates;
+	case SR_DI_TRIGGER_TYPES:
+		return TRIGGER_TYPES;
+	case SR_DI_CUR_SAMPLERATE:
+		return &ctx->cur_samplerate;
+	}
+
 	return NULL;
 }
 
-static int hw_dev_status_get(int device_index)
+static int hw_dev_status_get(int dev_index)
 {
-	(void)device_index;
-	return SR_ST_NOT_FOUND;
+	const struct sr_dev_inst *const sdi =
+		sr_dev_inst_get(dev_insts, dev_index);
+
+	if (!sdi)
+		return SR_ST_NOT_FOUND;
+
+	return sdi->status;
 }
 
 static int *hw_hwcap_get_all(void)
 {
-	return NULL;
+	return fx2lafw_capabilities;
 }
 
-static int hw_dev_config_set(int dev_index, int capability, void *value)
+static int hw_dev_config_set(int dev_index, int hwcap, void *value)
 {
-	(void)dev_index;
-	(void)capability;
-	(void)value;
-	return SR_OK;
+	struct sr_dev_inst *sdi;
+	struct context *ctx;
+	int ret;
+
+	if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
+		return SR_ERR;
+	ctx = sdi->priv;
+
+	if (hwcap == SR_HWCAP_SAMPLERATE) {
+		ctx->cur_samplerate = *(uint64_t *)value;
+		ret = SR_OK;
+	} else if (hwcap == SR_HWCAP_PROBECONFIG) {
+		ret = SR_OK;
+	} else if (hwcap == SR_HWCAP_LIMIT_SAMPLES) {
+		ctx->limit_samples = *(uint64_t *)value;
+		ret = SR_OK;
+	} else {
+		ret = SR_ERR;
+	}
+
+	return ret;
+}
+
+static int receive_data(int fd, int revents, void *cb_data)
+{
+	struct timeval tv;
+
+	/* Avoid compiler warnings. */
+	(void)fd;
+	(void)revents;
+	(void)cb_data;
+
+	tv.tv_sec = tv.tv_usec = 0;
+	libusb_handle_events_timeout(usb_context, &tv);
+
+	return TRUE;
+}
+
+static void abort_acquisition(struct context *ctx)
+{
+	struct sr_datafeed_packet packet;
+
+	packet.type = SR_DF_END;
+	sr_session_send(ctx->session_dev_id, &packet);
+
+	ctx->num_samples = -1;
+
+	/* TODO: Need to cancel and free any queued up transfers. */
 }
 
-static int hw_dev_acquisition_start(int dev_index, gpointer session_data)
+static void receive_transfer(struct libusb_transfer *transfer)
 {
-	(void)dev_index;
-	(void)session_data;
+	/* TODO: These statics have to move to the ctx struct. */
+	static int empty_transfer_count = 0;
+	struct sr_datafeed_packet packet;
+	struct sr_datafeed_logic logic;
+	struct context *ctx = transfer->user_data;
+	int cur_buflen;
+	unsigned char *cur_buf, *new_buf;
+
+	/*
+	 * If acquisition has already ended, just free any queued up
+	 * transfer that come in.
+	 */
+	if (ctx->num_samples == -1) {
+		if (transfer)
+			libusb_free_transfer(transfer);
+		return;
+	}
+
+	sr_info("fx2lafw: receive_transfer(): status %d received %d bytes",
+		transfer->status, transfer->actual_length);
+
+	/* Save incoming transfer before reusing the transfer struct. */
+	cur_buf = transfer->buffer;
+	cur_buflen = transfer->actual_length;
+	ctx = transfer->user_data;
+
+	/* Fire off a new request. */
+	if (!(new_buf = g_try_malloc(4096))) {
+		sr_err("fx2lafw: %s: new_buf malloc failed", __func__);
+		return; /* TODO: SR_ERR_MALLOC */
+	}
+
+	transfer->buffer = new_buf;
+	transfer->length = 4096;
+	if (libusb_submit_transfer(transfer) != 0) {
+		/* TODO: Stop session? */
+		/* TODO: Better error message. */
+		sr_err("fx2lafw: %s: libusb_submit_transfer error", __func__);
+	}
+
+	if (cur_buflen == 0) {
+		empty_transfer_count++;
+		if (empty_transfer_count > MAX_EMPTY_TRANSFERS) {
+			/*
+			 * The FX2 gave up. End the acquisition, the frontend
+			 * will work out that the samplecount is short.
+			 */
+			abort_acquisition(ctx);
+		}
+		return;
+	} else {
+		empty_transfer_count = 0;
+	}
+
+	/* Send the incoming transfer to the session bus. */
+	packet.type = SR_DF_LOGIC;
+	packet.payload = &logic;
+	logic.length = cur_buflen;
+	logic.unitsize = 1;
+	logic.data = cur_buf;
+	sr_session_send(ctx->session_dev_id, &packet);
+	g_free(cur_buf);
+
+	ctx->num_samples += cur_buflen;
+	if (ctx->limit_samples &&
+		(unsigned int) ctx->num_samples > ctx->limit_samples) {
+		abort_acquisition(ctx);
+	}
+}
+
+static int hw_dev_acquisition_start(int dev_index, void *cb_data)
+{
+	struct sr_dev_inst *sdi;
+	struct sr_datafeed_packet *packet;
+	struct sr_datafeed_header *header;
+	struct context *ctx;
+	struct libusb_transfer *transfer;
+	const struct libusb_pollfd **lupfd;
+	int err, size, i;
+	unsigned char *buf;
+
+	if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
+		return SR_ERR;
+	ctx = sdi->priv;
+	ctx->session_dev_id = cb_data;
+	ctx->num_samples = 0;
+
+	if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
+		sr_err("fx2lafw: %s: packet malloc failed", __func__);
+		return SR_ERR_MALLOC;
+	}
+
+	if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) {
+		sr_err("fx2lafw: %s: header malloc failed", __func__);
+		return SR_ERR_MALLOC;
+	}
+
+	if ((err = command_start_acquisition (ctx->usb->devhdl,
+		ctx->cur_samplerate)) != SR_OK) {
+		return err;
+	}
+
+	/* Start with 2K transfer, subsequently increased to 4K. */
+	size = 2048;
+	for (i = 0; i < NUM_SIMUL_TRANSFERS; i++) {
+		if (!(buf = g_try_malloc(size))) {
+			sr_err("fx2lafw: %s: buf malloc failed", __func__);
+			return SR_ERR_MALLOC;
+		}
+		transfer = libusb_alloc_transfer(0);
+		libusb_fill_bulk_transfer(transfer, ctx->usb->devhdl,
+				2 | LIBUSB_ENDPOINT_IN, buf, size,
+				receive_transfer, ctx, 40);
+		if (libusb_submit_transfer(transfer) != 0) {
+			/* TODO: Free them all. */
+			libusb_free_transfer(transfer);
+			g_free(buf);
+			return SR_ERR;
+		}
+		size = 4096;
+	}
+
+	lupfd = libusb_get_pollfds(usb_context);
+	for (i = 0; lupfd[i]; i++)
+		sr_source_add(lupfd[i]->fd, lupfd[i]->events,
+			      40, receive_data, NULL);
+	free(lupfd); /* NOT g_free()! */
+
+	packet->type = SR_DF_HEADER;
+	packet->payload = header;
+	header->feed_version = 1;
+	gettimeofday(&header->starttime, NULL);
+	header->samplerate = ctx->cur_samplerate;
+	header->num_logic_probes = ctx->profile->num_probes;
+	sr_session_send(cb_data, packet);
+	g_free(header);
+	g_free(packet);
+
 	return SR_OK;
 }
 
-/* This stops acquisition on ALL devices, ignoring device_index. */
-static int hw_dev_acquisition_stop(int dev_index, gpointer session_data)
+/* TODO: This stops acquisition on ALL devices, ignoring dev_index. */
+static int hw_dev_acquisition_stop(int dev_index, void *cb_data)
 {
-	(void)dev_index;
-	(void)session_data;
+	struct sr_dev_inst *sdi;
+
+	/* unused parameter */
+	(void)cb_data;
+
+	if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
+		return SR_ERR;
+ 
+	abort_acquisition(sdi->priv);
+
 	return SR_OK;
 }
 
-SR_PRIV struct sr_dev_plugin fx2lafw_plugin_info = {
+SR_PRIV struct sr_dev_driver fx2lafw_driver_info = {
 	.name = "fx2lafw",
 	.longname = "fx2lafw",
 	.api_version = 1,