[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)
{
	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(32);
	model = g_malloc(32);
	serial_num = g_malloc(32);
	rv = ftdi_usb_get_strings(ftdic, dev, vendor, 32,
			model, 32, serial_num, 32);
	switch (rv) {
	case 0:
		break;
	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 = ftdi_usb_purge_buffers(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	{
4f7fdcdd SA	114	struct libusb_device_descriptor usb_desc;
4f7fdcdd SA	115	const struct ftdi_chip_desc *desc;
cee6d3fa	116	struct dev_context *devc;
4f7fdcdd	117	char vendor, model, *serial_num;
cee6d3fa	118	struct sr_dev_inst *sdi;
cee6d3fa	119	int rv;
4f7fdcdd	120
cee6d3fa SA	121	libusb_get_device_descriptor(dev, &usb_desc);
	122
	123	desc = NULL;
	124	for (unsigned long i = 0; i < ARRAY_SIZE(chip_descs); i++) {
	125	desc = chip_descs[i];
01ae826b GS	126	if (!desc)
01ae826b GS	127	break;
cee6d3fa SA	128	if (desc->vendor == usb_desc.idVendor &&
	129	desc->product == usb_desc.idProduct)
	130	break;
	131	}
	132
	133	if (!desc) {
66e19f47	134	sr_spew("Unsupported FTDI device 0x%04x:0x%04x.",
cee6d3fa SA	135	usb_desc.idVendor, usb_desc.idProduct);
	136	return;
	137	}
4f7fdcdd	138
4f7fdcdd SA	139	devc = g_malloc0(sizeof(struct dev_context));
	140
	141	/* Allocate memory for the incoming data. */
	142	devc->data_buf = g_malloc0(DATA_BUF_SIZE);
	143
cee6d3fa SA	144	devc->desc = desc;
	145
	146	vendor = g_malloc(32);
	147	model = g_malloc(32);
	148	serial_num = g_malloc(32);
07a91752	149	rv = ftdi_usb_get_strings(ftdic, dev, vendor, 32,
d9251a2c	150	model, 32, serial_num, 32);
cee6d3fa SA	151	switch (rv) {
	152	case 0:
	153	break;
	154	case -9:
	155	sr_dbg("The device lacks a serial number.");
	156	g_free(serial_num);
	157	serial_num = NULL;
	158	break;
	159	default:
	160	sr_err("Failed to get the FTDI strings: %d", rv);
	161	goto err_free_strings;
	162	}
	163	sr_dbg("Found an FTDI device: %s.", model);
	164
cee6d3fa	165	sdi = g_malloc0(sizeof(struct sr_dev_inst));
45884333	166	sdi->status = SR_ST_INACTIVE;
cee6d3fa SA	167	sdi->vendor = vendor;
	168	sdi->model = model;
	169	sdi->serial_num = serial_num;
cee6d3fa	170	sdi->priv = devc;
634d7299 LPC	171	sdi->connection_id = g_strdup_printf("d:%u/%u",
634d7299 LPC	172	libusb_get_bus_number(dev), libusb_get_device_address(dev));
cee6d3fa SA	173
	174	for (char const chan = &(desc->channel_names[0]); *chan; chan++)
	175	sr_channel_new(sdi, chan - &(desc->channel_names[0]),
	176	SR_CHANNEL_LOGIC, TRUE, *chan);
	177
	178	devices = g_slist_append(devices, sdi);
cee6d3fa SA	179	return;
	180
	181	err_free_strings:
	182	g_free(vendor);
	183	g_free(model);
	184	g_free(serial_num);
cee6d3fa SA	185	g_free(devc->data_buf);
	186	g_free(devc);
	187	}
	188
15a5bfe4	189	static GSList scan_all(struct ftdi_context ftdic, GSList *options)
cee6d3fa SA	190	{
	191	GSList *devices;
	192	struct ftdi_device_list *devlist = 0;
	193	struct ftdi_device_list *curdev;
cee6d3fa SA	194	int ret;
	195
	196	(void)options;
	197
	198	devices = NULL;
	199
cee6d3fa	200	ret = ftdi_usb_find_all(ftdic, &devlist, 0, 0);
4f7fdcdd SA	201	if (ret < 0) {
4f7fdcdd SA	202	sr_err("Failed to list devices (%d): %s", ret,
cee6d3fa	203	ftdi_get_error_string(ftdic));
07a91752	204	return NULL;
4f7fdcdd SA	205	}
4f7fdcdd SA	206
4f7fdcdd SA	207	curdev = devlist;
4f7fdcdd SA	208	while (curdev) {
15a5bfe4	209	scan_device(ftdic, curdev->dev, &devices);
4f7fdcdd SA	210	curdev = curdev->next;
	211	}
	212
7b6072d3	213	ftdi_list_free(&devlist);
7b6072d3	214
4f7fdcdd	215	return devices;
4f7fdcdd SA	216	}
4f7fdcdd SA	217
cee6d3fa SA	218	static GSList scan(struct sr_dev_driver di, GSList *options)
cee6d3fa SA	219	{
07a91752	220	struct ftdi_context *ftdic;
cee6d3fa SA	221	struct sr_config *src;
	222	struct sr_usb_dev_inst *usb;
	223	const char *conn;
	224	GSList l, conn_devices;
	225	GSList *devices;
	226	struct drv_context *drvc;
	227	libusb_device **devlist;
	228	int i;
	229
	230	drvc = di->context;
cee6d3fa SA	231	conn = NULL;
	232	for (l = options; l; l = l->next) {
	233	src = l->data;
	234	if (src->key == SR_CONF_CONN) {
	235	conn = g_variant_get_string(src->data, NULL);
	236	break;
	237	}
	238	}
07a91752	239
07a91752 LPC	240	ftdic = ftdi_new();
	241	if (!ftdic) {
	242	sr_err("Failed to initialize libftdi.");
	243	return NULL;
	244	}
	245
cee6d3fa SA	246	if (conn) {
	247	devices = NULL;
	248	libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
	249	for (i = 0; devlist[i]; i++) {
	250	conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
	251	for (l = conn_devices; l; l = l->next) {
	252	usb = l->data;
	253	if (usb->bus == libusb_get_bus_number(devlist[i])
	254	&& usb->address == libusb_get_device_address(devlist[i])) {
15a5bfe4	255	scan_device(ftdic, devlist[i], &devices);
cee6d3fa SA	256	}
	257	}
	258	}
	259	libusb_free_device_list(devlist, 1);
cee6d3fa	260	} else
15a5bfe4	261	devices = scan_all(ftdic, options);
07a91752 LPC	262
	263	ftdi_free(ftdic);
	264
15a5bfe4	265	return std_scan_complete(di, devices);
cee6d3fa SA	266	}
cee6d3fa SA	267
3553451f	268	static void clear_helper(struct dev_context *devc)
4f7fdcdd	269	{
4f7fdcdd	270	g_free(devc->data_buf);
4f7fdcdd SA	271	}
	272
	273	static int dev_clear(const struct sr_dev_driver *di)
	274	{
3553451f	275	return std_dev_clear_with_callback(di, (std_dev_clear_callback)clear_helper);
4f7fdcdd SA	276	}
	277
	278	static int dev_open(struct sr_dev_inst *sdi)
	279	{
	280	struct dev_context *devc;
	281	int ret = SR_OK;
	282
	283	devc = sdi->priv;
	284
07a91752 LPC	285	devc->ftdic = ftdi_new();
	286	if (!devc->ftdic)
	287	return SR_ERR;
	288
634d7299	289	ret = ftdi_usb_open_string(devc->ftdic, sdi->connection_id);
4f7fdcdd SA	290	if (ret < 0) {
	291	/* Log errors, except for -3 ("device not found"). */
	292	if (ret != -3)
	293	sr_err("Failed to open device (%d): %s", ret,
	294	ftdi_get_error_string(devc->ftdic));
07a91752	295	goto err_ftdi_free;
4f7fdcdd SA	296	}
4f7fdcdd SA	297
4f7fdcdd SA	298	ret = ftdi_usb_purge_buffers(devc->ftdic);
	299	if (ret < 0) {
	300	sr_err("Failed to purge FTDI RX/TX buffers (%d): %s.",
	301	ret, ftdi_get_error_string(devc->ftdic));
	302	goto err_dev_open_close_ftdic;
	303	}
4f7fdcdd	304
4f7fdcdd SA	305	ret = ftdi_set_bitmode(devc->ftdic, 0x00, BITMODE_RESET);
	306	if (ret < 0) {
	307	sr_err("Failed to reset the FTDI chip bitmode (%d): %s.",
	308	ret, ftdi_get_error_string(devc->ftdic));
	309	goto err_dev_open_close_ftdic;
	310	}
4f7fdcdd SA	311
	312	ret = ftdi_set_bitmode(devc->ftdic, 0x00, BITMODE_BITBANG);
	313	if (ret < 0) {
	314	sr_err("Failed to put FTDI chip into bitbang mode (%d): %s.",
	315	ret, ftdi_get_error_string(devc->ftdic));
	316	goto err_dev_open_close_ftdic;
	317	}
4f7fdcdd	318
4f7fdcdd	319	return SR_OK;
7e463623	320
4f7fdcdd SA	321	err_dev_open_close_ftdic:
4f7fdcdd SA	322	ftdi_usb_close(devc->ftdic);
7e463623	323
07a91752 LPC	324	err_ftdi_free:
07a91752 LPC	325	ftdi_free(devc->ftdic);
7e463623	326
4f7fdcdd SA	327	return SR_ERR;
	328	}
	329
	330	static int dev_close(struct sr_dev_inst *sdi)
	331	{
	332	struct dev_context *devc;
	333
	334	devc = sdi->priv;
	335
f1ba6b4b UH	336	if (!devc->ftdic)
f1ba6b4b UH	337	return SR_ERR_BUG;
4f7fdcdd	338
f1ba6b4b UH	339	ftdi_usb_close(devc->ftdic);
	340	ftdi_free(devc->ftdic);
	341	devc->ftdic = NULL;
4f7fdcdd SA	342
	343	return SR_OK;
	344	}
	345
4f7fdcdd SA	346	static int config_get(uint32_t key, GVariant **data,
	347	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
	348	{
4f7fdcdd	349	struct dev_context *devc;
cee6d3fa	350	struct sr_usb_dev_inst *usb;
4f7fdcdd SA	351
	352	(void)cg;
	353
	354	devc = sdi->priv;
	355
4f7fdcdd SA	356	switch (key) {
	357	case SR_CONF_SAMPLERATE:
	358	*data = g_variant_new_uint64(devc->cur_samplerate);
	359	break;
cee6d3fa SA	360	case SR_CONF_CONN:
	361	if (!sdi \|\| !sdi->conn)
	362	return SR_ERR_ARG;
	363	usb = sdi->conn;
95c1fe62	364	*data = g_variant_new_printf("%d.%d", usb->bus, usb->address);
cee6d3fa	365	break;
4f7fdcdd SA	366	default:
	367	return SR_ERR_NA;
	368	}
	369
a9010323	370	return SR_OK;
4f7fdcdd SA	371	}
4f7fdcdd SA	372
4f7fdcdd SA	373	static int config_set(uint32_t key, GVariant *data,
	374	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
	375	{
4f7fdcdd SA	376	struct dev_context *devc;
	377	uint64_t value;
	378
	379	(void)cg;
	380
4f7fdcdd SA	381	devc = sdi->priv;
4f7fdcdd SA	382
4f7fdcdd SA	383	switch (key) {
	384	case SR_CONF_LIMIT_MSEC:
	385	value = g_variant_get_uint64(data);
	386	/* TODO: Implement. */
f6051b9e	387	(void)value;
a9010323	388	return SR_ERR_NA;
4f7fdcdd	389	case SR_CONF_LIMIT_SAMPLES:
4f7fdcdd SA	390	devc->limit_samples = g_variant_get_uint64(data);
	391	break;
	392	case SR_CONF_SAMPLERATE:
	393	value = g_variant_get_uint64(data);
	394	if (value < 3600)
	395	return SR_ERR_SAMPLERATE;
	396	devc->cur_samplerate = value;
f2273382	397	return ftdi_la_set_samplerate(devc);
4f7fdcdd	398	default:
a9010323	399	return SR_ERR_NA;
4f7fdcdd SA	400	}
4f7fdcdd SA	401
a9010323	402	return SR_OK;
4f7fdcdd SA	403	}
	404
	405	static int config_list(uint32_t key, GVariant **data,
	406	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
	407	{
4f7fdcdd SA	408	switch (key) {
4f7fdcdd SA	409	case SR_CONF_SCAN_OPTIONS:
4f7fdcdd	410	case SR_CONF_DEVICE_OPTIONS:
05199c0a	411	return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
4f7fdcdd	412	case SR_CONF_SAMPLERATE:
53012da6	413	*data = std_gvar_samplerates_steps(ARRAY_AND_SIZE(samplerates));
4f7fdcdd SA	414	break;
	415	default:
	416	return SR_ERR_NA;
	417	}
	418
a9010323	419	return SR_OK;
4f7fdcdd SA	420	}
4f7fdcdd SA	421
695dc859	422	static int dev_acquisition_start(const struct sr_dev_inst *sdi)
4f7fdcdd SA	423	{
	424	struct dev_context *devc;
	425
4f7fdcdd SA	426	devc = sdi->priv;
4f7fdcdd SA	427
4f7fdcdd SA	428	if (!devc->ftdic)
	429	return SR_ERR_BUG;
	430
	431	ftdi_set_bitmode(devc->ftdic, 0, BITMODE_BITBANG);
	432
4f7fdcdd SA	433	/* Properly reset internal variables before every new acquisition. */
	434	devc->samples_sent = 0;
	435	devc->bytes_received = 0;
	436
bee2b016	437	std_session_send_df_header(sdi);
4f7fdcdd SA	438
	439	/* Hook up a dummy handler to receive data from the device. */
	440	sr_session_source_add(sdi->session, -1, G_IO_IN, 0,
f2273382	441	ftdi_la_receive_data, (void *)sdi);
4f7fdcdd SA	442
	443	return SR_OK;
	444	}
	445
695dc859	446	static int dev_acquisition_stop(struct sr_dev_inst *sdi)
4f7fdcdd	447	{
4f7fdcdd SA	448	sr_session_source_remove(sdi->session, -1);
4f7fdcdd SA	449
bee2b016	450	std_session_send_df_end(sdi);
4f7fdcdd SA	451
	452	return SR_OK;
	453	}
	454
dd5c48a6	455	static struct sr_dev_driver ftdi_la_driver_info = {
f2273382 UH	456	.name = "ftdi-la",
f2273382 UH	457	.longname = "FTDI LA",
4f7fdcdd	458	.api_version = 1,
c2fdcc25	459	.init = std_init,
700d6b64	460	.cleanup = std_cleanup,
4f7fdcdd	461	.scan = scan,
c01bf34c	462	.dev_list = std_dev_list,
4f7fdcdd SA	463	.dev_clear = dev_clear,
	464	.config_get = config_get,
	465	.config_set = config_set,
	466	.config_list = config_list,
	467	.dev_open = dev_open,
	468	.dev_close = dev_close,
	469	.dev_acquisition_start = dev_acquisition_start,
	470	.dev_acquisition_stop = dev_acquisition_stop,
	471	.context = NULL,
	472	};
dd5c48a6	473	SR_REGISTER_DEV_DRIVER(ftdi_la_driver_info);