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