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 SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
 143 static struct sr_dev_driver *fdi = &fx2lafw_driver_info;
 144 static int hw_dev_close(struct sr_dev_inst *sdi);
 145 static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
 146                 const void *value);
 147 static int hw_dev_acquisition_stop(const struct sr_dev_inst *sdi,
 148                 void *cb_data);
 149
 150 /**
 151  * Check the USB configuration to determine if this is an fx2lafw device.
 152  *
 153  * @return TRUE if the device's configuration profile match fx2lafw
 154  *         configuration, FALSE otherwise.
 155  */
 156 static gboolean check_conf_profile(libusb_device *dev)
 157 {
 158         struct libusb_device_descriptor des;
 159         struct libusb_device_handle *hdl;
 160         gboolean ret;
 161         unsigned char strdesc[64];
 162
 163         hdl = NULL;
 164         ret = FALSE;
 165         while (!ret) {
 166                 /* Assume the FW has not been loaded, unless proven wrong. */
 167                 if (libusb_get_device_descriptor(dev, &des) != 0)
 168                         break;
 169
 170                 if (libusb_open(dev, &hdl) != 0)
 171                         break;
 172
 173                 if (libusb_get_string_descriptor_ascii(hdl,
 174                                 des.iManufacturer, strdesc, sizeof(strdesc)) < 0)
 175                         break;
 176                 if (strncmp((const char *)strdesc, "sigrok", 6))
 177                         break;
 178
 179                 if (libusb_get_string_descriptor_ascii(hdl,
 180                                 des.iProduct, strdesc, sizeof(strdesc)) < 0)
 181                         break;
 182                 if (strncmp((const char *)strdesc, "fx2lafw", 7))
 183                         break;
 184
 185                 /* If we made it here, it must be an fx2lafw. */
 186                 ret = TRUE;
 187         }
 188         if (hdl)
 189                 libusb_close(hdl);
 190
 191         return ret;
 192 }
 193
 194 static int fx2lafw_dev_open(struct sr_dev_inst *sdi)
 195 {
 196         libusb_device **devlist;
 197         struct libusb_device_descriptor des;
 198         struct drv_context *drvc;
 199         struct dev_context *devc;
 200         struct version_info vi;
 201         int ret, skip, i;
 202         uint8_t revid;
 203
 204         drvc = fdi->priv;
 205         devc = 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(drvc->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 != devc->profile->vid
 227                     || des.idProduct != devc->profile->pid)
 228                         continue;
 229
 230                 if (sdi->status == SR_ST_INITIALIZING) {
 231                         if (skip != sdi->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]) != devc->usb->bus
 242                                 || libusb_get_device_address(devlist[i]) != devc->usb->address)
 243                                 /* this is not the one */
 244                                 continue;
 245                 }
 246
 247                 if (!(ret = libusb_open(devlist[i], &devc->usb->devhdl))) {
 248                         if (devc->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                                 devc->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(devc->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(devc->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, devc->usb->bus, devc->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 int configure_probes(struct dev_context *devc, GSList *probes)
 301 {
 302         struct sr_probe *probe;
 303         GSList *l;
 304         int probe_bit, stage, i;
 305         char *tc;
 306
 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 = 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(void)
 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;
 411         }
 412
 413         if (libusb_init(&drvc->usb_context) != 0) {
 414                 g_free(drvc);
 415                 sr_warn("fx2lafw: Failed to initialize libusb.");
 416                 return SR_ERR;
 417         }
 418
 419         fdi->priv = drvc;
 420
 421         return SR_OK;
 422 }
 423
 424 static GSList *hw_scan(GSList *options)
 425 {
 426         GSList *devices;
 427         struct libusb_device_descriptor des;
 428         struct sr_dev_inst *sdi;
 429         const struct fx2lafw_profile *prof;
 430         struct drv_context *drvc;
 431         struct dev_context *devc;
 432         struct sr_probe *probe;
 433         libusb_device **devlist;
 434         int devcnt, num_logic_probes, ret, i, j;
 435
 436         /* Avoid compiler warnings. */
 437         (void)options;
 438         drvc = fdi->priv;
 439
 440         /* This scan always invalidates any previous scans. */
 441         clear_instances();
 442
 443         /* Find all fx2lafw compatible devices and upload firmware to them. */
 444         devices = NULL;
 445         libusb_get_device_list(drvc->usb_context, &devlist);
 446         for (i = 0; devlist[i]; i++) {
 447
 448                 if ((ret = libusb_get_device_descriptor(
 449                      devlist[i], &des)) != 0) {
 450                         sr_warn("fx2lafw: Failed to get device descriptor: %d.", ret);
 451                         continue;
 452                 }
 453
 454                 prof = NULL;
 455                 for (j = 0; supported_fx2[j].vid; j++) {
 456                         if (des.idVendor == supported_fx2[j].vid &&
 457                                 des.idProduct == supported_fx2[j].pid) {
 458                                 prof = &supported_fx2[j];
 459                         }
 460                 }
 461
 462                 /* Skip if the device was not found */
 463                 if (!prof)
 464                         continue;
 465
 466                 devcnt = g_slist_length(drvc->instances);
 467                 sdi = sr_dev_inst_new(devcnt, SR_ST_INITIALIZING,
 468                         prof->vendor, prof->model, prof->model_version);
 469                 if (!sdi)
 470                         return NULL;
 471                 sdi->driver = fdi;
 472
 473                 /* Fill in probelist according to this device's profile. */
 474                 num_logic_probes = prof->dev_caps & DEV_CAPS_16BIT ? 16 : 8;
 475                 for (j = 0; j < num_logic_probes; j++) {
 476                         if (!(probe = sr_probe_new(j, SR_PROBE_LOGIC, TRUE,
 477                                         probe_names[j])))
 478                                 return NULL;
 479                         sdi->probes = g_slist_append(sdi->probes, probe);
 480                 }
 481
 482                 devc = fx2lafw_dev_new();
 483                 devc->profile = prof;
 484                 sdi->priv = devc;
 485                 drvc->instances = g_slist_append(drvc->instances, sdi);
 486                 devices = g_slist_append(devices, sdi);
 487
 488                 if (check_conf_profile(devlist[i])) {
 489                         /* Already has the firmware, so fix the new address. */
 490                         sr_dbg("fx2lafw: Found an fx2lafw device.");
 491                         sdi->status = SR_ST_INACTIVE;
 492                         devc->usb = sr_usb_dev_inst_new
 493                             (libusb_get_bus_number(devlist[i]),
 494                              libusb_get_device_address(devlist[i]), NULL);
 495                 } else {
 496                         if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
 497                                 prof->firmware) == SR_OK)
 498                                 /* Remember when the firmware on this device was updated */
 499                                 devc->fw_updated = g_get_monotonic_time();
 500                         else
 501                                 sr_err("fx2lafw: Firmware upload failed for "
 502                                        "device %d.", devcnt);
 503                         devc->usb = sr_usb_dev_inst_new
 504                                 (libusb_get_bus_number(devlist[i]), 0xff, NULL);
 505                 }
 506         }
 507         libusb_free_device_list(devlist, 1);
 508
 509         return devices;
 510 }
 511
 512 static int hw_dev_open(struct sr_dev_inst *sdi)
 513 {
 514         struct dev_context *devc;
 515         int ret;
 516         int64_t timediff_us, timediff_ms;
 517
 518         devc = sdi->priv;
 519
 520         /*
 521          * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
 522          * milliseconds for the FX2 to renumerate.
 523          */
 524         ret = SR_ERR;
 525         if (devc->fw_updated > 0) {
 526                 sr_info("fx2lafw: Waiting for device to reset.");
 527                 /* takes at least 300ms for the FX2 to be gone from the USB bus */
 528                 g_usleep(300 * 1000);
 529                 timediff_ms = 0;
 530                 while (timediff_ms < MAX_RENUM_DELAY_MS) {
 531                         if ((ret = fx2lafw_dev_open(sdi)) == SR_OK)
 532                                 break;
 533                         g_usleep(100 * 1000);
 534
 535                         timediff_us = g_get_monotonic_time() - devc->fw_updated;
 536                         timediff_ms = timediff_us / 1000;
 537                         sr_spew("fx2lafw: waited %" PRIi64 " ms", timediff_ms);
 538                 }
 539                 sr_info("fx2lafw: Device came back after %d ms.", timediff_ms);
 540         } else {
 541                 ret = fx2lafw_dev_open(sdi);
 542         }
 543
 544         if (ret != SR_OK) {
 545                 sr_err("fx2lafw: Unable to open device.");
 546                 return SR_ERR;
 547         }
 548         devc = sdi->priv;
 549
 550         ret = libusb_claim_interface(devc->usb->devhdl, USB_INTERFACE);
 551         if (ret != 0) {
 552                 switch(ret) {
 553                 case LIBUSB_ERROR_BUSY:
 554                         sr_err("fx2lafw: Unable to claim USB interface. Another "
 555                                 "program or driver has already claimed it.");
 556                         break;
 557
 558                 case LIBUSB_ERROR_NO_DEVICE:
 559                         sr_err("fx2lafw: Device has been disconnected.");
 560                         break;
 561
 562                 default:
 563                         sr_err("fx2lafw: Unable to claim interface: %d.", ret);
 564                         break;
 565                 }
 566
 567                 return SR_ERR;
 568         }
 569
 570         if (devc->cur_samplerate == 0) {
 571                 /* Samplerate hasn't been set; default to the slowest one. */
 572                 if (hw_dev_config_set(sdi, SR_HWCAP_SAMPLERATE,
 573                     &supported_samplerates[0]) == SR_ERR)
 574                         return SR_ERR;
 575         }
 576
 577         return SR_OK;
 578 }
 579
 580 static int hw_dev_close(struct sr_dev_inst *sdi)
 581 {
 582         struct dev_context *devc;
 583
 584         devc = sdi->priv;
 585         if (devc->usb->devhdl == NULL)
 586                 return SR_ERR;
 587
 588         sr_info("fx2lafw: Closing device %d on %d.%d interface %d.",
 589                 sdi->index, devc->usb->bus, devc->usb->address, USB_INTERFACE);
 590         libusb_release_interface(devc->usb->devhdl, USB_INTERFACE);
 591         libusb_close(devc->usb->devhdl);
 592         devc->usb->devhdl = NULL;
 593         sdi->status = SR_ST_INACTIVE;
 594
 595         return SR_OK;
 596 }
 597
 598 static int hw_cleanup(void)
 599 {
 600         struct drv_context *drvc;
 601         int ret;
 602
 603         if (!(drvc = fdi->priv))
 604                 return SR_OK;
 605
 606         ret = clear_instances();
 607
 608         if (drvc->usb_context)
 609                 libusb_exit(drvc->usb_context);
 610         drvc->usb_context = NULL;
 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_PROBECONFIG) {
 671                 ret = configure_probes(devc, (GSList *) value);
 672         } else if (hwcap == SR_HWCAP_LIMIT_SAMPLES) {
 673                 devc->limit_samples = *(const uint64_t *)value;
 674                 ret = SR_OK;
 675         } else {
 676                 ret = SR_ERR;
 677         }
 678
 679         return ret;
 680 }
 681
 682 static int receive_data(int fd, int revents, void *cb_data)
 683 {
 684         struct drv_context *drvc;
 685         struct timeval tv;
 686
 687         /* Avoid compiler warnings. */
 688         (void)fd;
 689         (void)revents;
 690         (void)cb_data;
 691
 692         drvc = fdi->priv;
 693         tv.tv_sec = tv.tv_usec = 0;
 694         libusb_handle_events_timeout(drvc->usb_context, &tv);
 695
 696         return TRUE;
 697 }
 698
 699 static void abort_acquisition(struct dev_context *devc)
 700 {
 701         int i;
 702
 703         devc->num_samples = -1;
 704
 705         for (i = devc->num_transfers - 1; i >= 0; i--) {
 706                 if (devc->transfers[i])
 707                         libusb_cancel_transfer(devc->transfers[i]);
 708         }
 709 }
 710
 711 static void finish_acquisition(struct dev_context *devc)
 712 {
 713         struct drv_context *drvc;
 714         struct sr_datafeed_packet packet;
 715         int i;
 716
 717         drvc = fdi->priv;
 718
 719         /* Terminate session */
 720         packet.type = SR_DF_END;
 721         sr_session_send(devc->session_dev_id, &packet);
 722
 723         /* Remove fds from polling */
 724         const struct libusb_pollfd **const lupfd =
 725                 libusb_get_pollfds(drvc->usb_context);
 726         for (i = 0; lupfd[i]; i++)
 727                 sr_source_remove(lupfd[i]->fd);
 728         free(lupfd); /* NOT g_free()! */
 729
 730         devc->num_transfers = 0;
 731         g_free(devc->transfers);
 732 }
 733
 734 static void free_transfer(struct libusb_transfer *transfer)
 735 {
 736         struct dev_context *devc = transfer->user_data;
 737         unsigned int i;
 738
 739         g_free(transfer->buffer);
 740         transfer->buffer = NULL;
 741         libusb_free_transfer(transfer);
 742
 743         for (i = 0; i < devc->num_transfers; i++) {
 744                 if (devc->transfers[i] == transfer) {
 745                         devc->transfers[i] = NULL;
 746                         break;
 747                 }
 748         }
 749
 750         devc->submitted_transfers--;
 751         if (devc->submitted_transfers == 0)
 752                 finish_acquisition(devc);
 753
 754 }
 755
 756 static void resubmit_transfer(struct libusb_transfer *transfer)
 757 {
 758         if (libusb_submit_transfer(transfer) != 0) {
 759                 free_transfer(transfer);
 760                 /* TODO: Stop session? */
 761                 /* TODO: Better error message. */
 762                 sr_err("fx2lafw: %s: libusb_submit_transfer error.", __func__);
 763         }
 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 = transfer->user_data;
 772         int trigger_offset, i;
 773
 774         /*
 775          * If acquisition has already ended, just free any queued up
 776          * transfer that come in.
 777          */
 778         if (devc->num_samples == -1) {
 779                 free_transfer(transfer);
 780                 return;
 781         }
 782
 783         sr_info("fx2lafw: receive_transfer(): status %d received %d bytes.",
 784                 transfer->status, transfer->actual_length);
 785
 786         /* Save incoming transfer before reusing the transfer struct. */
 787         uint8_t *const cur_buf = transfer->buffer;
 788         const int sample_width = devc->sample_wide ? 2 : 1;
 789         const int cur_sample_count = transfer->actual_length / sample_width;
 790
 791         switch (transfer->status) {
 792         case LIBUSB_TRANSFER_NO_DEVICE:
 793                 abort_acquisition(devc);
 794                 free_transfer(transfer);
 795                 return;
 796         case LIBUSB_TRANSFER_COMPLETED:
 797         case LIBUSB_TRANSFER_TIMED_OUT: /* We may have received some data though */
 798                 break;
 799         default:
 800                 packet_has_error = TRUE;
 801                 break;
 802         }
 803
 804         if (transfer->actual_length == 0 || packet_has_error) {
 805                 devc->empty_transfer_count++;
 806                 if (devc->empty_transfer_count > MAX_EMPTY_TRANSFERS) {
 807                         /*
 808                          * The FX2 gave up. End the acquisition, the frontend
 809                          * will work out that the samplecount is short.
 810                          */
 811                         abort_acquisition(devc);
 812                         free_transfer(transfer);
 813                 } else {
 814                         resubmit_transfer(transfer);
 815                 }
 816                 return;
 817         } else {
 818                 devc->empty_transfer_count = 0;
 819         }
 820
 821         trigger_offset = 0;
 822         if (devc->trigger_stage >= 0) {
 823                 for (i = 0; i < cur_sample_count; i++) {
 824
 825                         const uint16_t cur_sample = devc->sample_wide ?
 826                                 *((const uint16_t*)cur_buf + i) :
 827                                 *((const uint8_t*)cur_buf + i);
 828
 829                         if ((cur_sample & devc->trigger_mask[devc->trigger_stage]) ==
 830                                 devc->trigger_value[devc->trigger_stage]) {
 831                                 /* Match on this trigger stage. */
 832                                 devc->trigger_buffer[devc->trigger_stage] = cur_sample;
 833                                 devc->trigger_stage++;
 834
 835                                 if (devc->trigger_stage == NUM_TRIGGER_STAGES ||
 836                                         devc->trigger_mask[devc->trigger_stage] == 0) {
 837                                         /* Match on all trigger stages, we're done. */
 838                                         trigger_offset = i + 1;
 839
 840                                         /*
 841                                          * TODO: Send pre-trigger buffer to session bus.
 842                                          * Tell the frontend we hit the trigger here.
 843                                          */
 844                                         packet.type = SR_DF_TRIGGER;
 845                                         packet.payload = NULL;
 846                                         sr_session_send(devc->session_dev_id, &packet);
 847
 848                                         /*
 849                                          * Send the samples that triggered it, since we're
 850                                          * skipping past them.
 851                                          */
 852                                         packet.type = SR_DF_LOGIC;
 853                                         packet.payload = &logic;
 854                                         logic.unitsize = sizeof(*devc->trigger_buffer);
 855                                         logic.length = devc->trigger_stage * logic.unitsize;
 856                                         logic.data = devc->trigger_buffer;
 857                                         sr_session_send(devc->session_dev_id, &packet);
 858
 859                                         devc->trigger_stage = TRIGGER_FIRED;
 860                                         break;
 861                                 }
 862                         } else if (devc->trigger_stage > 0) {
 863                                 /*
 864                                  * We had a match before, but not in the next sample. However, we may
 865                                  * have a match on this stage in the next bit -- trigger on 0001 will
 866                                  * fail on seeing 00001, so we need to go back to stage 0 -- but at
 867                                  * the next sample from the one that matched originally, which the
 868                                  * counter increment at the end of the loop takes care of.
 869                                  */
 870                                 i -= devc->trigger_stage;
 871                                 if (i < -1)
 872                                         i = -1; /* Oops, went back past this buffer. */
 873                                 /* Reset trigger stage. */
 874                                 devc->trigger_stage = 0;
 875                         }
 876                 }
 877         }
 878
 879         if (devc->trigger_stage == TRIGGER_FIRED) {
 880                 /* Send the incoming transfer to the session bus. */
 881                 const int trigger_offset_bytes = trigger_offset * sample_width;
 882                 packet.type = SR_DF_LOGIC;
 883                 packet.payload = &logic;
 884                 logic.length = transfer->actual_length - trigger_offset_bytes;
 885                 logic.unitsize = sample_width;
 886                 logic.data = cur_buf + trigger_offset_bytes;
 887                 sr_session_send(devc->session_dev_id, &packet);
 888
 889                 devc->num_samples += cur_sample_count;
 890                 if (devc->limit_samples &&
 891                         (unsigned int)devc->num_samples > devc->limit_samples) {
 892                         abort_acquisition(devc);
 893                         free_transfer(transfer);
 894                         return;
 895                 }
 896         } else {
 897                 /*
 898                  * TODO: Buffer pre-trigger data in capture
 899                  * ratio-sized buffer.
 900                  */
 901         }
 902
 903         resubmit_transfer(transfer);
 904 }
 905
 906 static unsigned int to_bytes_per_ms(unsigned int samplerate)
 907 {
 908         return samplerate / 1000;
 909 }
 910
 911 static size_t get_buffer_size(struct dev_context *devc)
 912 {
 913         size_t s;
 914
 915         /* The buffer should be large enough to hold 10ms of data and a multiple
 916          * of 512. */
 917         s = 10 * to_bytes_per_ms(devc->cur_samplerate);
 918         return (s + 511) & ~511;
 919 }
 920
 921 static unsigned int get_number_of_transfers(struct dev_context *devc)
 922 {
 923         unsigned int n;
 924
 925         /* Total buffer size should be able to hold about 500ms of data */
 926         n = 500 * to_bytes_per_ms(devc->cur_samplerate) / get_buffer_size(devc);
 927
 928         if (n > NUM_SIMUL_TRANSFERS)
 929                 return NUM_SIMUL_TRANSFERS;
 930
 931         return n;
 932 }
 933
 934 static unsigned int get_timeout(struct dev_context *devc)
 935 {
 936         size_t total_size;
 937         unsigned int timeout;
 938
 939         total_size = get_buffer_size(devc) * get_number_of_transfers(devc);
 940         timeout = total_size / to_bytes_per_ms(devc->cur_samplerate);
 941         return timeout + timeout / 4; /* Leave a headroom of 25% percent */
 942 }
 943
 944 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
 945                 void *cb_data)
 946 {
 947         struct sr_datafeed_packet packet;
 948         struct sr_datafeed_header header;
 949         struct sr_datafeed_meta_logic meta;
 950         struct drv_context *drvc;
 951         struct dev_context *devc;
 952         struct libusb_transfer *transfer;
 953         const struct libusb_pollfd **lupfd;
 954         unsigned int i;
 955         int ret;
 956         unsigned char *buf;
 957
 958         drvc = fdi->priv;
 959         devc = sdi->priv;
 960         if (devc->submitted_transfers != 0)
 961                 return SR_ERR;
 962
 963         devc->session_dev_id = cb_data;
 964         devc->num_samples = 0;
 965         devc->empty_transfer_count = 0;
 966
 967         const unsigned int timeout = get_timeout(devc);
 968         const unsigned int num_transfers = get_number_of_transfers(devc);
 969         const size_t size = get_buffer_size(devc);
 970
 971         devc->transfers = g_try_malloc0(sizeof(*devc->transfers) * num_transfers);
 972         if (!devc->transfers)
 973                 return SR_ERR;
 974
 975         devc->num_transfers = num_transfers;
 976
 977         for (i = 0; i < num_transfers; i++) {
 978                 if (!(buf = g_try_malloc(size))) {
 979                         sr_err("fx2lafw: %s: buf malloc failed.", __func__);
 980                         return SR_ERR_MALLOC;
 981                 }
 982                 transfer = libusb_alloc_transfer(0);
 983                 libusb_fill_bulk_transfer(transfer, devc->usb->devhdl,
 984                                 2 | LIBUSB_ENDPOINT_IN, buf, size,
 985                                 receive_transfer, devc, timeout);
 986                 if (libusb_submit_transfer(transfer) != 0) {
 987                         libusb_free_transfer(transfer);
 988                         g_free(buf);
 989                         abort_acquisition(devc);
 990                         return SR_ERR;
 991                 }
 992                 devc->transfers[i] = transfer;
 993                 devc->submitted_transfers++;
 994         }
 995
 996         lupfd = libusb_get_pollfds(drvc->usb_context);
 997         for (i = 0; lupfd[i]; i++)
 998                 sr_source_add(lupfd[i]->fd, lupfd[i]->events,
 999                               timeout, receive_data, NULL);
1000         free(lupfd); /* NOT g_free()! */
1001
1002         packet.type = SR_DF_HEADER;
1003         packet.payload = &header;
1004         header.feed_version = 1;
1005         gettimeofday(&header.starttime, NULL);
1006         sr_session_send(cb_data, &packet);
1007
1008         /* Send metadata about the SR_DF_LOGIC packets to come. */
1009         packet.type = SR_DF_META_LOGIC;
1010         packet.payload = &meta;
1011         meta.samplerate = devc->cur_samplerate;
1012         meta.num_probes = devc->sample_wide ? 16 : 8;
1013         sr_session_send(cb_data, &packet);
1014
1015         if ((ret = command_start_acquisition (devc->usb->devhdl,
1016                 devc->cur_samplerate, devc->sample_wide)) != SR_OK) {
1017                 abort_acquisition(devc);
1018                 return ret;
1019         }
1020
1021         return SR_OK;
1022 }
1023
1024 /* TODO: This stops acquisition on ALL devices, ignoring dev_index. */
1025 static int hw_dev_acquisition_stop(const struct sr_dev_inst *sdi,
1026                 void *cb_data)
1027 {
1028
1029         /* Avoid compiler warnings. */
1030         (void)cb_data;
1031
1032         abort_acquisition(sdi->priv);
1033
1034         return SR_OK;
1035 }
1036
1037 SR_PRIV struct sr_dev_driver fx2lafw_driver_info = {
1038         .name = "fx2lafw",
1039         .longname = "fx2lafw (generic driver for FX2 based LAs)",
1040         .api_version = 1,
1041         .init = hw_init,
1042         .cleanup = hw_cleanup,
1043         .scan = hw_scan,
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 };