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 ft232h_desc = {
75 "ADBUS0", "ADBUS1", "ADBUS2", "ADBUS3", "ADBUS4", "ADBUS5", "ADBUS6", "ADBUS7",
80 static const struct ftdi_chip_desc *chip_descs[] = {
87 static void scan_device(struct ftdi_context *ftdic,
88 struct libusb_device *dev, GSList **devices)
90 struct libusb_device_descriptor usb_desc;
91 const struct ftdi_chip_desc *desc;
92 struct dev_context *devc;
93 char *vendor, *model, *serial_num;
94 struct sr_dev_inst *sdi;
97 libusb_get_device_descriptor(dev, &usb_desc);
100 for (unsigned long i = 0; i < ARRAY_SIZE(chip_descs); i++) {
101 desc = chip_descs[i];
104 if (desc->vendor == usb_desc.idVendor &&
105 desc->product == usb_desc.idProduct)
110 sr_spew("Unsupported FTDI device 0x%04x:0x%04x.",
111 usb_desc.idVendor, usb_desc.idProduct);
115 devc = g_malloc0(sizeof(struct dev_context));
117 /* Allocate memory for the incoming data. */
118 devc->data_buf = g_malloc0(DATA_BUF_SIZE);
122 vendor = g_malloc(32);
123 model = g_malloc(32);
124 serial_num = g_malloc(32);
125 rv = ftdi_usb_get_strings(ftdic, dev, vendor, 32,
126 model, 32, serial_num, 32);
131 sr_dbg("The device lacks a serial number.");
136 sr_err("Failed to get the FTDI strings: %d", rv);
137 goto err_free_strings;
139 sr_dbg("Found an FTDI device: %s.", model);
141 sdi = g_malloc0(sizeof(struct sr_dev_inst));
142 sdi->status = SR_ST_INACTIVE;
143 sdi->vendor = vendor;
145 sdi->serial_num = serial_num;
147 sdi->connection_id = g_strdup_printf("d:%u/%u",
148 libusb_get_bus_number(dev), libusb_get_device_address(dev));
150 for (char *const *chan = &(desc->channel_names[0]); *chan; chan++)
151 sr_channel_new(sdi, chan - &(desc->channel_names[0]),
152 SR_CHANNEL_LOGIC, TRUE, *chan);
154 *devices = g_slist_append(*devices, sdi);
161 g_free(devc->data_buf);
165 static GSList *scan_all(struct ftdi_context *ftdic, GSList *options)
168 struct ftdi_device_list *devlist = 0;
169 struct ftdi_device_list *curdev;
176 ret = ftdi_usb_find_all(ftdic, &devlist, 0, 0);
178 sr_err("Failed to list devices (%d): %s", ret,
179 ftdi_get_error_string(ftdic));
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);
218 sr_err("Failed to initialize libftdi.");
224 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
225 for (i = 0; devlist[i]; i++) {
226 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
227 for (l = conn_devices; l; l = l->next) {
229 if (usb->bus == libusb_get_bus_number(devlist[i])
230 && usb->address == libusb_get_device_address(devlist[i])) {
231 scan_device(ftdic, devlist[i], &devices);
235 libusb_free_device_list(devlist, 1);
237 devices = scan_all(ftdic, options);
241 return std_scan_complete(di, devices);
244 static void clear_helper(struct dev_context *devc)
246 g_free(devc->data_buf);
249 static int dev_clear(const struct sr_dev_driver *di)
251 return std_dev_clear_with_callback(di, (std_dev_clear_callback)clear_helper);
254 static int dev_open(struct sr_dev_inst *sdi)
256 struct dev_context *devc;
261 devc->ftdic = ftdi_new();
265 ret = ftdi_usb_open_string(devc->ftdic, sdi->connection_id);
267 /* Log errors, except for -3 ("device not found"). */
269 sr_err("Failed to open device (%d): %s", ret,
270 ftdi_get_error_string(devc->ftdic));
274 ret = ftdi_usb_purge_buffers(devc->ftdic);
276 sr_err("Failed to purge FTDI RX/TX buffers (%d): %s.",
277 ret, ftdi_get_error_string(devc->ftdic));
278 goto err_dev_open_close_ftdic;
281 ret = ftdi_set_bitmode(devc->ftdic, 0x00, BITMODE_RESET);
283 sr_err("Failed to reset the FTDI chip bitmode (%d): %s.",
284 ret, ftdi_get_error_string(devc->ftdic));
285 goto err_dev_open_close_ftdic;
288 ret = ftdi_set_bitmode(devc->ftdic, 0x00, BITMODE_BITBANG);
290 sr_err("Failed to put FTDI chip into bitbang mode (%d): %s.",
291 ret, ftdi_get_error_string(devc->ftdic));
292 goto err_dev_open_close_ftdic;
297 err_dev_open_close_ftdic:
298 ftdi_usb_close(devc->ftdic);
301 ftdi_free(devc->ftdic);
306 static int dev_close(struct sr_dev_inst *sdi)
308 struct dev_context *devc;
315 ftdi_usb_close(devc->ftdic);
316 ftdi_free(devc->ftdic);
322 static int config_get(uint32_t key, GVariant **data,
323 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
325 struct dev_context *devc;
326 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 *data = g_variant_new_printf("%d.%d", usb->bus, usb->address);
349 static int config_set(uint32_t key, GVariant *data,
350 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
352 struct dev_context *devc;
360 case SR_CONF_LIMIT_MSEC:
361 value = g_variant_get_uint64(data);
362 /* TODO: Implement. */
365 case SR_CONF_LIMIT_SAMPLES:
366 devc->limit_samples = g_variant_get_uint64(data);
368 case SR_CONF_SAMPLERATE:
369 value = g_variant_get_uint64(data);
371 return SR_ERR_SAMPLERATE;
372 devc->cur_samplerate = value;
373 return ftdi_la_set_samplerate(devc);
381 static int config_list(uint32_t key, GVariant **data,
382 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
385 case SR_CONF_SCAN_OPTIONS:
386 case SR_CONF_DEVICE_OPTIONS:
387 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
388 case SR_CONF_SAMPLERATE:
389 *data = std_gvar_samplerates_steps(ARRAY_AND_SIZE(samplerates));
398 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
400 struct dev_context *devc;
407 ftdi_set_bitmode(devc->ftdic, 0, BITMODE_BITBANG);
409 /* Properly reset internal variables before every new acquisition. */
410 devc->samples_sent = 0;
411 devc->bytes_received = 0;
413 std_session_send_df_header(sdi);
415 /* Hook up a dummy handler to receive data from the device. */
416 sr_session_source_add(sdi->session, -1, G_IO_IN, 0,
417 ftdi_la_receive_data, (void *)sdi);
422 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
424 sr_session_source_remove(sdi->session, -1);
426 std_session_send_df_end(sdi);
431 static struct sr_dev_driver ftdi_la_driver_info = {
433 .longname = "FTDI LA",
436 .cleanup = std_cleanup,
438 .dev_list = std_dev_list,
439 .dev_clear = dev_clear,
440 .config_get = config_get,
441 .config_set = config_set,
442 .config_list = config_list,
443 .dev_open = dev_open,
444 .dev_close = dev_close,
445 .dev_acquisition_start = dev_acquisition_start,
446 .dev_acquisition_stop = dev_acquisition_stop,
449 SR_REGISTER_DEV_DRIVER(ftdi_la_driver_info);