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 *fdi = &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 = fdi->priv;
 198         struct version_info vi;
 199         int ret, skip, i;
 200         uint8_t revid;
 201
 202         devc = sdi->priv;
 203
 204         if (sdi->status == SR_ST_ACTIVE)
 205                 /* already in use */
 206                 return SR_ERR;
 207
 208         skip = 0;
 209         const int device_count = libusb_get_device_list(
 210                 drvc->sr_ctx->libusb_ctx, &devlist);
 211         if (device_count < 0) {
 212                 sr_err("fx2lafw: Failed to retrieve device list (%d)",
 213                         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("fx2lafw: Failed to get device descriptor: %d.",
 220                                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 firmware upload,
 249                                  * so we don't know the address yet.
 250                                  */
 251                                 devc->usb->address = libusb_get_device_address(devlist[i]);
 252                 } else {
 253                         sr_err("fx2lafw: Failed to open device: %d.", ret);
 254                         break;
 255                 }
 256
 257                 ret = command_get_fw_version(devc->usb->devhdl, &vi);
 258                 if (ret != SR_OK) {
 259                         sr_err("fx2lafw: Failed to retrieve "
 260                                "firmware version information.");
 261                         break;
 262                 }
 263
 264                 ret = command_get_revid_version(devc->usb->devhdl, &revid);
 265                 if (ret != SR_OK) {
 266                         sr_err("fx2lafw: Failed to retrieve 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("fx2lafw: 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("fx2lafw: 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("fx2lafw: %s: devc malloc failed.", __func__);
 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 = fdi->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("fx2lafw: %s: sdi was NULL, continuing.",
 376                                    __func__);
 377                         ret = SR_ERR_BUG;
 378                         continue;
 379                 }
 380                 if (!(devc = sdi->priv)) {
 381                         /* Log error, but continue cleaning up the rest. */
 382                         sr_err("fx2lafw: %s: sdi->priv was NULL, continuing",
 383                                    __func__);
 384                         ret = SR_ERR_BUG;
 385                         continue;
 386                 }
 387                 hw_dev_close(sdi);
 388                 sr_usb_dev_inst_free(devc->usb);
 389                 sdi = l->data;
 390                 sr_dev_inst_free(sdi);
 391         }
 392
 393         g_slist_free(drvc->instances);
 394         drvc->instances = NULL;
 395
 396         return ret;
 397 }
 398
 399
 400 /*
 401  * API callbacks
 402  */
 403
 404 static int hw_init(struct sr_context *sr_ctx)
 405 {
 406         struct drv_context *drvc;
 407
 408         if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
 409                 sr_err("fx2lafw: driver context malloc failed.");
 410                 return SR_ERR_MALLOC;
 411         }
 412
 413         drvc->sr_ctx = sr_ctx;
 414         fdi->priv = drvc;
 415
 416         return SR_OK;
 417 }
 418
 419 static GSList *hw_scan(GSList *options)
 420 {
 421         GSList *devices;
 422         struct libusb_device_descriptor des;
 423         struct sr_dev_inst *sdi;
 424         const struct fx2lafw_profile *prof;
 425         struct drv_context *drvc;
 426         struct dev_context *devc;
 427         struct sr_probe *probe;
 428         libusb_device **devlist;
 429         int devcnt, num_logic_probes, ret, i, j;
 430
 431         (void)options;
 432
 433         drvc = fdi->priv;
 434
 435         /* This scan always invalidates any previous scans. */
 436         clear_instances();
 437
 438         /* Find all fx2lafw compatible devices and upload firmware to them. */
 439         devices = NULL;
 440         libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
 441         for (i = 0; devlist[i]; i++) {
 442
 443                 if ((ret = libusb_get_device_descriptor(
 444                      devlist[i], &des)) != 0) {
 445                         sr_warn("fx2lafw: Failed to get device descriptor: %d.", ret);
 446                         continue;
 447                 }
 448
 449                 prof = NULL;
 450                 for (j = 0; supported_fx2[j].vid; j++) {
 451                         if (des.idVendor == supported_fx2[j].vid &&
 452                                 des.idProduct == supported_fx2[j].pid) {
 453                                 prof = &supported_fx2[j];
 454                         }
 455                 }
 456
 457                 /* Skip if the device was not found */
 458                 if (!prof)
 459                         continue;
 460
 461                 devcnt = g_slist_length(drvc->instances);
 462                 sdi = sr_dev_inst_new(devcnt, SR_ST_INITIALIZING,
 463                         prof->vendor, prof->model, prof->model_version);
 464                 if (!sdi)
 465                         return NULL;
 466                 sdi->driver = fdi;
 467
 468                 /* Fill in probelist according to this device's profile. */
 469                 num_logic_probes = prof->dev_caps & DEV_CAPS_16BIT ? 16 : 8;
 470                 for (j = 0; j < num_logic_probes; j++) {
 471                         if (!(probe = sr_probe_new(j, SR_PROBE_LOGIC, TRUE,
 472                                         probe_names[j])))
 473                                 return NULL;
 474                         sdi->probes = g_slist_append(sdi->probes, probe);
 475                 }
 476
 477                 devc = fx2lafw_dev_new();
 478                 devc->profile = prof;
 479                 sdi->priv = devc;
 480                 drvc->instances = g_slist_append(drvc->instances, sdi);
 481                 devices = g_slist_append(devices, sdi);
 482
 483                 if (check_conf_profile(devlist[i])) {
 484                         /* Already has the firmware, so fix the new address. */
 485                         sr_dbg("fx2lafw: Found an fx2lafw device.");
 486                         sdi->status = SR_ST_INACTIVE;
 487                         devc->usb = sr_usb_dev_inst_new
 488                             (libusb_get_bus_number(devlist[i]),
 489                              libusb_get_device_address(devlist[i]), NULL);
 490                 } else {
 491                         if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
 492                                 prof->firmware) == SR_OK)
 493                                 /* Remember when the firmware on this device was updated */
 494                                 devc->fw_updated = g_get_monotonic_time();
 495                         else
 496                                 sr_err("fx2lafw: Firmware upload failed for "
 497                                        "device %d.", devcnt);
 498                         devc->usb = sr_usb_dev_inst_new
 499                                 (libusb_get_bus_number(devlist[i]), 0xff, NULL);
 500                 }
 501         }
 502         libusb_free_device_list(devlist, 1);
 503
 504         return devices;
 505 }
 506
 507 static GSList *hw_dev_list(void)
 508 {
 509         struct drv_context *drvc;
 510
 511         drvc = fdi->priv;
 512
 513         return drvc->instances;
 514 }
 515
 516 static int hw_dev_open(struct sr_dev_inst *sdi)
 517 {
 518         struct dev_context *devc;
 519         int ret;
 520         int64_t timediff_us, timediff_ms;
 521
 522         devc = sdi->priv;
 523
 524         /*
 525          * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
 526          * milliseconds for the FX2 to renumerate.
 527          */
 528         ret = SR_ERR;
 529         if (devc->fw_updated > 0) {
 530                 sr_info("fx2lafw: Waiting for device to reset.");
 531                 /* takes at least 300ms for the FX2 to be gone from the USB bus */
 532                 g_usleep(300 * 1000);
 533                 timediff_ms = 0;
 534                 while (timediff_ms < MAX_RENUM_DELAY_MS) {
 535                         if ((ret = fx2lafw_dev_open(sdi)) == SR_OK)
 536                                 break;
 537                         g_usleep(100 * 1000);
 538
 539                         timediff_us = g_get_monotonic_time() - devc->fw_updated;
 540                         timediff_ms = timediff_us / 1000;
 541                         sr_spew("fx2lafw: waited %" PRIi64 " ms", timediff_ms);
 542                 }
 543                 sr_info("fx2lafw: Device came back after %d ms.", timediff_ms);
 544         } else {
 545                 ret = fx2lafw_dev_open(sdi);
 546         }
 547
 548         if (ret != SR_OK) {
 549                 sr_err("fx2lafw: Unable to open device.");
 550                 return SR_ERR;
 551         }
 552         devc = sdi->priv;
 553
 554         ret = libusb_claim_interface(devc->usb->devhdl, USB_INTERFACE);
 555         if (ret != 0) {
 556                 switch(ret) {
 557                 case LIBUSB_ERROR_BUSY:
 558                         sr_err("fx2lafw: Unable to claim USB interface. Another "
 559                                 "program or driver has already claimed it.");
 560                         break;
 561
 562                 case LIBUSB_ERROR_NO_DEVICE:
 563                         sr_err("fx2lafw: Device has been disconnected.");
 564                         break;
 565
 566                 default:
 567                         sr_err("fx2lafw: Unable to claim interface: %d.", 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("fx2lafw: 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 = fdi->priv))
 608                 return SR_OK;
 609
 610         ret = clear_instances();
 611
 612         g_free(drvc);
 613         fdi->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 = fdi->priv;
 684
 685         (void)fd;
 686         (void)revents;
 687         (void)cb_data;
 688
 689         tv.tv_sec = tv.tv_usec = 0;
 690         libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
 691
 692         return TRUE;
 693 }
 694
 695 static void abort_acquisition(struct dev_context *devc)
 696 {
 697         int i;
 698
 699         devc->num_samples = -1;
 700
 701         for (i = devc->num_transfers - 1; i >= 0; i--) {
 702                 if (devc->transfers[i])
 703                         libusb_cancel_transfer(devc->transfers[i]);
 704         }
 705 }
 706
 707 static void finish_acquisition(struct dev_context *devc)
 708 {
 709         struct sr_datafeed_packet packet;
 710         struct drv_context *drvc = fdi->priv;
 711         int i;
 712
 713
 714         /* Terminate session */
 715         packet.type = SR_DF_END;
 716         sr_session_send(devc->session_dev_id, &packet);
 717
 718         /* Remove fds from polling */
 719         const struct libusb_pollfd **const lupfd =
 720                 libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
 721         for (i = 0; lupfd[i]; i++)
 722                 sr_source_remove(lupfd[i]->fd);
 723         free(lupfd); /* NOT g_free()! */
 724
 725         devc->num_transfers = 0;
 726         g_free(devc->transfers);
 727 }
 728
 729 static void free_transfer(struct libusb_transfer *transfer)
 730 {
 731         struct dev_context *devc = transfer->user_data;
 732         unsigned int i;
 733
 734         g_free(transfer->buffer);
 735         transfer->buffer = NULL;
 736         libusb_free_transfer(transfer);
 737
 738         for (i = 0; i < devc->num_transfers; i++) {
 739                 if (devc->transfers[i] == transfer) {
 740                         devc->transfers[i] = NULL;
 741                         break;
 742                 }
 743         }
 744
 745         devc->submitted_transfers--;
 746         if (devc->submitted_transfers == 0)
 747                 finish_acquisition(devc);
 748
 749 }
 750
 751 static void resubmit_transfer(struct libusb_transfer *transfer)
 752 {
 753         if (libusb_submit_transfer(transfer) != 0) {
 754                 free_transfer(transfer);
 755                 /* TODO: Stop session? */
 756                 /* TODO: Better error message. */
 757                 sr_err("fx2lafw: %s: libusb_submit_transfer error.", __func__);
 758         }
 759 }
 760
 761 static void receive_transfer(struct libusb_transfer *transfer)
 762 {
 763         gboolean packet_has_error = FALSE;
 764         struct sr_datafeed_packet packet;
 765         struct sr_datafeed_logic logic;
 766         struct dev_context *devc = transfer->user_data;
 767         int trigger_offset, i;
 768
 769         /*
 770          * If acquisition has already ended, just free any queued up
 771          * transfer that come in.
 772          */
 773         if (devc->num_samples == -1) {
 774                 free_transfer(transfer);
 775                 return;
 776         }
 777
 778         sr_info("fx2lafw: receive_transfer(): status %d received %d bytes.",
 779                 transfer->status, transfer->actual_length);
 780
 781         /* Save incoming transfer before reusing the transfer struct. */
 782         uint8_t *const cur_buf = transfer->buffer;
 783         const int sample_width = devc->sample_wide ? 2 : 1;
 784         const int cur_sample_count = transfer->actual_length / sample_width;
 785
 786         switch (transfer->status) {
 787         case LIBUSB_TRANSFER_NO_DEVICE:
 788                 abort_acquisition(devc);
 789                 free_transfer(transfer);
 790                 return;
 791         case LIBUSB_TRANSFER_COMPLETED:
 792         case LIBUSB_TRANSFER_TIMED_OUT: /* We may have received some data though */
 793                 break;
 794         default:
 795                 packet_has_error = TRUE;
 796                 break;
 797         }
 798
 799         if (transfer->actual_length == 0 || packet_has_error) {
 800                 devc->empty_transfer_count++;
 801                 if (devc->empty_transfer_count > MAX_EMPTY_TRANSFERS) {
 802                         /*
 803                          * The FX2 gave up. End the acquisition, the frontend
 804                          * will work out that the samplecount is short.
 805                          */
 806                         abort_acquisition(devc);
 807                         free_transfer(transfer);
 808                 } else {
 809                         resubmit_transfer(transfer);
 810                 }
 811                 return;
 812         } else {
 813                 devc->empty_transfer_count = 0;
 814         }
 815
 816         trigger_offset = 0;
 817         if (devc->trigger_stage >= 0) {
 818                 for (i = 0; i < cur_sample_count; i++) {
 819
 820                         const uint16_t cur_sample = devc->sample_wide ?
 821                                 *((const uint16_t*)cur_buf + i) :
 822                                 *((const uint8_t*)cur_buf + i);
 823
 824                         if ((cur_sample & devc->trigger_mask[devc->trigger_stage]) ==
 825                                 devc->trigger_value[devc->trigger_stage]) {
 826                                 /* Match on this trigger stage. */
 827                                 devc->trigger_buffer[devc->trigger_stage] = cur_sample;
 828                                 devc->trigger_stage++;
 829
 830                                 if (devc->trigger_stage == NUM_TRIGGER_STAGES ||
 831                                         devc->trigger_mask[devc->trigger_stage] == 0) {
 832                                         /* Match on all trigger stages, we're done. */
 833                                         trigger_offset = i + 1;
 834
 835                                         /*
 836                                          * TODO: Send pre-trigger buffer to session bus.
 837                                          * Tell the frontend we hit the trigger here.
 838                                          */
 839                                         packet.type = SR_DF_TRIGGER;
 840                                         packet.payload = NULL;
 841                                         sr_session_send(devc->session_dev_id, &packet);
 842
 843                                         /*
 844                                          * Send the samples that triggered it, since we're
 845                                          * skipping past them.
 846                                          */
 847                                         packet.type = SR_DF_LOGIC;
 848                                         packet.payload = &logic;
 849                                         logic.unitsize = sizeof(*devc->trigger_buffer);
 850                                         logic.length = devc->trigger_stage * logic.unitsize;
 851                                         logic.data = devc->trigger_buffer;
 852                                         sr_session_send(devc->session_dev_id, &packet);
 853
 854                                         devc->trigger_stage = TRIGGER_FIRED;
 855                                         break;
 856                                 }
 857                         } else if (devc->trigger_stage > 0) {
 858                                 /*
 859                                  * We had a match before, but not in the next sample. However, we may
 860                                  * have a match on this stage in the next bit -- trigger on 0001 will
 861                                  * fail on seeing 00001, so we need to go back to stage 0 -- but at
 862                                  * the next sample from the one that matched originally, which the
 863                                  * counter increment at the end of the loop takes care of.
 864                                  */
 865                                 i -= devc->trigger_stage;
 866                                 if (i < -1)
 867                                         i = -1; /* Oops, went back past this buffer. */
 868                                 /* Reset trigger stage. */
 869                                 devc->trigger_stage = 0;
 870                         }
 871                 }
 872         }
 873
 874         if (devc->trigger_stage == TRIGGER_FIRED) {
 875                 /* Send the incoming transfer to the session bus. */
 876                 const int trigger_offset_bytes = trigger_offset * sample_width;
 877                 packet.type = SR_DF_LOGIC;
 878                 packet.payload = &logic;
 879                 logic.length = transfer->actual_length - trigger_offset_bytes;
 880                 logic.unitsize = sample_width;
 881                 logic.data = cur_buf + trigger_offset_bytes;
 882                 sr_session_send(devc->session_dev_id, &packet);
 883
 884                 devc->num_samples += cur_sample_count;
 885                 if (devc->limit_samples &&
 886                         (unsigned int)devc->num_samples > devc->limit_samples) {
 887                         abort_acquisition(devc);
 888                         free_transfer(transfer);
 889                         return;
 890                 }
 891         } else {
 892                 /*
 893                  * TODO: Buffer pre-trigger data in capture
 894                  * ratio-sized buffer.
 895                  */
 896         }
 897
 898         resubmit_transfer(transfer);
 899 }
 900
 901 static unsigned int to_bytes_per_ms(unsigned int samplerate)
 902 {
 903         return samplerate / 1000;
 904 }
 905
 906 static size_t get_buffer_size(struct dev_context *devc)
 907 {
 908         size_t s;
 909
 910         /* The buffer should be large enough to hold 10ms of data and a multiple
 911          * of 512. */
 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 sr_datafeed_packet packet;
 943         struct sr_datafeed_header header;
 944         struct sr_datafeed_meta_logic meta;
 945         struct dev_context *devc;
 946         struct drv_context *drvc = fdi->priv;
 947         struct libusb_transfer *transfer;
 948         const struct libusb_pollfd **lupfd;
 949         unsigned int i;
 950         int ret;
 951         unsigned char *buf;
 952
 953         devc = sdi->priv;
 954         if (devc->submitted_transfers != 0)
 955                 return SR_ERR;
 956
 957         if (configure_probes(sdi) != SR_OK) {
 958                 sr_err("fx2lafw: failed to configured probes");
 959                 return SR_ERR;
 960         }
 961
 962         devc->session_dev_id = cb_data;
 963         devc->num_samples = 0;
 964         devc->empty_transfer_count = 0;
 965
 966         const unsigned int timeout = get_timeout(devc);
 967         const unsigned int num_transfers = get_number_of_transfers(devc);
 968         const size_t size = get_buffer_size(devc);
 969
 970         devc->transfers = g_try_malloc0(sizeof(*devc->transfers) * num_transfers);
 971         if (!devc->transfers) {
 972                 sr_err("fx2lafw: USB transfers malloc failed.");
 973                 return SR_ERR_MALLOC;
 974         }
 975
 976         devc->num_transfers = num_transfers;
 977
 978         for (i = 0; i < num_transfers; i++) {
 979                 if (!(buf = g_try_malloc(size))) {
 980                         sr_err("fx2lafw: %s: buf malloc failed.", __func__);
 981                         return SR_ERR_MALLOC;
 982                 }
 983                 transfer = libusb_alloc_transfer(0);
 984                 libusb_fill_bulk_transfer(transfer, devc->usb->devhdl,
 985                                 2 | LIBUSB_ENDPOINT_IN, buf, size,
 986                                 receive_transfer, devc, timeout);
 987                 if (libusb_submit_transfer(transfer) != 0) {
 988                         libusb_free_transfer(transfer);
 989                         g_free(buf);
 990                         abort_acquisition(devc);
 991                         return SR_ERR;
 992                 }
 993                 devc->transfers[i] = transfer;
 994                 devc->submitted_transfers++;
 995         }
 996
 997         lupfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
 998         for (i = 0; lupfd[i]; i++)
 999                 sr_source_add(lupfd[i]->fd, lupfd[i]->events,
1000                               timeout, receive_data, NULL);
1001         free(lupfd); /* NOT g_free()! */
1002
1003         packet.type = SR_DF_HEADER;
1004         packet.payload = &header;
1005         header.feed_version = 1;
1006         gettimeofday(&header.starttime, NULL);
1007         sr_session_send(cb_data, &packet);
1008
1009         /* Send metadata about the SR_DF_LOGIC packets to come. */
1010         packet.type = SR_DF_META_LOGIC;
1011         packet.payload = &meta;
1012         meta.samplerate = devc->cur_samplerate;
1013         meta.num_probes = devc->sample_wide ? 16 : 8;
1014         sr_session_send(cb_data, &packet);
1015
1016         if ((ret = command_start_acquisition (devc->usb->devhdl,
1017                 devc->cur_samplerate, devc->sample_wide)) != SR_OK) {
1018                 abort_acquisition(devc);
1019                 return ret;
1020         }
1021
1022         return SR_OK;
1023 }
1024
1025 /* TODO: This stops acquisition on ALL devices, ignoring dev_index. */
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         .dev_open = hw_dev_open,
1045         .dev_close = hw_dev_close,
1046         .info_get = hw_info_get,
1047         .dev_config_set = hw_dev_config_set,
1048         .dev_acquisition_start = hw_dev_acquisition_start,
1049         .dev_acquisition_stop = hw_dev_acquisition_stop,
1050         .priv = NULL,
1051 };