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