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