hardware/hantek-dso/api.c

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