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