hardware/hantek-dso/api.c

   1 /*
   2  * This file is part of the sigrok project.
   3  *
   4  * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
   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 <stdint.h>
  22 #include <stdlib.h>
  23 #include <sys/types.h>
  24 #include <sys/stat.h>
  25 #include <fcntl.h>
  26 #include <unistd.h>
  27 #include <string.h>
  28 #include <sys/time.h>
  29 #include <inttypes.h>
  30 #include <glib.h>
  31 #include <libusb.h>
  32 #include "libsigrok.h"
  33 #include "libsigrok-internal.h"
  34 #include "dso.h"
  35
  36 /* Max time in ms before we want to check on USB events */
  37 /* TODO tune this properly */
  38 #define TICK 1
  39
  40 static const int hwcaps[] = {
  41         SR_HWCAP_OSCILLOSCOPE,
  42         SR_HWCAP_LIMIT_SAMPLES,
  43         SR_HWCAP_CONTINUOUS,
  44         SR_HWCAP_TIMEBASE,
  45         SR_HWCAP_BUFFERSIZE,
  46         SR_HWCAP_TRIGGER_SOURCE,
  47         SR_HWCAP_TRIGGER_SLOPE,
  48         SR_HWCAP_HORIZ_TRIGGERPOS,
  49         SR_HWCAP_FILTER,
  50         SR_HWCAP_VDIV,
  51         SR_HWCAP_COUPLING,
  52         0,
  53 };
  54
  55 static const char *probe_names[] = {
  56         "CH1", "CH2",
  57         NULL,
  58 };
  59
  60 static const struct dso_profile dev_profiles[] = {
  61         {       0x04b4, 0x2090, 0x04b5, 0x2090,
  62                 "Hantek", "DSO-2090",
  63                 FIRMWARE_DIR "/hantek-dso-2xxx.fw" },
  64         {       0x04b4, 0x2150, 0x04b5, 0x2150,
  65                 "Hantek", "DSO-2150",
  66                 FIRMWARE_DIR "/hantek-dso-2xxx.fw" },
  67         {       0x04b4, 0x2250, 0x04b5, 0x2250,
  68                 "Hantek", "DSO-2250",
  69                 FIRMWARE_DIR "/hantek-dso-2xxx.fw" },
  70         {       0x04b4, 0x5200, 0x04b5, 0x5200,
  71                 "Hantek", "DSO-5200",
  72                 FIRMWARE_DIR "/hantek-dso-5xxx.fw" },
  73         {       0x04b4, 0x520a, 0x04b5, 0x520a,
  74                 "Hantek", "DSO-5200A",
  75                 FIRMWARE_DIR "/hantek-dso-5xxx.fw" },
  76         { 0, 0, 0, 0, 0, 0, 0 },
  77 };
  78
  79 static const uint64_t buffersizes[] = {
  80         10240,
  81         32768,
  82         /* TODO: 65535 */
  83         0,
  84 };
  85
  86 static const struct sr_rational timebases[] = {
  87         /* microseconds */
  88         { 10, 1000000 },
  89         { 20, 1000000 },
  90         { 40, 1000000 },
  91         { 100, 1000000 },
  92         { 200, 1000000 },
  93         { 400, 1000000 },
  94         /* milliseconds */
  95         { 1, 1000 },
  96         { 2, 1000 },
  97         { 4, 1000 },
  98         { 10, 1000 },
  99         { 20, 1000 },
 100         { 40, 1000 },
 101         { 100, 1000 },
 102         { 200, 1000 },
 103         { 400, 1000 },
 104         { 0, 0},
 105 };
 106
 107 static const struct sr_rational vdivs[] = {
 108         /* millivolts */
 109         { 10, 1000 },
 110         { 20, 1000 },
 111         { 50, 1000 },
 112         { 100, 1000 },
 113         { 200, 1000 },
 114         { 500, 1000 },
 115         /* volts */
 116         { 1, 1 },
 117         { 2, 1 },
 118         { 5, 1 },
 119         { 0, 0 },
 120 };
 121
 122 static const char *trigger_sources[] = {
 123         "CH1",
 124         "CH2",
 125         "EXT",
 126         /* TODO: forced */
 127         NULL,
 128 };
 129
 130 static const char *filter_targets[] = {
 131         "CH1",
 132         "CH2",
 133         /* TODO: "TRIGGER", */
 134         NULL,
 135 };
 136
 137 static const char *coupling[] = {
 138         "AC",
 139         "DC",
 140         "GND",
 141         NULL,
 142 };
 143
 144 SR_PRIV struct sr_dev_driver hantek_dso_driver_info;
 145 static struct sr_dev_driver *di = &hantek_dso_driver_info;
 146
 147 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data);
 148
 149 static struct sr_dev_inst *dso_dev_new(int index, const struct dso_profile *prof)
 150 {
 151         struct sr_dev_inst *sdi;
 152         struct sr_probe *probe;
 153         struct drv_context *drvc;
 154         struct dev_context *devc;
 155         int i;
 156
 157         sdi = sr_dev_inst_new(index, SR_ST_INITIALIZING,
 158                 prof->vendor, prof->model, NULL);
 159         if (!sdi)
 160                 return NULL;
 161         sdi->driver = di;
 162
 163         /*
 164          * Add only the real probes -- EXT isn't a source of data, only
 165          * a trigger source internal to the device.
 166          */
 167         for (i = 0; probe_names[i]; i++) {
 168                 if (!(probe = sr_probe_new(i, SR_PROBE_ANALOG, TRUE,
 169                                 probe_names[i])))
 170                         return NULL;
 171                 sdi->probes = g_slist_append(sdi->probes, probe);
 172         }
 173
 174         if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
 175                 sr_err("Device context malloc failed.");
 176                 return NULL;
 177         }
 178
 179         devc->profile = prof;
 180         devc->dev_state = IDLE;
 181         devc->timebase = DEFAULT_TIMEBASE;
 182         devc->ch1_enabled = TRUE;
 183         devc->ch2_enabled = TRUE;
 184         devc->voltage_ch1 = DEFAULT_VOLTAGE;
 185         devc->voltage_ch2 = DEFAULT_VOLTAGE;
 186         devc->coupling_ch1 = DEFAULT_COUPLING;
 187         devc->coupling_ch2 = DEFAULT_COUPLING;
 188         devc->voffset_ch1 = DEFAULT_VERT_OFFSET;
 189         devc->voffset_ch2 = DEFAULT_VERT_OFFSET;
 190         devc->voffset_trigger = DEFAULT_VERT_TRIGGERPOS;
 191         devc->framesize = DEFAULT_FRAMESIZE;
 192         devc->triggerslope = SLOPE_POSITIVE;
 193         devc->triggersource = g_strdup(DEFAULT_TRIGGER_SOURCE);
 194         devc->triggerposition = DEFAULT_HORIZ_TRIGGERPOS;
 195         sdi->priv = devc;
 196         drvc = di->priv;
 197         drvc->instances = g_slist_append(drvc->instances, sdi);
 198
 199         return sdi;
 200 }
 201
 202 static int configure_probes(const struct sr_dev_inst *sdi)
 203 {
 204         struct dev_context *devc;
 205         const struct sr_probe *probe;
 206         const GSList *l;
 207
 208         devc = sdi->priv;
 209
 210         devc->ch1_enabled = devc->ch2_enabled = FALSE;
 211         for (l = sdi->probes; l; l = l->next) {
 212                 probe = (struct sr_probe *)l->data;
 213                 if (probe->index == 0)
 214                         devc->ch1_enabled = probe->enabled;
 215                 else if (probe->index == 1)
 216                         devc->ch2_enabled = probe->enabled;
 217         }
 218
 219         return SR_OK;
 220 }
 221
 222 /* Properly close and free all devices. */
 223 static int clear_instances(void)
 224 {
 225         struct sr_dev_inst *sdi;
 226         struct drv_context *drvc;
 227         struct dev_context *devc;
 228         GSList *l;
 229
 230         drvc = di->priv;
 231         for (l = drvc->instances; l; l = l->next) {
 232                 if (!(sdi = l->data)) {
 233                         /* Log error, but continue cleaning up the rest. */
 234                         sr_err("%s: sdi was NULL, continuing", __func__);
 235                         continue;
 236                 }
 237                 if (!(devc = sdi->priv)) {
 238                         /* Log error, but continue cleaning up the rest. */
 239                         sr_err("%s: sdi->priv was NULL, continuing", __func__);
 240                         continue;
 241                 }
 242                 dso_close(sdi);
 243                 sr_usb_dev_inst_free(devc->usb);
 244                 g_free(devc->triggersource);
 245
 246                 sr_dev_inst_free(sdi);
 247         }
 248
 249         g_slist_free(drvc->instances);
 250         drvc->instances = NULL;
 251
 252         return SR_OK;
 253 }
 254
 255 static int hw_init(struct sr_context *sr_ctx)
 256 {
 257         struct drv_context *drvc;
 258
 259         if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
 260                 sr_err("Driver context malloc failed.");
 261                 return SR_ERR_MALLOC;
 262         }
 263
 264         drvc->sr_ctx = sr_ctx;
 265         di->priv = drvc;
 266
 267         return SR_OK;
 268 }
 269
 270 static GSList *hw_scan(GSList *options)
 271 {
 272         struct sr_dev_inst *sdi;
 273         const struct dso_profile *prof;
 274         struct drv_context *drvc;
 275         struct dev_context *devc;
 276         GSList *devices;
 277         struct libusb_device_descriptor des;
 278         libusb_device **devlist;
 279         int devcnt, ret, i, j;
 280
 281         (void)options;
 282
 283         devcnt = 0;
 284         devices = 0;
 285         drvc = di->priv;
 286         drvc->instances = NULL;
 287
 288         clear_instances();
 289
 290         /* Find all Hantek DSO devices and upload firmware to all of them. */
 291         libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
 292         for (i = 0; devlist[i]; i++) {
 293                 if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
 294                         sr_err("Failed to get device descriptor: %s.",
 295                                libusb_error_name(ret));
 296                         continue;
 297                 }
 298
 299                 prof = NULL;
 300                 for (j = 0; dev_profiles[j].orig_vid; j++) {
 301                         if (des.idVendor == dev_profiles[j].orig_vid
 302                                 && des.idProduct == dev_profiles[j].orig_pid) {
 303                                 /* Device matches the pre-firmware profile. */
 304                                 prof = &dev_profiles[j];
 305                                 sr_dbg("Found a %s %s.", prof->vendor, prof->model);
 306                                 sdi = dso_dev_new(devcnt, prof);
 307                                 devices = g_slist_append(devices, sdi);
 308                                 devc = sdi->priv;
 309                                 if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
 310                                                 prof->firmware) == SR_OK)
 311                                         /* Remember when the firmware on this device was updated */
 312                                         devc->fw_updated = g_get_monotonic_time();
 313                                 else
 314                                         sr_err("Firmware upload failed for "
 315                                                "device %d.", devcnt);
 316                                 /* Dummy USB address of 0xff will get overwritten later. */
 317                                 devc->usb = sr_usb_dev_inst_new(
 318                                                 libusb_get_bus_number(devlist[i]), 0xff, NULL);
 319                                 devcnt++;
 320                                 break;
 321                         } else if (des.idVendor == dev_profiles[j].fw_vid
 322                                 && des.idProduct == dev_profiles[j].fw_pid) {
 323                                 /* Device matches the post-firmware profile. */
 324                                 prof = &dev_profiles[j];
 325                                 sr_dbg("Found a %s %s.", prof->vendor, prof->model);
 326                                 sdi = dso_dev_new(devcnt, prof);
 327                                 sdi->status = SR_ST_INACTIVE;
 328                                 devices = g_slist_append(devices, sdi);
 329                                 devc = sdi->priv;
 330                                 devc->usb = sr_usb_dev_inst_new(
 331                                                 libusb_get_bus_number(devlist[i]),
 332                                                 libusb_get_device_address(devlist[i]), NULL);
 333                                 devcnt++;
 334                                 break;
 335                         }
 336                 }
 337                 if (!prof)
 338                         /* not a supported VID/PID */
 339                         continue;
 340         }
 341         libusb_free_device_list(devlist, 1);
 342
 343         return devices;
 344 }
 345
 346 static GSList *hw_dev_list(void)
 347 {
 348         struct drv_context *drvc;
 349
 350         drvc = di->priv;
 351
 352         return drvc->instances;
 353 }
 354
 355 static int hw_dev_open(struct sr_dev_inst *sdi)
 356 {
 357         struct dev_context *devc;
 358         int64_t timediff_us, timediff_ms;
 359         int err;
 360
 361         devc = sdi->priv;
 362
 363         /*
 364          * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
 365          * for the FX2 to renumerate.
 366          */
 367         err = SR_ERR;
 368         if (devc->fw_updated > 0) {
 369                 sr_info("Waiting for device to reset.");
 370                 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
 371                 g_usleep(300 * 1000);
 372                 timediff_ms = 0;
 373                 while (timediff_ms < MAX_RENUM_DELAY_MS) {
 374                         if ((err = dso_open(sdi)) == SR_OK)
 375                                 break;
 376                         g_usleep(100 * 1000);
 377                         timediff_us = g_get_monotonic_time() - devc->fw_updated;
 378                         timediff_ms = timediff_us / 1000;
 379                         sr_spew("Waited %" PRIi64 " ms.", timediff_ms);
 380                 }
 381                 sr_info("Device came back after %d ms.", timediff_ms);
 382         } else {
 383                 err = dso_open(sdi);
 384         }
 385
 386         if (err != SR_OK) {
 387                 sr_err("Unable to open device.");
 388                 return SR_ERR;
 389         }
 390
 391         err = libusb_claim_interface(devc->usb->devhdl, USB_INTERFACE);
 392         if (err != 0) {
 393                 sr_err("Unable to claim interface: %s.",
 394                        libusb_error_name(err));
 395                 return SR_ERR;
 396         }
 397
 398         return SR_OK;
 399 }
 400
 401 static int hw_dev_close(struct sr_dev_inst *sdi)
 402 {
 403         dso_close(sdi);
 404
 405         return SR_OK;
 406 }
 407
 408 static int hw_cleanup(void)
 409 {
 410         struct drv_context *drvc;
 411
 412         if (!(drvc = di->priv))
 413                 return SR_OK;
 414
 415         clear_instances();
 416
 417         return SR_OK;
 418 }
 419
 420 static int hw_info_get(int info_id, const void **data,
 421                        const struct sr_dev_inst *sdi)
 422 {
 423         uint64_t tmp;
 424
 425         (void)sdi;
 426
 427         switch (info_id) {
 428         case SR_DI_HWCAPS:
 429                 *data = hwcaps;
 430                 break;
 431         case SR_DI_NUM_PROBES:
 432                 *data = GINT_TO_POINTER(NUM_PROBES);
 433                 break;
 434         case SR_DI_PROBE_NAMES:
 435                 *data = probe_names;
 436                 break;
 437         case SR_DI_BUFFERSIZES:
 438                 *data = buffersizes;
 439                 break;
 440         case SR_DI_TIMEBASES:
 441                 *data = timebases;
 442                 break;
 443         case SR_DI_TRIGGER_SOURCES:
 444                 *data = trigger_sources;
 445                 break;
 446         case SR_DI_FILTERS:
 447                 *data = filter_targets;
 448                 break;
 449         case SR_DI_VDIVS:
 450                 *data = vdivs;
 451                 break;
 452         case SR_DI_COUPLING:
 453                 *data = coupling;
 454                 break;
 455         /* TODO remove this */
 456         case SR_DI_CUR_SAMPLERATE:
 457                 *data = &tmp;
 458                 break;
 459         default:
 460                 return SR_ERR_ARG;
 461         }
 462
 463         return SR_OK;
 464 }
 465
 466 static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
 467                              const void *value)
 468 {
 469         struct dev_context *devc;
 470         struct sr_rational tmp_rat;
 471         float tmp_float;
 472         uint64_t tmp_u64;
 473         int ret, i;
 474         char **targets;
 475
 476         if (sdi->status != SR_ST_ACTIVE)
 477                 return SR_ERR;
 478
 479         ret = SR_OK;
 480         devc = sdi->priv;
 481         switch (hwcap) {
 482         case SR_HWCAP_LIMIT_FRAMES:
 483                 devc->limit_frames = *(const uint64_t *)value;
 484                 break;
 485         case SR_HWCAP_TRIGGER_SLOPE:
 486                 tmp_u64 = *(const int *)value;
 487                 if (tmp_u64 != SLOPE_NEGATIVE && tmp_u64 != SLOPE_POSITIVE)
 488                         ret = SR_ERR_ARG;
 489                 devc->triggerslope = tmp_u64;
 490                 break;
 491         case SR_HWCAP_HORIZ_TRIGGERPOS:
 492                 tmp_float = *(const float *)value;
 493                 if (tmp_float < 0.0 || tmp_float > 1.0) {
 494                         sr_err("Trigger position should be between 0.0 and 1.0.");
 495                         ret = SR_ERR_ARG;
 496                 } else
 497                         devc->triggerposition = tmp_float;
 498                 break;
 499         case SR_HWCAP_BUFFERSIZE:
 500                 tmp_u64 = *(const int *)value;
 501                 for (i = 0; buffersizes[i]; i++) {
 502                         if (buffersizes[i] == tmp_u64) {
 503                                 devc->framesize = tmp_u64;
 504                                 break;
 505                         }
 506                 }
 507                 if (buffersizes[i] == 0)
 508                         ret = SR_ERR_ARG;
 509                 break;
 510         case SR_HWCAP_TIMEBASE:
 511                 tmp_rat = *(const struct sr_rational *)value;
 512                 for (i = 0; timebases[i].p && timebases[i].q; i++) {
 513                         if (timebases[i].p == tmp_rat.p
 514                                         && timebases[i].q == tmp_rat.q) {
 515                                 devc->timebase = i;
 516                                 break;
 517                         }
 518                 }
 519                 if (timebases[i].p == 0 && timebases[i].q == 0)
 520                         ret = SR_ERR_ARG;
 521                 break;
 522         case SR_HWCAP_TRIGGER_SOURCE:
 523                 for (i = 0; trigger_sources[i]; i++) {
 524                         if (!strcmp(value, trigger_sources[i])) {
 525                                 devc->triggersource = g_strdup(value);
 526                                 break;
 527                         }
 528                 }
 529                 if (trigger_sources[i] == 0)
 530                         ret = SR_ERR_ARG;
 531                 break;
 532         case SR_HWCAP_FILTER:
 533                 devc->filter_ch1 = devc->filter_ch2 = devc->filter_trigger = 0;
 534                 targets = g_strsplit(value, ",", 0);
 535                 for (i = 0; targets[i]; i++) {
 536                         if (targets[i] == '\0')
 537                                 /* Empty filter string can be used to clear them all. */
 538                                 ;
 539                         else if (!strcmp(targets[i], "CH1"))
 540                                 devc->filter_ch1 = TRUE;
 541                         else if (!strcmp(targets[i], "CH2"))
 542                                 devc->filter_ch2 = TRUE;
 543                         else if (!strcmp(targets[i], "TRIGGER"))
 544                                 devc->filter_trigger = TRUE;
 545                         else {
 546                                 sr_err("Invalid filter target %s.", targets[i]);
 547                                 ret = SR_ERR_ARG;
 548                         }
 549                 }
 550                 g_strfreev(targets);
 551                 break;
 552         case SR_HWCAP_VDIV:
 553                 /* TODO: Not supporting vdiv per channel yet. */
 554                 tmp_rat = *(const struct sr_rational *)value;
 555                 for (i = 0; vdivs[i].p && vdivs[i].q; i++) {
 556                         if (vdivs[i].p == tmp_rat.p
 557                                         && vdivs[i].q == tmp_rat.q) {
 558                                 devc->voltage_ch1 = i;
 559                                 devc->voltage_ch2 = i;
 560                                 break;
 561                         }
 562                 }
 563                 if (vdivs[i].p == 0 && vdivs[i].q == 0)
 564                         ret = SR_ERR_ARG;
 565                 break;
 566         case SR_HWCAP_COUPLING:
 567                 /* TODO: Not supporting coupling per channel yet. */
 568                 for (i = 0; coupling[i]; i++) {
 569                         if (!strcmp(value, coupling[i])) {
 570                                 devc->coupling_ch1 = i;
 571                                 devc->coupling_ch2 = i;
 572                                 break;
 573                         }
 574                 }
 575                 if (coupling[i] == 0)
 576                         ret = SR_ERR_ARG;
 577                 break;
 578         default:
 579                 ret = SR_ERR_ARG;
 580                 break;
 581         }
 582
 583         return ret;
 584 }
 585
 586 static void send_chunk(struct dev_context *devc, unsigned char *buf,
 587                 int num_samples)
 588 {
 589         struct sr_datafeed_packet packet;
 590         struct sr_datafeed_analog analog;
 591         float ch1, ch2, range;
 592         int num_probes, data_offset, i;
 593
 594         num_probes = (devc->ch1_enabled && devc->ch2_enabled) ? 2 : 1;
 595         packet.type = SR_DF_ANALOG;
 596         packet.payload = &analog;
 597         /* TODO: support for 5xxx series 9-bit samples */
 598         analog.num_samples = num_samples;
 599         analog.mq = SR_MQ_VOLTAGE;
 600         analog.unit = SR_UNIT_VOLT;
 601         /* TODO: Check malloc return value. */
 602         analog.data = g_try_malloc(analog.num_samples * sizeof(float) * num_probes);
 603         data_offset = 0;
 604         for (i = 0; i < analog.num_samples; i++) {
 605                 /*
 606                  * The device always sends data for both channels. If a channel
 607                  * is disabled, it contains a copy of the enabled channel's
 608                  * data. However, we only send the requested channels to
 609                  * the bus.
 610                  *
 611                  * Voltage values are encoded as a value 0-255 (0-512 on the
 612                  * DSO-5200*), where the value is a point in the range
 613                  * represented by the vdiv setting. There are 8 vertical divs,
 614                  * so e.g. 500mV/div represents 4V peak-to-peak where 0 = -2V
 615                  * and 255 = +2V.
 616                  */
 617                 /* TODO: Support for DSO-5xxx series 9-bit samples. */
 618                 if (devc->ch1_enabled) {
 619                         range = ((float)vdivs[devc->voltage_ch1].p / vdivs[devc->voltage_ch1].q) * 8;
 620                         ch1 = range / 255 * *(buf + i * 2 + 1);
 621                         /* Value is centered around 0V. */
 622                         ch1 -= range / 2;
 623                         analog.data[data_offset++] = ch1;
 624                 }
 625                 if (devc->ch2_enabled) {
 626                         range = ((float)vdivs[devc->voltage_ch2].p / vdivs[devc->voltage_ch2].q) * 8;
 627                         ch2 = range / 255 * *(buf + i * 2);
 628                         ch2 -= range / 2;
 629                         analog.data[data_offset++] = ch2;
 630                 }
 631         }
 632         sr_session_send(devc->cb_data, &packet);
 633 }
 634
 635 /*
 636  * Called by libusb (as triggered by handle_event()) when a transfer comes in.
 637  * Only channel data comes in asynchronously, and all transfers for this are
 638  * queued up beforehand, so this just needs to chuck the incoming data onto
 639  * the libsigrok session bus.
 640  */
 641 static void receive_transfer(struct libusb_transfer *transfer)
 642 {
 643         struct sr_datafeed_packet packet;
 644         struct dev_context *devc;
 645         int num_samples, pre;
 646
 647         devc = transfer->user_data;
 648         sr_dbg("receive_transfer(): status %d received %d bytes.",
 649                transfer->status, transfer->actual_length);
 650
 651         if (transfer->actual_length == 0)
 652                 /* Nothing to send to the bus. */
 653                 return;
 654
 655         num_samples = transfer->actual_length / 2;
 656
 657         sr_dbg("Got %d-%d/%d samples in frame.", devc->samp_received + 1,
 658                devc->samp_received + num_samples, devc->framesize);
 659
 660         /*
 661          * The device always sends a full frame, but the beginning of the frame
 662          * doesn't represent the trigger point. The offset at which the trigger
 663          * happened came in with the capture state, so we need to start sending
 664          * from there up the session bus. The samples in the frame buffer
 665          * before that trigger point came after the end of the device's frame
 666          * buffer was reached, and it wrapped around to overwrite up until the
 667          * trigger point.
 668          */
 669         if (devc->samp_received < devc->trigger_offset) {
 670                 /* Trigger point not yet reached. */
 671                 if (devc->samp_received + num_samples < devc->trigger_offset) {
 672                         /* The entire chunk is before the trigger point. */
 673                         memcpy(devc->framebuf + devc->samp_buffered * 2,
 674                                         transfer->buffer, num_samples * 2);
 675                         devc->samp_buffered += num_samples;
 676                 } else {
 677                         /*
 678                          * This chunk hits or overruns the trigger point.
 679                          * Store the part before the trigger fired, and
 680                          * send the rest up to the session bus.
 681                          */
 682                         pre = devc->trigger_offset - devc->samp_received;
 683                         memcpy(devc->framebuf + devc->samp_buffered * 2,
 684                                         transfer->buffer, pre * 2);
 685                         devc->samp_buffered += pre;
 686
 687                         /* The rest of this chunk starts with the trigger point. */
 688                         sr_dbg("Reached trigger point, %d samples buffered.",
 689                                devc->samp_buffered);
 690
 691                         /* Avoid the corner case where the chunk ended at
 692                          * exactly the trigger point. */
 693                         if (num_samples > pre)
 694                                 send_chunk(devc, transfer->buffer + pre * 2,
 695                                                 num_samples - pre);
 696                 }
 697         } else {
 698                 /* Already past the trigger point, just send it all out. */
 699                 send_chunk(devc, transfer->buffer,
 700                                 num_samples);
 701         }
 702
 703         devc->samp_received += num_samples;
 704
 705         /* Everything in this transfer was either copied to the buffer or
 706          * sent to the session bus. */
 707         g_free(transfer->buffer);
 708         libusb_free_transfer(transfer);
 709
 710         if (devc->samp_received >= devc->framesize) {
 711                 /* That was the last chunk in this frame. Send the buffered
 712                  * pre-trigger samples out now, in one big chunk. */
 713                 sr_dbg("End of frame, sending %d pre-trigger buffered samples.",
 714                        devc->samp_buffered);
 715                 send_chunk(devc, devc->framebuf, devc->samp_buffered);
 716
 717                 /* Mark the end of this frame. */
 718                 packet.type = SR_DF_FRAME_END;
 719                 sr_session_send(devc->cb_data, &packet);
 720
 721                 if (devc->limit_frames && ++devc->num_frames == devc->limit_frames) {
 722                         /* Terminate session */
 723                         devc->dev_state = STOPPING;
 724                 } else {
 725                         devc->dev_state = NEW_CAPTURE;
 726                 }
 727         }
 728 }
 729
 730 static int handle_event(int fd, int revents, void *cb_data)
 731 {
 732         const struct sr_dev_inst *sdi;
 733         struct sr_datafeed_packet packet;
 734         struct timeval tv;
 735         struct dev_context *devc;
 736         struct drv_context *drvc = di->priv;
 737         const struct libusb_pollfd **lupfd;
 738         int num_probes, i;
 739         uint32_t trigger_offset;
 740         uint8_t capturestate;
 741
 742         (void)fd;
 743         (void)revents;
 744
 745         sdi = cb_data;
 746         devc = sdi->priv;
 747         if (devc->dev_state == STOPPING) {
 748                 /* We've been told to wind up the acquisition. */
 749                 sr_dbg("Stopping acquisition.");
 750                 /*
 751                  * TODO: Doesn't really cancel pending transfers so they might
 752                  * come in after SR_DF_END is sent.
 753                  */
 754                 lupfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
 755                 for (i = 0; lupfd[i]; i++)
 756                         sr_source_remove(lupfd[i]->fd);
 757                 free(lupfd);
 758
 759                 packet.type = SR_DF_END;
 760                 sr_session_send(sdi, &packet);
 761
 762                 devc->dev_state = IDLE;
 763
 764                 return TRUE;
 765         }
 766
 767         /* Always handle pending libusb events. */
 768         tv.tv_sec = tv.tv_usec = 0;
 769         libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
 770
 771         /* TODO: ugh */
 772         if (devc->dev_state == NEW_CAPTURE) {
 773                 if (dso_capture_start(devc) != SR_OK)
 774                         return TRUE;
 775                 if (dso_enable_trigger(devc) != SR_OK)
 776                         return TRUE;
 777 //              if (dso_force_trigger(devc) != SR_OK)
 778 //                      return TRUE;
 779                 sr_dbg("Successfully requested next chunk.");
 780                 devc->dev_state = CAPTURE;
 781                 return TRUE;
 782         }
 783         if (devc->dev_state != CAPTURE)
 784                 return TRUE;
 785
 786         if ((dso_get_capturestate(devc, &capturestate, &trigger_offset)) != SR_OK)
 787                 return TRUE;
 788
 789         sr_dbg("Capturestate %d.", capturestate);
 790         sr_dbg("Trigger offset 0x%.6x.", trigger_offset);
 791         switch (capturestate) {
 792         case CAPTURE_EMPTY:
 793                 if (++devc->capture_empty_count >= MAX_CAPTURE_EMPTY) {
 794                         devc->capture_empty_count = 0;
 795                         if (dso_capture_start(devc) != SR_OK)
 796                                 break;
 797                         if (dso_enable_trigger(devc) != SR_OK)
 798                                 break;
 799 //                      if (dso_force_trigger(devc) != SR_OK)
 800 //                              break;
 801                         sr_dbg("Successfully requested next chunk.");
 802                 }
 803                 break;
 804         case CAPTURE_FILLING:
 805                 /* No data yet. */
 806                 break;
 807         case CAPTURE_READY_8BIT:
 808                 /* Remember where in the captured frame the trigger is. */
 809                 devc->trigger_offset = trigger_offset;
 810
 811                 num_probes = (devc->ch1_enabled && devc->ch2_enabled) ? 2 : 1;
 812                 /* TODO: Check malloc return value. */
 813                 devc->framebuf = g_try_malloc(devc->framesize * num_probes * 2);
 814                 devc->samp_buffered = devc->samp_received = 0;
 815
 816                 /* Tell the scope to send us the first frame. */
 817                 if (dso_get_channeldata(devc, receive_transfer) != SR_OK)
 818                         break;
 819
 820                 /*
 821                  * Don't hit the state machine again until we're done fetching
 822                  * the data we just told the scope to send.
 823                  */
 824                 devc->dev_state = FETCH_DATA;
 825
 826                 /* Tell the frontend a new frame is on the way. */
 827                 packet.type = SR_DF_FRAME_BEGIN;
 828                 sr_session_send(sdi, &packet);
 829                 break;
 830         case CAPTURE_READY_9BIT:
 831                 /* TODO */
 832                 sr_err("Not yet supported.");
 833                 break;
 834         case CAPTURE_TIMEOUT:
 835                 /* Doesn't matter, we'll try again next time. */
 836                 break;
 837         default:
 838                 sr_dbg("Unknown capture state: %d.", capturestate);
 839                 break;
 840         }
 841
 842         return TRUE;
 843 }
 844
 845 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
 846                                     void *cb_data)
 847 {
 848         const struct libusb_pollfd **lupfd;
 849         struct sr_datafeed_packet packet;
 850         struct sr_datafeed_header header;
 851         struct sr_datafeed_meta_analog meta;
 852         struct dev_context *devc;
 853         struct drv_context *drvc = di->priv;
 854         int i;
 855
 856         if (sdi->status != SR_ST_ACTIVE)
 857                 return SR_ERR;
 858
 859         devc = sdi->priv;
 860         devc->cb_data = cb_data;
 861
 862         if (configure_probes(sdi) != SR_OK) {
 863                 sr_err("Failed to configure probes.");
 864                 return SR_ERR;
 865         }
 866
 867         if (dso_init(devc) != SR_OK)
 868                 return SR_ERR;
 869
 870         if (dso_capture_start(devc) != SR_OK)
 871                 return SR_ERR;
 872
 873         devc->dev_state = CAPTURE;
 874         lupfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
 875         for (i = 0; lupfd[i]; i++)
 876                 sr_source_add(lupfd[i]->fd, lupfd[i]->events, TICK,
 877                               handle_event, (void *)sdi);
 878         free(lupfd);
 879
 880         /* Send header packet to the session bus. */
 881         packet.type = SR_DF_HEADER;
 882         packet.payload = (unsigned char *)&header;
 883         header.feed_version = 1;
 884         gettimeofday(&header.starttime, NULL);
 885         sr_session_send(cb_data, &packet);
 886
 887         /* Send metadata about the SR_DF_ANALOG packets to come. */
 888         packet.type = SR_DF_META_ANALOG;
 889         packet.payload = &meta;
 890         meta.num_probes = NUM_PROBES;
 891         sr_session_send(cb_data, &packet);
 892
 893         return SR_OK;
 894 }
 895
 896 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 897 {
 898         struct dev_context *devc;
 899
 900         (void)cb_data;
 901
 902         if (sdi->status != SR_ST_ACTIVE)
 903                 return SR_ERR;
 904
 905         devc = sdi->priv;
 906         devc->dev_state = STOPPING;
 907
 908         return SR_OK;
 909 }
 910
 911 SR_PRIV struct sr_dev_driver hantek_dso_driver_info = {
 912         .name = "hantek-dso",
 913         .longname = "Hantek DSO",
 914         .api_version = 1,
 915         .init = hw_init,
 916         .cleanup = hw_cleanup,
 917         .scan = hw_scan,
 918         .dev_list = hw_dev_list,
 919         .dev_clear = clear_instances,
 920         .dev_open = hw_dev_open,
 921         .dev_close = hw_dev_close,
 922         .info_get = hw_info_get,
 923         .dev_config_set = hw_dev_config_set,
 924         .dev_acquisition_start = hw_dev_acquisition_start,
 925         .dev_acquisition_stop = hw_dev_acquisition_stop,
 926         .priv = NULL,
 927 };