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 ft232r_desc = {
65 "TXD", "RXD", "RTS#", "CTS#", "DTR#", "DSR#", "DCD#", "RI#",
70 static const struct ftdi_chip_desc *chip_descs[] = {
75 static void scan_device(struct ftdi_context *ftdic,
76 struct libusb_device *dev, GSList **devices)
78 struct libusb_device_descriptor usb_desc;
79 const struct ftdi_chip_desc *desc;
80 struct dev_context *devc;
81 char *vendor, *model, *serial_num;
82 struct sr_dev_inst *sdi;
85 libusb_get_device_descriptor(dev, &usb_desc);
88 for (unsigned long i = 0; i < ARRAY_SIZE(chip_descs); i++) {
90 if (desc->vendor == usb_desc.idVendor &&
91 desc->product == usb_desc.idProduct)
96 sr_spew("Unsupported FTDI device 0x%4x:0x%4x.",
97 usb_desc.idVendor, usb_desc.idProduct);
101 devc = g_malloc0(sizeof(struct dev_context));
103 /* Allocate memory for the incoming data. */
104 devc->data_buf = g_malloc0(DATA_BUF_SIZE);
108 vendor = g_malloc(32);
109 model = g_malloc(32);
110 serial_num = g_malloc(32);
111 rv = ftdi_usb_get_strings(ftdic, dev, vendor, 32,
112 model, 32, serial_num, 32);
117 sr_dbg("The device lacks a serial number.");
122 sr_err("Failed to get the FTDI strings: %d", rv);
123 goto err_free_strings;
125 sr_dbg("Found an FTDI device: %s.", model);
127 sdi = g_malloc0(sizeof(struct sr_dev_inst));
128 sdi->status = SR_ST_INACTIVE;
129 sdi->vendor = vendor;
131 sdi->serial_num = serial_num;
133 sdi->connection_id = g_strdup_printf("d:%u/%u",
134 libusb_get_bus_number(dev), libusb_get_device_address(dev));
136 for (char *const *chan = &(desc->channel_names[0]); *chan; chan++)
137 sr_channel_new(sdi, chan - &(desc->channel_names[0]),
138 SR_CHANNEL_LOGIC, TRUE, *chan);
140 *devices = g_slist_append(*devices, sdi);
147 g_free(devc->data_buf);
151 static GSList *scan_all(struct ftdi_context *ftdic, GSList *options)
154 struct ftdi_device_list *devlist = 0;
155 struct ftdi_device_list *curdev;
162 ret = ftdi_usb_find_all(ftdic, &devlist, 0, 0);
164 sr_err("Failed to list devices (%d): %s", ret,
165 ftdi_get_error_string(ftdic));
171 scan_device(ftdic, curdev->dev, &devices);
172 curdev = curdev->next;
175 ftdi_list_free(&devlist);
180 static GSList *scan(struct sr_dev_driver *di, GSList *options)
182 struct ftdi_context *ftdic;
183 struct sr_config *src;
184 struct sr_usb_dev_inst *usb;
186 GSList *l, *conn_devices;
188 struct drv_context *drvc;
189 libusb_device **devlist;
194 for (l = options; l; l = l->next) {
196 if (src->key == SR_CONF_CONN) {
197 conn = g_variant_get_string(src->data, NULL);
204 sr_err("Failed to initialize libftdi.");
210 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
211 for (i = 0; devlist[i]; i++) {
212 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
213 for (l = conn_devices; l; l = l->next) {
215 if (usb->bus == libusb_get_bus_number(devlist[i])
216 && usb->address == libusb_get_device_address(devlist[i])) {
217 scan_device(ftdic, devlist[i], &devices);
221 libusb_free_device_list(devlist, 1);
223 devices = scan_all(ftdic, options);
227 return std_scan_complete(di, devices);
230 static void clear_helper(struct dev_context *devc)
232 g_free(devc->data_buf);
235 static int dev_clear(const struct sr_dev_driver *di)
237 return std_dev_clear_with_callback(di, (std_dev_clear_callback)clear_helper);
240 static int dev_open(struct sr_dev_inst *sdi)
242 struct dev_context *devc;
247 devc->ftdic = ftdi_new();
251 ret = ftdi_usb_open_string(devc->ftdic, sdi->connection_id);
253 /* Log errors, except for -3 ("device not found"). */
255 sr_err("Failed to open device (%d): %s", ret,
256 ftdi_get_error_string(devc->ftdic));
260 ret = ftdi_usb_purge_buffers(devc->ftdic);
262 sr_err("Failed to purge FTDI RX/TX buffers (%d): %s.",
263 ret, ftdi_get_error_string(devc->ftdic));
264 goto err_dev_open_close_ftdic;
267 ret = ftdi_set_bitmode(devc->ftdic, 0x00, BITMODE_RESET);
269 sr_err("Failed to reset the FTDI chip bitmode (%d): %s.",
270 ret, ftdi_get_error_string(devc->ftdic));
271 goto err_dev_open_close_ftdic;
274 ret = ftdi_set_bitmode(devc->ftdic, 0x00, BITMODE_BITBANG);
276 sr_err("Failed to put FTDI chip into bitbang mode (%d): %s.",
277 ret, ftdi_get_error_string(devc->ftdic));
278 goto err_dev_open_close_ftdic;
283 err_dev_open_close_ftdic:
284 ftdi_usb_close(devc->ftdic);
287 ftdi_free(devc->ftdic);
292 static int dev_close(struct sr_dev_inst *sdi)
294 struct dev_context *devc;
301 ftdi_usb_close(devc->ftdic);
302 ftdi_free(devc->ftdic);
308 static int config_get(uint32_t key, GVariant **data,
309 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
311 struct dev_context *devc;
312 struct sr_usb_dev_inst *usb;
319 case SR_CONF_SAMPLERATE:
320 *data = g_variant_new_uint64(devc->cur_samplerate);
323 if (!sdi || !sdi->conn)
326 *data = g_variant_new_printf("%d.%d", usb->bus, usb->address);
335 static int config_set(uint32_t key, GVariant *data,
336 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
338 struct dev_context *devc;
346 case SR_CONF_LIMIT_MSEC:
347 value = g_variant_get_uint64(data);
348 /* TODO: Implement. */
351 case SR_CONF_LIMIT_SAMPLES:
352 devc->limit_samples = g_variant_get_uint64(data);
354 case SR_CONF_SAMPLERATE:
355 value = g_variant_get_uint64(data);
357 return SR_ERR_SAMPLERATE;
358 devc->cur_samplerate = value;
359 return ftdi_la_set_samplerate(devc);
367 static int config_list(uint32_t key, GVariant **data,
368 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
371 case SR_CONF_SCAN_OPTIONS:
372 case SR_CONF_DEVICE_OPTIONS:
373 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
374 case SR_CONF_SAMPLERATE:
375 *data = std_gvar_samplerates_steps(ARRAY_AND_SIZE(samplerates));
384 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
386 struct dev_context *devc;
393 ftdi_set_bitmode(devc->ftdic, 0, BITMODE_BITBANG);
395 /* Properly reset internal variables before every new acquisition. */
396 devc->samples_sent = 0;
397 devc->bytes_received = 0;
399 std_session_send_df_header(sdi);
401 /* Hook up a dummy handler to receive data from the device. */
402 sr_session_source_add(sdi->session, -1, G_IO_IN, 0,
403 ftdi_la_receive_data, (void *)sdi);
408 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
410 sr_session_source_remove(sdi->session, -1);
412 std_session_send_df_end(sdi);
417 static struct sr_dev_driver ftdi_la_driver_info = {
419 .longname = "FTDI LA",
422 .cleanup = std_cleanup,
424 .dev_list = std_dev_list,
425 .dev_clear = dev_clear,
426 .config_get = config_get,
427 .config_set = config_set,
428 .config_list = config_list,
429 .dev_open = dev_open,
430 .dev_close = dev_close,
431 .dev_acquisition_start = dev_acquisition_start,
432 .dev_acquisition_stop = dev_acquisition_stop,
435 SR_REGISTER_DEV_DRIVER(ftdi_la_driver_info);