[libsigrok.git] / src / hardware / ftdi-la / api.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2015 Sergey Alirzaev <zl29ah@gmail.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 <ftdi.h>
#include <libusb.h>
#include <libsigrok/libsigrok.h>
#include "libsigrok-internal.h"
#include "protocol.h"

static const uint32_t scanopts[] = {
	SR_CONF_CONN,
};

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

static const uint32_t devopts[] = {
	SR_CONF_CONTINUOUS,
	SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
	SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
	SR_CONF_CONN | SR_CONF_GET,
};

static const uint64_t samplerates[] = {
	SR_HZ(3600),
	SR_MHZ(10),
	SR_HZ(1),
};

static const struct ftdi_chip_desc ft2232h_desc = {
	.vendor = 0x0403,
	.product = 0x6010,
	.samplerate_div = 20,
	.channel_names = {
		"ADBUS0", "ADBUS1", "ADBUS2", "ADBUS3",
		"ADBUS4", "ADBUS5", "ADBUS6", "ADBUS7",
		/* TODO: BDBUS[0..7] channels. */
		NULL
	}
};

static const struct ftdi_chip_desc ft2232h_tumpa_desc = {
	.vendor = 0x0403,
	.product = 0x8a98,
	.samplerate_div = 20,
	/* 20 pin JTAG header */
	.channel_names = {
		"TCK", "TDI", "TDO", "TMS", "RST", "nTRST", "DBGRQ", "RTCK",
		NULL
	}
};

static const struct ftdi_chip_desc ft4232h_desc = {
	.vendor = 0x0403,
	.product = 0x6011,
	.samplerate_div = 20,
	.channel_names = {
		"ADBUS0", "ADBUS1", "ADBUS2", "ADBUS3",	"ADBUS4", "ADBUS5", "ADBUS6", "ADBUS7",
		/* TODO: BDBUS[0..7], CDBUS[0..7], DDBUS[0..7] channels. */
		NULL
	}
};

static const struct ftdi_chip_desc ft232r_desc = {
	.vendor = 0x0403,
	.product = 0x6001,
	.samplerate_div = 30,
	.channel_names = {
		"TXD", "RXD", "RTS#", "CTS#", "DTR#", "DSR#", "DCD#", "RI#",
		NULL
	}
};

static const struct ftdi_chip_desc ft232h_desc = {
	.vendor = 0x0403,
	.product = 0x6014,
	.samplerate_div = 30,
	.channel_names = {
		"ADBUS0", "ADBUS1", "ADBUS2", "ADBUS3", "ADBUS4", "ADBUS5", "ADBUS6", "ADBUS7",
		NULL
	}
};

static const struct ftdi_chip_desc *chip_descs[] = {
	&ft2232h_desc,
	&ft2232h_tumpa_desc,
	&ft4232h_desc,
	&ft232r_desc,
	&ft232h_desc,
	NULL,
};

static void scan_device(struct ftdi_context *ftdic,
	struct libusb_device *dev, GSList **devices)
{
	static const int usb_str_maxlen = 32;

	struct libusb_device_descriptor usb_desc;
	const struct ftdi_chip_desc *desc;
	struct dev_context *devc;
	char *vendor, *model, *serial_num;
	struct sr_dev_inst *sdi;
	int rv;

	libusb_get_device_descriptor(dev, &usb_desc);

	desc = NULL;
	for (unsigned long i = 0; i < ARRAY_SIZE(chip_descs); i++) {
		desc = chip_descs[i];
		if (!desc)
			break;
		if (desc->vendor == usb_desc.idVendor &&
			desc->product == usb_desc.idProduct)
			break;
	}

	if (!desc) {
		sr_spew("Unsupported FTDI device 0x%04x:0x%04x.",
			usb_desc.idVendor, usb_desc.idProduct);
		return;
	}

	devc = g_malloc0(sizeof(struct dev_context));

	/* Allocate memory for the incoming data. */
	devc->data_buf = g_malloc0(DATA_BUF_SIZE);

	devc->desc = desc;

