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