src/hardware/fx2lafw/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
   5  * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation, either version 3 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21 #include "protocol.h"
  22
  23 static const struct fx2lafw_profile supported_fx2[] = {
  24         /*
  25          * CWAV USBee AX
  26          * EE Electronics ESLA201A
  27          * ARMFLY AX-Pro
  28          */
  29         { 0x08a9, 0x0014, "CWAV", "USBee AX", NULL,
  30                 FIRMWARE_DIR "/fx2lafw-cwav-usbeeax.fw",
  31                 0, NULL, NULL},
  32         /*
  33          * CWAV USBee DX
  34          * XZL-Studio DX
  35          */
  36         { 0x08a9, 0x0015, "CWAV", "USBee DX", NULL,
  37                 FIRMWARE_DIR "/fx2lafw-cwav-usbeedx.fw",
  38                 DEV_CAPS_16BIT, NULL, NULL },
  39
  40         /*
  41          * CWAV USBee SX
  42          */
  43         { 0x08a9, 0x0009, "CWAV", "USBee SX", NULL,
  44                 FIRMWARE_DIR "/fx2lafw-cwav-usbeesx.fw",
  45                 0, NULL, NULL},
  46
  47         /*
  48          * Saleae Logic
  49          * EE Electronics ESLA100
  50          * Robomotic MiniLogic
  51          * Robomotic BugLogic 3
  52          */
  53         { 0x0925, 0x3881, "Saleae", "Logic", NULL,
  54                 FIRMWARE_DIR "/fx2lafw-saleae-logic.fw",
  55                 0, NULL, NULL},
  56
  57         /*
  58          * Default Cypress FX2 without EEPROM, e.g.:
  59          * Lcsoft Mini Board
  60          * Braintechnology USB Interface V2.x
  61          */
  62         { 0x04B4, 0x8613, "Cypress", "FX2", NULL,
  63                 FIRMWARE_DIR "/fx2lafw-cypress-fx2.fw",
  64                 DEV_CAPS_16BIT, NULL, NULL },
  65
  66         /*
  67          * Braintechnology USB-LPS
  68          */
  69         { 0x16d0, 0x0498, "Braintechnology", "USB-LPS", NULL,
  70                 FIRMWARE_DIR "/fx2lafw-braintechnology-usb-lps.fw",
  71                 DEV_CAPS_16BIT, NULL, NULL },
  72
  73         { 0, 0, 0, 0, 0, 0, 0, 0, 0 }
  74 };
  75
  76 static const uint32_t scanopts[] = {
  77         SR_CONF_CONN,
  78 };
  79
  80 static const uint32_t devopts[] = {
  81         SR_CONF_LOGIC_ANALYZER,
  82         SR_CONF_CONTINUOUS,
  83         SR_CONF_CONN | SR_CONF_GET,
  84         SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  85         SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
  86         SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
  87 };
  88
  89 static const char *channel_names[] = {
  90         "0",  "1",  "2",  "3",  "4",  "5",  "6",  "7",
  91         "8",  "9", "10", "11", "12", "13", "14", "15",
  92         NULL,
  93 };
  94
  95 static const int32_t soft_trigger_matches[] = {
  96         SR_TRIGGER_ZERO,
  97         SR_TRIGGER_ONE,
  98         SR_TRIGGER_RISING,
  99         SR_TRIGGER_FALLING,
 100         SR_TRIGGER_EDGE,
 101 };
 102
 103 static const uint64_t samplerates[] = {
 104         SR_KHZ(20),
 105         SR_KHZ(25),
 106         SR_KHZ(50),
 107         SR_KHZ(100),
 108         SR_KHZ(200),
 109         SR_KHZ(250),
 110         SR_KHZ(500),
 111         SR_MHZ(1),
 112         SR_MHZ(2),
 113         SR_MHZ(3),
 114         SR_MHZ(4),
 115         SR_MHZ(6),
 116         SR_MHZ(8),
 117         SR_MHZ(12),
 118         SR_MHZ(16),
 119         SR_MHZ(24),
 120 };
 121
 122 SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
 123 static struct sr_dev_driver *di = &fx2lafw_driver_info;
 124
 125 static int init(struct sr_context *sr_ctx)
 126 {
 127         return std_init(sr_ctx, di, LOG_PREFIX);
 128 }
 129
 130 static GSList *scan(GSList *options)
 131 {
 132         struct drv_context *drvc;
 133         struct dev_context *devc;
 134         struct sr_dev_inst *sdi;
 135         struct sr_usb_dev_inst *usb;
 136         struct sr_channel *ch;
 137         struct sr_config *src;
 138         const struct fx2lafw_profile *prof;
 139         GSList *l, *devices, *conn_devices;
 140         struct libusb_device_descriptor des;
 141         libusb_device **devlist;
 142         struct libusb_device_handle *hdl;
 143         int devcnt, num_logic_channels, ret, i, j;
 144         const char *conn;
 145         char manufacturer[64], product[64];
 146
 147         drvc = di->priv;
 148
 149         conn = NULL;
 150         for (l = options; l; l = l->next) {
 151                 src = l->data;
 152                 switch (src->key) {
 153                 case SR_CONF_CONN:
 154                         conn = g_variant_get_string(src->data, NULL);
 155                         break;
 156                 }
 157         }
 158         if (conn)
 159                 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
 160         else
 161                 conn_devices = NULL;
 162
 163         /* Find all fx2lafw compatible devices and upload firmware to them. */
 164         devices = NULL;
 165         libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
 166         for (i = 0; devlist[i]; i++) {
 167                 if (conn) {
 168                         usb = NULL;
 169                         for (l = conn_devices; l; l = l->next) {
 170                                 usb = l->data;
 171                                 if (usb->bus == libusb_get_bus_number(devlist[i])
 172                                         && usb->address == libusb_get_device_address(devlist[i]))
 173                                         break;
 174                         }
 175                         if (!l)
 176                                 /* This device matched none of the ones that
 177                                  * matched the conn specification. */
 178                                 continue;
 179                 }
 180
 181                 if ((ret = libusb_get_device_descriptor( devlist[i], &des)) != 0) {
 182                         sr_warn("Failed to get device descriptor: %s.",
 183                                 libusb_error_name(ret));
 184                         continue;
 185                 }
 186
 187                 if ((ret = libusb_open(devlist[i], &hdl)) < 0)
 188                         continue;
 189
 190                 if (des.iManufacturer == 0) {
 191                         manufacturer[0] = '\0';
 192                 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
 193                                 des.iManufacturer, (unsigned char *) manufacturer,
 194                                 sizeof(manufacturer))) < 0) {
 195                         sr_warn("Failed to get manufacturer string descriptor: %s.",
 196                                 libusb_error_name(ret));
 197                         continue;
 198                 }
 199
 200                 if (des.iProduct == 0) {
 201                         product[0] = '\0';
 202                 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
 203                                 des.iProduct, (unsigned char *) product,
 204                                 sizeof(product))) < 0) {
 205                         sr_warn("Failed to get product string descriptor: %s.",
 206                                 libusb_error_name(ret));
 207                         continue;
 208                 }
 209
 210                 libusb_close(hdl);
 211
 212                 prof = NULL;
 213                 for (j = 0; supported_fx2[j].vid; j++) {
 214                         if (des.idVendor == supported_fx2[j].vid &&
 215                                         des.idProduct == supported_fx2[j].pid &&
 216                                         (!supported_fx2[j].usb_manufacturer ||
 217                                          !strcmp(manufacturer, supported_fx2[j].usb_manufacturer)) &&
 218                                         (!supported_fx2[j].usb_manufacturer ||
 219                                          !strcmp(product, supported_fx2[j].usb_product))) {
 220                                 prof = &supported_fx2[j];
 221                                 break;
 222                         }
 223                 }
 224
 225                 /* Skip if the device was not found. */
 226                 if (!prof)
 227                         continue;
 228
 229                 devcnt = g_slist_length(drvc->instances);
 230                 sdi = sr_dev_inst_new(devcnt, SR_ST_INITIALIZING,
 231                         prof->vendor, prof->model, prof->model_version);
 232                 if (!sdi)
 233                         return NULL;
 234                 sdi->driver = di;
 235
 236                 /* Fill in channellist according to this device's profile. */
 237                 num_logic_channels = prof->dev_caps & DEV_CAPS_16BIT ? 16 : 8;
 238                 for (j = 0; j < num_logic_channels; j++) {
 239                         if (!(ch = sr_channel_new(j, SR_CHANNEL_LOGIC, TRUE,
 240                                         channel_names[j])))
 241                                 return NULL;
 242                         sdi->channels = g_slist_append(sdi->channels, ch);
 243                 }
 244
 245                 devc = fx2lafw_dev_new();
 246                 devc->profile = prof;
 247                 sdi->priv = devc;
 248                 drvc->instances = g_slist_append(drvc->instances, sdi);
 249                 devices = g_slist_append(devices, sdi);
 250
 251                 if (fx2lafw_check_conf_profile(devlist[i])) {
 252                         /* Already has the firmware, so fix the new address. */
 253                         sr_dbg("Found an fx2lafw device.");
 254                         sdi->status = SR_ST_INACTIVE;
 255                         sdi->inst_type = SR_INST_USB;
 256                         sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
 257                                         libusb_get_device_address(devlist[i]), NULL);
 258                 } else {
 259                         if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
 260                                 prof->firmware) == SR_OK)
 261                                 /* Store when this device's FW was updated. */
 262                                 devc->fw_updated = g_get_monotonic_time();
 263                         else
 264                                 sr_err("Firmware upload failed for "
 265                                        "device %d.", devcnt);
 266                         sdi->inst_type = SR_INST_USB;
 267                         sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
 268                                         0xff, NULL);
 269                 }
 270         }
 271         libusb_free_device_list(devlist, 1);
 272         g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
 273
 274         return devices;
 275 }
 276
 277 static GSList *dev_list(void)
 278 {
 279         return ((struct drv_context *)(di->priv))->instances;
 280 }
 281
 282 static int dev_open(struct sr_dev_inst *sdi)
 283 {
 284         struct sr_usb_dev_inst *usb;
 285         struct dev_context *devc;
 286         int ret;
 287         int64_t timediff_us, timediff_ms;
 288
 289         devc = sdi->priv;
 290         usb = sdi->conn;
 291
 292         /*
 293          * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
 294          * milliseconds for the FX2 to renumerate.
 295          */
 296         ret = SR_ERR;
 297         if (devc->fw_updated > 0) {
 298                 sr_info("Waiting for device to reset.");
 299                 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
 300                 g_usleep(300 * 1000);
 301                 timediff_ms = 0;
 302                 while (timediff_ms < MAX_RENUM_DELAY_MS) {
 303                         if ((ret = fx2lafw_dev_open(sdi, di)) == SR_OK)
 304                                 break;
 305                         g_usleep(100 * 1000);
 306
 307                         timediff_us = g_get_monotonic_time() - devc->fw_updated;
 308                         timediff_ms = timediff_us / 1000;
 309                         sr_spew("Waited %" PRIi64 "ms.", timediff_ms);
 310                 }
 311                 if (ret != SR_OK) {
 312                         sr_err("Device failed to renumerate.");
 313                         return SR_ERR;
 314                 }
 315                 sr_info("Device came back after %" PRIi64 "ms.", timediff_ms);
 316         } else {
 317                 sr_info("Firmware upload was not needed.");
 318                 ret = fx2lafw_dev_open(sdi, di);
 319         }
 320
 321         if (ret != SR_OK) {
 322                 sr_err("Unable to open device.");
 323                 return SR_ERR;
 324         }
 325
 326         ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
 327         if (ret != 0) {
 328                 switch (ret) {
 329                 case LIBUSB_ERROR_BUSY:
 330                         sr_err("Unable to claim USB interface. Another "
 331                                "program or driver has already claimed it.");
 332                         break;
 333                 case LIBUSB_ERROR_NO_DEVICE:
 334                         sr_err("Device has been disconnected.");
 335                         break;
 336                 default:
 337                         sr_err("Unable to claim interface: %s.",
 338                                libusb_error_name(ret));
 339                         break;
 340                 }
 341
 342                 return SR_ERR;
 343         }
 344
 345         if (devc->cur_samplerate == 0) {
 346                 /* Samplerate hasn't been set; default to the slowest one. */
 347                 devc->cur_samplerate = samplerates[0];
 348         }
 349
 350         return SR_OK;
 351 }
 352
 353 static int dev_close(struct sr_dev_inst *sdi)
 354 {
 355         struct sr_usb_dev_inst *usb;
 356
 357         usb = sdi->conn;
 358         if (usb->devhdl == NULL)
 359                 return SR_ERR;
 360
 361         sr_info("fx2lafw: Closing device %d on %d.%d interface %d.",
 362                 sdi->index, usb->bus, usb->address, USB_INTERFACE);
 363         libusb_release_interface(usb->devhdl, USB_INTERFACE);
 364         libusb_close(usb->devhdl);
 365         usb->devhdl = NULL;
 366         sdi->status = SR_ST_INACTIVE;
 367
 368         return SR_OK;
 369 }
 370
 371 static int cleanup(void)
 372 {
 373         int ret;
 374         struct drv_context *drvc;
 375
 376         if (!(drvc = di->priv))
 377                 return SR_OK;
 378
 379         ret = std_dev_clear(di, NULL);
 380
 381         g_free(drvc);
 382         di->priv = NULL;
 383
 384         return ret;
 385 }
 386
 387 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 388                 const struct sr_channel_group *cg)
 389 {
 390         struct dev_context *devc;
 391         struct sr_usb_dev_inst *usb;
 392         char str[128];
 393
 394         (void)cg;
 395
 396         if (!sdi)
 397                 return SR_ERR_ARG;
 398
 399         devc = sdi->priv;
 400
 401         switch (key) {
 402         case SR_CONF_CONN:
 403                 if (!sdi->conn)
 404                         return SR_ERR_ARG;
 405                 usb = sdi->conn;
 406                 if (usb->address == 255)
 407                         /* Device still needs to re-enumerate after firmware
 408                          * upload, so we don't know its (future) address. */
 409                         return SR_ERR;
 410                 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
 411                 *data = g_variant_new_string(str);
 412                 break;
 413         case SR_CONF_LIMIT_SAMPLES:
 414                 *data = g_variant_new_uint64(devc->limit_samples);
 415                 break;
 416         case SR_CONF_SAMPLERATE:
 417                 *data = g_variant_new_uint64(devc->cur_samplerate);
 418                 break;
 419         default:
 420                 return SR_ERR_NA;
 421         }
 422
 423         return SR_OK;
 424 }
 425
 426 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 427                 const struct sr_channel_group *cg)
 428 {
 429         struct dev_context *devc;
 430         uint64_t arg;
 431         unsigned int i;
 432         int ret;
 433
 434         (void)cg;
 435
 436         if (!sdi)
 437                 return SR_ERR_ARG;
 438
 439         if (sdi->status != SR_ST_ACTIVE)
 440                 return SR_ERR;
 441
 442         devc = sdi->priv;
 443
 444         ret = SR_OK;
 445
 446         switch (key) {
 447                 case SR_CONF_SAMPLERATE:
 448                         arg = g_variant_get_uint64(data);
 449                         for (i = 0; i < ARRAY_SIZE(samplerates); i++) {
 450                                 if (samplerates[i] == arg) {
 451                                         devc->cur_samplerate = arg;
 452                                         break;
 453                                 }
 454                         }
 455                         if (i == ARRAY_SIZE(samplerates))
 456                                 ret = SR_ERR_ARG;
 457                         break;
 458                 case SR_CONF_LIMIT_SAMPLES:
 459                         devc->limit_samples = g_variant_get_uint64(data);
 460                         break;
 461                 default:
 462                         ret = SR_ERR_NA;
 463         }
 464
 465         return ret;
 466 }
 467
 468 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 469                 const struct sr_channel_group *cg)
 470 {
 471         GVariant *gvar;
 472         GVariantBuilder gvb;
 473
 474         (void)sdi;
 475         (void)cg;
 476
 477         switch (key) {
 478         case SR_CONF_SCAN_OPTIONS:
 479                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 480                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 481                 break;
 482         case SR_CONF_DEVICE_OPTIONS:
 483                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 484                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 485                 break;
 486         case SR_CONF_SAMPLERATE:
 487                 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
 488                 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
 489                                 ARRAY_SIZE(samplerates), sizeof(uint64_t));
 490                 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
 491                 *data = g_variant_builder_end(&gvb);
 492                 break;
 493         case SR_CONF_TRIGGER_MATCH:
 494                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
 495                                 soft_trigger_matches, ARRAY_SIZE(soft_trigger_matches),
 496                                 sizeof(int32_t));
 497                 break;
 498         default:
 499                 return SR_ERR_NA;
 500         }
 501
 502         return SR_OK;
 503 }
 504
 505 static int receive_data(int fd, int revents, void *cb_data)
 506 {
 507         struct timeval tv;
 508         struct drv_context *drvc;
 509
 510         (void)fd;
 511         (void)revents;
 512         (void)cb_data;
 513
 514         drvc = di->priv;
 515
 516         tv.tv_sec = tv.tv_usec = 0;
 517         libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
 518
 519         return TRUE;
 520 }
 521
 522 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
 523 {
 524         struct dev_context *devc;
 525         struct drv_context *drvc;
 526         struct sr_usb_dev_inst *usb;
 527         struct sr_trigger *trigger;
 528         struct libusb_transfer *transfer;
 529         unsigned int i, timeout, num_transfers;
 530         int ret;
 531         unsigned char *buf;
 532         size_t size;
 533
 534         if (sdi->status != SR_ST_ACTIVE)
 535                 return SR_ERR_DEV_CLOSED;
 536
 537         drvc = di->priv;
 538         devc = sdi->priv;
 539         usb = sdi->conn;
 540
 541         devc->cb_data = cb_data;
 542         devc->sent_samples = 0;
 543         devc->acq_aborted = FALSE;
 544         devc->empty_transfer_count = 0;
 545
 546         if ((trigger = sr_session_trigger_get(sdi->session))) {
 547                 devc->stl = soft_trigger_logic_new(sdi, trigger);
 548                 devc->trigger_fired = FALSE;
 549         } else
 550                 devc->trigger_fired = TRUE;
 551
 552         timeout = fx2lafw_get_timeout(devc);
 553         num_transfers = fx2lafw_get_number_of_transfers(devc);
 554         size = fx2lafw_get_buffer_size(devc);
 555         devc->submitted_transfers = 0;
 556
 557         devc->transfers = g_try_malloc0(sizeof(*devc->transfers) * num_transfers);
 558         if (!devc->transfers) {
 559                 sr_err("USB transfers malloc failed.");
 560                 return SR_ERR_MALLOC;
 561         }
 562
 563         devc->num_transfers = num_transfers;
 564         for (i = 0; i < num_transfers; i++) {
 565                 if (!(buf = g_try_malloc(size))) {
 566                         sr_err("USB transfer buffer malloc failed.");
 567                         return SR_ERR_MALLOC;
 568                 }
 569                 transfer = libusb_alloc_transfer(0);
 570                 libusb_fill_bulk_transfer(transfer, usb->devhdl,
 571                                 2 | LIBUSB_ENDPOINT_IN, buf, size,
 572                                 fx2lafw_receive_transfer, (void *)sdi, timeout);
 573                 if ((ret = libusb_submit_transfer(transfer)) != 0) {
 574                         sr_err("Failed to submit transfer: %s.",
 575                                libusb_error_name(ret));
 576                         libusb_free_transfer(transfer);
 577                         g_free(buf);
 578                         fx2lafw_abort_acquisition(devc);
 579                         return SR_ERR;
 580                 }
 581                 devc->transfers[i] = transfer;
 582                 devc->submitted_transfers++;
 583         }
 584
 585         devc->ctx = drvc->sr_ctx;
 586
 587         usb_source_add(sdi->session, devc->ctx, timeout, receive_data, NULL);
 588
 589         /* Send header packet to the session bus. */
 590         std_session_send_df_header(cb_data, LOG_PREFIX);
 591
 592         if ((ret = fx2lafw_command_start_acquisition(sdi)) != SR_OK) {
 593                 fx2lafw_abort_acquisition(devc);
 594                 return ret;
 595         }
 596
 597         return SR_OK;
 598 }
 599
 600 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 601 {
 602         (void)cb_data;
 603
 604         fx2lafw_abort_acquisition(sdi->priv);
 605
 606         return SR_OK;
 607 }
 608
 609 SR_PRIV struct sr_dev_driver fx2lafw_driver_info = {
 610         .name = "fx2lafw",
 611         .longname = "fx2lafw (generic driver for FX2 based LAs)",
 612         .api_version = 1,
 613         .init = init,
 614         .cleanup = cleanup,
 615         .scan = scan,
 616         .dev_list = dev_list,
 617         .dev_clear = NULL,
 618         .config_get = config_get,
 619         .config_set = config_set,
 620         .config_list = config_list,
 621         .dev_open = dev_open,
 622         .dev_close = dev_close,
 623         .dev_acquisition_start = dev_acquisition_start,
 624         .dev_acquisition_stop = dev_acquisition_stop,
 625         .priv = NULL,
 626 };