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