src/hardware/ftdi-la/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2015 Sergey Alirzaev <zl29ah@gmail.com>
   5  *
   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.
  10  *
  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.
  15  *
  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/>.
  18  */
  19
  20 #include <config.h>
  21 #include <ftdi.h>
  22 #include <libusb.h>
  23 #include <libsigrok/libsigrok.h>
  24 #include "libsigrok-internal.h"
  25 #include "protocol.h"
  26
  27 static const uint32_t scanopts[] = {
  28         SR_CONF_CONN,
  29 };
  30
  31 static const uint32_t devopts[] = {
  32         SR_CONF_LOGIC_ANALYZER,
  33         SR_CONF_CONTINUOUS,
  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,
  37 };
  38
  39 static const uint64_t samplerates[] = {
  40         SR_HZ(3600),
  41         SR_MHZ(10),
  42         SR_HZ(1),
  43 };
  44
  45 static const struct ftdi_chip_desc ft2232h_desc = {
  46         .vendor = 0x0403,
  47         .product = 0x6010,
  48         .samplerate_div = 20,
  49         .channel_names = {
  50                 "ADBUS0",
  51                 "ADBUS1",
  52                 "ADBUS2",
  53                 "ADBUS3",
  54                 "ADBUS4",
  55                 "ADBUS5",
  56                 "ADBUS6",
  57                 "ADBUS7",
  58                 /* TODO: BDBUS[0..7] channels. */
  59                 NULL
  60         }
  61 };
  62
  63 static const struct ftdi_chip_desc ft232r_desc = {
  64         .vendor = 0x0403,
  65         .product = 0x6001,
  66         .samplerate_div = 30,
  67         .channel_names = {
  68                 "TXD",
  69                 "RXD",
  70                 "RTS#",
  71                 "CTS#",
  72                 "DTR#",
  73                 "DSR#",
  74                 "DCD#",
  75                 "RI#",
  76                 NULL
  77         }
  78 };
  79
  80 static const struct ftdi_chip_desc *chip_descs[] = {
  81         &ft2232h_desc,
  82         &ft232r_desc,
  83 };
  84
  85 static void scan_device(struct ftdi_context *ftdic,
  86         struct libusb_device *dev, GSList **devices)
  87 {
  88         struct libusb_device_descriptor usb_desc;
  89         const struct ftdi_chip_desc *desc;
  90         struct dev_context *devc;
  91         char *vendor, *model, *serial_num;
  92         struct sr_dev_inst *sdi;
  93         int rv;
  94
  95         libusb_get_device_descriptor(dev, &usb_desc);
  96
  97         desc = NULL;
  98         for (unsigned long i = 0; i < ARRAY_SIZE(chip_descs); i++) {
  99                 desc = chip_descs[i];
 100                 if (desc->vendor == usb_desc.idVendor &&
 101                         desc->product == usb_desc.idProduct)
 102                         break;
 103         }
 104
 105         if (!desc) {
 106                 sr_spew("Unsupported FTDI device 0x%4x:0x%4x.",
 107                         usb_desc.idVendor, usb_desc.idProduct);
 108                 return;
 109         }
 110
 111         /* Allocate memory for our private device context. */
 112         devc = g_malloc0(sizeof(struct dev_context));
 113
 114         /* Allocate memory for the incoming data. */
 115         devc->data_buf = g_malloc0(DATA_BUF_SIZE);
 116
 117         devc->desc = desc;
 118
 119         vendor = g_malloc(32);
 120         model = g_malloc(32);
 121         serial_num = g_malloc(32);
 122         rv = ftdi_usb_get_strings(ftdic, dev, vendor, 32,
 123                         model, 32, serial_num, 32);
 124         switch (rv) {
 125         case 0:
 126                 break;
 127         case -9:
 128                 sr_dbg("The device lacks a serial number.");
 129                 g_free(serial_num);
 130                 serial_num = NULL;
 131                 break;
 132         default:
 133                 sr_err("Failed to get the FTDI strings: %d", rv);
 134                 goto err_free_strings;
 135         }
 136         sr_dbg("Found an FTDI device: %s.", model);
 137
 138         /* Register the device with libsigrok. */
 139         sdi = g_malloc0(sizeof(struct sr_dev_inst));
 140         sdi->status = SR_ST_INACTIVE;
 141         sdi->vendor = vendor;
 142         sdi->model = model;
 143         sdi->serial_num = serial_num;
 144         sdi->priv = devc;
 145         sdi->connection_id = g_strdup_printf("d:%u/%u",
 146                 libusb_get_bus_number(dev), libusb_get_device_address(dev));
 147
 148         for (char *const *chan = &(desc->channel_names[0]); *chan; chan++)
 149                 sr_channel_new(sdi, chan - &(desc->channel_names[0]),
 150                                 SR_CHANNEL_LOGIC, TRUE, *chan);
 151
 152         *devices = g_slist_append(*devices, sdi);
 153         return;
 154
 155 err_free_strings:
 156         g_free(vendor);
 157         g_free(model);
 158         g_free(serial_num);
 159         g_free(devc->data_buf);
 160         g_free(devc);
 161 }
 162
 163 static GSList *scan_all(struct ftdi_context *ftdic, GSList *options)
 164 {
 165         GSList *devices;
 166         struct ftdi_device_list *devlist = 0;
 167         struct ftdi_device_list *curdev;
 168         int ret;
 169
 170         (void)options;
 171
 172         devices = NULL;
 173
 174         ret = ftdi_usb_find_all(ftdic, &devlist, 0, 0);
 175         if (ret < 0) {
 176                 sr_err("Failed to list devices (%d): %s", ret,
 177                        ftdi_get_error_string(ftdic));
 178                 return NULL;
 179         }
 180
 181         sr_dbg("Number of FTDI devices found: %d", ret);
 182
 183         curdev = devlist;
 184         while (curdev) {
 185                 scan_device(ftdic, curdev->dev, &devices);
 186                 curdev = curdev->next;
 187         }
 188
 189         ftdi_list_free(&devlist);
 190
 191         return devices;
 192 }
 193
 194 static GSList *scan(struct sr_dev_driver *di, GSList *options)
 195 {
 196         struct ftdi_context *ftdic;
 197         struct sr_config *src;
 198         struct sr_usb_dev_inst *usb;
 199         const char *conn;
 200         GSList *l, *conn_devices;
 201         GSList *devices;
 202         struct drv_context *drvc;
 203         libusb_device **devlist;
 204         int i;
 205
 206         drvc = di->context;
 207         conn = NULL;
 208         for (l = options; l; l = l->next) {
 209                 src = l->data;
 210                 if (src->key == SR_CONF_CONN) {
 211                         conn = g_variant_get_string(src->data, NULL);
 212                         break;
 213                 }
 214         }
 215
 216         /* Allocate memory for the FTDI context (ftdic) and initialize it. */
 217         ftdic = ftdi_new();
 218         if (!ftdic) {
 219                 sr_err("Failed to initialize libftdi.");
 220                 return NULL;
 221         }
 222
 223         if (conn) {
 224                 devices = NULL;
 225                 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
 226                 for (i = 0; devlist[i]; i++) {
 227                         conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
 228                         for (l = conn_devices; l; l = l->next) {
 229                                 usb = l->data;
 230                                 if (usb->bus == libusb_get_bus_number(devlist[i])
 231                                         && usb->address == libusb_get_device_address(devlist[i])) {
 232                                         scan_device(ftdic, devlist[i], &devices);
 233                                 }
 234                         }
 235                 }
 236                 libusb_free_device_list(devlist, 1);
 237         } else
 238                 devices = scan_all(ftdic, options);
 239
 240         ftdi_free(ftdic);
 241
 242         return std_scan_complete(di, devices);
 243 }
 244
 245 static void clear_helper(void *priv)
 246 {
 247         struct dev_context *devc;
 248
 249         devc = priv;
 250         g_free(devc->data_buf);
 251         g_free(devc);
 252 }
 253
 254 static int dev_clear(const struct sr_dev_driver *di)
 255 {
 256         return std_dev_clear(di, clear_helper);
 257 }
 258
 259 static int dev_open(struct sr_dev_inst *sdi)
 260 {
 261         struct dev_context *devc;
 262         int ret = SR_OK;
 263
 264         devc = sdi->priv;
 265
 266         devc->ftdic = ftdi_new();
 267         if (!devc->ftdic)
 268                 return SR_ERR;
 269
 270         ret = ftdi_usb_open_string(devc->ftdic, sdi->connection_id);
 271         if (ret < 0) {
 272                 /* Log errors, except for -3 ("device not found"). */
 273                 if (ret != -3)
 274                         sr_err("Failed to open device (%d): %s", ret,
 275                                ftdi_get_error_string(devc->ftdic));
 276                 goto err_ftdi_free;
 277         }
 278
 279         /* Purge RX/TX buffers in the FTDI chip. */
 280         ret = ftdi_usb_purge_buffers(devc->ftdic);
 281         if (ret < 0) {
 282                 sr_err("Failed to purge FTDI RX/TX buffers (%d): %s.",
 283                        ret, ftdi_get_error_string(devc->ftdic));
 284                 goto err_dev_open_close_ftdic;
 285         }
 286         sr_dbg("FTDI chip buffers purged successfully.");
 287
 288         /* Reset the FTDI bitmode. */
 289         ret = ftdi_set_bitmode(devc->ftdic, 0x00, BITMODE_RESET);
 290         if (ret < 0) {
 291                 sr_err("Failed to reset the FTDI chip bitmode (%d): %s.",
 292                        ret, ftdi_get_error_string(devc->ftdic));
 293                 goto err_dev_open_close_ftdic;
 294         }
 295         sr_dbg("FTDI chip bitmode reset successfully.");
 296
 297         ret = ftdi_set_bitmode(devc->ftdic, 0x00, BITMODE_BITBANG);
 298         if (ret < 0) {
 299                 sr_err("Failed to put FTDI chip into bitbang mode (%d): %s.",
 300                        ret, ftdi_get_error_string(devc->ftdic));
 301                 goto err_dev_open_close_ftdic;
 302         }
 303         sr_dbg("FTDI chip bitbang mode entered successfully.");
 304
 305         return SR_OK;
 306
 307 err_dev_open_close_ftdic:
 308         ftdi_usb_close(devc->ftdic);
 309
 310 err_ftdi_free:
 311         ftdi_free(devc->ftdic);
 312
 313         return SR_ERR;
 314 }
 315
 316 static int dev_close(struct sr_dev_inst *sdi)
 317 {
 318         struct dev_context *devc;
 319
 320         devc = sdi->priv;
 321
 322         if (!devc->ftdic)
 323                 return SR_ERR_BUG;
 324
 325         ftdi_usb_close(devc->ftdic);
 326         ftdi_free(devc->ftdic);
 327         devc->ftdic = NULL;
 328
 329         return SR_OK;
 330 }
 331
 332 static int config_get(uint32_t key, GVariant **data,
 333         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 334 {
 335         int ret;
 336         struct dev_context *devc;
 337         struct sr_usb_dev_inst *usb;
 338         char str[128];
 339
 340         (void)cg;
 341
 342         devc = sdi->priv;
 343
 344         ret = SR_OK;
 345         switch (key) {
 346         case SR_CONF_SAMPLERATE:
 347                 *data = g_variant_new_uint64(devc->cur_samplerate);
 348                 break;
 349         case SR_CONF_CONN:
 350                 if (!sdi || !sdi->conn)
 351                         return SR_ERR_ARG;
 352                 usb = sdi->conn;
 353                 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
 354                 *data = g_variant_new_string(str);
 355                 break;
 356         default:
 357                 return SR_ERR_NA;
 358         }
 359
 360         return ret;
 361 }
 362
 363 static int config_set(uint32_t key, GVariant *data,
 364         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 365 {
 366         int ret;
 367         struct dev_context *devc;
 368         uint64_t value;
 369
 370         (void)cg;
 371
 372         devc = sdi->priv;
 373
 374         ret = SR_OK;
 375         switch (key) {
 376         case SR_CONF_LIMIT_MSEC:
 377                 value = g_variant_get_uint64(data);
 378                 /* TODO: Implement. */
 379                 ret = SR_ERR_NA;
 380                 break;
 381         case SR_CONF_LIMIT_SAMPLES:
 382                 if (g_variant_get_uint64(data) == 0)
 383                         return SR_ERR_ARG;
 384                 devc->limit_samples = g_variant_get_uint64(data);
 385                 break;
 386         case SR_CONF_SAMPLERATE:
 387                 value = g_variant_get_uint64(data);
 388                 if (value < 3600)
 389                         return SR_ERR_SAMPLERATE;
 390                 devc->cur_samplerate = value;
 391                 return ftdi_la_set_samplerate(devc);
 392         default:
 393                 ret = SR_ERR_NA;
 394         }
 395
 396         return ret;
 397 }
 398
 399 static int config_list(uint32_t key, GVariant **data,
 400         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 401 {
 402         int ret;
 403         GVariant *gvar;
 404         GVariantBuilder gvb;
 405
 406         (void)sdi;
 407         (void)cg;
 408
 409         ret = SR_OK;
 410         switch (key) {
 411         case SR_CONF_SCAN_OPTIONS:
 412                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 413                         scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 414                 break;
 415         case SR_CONF_DEVICE_OPTIONS:
 416                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 417                         devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 418                 break;
 419         case SR_CONF_SAMPLERATE:
 420                 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
 421                 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
 422                         samplerates, ARRAY_SIZE(samplerates), sizeof(uint64_t));
 423                 g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar);
 424                 *data = g_variant_builder_end(&gvb);
 425                 break;
 426         default:
 427                 return SR_ERR_NA;
 428         }
 429
 430         return ret;
 431 }
 432
 433 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 434 {
 435         struct dev_context *devc;
 436
 437         devc = sdi->priv;
 438
 439         if (!devc->ftdic)
 440                 return SR_ERR_BUG;
 441
 442         ftdi_set_bitmode(devc->ftdic, 0, BITMODE_BITBANG);
 443
 444         /* Properly reset internal variables before every new acquisition. */
 445         devc->samples_sent = 0;
 446         devc->bytes_received = 0;
 447
 448         std_session_send_df_header(sdi);
 449
 450         /* Hook up a dummy handler to receive data from the device. */
 451         sr_session_source_add(sdi->session, -1, G_IO_IN, 0,
 452                               ftdi_la_receive_data, (void *)sdi);
 453
 454         return SR_OK;
 455 }
 456
 457 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 458 {
 459         sr_session_source_remove(sdi->session, -1);
 460
 461         std_session_send_df_end(sdi);
 462
 463         return SR_OK;
 464 }
 465
 466 static struct sr_dev_driver ftdi_la_driver_info = {
 467         .name = "ftdi-la",
 468         .longname = "FTDI LA",
 469         .api_version = 1,
 470         .init = std_init,
 471         .cleanup = std_cleanup,
 472         .scan = scan,
 473         .dev_list = std_dev_list,
 474         .dev_clear = dev_clear,
 475         .config_get = config_get,
 476         .config_set = config_set,
 477         .config_list = config_list,
 478         .dev_open = dev_open,
 479         .dev_close = dev_close,
 480         .dev_acquisition_start = dev_acquisition_start,
 481         .dev_acquisition_stop = dev_acquisition_stop,
 482         .context = NULL,
 483 };
 484 SR_REGISTER_DEV_DRIVER(ftdi_la_driver_info);