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