	vendor = g_malloc(usb_str_maxlen);
	model = g_malloc(usb_str_maxlen);
	serial_num = g_malloc(usb_str_maxlen);
	rv = ftdi_usb_get_strings(ftdic, dev, vendor, usb_str_maxlen,
			model, usb_str_maxlen, serial_num, usb_str_maxlen);
	switch (rv) {
	case 0:
		break;
	/* ftdi_usb_get_strings() fails on first miss, hence fall through. */
	case -7:
		sr_dbg("The device lacks a manufacturer descriptor.");
		g_snprintf(vendor, usb_str_maxlen, "Generic");
		/* FALLTHROUGH */
	case -8:
		sr_dbg("The device lacks a product descriptor.");
		switch (usb_desc.idProduct) {
		case 0x6001:
			g_snprintf(model, usb_str_maxlen, "FT232R");
			break;
		case 0x6010:
			g_snprintf(model, usb_str_maxlen, "FT2232H");
			break;
		case 0x6011:
			g_snprintf(model, usb_str_maxlen, "FT4232H");
			break;
		case 0x6014:
			g_snprintf(model, usb_str_maxlen, "FT232H");
			break;
		case 0x8a98:
			g_snprintf(model, usb_str_maxlen, "FT2232H-TUMPA");
			break;
		default:
			g_snprintf(model, usb_str_maxlen, "Unknown");
			break;
		}
		/* FALLTHROUGH */
	case -9:
		sr_dbg("The device lacks a serial number.");
		g_free(serial_num);
		serial_num = NULL;
		break;
	default:
		sr_err("Failed to get the FTDI strings: %d", rv);
		goto err_free_strings;
	}
	sr_dbg("Found an FTDI device: %s.", model);

	sdi = g_malloc0(sizeof(struct sr_dev_inst));
	sdi->status = SR_ST_INACTIVE;
	sdi->vendor = vendor;
	sdi->model = model;
	sdi->serial_num = serial_num;
	sdi->priv = devc;
	sdi->connection_id = g_strdup_printf("d:%u/%u",
		libusb_get_bus_number(dev), libusb_get_device_address(dev));

	for (char *const *chan = &(desc->channel_names[0]); *chan; chan++)
		sr_channel_new(sdi, chan - &(desc->channel_names[0]),
				SR_CHANNEL_LOGIC, TRUE, *chan);

	*devices = g_slist_append(*devices, sdi);
	return;

err_free_strings:
	g_free(vendor);
	g_free(model);
	g_free(serial_num);
	g_free(devc->data_buf);
	g_free(devc);
}

static GSList *scan_all(struct ftdi_context *ftdic, GSList *options)
{
	GSList *devices;
	struct ftdi_device_list *devlist = 0;
	struct ftdi_device_list *curdev;
	int ret;

	(void)options;

	devices = NULL;

	ret = ftdi_usb_find_all(ftdic, &devlist, 0, 0);
	if (ret < 0) {
		sr_err("Failed to list devices (%d): %s", ret,
		       ftdi_get_error_string(ftdic));
		return NULL;
	}

	curdev = devlist;
	while (curdev) {
		scan_device(ftdic, curdev->dev, &devices);
		curdev = curdev->next;
	}

	ftdi_list_free(&devlist);

	return devices;
}

static GSList *scan(struct sr_dev_driver *di, GSList *options)
{
	struct ftdi_context *ftdic;
	struct sr_config *src;
	struct sr_usb_dev_inst *usb;
	const char *conn;
	GSList *l, *conn_devices;
	GSList *devices;
	struct drv_context *drvc;
	libusb_device **devlist;
	int i;

	drvc = di->context;
	conn = NULL;
	for (l = options; l; l = l->next) {
		src = l->data;
		if (src->key == SR_CONF_CONN) {
			conn = g_variant_get_string(src->data, NULL);
			break;
		}
	}

	ftdic = ftdi_new();
	if (!ftdic) {
		sr_err("Failed to initialize libftdi.");
		return NULL;
	}

	if (conn) {
		devices = NULL;
		libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
		for (i = 0; devlist[i]; i++) {
			conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
			for (l = conn_devices; l; l = l->next) {
				usb = l->data;
				if (usb->bus == libusb_get_bus_number(devlist[i])
					&& usb->address == libusb_get_device_address(devlist[i])) {
					scan_device(ftdic, devlist[i], &devices);
				}
			}
		}
		libusb_free_device_list(devlist, 1);
	} else
		devices = scan_all(ftdic, options);

	ftdi_free(ftdic);

	return std_scan_complete(di, devices);
}

static void clear_helper(struct dev_context *devc)
{
	g_free(devc->data_buf);
}

