src/hardware/hantek-6xxx/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2015 Christer Ekholm <christerekholm@gmail.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 "protocol.h"
  23
  24 /* Max time in ms before we want to check on USB events */
  25 #define TICK 200
  26
  27 #define RANGE(ch) (((float)vdivs[devc->voltage[ch]][0] / vdivs[devc->voltage[ch]][1]) * VDIV_MULTIPLIER)
  28
  29 static const uint32_t scanopts[] = {
  30         SR_CONF_CONN,
  31 };
  32
  33 static const uint32_t drvopts[] = {
  34         SR_CONF_OSCILLOSCOPE,
  35 };
  36
  37 static const uint32_t devopts[] = {
  38         SR_CONF_CONN | SR_CONF_GET,
  39         SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
  40         SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
  41         SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  42         SR_CONF_NUM_VDIV | SR_CONF_GET,
  43 };
  44
  45 static const uint32_t devopts_cg[] = {
  46         SR_CONF_VDIV | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  47         SR_CONF_COUPLING | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  48 };
  49
  50 static const char *channel_names[] = {
  51         "CH1", "CH2",
  52 };
  53
  54 static const char *dc_coupling[] = {
  55         "DC",
  56 };
  57
  58 static const char *acdc_coupling[] = {
  59         "AC", "DC",
  60 };
  61
  62 static const struct hantek_6xxx_profile dev_profiles[] = {
  63         {
  64                 0x04b4, 0x6022, 0x1d50, 0x608e, 0x0001,
  65                 "Hantek", "6022BE", "fx2lafw-hantek-6022be.fw",
  66                 dc_coupling, ARRAY_SIZE(dc_coupling), FALSE,
  67         },
  68         {
  69                 0x8102, 0x8102, 0x1d50, 0x608e, 0x0002,
  70                 "Sainsmart", "DDS120", "fx2lafw-sainsmart-dds120.fw",
  71                 acdc_coupling, ARRAY_SIZE(acdc_coupling), TRUE,
  72         },
  73         {
  74                 0x04b4, 0x602a, 0x1d50, 0x608e, 0x0003,
  75                 "Hantek", "6022BL", "fx2lafw-hantek-6022bl.fw",
  76                 dc_coupling, ARRAY_SIZE(dc_coupling), FALSE,
  77         },
  78         ALL_ZERO
  79 };
  80
  81 static const uint64_t samplerates[] = {
  82         SAMPLERATE_VALUES
  83 };
  84
  85 static const uint64_t vdivs[][2] = {
  86         VDIV_VALUES
  87 };
  88
  89 static int read_channel(const struct sr_dev_inst *sdi, uint32_t amount);
  90
  91 static struct sr_dev_inst *hantek_6xxx_dev_new(const struct hantek_6xxx_profile *prof)
  92 {
  93         struct sr_dev_inst *sdi;
  94         struct sr_channel *ch;
  95         struct sr_channel_group *cg;
  96         struct dev_context *devc;
  97         unsigned int i;
  98
  99         sdi = g_malloc0(sizeof(struct sr_dev_inst));
 100         sdi->status = SR_ST_INITIALIZING;
 101         sdi->vendor = g_strdup(prof->vendor);
 102         sdi->model = g_strdup(prof->model);
 103
 104         for (i = 0; i < ARRAY_SIZE(channel_names); i++) {
 105                 ch = sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, TRUE, channel_names[i]);
 106                 cg = g_malloc0(sizeof(struct sr_channel_group));
 107                 cg->name = g_strdup(channel_names[i]);
 108                 cg->channels = g_slist_append(cg->channels, ch);
 109                 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
 110         }
 111
 112         devc = g_malloc0(sizeof(struct dev_context));
 113
 114         for (i = 0; i < NUM_CHANNELS; i++) {
 115                 devc->ch_enabled[i] = TRUE;
 116                 devc->voltage[i] = DEFAULT_VOLTAGE;
 117                 devc->coupling[i] = DEFAULT_COUPLING;
 118         }
 119         devc->coupling_vals = prof->coupling_vals;
 120         devc->coupling_tab_size = prof->coupling_tab_size;
 121         devc->has_coupling = prof->has_coupling;
 122
 123         devc->sample_buf = NULL;
 124         devc->sample_buf_write = 0;
 125         devc->sample_buf_size = 0;
 126
 127         devc->profile = prof;
 128         devc->dev_state = IDLE;
 129         devc->samplerate = DEFAULT_SAMPLERATE;
 130
 131         sdi->priv = devc;
 132
 133         return sdi;
 134 }
 135
 136 static int configure_channels(const struct sr_dev_inst *sdi)
 137 {
 138         struct dev_context *devc;
 139         const GSList *l;
 140         int p;
 141         struct sr_channel *ch;
 142         devc = sdi->priv;
 143
 144         g_slist_free(devc->enabled_channels);
 145         devc->enabled_channels = NULL;
 146         memset(devc->ch_enabled, 0, sizeof(devc->ch_enabled));
 147
 148         for (l = sdi->channels, p = 0; l; l = l->next, p++) {
 149                 ch = l->data;
 150                 if (p < NUM_CHANNELS) {
 151                         devc->ch_enabled[p] = ch->enabled;
 152                         devc->enabled_channels = g_slist_append(devc->enabled_channels, ch);
 153                 }
 154         }
 155
 156         return SR_OK;
 157 }
 158
 159 static void clear_dev_context(void *priv)
 160 {
 161         struct dev_context *devc;
 162
 163         devc = priv;
 164         g_slist_free(devc->enabled_channels);
 165         g_free(devc);
 166 }
 167
 168 static int dev_clear(const struct sr_dev_driver *di)
 169 {
 170         return std_dev_clear(di, clear_dev_context);
 171 }
 172
 173 static GSList *scan(struct sr_dev_driver *di, GSList *options)
 174 {
 175         struct drv_context *drvc;
 176         struct dev_context *devc;
 177         struct sr_dev_inst *sdi;
 178         struct sr_usb_dev_inst *usb;
 179         struct sr_config *src;
 180         const struct hantek_6xxx_profile *prof;
 181         GSList *l, *devices, *conn_devices;
 182         struct libusb_device_descriptor des;
 183         libusb_device **devlist;
 184         int i, j;
 185         const char *conn;
 186         char connection_id[64];
 187
 188         drvc = di->context;
 189
 190         devices = 0;
 191
 192         conn = NULL;
 193         for (l = options; l; l = l->next) {
 194                 src = l->data;
 195                 if (src->key == SR_CONF_CONN) {
 196                         conn = g_variant_get_string(src->data, NULL);
 197                         break;
 198                 }
 199         }
 200         if (conn)
 201                 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
 202         else
 203                 conn_devices = NULL;
 204
 205         /* Find all Hantek 60xx devices and upload firmware to all of them. */
 206         libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
 207         for (i = 0; devlist[i]; i++) {
 208                 if (conn) {
 209                         usb = NULL;
 210                         for (l = conn_devices; l; l = l->next) {
 211                                 usb = l->data;
 212                                 if (usb->bus == libusb_get_bus_number(devlist[i])
 213                                         && usb->address == libusb_get_device_address(devlist[i]))
 214                                         break;
 215                         }
 216                         if (!l)
 217                                 /* This device matched none of the ones that
 218                                  * matched the conn specification. */
 219                                 continue;
 220                 }
 221
 222                 libusb_get_device_descriptor(devlist[i], &des);
 223
 224                 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
 225
 226                 prof = NULL;
 227                 for (j = 0; dev_profiles[j].orig_vid; j++) {
 228                         if (des.idVendor == dev_profiles[j].orig_vid
 229                                 && des.idProduct == dev_profiles[j].orig_pid) {
 230                                 /* Device matches the pre-firmware profile. */
 231                                 prof = &dev_profiles[j];
 232                                 sr_dbg("Found a %s %s.", prof->vendor, prof->model);
 233                                 sdi = hantek_6xxx_dev_new(prof);
 234                                 sdi->connection_id = g_strdup(connection_id);
 235                                 devices = g_slist_append(devices, sdi);
 236                                 devc = sdi->priv;
 237                                 if (ezusb_upload_firmware(drvc->sr_ctx, devlist[i],
 238                                                 USB_CONFIGURATION, prof->firmware) == SR_OK)
 239                                         /* Remember when the firmware on this device was updated. */
 240                                         devc->fw_updated = g_get_monotonic_time();
 241                                 else
 242                                         sr_err("Firmware upload failed.");
 243                                 /* Dummy USB address of 0xff will get overwritten later. */
 244                                 sdi->conn = sr_usb_dev_inst_new(
 245                                                 libusb_get_bus_number(devlist[i]), 0xff, NULL);
 246                                 break;
 247                         } else if (des.idVendor == dev_profiles[j].fw_vid
 248                                 && des.idProduct == dev_profiles[j].fw_pid
 249                                 && des.bcdDevice == dev_profiles[j].fw_prod_ver) {
 250                                 /* Device matches the post-firmware profile. */
 251                                 prof = &dev_profiles[j];
 252                                 sr_dbg("Found a %s %s.", prof->vendor, prof->model);
 253                                 sdi = hantek_6xxx_dev_new(prof);
 254                                 sdi->connection_id = g_strdup(connection_id);
 255                                 sdi->status = SR_ST_INACTIVE;
 256                                 devices = g_slist_append(devices, sdi);
 257                                 sdi->inst_type = SR_INST_USB;
 258                                 sdi->conn = sr_usb_dev_inst_new(
 259                                                 libusb_get_bus_number(devlist[i]),
 260                                                 libusb_get_device_address(devlist[i]), NULL);
 261                                 break;
 262                         }
 263                 }
 264                 if (!prof)
 265                         /* Not a supported VID/PID. */
 266                         continue;
 267         }
 268         libusb_free_device_list(devlist, 1);
 269
 270         return std_scan_complete(di, devices);
 271 }
 272
 273 static int dev_open(struct sr_dev_inst *sdi)
 274 {
 275         struct dev_context *devc;
 276         struct sr_usb_dev_inst *usb;
 277         int64_t timediff_us, timediff_ms;
 278         int err;
 279
 280         devc = sdi->priv;
 281         usb = sdi->conn;
 282
 283         /*
 284          * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
 285          * for the FX2 to renumerate.
 286          */
 287         err = SR_ERR;
 288         if (devc->fw_updated > 0) {
 289                 sr_info("Waiting for device to reset.");
 290                 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
 291                 g_usleep(300 * 1000);
 292                 timediff_ms = 0;
 293                 while (timediff_ms < MAX_RENUM_DELAY_MS) {
 294                         if ((err = hantek_6xxx_open(sdi)) == SR_OK)
 295                                 break;
 296                         g_usleep(100 * 1000);
 297                         timediff_us = g_get_monotonic_time() - devc->fw_updated;
 298                         timediff_ms = timediff_us / 1000;
 299                         sr_spew("Waited %" PRIi64 " ms.", timediff_ms);
 300                 }
 301                 if (timediff_ms < MAX_RENUM_DELAY_MS)
 302                         sr_info("Device came back after %"PRIu64" ms.", timediff_ms);
 303         } else {
 304                 err = hantek_6xxx_open(sdi);
 305         }
 306
 307         if (err != SR_OK) {
 308                 sr_err("Unable to open device.");
 309                 return SR_ERR;
 310         }
 311
 312         err = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
 313         if (err != 0) {
 314                 sr_err("Unable to claim interface: %s.",
 315                         libusb_error_name(err));
 316                 return SR_ERR;
 317         }
 318
 319         return SR_OK;
 320 }
 321
 322 static int dev_close(struct sr_dev_inst *sdi)
 323 {
 324         hantek_6xxx_close(sdi);
 325
 326         return SR_OK;
 327 }
 328
 329 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 330                 const struct sr_channel_group *cg)
 331 {
 332         struct dev_context *devc;
 333         struct sr_usb_dev_inst *usb;
 334         char str[128];
 335         const uint64_t *vdiv;
 336         int ch_idx;
 337
 338         switch (key) {
 339         case SR_CONF_NUM_VDIV:
 340                 *data = g_variant_new_int32(ARRAY_SIZE(vdivs));
 341                 break;
 342         }
 343
 344         if (!sdi)
 345                 return SR_ERR_ARG;
 346
 347         devc = sdi->priv;
 348         if (!cg) {
 349                 switch (key) {
 350                 case SR_CONF_SAMPLERATE:
 351                         *data = g_variant_new_uint64(devc->samplerate);
 352                         break;
 353                 case SR_CONF_LIMIT_MSEC:
 354                         *data = g_variant_new_uint64(devc->limit_msec);
 355                         break;
 356                 case SR_CONF_LIMIT_SAMPLES:
 357                         *data = g_variant_new_uint64(devc->limit_samples);
 358                         break;
 359                 case SR_CONF_CONN:
 360                         if (!sdi->conn)
 361                                 return SR_ERR_ARG;
 362                         usb = sdi->conn;
 363                         if (usb->address == 255)
 364                                 /* Device still needs to re-enumerate after firmware
 365                                  * upload, so we don't know its (future) address. */
 366                                 return SR_ERR;
 367                         snprintf(str, 128, "%d.%d", usb->bus, usb->address);
 368                         *data = g_variant_new_string(str);
 369                         break;
 370                 default:
 371                         return SR_ERR_NA;
 372                 }
 373         } else {
 374                 if (sdi->channel_groups->data == cg)
 375                         ch_idx = 0;
 376                 else if (sdi->channel_groups->next->data == cg)
 377                         ch_idx = 1;
 378                 else
 379                         return SR_ERR_ARG;
 380                 switch (key) {
 381                 case SR_CONF_VDIV:
 382                         vdiv = vdivs[devc->voltage[ch_idx]];
 383                         *data = g_variant_new("(tt)", vdiv[0], vdiv[1]);
 384                         break;
 385                 case SR_CONF_COUPLING:
 386                         *data = g_variant_new_string((devc->coupling[ch_idx] \
 387                                         == COUPLING_DC) ? "DC" : "AC");
 388                         break;
 389                 }
 390         }
 391
 392         return SR_OK;
 393 }
 394
 395 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 396                 const struct sr_channel_group *cg)
 397 {
 398         struct dev_context *devc;
 399         uint64_t p, q;
 400         int tmp_int, ch_idx, ret;
 401         unsigned int i;
 402         const char *tmp_str;
 403
 404         if (sdi->status != SR_ST_ACTIVE)
 405                 return SR_ERR_DEV_CLOSED;
 406
 407         ret = SR_OK;
 408         devc = sdi->priv;
 409         if (!cg) {
 410                 switch (key) {
 411                 case SR_CONF_SAMPLERATE:
 412                         devc->samplerate = g_variant_get_uint64(data);
 413                         hantek_6xxx_update_samplerate(sdi);
 414                         break;
 415                 case SR_CONF_LIMIT_MSEC:
 416                         devc->limit_msec = g_variant_get_uint64(data);
 417                         break;
 418                 case SR_CONF_LIMIT_SAMPLES:
 419                         devc->limit_samples = g_variant_get_uint64(data);
 420                         break;
 421                 default:
 422                         ret = SR_ERR_NA;
 423                         break;
 424                 }
 425         } else {
 426                 if (sdi->channel_groups->data == cg)
 427                         ch_idx = 0;
 428                 else if (sdi->channel_groups->next->data == cg)
 429                         ch_idx = 1;
 430                 else
 431                         return SR_ERR_ARG;
 432                 switch (key) {
 433                 case SR_CONF_VDIV:
 434                         g_variant_get(data, "(tt)", &p, &q);
 435                         tmp_int = -1;
 436                         for (i = 0; i < ARRAY_SIZE(vdivs); i++) {
 437                                 if (vdivs[i][0] == p && vdivs[i][1] == q) {
 438                                         tmp_int = i;
 439                                         break;
 440                                 }
 441                         }
 442                         if (tmp_int >= 0) {
 443                                 devc->voltage[ch_idx] = tmp_int;
 444                                 hantek_6xxx_update_vdiv(sdi);
 445                         } else
 446                                 ret = SR_ERR_ARG;
 447                         break;
 448                 case SR_CONF_COUPLING:
 449                         tmp_str = g_variant_get_string(data, NULL);
 450                         for (i = 0; i < devc->coupling_tab_size; i++) {
 451                                 if (!strcmp(tmp_str, devc->coupling_vals[i])) {
 452                                         devc->coupling[ch_idx] = i;
 453                                         break;
 454                                 }
 455                         }
 456                         if (i == devc->coupling_tab_size)
 457                                 ret = SR_ERR_ARG;
 458                         break;
 459                 default:
 460                         ret = SR_ERR_NA;
 461                         break;
 462                 }
 463         }
 464
 465         return ret;
 466 }
 467
 468 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 469                 const struct sr_channel_group *cg)
 470 {
 471         GVariant *tuple, *rational[2];
 472         GVariantBuilder gvb;
 473         unsigned int i;
 474         GVariant *gvar;
 475         struct dev_context *devc = NULL;
 476
 477         if (key == SR_CONF_SCAN_OPTIONS) {
 478                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 479                         scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 480                 return SR_OK;
 481         } else if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
 482                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 483                         drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
 484                 return SR_OK;
 485         }
 486
 487         if (sdi)
 488                 devc = sdi->priv;
 489
 490         if (!cg) {
 491                 switch (key) {
 492                 case SR_CONF_DEVICE_OPTIONS:
 493                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 494                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 495                         break;
 496                 case SR_CONF_SAMPLERATE:
 497                         g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
 498                         gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
 499                                 samplerates, ARRAY_SIZE(samplerates),
 500                                 sizeof(uint64_t));
 501                         g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
 502                         *data = g_variant_builder_end(&gvb);
 503                         break;
 504                 default:
 505                         return SR_ERR_NA;
 506                 }
 507         } else {
 508                 switch (key) {
 509                 case SR_CONF_DEVICE_OPTIONS:
 510                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 511                                 devopts_cg, ARRAY_SIZE(devopts_cg), sizeof(uint32_t));
 512                         break;
 513                 case SR_CONF_COUPLING:
 514                         if (!devc)
 515                                 return SR_ERR_NA;
 516                         *data = g_variant_new_strv(devc->coupling_vals, devc->coupling_tab_size);
 517                         break;
 518                 case SR_CONF_VDIV:
 519                         g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
 520                         for (i = 0; i < ARRAY_SIZE(vdivs); i++) {
 521                                 rational[0] = g_variant_new_uint64(vdivs[i][0]);
 522                                 rational[1] = g_variant_new_uint64(vdivs[i][1]);
 523                                 tuple = g_variant_new_tuple(rational, 2);
 524                                 g_variant_builder_add_value(&gvb, tuple);
 525                         }
 526                         *data = g_variant_builder_end(&gvb);
 527                         break;
 528                 default:
 529                         return SR_ERR_NA;
 530                 }
 531         }
 532
 533         return SR_OK;
 534 }
 535
 536 /* Minimise data amount for limit_samples and limit_msec limits. */
 537 static uint32_t data_amount(const struct sr_dev_inst *sdi)
 538 {
 539         struct dev_context *devc = sdi->priv;
 540         uint32_t data_left, data_left_2, i;
 541         int32_t time_left;
 542
 543         if (devc->limit_msec) {
 544                 time_left = devc->limit_msec - (g_get_monotonic_time() - devc->aq_started) / 1000;
 545                 data_left = devc->samplerate * MAX(time_left, 0) * NUM_CHANNELS / 1000;
 546         } else if (devc->limit_samples) {
 547                 data_left = (devc->limit_samples - devc->samp_received) * NUM_CHANNELS;
 548         } else {
 549                 data_left = devc->samplerate * NUM_CHANNELS;
 550         }
 551
 552         /* Round up to nearest power of two. */
 553         for (i = MIN_PACKET_SIZE; i < data_left; i *= 2)
 554                 ;
 555         data_left_2 = i;
 556
 557         sr_spew("data_amount: %u (rounded to power of 2: %u)", data_left, data_left_2);
 558
 559         return data_left_2;
 560 }
 561
 562 static void send_chunk(struct sr_dev_inst *sdi, unsigned char *buf,
 563                 int num_samples)
 564 {
 565         struct sr_datafeed_packet packet;
 566         struct sr_datafeed_analog analog;
 567         struct sr_analog_encoding encoding;
 568         struct sr_analog_meaning meaning;
 569         struct sr_analog_spec spec;
 570         struct dev_context *devc = sdi->priv;
 571         GSList *channels = devc->enabled_channels;
 572
 573         const float ch_bit[] = { RANGE(0) / 255, RANGE(1) / 255 };
 574         const float ch_center[] = { RANGE(0) / 2, RANGE(1) / 2 };
 575
 576         sr_analog_init(&analog, &encoding, &meaning, &spec, 0);
 577
 578         packet.type = SR_DF_ANALOG;
 579         packet.payload = &analog;
 580
 581         analog.num_samples = num_samples;
 582         analog.meaning->mq = SR_MQ_VOLTAGE;
 583         analog.meaning->unit = SR_UNIT_VOLT;
 584         analog.meaning->mqflags = 0;
 585
 586         analog.data = g_try_malloc(num_samples * sizeof(float));
 587         if (!analog.data) {
 588                 sr_err("Analog data buffer malloc failed.");
 589                 devc->dev_state = STOPPING;
 590                 return;
 591         }
 592
 593         for (int ch = 0; ch < 2; ch++) {
 594                 if (!devc->ch_enabled[ch])
 595                         continue;
 596
 597                 float vdivlog = log10f(ch_bit[ch]);
 598                 int digits = -(int)vdivlog + (vdivlog < 0.0);
 599                 analog.encoding->digits = digits;
 600                 analog.spec->spec_digits = digits;
 601                 analog.meaning->channels = g_slist_append(NULL, channels->data);
 602
 603                 for (int i = 0; i < num_samples; i++) {
 604                         /*
 605                          * The device always sends data for both channels. If a channel
 606                          * is disabled, it contains a copy of the enabled channel's
 607                          * data. However, we only send the requested channels to
 608                          * the bus.
 609                          *
 610                          * Voltage values are encoded as a value 0-255, where the
 611                          * value is a point in the range represented by the vdiv
 612                          * setting. There are 10 vertical divs, so e.g. 500mV/div
 613                          * represents 5V peak-to-peak where 0 = -2.5V and 255 = +2.5V.
 614                          */
 615                         ((float *)analog.data)[i] = ch_bit[ch] * *(buf + i * 2 + ch) - ch_center[ch];
 616                 }
 617
 618                 sr_session_send(sdi, &packet);
 619                 g_slist_free(analog.meaning->channels);
 620
 621                 channels = channels->next;
 622         }
 623         g_free(analog.data);
 624 }
 625
 626 static void send_data(struct sr_dev_inst *sdi, struct libusb_transfer *buf[], uint64_t samples)
 627 {
 628         int i = 0;
 629         uint64_t send = 0;
 630         uint32_t chunk;
 631
 632         while (send < samples) {
 633                 chunk = MIN(samples - send, (uint64_t)(buf[i]->actual_length / NUM_CHANNELS));
 634                 send += chunk;
 635                 send_chunk(sdi, buf[i]->buffer, chunk);
 636
 637                 /*
 638                  * Everything in this transfer was either copied to the buffer
 639                  * or sent to the session bus.
 640                  */
 641                 g_free(buf[i]->buffer);
 642                 libusb_free_transfer(buf[i]);
 643                 i++;
 644         }
 645 }
 646
 647 /*
 648  * Called by libusb (as triggered by handle_event()) when a transfer comes in.
 649  * Only channel data comes in asynchronously, and all transfers for this are
 650  * queued up beforehand, so this just needs to chuck the incoming data onto
 651  * the libsigrok session bus.
 652  */
 653 static void LIBUSB_CALL receive_transfer(struct libusb_transfer *transfer)
 654 {
 655         struct sr_dev_inst *sdi;
 656         struct dev_context *devc;
 657
 658         sdi = transfer->user_data;
 659         devc = sdi->priv;
 660
 661         if (devc->dev_state == FLUSH) {
 662                 g_free(transfer->buffer);
 663                 libusb_free_transfer(transfer);
 664                 devc->dev_state = CAPTURE;
 665                 devc->aq_started = g_get_monotonic_time();
 666                 read_channel(sdi, data_amount(sdi));
 667                 return;
 668         }
 669
 670         if (devc->dev_state != CAPTURE)
 671                 return;
 672
 673         if (!devc->sample_buf) {
 674                 devc->sample_buf_size = 10;
 675                 devc->sample_buf = g_try_malloc(devc->sample_buf_size * sizeof(transfer));
 676                 devc->sample_buf_write = 0;
 677         }
 678
 679         if (devc->sample_buf_write >= devc->sample_buf_size) {
 680                 devc->sample_buf_size += 10;
 681                 devc->sample_buf = g_try_realloc(devc->sample_buf,
 682                                 devc->sample_buf_size * sizeof(transfer));
 683                 if (!devc->sample_buf) {
 684                         sr_err("Sample buffer malloc failed.");
 685                         devc->dev_state = STOPPING;
 686                         return;
 687                 }
 688         }
 689
 690         devc->sample_buf[devc->sample_buf_write++] = transfer;
 691         devc->samp_received += transfer->actual_length / NUM_CHANNELS;
 692
 693         sr_spew("receive_transfer(): calculated samplerate == %" PRIu64 "ks/s",
 694                 (uint64_t)(transfer->actual_length * 1000 /
 695                 (g_get_monotonic_time() - devc->read_start_ts + 1) /
 696                 NUM_CHANNELS));
 697
 698         sr_spew("receive_transfer(): status %s received %d bytes.",
 699                 libusb_error_name(transfer->status), transfer->actual_length);
 700
 701         if (transfer->actual_length == 0)
 702                 /* Nothing to send to the bus. */
 703                 return;
 704
 705         if (devc->limit_samples && devc->samp_received >= devc->limit_samples) {
 706                 sr_info("Requested number of samples reached, stopping. %"
 707                         PRIu64 " <= %" PRIu64, devc->limit_samples,
 708                         devc->samp_received);
 709                 send_data(sdi, devc->sample_buf, devc->limit_samples);
 710                 sr_dev_acquisition_stop(sdi);
 711         } else if (devc->limit_msec && (g_get_monotonic_time() -
 712                         devc->aq_started) / 1000 >= devc->limit_msec) {
 713                 sr_info("Requested time limit reached, stopping. %d <= %d",
 714                         (uint32_t)devc->limit_msec,
 715                         (uint32_t)(g_get_monotonic_time() - devc->aq_started) / 1000);
 716                 send_data(sdi, devc->sample_buf, devc->samp_received);
 717                 g_free(devc->sample_buf);
 718                 devc->sample_buf = NULL;
 719                 sr_dev_acquisition_stop(sdi);
 720         } else {
 721                 read_channel(sdi, data_amount(sdi));
 722         }
 723 }
 724
 725 static int read_channel(const struct sr_dev_inst *sdi, uint32_t amount)
 726 {
 727         int ret;
 728         struct dev_context *devc;
 729
 730         devc = sdi->priv;
 731
 732         amount = MIN(amount, MAX_PACKET_SIZE);
 733         ret = hantek_6xxx_get_channeldata(sdi, receive_transfer, amount);
 734         devc->read_start_ts = g_get_monotonic_time();
 735         devc->read_data_amount = amount;
 736
 737         return ret;
 738 }
 739
 740 static int handle_event(int fd, int revents, void *cb_data)
 741 {
 742         const struct sr_dev_inst *sdi;
 743         struct timeval tv;
 744         struct sr_dev_driver *di;
 745         struct dev_context *devc;
 746         struct drv_context *drvc;
 747
 748         (void)fd;
 749         (void)revents;
 750
 751         sdi = cb_data;
 752         di = sdi->driver;
 753         drvc = di->context;
 754         devc = sdi->priv;
 755
 756         /* Always handle pending libusb events. */
 757         tv.tv_sec = tv.tv_usec = 0;
 758         libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
 759
 760         if (devc->dev_state == STOPPING) {
 761                 /* We've been told to wind up the acquisition. */
 762                 sr_dbg("Stopping acquisition.");
 763
 764                 hantek_6xxx_stop_data_collecting(sdi);
 765                 /*
 766                  * TODO: Doesn't really cancel pending transfers so they might
 767                  * come in after SR_DF_END is sent.
 768                  */
 769                 usb_source_remove(sdi->session, drvc->sr_ctx);
 770
 771                 std_session_send_df_end(sdi);
 772
 773                 devc->dev_state = IDLE;
 774
 775                 return TRUE;
 776         }
 777
 778         return TRUE;
 779 }
 780
 781 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 782 {
 783         struct dev_context *devc;
 784         struct sr_dev_driver *di = sdi->driver;
 785         struct drv_context *drvc = di->context;
 786
 787         devc = sdi->priv;
 788
 789         if (configure_channels(sdi) != SR_OK) {
 790                 sr_err("Failed to configure channels.");
 791                 return SR_ERR;
 792         }
 793
 794         if (hantek_6xxx_init(sdi) != SR_OK)
 795                 return SR_ERR;
 796
 797         std_session_send_df_header(sdi);
 798
 799         devc->samp_received = 0;
 800         devc->dev_state = FLUSH;
 801
 802         usb_source_add(sdi->session, drvc->sr_ctx, TICK,
 803                        handle_event, (void *)sdi);
 804
 805         hantek_6xxx_start_data_collecting(sdi);
 806
 807         read_channel(sdi, FLUSH_PACKET_SIZE);
 808
 809         return SR_OK;
 810 }
 811
 812 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 813 {
 814         struct dev_context *devc;
 815
 816         devc = sdi->priv;
 817         devc->dev_state = STOPPING;
 818
 819         g_free(devc->sample_buf);
 820         devc->sample_buf = NULL;
 821
 822         return SR_OK;
 823 }
 824
 825 static struct sr_dev_driver hantek_6xxx_driver_info = {
 826         .name = "hantek-6xxx",
 827         .longname = "Hantek 6xxx",
 828         .api_version = 1,
 829         .init = std_init,
 830         .cleanup = std_cleanup,
 831         .scan = scan,
 832         .dev_list = std_dev_list,
 833         .dev_clear = dev_clear,
 834         .config_get = config_get,
 835         .config_set = config_set,
 836         .config_list = config_list,
 837         .dev_open = dev_open,
 838         .dev_close = dev_close,
 839         .dev_acquisition_start = dev_acquisition_start,
 840         .dev_acquisition_stop = dev_acquisition_stop,
 841         .context = NULL,
 842 };
 843 SR_REGISTER_DEV_DRIVER(hantek_6xxx_driver_info);