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