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