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 = {
61 /* TODO: BDBUS[0..7] channels. */
66 static const struct ftdi_chip_desc ft232r_desc = {
83 static const struct ftdi_chip_desc *chip_descs[] = {
88 static void scan_device(struct ftdi_context *ftdic,
89 struct libusb_device *dev, GSList **devices)
91 struct libusb_device_descriptor usb_desc;
92 const struct ftdi_chip_desc *desc;
93 struct dev_context *devc;
94 char *vendor, *model, *serial_num;
95 struct sr_dev_inst *sdi;
98 libusb_get_device_descriptor(dev, &usb_desc);
101 for (unsigned long i = 0; i < ARRAY_SIZE(chip_descs); i++) {
102 desc = chip_descs[i];
103 if (desc->vendor == usb_desc.idVendor &&
104 desc->product == usb_desc.idProduct)
109 sr_spew("Unsupported FTDI device 0x%4x:0x%4x.",
110 usb_desc.idVendor, usb_desc.idProduct);
114 devc = g_malloc0(sizeof(struct dev_context));
116 /* Allocate memory for the incoming data. */
117 devc->data_buf = g_malloc0(DATA_BUF_SIZE);
121 vendor = g_malloc(32);
122 model = g_malloc(32);
123 serial_num = g_malloc(32);
124 rv = ftdi_usb_get_strings(ftdic, dev, vendor, 32,
125 model, 32, serial_num, 32);
130 sr_dbg("The device lacks a serial number.");
135 sr_err("Failed to get the FTDI strings: %d", rv);
136 goto err_free_strings;
138 sr_dbg("Found an FTDI device: %s.", model);
140 sdi = g_malloc0(sizeof(struct sr_dev_inst));
141 sdi->status = SR_ST_INACTIVE;
142 sdi->vendor = vendor;
144 sdi->serial_num = serial_num;
146 sdi->connection_id = g_strdup_printf("d:%u/%u",
147 libusb_get_bus_number(dev), libusb_get_device_address(dev));
149 for (char *const *chan = &(desc->channel_names[0]); *chan; chan++)
150 sr_channel_new(sdi, chan - &(desc->channel_names[0]),
151 SR_CHANNEL_LOGIC, TRUE, *chan);
153 *devices = g_slist_append(*devices, sdi);
160 g_free(devc->data_buf);
164 static GSList *scan_all(struct ftdi_context *ftdic, GSList *options)
167 struct ftdi_device_list *devlist = 0;
168 struct ftdi_device_list *curdev;
175 ret = ftdi_usb_find_all(ftdic, &devlist, 0, 0);
177 sr_err("Failed to list devices (%d): %s", ret,
178 ftdi_get_error_string(ftdic));
184 scan_device(ftdic, curdev->dev, &devices);
185 curdev = curdev->next;
188 ftdi_list_free(&devlist);
193 static GSList *scan(struct sr_dev_driver *di, GSList *options)
195 struct ftdi_context *ftdic;
196 struct sr_config *src;
197 struct sr_usb_dev_inst *usb;
199 GSList *l, *conn_devices;
201 struct drv_context *drvc;
202 libusb_device **devlist;
207 for (l = options; l; l = l->next) {
209 if (src->key == SR_CONF_CONN) {
210 conn = g_variant_get_string(src->data, NULL);
217 sr_err("Failed to initialize libftdi.");
223 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
224 for (i = 0; devlist[i]; i++) {
225 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
226 for (l = conn_devices; l; l = l->next) {
228 if (usb->bus == libusb_get_bus_number(devlist[i])
229 && usb->address == libusb_get_device_address(devlist[i])) {
230 scan_device(ftdic, devlist[i], &devices);
234 libusb_free_device_list(devlist, 1);
236 devices = scan_all(ftdic, options);
240 return std_scan_complete(di, devices);
243 static void clear_helper(struct dev_context *devc)
245 g_free(devc->data_buf);
248 static int dev_clear(const struct sr_dev_driver *di)
250 return std_dev_clear_with_callback(di, (std_dev_clear_callback)clear_helper);
253 static int dev_open(struct sr_dev_inst *sdi)
255 struct dev_context *devc;
260 devc->ftdic = ftdi_new();
264 ret = ftdi_usb_open_string(devc->ftdic, sdi->connection_id);
266 /* Log errors, except for -3 ("device not found"). */
268 sr_err("Failed to open device (%d): %s", ret,
269 ftdi_get_error_string(devc->ftdic));
273 ret = ftdi_usb_purge_buffers(devc->ftdic);
275 sr_err("Failed to purge FTDI RX/TX buffers (%d): %s.",
276 ret, ftdi_get_error_string(devc->ftdic));
277 goto err_dev_open_close_ftdic;
280 ret = ftdi_set_bitmode(devc->ftdic, 0x00, BITMODE_RESET);
282 sr_err("Failed to reset the FTDI chip bitmode (%d): %s.",
283 ret, ftdi_get_error_string(devc->ftdic));
284 goto err_dev_open_close_ftdic;
287 ret = ftdi_set_bitmode(devc->ftdic, 0x00, BITMODE_BITBANG);
289 sr_err("Failed to put FTDI chip into bitbang mode (%d): %s.",
290 ret, ftdi_get_error_string(devc->ftdic));
291 goto err_dev_open_close_ftdic;
296 err_dev_open_close_ftdic:
297 ftdi_usb_close(devc->ftdic);
300 ftdi_free(devc->ftdic);
305 static int dev_close(struct sr_dev_inst *sdi)
307 struct dev_context *devc;
314 ftdi_usb_close(devc->ftdic);
315 ftdi_free(devc->ftdic);
321 static int config_get(uint32_t key, GVariant **data,
322 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
324 struct dev_context *devc;
325 struct sr_usb_dev_inst *usb;
333 case SR_CONF_SAMPLERATE:
334 *data = g_variant_new_uint64(devc->cur_samplerate);
337 if (!sdi || !sdi->conn)
340 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
341 *data = g_variant_new_string(str);
350 static int config_set(uint32_t key, GVariant *data,
351 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
353 struct dev_context *devc;
361 case SR_CONF_LIMIT_MSEC:
362 value = g_variant_get_uint64(data);
363 /* TODO: Implement. */
365 case SR_CONF_LIMIT_SAMPLES:
366 if (g_variant_get_uint64(data) == 0)
368 devc->limit_samples = g_variant_get_uint64(data);
370 case SR_CONF_SAMPLERATE:
371 value = g_variant_get_uint64(data);
373 return SR_ERR_SAMPLERATE;
374 devc->cur_samplerate = value;
375 return ftdi_la_set_samplerate(devc);
383 static int config_list(uint32_t key, GVariant **data,
384 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
390 case SR_CONF_SCAN_OPTIONS:
391 case SR_CONF_DEVICE_OPTIONS:
392 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
393 case SR_CONF_SAMPLERATE:
394 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
395 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
396 samplerates, ARRAY_SIZE(samplerates), sizeof(uint64_t));
397 g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar);
398 *data = g_variant_builder_end(&gvb);
407 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
409 struct dev_context *devc;
416 ftdi_set_bitmode(devc->ftdic, 0, BITMODE_BITBANG);
418 /* Properly reset internal variables before every new acquisition. */
419 devc->samples_sent = 0;
420 devc->bytes_received = 0;
422 std_session_send_df_header(sdi);
424 /* Hook up a dummy handler to receive data from the device. */
425 sr_session_source_add(sdi->session, -1, G_IO_IN, 0,
426 ftdi_la_receive_data, (void *)sdi);
431 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
433 sr_session_source_remove(sdi->session, -1);
435 std_session_send_df_end(sdi);
440 static struct sr_dev_driver ftdi_la_driver_info = {
442 .longname = "FTDI LA",
445 .cleanup = std_cleanup,
447 .dev_list = std_dev_list,
448 .dev_clear = dev_clear,
449 .config_get = config_get,
450 .config_set = config_set,
451 .config_list = config_list,
452 .dev_open = dev_open,
453 .dev_close = dev_close,
454 .dev_acquisition_start = dev_acquisition_start,
455 .dev_acquisition_stop = dev_acquisition_stop,
458 SR_REGISTER_DEV_DRIVER(ftdi_la_driver_info);