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