]> sigrok.org Git - libsigrok.git/blob - src/hardware/rigol-ds/protocol.c
Add sr_dev_acquisition_stop(), factor out SR_ERR_DEV_CLOSED check.
[libsigrok.git] / 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->conn, ":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
337         if (!(devc = sdi->priv))
338                 return SR_ERR;
339
340         sr_dbg("Starting data capture for frameset %" PRIu64 " of %" PRIu64,
341                devc->num_frames + 1, devc->limit_frames);
342
343         switch (devc->model->series->protocol) {
344         case PROTOCOL_V1:
345                 rigol_ds_set_wait_event(devc, WAIT_TRIGGER);
346                 break;
347         case PROTOCOL_V2:
348                 if (devc->data_source == DATA_SOURCE_LIVE) {
349                         if (rigol_ds_config_set(sdi, ":WAV:POIN:MODE NORMAL") != SR_OK)
350                                 return SR_ERR;
351                         rigol_ds_set_wait_event(devc, WAIT_TRIGGER);
352                 } else {
353                         if (rigol_ds_config_set(sdi, ":STOP") != SR_OK)
354                                 return SR_ERR;
355                         if (rigol_ds_config_set(sdi, ":WAV:POIN:MODE RAW") != SR_OK)
356                                 return SR_ERR;
357                         if (sr_scpi_get_string(sdi->conn, ":TRIG:MODE?", &trig_mode) != SR_OK)
358                                 return SR_ERR;
359                         if (rigol_ds_config_set(sdi, ":TRIG:%s:SWE SING", trig_mode) != SR_OK)
360                                 return SR_ERR;
361                         if (rigol_ds_config_set(sdi, ":RUN") != SR_OK)
362                                 return SR_ERR;
363                         rigol_ds_set_wait_event(devc, WAIT_STOP);
364                 }
365                 break;
366         case PROTOCOL_V3:
367         case PROTOCOL_V4:
368                 if (rigol_ds_config_set(sdi, ":WAV:FORM BYTE") != SR_OK)
369                         return SR_ERR;
370                 if (devc->data_source == DATA_SOURCE_LIVE) {
371                         if (rigol_ds_config_set(sdi, ":WAV:MODE NORM") != SR_OK)
372                                 return SR_ERR;
373                         devc->analog_frame_size = devc->model->series->live_samples;
374                         devc->digital_frame_size = devc->model->series->live_samples;
375                         rigol_ds_set_wait_event(devc, WAIT_TRIGGER);
376                 } else {
377                         if (devc->model->series->protocol == PROTOCOL_V3) {
378                                 if (rigol_ds_config_set(sdi, ":WAV:MODE RAW") != SR_OK)
379                                         return SR_ERR;
380                         } else if (devc->model->series->protocol == PROTOCOL_V4) {
381                                 num_channels = 0;
382
383                                 /* Channels 3 and 4 are multiplexed with D0-7 and D8-15 */
384                                 for (i = 0; i < devc->model->analog_channels; i++) {
385                                         if (devc->analog_channels[i]) {
386                                                 num_channels++;
387                                         } else if (i >= 2 && devc->model->has_digital) {
388                                                 for (j = 0; j < 8; j++) {
389                                                         if (devc->digital_channels[8 * (i - 2) + j]) {
390                                                                 num_channels++;
391                                                                 break;
392                                                         }
393                                                 }
394                                         }
395                                 }
396
397                                 devc->analog_frame_size = devc->digital_frame_size =
398                                         num_channels == 1 ?
399                                                 devc->model->series->buffer_samples :
400                                                         num_channels == 2 ?
401                                                                 devc->model->series->buffer_samples / 2 :
402                                                                 devc->model->series->buffer_samples / 4;
403                         }
404
405                         if (rigol_ds_config_set(sdi, ":SING") != SR_OK)
406                                 return SR_ERR;
407                         rigol_ds_set_wait_event(devc, WAIT_STOP);
408                 }
409                 break;
410         }
411
412         return SR_OK;
413 }
414
415 /* Start reading data from the current channel */
416 SR_PRIV int rigol_ds_channel_start(const struct sr_dev_inst *sdi)
417 {
418         struct dev_context *devc;
419         struct sr_channel *ch;
420
421         if (!(devc = sdi->priv))
422                 return SR_ERR;
423
424         ch = devc->channel_entry->data;
425
426         sr_dbg("Starting reading data from channel %d", ch->index + 1);
427
428         switch (devc->model->series->protocol) {
429         case PROTOCOL_V1:
430         case PROTOCOL_V2:
431                 if (ch->type == SR_CHANNEL_LOGIC) {
432                         if (sr_scpi_send(sdi->conn, ":WAV:DATA? DIG") != SR_OK)
433                                 return SR_ERR;
434                 } else {
435                         if (sr_scpi_send(sdi->conn, ":WAV:DATA? CHAN%d",
436                                         ch->index + 1) != SR_OK)
437                                 return SR_ERR;
438                 }
439                 rigol_ds_set_wait_event(devc, WAIT_NONE);
440                 break;
441         case PROTOCOL_V3:
442                 if (ch->type == SR_CHANNEL_LOGIC) {
443                         if (rigol_ds_config_set(sdi->conn, ":WAV:SOUR LA") != SR_OK)
444                                 return SR_ERR;
445                 } else {
446                         if (rigol_ds_config_set(sdi, ":WAV:SOUR CHAN%d",
447                                         ch->index + 1) != SR_OK)
448                                 return SR_ERR;
449                 }
450                 if (devc->data_source != DATA_SOURCE_LIVE) {
451                         if (rigol_ds_config_set(sdi, ":WAV:RES") != SR_OK)
452                                 return SR_ERR;
453                         if (rigol_ds_config_set(sdi, ":WAV:BEG") != SR_OK)
454                                 return SR_ERR;
455                 }
456                 break;
457         case PROTOCOL_V4:
458                 if (ch->type == SR_CHANNEL_ANALOG) {
459                         if (rigol_ds_config_set(sdi, ":WAV:SOUR CHAN%d",
460                                         ch->index + 1) != SR_OK)
461                                 return SR_ERR;
462                 } else {
463                         if (rigol_ds_config_set(sdi, ":WAV:SOUR D%d",
464                                         ch->index) != SR_OK)
465                                 return SR_ERR;
466                 }
467
468                 if (rigol_ds_config_set(sdi,
469                                         devc->data_source == DATA_SOURCE_LIVE ?
470                                                 ":WAV:MODE NORM" :":WAV:MODE RAW") != SR_OK)
471                         return SR_ERR;
472                 break;
473         }
474
475         if (devc->model->series->protocol >= PROTOCOL_V3 &&
476                         ch->type == SR_CHANNEL_ANALOG) {
477                 /* Vertical reference. */
478                 if (sr_scpi_get_int(sdi->conn, ":WAV:YREF?",
479                                 &devc->vert_reference[ch->index]) != SR_OK)
480                         return SR_ERR;
481         }
482
483         rigol_ds_set_wait_event(devc, WAIT_BLOCK);
484
485         devc->num_channel_bytes = 0;
486         devc->num_header_bytes = 0;
487         devc->num_block_bytes = 0;
488
489         return SR_OK;
490 }
491
492 /* Read the header of a data block */
493 static int rigol_ds_read_header(struct sr_dev_inst *sdi)
494 {
495         struct sr_scpi_dev_inst *scpi = sdi->conn;
496         struct dev_context *devc = sdi->priv;
497         char *buf = (char *) devc->buffer;
498         size_t header_length;
499         int ret;
500
501         /* Try to read the hashsign and length digit. */
502         if (devc->num_header_bytes < 2) {
503                 ret = sr_scpi_read_data(scpi, buf + devc->num_header_bytes,
504                                 2 - devc->num_header_bytes);
505                 if (ret < 0) {
506                         sr_err("Read error while reading data header.");
507                         return SR_ERR;
508                 }
509                 devc->num_header_bytes += ret;
510         }
511
512         if (devc->num_header_bytes < 2)
513                 return 0;
514
515         if (buf[0] != '#' || !isdigit(buf[1]) || buf[1] == '0') {
516                 sr_err("Received invalid data block header '%c%c'.", buf[0], buf[1]);
517                 return SR_ERR;
518         }
519
520         header_length = 2 + buf[1] - '0';
521
522         /* Try to read the length. */
523         if (devc->num_header_bytes < header_length) {
524                 ret = sr_scpi_read_data(scpi, buf + devc->num_header_bytes,
525                                 header_length - devc->num_header_bytes);
526                 if (ret < 0) {
527                         sr_err("Read error while reading data header.");
528                         return SR_ERR;
529                 }
530                 devc->num_header_bytes += ret;
531         }
532
533         if (devc->num_header_bytes < header_length)
534                 return 0;
535
536         /* Read the data length. */
537         buf[header_length] = '\0';
538
539         if (parse_int(buf + 2, &ret) != SR_OK) {
540                 sr_err("Received invalid data block length '%s'.", buf + 2);
541                 return -1;
542         }
543
544         sr_dbg("Received data block header: '%s' -> block length %d", buf, ret);
545
546         return ret;
547 }
548
549 SR_PRIV int rigol_ds_receive(int fd, int revents, void *cb_data)
550 {
551         struct sr_dev_inst *sdi;
552         struct sr_scpi_dev_inst *scpi;
553         struct dev_context *devc;
554         struct sr_datafeed_packet packet;
555         struct sr_datafeed_analog analog;
556         struct sr_analog_encoding encoding;
557         struct sr_analog_meaning meaning;
558         struct sr_analog_spec spec;
559         struct sr_datafeed_logic logic;
560         double vdiv, offset;
561         int len, i, vref;
562         struct sr_channel *ch;
563         gsize expected_data_bytes;
564
565         (void)fd;
566
567         if (!(sdi = cb_data))
568                 return TRUE;
569
570         if (!(devc = sdi->priv))
571                 return TRUE;
572
573         scpi = sdi->conn;
574
575         if (!(revents == G_IO_IN || revents == 0))
576                 return TRUE;
577
578         switch (devc->wait_event) {
579         case WAIT_NONE:
580                 break;
581         case WAIT_TRIGGER:
582                 if (rigol_ds_trigger_wait(sdi) != SR_OK)
583                         return TRUE;
584                 if (rigol_ds_channel_start(sdi) != SR_OK)
585                         return TRUE;
586                 return TRUE;
587         case WAIT_BLOCK:
588                 if (rigol_ds_block_wait(sdi) != SR_OK)
589                         return TRUE;
590                 break;
591         case WAIT_STOP:
592                 if (rigol_ds_stop_wait(sdi) != SR_OK)
593                         return TRUE;
594                 if (rigol_ds_check_stop(sdi) != SR_OK)
595                         return TRUE;
596                 if (rigol_ds_channel_start(sdi) != SR_OK)
597                         return TRUE;
598                 return TRUE;
599         default:
600                 sr_err("BUG: Unknown event target encountered");
601                 break;
602         }
603
604         ch = devc->channel_entry->data;
605
606         expected_data_bytes = ch->type == SR_CHANNEL_ANALOG ?
607                         devc->analog_frame_size : devc->digital_frame_size;
608
609         if (devc->num_block_bytes == 0) {
610                 if (devc->model->series->protocol >= PROTOCOL_V4) {
611                         if (rigol_ds_config_set(sdi, ":WAV:START %d",
612                                         devc->num_channel_bytes + 1) != SR_OK)
613                                 return TRUE;
614                         if (rigol_ds_config_set(sdi, ":WAV:STOP %d",
615                                         MIN(devc->num_channel_bytes + ACQ_BLOCK_SIZE,
616                                                 devc->analog_frame_size)) != SR_OK)
617                                 return TRUE;
618                 }
619
620                 if (devc->model->series->protocol >= PROTOCOL_V3)
621                         if (sr_scpi_send(sdi->conn, ":WAV:DATA?") != SR_OK)
622                                 return TRUE;
623
624                 if (sr_scpi_read_begin(scpi) != SR_OK)
625                         return TRUE;
626
627                 if (devc->format == FORMAT_IEEE488_2) {
628                         sr_dbg("New block header expected");
629                         len = rigol_ds_read_header(sdi);
630                         if (len == 0)
631                                 /* Still reading the header. */
632                                 return TRUE;
633                         if (len == -1) {
634                                 sr_err("Read error, aborting capture.");
635                                 packet.type = SR_DF_FRAME_END;
636                                 sr_session_send(sdi, &packet);
637                                 sr_dev_acquisition_stop(sdi);
638                                 return TRUE;
639                         }
640                         /* At slow timebases in live capture the DS2072
641                          * sometimes returns "short" data blocks, with
642                          * apparently no way to get the rest of the data.
643                          * Discard these, the complete data block will
644                          * appear eventually.
645                          */
646                         if (devc->data_source == DATA_SOURCE_LIVE
647                                         && (unsigned)len < expected_data_bytes) {
648                                 sr_dbg("Discarding short data block");
649                                 sr_scpi_read_data(scpi, (char *)devc->buffer, len + 1);
650                                 return TRUE;
651                         }
652                         devc->num_block_bytes = len;
653                 } else {
654                         devc->num_block_bytes = expected_data_bytes;
655                 }
656                 devc->num_block_read = 0;
657         }
658
659         len = devc->num_block_bytes - devc->num_block_read;
660         if (len > ACQ_BUFFER_SIZE)
661                 len = ACQ_BUFFER_SIZE;
662         sr_dbg("Requesting read of %d bytes", len);
663
664         len = sr_scpi_read_data(scpi, (char *)devc->buffer, len);
665
666         if (len == -1) {
667                 sr_err("Read error, aborting capture.");
668                 packet.type = SR_DF_FRAME_END;
669                 sr_session_send(sdi, &packet);
670                 sr_dev_acquisition_stop(sdi);
671                 return TRUE;
672         }
673
674         sr_dbg("Received %d bytes.", len);
675
676         devc->num_block_read += len;
677
678         if (ch->type == SR_CHANNEL_ANALOG) {
679                 vref = devc->vert_reference[ch->index];
680                 vdiv = devc->vdiv[ch->index] / 25.6;
681                 offset = devc->vert_offset[ch->index];
682                 if (devc->model->series->protocol >= PROTOCOL_V3)
683                         for (i = 0; i < len; i++)
684                                 devc->data[i] = ((int)devc->buffer[i] - vref) * vdiv - offset;
685                 else
686                         for (i = 0; i < len; i++)
687                                 devc->data[i] = (128 - devc->buffer[i]) * vdiv - offset;
688                 float vdivlog = log10f(vdiv);
689                 int digits = -(int)vdivlog + (vdivlog < 0.0);
690                 sr_analog_init(&analog, &encoding, &meaning, &spec, digits);
691                 analog.meaning->channels = g_slist_append(NULL, ch);
692                 analog.num_samples = len;
693                 analog.data = devc->data;
694                 analog.meaning->mq = SR_MQ_VOLTAGE;
695                 analog.meaning->unit = SR_UNIT_VOLT;
696                 analog.meaning->mqflags = 0;
697                 packet.type = SR_DF_ANALOG;
698                 packet.payload = &analog;
699                 sr_session_send(sdi, &packet);
700                 g_slist_free(analog.meaning->channels);
701         } else {
702                 logic.length = len;
703                 // TODO: For the MSO1000Z series, we need a way to express that
704                 // this data is in fact just for a single channel, with the valid
705                 // data for that channel in the LSB of each byte.
706                 logic.unitsize = devc->model->series->protocol == PROTOCOL_V4 ? 1 : 2;
707                 logic.data = devc->buffer;
708                 packet.type = SR_DF_LOGIC;
709                 packet.payload = &logic;
710                 sr_session_send(sdi, &packet);
711         }
712
713         if (devc->num_block_read == devc->num_block_bytes) {
714                 sr_dbg("Block has been completed");
715                 if (devc->model->series->protocol >= PROTOCOL_V3) {
716                         /* Discard the terminating linefeed */
717                         sr_scpi_read_data(scpi, (char *)devc->buffer, 1);
718                 }
719                 if (devc->format == FORMAT_IEEE488_2) {
720                         /* Prepare for possible next block */
721                         devc->num_header_bytes = 0;
722                         devc->num_block_bytes = 0;
723                         if (devc->data_source != DATA_SOURCE_LIVE)
724                                 rigol_ds_set_wait_event(devc, WAIT_BLOCK);
725                 }
726                 if (!sr_scpi_read_complete(scpi)) {
727                         sr_err("Read should have been completed");
728                         packet.type = SR_DF_FRAME_END;
729                         sr_session_send(sdi, &packet);
730                         sr_dev_acquisition_stop(sdi);
731                         return TRUE;
732                 }
733                 devc->num_block_read = 0;
734         } else {
735                 sr_dbg("%" PRIu64 " of %" PRIu64 " block bytes read",
736                         devc->num_block_read, devc->num_block_bytes);
737         }
738
739         devc->num_channel_bytes += len;
740
741         if (devc->num_channel_bytes < expected_data_bytes)
742                 /* Don't have the full data for this channel yet, re-run. */
743                 return TRUE;
744
745         /* End of data for this channel. */
746         if (devc->model->series->protocol == PROTOCOL_V3) {
747                 /* Signal end of data download to scope */
748                 if (devc->data_source != DATA_SOURCE_LIVE)
749                         /*
750                          * This causes a query error, without it switching
751                          * to the next channel causes an error. Fun with
752                          * firmware...
753                          */
754                         rigol_ds_config_set(sdi, ":WAV:END");
755         }
756
757         if (devc->channel_entry->next) {
758                 /* We got the frame for this channel, now get the next channel. */
759                 devc->channel_entry = devc->channel_entry->next;
760                 rigol_ds_channel_start(sdi);
761         } else {
762                 /* Done with this frame. */
763                 packet.type = SR_DF_FRAME_END;
764                 sr_session_send(sdi, &packet);
765
766                 if (++devc->num_frames == devc->limit_frames) {
767                         /* Last frame, stop capture. */
768                         sr_dev_acquisition_stop(sdi);
769                 } else {
770                         /* Get the next frame, starting with the first channel. */
771                         devc->channel_entry = devc->enabled_channels;
772
773                         rigol_ds_capture_start(sdi);
774
775                         /* Start of next frame. */
776                         packet.type = SR_DF_FRAME_BEGIN;
777                         sr_session_send(sdi, &packet);
778                 }
779         }
780
781         return TRUE;
782 }
783
784 SR_PRIV int rigol_ds_get_dev_cfg(const struct sr_dev_inst *sdi)
785 {
786         struct dev_context *devc;
787         struct sr_channel *ch;
788         char *cmd;
789         unsigned int i;
790         int res;
791
792         devc = sdi->priv;
793
794         /* Analog channel state. */
795         for (i = 0; i < devc->model->analog_channels; i++) {
796                 cmd = g_strdup_printf(":CHAN%d:DISP?", i + 1);
797                 res = sr_scpi_get_bool(sdi->conn, cmd, &devc->analog_channels[i]);
798                 g_free(cmd);
799                 if (res != SR_OK)
800                         return SR_ERR;
801                 ch = g_slist_nth_data(sdi->channels, i);
802                 ch->enabled = devc->analog_channels[i];
803         }
804         sr_dbg("Current analog channel state:");
805         for (i = 0; i < devc->model->analog_channels; i++)
806                 sr_dbg("CH%d %s", i + 1, devc->analog_channels[i] ? "on" : "off");
807
808         /* Digital channel state. */
809         if (devc->model->has_digital) {
810                 if (sr_scpi_get_bool(sdi->conn,
811                                 devc->model->series->protocol >= PROTOCOL_V3 ?
812                                         ":LA:STAT?" : ":LA:DISP?",
813                                 &devc->la_enabled) != SR_OK)
814                         return SR_ERR;
815                 sr_dbg("Logic analyzer %s, current digital channel state:",
816                                 devc->la_enabled ? "enabled" : "disabled");
817                 for (i = 0; i < ARRAY_SIZE(devc->digital_channels); i++) {
818                         cmd = g_strdup_printf(
819                                 devc->model->series->protocol >= PROTOCOL_V3 ?
820                                         ":LA:DIG%d:DISP?" : ":DIG%d:TURN?", i);
821                         res = sr_scpi_get_bool(sdi->conn, cmd, &devc->digital_channels[i]);
822                         g_free(cmd);
823                         if (res != SR_OK)
824                                 return SR_ERR;
825                         ch = g_slist_nth_data(sdi->channels, i + devc->model->analog_channels);
826                         ch->enabled = devc->digital_channels[i];
827                         sr_dbg("D%d: %s", i, devc->digital_channels[i] ? "on" : "off");
828                 }
829         }
830
831         /* Timebase. */
832         if (sr_scpi_get_float(sdi->conn, ":TIM:SCAL?", &devc->timebase) != SR_OK)
833                 return SR_ERR;
834         sr_dbg("Current timebase %g", devc->timebase);
835
836         /* Probe attenuation. */
837         for (i = 0; i < devc->model->analog_channels; i++) {
838                 cmd = g_strdup_printf(":CHAN%d:PROB?", i + 1);
839                 res = sr_scpi_get_float(sdi->conn, cmd, &devc->attenuation[i]);
840                 g_free(cmd);
841                 if (res != SR_OK)
842                         return SR_ERR;
843         }
844         sr_dbg("Current probe attenuation:");
845         for (i = 0; i < devc->model->analog_channels; i++)
846                 sr_dbg("CH%d %g", i + 1, devc->attenuation[i]);
847
848         /* Vertical gain and offset. */
849         if (rigol_ds_get_dev_cfg_vertical(sdi) != SR_OK)
850                 return SR_ERR;
851
852         /* Coupling. */
853         for (i = 0; i < devc->model->analog_channels; i++) {
854                 cmd = g_strdup_printf(":CHAN%d:COUP?", i + 1);
855                 res = sr_scpi_get_string(sdi->conn, cmd, &devc->coupling[i]);
856                 g_free(cmd);
857                 if (res != SR_OK)
858                         return SR_ERR;
859         }
860         sr_dbg("Current coupling:");
861         for (i = 0; i < devc->model->analog_channels; i++)
862                 sr_dbg("CH%d %s", i + 1, devc->coupling[i]);
863
864         /* Trigger source. */
865         if (sr_scpi_get_string(sdi->conn, ":TRIG:EDGE:SOUR?", &devc->trigger_source) != SR_OK)
866                 return SR_ERR;
867         sr_dbg("Current trigger source %s", devc->trigger_source);
868
869         /* Horizontal trigger position. */
870         if (sr_scpi_get_float(sdi->conn, ":TIM:OFFS?", &devc->horiz_triggerpos) != SR_OK)
871                 return SR_ERR;
872         sr_dbg("Current horizontal trigger position %g", devc->horiz_triggerpos);
873
874         /* Trigger slope. */
875         if (sr_scpi_get_string(sdi->conn, ":TRIG:EDGE:SLOP?", &devc->trigger_slope) != SR_OK)
876                 return SR_ERR;
877         sr_dbg("Current trigger slope %s", devc->trigger_slope);
878
879         /* Trigger level. */
880         if (sr_scpi_get_float(sdi->conn, ":TRIG:EDGE:LEV?", &devc->trigger_level) != SR_OK)
881                 return SR_ERR;
882         sr_dbg("Current trigger level %g", devc->trigger_level);
883
884         return SR_OK;
885 }
886
887 SR_PRIV int rigol_ds_get_dev_cfg_vertical(const struct sr_dev_inst *sdi)
888 {
889         struct dev_context *devc;
890         char *cmd;
891         unsigned int i;
892         int res;
893
894         devc = sdi->priv;
895
896         /* Vertical gain. */
897         for (i = 0; i < devc->model->analog_channels; i++) {
898                 cmd = g_strdup_printf(":CHAN%d:SCAL?", i + 1);
899                 res = sr_scpi_get_float(sdi->conn, cmd, &devc->vdiv[i]);
900                 g_free(cmd);
901                 if (res != SR_OK)
902                         return SR_ERR;
903         }
904         sr_dbg("Current vertical gain:");
905         for (i = 0; i < devc->model->analog_channels; i++)
906                 sr_dbg("CH%d %g", i + 1, devc->vdiv[i]);
907
908         /* Vertical offset. */
909         for (i = 0; i < devc->model->analog_channels; i++) {
910                 cmd = g_strdup_printf(":CHAN%d:OFFS?", i + 1);
911                 res = sr_scpi_get_float(sdi->conn, cmd, &devc->vert_offset[i]);
912                 g_free(cmd);
913                 if (res != SR_OK)
914                         return SR_ERR;
915         }
916         sr_dbg("Current vertical offset:");
917         for (i = 0; i < devc->model->analog_channels; i++)
918                 sr_dbg("CH%d %g", i + 1, devc->vert_offset[i]);
919
920         return SR_OK;
921 }