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 sr_dev_driver *di, struct libusb_device *dev, GSList **devices)
87 struct libusb_device_descriptor usb_desc;
88 const struct ftdi_chip_desc *desc;
89 struct dev_context *devc;
90 char *vendor, *model, *serial_num;
91 struct sr_dev_inst *sdi;
92 struct drv_context *drvc;
96 libusb_get_device_descriptor(dev, &usb_desc);
99 for (unsigned long i = 0; i < ARRAY_SIZE(chip_descs); i++) {
100 desc = chip_descs[i];
101 if (desc->vendor == usb_desc.idVendor &&
102 desc->product == usb_desc.idProduct)
107 sr_spew("Unsupported FTDI device 0x%4x:0x%4x.",
108 usb_desc.idVendor, usb_desc.idProduct);
112 /* Allocate memory for our private device context. */
113 devc = g_malloc0(sizeof(struct dev_context));
115 /* Allocate memory for the incoming data. */
116 devc->data_buf = g_malloc0(DATA_BUF_SIZE);
118 /* Allocate memory for the FTDI context (ftdic) and initialize it. */
119 devc->ftdic = ftdi_new();
121 sr_err("Failed to initialize libftdi.");
122 goto err_free_data_buf;
128 vendor = g_malloc(32);
129 model = g_malloc(32);
130 serial_num = g_malloc(32);
131 rv = ftdi_usb_get_strings(devc->ftdic, dev, vendor, 32,
132 model, 32, serial_num, 32);
137 sr_dbg("The device lacks a serial number.");
142 sr_err("Failed to get the FTDI strings: %d", rv);
143 goto err_free_strings;
145 sr_dbg("Found an FTDI device: %s.", model);
147 /* Register the device with libsigrok. */
148 sdi = g_malloc0(sizeof(struct sr_dev_inst));
149 sdi->status = SR_ST_INACTIVE;
150 sdi->vendor = vendor;
152 sdi->serial_num = serial_num;
156 for (char *const *chan = &(desc->channel_names[0]); *chan; chan++)
157 sr_channel_new(sdi, chan - &(desc->channel_names[0]),
158 SR_CHANNEL_LOGIC, TRUE, *chan);
160 *devices = g_slist_append(*devices, sdi);
161 drvc->instances = g_slist_append(drvc->instances, sdi);
168 ftdi_free(devc->ftdic);
170 g_free(devc->data_buf);
174 static GSList *scan_all(struct sr_dev_driver *di, GSList *options)
177 struct ftdi_device_list *devlist = 0;
178 struct ftdi_device_list *curdev;
179 struct ftdi_context *ftdic;
186 /* Allocate memory for the FTDI context (ftdic) and initialize it. */
189 sr_err("Failed to initialize libftdi.");
193 ret = ftdi_usb_find_all(ftdic, &devlist, 0, 0);
195 sr_err("Failed to list devices (%d): %s", ret,
196 ftdi_get_error_string(ftdic));
200 sr_dbg("Number of FTDI devices found: %d", ret);
204 scan_device(di, curdev->dev, &devices);
205 curdev = curdev->next;
208 ftdi_list_free(&devlist);
214 ftdi_free(ftdic); /* NOT free() or g_free()! */
219 static GSList *scan(struct sr_dev_driver *di, GSList *options)
221 struct sr_config *src;
222 struct sr_usb_dev_inst *usb;
224 GSList *l, *conn_devices;
226 struct drv_context *drvc;
227 libusb_device **devlist;
231 drvc->instances = NULL;
233 for (l = options; l; l = l->next) {
235 if (src->key == SR_CONF_CONN) {
236 conn = g_variant_get_string(src->data, NULL);
242 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
243 for (i = 0; devlist[i]; i++) {
244 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
245 for (l = conn_devices; l; l = l->next) {
247 if (usb->bus == libusb_get_bus_number(devlist[i])
248 && usb->address == libusb_get_device_address(devlist[i])) {
249 scan_device(di, devlist[i], &devices);
253 libusb_free_device_list(devlist, 1);
256 return scan_all(di, options);
259 static void clear_helper(void *priv)
261 struct dev_context *devc;
265 ftdi_free(devc->ftdic);
266 g_free(devc->data_buf);
270 static int dev_clear(const struct sr_dev_driver *di)
272 return std_dev_clear(di, clear_helper);
275 static int dev_open(struct sr_dev_inst *sdi)
277 struct dev_context *devc;
282 ret = ftdi_usb_open_dev(devc->ftdic, devc->usbdev);
284 /* Log errors, except for -3 ("device not found"). */
286 sr_err("Failed to open device (%d): %s", ret,
287 ftdi_get_error_string(devc->ftdic));
291 /* Purge RX/TX buffers in the FTDI chip. */
292 ret = ftdi_usb_purge_buffers(devc->ftdic);
294 sr_err("Failed to purge FTDI RX/TX buffers (%d): %s.",
295 ret, ftdi_get_error_string(devc->ftdic));
296 goto err_dev_open_close_ftdic;
298 sr_dbg("FTDI chip buffers purged successfully.");
300 /* Reset the FTDI bitmode. */
301 ret = ftdi_set_bitmode(devc->ftdic, 0x00, BITMODE_RESET);
303 sr_err("Failed to reset the FTDI chip bitmode (%d): %s.",
304 ret, ftdi_get_error_string(devc->ftdic));
305 goto err_dev_open_close_ftdic;
307 sr_dbg("FTDI chip bitmode reset successfully.");
309 ret = ftdi_set_bitmode(devc->ftdic, 0x00, BITMODE_BITBANG);
311 sr_err("Failed to put FTDI chip into bitbang mode (%d): %s.",
312 ret, ftdi_get_error_string(devc->ftdic));
313 goto err_dev_open_close_ftdic;
315 sr_dbg("FTDI chip bitbang mode entered successfully.");
317 sdi->status = SR_ST_ACTIVE;
321 err_dev_open_close_ftdic:
322 ftdi_usb_close(devc->ftdic);
326 static int dev_close(struct sr_dev_inst *sdi)
328 struct dev_context *devc;
332 ftdi_usb_close(devc->ftdic);
334 sdi->status = SR_ST_INACTIVE;
339 static int config_get(uint32_t key, GVariant **data,
340 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
343 struct dev_context *devc;
344 struct sr_usb_dev_inst *usb;
353 case SR_CONF_SAMPLERATE:
354 *data = g_variant_new_uint64(devc->cur_samplerate);
357 if (!sdi || !sdi->conn)
360 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
361 *data = g_variant_new_string(str);
370 static int config_set(uint32_t key, GVariant *data,
371 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
374 struct dev_context *devc;
379 if (sdi->status != SR_ST_ACTIVE)
380 return SR_ERR_DEV_CLOSED;
386 case SR_CONF_LIMIT_MSEC:
387 value = g_variant_get_uint64(data);
388 /* TODO: Implement. */
391 case SR_CONF_LIMIT_SAMPLES:
392 if (g_variant_get_uint64(data) == 0)
394 devc->limit_samples = g_variant_get_uint64(data);
396 case SR_CONF_SAMPLERATE:
397 value = g_variant_get_uint64(data);
399 return SR_ERR_SAMPLERATE;
400 devc->cur_samplerate = value;
401 return ftdi_la_set_samplerate(devc);
409 static int config_list(uint32_t key, GVariant **data,
410 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
421 case SR_CONF_SCAN_OPTIONS:
422 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
423 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
425 case SR_CONF_DEVICE_OPTIONS:
426 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
427 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
429 case SR_CONF_SAMPLERATE:
430 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
431 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
432 samplerates, ARRAY_SIZE(samplerates), sizeof(uint64_t));
433 g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar);
434 *data = g_variant_builder_end(&gvb);
443 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
445 struct dev_context *devc;
449 if (sdi->status != SR_ST_ACTIVE)
450 return SR_ERR_DEV_CLOSED;
455 ftdi_set_bitmode(devc->ftdic, 0, BITMODE_BITBANG);
457 /* Properly reset internal variables before every new acquisition. */
458 devc->samples_sent = 0;
459 devc->bytes_received = 0;
461 std_session_send_df_header(sdi, LOG_PREFIX);
463 /* Hook up a dummy handler to receive data from the device. */
464 sr_session_source_add(sdi->session, -1, G_IO_IN, 0,
465 ftdi_la_receive_data, (void *)sdi);
470 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
472 if (sdi->status != SR_ST_ACTIVE)
473 return SR_ERR_DEV_CLOSED;
475 sr_dbg("Stopping acquisition.");
476 sr_session_source_remove(sdi->session, -1);
478 std_session_send_df_end(sdi, LOG_PREFIX);
483 static struct sr_dev_driver ftdi_la_driver_info = {
485 .longname = "FTDI LA",
488 .cleanup = std_cleanup,
490 .dev_list = std_dev_list,
491 .dev_clear = dev_clear,
492 .config_get = config_get,
493 .config_set = config_set,
494 .config_list = config_list,
495 .dev_open = dev_open,
496 .dev_close = dev_close,
497 .dev_acquisition_start = dev_acquisition_start,
498 .dev_acquisition_stop = dev_acquisition_stop,
501 SR_REGISTER_DEV_DRIVER(ftdi_la_driver_info);