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