[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 devopts[] = {
	SR_CONF_LOGIC_ANALYZER,
	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 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 *chip_descs[] = {
	&ft2232h_desc,
	&ft232r_desc,
};

static void scan_device(struct sr_dev_driver *di, 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;
	struct drv_context *drvc;
	int rv;

	drvc = di->context;
	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->vendor == usb_desc.idVendor &&
			desc->product == usb_desc.idProduct)
			break;
	}

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

	/* Allocate memory for our private device context. */
	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);

	/* Register the device with libsigrok. */
	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->driver = di;
	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);
	drvc->instances = g_slist_append(drvc->instances, 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, struct sr_dev_driver *di,
	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;
	}

	sr_dbg("Number of FTDI devices found: %d", ret);

	curdev = devlist;
	while (curdev) {
		scan_device(di, 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;
	drvc->instances = NULL;
	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;
		}
	}

	/* Allocate memory for the FTDI context (ftdic) and initialize it. */
	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(di, ftdic, devlist[i], &devices);
				}
			}
		}
		libusb_free_device_list(devlist, 1);
	} else
		devices = scan_all(ftdic, di, options);

	ftdi_free(ftdic);

	return devices;
}

static void clear_helper(void *priv)
{
	struct dev_context *devc;

	devc = priv;
	g_free(devc->data_buf);
	g_free(devc);
}

static int dev_clear(const struct sr_dev_driver *di)
{
	return std_dev_clear(di, 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;
	}

	/* Purge RX/TX buffers in the FTDI chip. */
	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;
	}
	sr_dbg("FTDI chip buffers purged successfully.");

	/* Reset the FTDI bitmode. */
	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;
	}
	sr_dbg("FTDI chip bitmode reset successfully.");

	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;
	}
	sr_dbg("FTDI chip bitbang mode entered successfully.");

	sdi->status = SR_ST_ACTIVE;

	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) {
		ftdi_usb_close(devc->ftdic);
		ftdi_free(devc->ftdic);
		devc->ftdic = NULL;
	}

	sdi->status = SR_ST_INACTIVE;

	return SR_OK;
}

static int config_get(uint32_t key, GVariant **data,
	const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
{
	int ret;
	struct dev_context *devc;
	struct sr_usb_dev_inst *usb;
	char str[128];

	(void)cg;

	devc = sdi->priv;

	ret = SR_OK;
	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;
		snprintf(str, 128, "%d.%d", usb->bus, usb->address);
		*data = g_variant_new_string(str);
		break;
	default:
		return SR_ERR_NA;
	}

	return ret;
}

static int config_set(uint32_t key, GVariant *data,
	const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
{
	int ret;
	struct dev_context *devc;
	uint64_t value;

	(void)cg;

	if (sdi->status != SR_ST_ACTIVE)
		return SR_ERR_DEV_CLOSED;

	devc = sdi->priv;

	ret = SR_OK;
	switch (key) {
	case SR_CONF_LIMIT_MSEC:
		value = g_variant_get_uint64(data);
		/* TODO: Implement. */
		ret = SR_ERR_NA;
		break;
	case SR_CONF_LIMIT_SAMPLES:
		if (g_variant_get_uint64(data) == 0)
			return SR_ERR_ARG;
		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:
		ret = SR_ERR_NA;
	}

	return ret;
}

static int config_list(uint32_t key, GVariant **data,
	const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
{
	int ret;
	GVariant *gvar;
	GVariantBuilder gvb;

	(void)sdi;
	(void)cg;

	ret = SR_OK;
	switch (key) {
	case SR_CONF_SCAN_OPTIONS:
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
			scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
		break;
	case SR_CONF_DEVICE_OPTIONS:
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
			devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
		break;
	case SR_CONF_SAMPLERATE:
		g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
		gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
			samplerates, ARRAY_SIZE(samplerates), sizeof(uint64_t));
		g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar);
		*data = g_variant_builder_end(&gvb);
		break;
	default:
		return SR_ERR_NA;
	}

	return ret;
}

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

	devc = sdi->priv;

	if (sdi->status != SR_ST_ACTIVE)
		return SR_ERR_DEV_CLOSED;

	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, LOG_PREFIX);

	/* 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)
{
	if (sdi->status != SR_ST_ACTIVE)
		return SR_ERR_DEV_CLOSED;

	sr_dbg("Stopping acquisition.");
	sr_session_source_remove(sdi->session, -1);

	std_session_send_df_end(sdi, LOG_PREFIX);

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