static int dev_clear(const struct sr_dev_driver *di)
{
	return std_dev_clear_with_callback(di, (std_dev_clear_callback)clear_helper);
}

static int dev_open(struct sr_dev_inst *sdi)
{
	struct dev_context *devc;
	int ret = SR_OK;

	devc = sdi->priv;

	devc->ftdic = ftdi_new();
	if (!devc->ftdic)
		return SR_ERR;

	ret = ftdi_usb_open_string(devc->ftdic, sdi->connection_id);
	if (ret < 0) {
		/* Log errors, except for -3 ("device not found"). */
		if (ret != -3)
			sr_err("Failed to open device (%d): %s", ret,
			       ftdi_get_error_string(devc->ftdic));
		goto err_ftdi_free;
	}

	ret = PURGE_FTDI_BOTH(devc->ftdic);
	if (ret < 0) {
		sr_err("Failed to purge FTDI RX/TX buffers (%d): %s.",
		       ret, ftdi_get_error_string(devc->ftdic));
		goto err_dev_open_close_ftdic;
	}

	ret = ftdi_set_bitmode(devc->ftdic, 0x00, BITMODE_RESET);
	if (ret < 0) {
		sr_err("Failed to reset the FTDI chip bitmode (%d): %s.",
		       ret, ftdi_get_error_string(devc->ftdic));
		goto err_dev_open_close_ftdic;
	}

	ret = ftdi_set_bitmode(devc->ftdic, 0x00, BITMODE_BITBANG);
	if (ret < 0) {
		sr_err("Failed to put FTDI chip into bitbang mode (%d): %s.",
		       ret, ftdi_get_error_string(devc->ftdic));
		goto err_dev_open_close_ftdic;
	}

	return SR_OK;

err_dev_open_close_ftdic:
	ftdi_usb_close(devc->ftdic);

err_ftdi_free:
	ftdi_free(devc->ftdic);

	return SR_ERR;
}

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

	devc = sdi->priv;

	if (!devc->ftdic)
		return SR_ERR_BUG;

	ftdi_usb_close(devc->ftdic);
	ftdi_free(devc->ftdic);
	devc->ftdic = 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;
	struct sr_usb_dev_inst *usb;

	(void)cg;

	devc = sdi->priv;

	switch (key) {
	case SR_CONF_SAMPLERATE:
		*data = g_variant_new_uint64(devc->cur_samplerate);
		break;
	case SR_CONF_CONN:
		if (!sdi || !sdi->conn)
			return SR_ERR_ARG;
		usb = sdi->conn;
		*data = g_variant_new_printf("%d.%d", usb->bus, usb->address);
		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;
	uint64_t value;

	(void)cg;

	devc = sdi->priv;

	switch (key) {
	case SR_CONF_LIMIT_MSEC:
		value = g_variant_get_uint64(data);
		/* TODO: Implement. */
		(void)value;
		return SR_ERR_NA;
	case SR_CONF_LIMIT_SAMPLES:
		devc->limit_samples = g_variant_get_uint64(data);
		break;
	case SR_CONF_SAMPLERATE:
		value = g_variant_get_uint64(data);
		if (value < 3600)
			return SR_ERR_SAMPLERATE;
		devc->cur_samplerate = value;
		return ftdi_la_set_samplerate(devc);
	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)
{
	switch (key) {
	case SR_CONF_SCAN_OPTIONS:
	case SR_CONF_DEVICE_OPTIONS:
		return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
	case SR_CONF_SAMPLERATE:
		*data = std_gvar_samplerates_steps(ARRAY_AND_SIZE(samplerates));
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

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

	devc = sdi->priv;

	if (!devc->ftdic)
		return SR_ERR_BUG;

	ftdi_set_bitmode(devc->ftdic, 0, BITMODE_BITBANG);

	/* Properly reset internal variables before every new acquisition. */
	devc->samples_sent = 0;
	devc->bytes_received = 0;

	std_session_send_df_header(sdi);

	/* Hook up a dummy handler to receive data from the device. */
	sr_session_source_add(sdi->session, -1, G_IO_IN, 0,
			      ftdi_la_receive_data, (void *)sdi);

	return SR_OK;
}

static int dev_acquisition_stop(struct sr_dev_inst *sdi)
{
	sr_session_source_remove(sdi->session, -1);

	std_session_send_df_end(sdi);

	return SR_OK;
}

static struct sr_dev_driver ftdi_la_driver_info = {
	.name = "ftdi-la",
	.longname = "FTDI LA",
	.api_version = 1,
	.init = std_init,
	.cleanup = std_cleanup,
	.scan = scan,
	.dev_list = std_dev_list,
	.dev_clear = 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(ftdi_la_driver_info);
Commit	Line	Data
4f7fdcdd SA	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2015 Sergey Alirzaev <zl29ah@gmail.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
cee6d3fa	20	#include <config.h>
4f7fdcdd SA	21	#include <ftdi.h>
4f7fdcdd SA	22	#include <libusb.h>
cee6d3fa SA	23	#include <libsigrok/libsigrok.h>
cee6d3fa SA	24	#include "libsigrok-internal.h"
4f7fdcdd SA	25	#include "protocol.h"
4f7fdcdd SA	26
4f7fdcdd	27	static const uint32_t scanopts[] = {
cee6d3fa	28	SR_CONF_CONN,
4f7fdcdd SA	29	};
4f7fdcdd SA	30
05199c0a	31	static const uint32_t drvopts[] = {
4f7fdcdd	32	SR_CONF_LOGIC_ANALYZER,
05199c0a UH	33	};
	34
	35	static const uint32_t devopts[] = {
e91bb0a6	36	SR_CONF_CONTINUOUS,
4f7fdcdd SA	37	SR_CONF_LIMIT_SAMPLES \| SR_CONF_SET,
4f7fdcdd SA	38	SR_CONF_SAMPLERATE \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
cee6d3fa	39	SR_CONF_CONN \| SR_CONF_GET,
4f7fdcdd SA	40	};
	41
	42	static const uint64_t samplerates[] = {
	43	SR_HZ(3600),
	44	SR_MHZ(10),
	45	SR_HZ(1),
	46	};
	47
	48	static const struct ftdi_chip_desc ft2232h_desc = {
	49	.vendor = 0x0403,
	50	.product = 0x6010,
	51	.samplerate_div = 20,
	52	.channel_names = {
f8195cb2 UH	53	"ADBUS0", "ADBUS1", "ADBUS2", "ADBUS3",
f8195cb2 UH	54	"ADBUS4", "ADBUS5", "ADBUS6", "ADBUS7",
4f7fdcdd SA	55	/* TODO: BDBUS[0..7] channels. */
	56	NULL
	57	}
	58	};
	59
3ff6cfee TM	60	static const struct ftdi_chip_desc ft2232h_tumpa_desc = {
	61	.vendor = 0x0403,
	62	.product = 0x8a98,
	63	.samplerate_div = 20,
	64	/* 20 pin JTAG header */
	65	.channel_names = {
	66	"TCK", "TDI", "TDO", "TMS", "RST", "nTRST", "DBGRQ", "RTCK",
	67	NULL
	68	}
	69	};
	70
97858914 SR	71	static const struct ftdi_chip_desc ft4232h_desc = {
	72	.vendor = 0x0403,
	73	.product = 0x6011,
	74	.samplerate_div = 20,
	75	.channel_names = {
	76	"ADBUS0", "ADBUS1", "ADBUS2", "ADBUS3", "ADBUS4", "ADBUS5", "ADBUS6", "ADBUS7",
	77	/* TODO: BDBUS[0..7], CDBUS[0..7], DDBUS[0..7] channels. */
	78	NULL
	79	}
	80	};
	81
4f7fdcdd SA	82	static const struct ftdi_chip_desc ft232r_desc = {
	83	.vendor = 0x0403,
	84	.product = 0x6001,
	85	.samplerate_div = 30,
	86	.channel_names = {
f8195cb2	87	"TXD", "RXD", "RTS#", "CTS#", "DTR#", "DSR#", "DCD#", "RI#",
4f7fdcdd SA	88	NULL
	89	}
	90	};
	91
c7a51272 P	92	static const struct ftdi_chip_desc ft232h_desc = {
	93	.vendor = 0x0403,
	94	.product = 0x6014,
	95	.samplerate_div = 30,
	96	.channel_names = {
	97	"ADBUS0", "ADBUS1", "ADBUS2", "ADBUS3", "ADBUS4", "ADBUS5", "ADBUS6", "ADBUS7",
	98	NULL
	99	}
	100	};
	101
4f7fdcdd SA	102	static const struct ftdi_chip_desc *chip_descs[] = {
4f7fdcdd SA	103	&ft2232h_desc,
3ff6cfee	104	&ft2232h_tumpa_desc,
97858914	105	&ft4232h_desc,
4f7fdcdd	106	&ft232r_desc,
c7a51272	107	&ft232h_desc,
01ae826b	108	NULL,
4f7fdcdd SA	109	};
4f7fdcdd SA	110
15a5bfe4	111	static void scan_device(struct ftdi_context *ftdic,
07a91752	112	struct libusb_device dev, GSList *devices)
4f7fdcdd	113	{
aa8e4959 GS	114	static const int usb_str_maxlen = 32;
aa8e4959 GS	115
4f7fdcdd SA	116	struct libusb_device_descriptor usb_desc;
4f7fdcdd SA	117	const struct ftdi_chip_desc *desc;
cee6d3fa	118	struct dev_context *devc;
4f7fdcdd	119	char vendor, model, *serial_num;
cee6d3fa	120	struct sr_dev_inst *sdi;
cee6d3fa	121	int rv;
4f7fdcdd	122
cee6d3fa SA	123	libusb_get_device_descriptor(dev, &usb_desc);
	124
	125	desc = NULL;
	126	for (unsigned long i = 0; i < ARRAY_SIZE(chip_descs); i++) {
	127	desc = chip_descs[i];
01ae826b GS	128	if (!desc)
01ae826b GS	129	break;
cee6d3fa SA	130	if (desc->vendor == usb_desc.idVendor &&
	131	desc->product == usb_desc.idProduct)
	132	break;
	133	}
	134
	135	if (!desc) {
66e19f47	136	sr_spew("Unsupported FTDI device 0x%04x:0x%04x.",
cee6d3fa SA	137	usb_desc.idVendor, usb_desc.idProduct);
	138	return;
	139	}
4f7fdcdd	140
4f7fdcdd SA	141	devc = g_malloc0(sizeof(struct dev_context));
	142
	143	/* Allocate memory for the incoming data. */
	144	devc->data_buf = g_malloc0(DATA_BUF_SIZE);
	145
cee6d3fa SA	146	devc->desc = desc;
cee6d3fa SA	147
aa8e4959 GS	148	vendor = g_malloc(usb_str_maxlen);
	149	model = g_malloc(usb_str_maxlen);
	150	serial_num = g_malloc(usb_str_maxlen);
	151	rv = ftdi_usb_get_strings(ftdic, dev, vendor, usb_str_maxlen,
	152	model, usb_str_maxlen, serial_num, usb_str_maxlen);
cee6d3fa SA	153	switch (rv) {
	154	case 0:
	155	break;
aa8e4959 GS	156	/* ftdi_usb_get_strings() fails on first miss, hence fall through. */
	157	case -7:
	158	sr_dbg("The device lacks a manufacturer descriptor.");
	159	g_snprintf(vendor, usb_str_maxlen, "Generic");
	160	/* FALLTHROUGH */
	161	case -8:
	162	sr_dbg("The device lacks a product descriptor.");
	163	switch (usb_desc.idProduct) {
	164	case 0x6001:
	165	g_snprintf(model, usb_str_maxlen, "FT232R");
	166	break;
	167	case 0x6010:
	168	g_snprintf(model, usb_str_maxlen, "FT2232H");
	169	break;
	170	case 0x6011:
	171	g_snprintf(model, usb_str_maxlen, "FT4232H");
	172	break;
	173	case 0x6014:
	174	g_snprintf(model, usb_str_maxlen, "FT232H");
	175	break;
	176	case 0x8a98:
	177	g_snprintf(model, usb_str_maxlen, "FT2232H-TUMPA");
	178	break;
	179	default:
	180	g_snprintf(model, usb_str_maxlen, "Unknown");
	181	break;
	182	}
	183	/* FALLTHROUGH */
cee6d3fa SA	184	case -9:
	185	sr_dbg("The device lacks a serial number.");
	186	g_free(serial_num);
	187	serial_num = NULL;
	188	break;
	189	default:
	190	sr_err("Failed to get the FTDI strings: %d", rv);
	191	goto err_free_strings;
	192	}
	193	sr_dbg("Found an FTDI device: %s.", model);
	194
cee6d3fa	195	sdi = g_malloc0(sizeof(struct sr_dev_inst));
45884333	196	sdi->status = SR_ST_INACTIVE;
cee6d3fa SA	197	sdi->vendor = vendor;
	198	sdi->model = model;
	199	sdi->serial_num = serial_num;
cee6d3fa	200	sdi->priv = devc;
634d7299 LPC	201	sdi->connection_id = g_strdup_printf("d:%u/%u",
634d7299 LPC	202	libusb_get_bus_number(dev), libusb_get_device_address(dev));
cee6d3fa SA	203
	204	for (char const chan = &(desc->channel_names[0]); *chan; chan++)
	205	sr_channel_new(sdi, chan - &(desc->channel_names[0]),
	206	SR_CHANNEL_LOGIC, TRUE, *chan);
	207
	208	devices = g_slist_append(devices, sdi);
cee6d3fa SA	209	return;
	210
	211	err_free_strings:
	212	g_free(vendor);
	213	g_free(model);
	214	g_free(serial_num);
cee6d3fa SA	215	g_free(devc->data_buf);
	216	g_free(devc);
	217	}
	218
15a5bfe4	219	static GSList scan_all(struct ftdi_context ftdic, GSList *options)
cee6d3fa SA	220	{
	221	GSList *devices;
	222	struct ftdi_device_list *devlist = 0;
	223	struct ftdi_device_list *curdev;
cee6d3fa SA	224	int ret;
	225
	226	(void)options;
	227
	228	devices = NULL;
	229
cee6d3fa	230	ret = ftdi_usb_find_all(ftdic, &devlist, 0, 0);
4f7fdcdd SA	231	if (ret < 0) {
4f7fdcdd SA	232	sr_err("Failed to list devices (%d): %s", ret,
cee6d3fa	233	ftdi_get_error_string(ftdic));
07a91752	234	return NULL;
4f7fdcdd SA	235	}
4f7fdcdd SA	236
4f7fdcdd SA	237	curdev = devlist;
4f7fdcdd SA	238	while (curdev) {
15a5bfe4	239	scan_device(ftdic, curdev->dev, &devices);
4f7fdcdd SA	240	curdev = curdev->next;
	241	}
	242
7b6072d3	243	ftdi_list_free(&devlist);
7b6072d3	244
4f7fdcdd	245	return devices;
4f7fdcdd SA	246	}
4f7fdcdd SA	247
cee6d3fa SA	248	static GSList scan(struct sr_dev_driver di, GSList *options)
cee6d3fa SA	249	{
07a91752	250	struct ftdi_context *ftdic;
cee6d3fa SA	251	struct sr_config *src;
	252	struct sr_usb_dev_inst *usb;
	253	const char *conn;
	254	GSList l, conn_devices;
	255	GSList *devices;
	256	struct drv_context *drvc;
	257	libusb_device **devlist;
	258	int i;
	259
	260	drvc = di->context;
cee6d3fa SA	261	conn = NULL;
	262	for (l = options; l; l = l->next) {
	263	src = l->data;
	264	if (src->key == SR_CONF_CONN) {
	265	conn = g_variant_get_string(src->data, NULL);
	266	break;
	267	}
	268	}
07a91752	269
07a91752 LPC	270	ftdic = ftdi_new();
	271	if (!ftdic) {
	272	sr_err("Failed to initialize libftdi.");
	273	return NULL;
	274	}
	275
cee6d3fa SA	276	if (conn) {
	277	devices = NULL;
	278	libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
	279	for (i = 0; devlist[i]; i++) {
	280	conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
	281	for (l = conn_devices; l; l = l->next) {
	282	usb = l->data;
	283	if (usb->bus == libusb_get_bus_number(devlist[i])
	284	&& usb->address == libusb_get_device_address(devlist[i])) {
15a5bfe4	285	scan_device(ftdic, devlist[i], &devices);
cee6d3fa SA	286	}
	287	}
	288	}
	289	libusb_free_device_list(devlist, 1);
cee6d3fa	290	} else
15a5bfe4	291	devices = scan_all(ftdic, options);
07a91752 LPC	292
	293	ftdi_free(ftdic);
	294
15a5bfe4	295	return std_scan_complete(di, devices);
cee6d3fa SA	296	}
cee6d3fa SA	297
3553451f	298	static void clear_helper(struct dev_context *devc)
4f7fdcdd	299	{
4f7fdcdd	300	g_free(devc->data_buf);
4f7fdcdd SA	301	}
	302
	303	static int dev_clear(const struct sr_dev_driver *di)
	304	{
3553451f	305	return std_dev_clear_with_callback(di, (std_dev_clear_callback)clear_helper);
4f7fdcdd SA	306	}
	307
	308	static int dev_open(struct sr_dev_inst *sdi)
	309	{
	310	struct dev_context *devc;
	311	int ret = SR_OK;
	312
	313	devc = sdi->priv;
	314
07a91752 LPC	315	devc->ftdic = ftdi_new();
	316	if (!devc->ftdic)
	317	return SR_ERR;
	318
634d7299	319	ret = ftdi_usb_open_string(devc->ftdic, sdi->connection_id);
4f7fdcdd SA	320	if (ret < 0) {
	321	/* Log errors, except for -3 ("device not found"). */
	322	if (ret != -3)
	323	sr_err("Failed to open device (%d): %s", ret,
	324	ftdi_get_error_string(devc->ftdic));
07a91752	325	goto err_ftdi_free;
4f7fdcdd SA	326	}
4f7fdcdd SA	327
e1a712ca	328	ret = PURGE_FTDI_BOTH(devc->ftdic);
4f7fdcdd SA	329	if (ret < 0) {
	330	sr_err("Failed to purge FTDI RX/TX buffers (%d): %s.",
	331	ret, ftdi_get_error_string(devc->ftdic));
	332	goto err_dev_open_close_ftdic;
	333	}
4f7fdcdd	334
4f7fdcdd SA	335	ret = ftdi_set_bitmode(devc->ftdic, 0x00, BITMODE_RESET);
	336	if (ret < 0) {
	337	sr_err("Failed to reset the FTDI chip bitmode (%d): %s.",
	338	ret, ftdi_get_error_string(devc->ftdic));
	339	goto err_dev_open_close_ftdic;
	340	}
4f7fdcdd SA	341
	342	ret = ftdi_set_bitmode(devc->ftdic, 0x00, BITMODE_BITBANG);
	343	if (ret < 0) {
	344	sr_err("Failed to put FTDI chip into bitbang mode (%d): %s.",
	345	ret, ftdi_get_error_string(devc->ftdic));
	346	goto err_dev_open_close_ftdic;
	347	}
4f7fdcdd	348
4f7fdcdd	349	return SR_OK;
7e463623	350
4f7fdcdd SA	351	err_dev_open_close_ftdic:
4f7fdcdd SA	352	ftdi_usb_close(devc->ftdic);
7e463623	353
07a91752 LPC	354	err_ftdi_free:
07a91752 LPC	355	ftdi_free(devc->ftdic);
7e463623	356
4f7fdcdd SA	357	return SR_ERR;
	358	}
	359
	360	static int dev_close(struct sr_dev_inst *sdi)
	361	{
	362	struct dev_context *devc;
	363
	364	devc = sdi->priv;
	365
f1ba6b4b UH	366	if (!devc->ftdic)
f1ba6b4b UH	367	return SR_ERR_BUG;
4f7fdcdd	368
f1ba6b4b UH	369	ftdi_usb_close(devc->ftdic);
	370	ftdi_free(devc->ftdic);
	371	devc->ftdic = NULL;
4f7fdcdd SA	372
	373	return SR_OK;
	374	}
	375
4f7fdcdd SA	376	static int config_get(uint32_t key, GVariant **data,
	377	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
	378	{
4f7fdcdd	379	struct dev_context *devc;
cee6d3fa	380	struct sr_usb_dev_inst *usb;
4f7fdcdd SA	381
	382	(void)cg;
	383
	384	devc = sdi->priv;
	385
4f7fdcdd SA	386	switch (key) {
	387	case SR_CONF_SAMPLERATE:
	388	*data = g_variant_new_uint64(devc->cur_samplerate);
	389	break;
cee6d3fa SA	390	case SR_CONF_CONN:
	391	if (!sdi \|\| !sdi->conn)
	392	return SR_ERR_ARG;
	393	usb = sdi->conn;
95c1fe62	394	*data = g_variant_new_printf("%d.%d", usb->bus, usb->address);
cee6d3fa	395	break;
4f7fdcdd SA	396	default:
	397	return SR_ERR_NA;
	398	}
	399
a9010323	400	return SR_OK;
4f7fdcdd SA	401	}
4f7fdcdd SA	402
4f7fdcdd SA	403	static int config_set(uint32_t key, GVariant *data,
	404	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
	405	{
4f7fdcdd SA	406	struct dev_context *devc;
	407	uint64_t value;
	408
	409	(void)cg;
	410
4f7fdcdd SA	411	devc = sdi->priv;
4f7fdcdd SA	412
4f7fdcdd SA	413	switch (key) {
	414	case SR_CONF_LIMIT_MSEC:
	415	value = g_variant_get_uint64(data);
	416	/* TODO: Implement. */
f6051b9e	417	(void)value;
a9010323	418	return SR_ERR_NA;
4f7fdcdd	419	case SR_CONF_LIMIT_SAMPLES:
4f7fdcdd SA	420	devc->limit_samples = g_variant_get_uint64(data);
	421	break;
	422	case SR_CONF_SAMPLERATE:
	423	value = g_variant_get_uint64(data);
	424	if (value < 3600)
	425	return SR_ERR_SAMPLERATE;
	426	devc->cur_samplerate = value;
f2273382	427	return ftdi_la_set_samplerate(devc);
4f7fdcdd	428	default:
a9010323	429	return SR_ERR_NA;
4f7fdcdd SA	430	}
4f7fdcdd SA	431
a9010323	432	return SR_OK;
4f7fdcdd SA	433	}
	434
	435	static int config_list(uint32_t key, GVariant **data,
	436	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
	437	{
4f7fdcdd SA	438	switch (key) {
4f7fdcdd SA	439	case SR_CONF_SCAN_OPTIONS:
4f7fdcdd	440	case SR_CONF_DEVICE_OPTIONS:
05199c0a	441	return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
4f7fdcdd	442	case SR_CONF_SAMPLERATE:
53012da6	443	*data = std_gvar_samplerates_steps(ARRAY_AND_SIZE(samplerates));
4f7fdcdd SA	444	break;
	445	default:
	446	return SR_ERR_NA;
	447	}
	448
a9010323	449	return SR_OK;
4f7fdcdd SA	450	}
4f7fdcdd SA	451
695dc859	452	static int dev_acquisition_start(const struct sr_dev_inst *sdi)
4f7fdcdd SA	453	{
	454	struct dev_context *devc;
	455
4f7fdcdd SA	456	devc = sdi->priv;
4f7fdcdd SA	457
4f7fdcdd SA	458	if (!devc->ftdic)
	459	return SR_ERR_BUG;
	460
	461	ftdi_set_bitmode(devc->ftdic, 0, BITMODE_BITBANG);
	462
4f7fdcdd SA	463	/* Properly reset internal variables before every new acquisition. */
	464	devc->samples_sent = 0;
	465	devc->bytes_received = 0;
	466
bee2b016	467	std_session_send_df_header(sdi);
4f7fdcdd SA	468
	469	/* Hook up a dummy handler to receive data from the device. */
	470	sr_session_source_add(sdi->session, -1, G_IO_IN, 0,
f2273382	471	ftdi_la_receive_data, (void *)sdi);
4f7fdcdd SA	472
	473	return SR_OK;
	474	}
	475
695dc859	476	static int dev_acquisition_stop(struct sr_dev_inst *sdi)
4f7fdcdd	477	{
4f7fdcdd SA	478	sr_session_source_remove(sdi->session, -1);
4f7fdcdd SA	479
bee2b016	480	std_session_send_df_end(sdi);
4f7fdcdd SA	481
	482	return SR_OK;
	483	}
	484
dd5c48a6	485	static struct sr_dev_driver ftdi_la_driver_info = {
f2273382 UH	486	.name = "ftdi-la",
f2273382 UH	487	.longname = "FTDI LA",
4f7fdcdd	488	.api_version = 1,
c2fdcc25	489	.init = std_init,
700d6b64	490	.cleanup = std_cleanup,
4f7fdcdd	491	.scan = scan,
c01bf34c	492	.dev_list = std_dev_list,
4f7fdcdd SA	493	.dev_clear = dev_clear,
	494	.config_get = config_get,
	495	.config_set = config_set,
	496	.config_list = config_list,
	497	.dev_open = dev_open,
	498	.dev_close = dev_close,
	499	.dev_acquisition_start = dev_acquisition_start,
	500	.dev_acquisition_stop = dev_acquisition_stop,
	501	.context = NULL,
	502	};
dd5c48a6	503	SR_REGISTER_DEV_DRIVER(ftdi_la_driver_info);