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 drvopts[] = {
32 SR_CONF_LOGIC_ANALYZER,
35 static const uint32_t devopts[] = {
37 SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
38 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
39 SR_CONF_CONN | SR_CONF_GET,
42 static const uint64_t samplerates[] = {
48 static const struct ftdi_chip_desc ft2232h_desc = {
53 "ADBUS0", "ADBUS1", "ADBUS2", "ADBUS3",
54 "ADBUS4", "ADBUS5", "ADBUS6", "ADBUS7",
55 /* TODO: BDBUS[0..7] channels. */
60 static const struct ftdi_chip_desc ft2232h_tumpa_desc = {
64 /* 20 pin JTAG header */
66 "TCK", "TDI", "TDO", "TMS", "RST", "nTRST", "DBGRQ", "RTCK",
71 static const struct ftdi_chip_desc ft4232h_desc = {
76 "ADBUS0", "ADBUS1", "ADBUS2", "ADBUS3", "ADBUS4", "ADBUS5", "ADBUS6", "ADBUS7",
77 /* TODO: BDBUS[0..7], CDBUS[0..7], DDBUS[0..7] channels. */
82 static const struct ftdi_chip_desc ft232r_desc = {
87 "TXD", "RXD", "RTS#", "CTS#", "DTR#", "DSR#", "DCD#", "RI#",
92 static const struct ftdi_chip_desc ft232h_desc = {
97 "ADBUS0", "ADBUS1", "ADBUS2", "ADBUS3", "ADBUS4", "ADBUS5", "ADBUS6", "ADBUS7",
102 static const struct ftdi_chip_desc *chip_descs[] = {
111 static void scan_device(struct ftdi_context *ftdic,
112 struct libusb_device *dev, GSList **devices)
114 static const int usb_str_maxlen = 32;
116 struct libusb_device_descriptor usb_desc;
117 const struct ftdi_chip_desc *desc;
118 struct dev_context *devc;
119 char *vendor, *model, *serial_num;
120 struct sr_dev_inst *sdi;
123 libusb_get_device_descriptor(dev, &usb_desc);
126 for (unsigned long i = 0; i < ARRAY_SIZE(chip_descs); i++) {
127 desc = chip_descs[i];
130 if (desc->vendor == usb_desc.idVendor &&
131 desc->product == usb_desc.idProduct)
136 sr_spew("Unsupported FTDI device 0x%04x:0x%04x.",
137 usb_desc.idVendor, usb_desc.idProduct);
141 devc = g_malloc0(sizeof(struct dev_context));
143 /* Allocate memory for the incoming data. */
144 devc->data_buf = g_malloc0(DATA_BUF_SIZE);
148 vendor = g_malloc(usb_str_maxlen);
149 model = g_malloc(usb_str_maxlen);
150 serial_num = g_malloc(usb_str_maxlen);
151 rv = ftdi_usb_get_strings(ftdic, dev, vendor, usb_str_maxlen,
152 model, usb_str_maxlen, serial_num, usb_str_maxlen);
156 /* ftdi_usb_get_strings() fails on first miss, hence fall through. */
158 sr_dbg("The device lacks a manufacturer descriptor.");
159 g_snprintf(vendor, usb_str_maxlen, "Generic");
162 sr_dbg("The device lacks a product descriptor.");
163 switch (usb_desc.idProduct) {
165 g_snprintf(model, usb_str_maxlen, "FT232R");
168 g_snprintf(model, usb_str_maxlen, "FT2232H");
171 g_snprintf(model, usb_str_maxlen, "FT4232H");
174 g_snprintf(model, usb_str_maxlen, "FT232H");
177 g_snprintf(model, usb_str_maxlen, "FT2232H-TUMPA");
180 g_snprintf(model, usb_str_maxlen, "Unknown");
185 sr_dbg("The device lacks a serial number.");
190 sr_err("Failed to get the FTDI strings: %d", rv);
191 goto err_free_strings;
193 sr_dbg("Found an FTDI device: %s.", model);
195 sdi = g_malloc0(sizeof(struct sr_dev_inst));
196 sdi->status = SR_ST_INACTIVE;
197 sdi->vendor = vendor;
199 sdi->serial_num = serial_num;
201 sdi->connection_id = g_strdup_printf("d:%u/%u",
202 libusb_get_bus_number(dev), libusb_get_device_address(dev));
204 for (char *const *chan = &(desc->channel_names[0]); *chan; chan++)
205 sr_channel_new(sdi, chan - &(desc->channel_names[0]),
206 SR_CHANNEL_LOGIC, TRUE, *chan);
208 *devices = g_slist_append(*devices, sdi);
215 g_free(devc->data_buf);
219 static GSList *scan_all(struct ftdi_context *ftdic, GSList *options)
222 struct ftdi_device_list *devlist = 0;
223 struct ftdi_device_list *curdev;
230 ret = ftdi_usb_find_all(ftdic, &devlist, 0, 0);
232 sr_err("Failed to list devices (%d): %s", ret,
233 ftdi_get_error_string(ftdic));
239 scan_device(ftdic, curdev->dev, &devices);
240 curdev = curdev->next;
243 ftdi_list_free(&devlist);
248 static GSList *scan(struct sr_dev_driver *di, GSList *options)
250 struct ftdi_context *ftdic;
251 struct sr_config *src;
252 struct sr_usb_dev_inst *usb;
254 GSList *l, *conn_devices;
256 struct drv_context *drvc;
257 libusb_device **devlist;
262 for (l = options; l; l = l->next) {
264 if (src->key == SR_CONF_CONN) {
265 conn = g_variant_get_string(src->data, NULL);
272 sr_err("Failed to initialize libftdi.");
278 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
279 for (i = 0; devlist[i]; i++) {
280 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
281 for (l = conn_devices; l; l = l->next) {
283 if (usb->bus == libusb_get_bus_number(devlist[i])
284 && usb->address == libusb_get_device_address(devlist[i])) {
285 scan_device(ftdic, devlist[i], &devices);
289 libusb_free_device_list(devlist, 1);
291 devices = scan_all(ftdic, options);
295 return std_scan_complete(di, devices);
298 static void clear_helper(struct dev_context *devc)
300 g_free(devc->data_buf);
303 static int dev_clear(const struct sr_dev_driver *di)
305 return std_dev_clear_with_callback(di, (std_dev_clear_callback)clear_helper);
308 static int dev_open(struct sr_dev_inst *sdi)
310 struct dev_context *devc;
315 devc->ftdic = ftdi_new();
319 ret = ftdi_usb_open_string(devc->ftdic, sdi->connection_id);
321 /* Log errors, except for -3 ("device not found"). */
323 sr_err("Failed to open device (%d): %s", ret,
324 ftdi_get_error_string(devc->ftdic));
328 ret = ftdi_usb_purge_buffers(devc->ftdic);
330 sr_err("Failed to purge FTDI RX/TX buffers (%d): %s.",
331 ret, ftdi_get_error_string(devc->ftdic));
332 goto err_dev_open_close_ftdic;
335 ret = ftdi_set_bitmode(devc->ftdic, 0x00, BITMODE_RESET);
337 sr_err("Failed to reset the FTDI chip bitmode (%d): %s.",
338 ret, ftdi_get_error_string(devc->ftdic));
339 goto err_dev_open_close_ftdic;
342 ret = ftdi_set_bitmode(devc->ftdic, 0x00, BITMODE_BITBANG);
344 sr_err("Failed to put FTDI chip into bitbang mode (%d): %s.",
345 ret, ftdi_get_error_string(devc->ftdic));
346 goto err_dev_open_close_ftdic;
351 err_dev_open_close_ftdic:
352 ftdi_usb_close(devc->ftdic);
355 ftdi_free(devc->ftdic);
360 static int dev_close(struct sr_dev_inst *sdi)
362 struct dev_context *devc;
369 ftdi_usb_close(devc->ftdic);
370 ftdi_free(devc->ftdic);
376 static int config_get(uint32_t key, GVariant **data,
377 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
379 struct dev_context *devc;
380 struct sr_usb_dev_inst *usb;
387 case SR_CONF_SAMPLERATE:
388 *data = g_variant_new_uint64(devc->cur_samplerate);
391 if (!sdi || !sdi->conn)
394 *data = g_variant_new_printf("%d.%d", usb->bus, usb->address);
403 static int config_set(uint32_t key, GVariant *data,
404 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
406 struct dev_context *devc;
414 case SR_CONF_LIMIT_MSEC:
415 value = g_variant_get_uint64(data);
416 /* TODO: Implement. */
419 case SR_CONF_LIMIT_SAMPLES:
420 devc->limit_samples = g_variant_get_uint64(data);
422 case SR_CONF_SAMPLERATE:
423 value = g_variant_get_uint64(data);
425 return SR_ERR_SAMPLERATE;
426 devc->cur_samplerate = value;
427 return ftdi_la_set_samplerate(devc);
435 static int config_list(uint32_t key, GVariant **data,
436 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
439 case SR_CONF_SCAN_OPTIONS:
440 case SR_CONF_DEVICE_OPTIONS:
441 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
442 case SR_CONF_SAMPLERATE:
443 *data = std_gvar_samplerates_steps(ARRAY_AND_SIZE(samplerates));
452 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
454 struct dev_context *devc;
461 ftdi_set_bitmode(devc->ftdic, 0, BITMODE_BITBANG);
463 /* Properly reset internal variables before every new acquisition. */
464 devc->samples_sent = 0;
465 devc->bytes_received = 0;
467 std_session_send_df_header(sdi);
469 /* Hook up a dummy handler to receive data from the device. */
470 sr_session_source_add(sdi->session, -1, G_IO_IN, 0,
471 ftdi_la_receive_data, (void *)sdi);
476 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
478 sr_session_source_remove(sdi->session, -1);
480 std_session_send_df_end(sdi);
485 static struct sr_dev_driver ftdi_la_driver_info = {
487 .longname = "FTDI LA",
490 .cleanup = std_cleanup,
492 .dev_list = std_dev_list,
493 .dev_clear = dev_clear,
494 .config_get = config_get,
495 .config_set = config_set,
496 .config_list = config_list,
497 .dev_open = dev_open,
498 .dev_close = dev_close,
499 .dev_acquisition_start = dev_acquisition_start,
500 .dev_acquisition_stop = dev_acquisition_stop,
503 SR_REGISTER_DEV_DRIVER(ftdi_la_driver_info);