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