[libsigrok.git] / src / hardware / ftdi-la / api.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2015 Sergey Alirzaev <zl29ah@gmail.com>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#include <config.h>
#include <ftdi.h>
#include <libusb.h>
#include <libsigrok/libsigrok.h>
#include "libsigrok-internal.h"
#include "protocol.h"

static const uint32_t scanopts[] = {
	SR_CONF_CONN,
};

static const uint32_t drvopts[] = {
	SR_CONF_LOGIC_ANALYZER,
};

static const uint32_t devopts[] = {
	SR_CONF_CONTINUOUS,
	SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
	SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
	SR_CONF_CONN | SR_CONF_GET,
};

static const uint64_t samplerates[] = {
	SR_HZ(3600),
	SR_MHZ(10),
	SR_HZ(1),
};

static const struct ftdi_chip_desc ft2232h_desc = {
	.vendor = 0x0403,
	.product = 0x6010,
	.samplerate_div = 20,
	.channel_names = {
		"ADBUS0", "ADBUS1", "ADBUS2", "ADBUS3",
		"ADBUS4", "ADBUS5", "ADBUS6", "ADBUS7",
		/* TODO: BDBUS[0..7] channels. */
		NULL
	}
};

static const struct ftdi_chip_desc ft232r_desc = {
	.vendor = 0x0403,
	.product = 0x6001,
	.samplerate_div = 30,
	.channel_names = {
		"TXD", "RXD", "RTS#", "CTS#", "DTR#", "DSR#", "DCD#", "RI#",
		NULL
	}
};

static const struct ftdi_chip_desc ft232h_desc = {
	.vendor = 0x0403,
	.product = 0x6014,
	.samplerate_div = 30,
	.channel_names = {
		"ADBUS0", "ADBUS1", "ADBUS2", "ADBUS3", "ADBUS4", "ADBUS5", "ADBUS6", "ADBUS7",
		NULL
	}
};

static const struct ftdi_chip_desc *chip_descs[] = {
	&ft2232h_desc,
	&ft232r_desc,
	&ft232h_desc,
};

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

	devc = g_malloc0(sizeof(struct dev_context));

	/* Allocate memory for the incoming data. */
	devc->data_buf = g_malloc0(DATA_BUF_SIZE);

	devc->desc = desc;

	vendor = g_malloc(32);
	model = g_malloc(32);
	serial_num = g_malloc(32);
	rv = ftdi_usb_get_strings(ftdic, dev, vendor, 32,
			model, 32, serial_num, 32);
	switch (rv) {
	case 0:
		break;
	case -9:
		sr_dbg("The device lacks a serial number.");
		g_free(serial_num);
		serial_num = NULL;
		break;
	default:
		sr_err("Failed to get the FTDI strings: %d", rv);
		goto err_free_strings;
	}
	sr_dbg("Found an FTDI device: %s.", model);

	sdi = g_malloc0(sizeof(struct sr_dev_inst));
	sdi->status = SR_ST_INACTIVE;
	sdi->vendor = vendor;
	sdi->model = model;
	sdi->serial_num = serial_num;
	sdi->priv = devc;
	sdi->connection_id = g_strdup_printf("d:%u/%u",
		libusb_get_bus_number(dev), libusb_get_device_address(dev));

	for (char *const *chan = &(desc->channel_names[0]); *chan; chan++)
		sr_channel_new(sdi, chan - &(desc->channel_names[0]),
				SR_CHANNEL_LOGIC, TRUE, *chan);

	*devices = g_slist_append(*devices, sdi);
	return;

err_free_strings:
	g_free(vendor);
	g_free(model);
	g_free(serial_num);
	g_free(devc->data_buf);
	g_free(devc);
}

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

	(void)options;

	devices = NULL;

	ret = ftdi_usb_find_all(ftdic, &devlist, 0, 0);
	if (ret < 0) {
		sr_err("Failed to list devices (%d): %s", ret,
		       ftdi_get_error_string(ftdic));
		return NULL;
	}

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

	ftdi_list_free(&devlist);

	return devices;
}

