hardware/fx2lafw/fx2lafw.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 <stdio.h>
  22 #include <stdlib.h>
  23 #include <string.h>
  24 #include <inttypes.h>
  25 #include <libusb.h>
  26 #include "libsigrok.h"
  27 #include "libsigrok-internal.h"
  28 #include "fx2lafw.h"
  29 #include "command.h"
  30
  31 static const struct fx2lafw_profile supported_fx2[] = {
  32         /*
  33          * CWAV USBee AX
  34          * EE Electronics ESLA201A
  35          * ARMFLY AX-Pro
  36          */
  37         { 0x08a9, 0x0014, "CWAV", "USBee AX", NULL,
  38                 FIRMWARE_DIR "/fx2lafw-cwav-usbeeax.fw",
  39                 0 },
  40         /*
  41          * CWAV USBee DX
  42          * XZL-Studio DX
  43          */
  44         { 0x08a9, 0x0015, "CWAV", "USBee DX", NULL,
  45                 FIRMWARE_DIR "/fx2lafw-cwav-usbeedx.fw",
  46                 DEV_CAPS_16BIT },
  47
  48         /*
  49          * CWAV USBee SX
  50          */
  51         { 0x08a9, 0x0009, "CWAV", "USBee SX", NULL,
  52                 FIRMWARE_DIR "/fx2lafw-cwav-usbeesx.fw",
  53                 0 },
  54
  55         /*
  56          * Saleae Logic
  57          * EE Electronics ESLA100
  58          * Robomotic MiniLogic
  59          * Robomotic BugLogic 3
  60          */
  61         { 0x0925, 0x3881, "Saleae", "Logic", NULL,
  62                 FIRMWARE_DIR "/fx2lafw-saleae-logic.fw",
  63                 0 },
  64
  65         /*
  66          * Default Cypress FX2 without EEPROM, e.g.:
  67          * Lcsoft Mini Board
  68          * Braintechnology USB Interface V2.x
  69          */
  70         { 0x04B4, 0x8613, "Cypress", "FX2", NULL,
  71                 FIRMWARE_DIR "/fx2lafw-cypress-fx2.fw",
  72                 DEV_CAPS_16BIT },
  73
  74         /*
  75          * Braintechnology USB-LPS
  76          */
  77         { 0x16d0, 0x0498, "Braintechnology", "USB-LPS", NULL,
  78                 FIRMWARE_DIR "/fx2lafw-braintechnology-usb-lps.fw",
  79                 DEV_CAPS_16BIT },
  80
  81         { 0, 0, 0, 0, 0, 0, 0 }
  82 };
  83
  84 static const int32_t hwopts[] = {
  85         SR_CONF_CONN,
  86 };
  87
  88 static const int32_t hwcaps[] = {
  89         SR_CONF_LOGIC_ANALYZER,
  90         SR_CONF_TRIGGER_TYPE,
  91         SR_CONF_SAMPLERATE,
  92
  93         /* These are really implemented in the driver, not the hardware. */
  94         SR_CONF_LIMIT_SAMPLES,
  95         SR_CONF_CONTINUOUS,
  96 };
  97
  98 static const char *probe_names[] = {
  99         "0",  "1",  "2",  "3",  "4",  "5",  "6",  "7",
 100         "8",  "9", "10", "11", "12", "13", "14", "15",
 101         NULL,
 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 /**
 127  * Check the USB configuration to determine if this is an fx2lafw device.
 128  *
 129  * @return TRUE if the device's configuration profile match fx2lafw
 130  *         configuration, FALSE otherwise.
 131  */
 132 static gboolean check_conf_profile(libusb_device *dev)
 133 {
 134         struct libusb_device_descriptor des;
 135         struct libusb_device_handle *hdl;
 136         gboolean ret;
 137         unsigned char strdesc[64];
 138
 139         hdl = NULL;
 140         ret = FALSE;
 141         while (!ret) {
 142                 /* Assume the FW has not been loaded, unless proven wrong. */
 143                 if (libusb_get_device_descriptor(dev, &des) != 0)
 144                         break;
 145
 146                 if (libusb_open(dev, &hdl) != 0)
 147                         break;
 148
 149                 if (libusb_get_string_descriptor_ascii(hdl,
 150                     des.iManufacturer, strdesc, sizeof(strdesc)) < 0)
 151                         break;
 152                 if (strncmp((const char *)strdesc, "sigrok", 6))
 153                         break;
 154
 155                 if (libusb_get_string_descriptor_ascii(hdl,
 156                                 des.iProduct, strdesc, sizeof(strdesc)) < 0)
 157                         break;
 158                 if (strncmp((const char *)strdesc, "fx2lafw", 7))
 159                         break;
 160
 161                 /* If we made it here, it must be an fx2lafw. */
 162                 ret = TRUE;
 163         }
 164         if (hdl)
 165                 libusb_close(hdl);
 166
 167         return ret;
 168 }
 169
 170 static int fx2lafw_dev_open(struct sr_dev_inst *sdi)
 171 {
 172         libusb_device **devlist;
 173         struct sr_usb_dev_inst *usb;
 174         struct libusb_device_descriptor des;
 175         struct dev_context *devc;
 176         struct drv_context *drvc;
 177         struct version_info vi;
 178         int ret, skip, i, device_count;
 179         uint8_t revid;
 180
 181         drvc = di->priv;
 182         devc = sdi->priv;
 183         usb = sdi->conn;
 184
 185         if (sdi->status == SR_ST_ACTIVE)
 186                 /* Device is already in use. */
 187                 return SR_ERR;
 188
 189         skip = 0;
 190         device_count = libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
 191         if (device_count < 0) {
 192                 sr_err("Failed to get device list: %s.",
 193                        libusb_error_name(device_count));
 194                 return SR_ERR;
 195         }
 196
 197         for (i = 0; i < device_count; i++) {
 198                 if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
 199                         sr_err("Failed to get device descriptor: %s.",
 200                                libusb_error_name(ret));
 201                         continue;
 202                 }
 203
 204                 if (des.idVendor != devc->profile->vid
 205                     || des.idProduct != devc->profile->pid)
 206                         continue;
 207
 208                 if (sdi->status == SR_ST_INITIALIZING) {
 209                         if (skip != sdi->index) {
 210                                 /* Skip devices of this type that aren't the one we want. */
 211                                 skip += 1;
 212                                 continue;
 213                         }
 214                 } else if (sdi->status == SR_ST_INACTIVE) {
 215                         /*
 216                          * This device is fully enumerated, so we need to find
 217                          * this device by vendor, product, bus and address.
 218                          */
 219                         if (libusb_get_bus_number(devlist[i]) != usb->bus
 220                                 || libusb_get_device_address(devlist[i]) != usb->address)
 221                                 /* This is not the one. */
 222                                 continue;
 223                 }
 224
 225                 if (!(ret = libusb_open(devlist[i], &usb->devhdl))) {
 226                         if (usb->address == 0xff)
 227                                 /*
 228                                  * First time we touch this device after FW
 229                                  * upload, so we don't know the address yet.
 230                                  */
 231                                 usb->address = libusb_get_device_address(devlist[i]);
 232                 } else {
 233                         sr_err("Failed to open device: %s.",
 234                                libusb_error_name(ret));
 235                         break;
 236                 }
 237
 238                 ret = command_get_fw_version(usb->devhdl, &vi);
 239                 if (ret != SR_OK) {
 240                         sr_err("Failed to get firmware version.");
 241                         break;
 242                 }
 243
 244                 ret = command_get_revid_version(usb->devhdl, &revid);
 245                 if (ret != SR_OK) {
 246                         sr_err("Failed to get REVID.");
 247                         break;
 248                 }
 249
 250                 /*
 251                  * Changes in major version mean incompatible/API changes, so
 252                  * bail out if we encounter an incompatible version.
 253                  * Different minor versions are OK, they should be compatible.
 254                  */
 255                 if (vi.major != FX2LAFW_REQUIRED_VERSION_MAJOR) {
 256                         sr_err("Expected firmware version %d.x, "
 257                                "got %d.%d.", FX2LAFW_REQUIRED_VERSION_MAJOR,
 258                                vi.major, vi.minor);
 259                         break;
 260                 }
 261
 262                 sdi->status = SR_ST_ACTIVE;
 263                 sr_info("Opened device %d on %d.%d, "
 264                         "interface %d, firmware %d.%d.",
 265                         sdi->index, usb->bus, usb->address,
 266                         USB_INTERFACE, vi.major, vi.minor);
 267
 268                 sr_info("Detected REVID=%d, it's a Cypress CY7C68013%s.",
 269                         revid, (revid != 1) ? " (FX2)" : "A (FX2LP)");
 270
 271                 break;
 272         }
 273         libusb_free_device_list(devlist, 1);
 274
 275         if (sdi->status != SR_ST_ACTIVE)
 276                 return SR_ERR;
 277
 278         return SR_OK;
 279 }
 280
 281 static int configure_probes(const struct sr_dev_inst *sdi)
 282 {
 283         struct dev_context *devc;
 284         struct sr_probe *probe;
 285         GSList *l;
 286         int probe_bit, stage, i;
 287         char *tc;
 288
 289         devc = sdi->priv;
 290         for (i = 0; i < NUM_TRIGGER_STAGES; i++) {
 291                 devc->trigger_mask[i] = 0;
 292                 devc->trigger_value[i] = 0;
 293         }
 294
 295         stage = -1;
 296         for (l = sdi->probes; l; l = l->next) {
 297                 probe = (struct sr_probe *)l->data;
 298                 if (probe->enabled == FALSE)
 299                         continue;
 300
 301                 if (probe->index > 7)
 302                         devc->sample_wide = TRUE;
 303
 304                 probe_bit = 1 << (probe->index);
 305                 if (!(probe->trigger))
 306                         continue;
 307
 308                 stage = 0;
 309                 for (tc = probe->trigger; *tc; tc++) {
 310                         devc->trigger_mask[stage] |= probe_bit;
 311                         if (*tc == '1')
 312                                 devc->trigger_value[stage] |= probe_bit;
 313                         stage++;
 314                         if (stage > NUM_TRIGGER_STAGES)
 315                                 return SR_ERR;
 316                 }
 317         }
 318
 319         if (stage == -1)
 320                 /*
 321                  * We didn't configure any triggers, make sure acquisition
 322                  * doesn't wait for any.
 323                  */
 324                 devc->trigger_stage = TRIGGER_FIRED;
 325         else
 326                 devc->trigger_stage = 0;
 327
 328         return SR_OK;
 329 }
 330
 331 static struct dev_context *fx2lafw_dev_new(void)
 332 {
 333         struct dev_context *devc;
 334
 335         if (!(devc = g_try_malloc(sizeof(struct dev_context)))) {
 336                 sr_err("Device context malloc failed.");
 337                 return NULL;
 338         }
 339
 340         devc->profile = NULL;
 341         devc->fw_updated = 0;
 342         devc->cur_samplerate = 0;
 343         devc->limit_samples = 0;
 344         devc->sample_wide = 0;
 345
 346
 347         return devc;
 348 }
 349
 350 static int clear_instances(void)
 351 {
 352         return std_dev_clear(di, NULL);
 353 }
 354
 355 static int hw_init(struct sr_context *sr_ctx)
 356 {
 357         return std_hw_init(sr_ctx, di, LOG_PREFIX);
 358 }
 359
 360 static GSList *hw_scan(GSList *options)
 361 {
 362         struct drv_context *drvc;
 363         struct dev_context *devc;
 364         struct sr_dev_inst *sdi;
 365         struct sr_usb_dev_inst *usb;
 366         struct sr_probe *probe;
 367         struct sr_config *src;
 368         const struct fx2lafw_profile *prof;
 369         GSList *l, *devices, *conn_devices;
 370         struct libusb_device_descriptor des;
 371         libusb_device **devlist;
 372         int devcnt, num_logic_probes, ret, i, j;
 373         const char *conn;
 374
 375         drvc = di->priv;
 376
 377         conn = NULL;
 378         for (l = options; l; l = l->next) {
 379                 src = l->data;
 380                 switch (src->key) {
 381                 case SR_CONF_CONN:
 382                         conn = g_variant_get_string(src->data, NULL);
 383                         break;
 384                 }
 385         }
 386         if (conn)
 387                 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
 388         else
 389                 conn_devices = NULL;
 390
 391         /* Find all fx2lafw compatible devices and upload firmware to them. */
 392         devices = NULL;
 393         libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
 394         for (i = 0; devlist[i]; i++) {
 395                 if (conn) {
 396                         usb = NULL;
 397                         for (l = conn_devices; l; l = l->next) {
 398                                 usb = l->data;
 399                                 if (usb->bus == libusb_get_bus_number(devlist[i])
 400                                         && usb->address == libusb_get_device_address(devlist[i]))
 401                                         break;
 402                         }
 403                         if (!l)
 404                                 /* This device matched none of the ones that
 405                                  * matched the conn specification. */
 406                                 continue;
 407                 }
 408
 409                 if ((ret = libusb_get_device_descriptor( devlist[i], &des)) != 0) {
 410                         sr_warn("Failed to get device descriptor: %s.",
 411                                 libusb_error_name(ret));
 412                         continue;
 413                 }
 414
 415                 prof = NULL;
 416                 for (j = 0; supported_fx2[j].vid; j++) {
 417                         if (des.idVendor == supported_fx2[j].vid &&
 418                                 des.idProduct == supported_fx2[j].pid) {
 419                                 prof = &supported_fx2[j];
 420                         }
 421                 }
 422
 423                 /* Skip if the device was not found. */
 424                 if (!prof)
 425                         continue;
 426
 427                 devcnt = g_slist_length(drvc->instances);
 428                 sdi = sr_dev_inst_new(devcnt, SR_ST_INITIALIZING,
 429                         prof->vendor, prof->model, prof->model_version);
 430                 if (!sdi)
 431                         return NULL;
 432                 sdi->driver = di;
 433
 434                 /* Fill in probelist according to this device's profile. */
 435                 num_logic_probes = prof->dev_caps & DEV_CAPS_16BIT ? 16 : 8;
 436                 for (j = 0; j < num_logic_probes; j++) {
 437                         if (!(probe = sr_probe_new(j, SR_PROBE_LOGIC, TRUE,
 438                                         probe_names[j])))
 439                                 return NULL;
 440                         sdi->probes = g_slist_append(sdi->probes, probe);
 441                 }
 442
 443                 devc = fx2lafw_dev_new();
 444                 devc->profile = prof;
 445                 sdi->priv = devc;
 446                 drvc->instances = g_slist_append(drvc->instances, sdi);
 447                 devices = g_slist_append(devices, sdi);
 448
 449                 if (check_conf_profile(devlist[i])) {
 450                         /* Already has the firmware, so fix the new address. */
 451                         sr_dbg("Found an fx2lafw device.");
 452                         sdi->status = SR_ST_INACTIVE;
 453                         sdi->inst_type = SR_INST_USB;
 454                         sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
 455                                         libusb_get_device_address(devlist[i]), NULL);
 456                 } else {
 457                         if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
 458                                 prof->firmware) == SR_OK)
 459                                 /* Store when this device's FW was updated. */
 460                                 devc->fw_updated = g_get_monotonic_time();
 461                         else
 462                                 sr_err("Firmware upload failed for "
 463                                        "device %d.", devcnt);
 464                         sdi->inst_type = SR_INST_USB;
 465                         sdi->conn = sr_usb_dev_inst_new (libusb_get_bus_number(devlist[i]),
 466                                         0xff, NULL);
 467                 }
 468         }
 469         libusb_free_device_list(devlist, 1);
 470         g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
 471
 472         return devices;
 473 }
 474
 475 static GSList *hw_dev_list(void)
 476 {
 477         return ((struct drv_context *)(di->priv))->instances;
 478 }
 479
 480 static int hw_dev_open(struct sr_dev_inst *sdi)
 481 {
 482         struct sr_usb_dev_inst *usb;
 483         struct dev_context *devc;
 484         int ret;
 485         int64_t timediff_us, timediff_ms;
 486
 487         devc = sdi->priv;
 488         usb = sdi->conn;
 489
 490         /*
 491          * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
 492          * milliseconds for the FX2 to renumerate.
 493          */
 494         ret = SR_ERR;
 495         if (devc->fw_updated > 0) {
 496                 sr_info("Waiting for device to reset.");
 497                 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
 498                 g_usleep(300 * 1000);
 499                 timediff_ms = 0;
 500                 while (timediff_ms < MAX_RENUM_DELAY_MS) {
 501                         if ((ret = fx2lafw_dev_open(sdi)) == SR_OK)
 502                                 break;
 503                         g_usleep(100 * 1000);
 504
 505                         timediff_us = g_get_monotonic_time() - devc->fw_updated;
 506                         timediff_ms = timediff_us / 1000;
 507                         sr_spew("Waited %" PRIi64 "ms.", timediff_ms);
 508                 }
 509                 if (ret != SR_OK) {
 510                         sr_err("Device failed to renumerate.");
 511                         return SR_ERR;
 512                 }
 513                 sr_info("Device came back after %" PRIi64 "ms.", timediff_ms);
 514         } else {
 515                 sr_info("Firmware upload was not needed.");
 516                 ret = fx2lafw_dev_open(sdi);
 517         }
 518
 519         if (ret != SR_OK) {
 520                 sr_err("Unable to open device.");
 521                 return SR_ERR;
 522         }
 523
 524         ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
 525         if (ret != 0) {
 526                 switch(ret) {
 527                 case LIBUSB_ERROR_BUSY:
 528                         sr_err("Unable to claim USB interface. Another "
 529                                "program or driver has already claimed it.");
 530                         break;
 531                 case LIBUSB_ERROR_NO_DEVICE:
 532                         sr_err("Device has been disconnected.");
 533                         break;
 534                 default:
 535                         sr_err("Unable to claim interface: %s.",
 536                                libusb_error_name(ret));
 537                         break;
 538                 }
 539
 540                 return SR_ERR;
 541         }
 542
 543         if (devc->cur_samplerate == 0) {
 544                 /* Samplerate hasn't been set; default to the slowest one. */
 545                 devc->cur_samplerate = samplerates[0];
 546         }
 547
 548         return SR_OK;
 549 }
 550
 551 static int hw_dev_close(struct sr_dev_inst *sdi)
 552 {
 553         struct sr_usb_dev_inst *usb;
 554
 555         usb = sdi->conn;
 556         if (usb->devhdl == NULL)
 557                 return SR_ERR;
 558
 559         sr_info("fx2lafw: Closing device %d on %d.%d interface %d.",
 560                 sdi->index, usb->bus, usb->address, USB_INTERFACE);
 561         libusb_release_interface(usb->devhdl, USB_INTERFACE);
 562         libusb_close(usb->devhdl);
 563         usb->devhdl = NULL;
 564         sdi->status = SR_ST_INACTIVE;
 565
 566         return SR_OK;
 567 }
 568
 569 static int hw_cleanup(void)
 570 {
 571         struct drv_context *drvc;
 572         int ret;
 573
 574         if (!(drvc = di->priv))
 575                 return SR_OK;
 576
 577         ret = clear_instances();
 578
 579         g_free(drvc);
 580         di->priv = NULL;
 581
 582         return ret;
 583 }
 584
 585 static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi)
 586 {
 587         struct dev_context *devc;
 588         struct sr_usb_dev_inst *usb;
 589         char str[128];
 590
 591         switch (id) {
 592         case SR_CONF_CONN:
 593                 if (!sdi || !sdi->conn)
 594                         return SR_ERR_ARG;
 595                 usb = sdi->conn;
 596                 if (usb->address == 255)
 597                         /* Device still needs to re-enumerate after firmware
 598                          * upload, so we don't know its (future) address. */
 599                         return SR_ERR;
 600                 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
 601                 *data = g_variant_new_string(str);
 602                 break;
 603         case SR_CONF_SAMPLERATE:
 604                 if (!sdi)
 605                         return SR_ERR;
 606                 devc = sdi->priv;
 607                 *data = g_variant_new_uint64(devc->cur_samplerate);
 608                 break;
 609         default:
 610                 return SR_ERR_NA;
 611         }
 612
 613         return SR_OK;
 614 }
 615
 616 static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi)
 617 {
 618         struct dev_context *devc;
 619         int ret;
 620
 621         if (sdi->status != SR_ST_ACTIVE)
 622                 return SR_ERR;
 623
 624         devc = sdi->priv;
 625
 626         if (id == SR_CONF_SAMPLERATE) {
 627                 devc->cur_samplerate = g_variant_get_uint64(data);
 628                 ret = SR_OK;
 629         } else if (id == SR_CONF_LIMIT_SAMPLES) {
 630                 devc->limit_samples = g_variant_get_uint64(data);
 631                 ret = SR_OK;
 632         } else {
 633                 ret = SR_ERR_NA;
 634         }
 635
 636         return ret;
 637 }
 638
 639 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
 640 {
 641         GVariant *gvar;
 642         GVariantBuilder gvb;
 643
 644         (void)sdi;
 645
 646         switch (key) {
 647         case SR_CONF_SCAN_OPTIONS:
 648                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
 649                                 hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
 650                 break;
 651         case SR_CONF_DEVICE_OPTIONS:
 652                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
 653                                 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
 654                 break;
 655         case SR_CONF_SAMPLERATE:
 656                 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
 657                 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
 658                                 ARRAY_SIZE(samplerates), sizeof(uint64_t));
 659                 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
 660                 *data = g_variant_builder_end(&gvb);
 661                 break;
 662         case SR_CONF_TRIGGER_TYPE:
 663                 *data = g_variant_new_string(TRIGGER_TYPE);
 664                 break;
 665         default:
 666                 return SR_ERR_NA;
 667         }
 668
 669         return SR_OK;
 670 }
 671
 672 static int receive_data(int fd, int revents, void *cb_data)
 673 {
 674         struct timeval tv;
 675         struct drv_context *drvc;
 676
 677         (void)fd;
 678         (void)revents;
 679         (void)cb_data;
 680
 681         drvc = di->priv;
 682
 683         tv.tv_sec = tv.tv_usec = 0;
 684         libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
 685
 686         return TRUE;
 687 }
 688
 689 static void abort_acquisition(struct dev_context *devc)
 690 {
 691         int i;
 692
 693         devc->num_samples = -1;
 694
 695         for (i = devc->num_transfers - 1; i >= 0; i--) {
 696                 if (devc->transfers[i])
 697                         libusb_cancel_transfer(devc->transfers[i]);
 698         }
 699 }
 700
 701 static void finish_acquisition(struct dev_context *devc)
 702 {
 703         struct sr_datafeed_packet packet;
 704         int i;
 705
 706         /* Terminate session. */
 707         packet.type = SR_DF_END;
 708         sr_session_send(devc->cb_data, &packet);
 709
 710         /* Remove fds from polling. */
 711         for (i = 0; devc->usbfd[i] != -1; i++)
 712                 sr_source_remove(devc->usbfd[i]);
 713         g_free(devc->usbfd);
 714
 715         devc->num_transfers = 0;
 716         g_free(devc->transfers);
 717 }
 718
 719 static void free_transfer(struct libusb_transfer *transfer)
 720 {
 721         struct dev_context *devc;
 722         unsigned int i;
 723
 724         devc = transfer->user_data;
 725
 726         g_free(transfer->buffer);
 727         transfer->buffer = NULL;
 728         libusb_free_transfer(transfer);
 729
 730         for (i = 0; i < devc->num_transfers; i++) {
 731                 if (devc->transfers[i] == transfer) {
 732                         devc->transfers[i] = NULL;
 733                         break;
 734                 }
 735         }
 736
 737         devc->submitted_transfers--;
 738         if (devc->submitted_transfers == 0)
 739                 finish_acquisition(devc);
 740 }
 741
 742 static void resubmit_transfer(struct libusb_transfer *transfer)
 743 {
 744         int ret;
 745
 746         if ((ret = libusb_submit_transfer(transfer)) == LIBUSB_SUCCESS)
 747                 return;
 748
 749         free_transfer(transfer);
 750         /* TODO: Stop session? */
 751
 752         sr_err("%s: %s", __func__, libusb_error_name(ret));
 753 }
 754
 755 static void receive_transfer(struct libusb_transfer *transfer)
 756 {
 757         gboolean packet_has_error = FALSE;
 758         struct sr_datafeed_packet packet;
 759         struct sr_datafeed_logic logic;
 760         struct dev_context *devc;
 761         int trigger_offset, i, sample_width, cur_sample_count;
 762         int trigger_offset_bytes;
 763         uint8_t *cur_buf;
 764
 765         devc = transfer->user_data;
 766
 767         /*
 768          * If acquisition has already ended, just free any queued up
 769          * transfer that come in.
 770          */
 771         if (devc->num_samples == -1) {
 772                 free_transfer(transfer);
 773                 return;
 774         }
 775
 776         sr_info("receive_transfer(): status %d received %d bytes.",
 777                 transfer->status, transfer->actual_length);
 778
 779         /* Save incoming transfer before reusing the transfer struct. */
 780         cur_buf = transfer->buffer;
 781         sample_width = devc->sample_wide ? 2 : 1;
 782         cur_sample_count = transfer->actual_length / sample_width;
 783
 784         switch (transfer->status) {
 785         case LIBUSB_TRANSFER_NO_DEVICE:
 786                 abort_acquisition(devc);
 787                 free_transfer(transfer);
 788                 return;
 789         case LIBUSB_TRANSFER_COMPLETED:
 790         case LIBUSB_TRANSFER_TIMED_OUT: /* We may have received some data though. */
 791                 break;
 792         default:
 793                 packet_has_error = TRUE;
 794                 break;
 795         }
 796
 797         if (transfer->actual_length == 0 || packet_has_error) {
 798                 devc->empty_transfer_count++;
 799                 if (devc->empty_transfer_count > MAX_EMPTY_TRANSFERS) {
 800                         /*
 801                          * The FX2 gave up. End the acquisition, the frontend
 802                          * will work out that the samplecount is short.
 803                          */
 804                         abort_acquisition(devc);
 805                         free_transfer(transfer);
 806                 } else {
 807                         resubmit_transfer(transfer);
 808                 }
 809                 return;
 810         } else {
 811                 devc->empty_transfer_count = 0;
 812         }
 813
 814         trigger_offset = 0;
 815         if (devc->trigger_stage >= 0) {
 816                 for (i = 0; i < cur_sample_count; i++) {
 817
 818                         const uint16_t cur_sample = devc->sample_wide ?
 819                                 *((const uint16_t*)cur_buf + i) :
 820                                 *((const uint8_t*)cur_buf + i);
 821
 822                         if ((cur_sample & devc->trigger_mask[devc->trigger_stage]) ==
 823                                 devc->trigger_value[devc->trigger_stage]) {
 824                                 /* Match on this trigger stage. */
 825                                 devc->trigger_buffer[devc->trigger_stage] = cur_sample;
 826                                 devc->trigger_stage++;
 827
 828                                 if (devc->trigger_stage == NUM_TRIGGER_STAGES ||
 829                                         devc->trigger_mask[devc->trigger_stage] == 0) {
 830                                         /* Match on all trigger stages, we're done. */
 831                                         trigger_offset = i + 1;
 832
 833                                         /*
 834                                          * TODO: Send pre-trigger buffer to session bus.
 835                                          * Tell the frontend we hit the trigger here.
 836                                          */
 837                                         packet.type = SR_DF_TRIGGER;
 838                                         packet.payload = NULL;
 839                                         sr_session_send(devc->cb_data, &packet);
 840
 841                                         /*
 842                                          * Send the samples that triggered it,
 843                                          * since we're skipping past them.
 844                                          */
 845                                         packet.type = SR_DF_LOGIC;
 846                                         packet.payload = &logic;
 847                                         logic.unitsize = sizeof(*devc->trigger_buffer);
 848                                         logic.length = devc->trigger_stage * logic.unitsize;
 849                                         logic.data = devc->trigger_buffer;
 850                                         sr_session_send(devc->cb_data, &packet);
 851
 852                                         devc->trigger_stage = TRIGGER_FIRED;
 853                                         break;
 854                                 }
 855                         } else if (devc->trigger_stage > 0) {
 856                                 /*
 857                                  * We had a match before, but not in the next sample. However, we may
 858                                  * have a match on this stage in the next bit -- trigger on 0001 will
 859                                  * fail on seeing 00001, so we need to go back to stage 0 -- but at
 860                                  * the next sample from the one that matched originally, which the
 861                                  * counter increment at the end of the loop takes care of.
 862                                  */
 863                                 i -= devc->trigger_stage;
 864                                 if (i < -1)
 865                                         i = -1; /* Oops, went back past this buffer. */
 866                                 /* Reset trigger stage. */
 867                                 devc->trigger_stage = 0;
 868                         }
 869                 }
 870         }
 871
 872         if (devc->trigger_stage == TRIGGER_FIRED) {
 873                 /* Send the incoming transfer to the session bus. */
 874                 trigger_offset_bytes = trigger_offset * sample_width;
 875                 packet.type = SR_DF_LOGIC;
 876                 packet.payload = &logic;
 877                 logic.length = transfer->actual_length - trigger_offset_bytes;
 878                 logic.unitsize = sample_width;
 879                 logic.data = cur_buf + trigger_offset_bytes;
 880                 sr_session_send(devc->cb_data, &packet);
 881
 882                 devc->num_samples += cur_sample_count;
 883                 if (devc->limit_samples &&
 884                         (unsigned int)devc->num_samples > devc->limit_samples) {
 885                         abort_acquisition(devc);
 886                         free_transfer(transfer);
 887                         return;
 888                 }
 889         } else {
 890                 /*
 891                  * TODO: Buffer pre-trigger data in capture
 892                  * ratio-sized buffer.
 893                  */
 894         }
 895
 896         resubmit_transfer(transfer);
 897 }
 898
 899 static unsigned int to_bytes_per_ms(unsigned int samplerate)
 900 {
 901         return samplerate / 1000;
 902 }
 903
 904 static size_t get_buffer_size(struct dev_context *devc)
 905 {
 906         size_t s;
 907
 908         /*
 909          * The buffer should be large enough to hold 10ms of data and
 910          * a multiple of 512.
 911          */
 912         s = 10 * to_bytes_per_ms(devc->cur_samplerate);
 913         return (s + 511) & ~511;
 914 }
 915
 916 static unsigned int get_number_of_transfers(struct dev_context *devc)
 917 {
 918         unsigned int n;
 919
 920         /* Total buffer size should be able to hold about 500ms of data. */
 921         n = 500 * to_bytes_per_ms(devc->cur_samplerate) / get_buffer_size(devc);
 922
 923         if (n > NUM_SIMUL_TRANSFERS)
 924                 return NUM_SIMUL_TRANSFERS;
 925
 926         return n;
 927 }
 928
 929 static unsigned int get_timeout(struct dev_context *devc)
 930 {
 931         size_t total_size;
 932         unsigned int timeout;
 933
 934         total_size = get_buffer_size(devc) * get_number_of_transfers(devc);
 935         timeout = total_size / to_bytes_per_ms(devc->cur_samplerate);
 936         return timeout + timeout / 4; /* Leave a headroom of 25% percent. */
 937 }
 938
 939 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
 940                 void *cb_data)
 941 {
 942         struct dev_context *devc;
 943         struct drv_context *drvc;
 944         struct sr_usb_dev_inst *usb;
 945         struct libusb_transfer *transfer;
 946         const struct libusb_pollfd **lupfd;
 947         unsigned int i, timeout, num_transfers;
 948         int ret;
 949         unsigned char *buf;
 950         size_t size;
 951
 952         if (sdi->status != SR_ST_ACTIVE)
 953                 return SR_ERR_DEV_CLOSED;
 954
 955         drvc = di->priv;
 956         devc = sdi->priv;
 957         usb = sdi->conn;
 958
 959         /* Configures devc->trigger_* and devc->sample_wide */
 960         if (configure_probes(sdi) != SR_OK) {
 961                 sr_err("Failed to configure probes.");
 962                 return SR_ERR;
 963         }
 964
 965         devc->cb_data = cb_data;
 966         devc->num_samples = 0;
 967         devc->empty_transfer_count = 0;
 968
 969         timeout = get_timeout(devc);
 970         num_transfers = get_number_of_transfers(devc);
 971         size = get_buffer_size(devc);
 972         devc->submitted_transfers = 0;
 973
 974         devc->transfers = g_try_malloc0(sizeof(*devc->transfers) * num_transfers);
 975         if (!devc->transfers) {
 976                 sr_err("USB transfers malloc failed.");
 977                 return SR_ERR_MALLOC;
 978         }
 979
 980         devc->num_transfers = num_transfers;
 981         for (i = 0; i < num_transfers; i++) {
 982                 if (!(buf = g_try_malloc(size))) {
 983                         sr_err("USB transfer buffer malloc failed.");
 984                         return SR_ERR_MALLOC;
 985                 }
 986                 transfer = libusb_alloc_transfer(0);
 987                 libusb_fill_bulk_transfer(transfer, usb->devhdl,
 988                                 2 | LIBUSB_ENDPOINT_IN, buf, size,
 989                                 receive_transfer, devc, timeout);
 990                 if ((ret = libusb_submit_transfer(transfer)) != 0) {
 991                         sr_err("Failed to submit transfer: %s.",
 992                                libusb_error_name(ret));
 993                         libusb_free_transfer(transfer);
 994                         g_free(buf);
 995                         abort_acquisition(devc);
 996                         return SR_ERR;
 997                 }
 998                 devc->transfers[i] = transfer;
 999                 devc->submitted_transfers++;
1000         }
1001
1002         lupfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
1003         for (i = 0; lupfd[i]; i++);
1004         if (!(devc->usbfd = g_try_malloc(sizeof(struct libusb_pollfd) * (i + 1))))
1005                 return SR_ERR;
1006         for (i = 0; lupfd[i]; i++) {
1007                 sr_source_add(lupfd[i]->fd, lupfd[i]->events,
1008                               timeout, receive_data, NULL);
1009                 devc->usbfd[i] = lupfd[i]->fd;
1010         }
1011         devc->usbfd[i] = -1;
1012         free(lupfd);
1013
1014         /* Send header packet to the session bus. */
1015         std_session_send_df_header(cb_data, LOG_PREFIX);
1016
1017         if ((ret = command_start_acquisition (usb->devhdl,
1018                 devc->cur_samplerate, devc->sample_wide)) != SR_OK) {
1019                 abort_acquisition(devc);
1020                 return ret;
1021         }
1022
1023         return SR_OK;
1024 }
1025
1026 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
1027 {
1028         (void)cb_data;
1029
1030         abort_acquisition(sdi->priv);
1031
1032         return SR_OK;
1033 }
1034
1035 SR_PRIV struct sr_dev_driver fx2lafw_driver_info = {
1036         .name = "fx2lafw",
1037         .longname = "fx2lafw (generic driver for FX2 based LAs)",
1038         .api_version = 1,
1039         .init = hw_init,
1040         .cleanup = hw_cleanup,
1041         .scan = hw_scan,
1042         .dev_list = hw_dev_list,
1043         .dev_clear = clear_instances,
1044         .config_get = config_get,
1045         .config_set = config_set,
1046         .config_list = config_list,
1047         .dev_open = hw_dev_open,
1048         .dev_close = hw_dev_close,
1049         .dev_acquisition_start = hw_dev_acquisition_start,
1050         .dev_acquisition_stop = hw_dev_acquisition_stop,
1051         .priv = NULL,
1052 };