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