src/hardware/hantek-dso/api.c

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