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                 sdi = l->data;
 389                 sr_dev_inst_free(sdi);
 390         }
 391
 392         g_slist_free(drvc->instances);
 393         drvc->instances = NULL;
 394
 395         return ret;
 396 }
 397
 398
 399 /*
 400  * API callbacks
 401  */
 402
 403 static int hw_init(void)
 404 {
 405         struct drv_context *drvc;
 406
 407         if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
 408                 sr_err("fx2lafw: driver context malloc failed.");
 409                 return SR_ERR;
 410         }
 411
 412         if (libusb_init(&drvc->usb_context) != 0) {
 413                 g_free(drvc);
 414                 sr_warn("fx2lafw: Failed to initialize libusb.");
 415                 return SR_ERR;
 416         }
 417
 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         /* Avoid compiler warnings. */
 436         (void)options;
 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(drvc->usb_context, &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 int hw_dev_open(struct sr_dev_inst *sdi)
 512 {
 513         struct dev_context *devc;
 514         int ret;
 515         int64_t timediff_us, timediff_ms;
 516
 517         devc = sdi->priv;
 518
 519         /*
 520          * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
 521          * milliseconds for the FX2 to renumerate.
 522          */
 523         ret = SR_ERR;
 524         if (devc->fw_updated > 0) {
 525                 sr_info("fx2lafw: Waiting for device to reset.");
 526                 /* takes at least 300ms for the FX2 to be gone from the USB bus */
 527                 g_usleep(300 * 1000);
 528                 timediff_ms = 0;
 529                 while (timediff_ms < MAX_RENUM_DELAY_MS) {
 530                         if ((ret = fx2lafw_dev_open(sdi)) == SR_OK)
 531                                 break;
 532                         g_usleep(100 * 1000);
 533
 534                         timediff_us = g_get_monotonic_time() - devc->fw_updated;
 535                         timediff_ms = timediff_us / 1000;
 536                         sr_spew("fx2lafw: waited %" PRIi64 " ms", timediff_ms);
 537                 }
 538                 sr_info("fx2lafw: Device came back after %d ms.", timediff_ms);
 539         } else {
 540                 ret = fx2lafw_dev_open(sdi);
 541         }
 542
 543         if (ret != SR_OK) {
 544                 sr_err("fx2lafw: Unable to open device.");
 545                 return SR_ERR;
 546         }
 547         devc = sdi->priv;
 548
 549         ret = libusb_claim_interface(devc->usb->devhdl, USB_INTERFACE);
 550         if (ret != 0) {
 551                 switch(ret) {
 552                 case LIBUSB_ERROR_BUSY:
 553                         sr_err("fx2lafw: Unable to claim USB interface. Another "
 554                                 "program or driver has already claimed it.");
 555                         break;
 556
 557                 case LIBUSB_ERROR_NO_DEVICE:
 558                         sr_err("fx2lafw: Device has been disconnected.");
 559                         break;
 560
 561                 default:
 562                         sr_err("fx2lafw: Unable to claim interface: %d.", ret);
 563                         break;
 564                 }
 565
 566                 return SR_ERR;
 567         }
 568
 569         if (devc->cur_samplerate == 0) {
 570                 /* Samplerate hasn't been set; default to the slowest one. */
 571                 if (hw_dev_config_set(sdi, SR_HWCAP_SAMPLERATE,
 572                     &supported_samplerates[0]) == SR_ERR)
 573                         return SR_ERR;
 574         }
 575
 576         return SR_OK;
 577 }
 578
 579 static int hw_dev_close(struct sr_dev_inst *sdi)
 580 {
 581         struct dev_context *devc;
 582
 583         devc = sdi->priv;
 584         if (devc->usb->devhdl == NULL)
 585                 return SR_ERR;
 586
 587         sr_info("fx2lafw: Closing device %d on %d.%d interface %d.",
 588                 sdi->index, devc->usb->bus, devc->usb->address, USB_INTERFACE);
 589         libusb_release_interface(devc->usb->devhdl, USB_INTERFACE);
 590         libusb_close(devc->usb->devhdl);
 591         devc->usb->devhdl = NULL;
 592         sdi->status = SR_ST_INACTIVE;
 593
 594         return SR_OK;
 595 }
 596
 597 static int hw_cleanup(void)
 598 {
 599         struct drv_context *drvc;
 600         int ret;
 601
 602         if (!(drvc = fdi->priv))
 603                 return SR_OK;
 604
 605         ret = clear_instances();
 606
 607         if (drvc->usb_context)
 608                 libusb_exit(drvc->usb_context);
 609         drvc->usb_context = NULL;
 610
 611         g_free(drvc);
 612         fdi->priv = NULL;
 613
 614         return ret;
 615 }
 616
 617 static int hw_info_get(int info_id, const void **data,
 618                 const struct sr_dev_inst *sdi)
 619 {
 620         struct dev_context *devc;
 621
 622         switch (info_id) {
 623         case SR_DI_HWCAPS:
 624                 *data = hwcaps;
 625                 break;
 626         case SR_DI_NUM_PROBES:
 627                 if (sdi) {
 628                         devc = sdi->priv;
 629                         *data = GINT_TO_POINTER(
 630                                 (devc->profile->dev_caps & DEV_CAPS_16BIT) ?
 631                                 16 : 8);
 632                 } else
 633                         return SR_ERR;
 634                 break;
 635         case SR_DI_PROBE_NAMES:
 636                 *data = probe_names;
 637                 break;
 638         case SR_DI_SAMPLERATES:
 639                 *data = &samplerates;
 640                 break;
 641         case SR_DI_TRIGGER_TYPES:
 642                 *data = TRIGGER_TYPES;
 643                 break;
 644         case SR_DI_CUR_SAMPLERATE:
 645                 if (sdi) {
 646                         devc = sdi->priv;
 647                         *data = &devc->cur_samplerate;
 648                 } else
 649                         return SR_ERR;
 650                 break;
 651         default:
 652                 return SR_ERR_ARG;
 653         }
 654
 655         return SR_OK;
 656 }
 657
 658 static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
 659                 const void *value)
 660 {
 661         struct dev_context *devc;
 662         int ret;
 663
 664         devc = sdi->priv;
 665
 666         if (hwcap == SR_HWCAP_SAMPLERATE) {
 667                 devc->cur_samplerate = *(const uint64_t *)value;
 668                 ret = SR_OK;
 669         } else if (hwcap == SR_HWCAP_PROBECONFIG) {
 670                 ret = configure_probes(devc, (GSList *) value);
 671         } else if (hwcap == SR_HWCAP_LIMIT_SAMPLES) {
 672                 devc->limit_samples = *(const uint64_t *)value;
 673                 ret = SR_OK;
 674         } else {
 675                 ret = SR_ERR;
 676         }
 677
 678         return ret;
 679 }
 680
 681 static int receive_data(int fd, int revents, void *cb_data)
 682 {
 683         struct drv_context *drvc;
 684         struct timeval tv;
 685
 686         /* Avoid compiler warnings. */
 687         (void)fd;
 688         (void)revents;
 689         (void)cb_data;
 690
 691         drvc = fdi->priv;
 692         tv.tv_sec = tv.tv_usec = 0;
 693         libusb_handle_events_timeout(drvc->usb_context, &tv);
 694
 695         return TRUE;
 696 }
 697
 698 static void abort_acquisition(struct dev_context *devc)
 699 {
 700         int i;
 701
 702         devc->num_samples = -1;
 703
 704         for (i = devc->num_transfers - 1; i >= 0; i--) {
 705                 if (devc->transfers[i])
 706                         libusb_cancel_transfer(devc->transfers[i]);
 707         }
 708 }
 709
 710 static void finish_acquisition(struct dev_context *devc)
 711 {
 712         struct drv_context *drvc;
 713         struct sr_datafeed_packet packet;
 714         int i;
 715
 716         drvc = fdi->priv;
 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(drvc->usb_context);
 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 drv_context *drvc;
 950         struct dev_context *devc;
 951         struct libusb_transfer *transfer;
 952         const struct libusb_pollfd **lupfd;
 953         unsigned int i;
 954         int ret;
 955         unsigned char *buf;
 956
 957         drvc = fdi->priv;
 958         devc = sdi->priv;
 959         if (devc->submitted_transfers != 0)
 960                 return SR_ERR;
 961
 962         devc->session_dev_id = cb_data;
 963         devc->num_samples = 0;
 964         devc->empty_transfer_count = 0;
 965
 966         const unsigned int timeout = get_timeout(devc);
 967         const unsigned int num_transfers = get_number_of_transfers(devc);
 968         const size_t size = get_buffer_size(devc);
 969
 970         devc->transfers = g_try_malloc0(sizeof(*devc->transfers) * num_transfers);
 971         if (!devc->transfers)
 972                 return SR_ERR;
 973
 974         devc->num_transfers = num_transfers;
 975
 976         for (i = 0; i < num_transfers; i++) {
 977                 if (!(buf = g_try_malloc(size))) {
 978                         sr_err("fx2lafw: %s: buf malloc failed.", __func__);
 979                         return SR_ERR_MALLOC;
 980                 }
 981                 transfer = libusb_alloc_transfer(0);
 982                 libusb_fill_bulk_transfer(transfer, devc->usb->devhdl,
 983                                 2 | LIBUSB_ENDPOINT_IN, buf, size,
 984                                 receive_transfer, devc, timeout);
 985                 if (libusb_submit_transfer(transfer) != 0) {
 986                         libusb_free_transfer(transfer);
 987                         g_free(buf);
 988                         abort_acquisition(devc);
 989                         return SR_ERR;
 990                 }
 991                 devc->transfers[i] = transfer;
 992                 devc->submitted_transfers++;
 993         }
 994
 995         lupfd = libusb_get_pollfds(drvc->usb_context);
 996         for (i = 0; lupfd[i]; i++)
 997                 sr_source_add(lupfd[i]->fd, lupfd[i]->events,
 998                               timeout, receive_data, NULL);
 999         free(lupfd); /* NOT g_free()! */
1000
1001         packet.type = SR_DF_HEADER;
1002         packet.payload = &header;
1003         header.feed_version = 1;
1004         gettimeofday(&header.starttime, NULL);
1005         sr_session_send(cb_data, &packet);
1006
1007         /* Send metadata about the SR_DF_LOGIC packets to come. */
1008         packet.type = SR_DF_META_LOGIC;
1009         packet.payload = &meta;
1010         meta.samplerate = devc->cur_samplerate;
1011         meta.num_probes = devc->sample_wide ? 16 : 8;
1012         sr_session_send(cb_data, &packet);
1013
1014         if ((ret = command_start_acquisition (devc->usb->devhdl,
1015                 devc->cur_samplerate, devc->sample_wide)) != SR_OK) {
1016                 abort_acquisition(devc);
1017                 return ret;
1018         }
1019
1020         return SR_OK;
1021 }
1022
1023 /* TODO: This stops acquisition on ALL devices, ignoring dev_index. */
1024 static int hw_dev_acquisition_stop(const struct sr_dev_inst *sdi,
1025                 void *cb_data)
1026 {
1027
1028         /* Avoid compiler warnings. */
1029         (void)cb_data;
1030
1031         abort_acquisition(sdi->priv);
1032
1033         return SR_OK;
1034 }
1035
1036 SR_PRIV struct sr_dev_driver fx2lafw_driver_info = {
1037         .name = "fx2lafw",
1038         .longname = "fx2lafw (generic driver for FX2 based LAs)",
1039         .api_version = 1,
1040         .init = hw_init,
1041         .cleanup = hw_cleanup,
1042         .scan = hw_scan,
1043         .dev_open = hw_dev_open,
1044         .dev_close = hw_dev_close,
1045         .info_get = hw_info_get,
1046         .dev_config_set = hw_dev_config_set,
1047         .dev_acquisition_start = hw_dev_acquisition_start,
1048         .dev_acquisition_stop = hw_dev_acquisition_stop,
1049         .priv = NULL,
1050 };