static GSList *scan(struct sr_dev_driver *di, GSList *options)
{
	struct ftdi_context *ftdic;
	struct sr_config *src;
	struct sr_usb_dev_inst *usb;
	const char *conn;
	GSList *l, *conn_devices;
	GSList *devices;
	struct drv_context *drvc;
	libusb_device **devlist;
	int i;

	drvc = di->context;
	conn = NULL;
	for (l = options; l; l = l->next) {
		src = l->data;
		if (src->key == SR_CONF_CONN) {
			conn = g_variant_get_string(src->data, NULL);
			break;
		}
	}

	ftdic = ftdi_new();
	if (!ftdic) {
		sr_err("Failed to initialize libftdi.");
		return NULL;
	}

	if (conn) {
		devices = NULL;
		libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
		for (i = 0; devlist[i]; i++) {
			conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
			for (l = conn_devices; l; l = l->next) {
				usb = l->data;
				if (usb->bus == libusb_get_bus_number(devlist[i])
					&& usb->address == libusb_get_device_address(devlist[i])) {
					scan_device(ftdic, devlist[i], &devices);
				}
			}
		}
		libusb_free_device_list(devlist, 1);
	} else
		devices = scan_all(ftdic, options);

	ftdi_free(ftdic);

	return std_scan_complete(di, devices);
}

static void clear_helper(struct dev_context *devc)
{
	g_free(devc->data_buf);
}

static int dev_clear(const struct sr_dev_driver *di)
{
	return std_dev_clear_with_callback(di, (std_dev_clear_callback)clear_helper);
}

static int dev_open(struct sr_dev_inst *sdi)
{
	struct dev_context *devc;
	int ret = SR_OK;

	devc = sdi->priv;

	devc->ftdic = ftdi_new();
	if (!devc->ftdic)
		return SR_ERR;

	ret = ftdi_usb_open_string(devc->ftdic, sdi->connection_id);
	if (ret < 0) {
		/* Log errors, except for -3 ("device not found"). */
		if (ret != -3)
			sr_err("Failed to open device (%d): %s", ret,
			       ftdi_get_error_string(devc->ftdic));
		goto err_ftdi_free;
	}

	ret = ftdi_usb_purge_buffers(devc->ftdic);
	if (ret < 0) {
		sr_err("Failed to purge FTDI RX/TX buffers (%d): %s.",
		       ret, ftdi_get_error_string(devc->ftdic));
		goto err_dev_open_close_ftdic;
	}

	ret = ftdi_set_bitmode(devc->ftdic, 0x00, BITMODE_RESET);
	if (ret < 0) {
		sr_err("Failed to reset the FTDI chip bitmode (%d): %s.",
		       ret, ftdi_get_error_string(devc->ftdic));
		goto err_dev_open_close_ftdic;
	}

	ret = ftdi_set_bitmode(devc->ftdic, 0x00, BITMODE_BITBANG);
	if (ret < 0) {
		sr_err("Failed to put FTDI chip into bitbang mode (%d): %s.",
		       ret, ftdi_get_error_string(devc->ftdic));
		goto err_dev_open_close_ftdic;
	}

	return SR_OK;

err_dev_open_close_ftdic:
	ftdi_usb_close(devc->ftdic);

err_ftdi_free:
	ftdi_free(devc->ftdic);

	return SR_ERR;
}

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

	devc = sdi->priv;

	if (!devc->ftdic)
		return SR_ERR_BUG;

	ftdi_usb_close(devc->ftdic);
	ftdi_free(devc->ftdic);
	devc->ftdic = NULL;

	return SR_OK;
}

