src/hardware/rigol-ds/protocol.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2012 Martin Ling <martin-git@earth.li>
   5  * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
   6  * Copyright (C) 2013 Mathias Grimmberger <mgri@zaphod.sax.de>
   7  *
   8  * This program is free software: you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation, either version 3 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20  */
  21
  22 #include <config.h>
  23 #include <stdlib.h>
  24 #include <stdarg.h>
  25 #include <unistd.h>
  26 #include <errno.h>
  27 #include <string.h>
  28 #include <math.h>
  29 #include <ctype.h>
  30 #include <time.h>
  31 #include <glib.h>
  32 #include <libsigrok/libsigrok.h>
  33 #include "libsigrok-internal.h"
  34 #include "scpi.h"
  35 #include "protocol.h"
  36
  37 /*
  38  * This is a unified protocol driver for the DS1000 and DS2000 series.
  39  *
  40  * DS1000 support tested with a Rigol DS1102D.
  41  *
  42  * DS2000 support tested with a Rigol DS2072 using firmware version 01.01.00.02.
  43  *
  44  * The Rigol DS2000 series scopes try to adhere to the IEEE 488.2 (I think)
  45  * standard. If you want to read it - it costs real money...
  46  *
  47  * Every response from the scope has a linefeed appended because the
  48  * standard says so. In principle this could be ignored because sending the
  49  * next command clears the output queue of the scope. This driver tries to
  50  * avoid doing that because it may cause an error being generated inside the
  51  * scope and who knows what bugs the firmware has WRT this.
  52  *
  53  * Waveform data is transferred in a format called "arbitrary block program
  54  * data" specified in IEEE 488.2. See Agilents programming manuals for their
  55  * 2000/3000 series scopes for a nice description.
  56  *
  57  * Each data block from the scope has a header, e.g. "#900000001400".
  58  * The '#' marks the start of a block.
  59  * Next is one ASCII decimal digit between 1 and 9, this gives the number of
  60  * ASCII decimal digits following.
  61  * Last are the ASCII decimal digits giving the number of bytes (not
  62  * samples!) in the block.
  63  *
  64  * After this header as many data bytes as indicated follow.
  65  *
  66  * Each data block has a trailing linefeed too.
  67  */
  68
  69 static int parse_int(const char *str, int *ret)
  70 {
  71         char *e;
  72         long tmp;
  73
  74         errno = 0;
  75         tmp = strtol(str, &e, 10);
  76         if (e == str || *e != '\0') {
  77                 sr_dbg("Failed to parse integer: '%s'", str);
  78                 return SR_ERR;
  79         }
  80         if (errno) {
  81                 sr_dbg("Failed to parse integer: '%s', numerical overflow", str);
  82                 return SR_ERR;
  83         }
  84         if (tmp > INT_MAX || tmp < INT_MIN) {
  85                 sr_dbg("Failed to parse integer: '%s', value to large/small", str);
  86                 return SR_ERR;
  87         }
  88
  89         *ret = (int)tmp;
  90         return SR_OK;
  91 }
  92
  93 /* Set the next event to wait for in rigol_ds_receive */
  94 static void rigol_ds_set_wait_event(struct dev_context *devc, enum wait_events event)
  95 {
  96         if (event == WAIT_STOP)
  97                 devc->wait_status = 2;
  98         else
  99                 devc->wait_status = 1;
 100         devc->wait_event = event;
 101 }
 102
 103 /*
 104  * Waiting for a event will return a timeout after 2 to 3 seconds in order
 105  * to not block the application.
 106  */
 107 static int rigol_ds_event_wait(const struct sr_dev_inst *sdi, char status1, char status2)
 108 {
 109         char *buf;
 110         struct dev_context *devc;
 111         time_t start;
 112
 113         if (!(devc = sdi->priv))
 114                 return SR_ERR;
 115
 116         start = time(NULL);
 117
 118         /*
 119          * Trigger status may return:
 120          * "TD" or "T'D" - triggered
 121          * "AUTO"        - autotriggered
 122          * "RUN"         - running
 123          * "WAIT"        - waiting for trigger
 124          * "STOP"        - stopped
 125          */
 126
 127         if (devc->wait_status == 1) {
 128                 do {
 129                         if (time(NULL) - start >= 3) {
 130                                 sr_dbg("Timeout waiting for trigger");
 131                                 return SR_ERR_TIMEOUT;
 132                         }
 133
 134                         if (sr_scpi_get_string(sdi->conn, ":TRIG:STAT?", &buf) != SR_OK)
 135                                 return SR_ERR;
 136                 } while (buf[0] == status1 || buf[0] == status2);
 137
 138                 devc->wait_status = 2;
 139         }
 140         if (devc->wait_status == 2) {
 141                 do {
 142                         if (time(NULL) - start >= 3) {
 143                                 sr_dbg("Timeout waiting for trigger");
 144                                 return SR_ERR_TIMEOUT;
 145                         }
 146
 147                         if (sr_scpi_get_string(sdi->conn, ":TRIG:STAT?", &buf) != SR_OK)
 148                                 return SR_ERR;
 149                 } while (buf[0] != status1 && buf[0] != status2);
 150
 151                 rigol_ds_set_wait_event(devc, WAIT_NONE);
 152         }
 153
 154         return SR_OK;
 155 }
 156
 157 /*
 158  * For live capture we need to wait for a new trigger event to ensure that
 159  * sample data is not returned twice.
 160  *
 161  * Unfortunately this will never really work because for sufficiently fast
 162  * timebases and trigger rates it just can't catch the status changes.
 163  *
 164  * What would be needed is a trigger event register with autoreset like the
 165  * Agilents have. The Rigols don't seem to have anything like this.
 166  *
 167  * The workaround is to only wait for the trigger when the timebase is slow
 168  * enough. Of course this means that for faster timebases sample data can be
 169  * returned multiple times, this effect is mitigated somewhat by sleeping
 170  * for about one sweep time in that case.
 171  */
 172 static int rigol_ds_trigger_wait(const struct sr_dev_inst *sdi)
 173 {
 174         struct dev_context *devc;
 175         long s;
 176
 177         if (!(devc = sdi->priv))
 178                 return SR_ERR;
 179
 180         /*
 181          * If timebase < 50 msecs/DIV just sleep about one sweep time except
 182          * for really fast sweeps.
 183          */
 184         if (devc->timebase < 0.0499) {
 185                 if (devc->timebase > 0.99e-6) {
 186                         /*
 187                          * Timebase * num hor. divs * 85(%) * 1e6(usecs) / 100
 188                          * -> 85 percent of sweep time
 189                          */
 190                         s = (devc->timebase * devc->model->series->num_horizontal_divs
 191                              * 85e6) / 100L;
 192                         sr_spew("Sleeping for %ld usecs instead of trigger-wait", s);
 193                         g_usleep(s);
 194                 }
 195                 rigol_ds_set_wait_event(devc, WAIT_NONE);
 196                 return SR_OK;
 197         } else {
 198                 return rigol_ds_event_wait(sdi, 'T', 'A');
 199         }
 200 }
 201
 202 /* Wait for scope to got to "Stop" in single shot mode */
 203 static int rigol_ds_stop_wait(const struct sr_dev_inst *sdi)
 204 {
 205         return rigol_ds_event_wait(sdi, 'S', 'S');
 206 }
 207
 208 /* Check that a single shot acquisition actually succeeded on the DS2000 */
 209 static int rigol_ds_check_stop(const struct sr_dev_inst *sdi)
 210 {
 211         struct dev_context *devc;
 212         struct sr_channel *ch;
 213         int tmp;
 214
 215         if (!(devc = sdi->priv))
 216                 return SR_ERR;
 217
 218         ch = devc->channel_entry->data;
 219
 220         if (devc->model->series->protocol != PROTOCOL_V3)
 221                 return SR_OK;
 222
 223         if (ch->type == SR_CHANNEL_LOGIC) {
 224                 if (rigol_ds_config_set(sdi, ":WAV:SOUR LA") != SR_OK)
 225                         return SR_ERR;
 226         } else {
 227                 if (rigol_ds_config_set(sdi, ":WAV:SOUR CHAN%d",
 228                                 ch->index + 1) != SR_OK)
 229                         return SR_ERR;
 230         }
 231         /* Check that the number of samples will be accepted */
 232         if (rigol_ds_config_set(sdi, ":WAV:POIN %d",
 233                         ch->type == SR_CHANNEL_LOGIC ?
 234                                 devc->digital_frame_size :
 235                                 devc->analog_frame_size) != SR_OK)
 236                 return SR_ERR;
 237         if (sr_scpi_get_int(sdi->conn, "*ESR?", &tmp) != SR_OK)
 238                 return SR_ERR;
 239         /*
 240          * If we get an "Execution error" the scope went from "Single" to
 241          * "Stop" without actually triggering. There is no waveform
 242          * displayed and trying to download one will fail - the scope thinks
 243          * it has 1400 samples (like display memory) and the driver thinks
 244          * it has a different number of samples.
 245          *
 246          * In that case just try to capture something again. Might still
 247          * fail in interesting ways.
 248          *
 249          * Ain't firmware fun?
 250          */
 251         if (tmp & 0x10) {
 252                 sr_warn("Single shot acquisition failed, retrying...");
 253                 /* Sleep a bit, otherwise the single shot will often fail */
 254                 g_usleep(500 * 1000);
 255                 rigol_ds_config_set(sdi, ":SING");
 256                 rigol_ds_set_wait_event(devc, WAIT_STOP);
 257                 return SR_ERR;
 258         }
 259
 260         return SR_OK;
 261 }
 262
 263 /* Wait for enough data becoming available in scope output buffer */
 264 static int rigol_ds_block_wait(const struct sr_dev_inst *sdi)
 265 {
 266         char *buf;
 267         struct dev_context *devc;
 268         time_t start;
 269         int len;
 270
 271         if (!(devc = sdi->priv))
 272                 return SR_ERR;
 273
 274         if (devc->model->series->protocol == PROTOCOL_V3) {
 275
 276                 start = time(NULL);
 277
 278                 do {
 279                         if (time(NULL) - start >= 3) {
 280                                 sr_dbg("Timeout waiting for data block");
 281                                 return SR_ERR_TIMEOUT;
 282                         }
 283
 284                         /*
 285                          * The scope copies data really slowly from sample
 286                          * memory to its output buffer, so try not to bother
 287                          * it too much with SCPI requests but don't wait too
 288                          * long for short sample frame sizes.
 289                          */
 290                         g_usleep(devc->analog_frame_size < (15 * 1000) ? (100 * 1000) : (1000 * 1000));
 291
 292                         /* "READ,nnnn" (still working) or "IDLE,nnnn" (finished) */
 293                         if (sr_scpi_get_string(sdi->conn, ":WAV:STAT?", &buf) != SR_OK)
 294                                 return SR_ERR;
 295
 296                         if (parse_int(buf + 5, &len) != SR_OK)
 297                                 return SR_ERR;
 298                 } while (buf[0] == 'R' && len < (1000 * 1000));
 299         }
 300
 301         rigol_ds_set_wait_event(devc, WAIT_NONE);
 302
 303         return SR_OK;
 304 }
 305
 306 /* Send a configuration setting. */
 307 SR_PRIV int rigol_ds_config_set(const struct sr_dev_inst *sdi, const char *format, ...)
 308 {
 309         struct dev_context *devc = sdi->priv;
 310         va_list args;
 311         int ret;
 312
 313         va_start(args, format);
 314         ret = sr_scpi_send_variadic(sdi->conn, format, args);
 315         va_end(args);
 316
 317         if (ret != SR_OK)
 318                 return SR_ERR;
 319
 320         if (devc->model->series->protocol == PROTOCOL_V2) {
 321                 /* The DS1000 series needs this stupid delay, *OPC? doesn't work. */
 322                 sr_spew("delay %dms", 100);
 323                 g_usleep(100 * 1000);
 324                 return SR_OK;
 325         } else {
 326                 return sr_scpi_get_opc(sdi->conn);
 327         }
 328 }
 329
 330 /* Start capturing a new frameset */
 331 SR_PRIV int rigol_ds_capture_start(const struct sr_dev_inst *sdi)
 332 {
 333         struct dev_context *devc;
 334         gchar *trig_mode;
 335         unsigned int num_channels, i, j;
 336         int buffer_samples;
 337
 338         if (!(devc = sdi->priv))
 339                 return SR_ERR;
 340
 341         if (devc->limit_frames == 0)
 342                 sr_dbg("Starting data capture for frameset %" PRIu64,
 343                        devc->num_frames + 1);
 344         else
 345                 sr_dbg("Starting data capture for frameset %" PRIu64 " of %"
 346                        PRIu64, devc->num_frames + 1, devc->limit_frames);
 347
 348         switch (devc->model->series->protocol) {
 349         case PROTOCOL_V1:
 350                 rigol_ds_set_wait_event(devc, WAIT_TRIGGER);
 351                 break;
 352         case PROTOCOL_V2:
 353                 if (devc->data_source == DATA_SOURCE_LIVE) {
 354                         if (rigol_ds_config_set(sdi, ":WAV:POIN:MODE NORMAL") != SR_OK)
 355                                 return SR_ERR;
 356                         rigol_ds_set_wait_event(devc, WAIT_TRIGGER);
 357                 } else {
 358                         if (rigol_ds_config_set(sdi, ":STOP") != SR_OK)
 359                                 return SR_ERR;
 360                         if (rigol_ds_config_set(sdi, ":WAV:POIN:MODE RAW") != SR_OK)
 361                                 return SR_ERR;
 362                         if (sr_scpi_get_string(sdi->conn, ":TRIG:MODE?", &trig_mode) != SR_OK)
 363                                 return SR_ERR;
 364                         if (rigol_ds_config_set(sdi, ":TRIG:%s:SWE SING", trig_mode) != SR_OK)
 365                                 return SR_ERR;
 366                         if (rigol_ds_config_set(sdi, ":RUN") != SR_OK)
 367                                 return SR_ERR;
 368                         rigol_ds_set_wait_event(devc, WAIT_STOP);
 369                 }
 370                 break;
 371         case PROTOCOL_V3:
 372         case PROTOCOL_V4:
 373         case PROTOCOL_V5:
 374                 if (rigol_ds_config_set(sdi, ":WAV:FORM BYTE") != SR_OK)
 375                         return SR_ERR;
 376                 if (devc->data_source == DATA_SOURCE_LIVE) {
 377                         if (rigol_ds_config_set(sdi, ":WAV:MODE NORM") != SR_OK)
 378                                 return SR_ERR;
 379                         devc->analog_frame_size = devc->model->series->live_samples;
 380                         devc->digital_frame_size = devc->model->series->live_samples;
 381                         rigol_ds_set_wait_event(devc, WAIT_TRIGGER);
 382                 } else {
 383                         if (devc->model->series->protocol == PROTOCOL_V3) {
 384                                 if (rigol_ds_config_set(sdi, ":WAV:MODE RAW") != SR_OK)
 385                                         return SR_ERR;
 386                         } else if (devc->model->series->protocol >= PROTOCOL_V4) {
 387                                 num_channels = 0;
 388
 389                                 /* Channels 3 and 4 are multiplexed with D0-7 and D8-15 */
 390                                 for (i = 0; i < devc->model->analog_channels; i++) {
 391                                         if (devc->analog_channels[i]) {
 392                                                 num_channels++;
 393                                         } else if (i >= 2 && devc->model->has_digital) {
 394                                                 for (j = 0; j < 8; j++) {
 395                                                         if (devc->digital_channels[8 * (i - 2) + j]) {
 396                                                                 num_channels++;
 397                                                                 break;
 398                                                         }
 399                                                 }
 400                                         }
 401                                 }
 402
 403                                 buffer_samples = devc->model->series->buffer_samples;
 404                                 if (buffer_samples == 0)
 405                                 {
 406                                         /* The DS4000 series does not have a fixed memory depth, it
 407                                          * can be chosen from the menu and also varies with number
 408                                          * of active channels. Retrieve the actual number with the
 409                                          * ACQ:MDEP command. */
 410                                         sr_scpi_get_int(sdi->conn, "ACQ:MDEP?", &buffer_samples);
 411                                         devc->analog_frame_size = devc->digital_frame_size =
 412                                                         buffer_samples;
 413                                 }
 414                                 else
 415                                 {
 416                                         /* The DS1000Z series has a fixed memory depth which we
 417                                          * need to divide correctly according to the number of
 418                                          * active channels. */
 419                                         devc->analog_frame_size = devc->digital_frame_size =
 420                                                 num_channels == 1 ?
 421                                                         buffer_samples :
 422                                                                 num_channels == 2 ?
 423                                                                         buffer_samples / 2 :
 424                                                                         buffer_samples / 4;
 425                                 }
 426                         }
 427
 428                         if (rigol_ds_config_set(sdi, ":SING") != SR_OK)
 429                                 return SR_ERR;
 430                         rigol_ds_set_wait_event(devc, WAIT_STOP);
 431                 }
 432                 break;
 433         }
 434
 435         return SR_OK;
 436 }
 437
 438 /* Start reading data from the current channel */
 439 SR_PRIV int rigol_ds_channel_start(const struct sr_dev_inst *sdi)
 440 {
 441         struct dev_context *devc;
 442         struct sr_channel *ch;
 443
 444         if (!(devc = sdi->priv))
 445                 return SR_ERR;
 446
 447         ch = devc->channel_entry->data;
 448
 449         sr_dbg("Starting reading data from channel %d", ch->index + 1);
 450
 451         switch (devc->model->series->protocol) {
 452         case PROTOCOL_V1:
 453         case PROTOCOL_V2:
 454                 if (ch->type == SR_CHANNEL_LOGIC) {
 455                         if (sr_scpi_send(sdi->conn, ":WAV:DATA? DIG") != SR_OK)
 456                                 return SR_ERR;
 457                 } else {
 458                         if (sr_scpi_send(sdi->conn, ":WAV:DATA? CHAN%d",
 459                                         ch->index + 1) != SR_OK)
 460                                 return SR_ERR;
 461                 }
 462                 rigol_ds_set_wait_event(devc, WAIT_NONE);
 463                 break;
 464         case PROTOCOL_V3:
 465                 if (ch->type == SR_CHANNEL_LOGIC) {
 466                         if (rigol_ds_config_set(sdi, ":WAV:SOUR LA") != SR_OK)
 467                                 return SR_ERR;
 468                 } else {
 469                         if (rigol_ds_config_set(sdi, ":WAV:SOUR CHAN%d",
 470                                         ch->index + 1) != SR_OK)
 471                                 return SR_ERR;
 472                 }
 473                 if (devc->data_source != DATA_SOURCE_LIVE) {
 474                         if (rigol_ds_config_set(sdi, ":WAV:RES") != SR_OK)
 475                                 return SR_ERR;
 476                         if (rigol_ds_config_set(sdi, ":WAV:BEG") != SR_OK)
 477                                 return SR_ERR;
 478                 }
 479                 break;
 480         case PROTOCOL_V4:
 481         case PROTOCOL_V5:
 482                 if (ch->type == SR_CHANNEL_ANALOG) {
 483                         if (rigol_ds_config_set(sdi, ":WAV:SOUR CHAN%d",
 484                                         ch->index + 1) != SR_OK)
 485                                 return SR_ERR;
 486                 } else {
 487                         if (rigol_ds_config_set(sdi, ":WAV:SOUR D%d",
 488                                         ch->index) != SR_OK)
 489                                 return SR_ERR;
 490                 }
 491
 492                 if (rigol_ds_config_set(sdi,
 493                                         devc->data_source == DATA_SOURCE_LIVE ?
 494                                                 ":WAV:MODE NORM" :":WAV:MODE RAW") != SR_OK)
 495                         return SR_ERR;
 496
 497                 if (devc->data_source != DATA_SOURCE_LIVE) {
 498                         if (rigol_ds_config_set(sdi, ":WAV:RES") != SR_OK)
 499                                 return SR_ERR;
 500                 }
 501                 break;
 502         }
 503
 504         if (devc->model->series->protocol >= PROTOCOL_V3 &&
 505                         ch->type == SR_CHANNEL_ANALOG) {
 506                 /* Vertical increment. */
 507                 if (sr_scpi_get_float(sdi->conn, ":WAV:YINC?",
 508                                 &devc->vert_inc[ch->index]) != SR_OK)
 509                         return SR_ERR;
 510                 /* Vertical origin. */
 511                 if (sr_scpi_get_float(sdi->conn, ":WAV:YOR?",
 512                         &devc->vert_origin[ch->index]) != SR_OK)
 513                         return SR_ERR;
 514                 /* Vertical reference. */
 515                 if (sr_scpi_get_int(sdi->conn, ":WAV:YREF?",
 516                                 &devc->vert_reference[ch->index]) != SR_OK)
 517                         return SR_ERR;
 518         } else if (ch->type == SR_CHANNEL_ANALOG) {
 519                 devc->vert_inc[ch->index] = devc->vdiv[ch->index] / 25.6;
 520         }
 521
 522         rigol_ds_set_wait_event(devc, WAIT_BLOCK);
 523
 524         devc->num_channel_bytes = 0;
 525         devc->num_header_bytes = 0;
 526         devc->num_block_bytes = 0;
 527
 528         return SR_OK;
 529 }
 530
 531 /* Read the header of a data block */
 532 static int rigol_ds_read_header(struct sr_dev_inst *sdi)
 533 {
 534         struct sr_scpi_dev_inst *scpi = sdi->conn;
 535         struct dev_context *devc = sdi->priv;
 536         char *buf = (char *) devc->buffer;
 537         size_t header_length;
 538         int ret;
 539
 540         /* Try to read the hashsign and length digit. */
 541         if (devc->num_header_bytes < 2) {
 542                 ret = sr_scpi_read_data(scpi, buf + devc->num_header_bytes,
 543                                 2 - devc->num_header_bytes);
 544                 if (ret < 0) {
 545                         sr_err("Read error while reading data header.");
 546                         return SR_ERR;
 547                 }
 548                 devc->num_header_bytes += ret;
 549         }
 550
 551         if (devc->num_header_bytes < 2)
 552                 return 0;
 553
 554         if (buf[0] != '#' || !isdigit(buf[1]) || buf[1] == '0') {
 555                 sr_err("Received invalid data block header '%c%c'.", buf[0], buf[1]);
 556                 return SR_ERR;
 557         }
 558
 559         header_length = 2 + buf[1] - '0';
 560
 561         /* Try to read the length. */
 562         if (devc->num_header_bytes < header_length) {
 563                 ret = sr_scpi_read_data(scpi, buf + devc->num_header_bytes,
 564                                 header_length - devc->num_header_bytes);
 565                 if (ret < 0) {
 566                         sr_err("Read error while reading data header.");
 567                         return SR_ERR;
 568                 }
 569                 devc->num_header_bytes += ret;
 570         }
 571
 572         if (devc->num_header_bytes < header_length)
 573                 return 0;
 574
 575         /* Read the data length. */
 576         buf[header_length] = '\0';
 577
 578         if (parse_int(buf + 2, &ret) != SR_OK) {
 579                 sr_err("Received invalid data block length '%s'.", buf + 2);
 580                 return -1;
 581         }
 582
 583         sr_dbg("Received data block header: '%s' -> block length %d", buf, ret);
 584
 585         return ret;
 586 }
 587
 588 SR_PRIV int rigol_ds_receive(int fd, int revents, void *cb_data)
 589 {
 590         struct sr_dev_inst *sdi;
 591         struct sr_scpi_dev_inst *scpi;
 592         struct dev_context *devc;
 593         struct sr_datafeed_packet packet;
 594         struct sr_datafeed_analog analog;
 595         struct sr_analog_encoding encoding;
 596         struct sr_analog_meaning meaning;
 597         struct sr_analog_spec spec;
 598         struct sr_datafeed_logic logic;
 599         double vdiv, offset, origin;
 600         int len, i, vref;
 601         struct sr_channel *ch;
 602         gsize expected_data_bytes;
 603
 604         (void)fd;
 605
 606         if (!(sdi = cb_data))
 607                 return TRUE;
 608
 609         if (!(devc = sdi->priv))
 610                 return TRUE;
 611
 612         scpi = sdi->conn;
 613
 614         if (!(revents == G_IO_IN || revents == 0))
 615                 return TRUE;
 616
 617         switch (devc->wait_event) {
 618         case WAIT_NONE:
 619                 break;
 620         case WAIT_TRIGGER:
 621                 if (rigol_ds_trigger_wait(sdi) != SR_OK)
 622                         return TRUE;
 623                 if (rigol_ds_channel_start(sdi) != SR_OK)
 624                         return TRUE;
 625                 return TRUE;
 626         case WAIT_BLOCK:
 627                 if (rigol_ds_block_wait(sdi) != SR_OK)
 628                         return TRUE;
 629                 break;
 630         case WAIT_STOP:
 631                 if (rigol_ds_stop_wait(sdi) != SR_OK)
 632                         return TRUE;
 633                 if (rigol_ds_check_stop(sdi) != SR_OK)
 634                         return TRUE;
 635                 if (rigol_ds_channel_start(sdi) != SR_OK)
 636                         return TRUE;
 637                 return TRUE;
 638         default:
 639                 sr_err("BUG: Unknown event target encountered");
 640                 break;
 641         }
 642
 643         ch = devc->channel_entry->data;
 644
 645         expected_data_bytes = ch->type == SR_CHANNEL_ANALOG ?
 646                         devc->analog_frame_size : devc->digital_frame_size;
 647
 648         if (devc->num_block_bytes == 0) {
 649                 if (devc->model->series->protocol >= PROTOCOL_V4) {
 650                         if (rigol_ds_config_set(sdi, ":WAV:START %d",
 651                                         devc->num_channel_bytes + 1) != SR_OK)
 652                                 return TRUE;
 653                         if (rigol_ds_config_set(sdi, ":WAV:STOP %d",
 654                                         MIN(devc->num_channel_bytes + ACQ_BLOCK_SIZE,
 655                                                 devc->analog_frame_size)) != SR_OK)
 656                                 return TRUE;
 657                 }
 658
 659                 if (devc->model->series->protocol >= PROTOCOL_V3) {
 660                         if (rigol_ds_config_set(sdi, ":WAV:BEG") != SR_OK)
 661                                 return TRUE;
 662                         if (sr_scpi_send(sdi->conn, ":WAV:DATA?") != SR_OK)
 663                                 return TRUE;
 664                 }
 665
 666                 if (sr_scpi_read_begin(scpi) != SR_OK)
 667                         return TRUE;
 668
 669                 if (devc->format == FORMAT_IEEE488_2) {
 670                         sr_dbg("New block header expected");
 671                         len = rigol_ds_read_header(sdi);
 672                         if (len == 0)
 673                                 /* Still reading the header. */
 674                                 return TRUE;
 675                         if (len == -1) {
 676                                 sr_err("Error while reading block header, aborting capture.");
 677                                 std_session_send_df_frame_end(sdi);
 678                                 sr_dev_acquisition_stop(sdi);
 679                                 return TRUE;
 680                         }
 681                         /* At slow timebases in live capture the DS2072
 682                          * sometimes returns "short" data blocks, with
 683                          * apparently no way to get the rest of the data.
 684                          * Discard these, the complete data block will
 685                          * appear eventually.
 686                          */
 687                         if (devc->data_source == DATA_SOURCE_LIVE
 688                                         && (unsigned)len < expected_data_bytes) {
 689                                 sr_dbg("Discarding short data block");
 690                                 sr_scpi_read_data(scpi, (char *)devc->buffer, len + 1);
 691                                 return TRUE;
 692                         }
 693                         devc->num_block_bytes = len;
 694                 } else {
 695                         devc->num_block_bytes = expected_data_bytes;
 696                 }
 697                 devc->num_block_read = 0;
 698         }
 699
 700         len = devc->num_block_bytes - devc->num_block_read;
 701         if (len > ACQ_BUFFER_SIZE)
 702                 len = ACQ_BUFFER_SIZE;
 703         sr_dbg("Requesting read of %d bytes", len);
 704
 705         len = sr_scpi_read_data(scpi, (char *)devc->buffer, len);
 706
 707         if (len == -1) {
 708                 sr_err("Error while reading block data, aborting capture.");
 709                 std_session_send_df_frame_end(sdi);
 710                 sr_dev_acquisition_stop(sdi);
 711                 return TRUE;
 712         }
 713
 714         sr_dbg("Received %d bytes.", len);
 715
 716         devc->num_block_read += len;
 717
 718         if (ch->type == SR_CHANNEL_ANALOG) {
 719                 vref = devc->vert_reference[ch->index];
 720                 vdiv = devc->vert_inc[ch->index];
 721                 origin = devc->vert_origin[ch->index];
 722                 offset = devc->vert_offset[ch->index];
 723                 if (devc->model->series->protocol >= PROTOCOL_V3)
 724                         for (i = 0; i < len; i++)
 725                                 devc->data[i] = ((int)devc->buffer[i] - vref - origin) * vdiv;
 726                 else
 727                         for (i = 0; i < len; i++)
 728                                 devc->data[i] = (128 - devc->buffer[i]) * vdiv - offset;
 729                 float vdivlog = log10f(vdiv);
 730                 int digits = -(int)vdivlog + (vdivlog < 0.0);
 731                 sr_analog_init(&analog, &encoding, &meaning, &spec, digits);
 732                 analog.meaning->channels = g_slist_append(NULL, ch);
 733                 analog.num_samples = len;
 734                 analog.data = devc->data;
 735                 analog.meaning->mq = SR_MQ_VOLTAGE;
 736                 analog.meaning->unit = SR_UNIT_VOLT;
 737                 analog.meaning->mqflags = 0;
 738                 packet.type = SR_DF_ANALOG;
 739                 packet.payload = &analog;
 740                 sr_session_send(sdi, &packet);
 741                 g_slist_free(analog.meaning->channels);
 742         } else {
 743                 logic.length = len;
 744                 // TODO: For the MSO1000Z series, we need a way to express that
 745                 // this data is in fact just for a single channel, with the valid
 746                 // data for that channel in the LSB of each byte.
 747                 logic.unitsize = devc->model->series->protocol >= PROTOCOL_V4 ? 1 : 2;
 748                 logic.data = devc->buffer;
 749                 packet.type = SR_DF_LOGIC;
 750                 packet.payload = &logic;
 751                 sr_session_send(sdi, &packet);
 752         }
 753
 754         if (devc->num_block_read == devc->num_block_bytes) {
 755                 sr_dbg("Block has been completed");
 756                 if (devc->model->series->protocol >= PROTOCOL_V3) {
 757                         /* Discard the terminating linefeed */
 758                         sr_scpi_read_data(scpi, (char *)devc->buffer, 1);
 759                 }
 760                 if (devc->format == FORMAT_IEEE488_2) {
 761                         /* Prepare for possible next block */
 762                         devc->num_header_bytes = 0;
 763                         devc->num_block_bytes = 0;
 764                         if (devc->data_source != DATA_SOURCE_LIVE)
 765                                 rigol_ds_set_wait_event(devc, WAIT_BLOCK);
 766                 }
 767                 if (!sr_scpi_read_complete(scpi) && !devc->channel_entry->next) {
 768                         sr_err("Read should have been completed");
 769                 }
 770                 devc->num_block_read = 0;
 771         } else {
 772                 sr_dbg("%" PRIu64 " of %" PRIu64 " block bytes read",
 773                         devc->num_block_read, devc->num_block_bytes);
 774         }
 775
 776         devc->num_channel_bytes += len;
 777
 778         if (devc->num_channel_bytes < expected_data_bytes)
 779                 /* Don't have the full data for this channel yet, re-run. */
 780                 return TRUE;
 781
 782         /* End of data for this channel. */
 783         if (devc->model->series->protocol == PROTOCOL_V3) {
 784                 /* Signal end of data download to scope */
 785                 if (devc->data_source != DATA_SOURCE_LIVE)
 786                         /*
 787                          * This causes a query error, without it switching
 788                          * to the next channel causes an error. Fun with
 789                          * firmware...
 790                          */
 791                         rigol_ds_config_set(sdi, ":WAV:END");
 792         }
 793
 794         if (devc->channel_entry->next) {
 795                 /* We got the frame for this channel, now get the next channel. */
 796                 devc->channel_entry = devc->channel_entry->next;
 797                 rigol_ds_channel_start(sdi);
 798         } else {
 799                 /* Done with this frame. */
 800                 std_session_send_df_frame_end(sdi);
 801
 802                 if (++devc->num_frames == devc->limit_frames || devc->data_source == DATA_SOURCE_MEMORY) {
 803                         /* Last frame, stop capture. */
 804                         sr_dev_acquisition_stop(sdi);
 805                 } else {
 806                         /* Get the next frame, starting with the first channel. */
 807                         devc->channel_entry = devc->enabled_channels;
 808
 809                         rigol_ds_capture_start(sdi);
 810
 811                         /* Start of next frame. */
 812                         std_session_send_df_frame_begin(sdi);
 813                 }
 814         }
 815
 816         return TRUE;
 817 }
 818
 819 SR_PRIV int rigol_ds_get_dev_cfg(const struct sr_dev_inst *sdi)
 820 {
 821         struct dev_context *devc;
 822         struct sr_channel *ch;
 823         char *cmd;
 824         unsigned int i;
 825         int res;
 826
 827         devc = sdi->priv;
 828
 829         /* Analog channel state. */
 830         for (i = 0; i < devc->model->analog_channels; i++) {
 831                 cmd = g_strdup_printf(":CHAN%d:DISP?", i + 1);
 832                 res = sr_scpi_get_bool(sdi->conn, cmd, &devc->analog_channels[i]);
 833                 g_free(cmd);
 834                 if (res != SR_OK)
 835                         return SR_ERR;
 836                 ch = g_slist_nth_data(sdi->channels, i);
 837                 ch->enabled = devc->analog_channels[i];
 838         }
 839         sr_dbg("Current analog channel state:");
 840         for (i = 0; i < devc->model->analog_channels; i++)
 841                 sr_dbg("CH%d %s", i + 1, devc->analog_channels[i] ? "on" : "off");
 842
 843         /* Digital channel state. */
 844         if (devc->model->has_digital) {
 845                 if (sr_scpi_get_bool(sdi->conn,
 846                                 devc->model->series->protocol >= PROTOCOL_V3 ?
 847                                         ":LA:STAT?" : ":LA:DISP?",
 848                                 &devc->la_enabled) != SR_OK)
 849                         return SR_ERR;
 850                 sr_dbg("Logic analyzer %s, current digital channel state:",
 851                                 devc->la_enabled ? "enabled" : "disabled");
 852                 for (i = 0; i < ARRAY_SIZE(devc->digital_channels); i++) {
 853                         if (devc->model->series->protocol >= PROTOCOL_V5)
 854                                 cmd = g_strdup_printf(":LA:DISP? D%d", i);
 855                         else if (devc->model->series->protocol >= PROTOCOL_V3)
 856                                 cmd = g_strdup_printf(":LA:DIG%d:DISP?", i);
 857                         else
 858                                 cmd = g_strdup_printf(":DIG%d:TURN?", i);
 859                         res = sr_scpi_get_bool(sdi->conn, cmd, &devc->digital_channels[i]);
 860                         g_free(cmd);
 861                         if (res != SR_OK)
 862                                 return SR_ERR;
 863                         ch = g_slist_nth_data(sdi->channels, i + devc->model->analog_channels);
 864                         ch->enabled = devc->digital_channels[i];
 865                         sr_dbg("D%d: %s", i, devc->digital_channels[i] ? "on" : "off");
 866                 }
 867         }
 868
 869         /* Timebase. */
 870         if (sr_scpi_get_float(sdi->conn, ":TIM:SCAL?", &devc->timebase) != SR_OK)
 871                 return SR_ERR;
 872         sr_dbg("Current timebase %g", devc->timebase);
 873
 874         /* Probe attenuation. */
 875         for (i = 0; i < devc->model->analog_channels; i++) {
 876                 cmd = g_strdup_printf(":CHAN%d:PROB?", i + 1);
 877                 res = sr_scpi_get_float(sdi->conn, cmd, &devc->attenuation[i]);
 878                 g_free(cmd);
 879                 if (res != SR_OK)
 880                         return SR_ERR;
 881         }
 882         sr_dbg("Current probe attenuation:");
 883         for (i = 0; i < devc->model->analog_channels; i++)
 884                 sr_dbg("CH%d %g", i + 1, devc->attenuation[i]);
 885
 886         /* Vertical gain and offset. */
 887         if (rigol_ds_get_dev_cfg_vertical(sdi) != SR_OK)
 888                 return SR_ERR;
 889
 890         /* Coupling. */
 891         for (i = 0; i < devc->model->analog_channels; i++) {
 892                 cmd = g_strdup_printf(":CHAN%d:COUP?", i + 1);
 893                 res = sr_scpi_get_string(sdi->conn, cmd, &devc->coupling[i]);
 894                 g_free(cmd);
 895                 if (res != SR_OK)
 896                         return SR_ERR;
 897         }
 898         sr_dbg("Current coupling:");
 899         for (i = 0; i < devc->model->analog_channels; i++)
 900                 sr_dbg("CH%d %s", i + 1, devc->coupling[i]);
 901
 902         /* Trigger source. */
 903         if (sr_scpi_get_string(sdi->conn, ":TRIG:EDGE:SOUR?", &devc->trigger_source) != SR_OK)
 904                 return SR_ERR;
 905         sr_dbg("Current trigger source %s", devc->trigger_source);
 906
 907         /* Horizontal trigger position. */
 908         if (sr_scpi_get_float(sdi->conn, devc->model->cmds[CMD_GET_HORIZ_TRIGGERPOS].str,
 909                         &devc->horiz_triggerpos) != SR_OK)
 910                 return SR_ERR;
 911         sr_dbg("Current horizontal trigger position %g", devc->horiz_triggerpos);
 912
 913         /* Trigger slope. */
 914         if (sr_scpi_get_string(sdi->conn, ":TRIG:EDGE:SLOP?", &devc->trigger_slope) != SR_OK)
 915                 return SR_ERR;
 916         sr_dbg("Current trigger slope %s", devc->trigger_slope);
 917
 918         /* Trigger level. */
 919         if (sr_scpi_get_float(sdi->conn, ":TRIG:EDGE:LEV?", &devc->trigger_level) != SR_OK)
 920                 return SR_ERR;
 921         sr_dbg("Current trigger level %g", devc->trigger_level);
 922
 923         return SR_OK;
 924 }
 925
 926 SR_PRIV int rigol_ds_get_dev_cfg_vertical(const struct sr_dev_inst *sdi)
 927 {
 928         struct dev_context *devc;
 929         char *cmd;
 930         unsigned int i;
 931         int res;
 932
 933         devc = sdi->priv;
 934
 935         /* Vertical gain. */
 936         for (i = 0; i < devc->model->analog_channels; i++) {
 937                 cmd = g_strdup_printf(":CHAN%d:SCAL?", i + 1);
 938                 res = sr_scpi_get_float(sdi->conn, cmd, &devc->vdiv[i]);
 939                 g_free(cmd);
 940                 if (res != SR_OK)
 941                         return SR_ERR;
 942         }
 943         sr_dbg("Current vertical gain:");
 944         for (i = 0; i < devc->model->analog_channels; i++)
 945                 sr_dbg("CH%d %g", i + 1, devc->vdiv[i]);
 946
 947         /* Vertical offset. */
 948         for (i = 0; i < devc->model->analog_channels; i++) {
 949                 cmd = g_strdup_printf(":CHAN%d:OFFS?", i + 1);
 950                 res = sr_scpi_get_float(sdi->conn, cmd, &devc->vert_offset[i]);
 951                 g_free(cmd);
 952                 if (res != SR_OK)
 953                         return SR_ERR;
 954         }
 955         sr_dbg("Current vertical offset:");
 956         for (i = 0; i < devc->model->analog_channels; i++)
 957                 sr_dbg("CH%d %g", i + 1, devc->vert_offset[i]);
 958
 959         return SR_OK;
 960 }