src/hardware/hantek-dso/api.c

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