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