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