hardware/fx2lafw/fx2lafw.c

   1 /*
   2  * This file is part of the sigrok project.
   3  *
   4  * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #include <stdio.h>
  21 #include <stdlib.h>
  22 #include <inttypes.h>
  23 #include <glib.h>
  24 #include <libusb.h>
  25 #include "config.h"
  26 #include "sigrok.h"
  27 #include "sigrok-internal.h"
  28 #include "fx2lafw.h"
  29
  30 static struct fx2lafw_profile supported_fx2[] = {
  31         /* USBee AX */
  32         { 0x08a9, 0x0014, "CWAV", "USBee AX", NULL, 8 },
  33         { 0, 0, 0, 0, 0, 0 }
  34 };
  35
  36 static int fx2lafw_capabilities[] = {
  37         SR_HWCAP_LOGIC_ANALYZER,
  38         SR_HWCAP_SAMPLERATE,
  39
  40         /* These are really implemented in the driver, not the hardware. */
  41         SR_HWCAP_LIMIT_SAMPLES,
  42         SR_HWCAP_CONTINUOUS,
  43         0,
  44 };
  45
  46 static const char *fx2lafw_probe_names[] = {
  47         "D0",
  48         "D1",
  49         "D2",
  50         "D3",
  51         "D4",
  52         "D5",
  53         "D6",
  54         "D7",
  55         NULL,
  56 };
  57
  58 static uint64_t fx2lafw_supported_samplerates[] = {
  59         SR_MHZ(1),
  60         SR_MHZ(2),
  61         SR_MHZ(3),
  62         SR_MHZ(4),
  63         SR_MHZ(6),
  64         SR_MHZ(8),
  65         SR_MHZ(12),
  66         SR_MHZ(16),
  67         SR_MHZ(24),
  68 };
  69
  70 static struct sr_samplerates fx2lafw_samplerates = {
  71         SR_MHZ(1),
  72         SR_MHZ(24),
  73         SR_HZ(0),
  74         fx2lafw_supported_samplerates,
  75 };
  76
  77 static GSList *dev_insts = NULL;
  78 static libusb_context *usb_context = NULL;
  79
  80 static int hw_dev_acquisition_stop(int dev_index, void *session_dev_id);
  81
  82 /**
  83  * Check the USB configuration to determine if this is an fx2lafw device.
  84  *
  85  * @return TRUE if the device's configuration profile match fx2lafw
  86  *         configuration, FALSE otherwise.
  87  */
  88 static gboolean check_conf_profile(libusb_device *dev)
  89 {
  90         struct libusb_device_descriptor des;
  91         struct libusb_config_descriptor *conf_dsc = NULL;
  92         const struct libusb_interface_descriptor *intf_dsc;
  93         gboolean ret = FALSE;
  94
  95         while (!ret) {
  96                 /* Assume it's not a Saleae Logic unless proven wrong. */
  97                 ret = 0;
  98
  99                 if (libusb_get_device_descriptor(dev, &des) != 0)
 100                         break;
 101
 102                 if (des.bNumConfigurations != 1)
 103                         /* Need exactly 1 configuration. */
 104                         break;
 105
 106                 if (libusb_get_config_descriptor(dev, 0, &conf_dsc) != 0)
 107                         break;
 108
 109                 if (conf_dsc->bNumInterfaces != 1)
 110                         /* Need exactly 1 interface. */
 111                         break;
 112
 113                 if (conf_dsc->interface[0].num_altsetting != 1)
 114                         /* Need just one alternate setting. */
 115                         break;
 116
 117                 intf_dsc = &(conf_dsc->interface[0].altsetting[0]);
 118                 if (intf_dsc->bNumEndpoints != 3)
 119                         /* Need exactly 3 end points. */
 120                         break;
 121
 122                 if ((intf_dsc->endpoint[0].bEndpointAddress & 0x8f) !=
 123                     (1 | LIBUSB_ENDPOINT_OUT))
 124                         /* The first endpoint should be 1 (outbound). */
 125                         break;
 126
 127                 if ((intf_dsc->endpoint[1].bEndpointAddress & 0x8f) !=
 128                     (2 | LIBUSB_ENDPOINT_IN))
 129                         /* The second endpoint should be 2 (inbound). */
 130                         break;
 131
 132                 /* TODO: Check the debug channel... */
 133
 134                 /* If we made it here, it must be an fx2lafw. */
 135                 ret = TRUE;
 136         }
 137
 138         if (conf_dsc)
 139                 libusb_free_config_descriptor(conf_dsc);
 140
 141         return ret;
 142 }
 143
 144 static int fx2lafw_open_dev(int dev_index)
 145 {
 146         libusb_device **devlist;
 147         struct libusb_device_descriptor des;
 148         struct sr_dev_inst *sdi;
 149         struct context *ctx;
 150         int err, skip, i;
 151
 152         if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
 153                 return SR_ERR;
 154         ctx = sdi->priv;
 155
 156         if (sdi->status == SR_ST_ACTIVE)
 157                 /* already in use */
 158                 return SR_ERR;
 159
 160         skip = 0;
 161         libusb_get_device_list(usb_context, &devlist);
 162         for (i = 0; devlist[i]; i++) {
 163                 if ((err = libusb_get_device_descriptor(devlist[i], &des))) {
 164                         sr_err("fx2lafw: failed to get device descriptor: %d", err);
 165                         continue;
 166                 }
 167
 168                 if (des.idVendor != FIRMWARE_VID
 169                     || des.idProduct != FIRMWARE_PID)
 170                         continue;
 171
 172                 if (sdi->status == SR_ST_INITIALIZING) {
 173                         if (skip != dev_index) {
 174                                 /* Skip devices of this type that aren't the one we want. */
 175                                 skip += 1;
 176                                 continue;
 177                         }
 178                 } else if (sdi->status == SR_ST_INACTIVE) {
 179                         /*
 180                          * This device is fully enumerated, so we need to find
 181                          * this device by vendor, product, bus and address.
 182                          */
 183                         if (libusb_get_bus_number(devlist[i]) != ctx->usb->bus
 184                                 || libusb_get_device_address(devlist[i]) != ctx->usb->address)
 185                                 /* this is not the one */
 186                                 continue;
 187                 }
 188
 189                 if (!(err = libusb_open(devlist[i], &ctx->usb->devhdl))) {
 190                         if (ctx->usb->address == 0xff)
 191                                 /*
 192                                  * first time we touch this device after firmware upload,
 193                                  * so we don't know the address yet.
 194                                  */
 195                                 ctx->usb->address = libusb_get_device_address(devlist[i]);
 196
 197                         sdi->status = SR_ST_ACTIVE;
 198                         sr_info("fx2lafw: opened device %d on %d.%d interface %d",
 199                                 sdi->index, ctx->usb->bus,
 200                                 ctx->usb->address, USB_INTERFACE);
 201                 } else {
 202                         sr_err("fx2lafw: failed to open device: %d", err);
 203                 }
 204
 205                 /* if we made it here, we handled the device one way or another */
 206                 break;
 207         }
 208         libusb_free_device_list(devlist, 1);
 209
 210         if (sdi->status != SR_ST_ACTIVE)
 211                 return SR_ERR;
 212
 213         return SR_OK;
 214 }
 215
 216 static void close_dev(struct sr_dev_inst *sdi)
 217 {
 218         struct context *ctx;
 219
 220         ctx = sdi->priv;
 221
 222         if (ctx->usb->devhdl == NULL)
 223                 return;
 224
 225         sr_info("fx2lafw: closing device %d on %d.%d interface %d", sdi->index,
 226                 ctx->usb->bus, ctx->usb->address, USB_INTERFACE);
 227         libusb_release_interface(ctx->usb->devhdl, USB_INTERFACE);
 228         libusb_close(ctx->usb->devhdl);
 229         ctx->usb->devhdl = NULL;
 230         sdi->status = SR_ST_INACTIVE;
 231 }
 232
 233 static struct context *fx2lafw_device_new(void)
 234 {
 235         struct context *ctx;
 236
 237         if (!(ctx = g_try_malloc0(sizeof(struct context)))) {
 238                 sr_err("fx2lafw: %s: ctx malloc failed", __func__);
 239                 return NULL;
 240         }
 241
 242         return ctx;
 243 }
 244
 245 /*
 246  * API callbacks
 247  */
 248
 249 static int hw_init(const char *deviceinfo)
 250 {
 251         struct sr_dev_inst *sdi;
 252         struct libusb_device_descriptor des;
 253         struct fx2lafw_profile *fx2lafw_prof;
 254         struct context *ctx;
 255         libusb_device **devlist;
 256         int err;
 257         int devcnt = 0;
 258         int i, j;
 259
 260         /* Avoid compiler warnings. */
 261         (void)deviceinfo;
 262
 263         if (libusb_init(&usb_context) != 0) {
 264                 sr_warn("Failed to initialize USB.");
 265                 return 0;
 266         }
 267
 268         /* Find all fx2lafw compatible devices and upload firware to all of them. */
 269         libusb_get_device_list(usb_context, &devlist);
 270         for (i = 0; devlist[i]; i++) {
 271
 272                 if ((err = libusb_get_device_descriptor(
 273                         devlist[i], &des)) != 0) {
 274                         sr_warn("failed to get device descriptor: %d", err);
 275                         continue;
 276                 }
 277
 278                 fx2lafw_prof = NULL;
 279                 for (j = 0; supported_fx2[j].vid; j++) {
 280                         if (des.idVendor == supported_fx2[j].vid &&
 281                                 des.idProduct == supported_fx2[j].pid) {
 282                                 fx2lafw_prof = &supported_fx2[j];
 283                         }
 284                 }
 285
 286                 /* Skip if the device was not found */
 287                 if(!fx2lafw_prof)
 288                         continue;
 289
 290                 sdi = sr_dev_inst_new(devcnt, SR_ST_INITIALIZING,
 291                         fx2lafw_prof->vendor, fx2lafw_prof->model,
 292                         fx2lafw_prof->model_version);
 293                 if(!sdi)
 294                         return 0;
 295
 296                 ctx = fx2lafw_device_new();
 297                 ctx->profile = fx2lafw_prof;
 298                 sdi->priv = ctx;
 299                 dev_insts = g_slist_append(dev_insts, sdi);
 300
 301                 if (check_conf_profile(devlist[i])) {
 302                         /* Already has the firmware, so fix the new address. */
 303                         sr_dbg("fx2lafw: Found a fx2lafw device.");
 304                         sdi->status = SR_ST_INACTIVE;
 305                         ctx->usb = sr_usb_dev_inst_new
 306                             (libusb_get_bus_number(devlist[i]),
 307                              libusb_get_device_address(devlist[i]), NULL);
 308                 } else {
 309                         if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION, FIRMWARE) == SR_OK)
 310                                 /* Remember when the firmware on this device was updated */
 311                                 g_get_current_time(&ctx->fw_updated);
 312                         else
 313                                 sr_err("fx2lafw: firmware upload failed for "
 314                                        "device %d", devcnt);
 315                         ctx->usb = sr_usb_dev_inst_new
 316                                 (libusb_get_bus_number(devlist[i]), 0xff, NULL);
 317                 }
 318
 319                 devcnt++;
 320         }
 321         libusb_free_device_list(devlist, 1);
 322
 323         return devcnt;
 324 }
 325
 326 static int hw_dev_open(int dev_index)
 327 {
 328         GTimeVal cur_time;
 329         struct sr_dev_inst *sdi;
 330         struct context *ctx;
 331         int timediff, err;
 332
 333         if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
 334                 return SR_ERR;
 335         ctx = sdi->priv;
 336
 337         /*
 338          * if the firmware was recently uploaded, wait up to MAX_RENUM_DELAY ms
 339          * for the FX2 to renumerate
 340          */
 341         err = 0;
 342         if (GTV_TO_MSEC(ctx->fw_updated) > 0) {
 343                 sr_info("fx2lafw: waiting for device to reset");
 344                 /* takes at least 300ms for the FX2 to be gone from the USB bus */
 345                 g_usleep(300 * 1000);
 346                 timediff = 0;
 347                 while (timediff < MAX_RENUM_DELAY) {
 348                         if ((err = fx2lafw_open_dev(dev_index)) == SR_OK)
 349                                 break;
 350                         g_usleep(100 * 1000);
 351                         g_get_current_time(&cur_time);
 352                         timediff = GTV_TO_MSEC(cur_time) - GTV_TO_MSEC(ctx->fw_updated);
 353                 }
 354                 sr_info("fx2lafw: device came back after %d ms", timediff);
 355         } else {
 356                 err = fx2lafw_open_dev(dev_index);
 357         }
 358
 359         if (err != SR_OK) {
 360                 sr_err("fx2lafw: unable to open device");
 361                 return SR_ERR;
 362         }
 363         ctx = sdi->priv;
 364
 365         err = libusb_claim_interface(ctx->usb->devhdl, USB_INTERFACE);
 366         if (err != 0) {
 367                 sr_err("fx2lafw: Unable to claim interface: %d", err);
 368                 return SR_ERR;
 369         }
 370
 371         return SR_OK;
 372 }
 373
 374 static int hw_dev_close(int dev_index)
 375 {
 376         struct sr_dev_inst *sdi;
 377
 378         if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) {
 379                 sr_err("fx2lafw: %s: sdi was NULL", __func__);
 380                 return SR_ERR; /* TODO: SR_ERR_ARG? */
 381         }
 382
 383         /* TODO */
 384         close_dev(sdi);
 385
 386         return SR_OK;
 387 }
 388
 389 static int hw_cleanup(void)
 390 {
 391         GSList *l;
 392         struct sr_dev_inst *sdi;
 393         struct context *ctx;
 394         int ret = SR_OK;
 395
 396         for(l = dev_insts; l; l = l->next) {
 397                 if (!(sdi = l->data)) {
 398                         /* Log error, but continue cleaning up the rest. */
 399                         sr_err("fx2lafw: %s: sdi was NULL, continuing", __func__);
 400                         ret = SR_ERR_BUG;
 401                         continue;
 402                 }
 403                 if (!(ctx = sdi->priv)) {
 404                         /* Log error, but continue cleaning up the rest. */
 405                         sr_err("fx2lafw: %s: sdi->priv was NULL, continuing",
 406                                __func__);
 407                         ret = SR_ERR_BUG;
 408                         continue;
 409                 }
 410                 close_dev(sdi);
 411                 sdi = l->data;
 412                 sr_dev_inst_free(sdi);
 413         }
 414
 415         g_slist_free(dev_insts);
 416         dev_insts = NULL;
 417
 418         if(usb_context)
 419                 libusb_exit(usb_context);
 420         usb_context = NULL;
 421
 422         return ret;
 423 }
 424
 425 static void *hw_dev_info_get(int dev_index, int dev_info_id)
 426 {
 427         struct sr_dev_inst *sdi;
 428         struct context *ctx;
 429
 430         if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
 431                 return NULL;
 432         ctx = sdi->priv;
 433
 434         switch (dev_info_id) {
 435         case SR_DI_INST:
 436                 return sdi;
 437         case SR_DI_NUM_PROBES:
 438                 return GINT_TO_POINTER(ctx->profile->num_probes);
 439         case SR_DI_PROBE_NAMES:
 440                 return fx2lafw_probe_names;
 441         case SR_DI_SAMPLERATES:
 442                 return &fx2lafw_samplerates;
 443         case SR_DI_TRIGGER_TYPES:
 444                 return TRIGGER_TYPES;
 445         }
 446
 447         return NULL;
 448 }
 449
 450 static int hw_dev_status_get(int dev_index)
 451 {
 452         const struct sr_dev_inst *const sdi =
 453                 sr_dev_inst_get(dev_insts, dev_index);
 454
 455         if (!sdi)
 456                 return SR_ST_NOT_FOUND;
 457
 458         return sdi->status;
 459 }
 460
 461 static int *hw_hwcap_get_all(void)
 462 {
 463         return fx2lafw_capabilities;
 464 }
 465
 466 static int hw_dev_config_set(int dev_index, int hwcap, void *value)
 467 {
 468         struct sr_dev_inst *sdi;
 469         struct context *ctx;
 470         int ret;
 471
 472         if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
 473                 return SR_ERR;
 474         ctx = sdi->priv;
 475
 476         if (hwcap == SR_HWCAP_LIMIT_SAMPLES) {
 477                 ctx->limit_samples = *(uint64_t *)value;
 478                 ret = SR_OK;
 479         } else {
 480                 ret = SR_ERR;
 481         }
 482
 483         return ret;
 484 }
 485
 486 static int receive_data(int fd, int revents, void *cb_data)
 487 {
 488         struct timeval tv;
 489
 490         /* Avoid compiler warnings. */
 491         (void)fd;
 492         (void)revents;
 493         (void)cb_data;
 494
 495         tv.tv_sec = tv.tv_usec = 0;
 496         libusb_handle_events_timeout(usb_context, &tv);
 497
 498         return TRUE;
 499 }
 500
 501 static void receive_transfer(struct libusb_transfer *transfer)
 502 {
 503         /* TODO: These statics have to move to the ctx struct. */
 504         static int num_samples = 0;
 505         static int empty_transfer_count = 0;
 506         struct sr_datafeed_packet packet;
 507         struct sr_datafeed_logic logic;
 508         struct context *ctx;
 509         int cur_buflen;
 510         unsigned char *cur_buf, *new_buf;
 511
 512         /* hw_dev_acquisition_stop() is telling us to stop. */
 513         if (transfer == NULL)
 514                 num_samples = -1;
 515
 516         /*
 517          * If acquisition has already ended, just free any queued up
 518          * transfer that come in.
 519          */
 520         if (num_samples == -1) {
 521                 if (transfer)
 522                         libusb_free_transfer(transfer);
 523                 return;
 524         }
 525
 526         sr_info("fx2lafw: receive_transfer(): status %d received %d bytes",
 527                 transfer->status, transfer->actual_length);
 528
 529         /* Save incoming transfer before reusing the transfer struct. */
 530         cur_buf = transfer->buffer;
 531         cur_buflen = transfer->actual_length;
 532         ctx = transfer->user_data;
 533
 534         /* Fire off a new request. */
 535         if (!(new_buf = g_try_malloc(4096))) {
 536                 sr_err("fx2lafw: %s: new_buf malloc failed", __func__);
 537                 return; /* TODO: SR_ERR_MALLOC */
 538         }
 539
 540         transfer->buffer = new_buf;
 541         transfer->length = 4096;
 542         if (libusb_submit_transfer(transfer) != 0) {
 543                 /* TODO: Stop session? */
 544                 /* TODO: Better error message. */
 545                 sr_err("fx2lafw: %s: libusb_submit_transfer error", __func__);
 546         }
 547
 548         if (cur_buflen == 0) {
 549                 empty_transfer_count++;
 550                 if (empty_transfer_count > MAX_EMPTY_TRANSFERS) {
 551                         /*
 552                          * The FX2 gave up. End the acquisition, the frontend
 553                          * will work out that the samplecount is short.
 554                          */
 555                         hw_dev_acquisition_stop(-1, ctx->session_dev_id);
 556                 }
 557                 return;
 558         } else {
 559                 empty_transfer_count = 0;
 560         }
 561
 562         /* Send the incoming transfer to the session bus. */
 563         packet.type = SR_DF_LOGIC;
 564         packet.payload = &logic;
 565         logic.length = cur_buflen;
 566         logic.unitsize = 1;
 567         logic.data = cur_buf;
 568         sr_session_send(ctx->session_dev_id, &packet);
 569         g_free(cur_buf);
 570
 571         num_samples += cur_buflen;
 572         if (ctx->limit_samples &&
 573                 (unsigned int) num_samples > ctx->limit_samples) {
 574                 hw_dev_acquisition_stop(-1, ctx->session_dev_id);
 575         }
 576 }
 577
 578 static int hw_dev_acquisition_start(int dev_index, void *cb_data)
 579 {
 580         struct sr_dev_inst *sdi;
 581         struct sr_datafeed_packet *packet;
 582         struct sr_datafeed_header *header;
 583         struct context *ctx;
 584         struct libusb_transfer *transfer;
 585         const struct libusb_pollfd **lupfd;
 586         int size, i;
 587         unsigned char *buf;
 588
 589         if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
 590                 return SR_ERR;
 591         ctx = sdi->priv;
 592         ctx->session_dev_id = cb_data;
 593
 594         if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
 595                 sr_err("fx2lafw: %s: packet malloc failed", __func__);
 596                 return SR_ERR_MALLOC;
 597         }
 598
 599         if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) {
 600                 sr_err("fx2lafw: %s: header malloc failed", __func__);
 601                 return SR_ERR_MALLOC;
 602         }
 603
 604         /* Start with 2K transfer, subsequently increased to 4K. */
 605         size = 2048;
 606         for (i = 0; i < NUM_SIMUL_TRANSFERS; i++) {
 607                 if (!(buf = g_try_malloc(size))) {
 608                         sr_err("fx2lafw: %s: buf malloc failed", __func__);
 609                         return SR_ERR_MALLOC;
 610                 }
 611                 transfer = libusb_alloc_transfer(0);
 612                 libusb_fill_bulk_transfer(transfer, ctx->usb->devhdl,
 613                                 2 | LIBUSB_ENDPOINT_IN, buf, size,
 614                                 receive_transfer, ctx, 40);
 615                 if (libusb_submit_transfer(transfer) != 0) {
 616                         /* TODO: Free them all. */
 617                         libusb_free_transfer(transfer);
 618                         g_free(buf);
 619                         return SR_ERR;
 620                 }
 621                 size = 4096;
 622         }
 623
 624         lupfd = libusb_get_pollfds(usb_context);
 625         for (i = 0; lupfd[i]; i++)
 626                 sr_source_add(lupfd[i]->fd, lupfd[i]->events,
 627                               40, receive_data, NULL);
 628         free(lupfd); /* NOT g_free()! */
 629
 630         packet->type = SR_DF_HEADER;
 631         packet->payload = header;
 632         header->feed_version = 1;
 633         gettimeofday(&header->starttime, NULL);
 634         header->samplerate = 24000000UL;
 635         header->num_logic_probes = ctx->profile->num_probes;
 636         sr_session_send(session_dev_id, packet);
 637         g_free(header);
 638         g_free(packet);
 639
 640         return SR_OK;
 641 }
 642
 643 /* TODO: This stops acquisition on ALL devices, ignoring dev_index. */
 644 static int hw_dev_acquisition_stop(int dev_index, void *session_dev_id)
 645 {
 646         struct sr_datafeed_packet packet;
 647
 648         /* Avoid compiler warnings. */
 649         (void)dev_index;
 650
 651         packet.type = SR_DF_END;
 652         sr_session_send(session_dev_id, &packet);
 653
 654         receive_transfer(NULL);
 655
 656         /* TODO: Need to cancel and free any queued up transfers. */
 657
 658         return SR_OK;
 659 }
 660
 661 SR_PRIV struct sr_dev_driver fx2lafw_driver_info = {
 662         .name = "fx2lafw",
 663         .longname = "fx2lafw",
 664         .api_version = 1,
 665         .init = hw_init,
 666         .cleanup = hw_cleanup,
 667         .dev_open = hw_dev_open,
 668         .dev_close = hw_dev_close,
 669         .dev_info_get = hw_dev_info_get,
 670         .dev_status_get = hw_dev_status_get,
 671         .hwcap_get_all = hw_hwcap_get_all,
 672         .dev_config_set = hw_dev_config_set,
 673         .dev_acquisition_start = hw_dev_acquisition_start,
 674         .dev_acquisition_stop = hw_dev_acquisition_stop,
 675 };