src/hardware/fx2lafw/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2013 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 <config.h>
  22 #include "protocol.h"
  23 #include <math.h>
  24
  25 static const struct fx2lafw_profile supported_fx2[] = {
  26         /*
  27          * CWAV USBee AX
  28          * EE Electronics ESLA201A
  29          * ARMFLY AX-Pro
  30          */
  31         { 0x08a9, 0x0014, "CWAV", "USBee AX", NULL,
  32                 "fx2lafw-cwav-usbeeax.fw",
  33                 DEV_CAPS_AX_ANALOG, NULL, NULL},
  34         /*
  35          * CWAV USBee DX
  36          * XZL-Studio DX
  37          */
  38         { 0x08a9, 0x0015, "CWAV", "USBee DX", NULL,
  39                 "fx2lafw-cwav-usbeedx.fw",
  40                 DEV_CAPS_16BIT, NULL, NULL },
  41
  42         /*
  43          * CWAV USBee SX
  44          */
  45         { 0x08a9, 0x0009, "CWAV", "USBee SX", NULL,
  46                 "fx2lafw-cwav-usbeesx.fw",
  47                 0, NULL, NULL},
  48
  49         /*
  50          * CWAV USBee ZX
  51          */
  52         { 0x08a9, 0x0005, "CWAV", "USBee ZX", NULL,
  53                 "fx2lafw-cwav-usbeezx.fw",
  54                 0, NULL, NULL},
  55
  56         /*
  57          * Saleae Logic
  58          * EE Electronics ESLA100
  59          * Robomotic MiniLogic
  60          * Robomotic BugLogic 3
  61          */
  62         { 0x0925, 0x3881, "Saleae", "Logic", NULL,
  63                 "fx2lafw-saleae-logic.fw",
  64                 0, NULL, NULL},
  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                 "fx2lafw-cypress-fx2.fw",
  73                 DEV_CAPS_16BIT, NULL, NULL },
  74
  75         /*
  76          * Braintechnology USB-LPS
  77          */
  78         { 0x16d0, 0x0498, "Braintechnology", "USB-LPS", NULL,
  79                 "fx2lafw-braintechnology-usb-lps.fw",
  80                 DEV_CAPS_16BIT, NULL, NULL },
  81
  82         /*
  83          * sigrok FX2 based 8-channel logic analyzer
  84          */
  85         { 0x1d50, 0x608c, "sigrok", "FX2 LA (8ch)", NULL,
  86                 "fx2lafw-sigrok-fx2-8ch.fw",
  87                 0, NULL, NULL},
  88
  89         /*
  90          * sigrok FX2 based 16-channel logic analyzer
  91          */
  92         { 0x1d50, 0x608d, "sigrok", "FX2 LA (16ch)", NULL,
  93                 "fx2lafw-sigrok-fx2-16ch.fw",
  94                 DEV_CAPS_16BIT, NULL, NULL },
  95
  96         ALL_ZERO
  97 };
  98
  99 static const uint32_t drvopts[] = {
 100         SR_CONF_LOGIC_ANALYZER,
 101 };
 102
 103 static const uint32_t scanopts[] = {
 104         SR_CONF_CONN,
 105 };
 106
 107 static const uint32_t devopts[] = {
 108         SR_CONF_CONTINUOUS,
 109         SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
 110         SR_CONF_CONN | SR_CONF_GET,
 111         SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
 112         SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
 113         SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
 114 };
 115
 116 static const int32_t soft_trigger_matches[] = {
 117         SR_TRIGGER_ZERO,
 118         SR_TRIGGER_ONE,
 119         SR_TRIGGER_RISING,
 120         SR_TRIGGER_FALLING,
 121         SR_TRIGGER_EDGE,
 122 };
 123
 124 static const uint64_t samplerates[] = {
 125         SR_KHZ(20),
 126         SR_KHZ(25),
 127         SR_KHZ(50),
 128         SR_KHZ(100),
 129         SR_KHZ(200),
 130         SR_KHZ(250),
 131         SR_KHZ(500),
 132         SR_MHZ(1),
 133         SR_MHZ(2),
 134         SR_MHZ(3),
 135         SR_MHZ(4),
 136         SR_MHZ(6),
 137         SR_MHZ(8),
 138         SR_MHZ(12),
 139         SR_MHZ(16),
 140         SR_MHZ(24),
 141 };
 142
 143 static gboolean is_plausible(const struct libusb_device_descriptor *des)
 144 {
 145         int i;
 146
 147         for (i = 0; supported_fx2[i].vid; i++) {
 148                 if (des->idVendor != supported_fx2[i].vid)
 149                         continue;
 150                 if (des->idProduct == supported_fx2[i].pid)
 151                         return TRUE;
 152         }
 153
 154         return FALSE;
 155 }
 156
 157 static GSList *scan(struct sr_dev_driver *di, GSList *options)
 158 {
 159         struct drv_context *drvc;
 160         struct dev_context *devc;
 161         struct sr_dev_inst *sdi;
 162         struct sr_usb_dev_inst *usb;
 163         struct sr_channel *ch;
 164         struct sr_channel_group *cg;
 165         struct sr_config *src;
 166         const struct fx2lafw_profile *prof;
 167         GSList *l, *devices, *conn_devices;
 168         gboolean has_firmware;
 169         struct libusb_device_descriptor des;
 170         libusb_device **devlist;
 171         struct libusb_device_handle *hdl;
 172         int ret, i, j;
 173         int num_logic_channels = 0, num_analog_channels = 0;
 174         const char *conn;
 175         char manufacturer[64], product[64], serial_num[64], connection_id[64];
 176         char channel_name[16];
 177
 178         drvc = di->context;
 179
 180         conn = NULL;
 181         for (l = options; l; l = l->next) {
 182                 src = l->data;
 183                 switch (src->key) {
 184                 case SR_CONF_CONN:
 185                         conn = g_variant_get_string(src->data, NULL);
 186                         break;
 187                 }
 188         }
 189         if (conn)
 190                 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
 191         else
 192                 conn_devices = NULL;
 193
 194         /* Find all fx2lafw compatible devices and upload firmware to them. */
 195         devices = NULL;
 196         libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
 197         for (i = 0; devlist[i]; i++) {
 198                 if (conn) {
 199                         usb = NULL;
 200                         for (l = conn_devices; l; l = l->next) {
 201                                 usb = l->data;
 202                                 if (usb->bus == libusb_get_bus_number(devlist[i])
 203                                         && usb->address == libusb_get_device_address(devlist[i]))
 204                                         break;
 205                         }
 206                         if (!l)
 207                                 /* This device matched none of the ones that
 208                                  * matched the conn specification. */
 209                                 continue;
 210                 }
 211
 212                 libusb_get_device_descriptor( devlist[i], &des);
 213
 214                 if (!is_plausible(&des))
 215                         continue;
 216
 217                 if ((ret = libusb_open(devlist[i], &hdl)) < 0) {
 218                         sr_warn("Failed to open potential device with "
 219                                 "VID:PID %04x:%04x: %s.", des.idVendor,
 220                                 des.idProduct, libusb_error_name(ret));
 221                         continue;
 222                 }
 223
 224                 if (des.iManufacturer == 0) {
 225                         manufacturer[0] = '\0';
 226                 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
 227                                 des.iManufacturer, (unsigned char *) manufacturer,
 228                                 sizeof(manufacturer))) < 0) {
 229                         sr_warn("Failed to get manufacturer string descriptor: %s.",
 230                                 libusb_error_name(ret));
 231                         continue;
 232                 }
 233
 234                 if (des.iProduct == 0) {
 235                         product[0] = '\0';
 236                 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
 237                                 des.iProduct, (unsigned char *) product,
 238                                 sizeof(product))) < 0) {
 239                         sr_warn("Failed to get product string descriptor: %s.",
 240                                 libusb_error_name(ret));
 241                         continue;
 242                 }
 243
 244                 if (des.iSerialNumber == 0) {
 245                         serial_num[0] = '\0';
 246                 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
 247                                 des.iSerialNumber, (unsigned char *) serial_num,
 248                                 sizeof(serial_num))) < 0) {
 249                         sr_warn("Failed to get serial number string descriptor: %s.",
 250                                 libusb_error_name(ret));
 251                         continue;
 252                 }
 253
 254                 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
 255
 256                 libusb_close(hdl);
 257
 258                 prof = NULL;
 259                 for (j = 0; supported_fx2[j].vid; j++) {
 260                         if (des.idVendor == supported_fx2[j].vid &&
 261                                         des.idProduct == supported_fx2[j].pid &&
 262                                         (!supported_fx2[j].usb_manufacturer ||
 263                                          !strcmp(manufacturer, supported_fx2[j].usb_manufacturer)) &&
 264                                         (!supported_fx2[j].usb_product ||
 265                                          !strcmp(product, supported_fx2[j].usb_product))) {
 266                                 prof = &supported_fx2[j];
 267                                 break;
 268                         }
 269                 }
 270
 271                 /* Skip if the device was not found. */
 272                 if (!prof)
 273                         continue;
 274
 275                 sdi = g_malloc0(sizeof(struct sr_dev_inst));
 276                 sdi->status = SR_ST_INITIALIZING;
 277                 sdi->vendor = g_strdup(prof->vendor);
 278                 sdi->model = g_strdup(prof->model);
 279                 sdi->version = g_strdup(prof->model_version);
 280                 sdi->serial_num = g_strdup(serial_num);
 281                 sdi->connection_id = g_strdup(connection_id);
 282
 283                 /* Fill in channellist according to this device's profile. */
 284                 num_logic_channels = prof->dev_caps & DEV_CAPS_16BIT ? 16 : 8;
 285                 num_analog_channels = prof->dev_caps & DEV_CAPS_AX_ANALOG ? 1 : 0;
 286
 287                 /* Logic channels, all in one channel group. */
 288                 cg = g_malloc0(sizeof(struct sr_channel_group));
 289                 cg->name = g_strdup("Logic");
 290                 for (j = 0; j < num_logic_channels; j++) {
 291                         sprintf(channel_name, "D%d", j);
 292                         ch = sr_channel_new(sdi, j, SR_CHANNEL_LOGIC,
 293                                                 TRUE, channel_name);
 294                         cg->channels = g_slist_append(cg->channels, ch);
 295                 }
 296                 sdi->channel_groups = g_slist_append(NULL, cg);
 297
 298                 for (j = 0; j < num_analog_channels; j++) {
 299                         snprintf(channel_name, 16, "A%d", j);
 300                         ch = sr_channel_new(sdi, j + num_logic_channels,
 301                                         SR_CHANNEL_ANALOG, TRUE, channel_name);
 302
 303                         /* Every analog channel gets its own channel group. */
 304                         cg = g_malloc0(sizeof(struct sr_channel_group));
 305                         cg->name = g_strdup(channel_name);
 306                         cg->channels = g_slist_append(NULL, ch);
 307                         sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
 308                 }
 309
 310                 devc = fx2lafw_dev_new();
 311                 devc->profile = prof;
 312                 sdi->priv = devc;
 313                 devices = g_slist_append(devices, sdi);
 314
 315                 devc->samplerates = samplerates;
 316                 devc->num_samplerates = ARRAY_SIZE(samplerates);
 317                 has_firmware = usb_match_manuf_prod(devlist[i],
 318                                 "sigrok", "fx2lafw");
 319
 320                 if (has_firmware) {
 321                         /* Already has the firmware, so fix the new address. */
 322                         sr_dbg("Found an fx2lafw device.");
 323                         sdi->status = SR_ST_INACTIVE;
 324                         sdi->inst_type = SR_INST_USB;
 325                         sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
 326                                         libusb_get_device_address(devlist[i]), NULL);
 327                 } else {
 328                         if (ezusb_upload_firmware(drvc->sr_ctx, devlist[i],
 329                                         USB_CONFIGURATION, prof->firmware) == SR_OK)
 330                                 /* Store when this device's FW was updated. */
 331                                 devc->fw_updated = g_get_monotonic_time();
 332                         else
 333                                 sr_err("Firmware upload failed for "
 334                                        "device %d.%d (logical).",
 335                                        libusb_get_bus_number(devlist[i]),
 336                                        libusb_get_device_address(devlist[i]));
 337                         sdi->inst_type = SR_INST_USB;
 338                         sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
 339                                         0xff, NULL);
 340                 }
 341         }
 342         libusb_free_device_list(devlist, 1);
 343         g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
 344
 345         return std_scan_complete(di, devices);
 346 }
 347
 348 static void clear_dev_context(void *priv)
 349 {
 350         struct dev_context *devc;
 351
 352         devc = priv;
 353         g_slist_free(devc->enabled_analog_channels);
 354         g_free(devc);
 355 }
 356
 357 static int dev_clear(const struct sr_dev_driver *di)
 358 {
 359         return std_dev_clear(di, clear_dev_context);
 360 }
 361
 362 static int dev_open(struct sr_dev_inst *sdi)
 363 {
 364         struct sr_dev_driver *di = sdi->driver;
 365         struct sr_usb_dev_inst *usb;
 366         struct dev_context *devc;
 367         int ret;
 368         int64_t timediff_us, timediff_ms;
 369
 370         devc = sdi->priv;
 371         usb = sdi->conn;
 372
 373         /*
 374          * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
 375          * milliseconds for the FX2 to renumerate.
 376          */
 377         ret = SR_ERR;
 378         if (devc->fw_updated > 0) {
 379                 sr_info("Waiting for device to reset.");
 380                 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
 381                 g_usleep(300 * 1000);
 382                 timediff_ms = 0;
 383                 while (timediff_ms < MAX_RENUM_DELAY_MS) {
 384                         if ((ret = fx2lafw_dev_open(sdi, di)) == SR_OK)
 385                                 break;
 386                         g_usleep(100 * 1000);
 387
 388                         timediff_us = g_get_monotonic_time() - devc->fw_updated;
 389                         timediff_ms = timediff_us / 1000;
 390                         sr_spew("Waited %" PRIi64 "ms.", timediff_ms);
 391                 }
 392                 if (ret != SR_OK) {
 393                         sr_err("Device failed to renumerate.");
 394                         return SR_ERR;
 395                 }
 396                 sr_info("Device came back after %" PRIi64 "ms.", timediff_ms);
 397         } else {
 398                 sr_info("Firmware upload was not needed.");
 399                 ret = fx2lafw_dev_open(sdi, di);
 400         }
 401
 402         if (ret != SR_OK) {
 403                 sr_err("Unable to open device.");
 404                 return SR_ERR;
 405         }
 406
 407         ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
 408         if (ret != 0) {
 409                 switch (ret) {
 410                 case LIBUSB_ERROR_BUSY:
 411                         sr_err("Unable to claim USB interface. Another "
 412                                "program or driver has already claimed it.");
 413                         break;
 414                 case LIBUSB_ERROR_NO_DEVICE:
 415                         sr_err("Device has been disconnected.");
 416                         break;
 417                 default:
 418                         sr_err("Unable to claim interface: %s.",
 419                                libusb_error_name(ret));
 420                         break;
 421                 }
 422
 423                 return SR_ERR;
 424         }
 425
 426         if (devc->cur_samplerate == 0) {
 427                 /* Samplerate hasn't been set; default to the slowest one. */
 428                 devc->cur_samplerate = devc->samplerates[0];
 429         }
 430
 431         return SR_OK;
 432 }
 433
 434 static int dev_close(struct sr_dev_inst *sdi)
 435 {
 436         struct sr_usb_dev_inst *usb;
 437
 438         usb = sdi->conn;
 439
 440         if (!usb->devhdl)
 441                 return SR_ERR_BUG;
 442
 443         sr_info("fx2lafw: Closing device on %d.%d (logical) / %s (physical) interface %d.",
 444                 usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
 445         libusb_release_interface(usb->devhdl, USB_INTERFACE);
 446         libusb_close(usb->devhdl);
 447         usb->devhdl = NULL;
 448
 449         return SR_OK;
 450 }
 451
 452 static int config_get(uint32_t key, GVariant **data,
 453         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 454 {
 455         struct dev_context *devc;
 456         struct sr_usb_dev_inst *usb;
 457         char str[128];
 458
 459         (void)cg;
 460
 461         if (!sdi)
 462                 return SR_ERR_ARG;
 463
 464         devc = sdi->priv;
 465
 466         switch (key) {
 467         case SR_CONF_CONN:
 468                 if (!sdi->conn)
 469                         return SR_ERR_ARG;
 470                 usb = sdi->conn;
 471                 if (usb->address == 255)
 472                         /* Device still needs to re-enumerate after firmware
 473                          * upload, so we don't know its (future) address. */
 474                         return SR_ERR;
 475                 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
 476                 *data = g_variant_new_string(str);
 477                 break;
 478         case SR_CONF_LIMIT_SAMPLES:
 479                 *data = g_variant_new_uint64(devc->limit_samples);
 480                 break;
 481         case SR_CONF_SAMPLERATE:
 482                 *data = g_variant_new_uint64(devc->cur_samplerate);
 483                 break;
 484         case SR_CONF_CAPTURE_RATIO:
 485                 *data = g_variant_new_uint64(devc->capture_ratio);
 486                 break;
 487         default:
 488                 return SR_ERR_NA;
 489         }
 490
 491         return SR_OK;
 492 }
 493
 494 static int config_set(uint32_t key, GVariant *data,
 495         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 496 {
 497         struct dev_context *devc;
 498         uint64_t arg;
 499         int i, ret;
 500
 501         (void)cg;
 502
 503         if (!sdi)
 504                 return SR_ERR_ARG;
 505
 506         devc = sdi->priv;
 507
 508         ret = SR_OK;
 509
 510         switch (key) {
 511         case SR_CONF_SAMPLERATE:
 512                 arg = g_variant_get_uint64(data);
 513                 for (i = 0; i < devc->num_samplerates; i++) {
 514                         if (devc->samplerates[i] == arg) {
 515                                 devc->cur_samplerate = arg;
 516                                 break;
 517                         }
 518                 }
 519                 if (i == devc->num_samplerates)
 520                         ret = SR_ERR_ARG;
 521                 break;
 522         case SR_CONF_LIMIT_SAMPLES:
 523                 devc->limit_samples = g_variant_get_uint64(data);
 524                 break;
 525         case SR_CONF_CAPTURE_RATIO:
 526                 devc->capture_ratio = g_variant_get_uint64(data);
 527                 ret = (devc->capture_ratio > 100) ? SR_ERR : SR_OK;
 528                 break;
 529         default:
 530                 ret = SR_ERR_NA;
 531         }
 532
 533         return ret;
 534 }
 535
 536 static int config_list(uint32_t key, GVariant **data,
 537         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 538 {
 539         struct dev_context *devc;
 540         GVariant *gvar;
 541         GVariantBuilder gvb;
 542
 543         (void)cg;
 544
 545         switch (key) {
 546         case SR_CONF_SCAN_OPTIONS:
 547                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 548                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 549                 break;
 550         case SR_CONF_DEVICE_OPTIONS:
 551                 if (!sdi) {
 552                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 553                                 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
 554                 } else {
 555                         devc = sdi->priv;
 556                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 557                                                           devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 558                 }
 559                 break;
 560         case SR_CONF_SAMPLERATE:
 561                 devc = sdi->priv;
 562                 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
 563                 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), devc->samplerates,
 564                                 devc->num_samplerates, sizeof(uint64_t));
 565                 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
 566                 *data = g_variant_builder_end(&gvb);
 567                 break;
 568         case SR_CONF_TRIGGER_MATCH:
 569                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
 570                                 soft_trigger_matches, ARRAY_SIZE(soft_trigger_matches),
 571                                 sizeof(int32_t));
 572                 break;
 573         default:
 574                 return SR_ERR_NA;
 575         }
 576
 577         return SR_OK;
 578 }
 579
 580 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 581 {
 582         fx2lafw_abort_acquisition(sdi->priv);
 583
 584         return SR_OK;
 585 }
 586
 587 static struct sr_dev_driver fx2lafw_driver_info = {
 588         .name = "fx2lafw",
 589         .longname = "fx2lafw (generic driver for FX2 based LAs)",
 590         .api_version = 1,
 591         .init = std_init,
 592         .cleanup = std_cleanup,
 593         .scan = scan,
 594         .dev_list = std_dev_list,
 595         .dev_clear = dev_clear,
 596         .config_get = config_get,
 597         .config_set = config_set,
 598         .config_list = config_list,
 599         .dev_open = dev_open,
 600         .dev_close = dev_close,
 601         .dev_acquisition_start = fx2lafw_start_acquisition,
 602         .dev_acquisition_stop = dev_acquisition_stop,
 603         .context = NULL,
 604 };
 605 SR_REGISTER_DEV_DRIVER(fx2lafw_driver_info);