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         curdev = devlist;
 182         while (curdev) {
 183                 scan_device(ftdic, curdev->dev, &devices);
 184                 curdev = curdev->next;
 185         }
 186
 187         ftdi_list_free(&devlist);
 188
 189         return devices;
 190 }
 191
 192 static GSList *scan(struct sr_dev_driver *di, GSList *options)
 193 {
 194         struct ftdi_context *ftdic;
 195         struct sr_config *src;
 196         struct sr_usb_dev_inst *usb;
 197         const char *conn;
 198         GSList *l, *conn_devices;
 199         GSList *devices;
 200         struct drv_context *drvc;
 201         libusb_device **devlist;
 202         int i;
 203
 204         drvc = di->context;
 205         conn = NULL;
 206         for (l = options; l; l = l->next) {
 207                 src = l->data;
 208                 if (src->key == SR_CONF_CONN) {
 209                         conn = g_variant_get_string(src->data, NULL);
 210                         break;
 211                 }
 212         }
 213
 214         /* Allocate memory for the FTDI context (ftdic) and initialize it. */
 215         ftdic = ftdi_new();
 216         if (!ftdic) {
 217                 sr_err("Failed to initialize libftdi.");
 218                 return NULL;
 219         }
 220
 221         if (conn) {
 222                 devices = NULL;
 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) {
 227                                 usb = l->data;
 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);
 231                                 }
 232                         }
 233                 }
 234                 libusb_free_device_list(devlist, 1);
 235         } else
 236                 devices = scan_all(ftdic, options);
 237
 238         ftdi_free(ftdic);
 239
 240         return std_scan_complete(di, devices);
 241 }
 242
 243 static void clear_helper(void *priv)
 244 {
 245         struct dev_context *devc;
 246
 247         devc = priv;
 248         g_free(devc->data_buf);
 249 }
 250
 251 static int dev_clear(const struct sr_dev_driver *di)
 252 {
 253         return std_dev_clear_with_callback(di, clear_helper);
 254 }
 255
 256 static int dev_open(struct sr_dev_inst *sdi)
 257 {
 258         struct dev_context *devc;
 259         int ret = SR_OK;
 260
 261         devc = sdi->priv;
 262
 263         devc->ftdic = ftdi_new();
 264         if (!devc->ftdic)
 265                 return SR_ERR;
 266
 267         ret = ftdi_usb_open_string(devc->ftdic, sdi->connection_id);
 268         if (ret < 0) {
 269                 /* Log errors, except for -3 ("device not found"). */
 270                 if (ret != -3)
 271                         sr_err("Failed to open device (%d): %s", ret,
 272                                ftdi_get_error_string(devc->ftdic));
 273                 goto err_ftdi_free;
 274         }
 275
 276         /* Purge RX/TX buffers in the FTDI chip. */
 277         ret = ftdi_usb_purge_buffers(devc->ftdic);
 278         if (ret < 0) {
 279                 sr_err("Failed to purge FTDI RX/TX buffers (%d): %s.",
 280                        ret, ftdi_get_error_string(devc->ftdic));
 281                 goto err_dev_open_close_ftdic;
 282         }
 283
 284         /* Reset the FTDI bitmode. */
 285         ret = ftdi_set_bitmode(devc->ftdic, 0x00, BITMODE_RESET);
 286         if (ret < 0) {
 287                 sr_err("Failed to reset the FTDI chip bitmode (%d): %s.",
 288                        ret, ftdi_get_error_string(devc->ftdic));
 289                 goto err_dev_open_close_ftdic;
 290         }
 291
 292         ret = ftdi_set_bitmode(devc->ftdic, 0x00, BITMODE_BITBANG);
 293         if (ret < 0) {
 294                 sr_err("Failed to put FTDI chip into bitbang mode (%d): %s.",
 295                        ret, ftdi_get_error_string(devc->ftdic));
 296                 goto err_dev_open_close_ftdic;
 297         }
 298
 299         return SR_OK;
 300
 301 err_dev_open_close_ftdic:
 302         ftdi_usb_close(devc->ftdic);
 303
 304 err_ftdi_free:
 305         ftdi_free(devc->ftdic);
 306
 307         return SR_ERR;
 308 }
 309
 310 static int dev_close(struct sr_dev_inst *sdi)
 311 {
 312         struct dev_context *devc;
 313
 314         devc = sdi->priv;
 315
 316         if (!devc->ftdic)
 317                 return SR_ERR_BUG;
 318
 319         ftdi_usb_close(devc->ftdic);
 320         ftdi_free(devc->ftdic);
 321         devc->ftdic = NULL;
 322
 323         return SR_OK;
 324 }
 325
 326 static int config_get(uint32_t key, GVariant **data,
 327         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 328 {
 329         int ret;
 330         struct dev_context *devc;
 331         struct sr_usb_dev_inst *usb;
 332         char str[128];
 333
 334         (void)cg;
 335
 336         devc = sdi->priv;
 337
 338         ret = SR_OK;
 339         switch (key) {
 340         case SR_CONF_SAMPLERATE:
 341                 *data = g_variant_new_uint64(devc->cur_samplerate);
 342                 break;
 343         case SR_CONF_CONN:
 344                 if (!sdi || !sdi->conn)
 345                         return SR_ERR_ARG;
 346                 usb = sdi->conn;
 347                 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
 348                 *data = g_variant_new_string(str);
 349                 break;
 350         default:
 351                 return SR_ERR_NA;
 352         }
 353
 354         return ret;
 355 }
 356
 357 static int config_set(uint32_t key, GVariant *data,
 358         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 359 {
 360         int ret;
 361         struct dev_context *devc;
 362         uint64_t value;
 363
 364         (void)cg;
 365
 366         devc = sdi->priv;
 367
 368         ret = SR_OK;
 369         switch (key) {
 370         case SR_CONF_LIMIT_MSEC:
 371                 value = g_variant_get_uint64(data);
 372                 /* TODO: Implement. */
 373                 ret = SR_ERR_NA;
 374                 break;
 375         case SR_CONF_LIMIT_SAMPLES:
 376                 if (g_variant_get_uint64(data) == 0)
 377                         return SR_ERR_ARG;
 378                 devc->limit_samples = g_variant_get_uint64(data);
 379                 break;
 380         case SR_CONF_SAMPLERATE:
 381                 value = g_variant_get_uint64(data);
 382                 if (value < 3600)
 383                         return SR_ERR_SAMPLERATE;
 384                 devc->cur_samplerate = value;
 385                 return ftdi_la_set_samplerate(devc);
 386         default:
 387                 ret = SR_ERR_NA;
 388         }
 389
 390         return ret;
 391 }
 392
 393 static int config_list(uint32_t key, GVariant **data,
 394         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 395 {
 396         int ret;
 397         GVariant *gvar;
 398         GVariantBuilder gvb;
 399
 400         (void)sdi;
 401         (void)cg;
 402
 403         ret = SR_OK;
 404         switch (key) {
 405         case SR_CONF_SCAN_OPTIONS:
 406                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 407                         scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 408                 break;
 409         case SR_CONF_DEVICE_OPTIONS:
 410                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 411                         devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 412                 break;
 413         case SR_CONF_SAMPLERATE:
 414                 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
 415                 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
 416                         samplerates, ARRAY_SIZE(samplerates), sizeof(uint64_t));
 417                 g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar);
 418                 *data = g_variant_builder_end(&gvb);
 419                 break;
 420         default:
 421                 return SR_ERR_NA;
 422         }
 423
 424         return ret;
 425 }
 426
 427 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 428 {
 429         struct dev_context *devc;
 430
 431         devc = sdi->priv;
 432
 433         if (!devc->ftdic)
 434                 return SR_ERR_BUG;
 435
 436         ftdi_set_bitmode(devc->ftdic, 0, BITMODE_BITBANG);
 437
 438         /* Properly reset internal variables before every new acquisition. */
 439         devc->samples_sent = 0;
 440         devc->bytes_received = 0;
 441
 442         std_session_send_df_header(sdi);
 443
 444         /* Hook up a dummy handler to receive data from the device. */
 445         sr_session_source_add(sdi->session, -1, G_IO_IN, 0,
 446                               ftdi_la_receive_data, (void *)sdi);
 447
 448         return SR_OK;
 449 }
 450
 451 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 452 {
 453         sr_session_source_remove(sdi->session, -1);
 454
 455         std_session_send_df_end(sdi);
 456
 457         return SR_OK;
 458 }
 459
 460 static struct sr_dev_driver ftdi_la_driver_info = {
 461         .name = "ftdi-la",
 462         .longname = "FTDI LA",
 463         .api_version = 1,
 464         .init = std_init,
 465         .cleanup = std_cleanup,
 466         .scan = scan,
 467         .dev_list = std_dev_list,
 468         .dev_clear = dev_clear,
 469         .config_get = config_get,
 470         .config_set = config_set,
 471         .config_list = config_list,
 472         .dev_open = dev_open,
 473         .dev_close = dev_close,
 474         .dev_acquisition_start = dev_acquisition_start,
 475         .dev_acquisition_stop = dev_acquisition_stop,
 476         .context = NULL,
 477 };
 478 SR_REGISTER_DEV_DRIVER(ftdi_la_driver_info);