static int config_get(uint32_t key, GVariant **data,
	const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
{
	struct dev_context *devc;
	struct sr_usb_dev_inst *usb;

	(void)cg;

	devc = sdi->priv;

	switch (key) {
	case SR_CONF_SAMPLERATE:
		*data = g_variant_new_uint64(devc->cur_samplerate);
		break;
	case SR_CONF_CONN:
		if (!sdi || !sdi->conn)
			return SR_ERR_ARG;
		usb = sdi->conn;
		*data = g_variant_new_printf("%d.%d", usb->bus, usb->address);
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

static int config_set(uint32_t key, GVariant *data,
	const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
{
	struct dev_context *devc;
	uint64_t value;

	(void)cg;

	devc = sdi->priv;

	switch (key) {
	case SR_CONF_LIMIT_MSEC:
		value = g_variant_get_uint64(data);
		/* TODO: Implement. */
		(void)value;
		return SR_ERR_NA;
	case SR_CONF_LIMIT_SAMPLES:
		devc->limit_samples = g_variant_get_uint64(data);
		break;
	case SR_CONF_SAMPLERATE:
		value = g_variant_get_uint64(data);
		if (value < 3600)
			return SR_ERR_SAMPLERATE;
		devc->cur_samplerate = value;
		return ftdi_la_set_samplerate(devc);
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

static int config_list(uint32_t key, GVariant **data,
	const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
{
	switch (key) {
	case SR_CONF_SCAN_OPTIONS:
	case SR_CONF_DEVICE_OPTIONS:
		return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
	case SR_CONF_SAMPLERATE:
		*data = std_gvar_samplerates_steps(ARRAY_AND_SIZE(samplerates));
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

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

	devc = sdi->priv;

	if (!devc->ftdic)
		return SR_ERR_BUG;

	ftdi_set_bitmode(devc->ftdic, 0, BITMODE_BITBANG);

	/* Properly reset internal variables before every new acquisition. */
	devc->samples_sent = 0;
	devc->bytes_received = 0;

	std_session_send_df_header(sdi);

	/* Hook up a dummy handler to receive data from the device. */
	sr_session_source_add(sdi->session, -1, G_IO_IN, 0,
			      ftdi_la_receive_data, (void *)sdi);

	return SR_OK;
}

static int dev_acquisition_stop(struct sr_dev_inst *sdi)
{
	sr_session_source_remove(sdi->session, -1);

	std_session_send_df_end(sdi);

	return SR_OK;
}

static struct sr_dev_driver ftdi_la_driver_info = {
	.name = "ftdi-la",
	.longname = "FTDI LA",
	.api_version = 1,
	.init = std_init,
	.cleanup = std_cleanup,
	.scan = scan,
	.dev_list = std_dev_list,
	.dev_clear = dev_clear,
	.config_get = config_get,
	.config_set = config_set,
	.config_list = config_list,
	.dev_open = dev_open,
	.dev_close = dev_close,
	.dev_acquisition_start = dev_acquisition_start,
	.dev_acquisition_stop = dev_acquisition_stop,
	.context = NULL,
};
SR_REGISTER_DEV_DRIVER(ftdi_la_driver_info);
Commit	Line	Data
4f7fdcdd SA	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2015 Sergey Alirzaev <zl29ah@gmail.com>
	5	*
	6	* This program is free software: you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License as published by
	8	* the Free Software Foundation, either version 3 of the License, or
	9	* (at your option) any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License
	17	* along with this program. If not, see <http://www.gnu.org/licenses/>.
	18	*/
	19
cee6d3fa	20	#include <config.h>
4f7fdcdd SA	21	#include <ftdi.h>
4f7fdcdd SA	22	#include <libusb.h>
cee6d3fa SA	23	#include <libsigrok/libsigrok.h>
cee6d3fa SA	24	#include "libsigrok-internal.h"
4f7fdcdd SA	25	#include "protocol.h"
4f7fdcdd SA	26
4f7fdcdd	27	static const uint32_t scanopts[] = {
cee6d3fa	28	SR_CONF_CONN,
4f7fdcdd SA	29	};
4f7fdcdd SA	30
05199c0a	31	static const uint32_t drvopts[] = {
4f7fdcdd	32	SR_CONF_LOGIC_ANALYZER,
05199c0a UH	33	};
	34
	35	static const uint32_t devopts[] = {
e91bb0a6	36	SR_CONF_CONTINUOUS,
4f7fdcdd SA	37	SR_CONF_LIMIT_SAMPLES \| SR_CONF_SET,
4f7fdcdd SA	38	SR_CONF_SAMPLERATE \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
cee6d3fa	39	SR_CONF_CONN \| SR_CONF_GET,
4f7fdcdd SA	40	};
	41
	42	static const uint64_t samplerates[] = {
	43	SR_HZ(3600),
	44	SR_MHZ(10),
	45	SR_HZ(1),
	46	};
	47
	48	static const struct ftdi_chip_desc ft2232h_desc = {
	49	.vendor = 0x0403,
	50	.product = 0x6010,
	51	.samplerate_div = 20,
	52	.channel_names = {
f8195cb2 UH	53	"ADBUS0", "ADBUS1", "ADBUS2", "ADBUS3",
f8195cb2 UH	54	"ADBUS4", "ADBUS5", "ADBUS6", "ADBUS7",
4f7fdcdd SA	55	/* TODO: BDBUS[0..7] channels. */
	56	NULL
	57	}
	58	};
	59
	60	static const struct ftdi_chip_desc ft232r_desc = {
	61	.vendor = 0x0403,
	62	.product = 0x6001,
	63	.samplerate_div = 30,
	64	.channel_names = {
f8195cb2	65	"TXD", "RXD", "RTS#", "CTS#", "DTR#", "DSR#", "DCD#", "RI#",
4f7fdcdd SA	66	NULL
	67	}
	68	};
	69
c7a51272 P	70	static const struct ftdi_chip_desc ft232h_desc = {
	71	.vendor = 0x0403,
	72	.product = 0x6014,
	73	.samplerate_div = 30,
	74	.channel_names = {
	75	"ADBUS0", "ADBUS1", "ADBUS2", "ADBUS3", "ADBUS4", "ADBUS5", "ADBUS6", "ADBUS7",
	76	NULL
	77	}
	78	};
	79
4f7fdcdd SA	80	static const struct ftdi_chip_desc *chip_descs[] = {
	81	&ft2232h_desc,
	82	&ft232r_desc,
c7a51272	83	&ft232h_desc,
4f7fdcdd SA	84	};
4f7fdcdd SA	85
15a5bfe4	86	static void scan_device(struct ftdi_context *ftdic,
07a91752	87	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	93	struct sr_dev_inst *sdi;
cee6d3fa	94	int rv;
4f7fdcdd	95
cee6d3fa SA	96	libusb_get_device_descriptor(dev, &usb_desc);
	97
	98	desc = NULL;
	99	for (unsigned long i = 0; i < ARRAY_SIZE(chip_descs); i++) {
	100	desc = chip_descs[i];
	101	if (desc->vendor == usb_desc.idVendor &&
	102	desc->product == usb_desc.idProduct)
	103	break;
	104	}
	105
	106	if (!desc) {
	107	sr_spew("Unsupported FTDI device 0x%4x:0x%4x.",
	108	usb_desc.idVendor, usb_desc.idProduct);
	109	return;
	110	}
4f7fdcdd	111
4f7fdcdd SA	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
cee6d3fa	138	sdi = g_malloc0(sizeof(struct sr_dev_inst));
45884333	139	sdi->status = SR_ST_INACTIVE;
cee6d3fa SA	140	sdi->vendor = vendor;
	141	sdi->model = model;
	142	sdi->serial_num = serial_num;
cee6d3fa	143	sdi->priv = devc;
634d7299 LPC	144	sdi->connection_id = g_strdup_printf("d:%u/%u",
634d7299 LPC	145	libusb_get_bus_number(dev), libusb_get_device_address(dev));
cee6d3fa SA	146
	147	for (char const chan = &(desc->channel_names[0]); *chan; chan++)
	148	sr_channel_new(sdi, chan - &(desc->channel_names[0]),
	149	SR_CHANNEL_LOGIC, TRUE, *chan);
	150
	151	devices = g_slist_append(devices, sdi);
cee6d3fa SA	152	return;
	153
	154	err_free_strings:
	155	g_free(vendor);
	156	g_free(model);
	157	g_free(serial_num);
cee6d3fa SA	158	g_free(devc->data_buf);
	159	g_free(devc);
	160	}
	161
15a5bfe4	162	static GSList scan_all(struct ftdi_context ftdic, GSList *options)
cee6d3fa SA	163	{
	164	GSList *devices;
	165	struct ftdi_device_list *devlist = 0;
	166	struct ftdi_device_list *curdev;
cee6d3fa SA	167	int ret;
	168
	169	(void)options;
	170
	171	devices = NULL;
	172
cee6d3fa	173	ret = ftdi_usb_find_all(ftdic, &devlist, 0, 0);
4f7fdcdd SA	174	if (ret < 0) {
4f7fdcdd SA	175	sr_err("Failed to list devices (%d): %s", ret,
cee6d3fa	176	ftdi_get_error_string(ftdic));
07a91752	177	return NULL;
4f7fdcdd SA	178	}
4f7fdcdd SA	179
4f7fdcdd SA	180	curdev = devlist;
4f7fdcdd SA	181	while (curdev) {
15a5bfe4	182	scan_device(ftdic, curdev->dev, &devices);
4f7fdcdd SA	183	curdev = curdev->next;
	184	}
	185
7b6072d3	186	ftdi_list_free(&devlist);
7b6072d3	187
4f7fdcdd	188	return devices;
4f7fdcdd SA	189	}
4f7fdcdd SA	190
cee6d3fa SA	191	static GSList scan(struct sr_dev_driver di, GSList *options)
cee6d3fa SA	192	{
07a91752	193	struct ftdi_context *ftdic;
cee6d3fa SA	194	struct sr_config *src;
	195	struct sr_usb_dev_inst *usb;
	196	const char *conn;
	197	GSList l, conn_devices;
	198	GSList *devices;
	199	struct drv_context *drvc;
	200	libusb_device **devlist;
	201	int i;
	202
	203	drvc = di->context;
cee6d3fa SA	204	conn = NULL;
	205	for (l = options; l; l = l->next) {
	206	src = l->data;
	207	if (src->key == SR_CONF_CONN) {
	208	conn = g_variant_get_string(src->data, NULL);
	209	break;
	210	}
	211	}
07a91752	212
07a91752 LPC	213	ftdic = ftdi_new();
	214	if (!ftdic) {
	215	sr_err("Failed to initialize libftdi.");
	216	return NULL;
	217	}
	218
cee6d3fa SA	219	if (conn) {
	220	devices = NULL;
	221	libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
	222	for (i = 0; devlist[i]; i++) {
	223	conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
	224	for (l = conn_devices; l; l = l->next) {
	225	usb = l->data;
	226	if (usb->bus == libusb_get_bus_number(devlist[i])
	227	&& usb->address == libusb_get_device_address(devlist[i])) {
15a5bfe4	228	scan_device(ftdic, devlist[i], &devices);
cee6d3fa SA	229	}
	230	}
	231	}
	232	libusb_free_device_list(devlist, 1);
cee6d3fa	233	} else
15a5bfe4	234	devices = scan_all(ftdic, options);
07a91752 LPC	235
	236	ftdi_free(ftdic);
	237
15a5bfe4	238	return std_scan_complete(di, devices);
cee6d3fa SA	239	}
cee6d3fa SA	240
3553451f	241	static void clear_helper(struct dev_context *devc)
4f7fdcdd	242	{
4f7fdcdd	243	g_free(devc->data_buf);
4f7fdcdd SA	244	}
	245
	246	static int dev_clear(const struct sr_dev_driver *di)
	247	{
3553451f	248	return std_dev_clear_with_callback(di, (std_dev_clear_callback)clear_helper);
4f7fdcdd SA	249	}
	250
	251	static int dev_open(struct sr_dev_inst *sdi)
	252	{
	253	struct dev_context *devc;
	254	int ret = SR_OK;
	255
	256	devc = sdi->priv;
	257
07a91752 LPC	258	devc->ftdic = ftdi_new();
	259	if (!devc->ftdic)
	260	return SR_ERR;
	261
634d7299	262	ret = ftdi_usb_open_string(devc->ftdic, sdi->connection_id);
4f7fdcdd SA	263	if (ret < 0) {
	264	/* Log errors, except for -3 ("device not found"). */
	265	if (ret != -3)
	266	sr_err("Failed to open device (%d): %s", ret,
	267	ftdi_get_error_string(devc->ftdic));
07a91752	268	goto err_ftdi_free;
4f7fdcdd SA	269	}
4f7fdcdd SA	270
4f7fdcdd SA	271	ret = ftdi_usb_purge_buffers(devc->ftdic);
	272	if (ret < 0) {
	273	sr_err("Failed to purge FTDI RX/TX buffers (%d): %s.",
	274	ret, ftdi_get_error_string(devc->ftdic));
	275	goto err_dev_open_close_ftdic;
	276	}
4f7fdcdd	277
4f7fdcdd SA	278	ret = ftdi_set_bitmode(devc->ftdic, 0x00, BITMODE_RESET);
	279	if (ret < 0) {
	280	sr_err("Failed to reset the FTDI chip bitmode (%d): %s.",
	281	ret, ftdi_get_error_string(devc->ftdic));
	282	goto err_dev_open_close_ftdic;
	283	}
4f7fdcdd SA	284
	285	ret = ftdi_set_bitmode(devc->ftdic, 0x00, BITMODE_BITBANG);
	286	if (ret < 0) {
	287	sr_err("Failed to put FTDI chip into bitbang mode (%d): %s.",
	288	ret, ftdi_get_error_string(devc->ftdic));
	289	goto err_dev_open_close_ftdic;
	290	}
4f7fdcdd	291
4f7fdcdd	292	return SR_OK;
7e463623	293
4f7fdcdd SA	294	err_dev_open_close_ftdic:
4f7fdcdd SA	295	ftdi_usb_close(devc->ftdic);
7e463623	296
07a91752 LPC	297	err_ftdi_free:
07a91752 LPC	298	ftdi_free(devc->ftdic);
7e463623	299
4f7fdcdd SA	300	return SR_ERR;
	301	}
	302
	303	static int dev_close(struct sr_dev_inst *sdi)
	304	{
	305	struct dev_context *devc;
	306
	307	devc = sdi->priv;
	308
f1ba6b4b UH	309	if (!devc->ftdic)
f1ba6b4b UH	310	return SR_ERR_BUG;
4f7fdcdd	311
f1ba6b4b UH	312	ftdi_usb_close(devc->ftdic);
	313	ftdi_free(devc->ftdic);
	314	devc->ftdic = NULL;
4f7fdcdd SA	315
	316	return SR_OK;
	317	}
	318
4f7fdcdd SA	319	static int config_get(uint32_t key, GVariant **data,
	320	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
	321	{
4f7fdcdd	322	struct dev_context *devc;
cee6d3fa	323	struct sr_usb_dev_inst *usb;
4f7fdcdd SA	324
	325	(void)cg;
	326
	327	devc = sdi->priv;
	328
4f7fdcdd SA	329	switch (key) {
	330	case SR_CONF_SAMPLERATE:
	331	*data = g_variant_new_uint64(devc->cur_samplerate);
	332	break;
cee6d3fa SA	333	case SR_CONF_CONN:
	334	if (!sdi \|\| !sdi->conn)
	335	return SR_ERR_ARG;
	336	usb = sdi->conn;
95c1fe62	337	*data = g_variant_new_printf("%d.%d", usb->bus, usb->address);
cee6d3fa	338	break;
4f7fdcdd SA	339	default:
	340	return SR_ERR_NA;
	341	}
	342
a9010323	343	return SR_OK;
4f7fdcdd SA	344	}
4f7fdcdd SA	345
4f7fdcdd SA	346	static int config_set(uint32_t key, GVariant *data,
	347	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
	348	{
4f7fdcdd SA	349	struct dev_context *devc;
	350	uint64_t value;
	351
	352	(void)cg;
	353
4f7fdcdd SA	354	devc = sdi->priv;
4f7fdcdd SA	355
4f7fdcdd SA	356	switch (key) {
	357	case SR_CONF_LIMIT_MSEC:
	358	value = g_variant_get_uint64(data);
	359	/* TODO: Implement. */
f6051b9e	360	(void)value;
a9010323	361	return SR_ERR_NA;
4f7fdcdd	362	case SR_CONF_LIMIT_SAMPLES:
4f7fdcdd SA	363	devc->limit_samples = g_variant_get_uint64(data);
	364	break;
	365	case SR_CONF_SAMPLERATE:
	366	value = g_variant_get_uint64(data);
	367	if (value < 3600)
	368	return SR_ERR_SAMPLERATE;
	369	devc->cur_samplerate = value;
f2273382	370	return ftdi_la_set_samplerate(devc);
4f7fdcdd	371	default:
a9010323	372	return SR_ERR_NA;
4f7fdcdd SA	373	}
4f7fdcdd SA	374
a9010323	375	return SR_OK;
4f7fdcdd SA	376	}
	377
	378	static int config_list(uint32_t key, GVariant **data,
	379	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
	380	{
4f7fdcdd SA	381	switch (key) {
4f7fdcdd SA	382	case SR_CONF_SCAN_OPTIONS:
4f7fdcdd	383	case SR_CONF_DEVICE_OPTIONS:
05199c0a	384	return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
4f7fdcdd	385	case SR_CONF_SAMPLERATE:
53012da6	386	*data = std_gvar_samplerates_steps(ARRAY_AND_SIZE(samplerates));
4f7fdcdd SA	387	break;
	388	default:
	389	return SR_ERR_NA;
	390	}
	391
a9010323	392	return SR_OK;
4f7fdcdd SA	393	}
4f7fdcdd SA	394
695dc859	395	static int dev_acquisition_start(const struct sr_dev_inst *sdi)
4f7fdcdd SA	396	{
	397	struct dev_context *devc;
	398
4f7fdcdd SA	399	devc = sdi->priv;
4f7fdcdd SA	400
4f7fdcdd SA	401	if (!devc->ftdic)
	402	return SR_ERR_BUG;
	403
	404	ftdi_set_bitmode(devc->ftdic, 0, BITMODE_BITBANG);
	405
4f7fdcdd SA	406	/* Properly reset internal variables before every new acquisition. */
	407	devc->samples_sent = 0;
	408	devc->bytes_received = 0;
	409
bee2b016	410	std_session_send_df_header(sdi);
4f7fdcdd SA	411
	412	/* Hook up a dummy handler to receive data from the device. */
	413	sr_session_source_add(sdi->session, -1, G_IO_IN, 0,
f2273382	414	ftdi_la_receive_data, (void *)sdi);
4f7fdcdd SA	415
	416	return SR_OK;
	417	}
	418
695dc859	419	static int dev_acquisition_stop(struct sr_dev_inst *sdi)
4f7fdcdd	420	{
4f7fdcdd SA	421	sr_session_source_remove(sdi->session, -1);
4f7fdcdd SA	422
bee2b016	423	std_session_send_df_end(sdi);
4f7fdcdd SA	424
	425	return SR_OK;
	426	}
	427
dd5c48a6	428	static struct sr_dev_driver ftdi_la_driver_info = {
f2273382 UH	429	.name = "ftdi-la",
f2273382 UH	430	.longname = "FTDI LA",
4f7fdcdd	431	.api_version = 1,
c2fdcc25	432	.init = std_init,
700d6b64	433	.cleanup = std_cleanup,
4f7fdcdd	434	.scan = scan,
c01bf34c	435	.dev_list = std_dev_list,
4f7fdcdd SA	436	.dev_clear = dev_clear,
	437	.config_get = config_get,
	438	.config_set = config_set,
	439	.config_list = config_list,
	440	.dev_open = dev_open,
	441	.dev_close = dev_close,
	442	.dev_acquisition_start = dev_acquisition_start,
	443	.dev_acquisition_stop = dev_acquisition_stop,
	444	.context = NULL,
	445	};
dd5c48a6	446	SR_REGISTER_DEV_DRIVER(ftdi_la_driver_info);