2 * This file is part of the libsigrok project.
4 * Copyright (C) 2015 Sergey Alirzaev <zl29ah@gmail.com>
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.
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.
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/>.
23 #include <libsigrok/libsigrok.h>
24 #include "libsigrok-internal.h"
27 static const uint32_t scanopts[] = {
31 static const uint32_t devopts[] = {
32 SR_CONF_LOGIC_ANALYZER,
34 SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
35 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
36 SR_CONF_CONN | SR_CONF_GET,
39 static const uint64_t samplerates[] = {
45 static const struct ftdi_chip_desc ft2232h_desc = {
58 /* TODO: BDBUS[0..7] channels. */
63 static const struct ftdi_chip_desc ft232r_desc = {
80 static const struct ftdi_chip_desc *chip_descs[] = {
85 static void scan_device(struct ftdi_context *ftdic,
86 struct libusb_device *dev, GSList **devices)
88 struct libusb_device_descriptor usb_desc;
89 const struct ftdi_chip_desc *desc;
90 struct dev_context *devc;
91 char *vendor, *model, *serial_num;
92 struct sr_dev_inst *sdi;
95 libusb_get_device_descriptor(dev, &usb_desc);
98 for (unsigned long i = 0; i < ARRAY_SIZE(chip_descs); i++) {
100 if (desc->vendor == usb_desc.idVendor &&
101 desc->product == usb_desc.idProduct)
106 sr_spew("Unsupported FTDI device 0x%4x:0x%4x.",
107 usb_desc.idVendor, usb_desc.idProduct);
111 /* Allocate memory for our private device context. */
112 devc = g_malloc0(sizeof(struct dev_context));
114 /* Allocate memory for the incoming data. */
115 devc->data_buf = g_malloc0(DATA_BUF_SIZE);
119 vendor = g_malloc(32);
120 model = g_malloc(32);
121 serial_num = g_malloc(32);
122 rv = ftdi_usb_get_strings(ftdic, dev, vendor, 32,
123 model, 32, serial_num, 32);
128 sr_dbg("The device lacks a serial number.");
133 sr_err("Failed to get the FTDI strings: %d", rv);
134 goto err_free_strings;
136 sr_dbg("Found an FTDI device: %s.", model);
138 /* Register the device with libsigrok. */
139 sdi = g_malloc0(sizeof(struct sr_dev_inst));
140 sdi->status = SR_ST_INACTIVE;
141 sdi->vendor = vendor;
143 sdi->serial_num = serial_num;
145 sdi->connection_id = g_strdup_printf("d:%u/%u",
146 libusb_get_bus_number(dev), libusb_get_device_address(dev));
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);
152 *devices = g_slist_append(*devices, sdi);
159 g_free(devc->data_buf);
163 static GSList *scan_all(struct ftdi_context *ftdic, GSList *options)
166 struct ftdi_device_list *devlist = 0;
167 struct ftdi_device_list *curdev;
174 ret = ftdi_usb_find_all(ftdic, &devlist, 0, 0);
176 sr_err("Failed to list devices (%d): %s", ret,
177 ftdi_get_error_string(ftdic));
181 sr_dbg("Number of FTDI devices found: %d", ret);
185 scan_device(ftdic, curdev->dev, &devices);
186 curdev = curdev->next;
189 ftdi_list_free(&devlist);
194 static GSList *scan(struct sr_dev_driver *di, GSList *options)
196 struct ftdi_context *ftdic;
197 struct sr_config *src;
198 struct sr_usb_dev_inst *usb;
200 GSList *l, *conn_devices;
202 struct drv_context *drvc;
203 libusb_device **devlist;
208 for (l = options; l; l = l->next) {
210 if (src->key == SR_CONF_CONN) {
211 conn = g_variant_get_string(src->data, NULL);
216 /* Allocate memory for the FTDI context (ftdic) and initialize it. */
219 sr_err("Failed to initialize libftdi.");
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) {
230 if (usb->bus == libusb_get_bus_number(devlist[i])
231 && usb->address == libusb_get_device_address(devlist[i])) {
232 scan_device(ftdic, devlist[i], &devices);
236 libusb_free_device_list(devlist, 1);
238 devices = scan_all(ftdic, options);
242 return std_scan_complete(di, devices);
245 static void clear_helper(void *priv)
247 struct dev_context *devc;
250 g_free(devc->data_buf);
254 static int dev_clear(const struct sr_dev_driver *di)
256 return std_dev_clear(di, clear_helper);
259 static int dev_open(struct sr_dev_inst *sdi)
261 struct dev_context *devc;
266 devc->ftdic = ftdi_new();
270 ret = ftdi_usb_open_string(devc->ftdic, sdi->connection_id);
272 /* Log errors, except for -3 ("device not found"). */
274 sr_err("Failed to open device (%d): %s", ret,
275 ftdi_get_error_string(devc->ftdic));
279 /* Purge RX/TX buffers in the FTDI chip. */
280 ret = ftdi_usb_purge_buffers(devc->ftdic);
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;
286 sr_dbg("FTDI chip buffers purged successfully.");
288 /* Reset the FTDI bitmode. */
289 ret = ftdi_set_bitmode(devc->ftdic, 0x00, BITMODE_RESET);
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;
295 sr_dbg("FTDI chip bitmode reset successfully.");
297 ret = ftdi_set_bitmode(devc->ftdic, 0x00, BITMODE_BITBANG);
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;
303 sr_dbg("FTDI chip bitbang mode entered successfully.");
305 sdi->status = SR_ST_ACTIVE;
308 err_dev_open_close_ftdic:
309 ftdi_usb_close(devc->ftdic);
311 ftdi_free(devc->ftdic);
315 static int dev_close(struct sr_dev_inst *sdi)
317 struct dev_context *devc;
322 ftdi_usb_close(devc->ftdic);
323 ftdi_free(devc->ftdic);
327 sdi->status = SR_ST_INACTIVE;
332 static int config_get(uint32_t key, GVariant **data,
333 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
336 struct dev_context *devc;
337 struct sr_usb_dev_inst *usb;
346 case SR_CONF_SAMPLERATE:
347 *data = g_variant_new_uint64(devc->cur_samplerate);
350 if (!sdi || !sdi->conn)
353 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
354 *data = g_variant_new_string(str);
363 static int config_set(uint32_t key, GVariant *data,
364 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
367 struct dev_context *devc;
372 if (sdi->status != SR_ST_ACTIVE)
373 return SR_ERR_DEV_CLOSED;
379 case SR_CONF_LIMIT_MSEC:
380 value = g_variant_get_uint64(data);
381 /* TODO: Implement. */
384 case SR_CONF_LIMIT_SAMPLES:
385 if (g_variant_get_uint64(data) == 0)
387 devc->limit_samples = g_variant_get_uint64(data);
389 case SR_CONF_SAMPLERATE:
390 value = g_variant_get_uint64(data);
392 return SR_ERR_SAMPLERATE;
393 devc->cur_samplerate = value;
394 return ftdi_la_set_samplerate(devc);
402 static int config_list(uint32_t key, GVariant **data,
403 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
414 case SR_CONF_SCAN_OPTIONS:
415 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
416 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
418 case SR_CONF_DEVICE_OPTIONS:
419 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
420 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
422 case SR_CONF_SAMPLERATE:
423 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
424 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
425 samplerates, ARRAY_SIZE(samplerates), sizeof(uint64_t));
426 g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar);
427 *data = g_variant_builder_end(&gvb);
436 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
438 struct dev_context *devc;
442 if (sdi->status != SR_ST_ACTIVE)
443 return SR_ERR_DEV_CLOSED;
448 ftdi_set_bitmode(devc->ftdic, 0, BITMODE_BITBANG);
450 /* Properly reset internal variables before every new acquisition. */
451 devc->samples_sent = 0;
452 devc->bytes_received = 0;
454 std_session_send_df_header(sdi);
456 /* Hook up a dummy handler to receive data from the device. */
457 sr_session_source_add(sdi->session, -1, G_IO_IN, 0,
458 ftdi_la_receive_data, (void *)sdi);
463 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
465 if (sdi->status != SR_ST_ACTIVE)
466 return SR_ERR_DEV_CLOSED;
468 sr_dbg("Stopping acquisition.");
469 sr_session_source_remove(sdi->session, -1);
471 std_session_send_df_end(sdi);
476 static struct sr_dev_driver ftdi_la_driver_info = {
478 .longname = "FTDI LA",
481 .cleanup = std_cleanup,
483 .dev_list = std_dev_list,
484 .dev_clear = dev_clear,
485 .config_get = config_get,
486 .config_set = config_set,
487 .config_list = config_list,
488 .dev_open = dev_open,
489 .dev_close = dev_close,
490 .dev_acquisition_start = dev_acquisition_start,
491 .dev_acquisition_stop = dev_acquisition_stop,
494 SR_REGISTER_DEV_DRIVER(ftdi_la_driver_info);