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