]> sigrok.org Git - libsigrok.git/blame - src/hardware/rigol-ds/protocol.c
rigol-ds: Experimental support for V5 frame reading
[libsigrok.git] / src / hardware / rigol-ds / protocol.c
CommitLineData
f4816ac6
ML
1/*
2 * This file is part of the libsigrok project.
3 *
4 * Copyright (C) 2012 Martin Ling <martin-git@earth.li>
88e429c9 5 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
bafd4890 6 * Copyright (C) 2013 Mathias Grimmberger <mgri@zaphod.sax.de>
f4816ac6
ML
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
6ec6c43b 22#include <config.h>
f4816ac6 23#include <stdlib.h>
e0b7d23c
ML
24#include <stdarg.h>
25#include <unistd.h>
26#include <errno.h>
a3df166f 27#include <string.h>
254dd102 28#include <math.h>
bafd4890
ML
29#include <ctype.h>
30#include <time.h>
f4816ac6 31#include <glib.h>
c1aae900 32#include <libsigrok/libsigrok.h>
f4816ac6 33#include "libsigrok-internal.h"
5a1afc09 34#include "scpi.h"
f4816ac6
ML
35#include "protocol.h"
36
bafd4890
ML
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
bafd4890
ML
69static 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
babab622
ML
93/* Set the next event to wait for in rigol_ds_receive */
94static 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
bafd4890 103/*
babab622
ML
104 * Waiting for a event will return a timeout after 2 to 3 seconds in order
105 * to not block the application.
bafd4890 106 */
babab622 107static int rigol_ds_event_wait(const struct sr_dev_inst *sdi, char status1, char status2)
bafd4890 108{
334fbc2a 109 char *buf;
bafd4890
ML
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:
babab622
ML
120 * "TD" or "T'D" - triggered
121 * "AUTO" - autotriggered
122 * "RUN" - running
123 * "WAIT" - waiting for trigger
124 * "STOP" - stopped
bafd4890
ML
125 */
126
babab622 127 if (devc->wait_status == 1) {
bafd4890
ML
128 do {
129 if (time(NULL) - start >= 3) {
130 sr_dbg("Timeout waiting for trigger");
131 return SR_ERR_TIMEOUT;
132 }
133
334fbc2a 134 if (sr_scpi_get_string(sdi->conn, ":TRIG:STAT?", &buf) != SR_OK)
bafd4890 135 return SR_ERR;
babab622 136 } while (buf[0] == status1 || buf[0] == status2);
bafd4890 137
babab622 138 devc->wait_status = 2;
bafd4890 139 }
babab622 140 if (devc->wait_status == 2) {
bafd4890
ML
141 do {
142 if (time(NULL) - start >= 3) {
143 sr_dbg("Timeout waiting for trigger");
144 return SR_ERR_TIMEOUT;
145 }
146
334fbc2a 147 if (sr_scpi_get_string(sdi->conn, ":TRIG:STAT?", &buf) != SR_OK)
bafd4890 148 return SR_ERR;
babab622 149 } while (buf[0] != status1 && buf[0] != status2);
bafd4890 150
babab622 151 rigol_ds_set_wait_event(devc, WAIT_NONE);
bafd4890
ML
152 }
153
154 return SR_OK;
155}
156
157/*
babab622
ML
158 * For live capture we need to wait for a new trigger event to ensure that
159 * sample data is not returned twice.
bafd4890
ML
160 *
161 * Unfortunately this will never really work because for sufficiently fast
babab622 162 * timebases and trigger rates it just can't catch the status changes.
bafd4890
ML
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
babab622
ML
169 * returned multiple times, this effect is mitigated somewhat by sleeping
170 * for about one sweep time in that case.
bafd4890 171 */
babab622 172static int rigol_ds_trigger_wait(const struct sr_dev_inst *sdi)
bafd4890
ML
173{
174 struct dev_context *devc;
babab622 175 long s;
bafd4890
ML
176
177 if (!(devc = sdi->priv))
178 return SR_ERR;
179
176d785d 180 /*
babab622
ML
181 * If timebase < 50 msecs/DIV just sleep about one sweep time except
182 * for really fast sweeps.
183 */
c2b394d5 184 if (devc->timebase < 0.0499) {
babab622
ML
185 if (devc->timebase > 0.99e-6) {
186 /*
187 * Timebase * num hor. divs * 85(%) * 1e6(usecs) / 100
188 * -> 85 percent of sweep time
189 */
569d4dbd 190 s = (devc->timebase * devc->model->series->num_horizontal_divs
babab622
ML
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}
bafd4890 201
babab622
ML
202/* Wait for scope to got to "Stop" in single shot mode */
203static 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 */
209static int rigol_ds_check_stop(const struct sr_dev_inst *sdi)
210{
211 struct dev_context *devc;
ba7dd8bb 212 struct sr_channel *ch;
babab622
ML
213 int tmp;
214
215 if (!(devc = sdi->priv))
bafd4890 216 return SR_ERR;
babab622 217
ba7dd8bb 218 ch = devc->channel_entry->data;
821fbcad 219
702f42e8 220 if (devc->model->series->protocol != PROTOCOL_V3)
e086b750
ML
221 return SR_OK;
222
01dd7a4c 223 if (ch->type == SR_CHANNEL_LOGIC) {
bbcffe51 224 if (rigol_ds_config_set(sdi, ":WAV:SOUR LA") != SR_OK)
01dd7a4c
ML
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 }
babab622 231 /* Check that the number of samples will be accepted */
01dd7a4c
ML
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)
babab622 236 return SR_ERR;
334fbc2a 237 if (sr_scpi_get_int(sdi->conn, "*ESR?", &tmp) != SR_OK)
bafd4890 238 return SR_ERR;
babab622
ML
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 */
1a46cc62 254 g_usleep(500 * 1000);
38354d9d 255 rigol_ds_config_set(sdi, ":SING");
babab622 256 rigol_ds_set_wait_event(devc, WAIT_STOP);
bafd4890 257 return SR_ERR;
babab622 258 }
bafd4890 259
babab622
ML
260 return SR_OK;
261}
bafd4890 262
babab622
ML
263/* Wait for enough data becoming available in scope output buffer */
264static int rigol_ds_block_wait(const struct sr_dev_inst *sdi)
265{
334fbc2a 266 char *buf;
babab622
ML
267 struct dev_context *devc;
268 time_t start;
269 int len;
270
271 if (!(devc = sdi->priv))
272 return SR_ERR;
273
702f42e8 274 if (devc->model->series->protocol == PROTOCOL_V3) {
babab622 275
4472867a
ML
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 }
babab622 283
4472867a
ML
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 */
1a46cc62 290 g_usleep(devc->analog_frame_size < (15 * 1000) ? (100 * 1000) : (1000 * 1000));
4472867a
ML
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;
1a46cc62 298 } while (buf[0] == 'R' && len < (1000 * 1000));
4472867a 299 }
babab622
ML
300
301 rigol_ds_set_wait_event(devc, WAIT_NONE);
302
303 return SR_OK;
304}
305
38354d9d
ML
306/* Send a configuration setting. */
307SR_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
569d4dbd 320 if (devc->model->series->protocol == PROTOCOL_V2) {
38354d9d
ML
321 /* The DS1000 series needs this stupid delay, *OPC? doesn't work. */
322 sr_spew("delay %dms", 100);
1a46cc62 323 g_usleep(100 * 1000);
38354d9d
ML
324 return SR_OK;
325 } else {
326 return sr_scpi_get_opc(sdi->conn);
327 }
328}
329
babab622
ML
330/* Start capturing a new frameset */
331SR_PRIV int rigol_ds_capture_start(const struct sr_dev_inst *sdi)
332{
333 struct dev_context *devc;
e086b750 334 gchar *trig_mode;
702f42e8 335 unsigned int num_channels, i, j;
47b821dc 336 int buffer_samples;
babab622
ML
337
338 if (!(devc = sdi->priv))
339 return SR_ERR;
340
8cbe5339
VO
341 uint64_t limit_frames = devc->limit_frames;
342 if (devc->num_frames_segmented != 0 && devc->num_frames_segmented < limit_frames)
343 limit_frames = devc->num_frames_segmented;
344 if (limit_frames == 0)
9ad1d49c
UH
345 sr_dbg("Starting data capture for frameset %" PRIu64,
346 devc->num_frames + 1);
347 else
348 sr_dbg("Starting data capture for frameset %" PRIu64 " of %"
8cbe5339 349 PRIu64, devc->num_frames + 1, limit_frames);
babab622 350
569d4dbd
ML
351 switch (devc->model->series->protocol) {
352 case PROTOCOL_V1:
353 rigol_ds_set_wait_event(devc, WAIT_TRIGGER);
354 break;
355 case PROTOCOL_V2:
356 if (devc->data_source == DATA_SOURCE_LIVE) {
357 if (rigol_ds_config_set(sdi, ":WAV:POIN:MODE NORMAL") != SR_OK)
e086b750 358 return SR_ERR;
569d4dbd 359 rigol_ds_set_wait_event(devc, WAIT_TRIGGER);
e086b750 360 } else {
e086b750
ML
361 if (rigol_ds_config_set(sdi, ":STOP") != SR_OK)
362 return SR_ERR;
363 if (rigol_ds_config_set(sdi, ":WAV:POIN:MODE RAW") != SR_OK)
364 return SR_ERR;
365 if (sr_scpi_get_string(sdi->conn, ":TRIG:MODE?", &trig_mode) != SR_OK)
366 return SR_ERR;
367 if (rigol_ds_config_set(sdi, ":TRIG:%s:SWE SING", trig_mode) != SR_OK)
368 return SR_ERR;
369 if (rigol_ds_config_set(sdi, ":RUN") != SR_OK)
370 return SR_ERR;
569d4dbd
ML
371 rigol_ds_set_wait_event(devc, WAIT_STOP);
372 }
373 break;
374 case PROTOCOL_V3:
702f42e8 375 case PROTOCOL_V4:
f6129c8f 376 case PROTOCOL_V5:
569d4dbd
ML
377 if (rigol_ds_config_set(sdi, ":WAV:FORM BYTE") != SR_OK)
378 return SR_ERR;
379 if (devc->data_source == DATA_SOURCE_LIVE) {
380 if (rigol_ds_config_set(sdi, ":WAV:MODE NORM") != SR_OK)
381 return SR_ERR;
702f42e8
ML
382 devc->analog_frame_size = devc->model->series->live_samples;
383 devc->digital_frame_size = devc->model->series->live_samples;
569d4dbd 384 rigol_ds_set_wait_event(devc, WAIT_TRIGGER);
e086b750 385 } else {
702f42e8
ML
386 if (devc->model->series->protocol == PROTOCOL_V3) {
387 if (rigol_ds_config_set(sdi, ":WAV:MODE RAW") != SR_OK)
388 return SR_ERR;
f6129c8f 389 } else if (devc->model->series->protocol >= PROTOCOL_V4) {
702f42e8
ML
390 num_channels = 0;
391
392 /* Channels 3 and 4 are multiplexed with D0-7 and D8-15 */
393 for (i = 0; i < devc->model->analog_channels; i++) {
394 if (devc->analog_channels[i]) {
395 num_channels++;
396 } else if (i >= 2 && devc->model->has_digital) {
397 for (j = 0; j < 8; j++) {
398 if (devc->digital_channels[8 * (i - 2) + j]) {
399 num_channels++;
400 break;
401 }
402 }
403 }
404 }
405
47b821dc
ML
406 buffer_samples = devc->model->series->buffer_samples;
407 if (buffer_samples == 0)
408 {
409 /* The DS4000 series does not have a fixed memory depth, it
410 * can be chosen from the menu and also varies with number
411 * of active channels. Retrieve the actual number with the
412 * ACQ:MDEP command. */
413 sr_scpi_get_int(sdi->conn, "ACQ:MDEP?", &buffer_samples);
414 devc->analog_frame_size = devc->digital_frame_size =
415 buffer_samples;
416 }
417 else
418 {
419 /* The DS1000Z series has a fixed memory depth which we
420 * need to divide correctly according to the number of
421 * active channels. */
422 devc->analog_frame_size = devc->digital_frame_size =
423 num_channels == 1 ?
424 buffer_samples :
425 num_channels == 2 ?
426 buffer_samples / 2 :
427 buffer_samples / 4;
428 }
702f42e8
ML
429 }
430
e086b750
ML
431 if (rigol_ds_config_set(sdi, ":SING") != SR_OK)
432 return SR_ERR;
569d4dbd 433 rigol_ds_set_wait_event(devc, WAIT_STOP);
19f31c8a
VO
434 if (devc->data_source == DATA_SOURCE_SEGMENTED &&
435 devc->model->series->protocol == PROTOCOL_V4)
8cbe5339
VO
436 if (rigol_ds_config_set(sdi, "FUNC:WREP:FCUR %d", devc->num_frames + 1) != SR_OK)
437 return SR_ERR;
e086b750 438 }
569d4dbd 439 break;
bafd4890
ML
440 }
441
442 return SR_OK;
443}
444
babab622
ML
445/* Start reading data from the current channel */
446SR_PRIV int rigol_ds_channel_start(const struct sr_dev_inst *sdi)
447{
448 struct dev_context *devc;
ba7dd8bb 449 struct sr_channel *ch;
babab622
ML
450
451 if (!(devc = sdi->priv))
452 return SR_ERR;
453
ba7dd8bb 454 ch = devc->channel_entry->data;
821fbcad 455
ba7dd8bb 456 sr_dbg("Starting reading data from channel %d", ch->index + 1);
babab622 457
2ea67fc9 458 switch (devc->model->series->protocol) {
702f42e8
ML
459 case PROTOCOL_V1:
460 case PROTOCOL_V2:
3f239f08 461 if (ch->type == SR_CHANNEL_LOGIC) {
677f85d0
ML
462 if (sr_scpi_send(sdi->conn, ":WAV:DATA? DIG") != SR_OK)
463 return SR_ERR;
464 } else {
821fbcad 465 if (sr_scpi_send(sdi->conn, ":WAV:DATA? CHAN%d",
ba7dd8bb 466 ch->index + 1) != SR_OK)
677f85d0
ML
467 return SR_ERR;
468 }
e086b750 469 rigol_ds_set_wait_event(devc, WAIT_NONE);
702f42e8
ML
470 break;
471 case PROTOCOL_V3:
01dd7a4c 472 if (ch->type == SR_CHANNEL_LOGIC) {
bbcffe51 473 if (rigol_ds_config_set(sdi, ":WAV:SOUR LA") != SR_OK)
01dd7a4c
ML
474 return SR_ERR;
475 } else {
476 if (rigol_ds_config_set(sdi, ":WAV:SOUR CHAN%d",
477 ch->index + 1) != SR_OK)
478 return SR_ERR;
479 }
677f85d0 480 if (devc->data_source != DATA_SOURCE_LIVE) {
38354d9d 481 if (rigol_ds_config_set(sdi, ":WAV:RES") != SR_OK)
677f85d0 482 return SR_ERR;
38354d9d 483 if (rigol_ds_config_set(sdi, ":WAV:BEG") != SR_OK)
677f85d0 484 return SR_ERR;
aff00e40 485 }
702f42e8
ML
486 break;
487 case PROTOCOL_V4:
f6129c8f 488 case PROTOCOL_V5:
702f42e8
ML
489 if (ch->type == SR_CHANNEL_ANALOG) {
490 if (rigol_ds_config_set(sdi, ":WAV:SOUR CHAN%d",
491 ch->index + 1) != SR_OK)
492 return SR_ERR;
493 } else {
494 if (rigol_ds_config_set(sdi, ":WAV:SOUR D%d",
495 ch->index) != SR_OK)
496 return SR_ERR;
497 }
498
499 if (rigol_ds_config_set(sdi,
500 devc->data_source == DATA_SOURCE_LIVE ?
501 ":WAV:MODE NORM" :":WAV:MODE RAW") != SR_OK)
502 return SR_ERR;
704910e3
VO
503
504 if (devc->data_source != DATA_SOURCE_LIVE) {
505 if (rigol_ds_config_set(sdi, ":WAV:RES") != SR_OK)
506 return SR_ERR;
507 }
702f42e8
ML
508 break;
509 }
510
511 if (devc->model->series->protocol >= PROTOCOL_V3 &&
512 ch->type == SR_CHANNEL_ANALOG) {
6b04525b
VO
513 /* Vertical increment. */
514 if (sr_scpi_get_float(sdi->conn, ":WAV:YINC?",
515 &devc->vert_inc[ch->index]) != SR_OK)
55bece00
UH
516 return SR_ERR;
517 /* Vertical origin. */
518 if (sr_scpi_get_float(sdi->conn, ":WAV:YOR?",
519 &devc->vert_origin[ch->index]) != SR_OK)
520 return SR_ERR;
702f42e8
ML
521 /* Vertical reference. */
522 if (sr_scpi_get_int(sdi->conn, ":WAV:YREF?",
523 &devc->vert_reference[ch->index]) != SR_OK)
524 return SR_ERR;
6b04525b
VO
525 } else if (ch->type == SR_CHANNEL_ANALOG) {
526 devc->vert_inc[ch->index] = devc->vdiv[ch->index] / 25.6;
677f85d0 527 }
babab622 528
aff00e40
ML
529 rigol_ds_set_wait_event(devc, WAIT_BLOCK);
530
f76c24f6 531 devc->num_channel_bytes = 0;
aff00e40 532 devc->num_header_bytes = 0;
babab622
ML
533 devc->num_block_bytes = 0;
534
535 return SR_OK;
536}
537
538/* Read the header of a data block */
aff00e40 539static int rigol_ds_read_header(struct sr_dev_inst *sdi)
bafd4890 540{
aff00e40
ML
541 struct sr_scpi_dev_inst *scpi = sdi->conn;
542 struct dev_context *devc = sdi->priv;
543 char *buf = (char *) devc->buffer;
fe0d9caa
ML
544 size_t header_length;
545 int ret;
aff00e40
ML
546
547 /* Try to read the hashsign and length digit. */
548 if (devc->num_header_bytes < 2) {
fe0d9caa 549 ret = sr_scpi_read_data(scpi, buf + devc->num_header_bytes,
aff00e40 550 2 - devc->num_header_bytes);
fe0d9caa 551 if (ret < 0) {
aff00e40
ML
552 sr_err("Read error while reading data header.");
553 return SR_ERR;
554 }
fe0d9caa 555 devc->num_header_bytes += ret;
bafd4890 556 }
aff00e40
ML
557
558 if (devc->num_header_bytes < 2)
559 return 0;
560
561 if (buf[0] != '#' || !isdigit(buf[1]) || buf[1] == '0') {
562 sr_err("Received invalid data block header '%c%c'.", buf[0], buf[1]);
563 return SR_ERR;
bafd4890 564 }
bafd4890 565
fe0d9caa 566 header_length = 2 + buf[1] - '0';
aff00e40
ML
567
568 /* Try to read the length. */
fe0d9caa
ML
569 if (devc->num_header_bytes < header_length) {
570 ret = sr_scpi_read_data(scpi, buf + devc->num_header_bytes,
571 header_length - devc->num_header_bytes);
572 if (ret < 0) {
aff00e40
ML
573 sr_err("Read error while reading data header.");
574 return SR_ERR;
575 }
fe0d9caa 576 devc->num_header_bytes += ret;
bafd4890 577 }
aff00e40 578
fe0d9caa 579 if (devc->num_header_bytes < header_length)
aff00e40
ML
580 return 0;
581
582 /* Read the data length. */
fe0d9caa 583 buf[header_length] = '\0';
aff00e40 584
fe0d9caa 585 if (parse_int(buf + 2, &ret) != SR_OK) {
aff00e40 586 sr_err("Received invalid data block length '%s'.", buf + 2);
bafd4890
ML
587 return -1;
588 }
589
fe0d9caa 590 sr_dbg("Received data block header: '%s' -> block length %d", buf, ret);
bafd4890 591
fe0d9caa 592 return ret;
bafd4890
ML
593}
594
3086efdd 595SR_PRIV int rigol_ds_receive(int fd, int revents, void *cb_data)
f4816ac6 596{
e0b7d23c 597 struct sr_dev_inst *sdi;
ae1bc1cc 598 struct sr_scpi_dev_inst *scpi;
f4816ac6 599 struct dev_context *devc;
e0b7d23c 600 struct sr_datafeed_packet packet;
246399f7
UH
601 struct sr_datafeed_analog analog;
602 struct sr_analog_encoding encoding;
603 struct sr_analog_meaning meaning;
604 struct sr_analog_spec spec;
6bb192bc 605 struct sr_datafeed_logic logic;
6b04525b 606 double vdiv, offset, origin;
f80a0bf2 607 int len, i, vref;
ba7dd8bb 608 struct sr_channel *ch;
bac11aeb 609 gsize expected_data_bytes;
f4816ac6 610
decfe89d 611 (void)fd;
9bd4c956 612
f4816ac6
ML
613 if (!(sdi = cb_data))
614 return TRUE;
615
616 if (!(devc = sdi->priv))
617 return TRUE;
618
ae1bc1cc 619 scpi = sdi->conn;
9bd4c956 620
dc89faea
UH
621 if (!(revents == G_IO_IN || revents == 0))
622 return TRUE;
623
624 switch (devc->wait_event) {
625 case WAIT_NONE:
626 break;
627 case WAIT_TRIGGER:
628 if (rigol_ds_trigger_wait(sdi) != SR_OK)
3918fbb0 629 return TRUE;
dc89faea 630 if (rigol_ds_channel_start(sdi) != SR_OK)
e086b750 631 return TRUE;
dc89faea
UH
632 return TRUE;
633 case WAIT_BLOCK:
634 if (rigol_ds_block_wait(sdi) != SR_OK)
635 return TRUE;
636 break;
637 case WAIT_STOP:
638 if (rigol_ds_stop_wait(sdi) != SR_OK)
639 return TRUE;
640 if (rigol_ds_check_stop(sdi) != SR_OK)
641 return TRUE;
642 if (rigol_ds_channel_start(sdi) != SR_OK)
643 return TRUE;
644 return TRUE;
645 default:
646 sr_err("BUG: Unknown event target encountered");
647 break;
648 }
f76c24f6 649
dc89faea 650 ch = devc->channel_entry->data;
702f42e8 651
dc89faea
UH
652 expected_data_bytes = ch->type == SR_CHANNEL_ANALOG ?
653 devc->analog_frame_size : devc->digital_frame_size;
bac11aeb 654
dc89faea
UH
655 if (devc->num_block_bytes == 0) {
656 if (devc->model->series->protocol >= PROTOCOL_V4) {
ef7fb1ab 657 if (rigol_ds_config_set(sdi, ":WAV:START %d",
dc89faea
UH
658 devc->num_channel_bytes + 1) != SR_OK)
659 return TRUE;
ef7fb1ab 660 if (rigol_ds_config_set(sdi, ":WAV:STOP %d",
dc89faea
UH
661 MIN(devc->num_channel_bytes + ACQ_BLOCK_SIZE,
662 devc->analog_frame_size)) != SR_OK)
05c644ea 663 return TRUE;
bafd4890 664 }
f80a0bf2 665
704910e3
VO
666 if (devc->model->series->protocol >= PROTOCOL_V3) {
667 if (rigol_ds_config_set(sdi, ":WAV:BEG") != SR_OK)
668 return TRUE;
dc89faea
UH
669 if (sr_scpi_send(sdi->conn, ":WAV:DATA?") != SR_OK)
670 return TRUE;
704910e3 671 }
f80a0bf2 672
dc89faea 673 if (sr_scpi_read_begin(scpi) != SR_OK)
7d63347e 674 return TRUE;
6bb192bc 675
dc89faea
UH
676 if (devc->format == FORMAT_IEEE488_2) {
677 sr_dbg("New block header expected");
678 len = rigol_ds_read_header(sdi);
679 if (len == 0)
680 /* Still reading the header. */
681 return TRUE;
682 if (len == -1) {
350501d0 683 sr_err("Error while reading block header, aborting capture.");
4c5f7006 684 std_session_send_df_frame_end(sdi);
d2f7c417 685 sr_dev_acquisition_stop(sdi);
3ed7a40c
ML
686 return TRUE;
687 }
dc89faea
UH
688 /* At slow timebases in live capture the DS2072
689 * sometimes returns "short" data blocks, with
690 * apparently no way to get the rest of the data.
691 * Discard these, the complete data block will
692 * appear eventually.
693 */
694 if (devc->data_source == DATA_SOURCE_LIVE
695 && (unsigned)len < expected_data_bytes) {
696 sr_dbg("Discarding short data block");
697 sr_scpi_read_data(scpi, (char *)devc->buffer, len + 1);
698 return TRUE;
699 }
700 devc->num_block_bytes = len;
48460c6f 701 } else {
dc89faea 702 devc->num_block_bytes = expected_data_bytes;
ee7e9bee 703 }
dc89faea
UH
704 devc->num_block_read = 0;
705 }
75d8a4e5 706
dc89faea
UH
707 len = devc->num_block_bytes - devc->num_block_read;
708 if (len > ACQ_BUFFER_SIZE)
709 len = ACQ_BUFFER_SIZE;
710 sr_dbg("Requesting read of %d bytes", len);
48460c6f 711
dc89faea 712 len = sr_scpi_read_data(scpi, (char *)devc->buffer, len);
48460c6f 713
dc89faea 714 if (len == -1) {
350501d0 715 sr_err("Error while reading block data, aborting capture.");
4c5f7006 716 std_session_send_df_frame_end(sdi);
d2f7c417 717 sr_dev_acquisition_stop(sdi);
dc89faea
UH
718 return TRUE;
719 }
720
721 sr_dbg("Received %d bytes.", len);
722
723 devc->num_block_read += len;
724
725 if (ch->type == SR_CHANNEL_ANALOG) {
726 vref = devc->vert_reference[ch->index];
6b04525b
VO
727 vdiv = devc->vert_inc[ch->index];
728 origin = devc->vert_origin[ch->index];
dc89faea
UH
729 offset = devc->vert_offset[ch->index];
730 if (devc->model->series->protocol >= PROTOCOL_V3)
731 for (i = 0; i < len; i++)
6b04525b 732 devc->data[i] = ((int)devc->buffer[i] - vref - origin) * vdiv;
dc89faea
UH
733 else
734 for (i = 0; i < len; i++)
735 devc->data[i] = (128 - devc->buffer[i]) * vdiv - offset;
b8f07f42
AJ
736 float vdivlog = log10f(vdiv);
737 int digits = -(int)vdivlog + (vdivlog < 0.0);
738 sr_analog_init(&analog, &encoding, &meaning, &spec, digits);
246399f7 739 analog.meaning->channels = g_slist_append(NULL, ch);
dc89faea
UH
740 analog.num_samples = len;
741 analog.data = devc->data;
246399f7
UH
742 analog.meaning->mq = SR_MQ_VOLTAGE;
743 analog.meaning->unit = SR_UNIT_VOLT;
744 analog.meaning->mqflags = 0;
745 packet.type = SR_DF_ANALOG;
dc89faea 746 packet.payload = &analog;
695dc859 747 sr_session_send(sdi, &packet);
246399f7 748 g_slist_free(analog.meaning->channels);
dc89faea
UH
749 } else {
750 logic.length = len;
751 // TODO: For the MSO1000Z series, we need a way to express that
752 // this data is in fact just for a single channel, with the valid
753 // data for that channel in the LSB of each byte.
f6129c8f 754 logic.unitsize = devc->model->series->protocol >= PROTOCOL_V4 ? 1 : 2;
dc89faea
UH
755 logic.data = devc->buffer;
756 packet.type = SR_DF_LOGIC;
757 packet.payload = &logic;
695dc859 758 sr_session_send(sdi, &packet);
dc89faea
UH
759 }
760
761 if (devc->num_block_read == devc->num_block_bytes) {
762 sr_dbg("Block has been completed");
763 if (devc->model->series->protocol >= PROTOCOL_V3) {
764 /* Discard the terminating linefeed */
765 sr_scpi_read_data(scpi, (char *)devc->buffer, 1);
766 }
767 if (devc->format == FORMAT_IEEE488_2) {
768 /* Prepare for possible next block */
769 devc->num_header_bytes = 0;
770 devc->num_block_bytes = 0;
babab622 771 if (devc->data_source != DATA_SOURCE_LIVE)
dc89faea 772 rigol_ds_set_wait_event(devc, WAIT_BLOCK);
babab622 773 }
ce97fc3f 774 if (!sr_scpi_read_complete(scpi) && !devc->channel_entry->next) {
dc89faea 775 sr_err("Read should have been completed");
dc89faea
UH
776 }
777 devc->num_block_read = 0;
778 } else {
6433156c
DE
779 sr_dbg("%" PRIu64 " of %" PRIu64 " block bytes read",
780 devc->num_block_read, devc->num_block_bytes);
dc89faea 781 }
f76c24f6 782
dc89faea 783 devc->num_channel_bytes += len;
f76c24f6 784
dc89faea
UH
785 if (devc->num_channel_bytes < expected_data_bytes)
786 /* Don't have the full data for this channel yet, re-run. */
787 return TRUE;
f76c24f6 788
dc89faea
UH
789 /* End of data for this channel. */
790 if (devc->model->series->protocol == PROTOCOL_V3) {
791 /* Signal end of data download to scope */
792 if (devc->data_source != DATA_SOURCE_LIVE)
793 /*
794 * This causes a query error, without it switching
795 * to the next channel causes an error. Fun with
796 * firmware...
797 */
798 rigol_ds_config_set(sdi, ":WAV:END");
799 }
800
801 if (devc->channel_entry->next) {
802 /* We got the frame for this channel, now get the next channel. */
803 devc->channel_entry = devc->channel_entry->next;
804 rigol_ds_channel_start(sdi);
805 } else {
806 /* Done with this frame. */
4c5f7006 807 std_session_send_df_frame_end(sdi);
dc89faea 808
19f31c8a
VO
809 devc->num_frames++;
810
811 /* V5 has no way to read the number of recorded frames, so try to set the
812 * next frame and read it back instead.
813 */
814 if (devc->data_source == DATA_SOURCE_SEGMENTED &&
815 devc->model->series->protocol == PROTOCOL_V5) {
816 int frames = 0;
817 if (rigol_ds_config_set(sdi, "REC:CURR %d", devc->num_frames + 1) != SR_OK)
818 return SR_ERR;
819 if (sr_scpi_get_int(sdi->conn, "REC:CURR?", &frames) != SR_OK)
820 return SR_ERR;
821 devc->num_frames_segmented = frames;
822 }
823
824 if (devc->num_frames == devc->limit_frames ||
8cbe5339
VO
825 devc->num_frames == devc->num_frames_segmented ||
826 devc->data_source == DATA_SOURCE_MEMORY) {
dc89faea 827 /* Last frame, stop capture. */
d2f7c417 828 sr_dev_acquisition_stop(sdi);
dc89faea
UH
829 } else {
830 /* Get the next frame, starting with the first channel. */
831 devc->channel_entry = devc->enabled_channels;
832
833 rigol_ds_capture_start(sdi);
834
835 /* Start of next frame. */
4c5f7006 836 std_session_send_df_frame_begin(sdi);
75d8a4e5 837 }
f4816ac6
ML
838 }
839
840 return TRUE;
841}
e0b7d23c 842
3086efdd 843SR_PRIV int rigol_ds_get_dev_cfg(const struct sr_dev_inst *sdi)
254dd102
BV
844{
845 struct dev_context *devc;
e264ebde 846 struct sr_channel *ch;
98bfc474 847 char *cmd;
821fbcad
ML
848 unsigned int i;
849 int res;
254dd102
BV
850
851 devc = sdi->priv;
852
6bb192bc 853 /* Analog channel state. */
821fbcad
ML
854 for (i = 0; i < devc->model->analog_channels; i++) {
855 cmd = g_strdup_printf(":CHAN%d:DISP?", i + 1);
98bfc474 856 res = sr_scpi_get_bool(sdi->conn, cmd, &devc->analog_channels[i]);
821fbcad
ML
857 g_free(cmd);
858 if (res != SR_OK)
859 return SR_ERR;
e264ebde
AJ
860 ch = g_slist_nth_data(sdi->channels, i);
861 ch->enabled = devc->analog_channels[i];
821fbcad
ML
862 }
863 sr_dbg("Current analog channel state:");
864 for (i = 0; i < devc->model->analog_channels; i++)
865 sr_dbg("CH%d %s", i + 1, devc->analog_channels[i] ? "on" : "off");
6bb192bc
ML
866
867 /* Digital channel state. */
bafd4890 868 if (devc->model->has_digital) {
702f42e8 869 if (sr_scpi_get_bool(sdi->conn,
01dd7a4c 870 devc->model->series->protocol >= PROTOCOL_V3 ?
702f42e8 871 ":LA:STAT?" : ":LA:DISP?",
98bfc474 872 &devc->la_enabled) != SR_OK)
04e8e01e 873 return SR_ERR;
04e8e01e
ML
874 sr_dbg("Logic analyzer %s, current digital channel state:",
875 devc->la_enabled ? "enabled" : "disabled");
effb9dd1 876 for (i = 0; i < ARRAY_SIZE(devc->digital_channels); i++) {
f6129c8f
SR
877 if (devc->model->series->protocol >= PROTOCOL_V5)
878 cmd = g_strdup_printf(":LA:DISP? D%d", i);
879 else if (devc->model->series->protocol >= PROTOCOL_V3)
880 cmd = g_strdup_printf(":LA:DIG%d:DISP?", i);
881 else
882 cmd = g_strdup_printf(":DIG%d:TURN?", i);
98bfc474 883 res = sr_scpi_get_bool(sdi->conn, cmd, &devc->digital_channels[i]);
6bb192bc
ML
884 g_free(cmd);
885 if (res != SR_OK)
886 return SR_ERR;
e264ebde
AJ
887 ch = g_slist_nth_data(sdi->channels, i + devc->model->analog_channels);
888 ch->enabled = devc->digital_channels[i];
bfaf112b 889 sr_dbg("D%d: %s", i, devc->digital_channels[i] ? "on" : "off");
6bb192bc
ML
890 }
891 }
254dd102
BV
892
893 /* Timebase. */
334fbc2a 894 if (sr_scpi_get_float(sdi->conn, ":TIM:SCAL?", &devc->timebase) != SR_OK)
254dd102 895 return SR_ERR;
bafd4890 896 sr_dbg("Current timebase %g", devc->timebase);
254dd102 897
934cf6cf
AJ
898 /* Probe attenuation. */
899 for (i = 0; i < devc->model->analog_channels; i++) {
900 cmd = g_strdup_printf(":CHAN%d:PROB?", i + 1);
901 res = sr_scpi_get_float(sdi->conn, cmd, &devc->attenuation[i]);
902 g_free(cmd);
903 if (res != SR_OK)
904 return SR_ERR;
905 }
906 sr_dbg("Current probe attenuation:");
907 for (i = 0; i < devc->model->analog_channels; i++)
908 sr_dbg("CH%d %g", i + 1, devc->attenuation[i]);
909
8719638f
AJ
910 /* Vertical gain and offset. */
911 if (rigol_ds_get_dev_cfg_vertical(sdi) != SR_OK)
912 return SR_ERR;
254dd102
BV
913
914 /* Coupling. */
821fbcad
ML
915 for (i = 0; i < devc->model->analog_channels; i++) {
916 cmd = g_strdup_printf(":CHAN%d:COUP?", i + 1);
334fbc2a 917 res = sr_scpi_get_string(sdi->conn, cmd, &devc->coupling[i]);
821fbcad
ML
918 g_free(cmd);
919 if (res != SR_OK)
920 return SR_ERR;
921 }
922 sr_dbg("Current coupling:");
923 for (i = 0; i < devc->model->analog_channels; i++)
924 sr_dbg("CH%d %s", i + 1, devc->coupling[i]);
254dd102
BV
925
926 /* Trigger source. */
334fbc2a 927 if (sr_scpi_get_string(sdi->conn, ":TRIG:EDGE:SOUR?", &devc->trigger_source) != SR_OK)
254dd102
BV
928 return SR_ERR;
929 sr_dbg("Current trigger source %s", devc->trigger_source);
930
931 /* Horizontal trigger position. */
0f523f2b
UH
932 if (sr_scpi_get_float(sdi->conn, devc->model->cmds[CMD_GET_HORIZ_TRIGGERPOS].str,
933 &devc->horiz_triggerpos) != SR_OK)
254dd102 934 return SR_ERR;
bafd4890 935 sr_dbg("Current horizontal trigger position %g", devc->horiz_triggerpos);
254dd102
BV
936
937 /* Trigger slope. */
334fbc2a 938 if (sr_scpi_get_string(sdi->conn, ":TRIG:EDGE:SLOP?", &devc->trigger_slope) != SR_OK)
254dd102
BV
939 return SR_ERR;
940 sr_dbg("Current trigger slope %s", devc->trigger_slope);
941
9ea62f2e
AJ
942 /* Trigger level. */
943 if (sr_scpi_get_float(sdi->conn, ":TRIG:EDGE:LEV?", &devc->trigger_level) != SR_OK)
944 return SR_ERR;
945 sr_dbg("Current trigger level %g", devc->trigger_level);
946
254dd102
BV
947 return SR_OK;
948}
8719638f
AJ
949
950SR_PRIV int rigol_ds_get_dev_cfg_vertical(const struct sr_dev_inst *sdi)
951{
952 struct dev_context *devc;
953 char *cmd;
954 unsigned int i;
955 int res;
956
957 devc = sdi->priv;
958
959 /* Vertical gain. */
960 for (i = 0; i < devc->model->analog_channels; i++) {
961 cmd = g_strdup_printf(":CHAN%d:SCAL?", i + 1);
962 res = sr_scpi_get_float(sdi->conn, cmd, &devc->vdiv[i]);
963 g_free(cmd);
964 if (res != SR_OK)
965 return SR_ERR;
966 }
967 sr_dbg("Current vertical gain:");
968 for (i = 0; i < devc->model->analog_channels; i++)
969 sr_dbg("CH%d %g", i + 1, devc->vdiv[i]);
970
971 /* Vertical offset. */
972 for (i = 0; i < devc->model->analog_channels; i++) {
973 cmd = g_strdup_printf(":CHAN%d:OFFS?", i + 1);
974 res = sr_scpi_get_float(sdi->conn, cmd, &devc->vert_offset[i]);
975 g_free(cmd);
976 if (res != SR_OK)
977 return SR_ERR;
978 }
979 sr_dbg("Current vertical offset:");
980 for (i = 0; i < devc->model->analog_channels; i++)
981 sr_dbg("CH%d %g", i + 1, devc->vert_offset[i]);
982
983 return SR_OK;
984}