src/hardware/hantek-dso/api.c

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