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