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