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