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 dev_clear(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 dev_clear();
 423 }
 424
 425 static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi,
 426                 const struct sr_probe_group *probe_group)
 427 {
 428         struct sr_usb_dev_inst *usb;
 429         char str[128];
 430
 431         (void)probe_group;
 432
 433         switch (id) {
 434         case SR_CONF_CONN:
 435                 if (!sdi || !sdi->conn)
 436                         return SR_ERR_ARG;
 437                 usb = sdi->conn;
 438                 if (usb->address == 255)
 439                         /* Device still needs to re-enumerate after firmware
 440                          * upload, so we don't know its (future) address. */
 441                         return SR_ERR;
 442                 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
 443                 *data = g_variant_new_string(str);
 444                 break;
 445         case SR_CONF_NUM_TIMEBASE:
 446                 *data = g_variant_new_int32(NUM_TIMEBASE);
 447                 break;
 448         case SR_CONF_NUM_VDIV:
 449                 *data = g_variant_new_int32(NUM_VDIV);
 450                 break;
 451         default:
 452                 return SR_ERR_NA;
 453         }
 454
 455         return SR_OK;
 456 }
 457
 458 static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
 459                 const struct sr_probe_group *probe_group)
 460 {
 461         struct dev_context *devc;
 462         double tmp_double;
 463         uint64_t tmp_u64, p, q;
 464         int tmp_int, ret;
 465         unsigned int i;
 466         const char *tmp_str;
 467         char **targets;
 468
 469         (void)probe_group;
 470
 471         if (sdi->status != SR_ST_ACTIVE)
 472                 return SR_ERR_DEV_CLOSED;
 473
 474         ret = SR_OK;
 475         devc = sdi->priv;
 476         switch (id) {
 477         case SR_CONF_LIMIT_FRAMES:
 478                 devc->limit_frames = g_variant_get_uint64(data);
 479                 break;
 480         case SR_CONF_TRIGGER_SLOPE:
 481                 tmp_u64 = g_variant_get_uint64(data);
 482                 if (tmp_u64 != SLOPE_NEGATIVE && tmp_u64 != SLOPE_POSITIVE)
 483                         ret = SR_ERR_ARG;
 484                 devc->triggerslope = tmp_u64;
 485                 break;
 486         case SR_CONF_HORIZ_TRIGGERPOS:
 487                 tmp_double = g_variant_get_double(data);
 488                 if (tmp_double < 0.0 || tmp_double > 1.0) {
 489                         sr_err("Trigger position should be between 0.0 and 1.0.");
 490                         ret = SR_ERR_ARG;
 491                 } else
 492                         devc->triggerposition = tmp_double;
 493                 break;
 494         case SR_CONF_BUFFERSIZE:
 495                 tmp_u64 = g_variant_get_uint64(data);
 496                 for (i = 0; i < 2; i++) {
 497                         if (devc->profile->buffersizes[i] == tmp_u64) {
 498                                 devc->framesize = tmp_u64;
 499                                 break;
 500                         }
 501                 }
 502                 if (i == 2)
 503                         ret = SR_ERR_ARG;
 504                 break;
 505         case SR_CONF_TIMEBASE:
 506                 g_variant_get(data, "(tt)", &p, &q);
 507                 tmp_int = -1;
 508                 for (i = 0; i < ARRAY_SIZE(timebases); i++) {
 509                         if (timebases[i][0] == p && timebases[i][1] == q) {
 510                                 tmp_int = i;
 511                                 break;
 512                         }
 513                 }
 514                 if (tmp_int >= 0)
 515                         devc->timebase = tmp_int;
 516                 else
 517                         ret = SR_ERR_ARG;
 518                 break;
 519         case SR_CONF_TRIGGER_SOURCE:
 520                 tmp_str = g_variant_get_string(data, NULL);
 521                 for (i = 0; trigger_sources[i]; i++) {
 522                         if (!strcmp(tmp_str, trigger_sources[i])) {
 523                                 devc->triggersource = g_strdup(tmp_str);
 524                                 break;
 525                         }
 526                 }
 527                 if (trigger_sources[i] == 0)
 528                         ret = SR_ERR_ARG;
 529                 break;
 530         case SR_CONF_FILTER:
 531                 tmp_str = g_variant_get_string(data, NULL);
 532                 devc->filter_ch1 = devc->filter_ch2 = devc->filter_trigger = 0;
 533                 targets = g_strsplit(tmp_str, ",", 0);
 534                 for (i = 0; targets[i]; i++) {
 535                         if (targets[i] == '\0')
 536                                 /* Empty filter string can be used to clear them all. */
 537                                 ;
 538                         else if (!strcmp(targets[i], "CH1"))
 539                                 devc->filter_ch1 = TRUE;
 540                         else if (!strcmp(targets[i], "CH2"))
 541                                 devc->filter_ch2 = TRUE;
 542                         else if (!strcmp(targets[i], "TRIGGER"))
 543                                 devc->filter_trigger = TRUE;
 544                         else {
 545                                 sr_err("Invalid filter target %s.", targets[i]);
 546                                 ret = SR_ERR_ARG;
 547                         }
 548                 }
 549                 g_strfreev(targets);
 550                 break;
 551         case SR_CONF_VDIV:
 552                 /* TODO: Not supporting vdiv per channel yet. */
 553                 g_variant_get(data, "(tt)", &p, &q);
 554                 tmp_int = -1;
 555                 for (i = 0; i < ARRAY_SIZE(vdivs); i++) {
 556                         if (vdivs[i][0] == p && vdivs[i][1] == q) {
 557                                 tmp_int = i;
 558                                 break;
 559                         }
 560                 }
 561                 if (tmp_int >= 0) {
 562                         devc->voltage_ch1 = tmp_int;
 563                         devc->voltage_ch2 = tmp_int;
 564                 } else
 565                         ret = SR_ERR_ARG;
 566                 break;
 567         case SR_CONF_COUPLING:
 568                 tmp_str = g_variant_get_string(data, NULL);
 569                 /* TODO: Not supporting coupling per channel yet. */
 570                 for (i = 0; coupling[i]; i++) {
 571                         if (!strcmp(tmp_str, coupling[i])) {
 572                                 devc->coupling_ch1 = i;
 573                                 devc->coupling_ch2 = i;
 574                                 break;
 575                         }
 576                 }
 577                 if (coupling[i] == 0)
 578                         ret = SR_ERR_ARG;
 579                 break;
 580         default:
 581                 ret = SR_ERR_NA;
 582                 break;
 583         }
 584
 585         return ret;
 586 }
 587
 588 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
 589                 const struct sr_probe_group *probe_group)
 590 {
 591         struct dev_context *devc;
 592         GVariant *tuple, *rational[2];
 593         GVariantBuilder gvb;
 594         unsigned int i;
 595
 596         (void)probe_group;
 597
 598         switch (key) {
 599         case SR_CONF_SCAN_OPTIONS:
 600                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
 601                                 scanopts, ARRAY_SIZE(scanopts), sizeof(int32_t));
 602                 break;
 603         case SR_CONF_DEVICE_OPTIONS:
 604                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
 605                                 devopts, ARRAY_SIZE(devopts), sizeof(int32_t));
 606                 break;
 607         case SR_CONF_BUFFERSIZE:
 608                 if (!sdi)
 609                         return SR_ERR_ARG;
 610                 devc = sdi->priv;
 611                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT64,
 612                                 devc->profile->buffersizes, 2, sizeof(uint64_t));
 613                 break;
 614         case SR_CONF_COUPLING:
 615                 *data = g_variant_new_strv(coupling, ARRAY_SIZE(coupling));
 616                 break;
 617         case SR_CONF_VDIV:
 618                 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
 619                 for (i = 0; i < ARRAY_SIZE(vdivs); i++) {
 620                         rational[0] = g_variant_new_uint64(vdivs[i][0]);
 621                         rational[1] = g_variant_new_uint64(vdivs[i][1]);
 622                         tuple = g_variant_new_tuple(rational, 2);
 623                         g_variant_builder_add_value(&gvb, tuple);
 624                 }
 625                 *data = g_variant_builder_end(&gvb);
 626                 break;
 627         case SR_CONF_FILTER:
 628                 *data = g_variant_new_strv(filter_targets,
 629                                 ARRAY_SIZE(filter_targets));
 630                 break;
 631         case SR_CONF_TIMEBASE:
 632                 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
 633                 for (i = 0; i < ARRAY_SIZE(timebases); i++) {
 634                         rational[0] = g_variant_new_uint64(timebases[i][0]);
 635                         rational[1] = g_variant_new_uint64(timebases[i][1]);
 636                         tuple = g_variant_new_tuple(rational, 2);
 637                         g_variant_builder_add_value(&gvb, tuple);
 638                 }
 639                 *data = g_variant_builder_end(&gvb);
 640                 break;
 641         case SR_CONF_TRIGGER_SOURCE:
 642                 *data = g_variant_new_strv(trigger_sources,
 643                                 ARRAY_SIZE(trigger_sources));
 644                 break;
 645         default:
 646                 return SR_ERR_NA;
 647         }
 648
 649         return SR_OK;
 650 }
 651
 652 static void send_chunk(struct sr_dev_inst *sdi, unsigned char *buf,
 653                 int num_samples)
 654 {
 655         struct sr_datafeed_packet packet;
 656         struct sr_datafeed_analog analog;
 657         struct dev_context *devc;
 658         float ch1, ch2, range;
 659         int num_probes, data_offset, i;
 660
 661         devc = sdi->priv;
 662         num_probes = (devc->ch1_enabled && devc->ch2_enabled) ? 2 : 1;
 663         packet.type = SR_DF_ANALOG;
 664         packet.payload = &analog;
 665         /* TODO: support for 5xxx series 9-bit samples */
 666         analog.probes = devc->enabled_probes;
 667         analog.num_samples = num_samples;
 668         analog.mq = SR_MQ_VOLTAGE;
 669         analog.unit = SR_UNIT_VOLT;
 670         /* TODO: Check malloc return value. */
 671         analog.data = g_try_malloc(analog.num_samples * sizeof(float) * num_probes);
 672         data_offset = 0;
 673         for (i = 0; i < analog.num_samples; i++) {
 674                 /*
 675                  * The device always sends data for both channels. If a channel
 676                  * is disabled, it contains a copy of the enabled channel's
 677                  * data. However, we only send the requested channels to
 678                  * the bus.
 679                  *
 680                  * Voltage values are encoded as a value 0-255 (0-512 on the
 681                  * DSO-5200*), where the value is a point in the range
 682                  * represented by the vdiv setting. There are 8 vertical divs,
 683                  * so e.g. 500mV/div represents 4V peak-to-peak where 0 = -2V
 684                  * and 255 = +2V.
 685                  */
 686                 /* TODO: Support for DSO-5xxx series 9-bit samples. */
 687                 if (devc->ch1_enabled) {
 688                         range = ((float)vdivs[devc->voltage_ch1][0] / vdivs[devc->voltage_ch1][1]) * 8;
 689                         ch1 = range / 255 * *(buf + i * 2 + 1);
 690                         /* Value is centered around 0V. */
 691                         ch1 -= range / 2;
 692                         analog.data[data_offset++] = ch1;
 693                 }
 694                 if (devc->ch2_enabled) {
 695                         range = ((float)vdivs[devc->voltage_ch2][0] / vdivs[devc->voltage_ch2][1]) * 8;
 696                         ch2 = range / 255 * *(buf + i * 2);
 697                         ch2 -= range / 2;
 698                         analog.data[data_offset++] = ch2;
 699                 }
 700         }
 701         sr_session_send(devc->cb_data, &packet);
 702 }
 703
 704 /*
 705  * Called by libusb (as triggered by handle_event()) when a transfer comes in.
 706  * Only channel data comes in asynchronously, and all transfers for this are
 707  * queued up beforehand, so this just needs to chuck the incoming data onto
 708  * the libsigrok session bus.
 709  */
 710 static void receive_transfer(struct libusb_transfer *transfer)
 711 {
 712         struct sr_datafeed_packet packet;
 713         struct sr_dev_inst *sdi;
 714         struct dev_context *devc;
 715         int num_samples, pre;
 716
 717         sdi = transfer->user_data;
 718         devc = sdi->priv;
 719         sr_spew("receive_transfer(): status %d received %d bytes.",
 720                    transfer->status, transfer->actual_length);
 721
 722         if (transfer->actual_length == 0)
 723                 /* Nothing to send to the bus. */
 724                 return;
 725
 726         num_samples = transfer->actual_length / 2;
 727
 728         sr_spew("Got %d-%d/%d samples in frame.", devc->samp_received + 1,
 729                    devc->samp_received + num_samples, devc->framesize);
 730
 731         /*
 732          * The device always sends a full frame, but the beginning of the frame
 733          * doesn't represent the trigger point. The offset at which the trigger
 734          * happened came in with the capture state, so we need to start sending
 735          * from there up the session bus. The samples in the frame buffer
 736          * before that trigger point came after the end of the device's frame
 737          * buffer was reached, and it wrapped around to overwrite up until the
 738          * trigger point.
 739          */
 740         if (devc->samp_received < devc->trigger_offset) {
 741                 /* Trigger point not yet reached. */
 742                 if (devc->samp_received + num_samples < devc->trigger_offset) {
 743                         /* The entire chunk is before the trigger point. */
 744                         memcpy(devc->framebuf + devc->samp_buffered * 2,
 745                                         transfer->buffer, num_samples * 2);
 746                         devc->samp_buffered += num_samples;
 747                 } else {
 748                         /*
 749                          * This chunk hits or overruns the trigger point.
 750                          * Store the part before the trigger fired, and
 751                          * send the rest up to the session bus.
 752                          */
 753                         pre = devc->trigger_offset - devc->samp_received;
 754                         memcpy(devc->framebuf + devc->samp_buffered * 2,
 755                                         transfer->buffer, pre * 2);
 756                         devc->samp_buffered += pre;
 757
 758                         /* The rest of this chunk starts with the trigger point. */
 759                         sr_dbg("Reached trigger point, %d samples buffered.",
 760                                    devc->samp_buffered);
 761
 762                         /* Avoid the corner case where the chunk ended at
 763                          * exactly the trigger point. */
 764                         if (num_samples > pre)
 765                                 send_chunk(sdi, transfer->buffer + pre * 2,
 766                                                 num_samples - pre);
 767                 }
 768         } else {
 769                 /* Already past the trigger point, just send it all out. */
 770                 send_chunk(sdi, transfer->buffer,
 771                                 num_samples);
 772         }
 773
 774         devc->samp_received += num_samples;
 775
 776         /* Everything in this transfer was either copied to the buffer or
 777          * sent to the session bus. */
 778         g_free(transfer->buffer);
 779         libusb_free_transfer(transfer);
 780
 781         if (devc->samp_received >= devc->framesize) {
 782                 /* That was the last chunk in this frame. Send the buffered
 783                  * pre-trigger samples out now, in one big chunk. */
 784                 sr_dbg("End of frame, sending %d pre-trigger buffered samples.",
 785                            devc->samp_buffered);
 786                 send_chunk(sdi, devc->framebuf, devc->samp_buffered);
 787
 788                 /* Mark the end of this frame. */
 789                 packet.type = SR_DF_FRAME_END;
 790                 sr_session_send(devc->cb_data, &packet);
 791
 792                 if (devc->limit_frames && ++devc->num_frames == devc->limit_frames) {
 793                         /* Terminate session */
 794                         devc->dev_state = STOPPING;
 795                 } else {
 796                         devc->dev_state = NEW_CAPTURE;
 797                 }
 798         }
 799 }
 800
 801 static int handle_event(int fd, int revents, void *cb_data)
 802 {
 803         const struct sr_dev_inst *sdi;
 804         struct sr_datafeed_packet packet;
 805         struct timeval tv;
 806         struct dev_context *devc;
 807         struct drv_context *drvc = di->priv;
 808         const struct libusb_pollfd **lupfd;
 809         int num_probes, i;
 810         uint32_t trigger_offset;
 811         uint8_t capturestate;
 812
 813         (void)fd;
 814         (void)revents;
 815
 816         sdi = cb_data;
 817         devc = sdi->priv;
 818         if (devc->dev_state == STOPPING) {
 819                 /* We've been told to wind up the acquisition. */
 820                 sr_dbg("Stopping acquisition.");
 821                 /*
 822                  * TODO: Doesn't really cancel pending transfers so they might
 823                  * come in after SR_DF_END is sent.
 824                  */
 825                 lupfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
 826                 for (i = 0; lupfd[i]; i++)
 827                         sr_source_remove(lupfd[i]->fd);
 828                 free(lupfd);
 829
 830                 packet.type = SR_DF_END;
 831                 sr_session_send(sdi, &packet);
 832
 833                 devc->dev_state = IDLE;
 834
 835                 return TRUE;
 836         }
 837
 838         /* Always handle pending libusb events. */
 839         tv.tv_sec = tv.tv_usec = 0;
 840         libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
 841
 842         /* TODO: ugh */
 843         if (devc->dev_state == NEW_CAPTURE) {
 844                 if (dso_capture_start(sdi) != SR_OK)
 845                         return TRUE;
 846                 if (dso_enable_trigger(sdi) != SR_OK)
 847                         return TRUE;
 848 //              if (dso_force_trigger(sdi) != SR_OK)
 849 //                      return TRUE;
 850                 sr_dbg("Successfully requested next chunk.");
 851                 devc->dev_state = CAPTURE;
 852                 return TRUE;
 853         }
 854         if (devc->dev_state != CAPTURE)
 855                 return TRUE;
 856
 857         if ((dso_get_capturestate(sdi, &capturestate, &trigger_offset)) != SR_OK)
 858                 return TRUE;
 859
 860         sr_dbg("Capturestate %d.", capturestate);
 861         sr_dbg("Trigger offset 0x%.6x.", trigger_offset);
 862         switch (capturestate) {
 863         case CAPTURE_EMPTY:
 864                 if (++devc->capture_empty_count >= MAX_CAPTURE_EMPTY) {
 865                         devc->capture_empty_count = 0;
 866                         if (dso_capture_start(sdi) != SR_OK)
 867                                 break;
 868                         if (dso_enable_trigger(sdi) != SR_OK)
 869                                 break;
 870 //                      if (dso_force_trigger(sdi) != SR_OK)
 871 //                              break;
 872                         sr_dbg("Successfully requested next chunk.");
 873                 }
 874                 break;
 875         case CAPTURE_FILLING:
 876                 /* No data yet. */
 877                 break;
 878         case CAPTURE_READY_8BIT:
 879                 /* Remember where in the captured frame the trigger is. */
 880                 devc->trigger_offset = trigger_offset;
 881
 882                 num_probes = (devc->ch1_enabled && devc->ch2_enabled) ? 2 : 1;
 883                 /* TODO: Check malloc return value. */
 884                 devc->framebuf = g_try_malloc(devc->framesize * num_probes * 2);
 885                 devc->samp_buffered = devc->samp_received = 0;
 886
 887                 /* Tell the scope to send us the first frame. */
 888                 if (dso_get_channeldata(sdi, receive_transfer) != SR_OK)
 889                         break;
 890
 891                 /*
 892                  * Don't hit the state machine again until we're done fetching
 893                  * the data we just told the scope to send.
 894                  */
 895                 devc->dev_state = FETCH_DATA;
 896
 897                 /* Tell the frontend a new frame is on the way. */
 898                 packet.type = SR_DF_FRAME_BEGIN;
 899                 sr_session_send(sdi, &packet);
 900                 break;
 901         case CAPTURE_READY_9BIT:
 902                 /* TODO */
 903                 sr_err("Not yet supported.");
 904                 break;
 905         case CAPTURE_TIMEOUT:
 906                 /* Doesn't matter, we'll try again next time. */
 907                 break;
 908         default:
 909                 sr_dbg("Unknown capture state: %d.", capturestate);
 910                 break;
 911         }
 912
 913         return TRUE;
 914 }
 915
 916 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
 917 {
 918         const struct libusb_pollfd **lupfd;
 919         struct dev_context *devc;
 920         struct drv_context *drvc = di->priv;
 921         int i;
 922
 923         if (sdi->status != SR_ST_ACTIVE)
 924                 return SR_ERR_DEV_CLOSED;
 925
 926         devc = sdi->priv;
 927         devc->cb_data = cb_data;
 928
 929         if (configure_probes(sdi) != SR_OK) {
 930                 sr_err("Failed to configure probes.");
 931                 return SR_ERR;
 932         }
 933
 934         if (dso_init(sdi) != SR_OK)
 935                 return SR_ERR;
 936
 937         if (dso_capture_start(sdi) != SR_OK)
 938                 return SR_ERR;
 939
 940         devc->dev_state = CAPTURE;
 941         lupfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
 942         for (i = 0; lupfd[i]; i++)
 943                 sr_source_add(lupfd[i]->fd, lupfd[i]->events, TICK,
 944                                 handle_event, (void *)sdi);
 945         free(lupfd);
 946
 947         /* Send header packet to the session bus. */
 948         std_session_send_df_header(cb_data, LOG_PREFIX);
 949
 950         return SR_OK;
 951 }
 952
 953 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 954 {
 955         struct dev_context *devc;
 956
 957         (void)cb_data;
 958
 959         if (sdi->status != SR_ST_ACTIVE)
 960                 return SR_ERR;
 961
 962         devc = sdi->priv;
 963         devc->dev_state = STOPPING;
 964
 965         return SR_OK;
 966 }
 967
 968 SR_PRIV struct sr_dev_driver hantek_dso_driver_info = {
 969         .name = "hantek-dso",
 970         .longname = "Hantek DSO",
 971         .api_version = 1,
 972         .init = init,
 973         .cleanup = cleanup,
 974         .scan = scan,
 975         .dev_list = dev_list,
 976         .dev_clear = dev_clear,
 977         .config_get = config_get,
 978         .config_set = config_set,
 979         .config_list = config_list,
 980         .dev_open = dev_open,
 981         .dev_close = dev_close,
 982         .dev_acquisition_start = dev_acquisition_start,
 983         .dev_acquisition_stop = dev_acquisition_stop,
 984         .priv = NULL,
 985 };