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