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