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_CONF_OSCILLOSCOPE,
  42         SR_CONF_LIMIT_SAMPLES,
  43         SR_CONF_CONTINUOUS,
  44         SR_CONF_TIMEBASE,
  45         SR_CONF_BUFFERSIZE,
  46         SR_CONF_TRIGGER_SOURCE,
  47         SR_CONF_TRIGGER_SLOPE,
  48         SR_CONF_HORIZ_TRIGGERPOS,
  49         SR_CONF_FILTER,
  50         SR_CONF_VDIV,
  51         SR_CONF_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         struct sr_probe *probe;
 206         const GSList *l;
 207         int p;
 208
 209         devc = sdi->priv;
 210
 211         g_slist_free(devc->enabled_probes);
 212         devc->ch1_enabled = devc->ch2_enabled = FALSE;
 213         for (l = sdi->probes, p = 0; l; l = l->next, p++) {
 214                 probe = l->data;
 215                 if (p == 0)
 216                         devc->ch1_enabled = probe->enabled;
 217                 else
 218                         devc->ch2_enabled = probe->enabled;
 219                 if (probe->enabled)
 220                         devc->enabled_probes = g_slist_append(devc->enabled_probes, probe);
 221         }
 222
 223         return SR_OK;
 224 }
 225
 226 /* Properly close and free all devices. */
 227 static int clear_instances(void)
 228 {
 229         struct sr_dev_inst *sdi;
 230         struct drv_context *drvc;
 231         struct dev_context *devc;
 232         GSList *l;
 233
 234         drvc = di->priv;
 235         for (l = drvc->instances; l; l = l->next) {
 236                 if (!(sdi = l->data)) {
 237                         /* Log error, but continue cleaning up the rest. */
 238                         sr_err("%s: sdi was NULL, continuing", __func__);
 239                         continue;
 240                 }
 241                 if (!(devc = sdi->priv)) {
 242                         /* Log error, but continue cleaning up the rest. */
 243                         sr_err("%s: sdi->priv was NULL, continuing", __func__);
 244                         continue;
 245                 }
 246                 dso_close(sdi);
 247                 sr_usb_dev_inst_free(devc->usb);
 248                 g_free(devc->triggersource);
 249                 g_slist_free(devc->enabled_probes);
 250
 251                 sr_dev_inst_free(sdi);
 252         }
 253
 254         g_slist_free(drvc->instances);
 255         drvc->instances = NULL;
 256
 257         return SR_OK;
 258 }
 259
 260 static int hw_init(struct sr_context *sr_ctx)
 261 {
 262         return std_hw_init(sr_ctx, di, DRIVER_LOG_DOMAIN);
 263 }
 264
 265 static GSList *hw_scan(GSList *options)
 266 {
 267         struct sr_dev_inst *sdi;
 268         const struct dso_profile *prof;
 269         struct drv_context *drvc;
 270         struct dev_context *devc;
 271         GSList *devices;
 272         struct libusb_device_descriptor des;
 273         libusb_device **devlist;
 274         int devcnt, ret, i, j;
 275
 276         (void)options;
 277
 278         drvc = di->priv;
 279         drvc->instances = NULL;
 280
 281         devcnt = 0;
 282         devices = 0;
 283
 284         clear_instances();
 285
 286         /* Find all Hantek DSO devices and upload firmware to all of them. */
 287         libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
 288         for (i = 0; devlist[i]; i++) {
 289                 if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
 290                         sr_err("Failed to get device descriptor: %s.",
 291                                libusb_error_name(ret));
 292                         continue;
 293                 }
 294
 295                 prof = NULL;
 296                 for (j = 0; dev_profiles[j].orig_vid; j++) {
 297                         if (des.idVendor == dev_profiles[j].orig_vid
 298                                 && des.idProduct == dev_profiles[j].orig_pid) {
 299                                 /* Device matches the pre-firmware profile. */
 300                                 prof = &dev_profiles[j];
 301                                 sr_dbg("Found a %s %s.", prof->vendor, prof->model);
 302                                 sdi = dso_dev_new(devcnt, prof);
 303                                 devices = g_slist_append(devices, sdi);
 304                                 devc = sdi->priv;
 305                                 if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
 306                                                 prof->firmware) == SR_OK)
 307                                         /* Remember when the firmware on this device was updated */
 308                                         devc->fw_updated = g_get_monotonic_time();
 309                                 else
 310                                         sr_err("Firmware upload failed for "
 311                                                "device %d.", devcnt);
 312                                 /* Dummy USB address of 0xff will get overwritten later. */
 313                                 devc->usb = sr_usb_dev_inst_new(
 314                                                 libusb_get_bus_number(devlist[i]), 0xff, NULL);
 315                                 devcnt++;
 316                                 break;
 317                         } else if (des.idVendor == dev_profiles[j].fw_vid
 318                                 && des.idProduct == dev_profiles[j].fw_pid) {
 319                                 /* Device matches the post-firmware profile. */
 320                                 prof = &dev_profiles[j];
 321                                 sr_dbg("Found a %s %s.", prof->vendor, prof->model);
 322                                 sdi = dso_dev_new(devcnt, prof);
 323                                 sdi->status = SR_ST_INACTIVE;
 324                                 devices = g_slist_append(devices, sdi);
 325                                 devc = sdi->priv;
 326                                 devc->usb = sr_usb_dev_inst_new(
 327                                                 libusb_get_bus_number(devlist[i]),
 328                                                 libusb_get_device_address(devlist[i]), NULL);
 329                                 devcnt++;
 330                                 break;
 331                         }
 332                 }
 333                 if (!prof)
 334                         /* not a supported VID/PID */
 335                         continue;
 336         }
 337         libusb_free_device_list(devlist, 1);
 338
 339         return devices;
 340 }
 341
 342 static GSList *hw_dev_list(void)
 343 {
 344         return ((struct drv_context *)(di->priv))->instances;
 345 }
 346
 347 static int hw_dev_open(struct sr_dev_inst *sdi)
 348 {
 349         struct dev_context *devc;
 350         int64_t timediff_us, timediff_ms;
 351         int err;
 352
 353         devc = sdi->priv;
 354
 355         /*
 356          * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
 357          * for the FX2 to renumerate.
 358          */
 359         err = SR_ERR;
 360         if (devc->fw_updated > 0) {
 361                 sr_info("Waiting for device to reset.");
 362                 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
 363                 g_usleep(300 * 1000);
 364                 timediff_ms = 0;
 365                 while (timediff_ms < MAX_RENUM_DELAY_MS) {
 366                         if ((err = dso_open(sdi)) == SR_OK)
 367                                 break;
 368                         g_usleep(100 * 1000);
 369                         timediff_us = g_get_monotonic_time() - devc->fw_updated;
 370                         timediff_ms = timediff_us / 1000;
 371                         sr_spew("Waited %" PRIi64 " ms.", timediff_ms);
 372                 }
 373                 sr_info("Device came back after %d ms.", timediff_ms);
 374         } else {
 375                 err = dso_open(sdi);
 376         }
 377
 378         if (err != SR_OK) {
 379                 sr_err("Unable to open device.");
 380                 return SR_ERR;
 381         }
 382
 383         err = libusb_claim_interface(devc->usb->devhdl, USB_INTERFACE);
 384         if (err != 0) {
 385                 sr_err("Unable to claim interface: %s.",
 386                        libusb_error_name(err));
 387                 return SR_ERR;
 388         }
 389
 390         return SR_OK;
 391 }
 392
 393 static int hw_dev_close(struct sr_dev_inst *sdi)
 394 {
 395         dso_close(sdi);
 396
 397         return SR_OK;
 398 }
 399
 400 static int hw_cleanup(void)
 401 {
 402         struct drv_context *drvc;
 403
 404         if (!(drvc = di->priv))
 405                 return SR_OK;
 406
 407         clear_instances();
 408
 409         return SR_OK;
 410 }
 411
 412 static int config_set(int id, const void *value, const struct sr_dev_inst *sdi)
 413 {
 414         struct dev_context *devc;
 415         struct sr_rational tmp_rat;
 416         float tmp_float;
 417         uint64_t tmp_u64;
 418         int ret, i;
 419         char **targets;
 420
 421         if (sdi->status != SR_ST_ACTIVE)
 422                 return SR_ERR;
 423
 424         ret = SR_OK;
 425         devc = sdi->priv;
 426         switch (id) {
 427         case SR_CONF_LIMIT_FRAMES:
 428                 devc->limit_frames = *(const uint64_t *)value;
 429                 break;
 430         case SR_CONF_TRIGGER_SLOPE:
 431                 tmp_u64 = *(const int *)value;
 432                 if (tmp_u64 != SLOPE_NEGATIVE && tmp_u64 != SLOPE_POSITIVE)
 433                         ret = SR_ERR_ARG;
 434                 devc->triggerslope = tmp_u64;
 435                 break;
 436         case SR_CONF_HORIZ_TRIGGERPOS:
 437                 tmp_float = *(const float *)value;
 438                 if (tmp_float < 0.0 || tmp_float > 1.0) {
 439                         sr_err("Trigger position should be between 0.0 and 1.0.");
 440                         ret = SR_ERR_ARG;
 441                 } else
 442                         devc->triggerposition = tmp_float;
 443                 break;
 444         case SR_CONF_BUFFERSIZE:
 445                 tmp_u64 = *(const int *)value;
 446                 for (i = 0; buffersizes[i]; i++) {
 447                         if (buffersizes[i] == tmp_u64) {
 448                                 devc->framesize = tmp_u64;
 449                                 break;
 450                         }
 451                 }
 452                 if (buffersizes[i] == 0)
 453                         ret = SR_ERR_ARG;
 454                 break;
 455         case SR_CONF_TIMEBASE:
 456                 tmp_rat = *(const struct sr_rational *)value;
 457                 for (i = 0; timebases[i].p && timebases[i].q; i++) {
 458                         if (timebases[i].p == tmp_rat.p
 459                                         && timebases[i].q == tmp_rat.q) {
 460                                 devc->timebase = i;
 461                                 break;
 462                         }
 463                 }
 464                 if (timebases[i].p == 0 && timebases[i].q == 0)
 465                         ret = SR_ERR_ARG;
 466                 break;
 467         case SR_CONF_TRIGGER_SOURCE:
 468                 for (i = 0; trigger_sources[i]; i++) {
 469                         if (!strcmp(value, trigger_sources[i])) {
 470                                 devc->triggersource = g_strdup(value);
 471                                 break;
 472                         }
 473                 }
 474                 if (trigger_sources[i] == 0)
 475                         ret = SR_ERR_ARG;
 476                 break;
 477         case SR_CONF_FILTER:
 478                 devc->filter_ch1 = devc->filter_ch2 = devc->filter_trigger = 0;
 479                 targets = g_strsplit(value, ",", 0);
 480                 for (i = 0; targets[i]; i++) {
 481                         if (targets[i] == '\0')
 482                                 /* Empty filter string can be used to clear them all. */
 483                                 ;
 484                         else if (!strcmp(targets[i], "CH1"))
 485                                 devc->filter_ch1 = TRUE;
 486                         else if (!strcmp(targets[i], "CH2"))
 487                                 devc->filter_ch2 = TRUE;
 488                         else if (!strcmp(targets[i], "TRIGGER"))
 489                                 devc->filter_trigger = TRUE;
 490                         else {
 491                                 sr_err("Invalid filter target %s.", targets[i]);
 492                                 ret = SR_ERR_ARG;
 493                         }
 494                 }
 495                 g_strfreev(targets);
 496                 break;
 497         case SR_CONF_VDIV:
 498                 /* TODO: Not supporting vdiv per channel yet. */
 499                 tmp_rat = *(const struct sr_rational *)value;
 500                 for (i = 0; vdivs[i].p && vdivs[i].q; i++) {
 501                         if (vdivs[i].p == tmp_rat.p
 502                                         && vdivs[i].q == tmp_rat.q) {
 503                                 devc->voltage_ch1 = i;
 504                                 devc->voltage_ch2 = i;
 505                                 break;
 506                         }
 507                 }
 508                 if (vdivs[i].p == 0 && vdivs[i].q == 0)
 509                         ret = SR_ERR_ARG;
 510                 break;
 511         case SR_CONF_COUPLING:
 512                 /* TODO: Not supporting coupling per channel yet. */
 513                 for (i = 0; coupling[i]; i++) {
 514                         if (!strcmp(value, coupling[i])) {
 515                                 devc->coupling_ch1 = i;
 516                                 devc->coupling_ch2 = i;
 517                                 break;
 518                         }
 519                 }
 520                 if (coupling[i] == 0)
 521                         ret = SR_ERR_ARG;
 522                 break;
 523         default:
 524                 ret = SR_ERR_ARG;
 525                 break;
 526         }
 527
 528         return ret;
 529 }
 530
 531 static int config_list(int key, const void **data, const struct sr_dev_inst *sdi)
 532 {
 533
 534         (void)sdi;
 535
 536         switch (key) {
 537         case SR_CONF_DEVICE_OPTIONS:
 538                 *data = hwcaps;
 539                 break;
 540         case SR_CONF_BUFFERSIZE:
 541                 *data = buffersizes;
 542                 break;
 543         case SR_CONF_COUPLING:
 544                 *data = coupling;
 545                 break;
 546         case SR_CONF_VDIV:
 547                 *data = vdivs;
 548                 break;
 549         case SR_CONF_FILTER:
 550                 *data = filter_targets;
 551                 break;
 552         case SR_CONF_TIMEBASE:
 553                 *data = timebases;
 554                 break;
 555         case SR_CONF_TRIGGER_SOURCE:
 556                 *data = trigger_sources;
 557                 break;
 558         default:
 559                 return SR_ERR_ARG;
 560         }
 561
 562         return SR_OK;
 563 }
 564
 565 static void send_chunk(struct sr_dev_inst *sdi, unsigned char *buf,
 566                 int num_samples)
 567 {
 568         struct sr_datafeed_packet packet;
 569         struct sr_datafeed_analog analog;
 570         struct dev_context *devc;
 571         float ch1, ch2, range;
 572         int num_probes, data_offset, i;
 573
 574         devc = sdi->priv;
 575         num_probes = (devc->ch1_enabled && devc->ch2_enabled) ? 2 : 1;
 576         packet.type = SR_DF_ANALOG;
 577         packet.payload = &analog;
 578         /* TODO: support for 5xxx series 9-bit samples */
 579         analog.probes = devc->enabled_probes;
 580         analog.num_samples = num_samples;
 581         analog.mq = SR_MQ_VOLTAGE;
 582         analog.unit = SR_UNIT_VOLT;
 583         /* TODO: Check malloc return value. */
 584         analog.data = g_try_malloc(analog.num_samples * sizeof(float) * num_probes);
 585         data_offset = 0;
 586         for (i = 0; i < analog.num_samples; i++) {
 587                 /*
 588                  * The device always sends data for both channels. If a channel
 589                  * is disabled, it contains a copy of the enabled channel's
 590                  * data. However, we only send the requested channels to
 591                  * the bus.
 592                  *
 593                  * Voltage values are encoded as a value 0-255 (0-512 on the
 594                  * DSO-5200*), where the value is a point in the range
 595                  * represented by the vdiv setting. There are 8 vertical divs,
 596                  * so e.g. 500mV/div represents 4V peak-to-peak where 0 = -2V
 597                  * and 255 = +2V.
 598                  */
 599                 /* TODO: Support for DSO-5xxx series 9-bit samples. */
 600                 if (devc->ch1_enabled) {
 601                         range = ((float)vdivs[devc->voltage_ch1].p / vdivs[devc->voltage_ch1].q) * 8;
 602                         ch1 = range / 255 * *(buf + i * 2 + 1);
 603                         /* Value is centered around 0V. */
 604                         ch1 -= range / 2;
 605                         analog.data[data_offset++] = ch1;
 606                 }
 607                 if (devc->ch2_enabled) {
 608                         range = ((float)vdivs[devc->voltage_ch2].p / vdivs[devc->voltage_ch2].q) * 8;
 609                         ch2 = range / 255 * *(buf + i * 2);
 610                         ch2 -= range / 2;
 611                         analog.data[data_offset++] = ch2;
 612                 }
 613         }
 614         sr_session_send(devc->cb_data, &packet);
 615 }
 616
 617 /*
 618  * Called by libusb (as triggered by handle_event()) when a transfer comes in.
 619  * Only channel data comes in asynchronously, and all transfers for this are
 620  * queued up beforehand, so this just needs to chuck the incoming data onto
 621  * the libsigrok session bus.
 622  */
 623 static void receive_transfer(struct libusb_transfer *transfer)
 624 {
 625         struct sr_datafeed_packet packet;
 626         struct sr_dev_inst *sdi;
 627         struct dev_context *devc;
 628         int num_samples, pre;
 629
 630         sdi = transfer->user_data;
 631         devc = sdi->priv;
 632         sr_dbg("receive_transfer(): status %d received %d bytes.",
 633                transfer->status, transfer->actual_length);
 634
 635         if (transfer->actual_length == 0)
 636                 /* Nothing to send to the bus. */
 637                 return;
 638
 639         num_samples = transfer->actual_length / 2;
 640
 641         sr_dbg("Got %d-%d/%d samples in frame.", devc->samp_received + 1,
 642                devc->samp_received + num_samples, devc->framesize);
 643
 644         /*
 645          * The device always sends a full frame, but the beginning of the frame
 646          * doesn't represent the trigger point. The offset at which the trigger
 647          * happened came in with the capture state, so we need to start sending
 648          * from there up the session bus. The samples in the frame buffer
 649          * before that trigger point came after the end of the device's frame
 650          * buffer was reached, and it wrapped around to overwrite up until the
 651          * trigger point.
 652          */
 653         if (devc->samp_received < devc->trigger_offset) {
 654                 /* Trigger point not yet reached. */
 655                 if (devc->samp_received + num_samples < devc->trigger_offset) {
 656                         /* The entire chunk is before the trigger point. */
 657                         memcpy(devc->framebuf + devc->samp_buffered * 2,
 658                                         transfer->buffer, num_samples * 2);
 659                         devc->samp_buffered += num_samples;
 660                 } else {
 661                         /*
 662                          * This chunk hits or overruns the trigger point.
 663                          * Store the part before the trigger fired, and
 664                          * send the rest up to the session bus.
 665                          */
 666                         pre = devc->trigger_offset - devc->samp_received;
 667                         memcpy(devc->framebuf + devc->samp_buffered * 2,
 668                                         transfer->buffer, pre * 2);
 669                         devc->samp_buffered += pre;
 670
 671                         /* The rest of this chunk starts with the trigger point. */
 672                         sr_dbg("Reached trigger point, %d samples buffered.",
 673                                devc->samp_buffered);
 674
 675                         /* Avoid the corner case where the chunk ended at
 676                          * exactly the trigger point. */
 677                         if (num_samples > pre)
 678                                 send_chunk(sdi, transfer->buffer + pre * 2,
 679                                                 num_samples - pre);
 680                 }
 681         } else {
 682                 /* Already past the trigger point, just send it all out. */
 683                 send_chunk(sdi, transfer->buffer,
 684                                 num_samples);
 685         }
 686
 687         devc->samp_received += num_samples;
 688
 689         /* Everything in this transfer was either copied to the buffer or
 690          * sent to the session bus. */
 691         g_free(transfer->buffer);
 692         libusb_free_transfer(transfer);
 693
 694         if (devc->samp_received >= devc->framesize) {
 695                 /* That was the last chunk in this frame. Send the buffered
 696                  * pre-trigger samples out now, in one big chunk. */
 697                 sr_dbg("End of frame, sending %d pre-trigger buffered samples.",
 698                        devc->samp_buffered);
 699                 send_chunk(sdi, devc->framebuf, devc->samp_buffered);
 700
 701                 /* Mark the end of this frame. */
 702                 packet.type = SR_DF_FRAME_END;
 703                 sr_session_send(devc->cb_data, &packet);
 704
 705                 if (devc->limit_frames && ++devc->num_frames == devc->limit_frames) {
 706                         /* Terminate session */
 707                         devc->dev_state = STOPPING;
 708                 } else {
 709                         devc->dev_state = NEW_CAPTURE;
 710                 }
 711         }
 712 }
 713
 714 static int handle_event(int fd, int revents, void *cb_data)
 715 {
 716         const struct sr_dev_inst *sdi;
 717         struct sr_datafeed_packet packet;
 718         struct timeval tv;
 719         struct dev_context *devc;
 720         struct drv_context *drvc = di->priv;
 721         const struct libusb_pollfd **lupfd;
 722         int num_probes, i;
 723         uint32_t trigger_offset;
 724         uint8_t capturestate;
 725
 726         (void)fd;
 727         (void)revents;
 728
 729         sdi = cb_data;
 730         devc = sdi->priv;
 731         if (devc->dev_state == STOPPING) {
 732                 /* We've been told to wind up the acquisition. */
 733                 sr_dbg("Stopping acquisition.");
 734                 /*
 735                  * TODO: Doesn't really cancel pending transfers so they might
 736                  * come in after SR_DF_END is sent.
 737                  */
 738                 lupfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
 739                 for (i = 0; lupfd[i]; i++)
 740                         sr_source_remove(lupfd[i]->fd);
 741                 free(lupfd);
 742
 743                 packet.type = SR_DF_END;
 744                 sr_session_send(sdi, &packet);
 745
 746                 devc->dev_state = IDLE;
 747
 748                 return TRUE;
 749         }
 750
 751         /* Always handle pending libusb events. */
 752         tv.tv_sec = tv.tv_usec = 0;
 753         libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
 754
 755         /* TODO: ugh */
 756         if (devc->dev_state == NEW_CAPTURE) {
 757                 if (dso_capture_start(devc) != SR_OK)
 758                         return TRUE;
 759                 if (dso_enable_trigger(devc) != SR_OK)
 760                         return TRUE;
 761 //              if (dso_force_trigger(devc) != SR_OK)
 762 //                      return TRUE;
 763                 sr_dbg("Successfully requested next chunk.");
 764                 devc->dev_state = CAPTURE;
 765                 return TRUE;
 766         }
 767         if (devc->dev_state != CAPTURE)
 768                 return TRUE;
 769
 770         if ((dso_get_capturestate(devc, &capturestate, &trigger_offset)) != SR_OK)
 771                 return TRUE;
 772
 773         sr_dbg("Capturestate %d.", capturestate);
 774         sr_dbg("Trigger offset 0x%.6x.", trigger_offset);
 775         switch (capturestate) {
 776         case CAPTURE_EMPTY:
 777                 if (++devc->capture_empty_count >= MAX_CAPTURE_EMPTY) {
 778                         devc->capture_empty_count = 0;
 779                         if (dso_capture_start(devc) != SR_OK)
 780                                 break;
 781                         if (dso_enable_trigger(devc) != SR_OK)
 782                                 break;
 783 //                      if (dso_force_trigger(devc) != SR_OK)
 784 //                              break;
 785                         sr_dbg("Successfully requested next chunk.");
 786                 }
 787                 break;
 788         case CAPTURE_FILLING:
 789                 /* No data yet. */
 790                 break;
 791         case CAPTURE_READY_8BIT:
 792                 /* Remember where in the captured frame the trigger is. */
 793                 devc->trigger_offset = trigger_offset;
 794
 795                 num_probes = (devc->ch1_enabled && devc->ch2_enabled) ? 2 : 1;
 796                 /* TODO: Check malloc return value. */
 797                 devc->framebuf = g_try_malloc(devc->framesize * num_probes * 2);
 798                 devc->samp_buffered = devc->samp_received = 0;
 799
 800                 /* Tell the scope to send us the first frame. */
 801                 if (dso_get_channeldata(sdi, receive_transfer) != SR_OK)
 802                         break;
 803
 804                 /*
 805                  * Don't hit the state machine again until we're done fetching
 806                  * the data we just told the scope to send.
 807                  */
 808                 devc->dev_state = FETCH_DATA;
 809
 810                 /* Tell the frontend a new frame is on the way. */
 811                 packet.type = SR_DF_FRAME_BEGIN;
 812                 sr_session_send(sdi, &packet);
 813                 break;
 814         case CAPTURE_READY_9BIT:
 815                 /* TODO */
 816                 sr_err("Not yet supported.");
 817                 break;
 818         case CAPTURE_TIMEOUT:
 819                 /* Doesn't matter, we'll try again next time. */
 820                 break;
 821         default:
 822                 sr_dbg("Unknown capture state: %d.", capturestate);
 823                 break;
 824         }
 825
 826         return TRUE;
 827 }
 828
 829 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
 830                                     void *cb_data)
 831 {
 832         const struct libusb_pollfd **lupfd;
 833         struct sr_datafeed_packet packet;
 834         struct sr_datafeed_header header;
 835         struct dev_context *devc;
 836         struct drv_context *drvc = di->priv;
 837         int i;
 838
 839         if (sdi->status != SR_ST_ACTIVE)
 840                 return SR_ERR;
 841
 842         devc = sdi->priv;
 843         devc->cb_data = cb_data;
 844
 845         if (configure_probes(sdi) != SR_OK) {
 846                 sr_err("Failed to configure probes.");
 847                 return SR_ERR;
 848         }
 849
 850         if (dso_init(devc) != SR_OK)
 851                 return SR_ERR;
 852
 853         if (dso_capture_start(devc) != SR_OK)
 854                 return SR_ERR;
 855
 856         devc->dev_state = CAPTURE;
 857         lupfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
 858         for (i = 0; lupfd[i]; i++)
 859                 sr_source_add(lupfd[i]->fd, lupfd[i]->events, TICK,
 860                               handle_event, (void *)sdi);
 861         free(lupfd);
 862
 863         /* Send header packet to the session bus. */
 864         packet.type = SR_DF_HEADER;
 865         packet.payload = (unsigned char *)&header;
 866         header.feed_version = 1;
 867         gettimeofday(&header.starttime, NULL);
 868         sr_session_send(cb_data, &packet);
 869
 870         return SR_OK;
 871 }
 872
 873 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 874 {
 875         struct dev_context *devc;
 876
 877         (void)cb_data;
 878
 879         if (sdi->status != SR_ST_ACTIVE)
 880                 return SR_ERR;
 881
 882         devc = sdi->priv;
 883         devc->dev_state = STOPPING;
 884
 885         return SR_OK;
 886 }
 887
 888 SR_PRIV struct sr_dev_driver hantek_dso_driver_info = {
 889         .name = "hantek-dso",
 890         .longname = "Hantek DSO",
 891         .api_version = 1,
 892         .init = hw_init,
 893         .cleanup = hw_cleanup,
 894         .scan = hw_scan,
 895         .dev_list = hw_dev_list,
 896         .dev_clear = clear_instances,
 897         .config_set = config_set,
 898         .config_list = config_list,
 899         .dev_open = hw_dev_open,
 900         .dev_close = hw_dev_close,
 901         .dev_acquisition_start = hw_dev_acquisition_start,
 902         .dev_acquisition_stop = hw_dev_acquisition_stop,
 903         .priv = NULL,
 904 };