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

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

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

	/* 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(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(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.");

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

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