hardware/fx2lafw/fx2lafw.c

   1 /*
   2  * This file is part of the sigrok project.
   3  *
   4  * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
   5  * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation, either version 3 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21 #include <stdio.h>
  22 #include <stdlib.h>
  23 #include <string.h>
  24 #include <inttypes.h>
  25 #include <libusb.h>
  26 #include "libsigrok.h"
  27 #include "libsigrok-internal.h"
  28 #include "fx2lafw.h"
  29 #include "command.h"
  30
  31 static const struct fx2lafw_profile supported_fx2[] = {
  32         /*
  33          * CWAV USBee AX
  34          * EE Electronics ESLA201A
  35          * ARMFLY AX-Pro
  36          */
  37         { 0x08a9, 0x0014, "CWAV", "USBee AX", NULL,
  38                 FIRMWARE_DIR "/fx2lafw-cwav-usbeeax.fw",
  39                 0 },
  40         /*
  41          * CWAV USBee DX
  42          * XZL-Studio DX
  43          */
  44         { 0x08a9, 0x0015, "CWAV", "USBee DX", NULL,
  45                 FIRMWARE_DIR "/fx2lafw-cwav-usbeedx.fw",
  46                 DEV_CAPS_16BIT },
  47
  48         /*
  49          * CWAV USBee SX
  50          */
  51         { 0x08a9, 0x0009, "CWAV", "USBee SX", NULL,
  52                 FIRMWARE_DIR "/fx2lafw-cwav-usbeesx.fw",
  53                 0 },
  54
  55         /*
  56          * Saleae Logic
  57          * EE Electronics ESLA100
  58          * Robomotic MiniLogic
  59          * Robomotic BugLogic 3
  60          */
  61         { 0x0925, 0x3881, "Saleae", "Logic", NULL,
  62                 FIRMWARE_DIR "/fx2lafw-saleae-logic.fw",
  63                 0 },
  64
  65         /*
  66          * Default Cypress FX2 without EEPROM, e.g.:
  67          * Lcsoft Mini Board
  68          * Braintechnology USB Interface V2.x
  69          */
  70         { 0x04B4, 0x8613, "Cypress", "FX2", NULL,
  71                 FIRMWARE_DIR "/fx2lafw-cypress-fx2.fw",
  72                 DEV_CAPS_16BIT },
  73
  74         /*
  75          * Braintechnology USB-LPS
  76          */
  77         { 0x16d0, 0x0498, "Braintechnology", "USB-LPS", NULL,
  78                 FIRMWARE_DIR "/fx2lafw-braintechnology-usb-lps.fw",
  79                 DEV_CAPS_16BIT },
  80
  81         { 0, 0, 0, 0, 0, 0, 0 }
  82 };
  83
  84 static const int hwcaps[] = {
  85         SR_HWCAP_LOGIC_ANALYZER,
  86         SR_HWCAP_SAMPLERATE,
  87
  88         /* These are really implemented in the driver, not the hardware. */
  89         SR_HWCAP_LIMIT_SAMPLES,
  90         SR_HWCAP_CONTINUOUS,
  91         0,
  92 };
  93
  94 static const char *probe_names[] = {
  95         "0",
  96         "1",
  97         "2",
  98         "3",
  99         "4",
 100         "5",
 101         "6",
 102         "7",
 103         "8",
 104         "9",
 105         "10",
 106         "11",
 107         "12",
 108         "13",
 109         "14",
 110         "15",
 111         NULL,
 112 };
 113
 114 static const uint64_t supported_samplerates[] = {
 115         SR_KHZ(20),
 116         SR_KHZ(25),
 117         SR_KHZ(50),
 118         SR_KHZ(100),
 119         SR_KHZ(200),
 120         SR_KHZ(250),
 121         SR_KHZ(500),
 122         SR_MHZ(1),
 123         SR_MHZ(2),
 124         SR_MHZ(3),
 125         SR_MHZ(4),
 126         SR_MHZ(6),
 127         SR_MHZ(8),
 128         SR_MHZ(12),
 129         SR_MHZ(16),
 130         SR_MHZ(24),
 131         0,
 132 };
 133
 134 static const struct sr_samplerates samplerates = {
 135         0,
 136         0,
 137         0,
 138         supported_samplerates,
 139 };
 140
 141 SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
 142 static struct sr_dev_driver *fdi = &fx2lafw_driver_info;
 143 static int hw_dev_close(struct sr_dev_inst *sdi);
 144 static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
 145                 const void *value);
 146 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data);
 147
 148 /**
 149  * Check the USB configuration to determine if this is an fx2lafw device.
 150  *
 151  * @return TRUE if the device's configuration profile match fx2lafw
 152  *         configuration, FALSE otherwise.
 153  */
 154 static gboolean check_conf_profile(libusb_device *dev)
 155 {
 156         struct libusb_device_descriptor des;
 157         struct libusb_device_handle *hdl;
 158         gboolean ret;
 159         unsigned char strdesc[64];
 160
 161         hdl = NULL;
 162         ret = FALSE;
 163         while (!ret) {
 164                 /* Assume the FW has not been loaded, unless proven wrong. */
 165                 if (libusb_get_device_descriptor(dev, &des) != 0)
 166                         break;
 167
 168                 if (libusb_open(dev, &hdl) != 0)
 169                         break;
 170
 171                 if (libusb_get_string_descriptor_ascii(hdl,
 172                                 des.iManufacturer, strdesc, sizeof(strdesc)) < 0)
 173                         break;
 174                 if (strncmp((const char *)strdesc, "sigrok", 6))
 175                         break;
 176
 177                 if (libusb_get_string_descriptor_ascii(hdl,
 178                                 des.iProduct, strdesc, sizeof(strdesc)) < 0)
 179                         break;
 180                 if (strncmp((const char *)strdesc, "fx2lafw", 7))
 181                         break;
 182
 183                 /* If we made it here, it must be an fx2lafw. */
 184                 ret = TRUE;
 185         }
 186         if (hdl)
 187                 libusb_close(hdl);
 188
 189         return ret;
 190 }
 191
 192 static int fx2lafw_dev_open(struct sr_dev_inst *sdi)
 193 {
 194         libusb_device **devlist;
 195         struct libusb_device_descriptor des;
 196         struct dev_context *devc;
 197         struct drv_context *drvc = fdi->priv;
 198         struct version_info vi;
 199         int ret, skip, i;
 200         uint8_t revid;
 201
 202         devc = sdi->priv;
 203
 204         if (sdi->status == SR_ST_ACTIVE)
 205                 /* already in use */
 206                 return SR_ERR;
 207
 208         skip = 0;
 209         const int device_count = libusb_get_device_list(
 210                 drvc->sr_ctx->libusb_ctx, &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: %s.",
 220                                libusb_error_name(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: %s.",
 254                                libusb_error_name(ret));
 255                         break;
 256                 }
 257
 258                 ret = command_get_fw_version(devc->usb->devhdl, &vi);
 259                 if (ret != SR_OK) {
 260                         sr_err("fx2lafw: Failed to retrieve "
 261                                "firmware version information.");
 262                         break;
 263                 }
 264
 265                 ret = command_get_revid_version(devc->usb->devhdl, &revid);
 266                 if (ret != SR_OK) {
 267                         sr_err("fx2lafw: Failed to retrieve REVID.");
 268                         break;
 269                 }
 270
 271                 /*
 272                  * Changes in major version mean incompatible/API changes, so
 273                  * bail out if we encounter an incompatible version.
 274                  * Different minor versions are OK, they should be compatible.
 275                  */
 276                 if (vi.major != FX2LAFW_REQUIRED_VERSION_MAJOR) {
 277                         sr_err("fx2lafw: Expected firmware version %d.x, "
 278                                "got %d.%d.", FX2LAFW_REQUIRED_VERSION_MAJOR,
 279                                vi.major, vi.minor);
 280                         break;
 281                 }
 282
 283                 sdi->status = SR_ST_ACTIVE;
 284                 sr_info("fx2lafw: Opened device %d on %d.%d "
 285                         "interface %d, firmware %d.%d, REVID %d.",
 286                         sdi->index, devc->usb->bus, devc->usb->address,
 287                         USB_INTERFACE, vi.major, vi.minor, revid);
 288
 289                 break;
 290         }
 291         libusb_free_device_list(devlist, 1);
 292
 293         if (sdi->status != SR_ST_ACTIVE)
 294                 return SR_ERR;
 295
 296         return SR_OK;
 297 }
 298
 299 static int configure_probes(const struct sr_dev_inst *sdi)
 300 {
 301         struct dev_context *devc;
 302         struct sr_probe *probe;
 303         GSList *l;
 304         int probe_bit, stage, i;
 305         char *tc;
 306
 307         devc = sdi->priv;
 308         for (i = 0; i < NUM_TRIGGER_STAGES; i++) {
 309                 devc->trigger_mask[i] = 0;
 310                 devc->trigger_value[i] = 0;
 311         }
 312
 313         stage = -1;
 314         for (l = sdi->probes; l; l = l->next) {
 315                 probe = (struct sr_probe *)l->data;
 316                 if (probe->enabled == FALSE)
 317                         continue;
 318
 319                 if (probe->index > 7)
 320                         devc->sample_wide = TRUE;
 321
 322                 probe_bit = 1 << (probe->index);
 323                 if (!(probe->trigger))
 324                         continue;
 325
 326                 stage = 0;
 327                 for (tc = probe->trigger; *tc; tc++) {
 328                         devc->trigger_mask[stage] |= probe_bit;
 329                         if (*tc == '1')
 330                                 devc->trigger_value[stage] |= probe_bit;
 331                         stage++;
 332                         if (stage > NUM_TRIGGER_STAGES)
 333                                 return SR_ERR;
 334                 }
 335         }
 336
 337         if (stage == -1)
 338                 /*
 339                  * We didn't configure any triggers, make sure acquisition
 340                  * doesn't wait for any.
 341                  */
 342                 devc->trigger_stage = TRIGGER_FIRED;
 343         else
 344                 devc->trigger_stage = 0;
 345
 346         return SR_OK;
 347 }
 348
 349 static struct dev_context *fx2lafw_dev_new(void)
 350 {
 351         struct dev_context *devc;
 352
 353         if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
 354                 sr_err("fx2lafw: %s: devc malloc failed.", __func__);
 355                 return NULL;
 356         }
 357
 358         devc->trigger_stage = TRIGGER_FIRED;
 359
 360         return devc;
 361 }
 362
 363 static int clear_instances(void)
 364 {
 365         GSList *l;
 366         struct sr_dev_inst *sdi;
 367         struct drv_context *drvc;
 368         struct dev_context *devc;
 369         int ret;
 370
 371         drvc = fdi->priv;
 372         ret = SR_OK;
 373         for (l = drvc->instances; l; l = l->next) {
 374                 if (!(sdi = l->data)) {
 375                         /* Log error, but continue cleaning up the rest. */
 376                         sr_err("fx2lafw: %s: sdi was NULL, continuing.",
 377                                    __func__);
 378                         ret = SR_ERR_BUG;
 379                         continue;
 380                 }
 381                 if (!(devc = sdi->priv)) {
 382                         /* Log error, but continue cleaning up the rest. */
 383                         sr_err("fx2lafw: %s: sdi->priv was NULL, continuing",
 384                                    __func__);
 385                         ret = SR_ERR_BUG;
 386                         continue;
 387                 }
 388                 hw_dev_close(sdi);
 389                 sr_usb_dev_inst_free(devc->usb);
 390                 sdi = l->data;
 391                 sr_dev_inst_free(sdi);
 392         }
 393
 394         g_slist_free(drvc->instances);
 395         drvc->instances = NULL;
 396
 397         return ret;
 398 }
 399
 400
 401 /*
 402  * API callbacks
 403  */
 404
 405 static int hw_init(struct sr_context *sr_ctx)
 406 {
 407         struct drv_context *drvc;
 408
 409         if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
 410                 sr_err("fx2lafw: driver context malloc failed.");
 411                 return SR_ERR_MALLOC;
 412         }
 413
 414         drvc->sr_ctx = sr_ctx;
 415         fdi->priv = drvc;
 416
 417         return SR_OK;
 418 }
 419
 420 static GSList *hw_scan(GSList *options)
 421 {
 422         GSList *devices;
 423         struct libusb_device_descriptor des;
 424         struct sr_dev_inst *sdi;
 425         const struct fx2lafw_profile *prof;
 426         struct drv_context *drvc;
 427         struct dev_context *devc;
 428         struct sr_probe *probe;
 429         libusb_device **devlist;
 430         int devcnt, num_logic_probes, ret, i, j;
 431
 432         (void)options;
 433
 434         drvc = fdi->priv;
 435
 436         /* This scan always invalidates any previous scans. */
 437         clear_instances();
 438
 439         /* Find all fx2lafw compatible devices and upload firmware to them. */
 440         devices = NULL;
 441         libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
 442         for (i = 0; devlist[i]; i++) {
 443
 444                 if ((ret = libusb_get_device_descriptor(
 445                      devlist[i], &des)) != 0) {
 446                         sr_warn("fx2lafw: Failed to get device descriptor: %s.",
 447                                 libusb_error_name(ret));
 448                         continue;
 449                 }
 450
 451                 prof = NULL;
 452                 for (j = 0; supported_fx2[j].vid; j++) {
 453                         if (des.idVendor == supported_fx2[j].vid &&
 454                                 des.idProduct == supported_fx2[j].pid) {
 455                                 prof = &supported_fx2[j];
 456                         }
 457                 }
 458
 459                 /* Skip if the device was not found */
 460                 if (!prof)
 461                         continue;
 462
 463                 devcnt = g_slist_length(drvc->instances);
 464                 sdi = sr_dev_inst_new(devcnt, SR_ST_INITIALIZING,
 465                         prof->vendor, prof->model, prof->model_version);
 466                 if (!sdi)
 467                         return NULL;
 468                 sdi->driver = fdi;
 469
 470                 /* Fill in probelist according to this device's profile. */
 471                 num_logic_probes = prof->dev_caps & DEV_CAPS_16BIT ? 16 : 8;
 472                 for (j = 0; j < num_logic_probes; j++) {
 473                         if (!(probe = sr_probe_new(j, SR_PROBE_LOGIC, TRUE,
 474                                         probe_names[j])))
 475                                 return NULL;
 476                         sdi->probes = g_slist_append(sdi->probes, probe);
 477                 }
 478
 479                 devc = fx2lafw_dev_new();
 480                 devc->profile = prof;
 481                 sdi->priv = devc;
 482                 drvc->instances = g_slist_append(drvc->instances, sdi);
 483                 devices = g_slist_append(devices, sdi);
 484
 485                 if (check_conf_profile(devlist[i])) {
 486                         /* Already has the firmware, so fix the new address. */
 487                         sr_dbg("fx2lafw: Found an fx2lafw device.");
 488                         sdi->status = SR_ST_INACTIVE;
 489                         devc->usb = sr_usb_dev_inst_new
 490                             (libusb_get_bus_number(devlist[i]),
 491                              libusb_get_device_address(devlist[i]), NULL);
 492                 } else {
 493                         if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
 494                                 prof->firmware) == SR_OK)
 495                                 /* Remember when the firmware on this device was updated */
 496                                 devc->fw_updated = g_get_monotonic_time();
 497                         else
 498                                 sr_err("fx2lafw: Firmware upload failed for "
 499                                        "device %d.", devcnt);
 500                         devc->usb = sr_usb_dev_inst_new
 501                                 (libusb_get_bus_number(devlist[i]), 0xff, NULL);
 502                 }
 503         }
 504         libusb_free_device_list(devlist, 1);
 505
 506         return devices;
 507 }
 508
 509 static GSList *hw_dev_list(void)
 510 {
 511         struct drv_context *drvc;
 512
 513         drvc = fdi->priv;
 514
 515         return drvc->instances;
 516 }
 517
 518 static int hw_dev_open(struct sr_dev_inst *sdi)
 519 {
 520         struct dev_context *devc;
 521         int ret;
 522         int64_t timediff_us, timediff_ms;
 523
 524         devc = sdi->priv;
 525
 526         /*
 527          * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
 528          * milliseconds for the FX2 to renumerate.
 529          */
 530         ret = SR_ERR;
 531         if (devc->fw_updated > 0) {
 532                 sr_info("fx2lafw: Waiting for device to reset.");
 533                 /* takes at least 300ms for the FX2 to be gone from the USB bus */
 534                 g_usleep(300 * 1000);
 535                 timediff_ms = 0;
 536                 while (timediff_ms < MAX_RENUM_DELAY_MS) {
 537                         if ((ret = fx2lafw_dev_open(sdi)) == SR_OK)
 538                                 break;
 539                         g_usleep(100 * 1000);
 540
 541                         timediff_us = g_get_monotonic_time() - devc->fw_updated;
 542                         timediff_ms = timediff_us / 1000;
 543                         sr_spew("fx2lafw: waited %" PRIi64 " ms", timediff_ms);
 544                 }
 545                 sr_info("fx2lafw: Device came back after %d ms.", timediff_ms);
 546         } else {
 547                 ret = fx2lafw_dev_open(sdi);
 548         }
 549
 550         if (ret != SR_OK) {
 551                 sr_err("fx2lafw: Unable to open device.");
 552                 return SR_ERR;
 553         }
 554         devc = sdi->priv;
 555
 556         ret = libusb_claim_interface(devc->usb->devhdl, USB_INTERFACE);
 557         if (ret != 0) {
 558                 switch(ret) {
 559                 case LIBUSB_ERROR_BUSY:
 560                         sr_err("fx2lafw: Unable to claim USB interface. Another "
 561                                 "program or driver has already claimed it.");
 562                         break;
 563
 564                 case LIBUSB_ERROR_NO_DEVICE:
 565                         sr_err("fx2lafw: Device has been disconnected.");
 566                         break;
 567
 568                 default:
 569                         sr_err("fx2lafw: Unable to claim interface: %s.",
 570                                libusb_error_name(ret));
 571                         break;
 572                 }
 573
 574                 return SR_ERR;
 575         }
 576
 577         if (devc->cur_samplerate == 0) {
 578                 /* Samplerate hasn't been set; default to the slowest one. */
 579                 if (hw_dev_config_set(sdi, SR_HWCAP_SAMPLERATE,
 580                     &supported_samplerates[0]) == SR_ERR)
 581                         return SR_ERR;
 582         }
 583
 584         return SR_OK;
 585 }
 586
 587 static int hw_dev_close(struct sr_dev_inst *sdi)
 588 {
 589         struct dev_context *devc;
 590
 591         devc = sdi->priv;
 592         if (devc->usb->devhdl == NULL)
 593                 return SR_ERR;
 594
 595         sr_info("fx2lafw: Closing device %d on %d.%d interface %d.",
 596                 sdi->index, devc->usb->bus, devc->usb->address, USB_INTERFACE);
 597         libusb_release_interface(devc->usb->devhdl, USB_INTERFACE);
 598         libusb_close(devc->usb->devhdl);
 599         devc->usb->devhdl = NULL;
 600         sdi->status = SR_ST_INACTIVE;
 601
 602         return SR_OK;
 603 }
 604
 605 static int hw_cleanup(void)
 606 {
 607         struct drv_context *drvc;
 608         int ret;
 609
 610         if (!(drvc = fdi->priv))
 611                 return SR_OK;
 612
 613         ret = clear_instances();
 614
 615         g_free(drvc);
 616         fdi->priv = NULL;
 617
 618         return ret;
 619 }
 620
 621 static int hw_info_get(int info_id, const void **data,
 622                 const struct sr_dev_inst *sdi)
 623 {
 624         struct dev_context *devc;
 625
 626         switch (info_id) {
 627         case SR_DI_HWCAPS:
 628                 *data = hwcaps;
 629                 break;
 630         case SR_DI_NUM_PROBES:
 631                 if (sdi) {
 632                         devc = sdi->priv;
 633                         *data = GINT_TO_POINTER(
 634                                 (devc->profile->dev_caps & DEV_CAPS_16BIT) ?
 635                                 16 : 8);
 636                 } else
 637                         return SR_ERR;
 638                 break;
 639         case SR_DI_PROBE_NAMES:
 640                 *data = probe_names;
 641                 break;
 642         case SR_DI_SAMPLERATES:
 643                 *data = &samplerates;
 644                 break;
 645         case SR_DI_TRIGGER_TYPES:
 646                 *data = TRIGGER_TYPES;
 647                 break;
 648         case SR_DI_CUR_SAMPLERATE:
 649                 if (sdi) {
 650                         devc = sdi->priv;
 651                         *data = &devc->cur_samplerate;
 652                 } else
 653                         return SR_ERR;
 654                 break;
 655         default:
 656                 return SR_ERR_ARG;
 657         }
 658
 659         return SR_OK;
 660 }
 661
 662 static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
 663                 const void *value)
 664 {
 665         struct dev_context *devc;
 666         int ret;
 667
 668         devc = sdi->priv;
 669
 670         if (hwcap == SR_HWCAP_SAMPLERATE) {
 671                 devc->cur_samplerate = *(const uint64_t *)value;
 672                 ret = SR_OK;
 673         } else if (hwcap == SR_HWCAP_LIMIT_SAMPLES) {
 674                 devc->limit_samples = *(const uint64_t *)value;
 675                 ret = SR_OK;
 676         } else {
 677                 ret = SR_ERR;
 678         }
 679
 680         return ret;
 681 }
 682
 683 static int receive_data(int fd, int revents, void *cb_data)
 684 {
 685         struct timeval tv;
 686         struct drv_context *drvc = fdi->priv;
 687
 688         (void)fd;
 689         (void)revents;
 690         (void)cb_data;
 691
 692         tv.tv_sec = tv.tv_usec = 0;
 693         libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &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 sr_datafeed_packet packet;
 713         struct drv_context *drvc = fdi->priv;
 714         int i;
 715
 716
 717         /* Terminate session */
 718         packet.type = SR_DF_END;
 719         sr_session_send(devc->session_dev_id, &packet);
 720
 721         /* Remove fds from polling */
 722         const struct libusb_pollfd **const lupfd =
 723                 libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
 724         for (i = 0; lupfd[i]; i++)
 725                 sr_source_remove(lupfd[i]->fd);
 726         free(lupfd); /* NOT g_free()! */
 727
 728         devc->num_transfers = 0;
 729         g_free(devc->transfers);
 730 }
 731
 732 static void free_transfer(struct libusb_transfer *transfer)
 733 {
 734         struct dev_context *devc = transfer->user_data;
 735         unsigned int i;
 736
 737         g_free(transfer->buffer);
 738         transfer->buffer = NULL;
 739         libusb_free_transfer(transfer);
 740
 741         for (i = 0; i < devc->num_transfers; i++) {
 742                 if (devc->transfers[i] == transfer) {
 743                         devc->transfers[i] = NULL;
 744                         break;
 745                 }
 746         }
 747
 748         devc->submitted_transfers--;
 749         if (devc->submitted_transfers == 0)
 750                 finish_acquisition(devc);
 751
 752 }
 753
 754 static void resubmit_transfer(struct libusb_transfer *transfer)
 755 {
 756         int ret = libusb_submit_transfer(transfer);
 757
 758         if (LIBUSB_SUCCESS == ret)
 759                 return;
 760
 761         free_transfer(transfer);
 762         /* TODO: Stop session? */
 763
 764         sr_err("fx2lafw: %s: %s", __func__, libusb_error_name(ret));
 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 drv_context *drvc = fdi->priv;
 953         struct libusb_transfer *transfer;
 954         const struct libusb_pollfd **lupfd;
 955         unsigned int i;
 956         int ret;
 957         unsigned char *buf;
 958
 959         devc = sdi->priv;
 960         if (devc->submitted_transfers != 0)
 961                 return SR_ERR;
 962
 963         if (configure_probes(sdi) != SR_OK) {
 964                 sr_err("fx2lafw: failed to configured probes");
 965                 return SR_ERR;
 966         }
 967
 968         devc->session_dev_id = cb_data;
 969         devc->num_samples = 0;
 970         devc->empty_transfer_count = 0;
 971
 972         const unsigned int timeout = get_timeout(devc);
 973         const unsigned int num_transfers = get_number_of_transfers(devc);
 974         const size_t size = get_buffer_size(devc);
 975
 976         devc->transfers = g_try_malloc0(sizeof(*devc->transfers) * num_transfers);
 977         if (!devc->transfers) {
 978                 sr_err("fx2lafw: USB transfers malloc failed.");
 979                 return SR_ERR_MALLOC;
 980         }
 981
 982         devc->num_transfers = num_transfers;
 983
 984         for (i = 0; i < num_transfers; i++) {
 985                 if (!(buf = g_try_malloc(size))) {
 986                         sr_err("fx2lafw: %s: buf malloc failed.", __func__);
 987                         return SR_ERR_MALLOC;
 988                 }
 989                 transfer = libusb_alloc_transfer(0);
 990                 libusb_fill_bulk_transfer(transfer, devc->usb->devhdl,
 991                                 2 | LIBUSB_ENDPOINT_IN, buf, size,
 992                                 receive_transfer, devc, timeout);
 993                 if ((ret = libusb_submit_transfer(transfer)) != 0) {
 994                         sr_err("fx2lafw: %s: libusb_submit_transfer: %s.",
 995                                __func__, libusb_error_name(ret));
 996                         libusb_free_transfer(transfer);
 997                         g_free(buf);
 998                         abort_acquisition(devc);
 999                         return SR_ERR;
1000                 }
1001                 devc->transfers[i] = transfer;
1002                 devc->submitted_transfers++;
1003         }
1004
1005         lupfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
1006         for (i = 0; lupfd[i]; i++)
1007                 sr_source_add(lupfd[i]->fd, lupfd[i]->events,
1008                               timeout, receive_data, NULL);
1009         free(lupfd); /* NOT g_free()! */
1010
1011         packet.type = SR_DF_HEADER;
1012         packet.payload = &header;
1013         header.feed_version = 1;
1014         gettimeofday(&header.starttime, NULL);
1015         sr_session_send(cb_data, &packet);
1016
1017         /* Send metadata about the SR_DF_LOGIC packets to come. */
1018         packet.type = SR_DF_META_LOGIC;
1019         packet.payload = &meta;
1020         meta.samplerate = devc->cur_samplerate;
1021         meta.num_probes = devc->sample_wide ? 16 : 8;
1022         sr_session_send(cb_data, &packet);
1023
1024         if ((ret = command_start_acquisition (devc->usb->devhdl,
1025                 devc->cur_samplerate, devc->sample_wide)) != SR_OK) {
1026                 abort_acquisition(devc);
1027                 return ret;
1028         }
1029
1030         return SR_OK;
1031 }
1032
1033 /* TODO: This stops acquisition on ALL devices, ignoring dev_index. */
1034 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
1035 {
1036         (void)cb_data;
1037
1038         abort_acquisition(sdi->priv);
1039
1040         return SR_OK;
1041 }
1042
1043 SR_PRIV struct sr_dev_driver fx2lafw_driver_info = {
1044         .name = "fx2lafw",
1045         .longname = "fx2lafw (generic driver for FX2 based LAs)",
1046         .api_version = 1,
1047         .init = hw_init,
1048         .cleanup = hw_cleanup,
1049         .scan = hw_scan,
1050         .dev_list = hw_dev_list,
1051         .dev_clear = clear_instances,
1052         .dev_open = hw_dev_open,
1053         .dev_close = hw_dev_close,
1054         .info_get = hw_info_get,
1055         .dev_config_set = hw_dev_config_set,
1056         .dev_acquisition_start = hw_dev_acquisition_start,
1057         .dev_acquisition_stop = hw_dev_acquisition_stop,
1058         .priv = NULL,
1059 };