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