src/hardware/hantek-dso/api.c

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