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