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

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

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

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

	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;
	char str[128];

	(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;
		snprintf(str, 128, "%d.%d", usb->bus, usb->address);
		*data = g_variant_new_string(str);
		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. */
		return SR_ERR_NA;
	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:
		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)
{
	GVariant *gvar;
	GVariantBuilder gvb;

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