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