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