hardware/fx2lafw/fx2lafw.c

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