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