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