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