[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"

SR_PRIV struct sr_dev_driver ftdi_la_driver_info;

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

	/* Allocate memory for the FTDI context (ftdic) and initialize it. */
	devc->ftdic = ftdi_new();
	if (!devc->ftdic) {
		sr_err("Failed to initialize libftdi.");
		goto err_free_data_buf;
	}

	devc->usbdev = dev;
	devc->desc = desc;

	vendor = g_malloc(32);
	model = g_malloc(32);
	serial_num = g_malloc(32);
	rv = ftdi_usb_get_strings(devc->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_INITIALIZING;
	sdi->vendor = vendor;
	sdi->model = model;
	sdi->serial_num = serial_num;
	sdi->driver = di;
	sdi->priv = devc;

	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);
	ftdi_free(devc->ftdic);
err_free_data_buf:
	g_free(devc->data_buf);
	g_free(devc);
}

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

	(void)options;

	devices = NULL;

	/* Allocate memory for the FTDI context (ftdic) and initialize it. */
	ftdic = ftdi_new();
	if (!ftdic) {
		sr_err("Failed to initialize libftdi.");
		return 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));
		goto err_free_ftdic;
	}

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

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

	ftdi_list_free(&devlist);
	ftdi_free(ftdic);

	return devices;

err_free_ftdic:
	ftdi_free(ftdic); /* NOT free() or g_free()! */

	return NULL;
}

static GSList *scan(struct sr_dev_driver *di, GSList *options)
{
	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;
		}
	}
	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, devlist[i], &devices);
				}
			}
		}
		libusb_free_device_list(devlist, 1);
		return devices;
	} else
		return scan_all(di, options);
}

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

	devc = priv;

	ftdi_free(devc->ftdic);
	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;

	ret = ftdi_usb_open_dev(devc->ftdic, devc->usbdev);
	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));
		return SR_ERR;
	}

	/* 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);
	return SR_ERR;
}

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

	devc = sdi->priv;

	ftdi_usb_close(devc->ftdic);

	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;
}

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