2 * This file is part of the libsigrok project.
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>
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.
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.
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/>.
31 #include "libsigrok.h"
32 #include "libsigrok-internal.h"
36 * This is a unified protocol driver for the DS1000 and DS2000 series.
38 * DS1000 support tested with a Rigol DS1102D.
40 * DS2000 support tested with a Rigol DS2072 using firmware version 01.01.00.02.
42 * The Rigol DS2000 series scopes try to adhere to the IEEE 488.2 (I think)
43 * standard. If you want to read it - it costs real money...
45 * Every response from the scope has a linefeed appended because the
46 * standard says so. In principle this could be ignored because sending the
47 * next command clears the output queue of the scope. This driver tries to
48 * avoid doing that because it may cause an error being generated inside the
49 * scope and who knows what bugs the firmware has WRT this.
51 * Waveform data is transferred in a format called "arbitrary block program
52 * data" specified in IEEE 488.2. See Agilents programming manuals for their
53 * 2000/3000 series scopes for a nice description.
55 * Each data block from the scope has a header, e.g. "#900000001400".
56 * The '#' marks the start of a block.
57 * Next is one ASCII decimal digit between 1 and 9, this gives the number of
58 * ASCII decimal digits following.
59 * Last are the ASCII decimal digits giving the number of bytes (not
60 * samples!) in the block.
62 * After this header as many data bytes as indicated follow.
64 * Each data block has a trailing linefeed too.
67 static int get_cfg(const struct sr_dev_inst *sdi, char *cmd, char *reply, size_t maxlen);
68 static int get_cfg_int(const struct sr_dev_inst *sdi, char *cmd, int *i);
70 static int parse_int(const char *str, int *ret)
76 tmp = strtol(str, &e, 10);
77 if (e == str || *e != '\0') {
78 sr_dbg("Failed to parse integer: '%s'", str);
82 sr_dbg("Failed to parse integer: '%s', numerical overflow", str);
85 if (tmp > INT_MAX || tmp < INT_MIN) {
86 sr_dbg("Failed to parse integer: '%s', value to large/small", str);
94 /* Set the next event to wait for in rigol_ds_receive */
95 static void rigol_ds_set_wait_event(struct dev_context *devc, enum wait_events event)
97 if (event == WAIT_STOP)
98 devc->wait_status = 2;
100 devc->wait_status = 1;
101 devc->wait_event = event;
105 * Waiting for a event will return a timeout after 2 to 3 seconds in order
106 * to not block the application.
108 static int rigol_ds_event_wait(const struct sr_dev_inst *sdi, char status1, char status2)
111 struct dev_context *devc;
114 if (!(devc = sdi->priv))
120 * Trigger status may return:
121 * "TD" or "T'D" - triggered
122 * "AUTO" - autotriggered
124 * "WAIT" - waiting for trigger
128 if (devc->wait_status == 1) {
130 if (time(NULL) - start >= 3) {
131 sr_dbg("Timeout waiting for trigger");
132 return SR_ERR_TIMEOUT;
135 if (get_cfg(sdi, ":TRIG:STAT?", buf, sizeof(buf)) != SR_OK)
137 } while (buf[0] == status1 || buf[0] == status2);
139 devc->wait_status = 2;
141 if (devc->wait_status == 2) {
143 if (time(NULL) - start >= 3) {
144 sr_dbg("Timeout waiting for trigger");
145 return SR_ERR_TIMEOUT;
148 if (get_cfg(sdi, ":TRIG:STAT?", buf, sizeof(buf)) != SR_OK)
150 } while (buf[0] != status1 && buf[0] != status2);
152 rigol_ds_set_wait_event(devc, WAIT_NONE);
159 * For live capture we need to wait for a new trigger event to ensure that
160 * sample data is not returned twice.
162 * Unfortunately this will never really work because for sufficiently fast
163 * timebases and trigger rates it just can't catch the status changes.
165 * What would be needed is a trigger event register with autoreset like the
166 * Agilents have. The Rigols don't seem to have anything like this.
168 * The workaround is to only wait for the trigger when the timebase is slow
169 * enough. Of course this means that for faster timebases sample data can be
170 * returned multiple times, this effect is mitigated somewhat by sleeping
171 * for about one sweep time in that case.
173 static int rigol_ds_trigger_wait(const struct sr_dev_inst *sdi)
175 struct dev_context *devc;
178 if (!(devc = sdi->priv))
182 * If timebase < 50 msecs/DIV just sleep about one sweep time except
183 * for really fast sweeps.
185 if (devc->timebase < 0.0499)
187 if (devc->timebase > 0.99e-6) {
189 * Timebase * num hor. divs * 85(%) * 1e6(usecs) / 100
190 * -> 85 percent of sweep time
192 s = (devc->timebase * devc->model->num_horizontal_divs
194 sr_spew("Sleeping for %ld usecs instead of trigger-wait", s);
197 rigol_ds_set_wait_event(devc, WAIT_NONE);
200 return rigol_ds_event_wait(sdi, 'T', 'A');
204 /* Wait for scope to got to "Stop" in single shot mode */
205 static int rigol_ds_stop_wait(const struct sr_dev_inst *sdi)
207 return rigol_ds_event_wait(sdi, 'S', 'S');
210 /* Check that a single shot acquisition actually succeeded on the DS2000 */
211 static int rigol_ds_check_stop(const struct sr_dev_inst *sdi)
213 struct dev_context *devc;
214 struct sr_probe *probe;
217 if (!(devc = sdi->priv))
220 probe = devc->channel_entry->data;
222 if (sr_scpi_send(sdi->conn, ":WAV:SOUR CHAN%d",
223 probe->index + 1) != SR_OK)
225 /* Check that the number of samples will be accepted */
226 if (sr_scpi_send(sdi->conn, ":WAV:POIN %d;*OPC", devc->analog_frame_size) != SR_OK)
228 if (get_cfg_int(sdi, "*ESR?", &tmp) != SR_OK)
231 * If we get an "Execution error" the scope went from "Single" to
232 * "Stop" without actually triggering. There is no waveform
233 * displayed and trying to download one will fail - the scope thinks
234 * it has 1400 samples (like display memory) and the driver thinks
235 * it has a different number of samples.
237 * In that case just try to capture something again. Might still
238 * fail in interesting ways.
240 * Ain't firmware fun?
243 sr_warn("Single shot acquisition failed, retrying...");
244 /* Sleep a bit, otherwise the single shot will often fail */
246 sr_scpi_send(sdi->conn, ":SING");
247 rigol_ds_set_wait_event(devc, WAIT_STOP);
254 /* Wait for enough data becoming available in scope output buffer */
255 static int rigol_ds_block_wait(const struct sr_dev_inst *sdi)
258 struct dev_context *devc;
262 if (!(devc = sdi->priv))
268 if (time(NULL) - start >= 3) {
269 sr_dbg("Timeout waiting for data block");
270 return SR_ERR_TIMEOUT;
274 * The scope copies data really slowly from sample
275 * memory to its output buffer, so try not to bother
276 * it too much with SCPI requests but don't wait too
277 * long for short sample frame sizes.
279 g_usleep(devc->analog_frame_size < 15000 ? 100000 : 1000000);
281 /* "READ,nnnn" (still working) or "IDLE,nnnn" (finished) */
282 if (get_cfg(sdi, ":WAV:STAT?", buf, sizeof(buf)) != SR_OK)
285 if (parse_int(buf + 5, &len) != SR_OK)
287 } while (buf[0] == 'R' && len < 1000000);
289 rigol_ds_set_wait_event(devc, WAIT_NONE);
294 /* Start capturing a new frameset */
295 SR_PRIV int rigol_ds_capture_start(const struct sr_dev_inst *sdi)
297 struct dev_context *devc;
299 if (!(devc = sdi->priv))
302 sr_dbg("Starting data capture for frameset %lu of %lu",
303 devc->num_frames + 1, devc->limit_frames);
305 if (sr_scpi_send(sdi->conn, ":WAV:FORM BYTE") != SR_OK)
307 if (devc->data_source == DATA_SOURCE_LIVE) {
308 if (sr_scpi_send(sdi->conn, ":WAV:MODE NORM") != SR_OK)
310 rigol_ds_set_wait_event(devc, WAIT_TRIGGER);
312 if (sr_scpi_send(sdi->conn, ":WAV:MODE RAW") != SR_OK)
314 if (sr_scpi_send(sdi->conn, ":SING", devc->analog_frame_size) != SR_OK)
316 rigol_ds_set_wait_event(devc, WAIT_STOP);
322 /* Start reading data from the current channel */
323 SR_PRIV int rigol_ds_channel_start(const struct sr_dev_inst *sdi)
325 struct dev_context *devc;
326 struct sr_probe *probe;
328 if (!(devc = sdi->priv))
331 probe = devc->channel_entry->data;
333 sr_dbg("Starting reading data from channel %d", probe->index + 1);
335 if (devc->model->protocol == PROTOCOL_LEGACY) {
336 if (probe->type == SR_PROBE_LOGIC) {
337 if (sr_scpi_send(sdi->conn, ":WAV:DATA? DIG") != SR_OK)
340 if (sr_scpi_send(sdi->conn, ":WAV:DATA? CHAN%d",
341 probe->index + 1) != SR_OK)
345 if (sr_scpi_send(sdi->conn, ":WAV:SOUR CHAN%d",
346 probe->index + 1) != SR_OK)
348 if (devc->data_source != DATA_SOURCE_LIVE) {
349 if (sr_scpi_send(sdi->conn, ":WAV:RES") != SR_OK)
351 if (sr_scpi_send(sdi->conn, ":WAV:BEG") != SR_OK)
353 rigol_ds_set_wait_event(devc, WAIT_BLOCK);
355 rigol_ds_set_wait_event(devc, WAIT_NONE);
358 devc->num_frame_samples = 0;
359 devc->num_block_bytes = 0;
364 /* Read the header of a data block */
365 static int rigol_ds_read_header(struct sr_scpi_dev_inst *scpi)
367 char start[3], length[10];
370 /* Read the hashsign and length digit. */
371 tmp = sr_scpi_read_data(scpi, start, 2);
375 sr_err("Failed to read first two bytes of data block header.");
378 if (start[0] != '#' || !isdigit(start[1]) || start[1] == '0')
380 sr_err("Received invalid data block header start '%s'.", start);
383 len = atoi(start + 1);
385 /* Read the data length. */
386 tmp = sr_scpi_read_data(scpi, length, len);
390 sr_err("Failed to read %d bytes of data block length.", len);
393 if (parse_int(length, &len) != SR_OK)
395 sr_err("Received invalid data block length '%s'.", length);
399 sr_dbg("Received data block header: %s%s -> block length %d", start, length, len);
404 SR_PRIV int rigol_ds_receive(int fd, int revents, void *cb_data)
406 struct sr_dev_inst *sdi;
407 struct sr_scpi_dev_inst *scpi;
408 struct dev_context *devc;
409 struct sr_datafeed_packet packet;
410 struct sr_datafeed_analog analog;
411 struct sr_datafeed_logic logic;
414 struct sr_probe *probe;
418 if (!(sdi = cb_data))
421 if (!(devc = sdi->priv))
426 if (revents == G_IO_IN || revents == 0) {
427 if (devc->model->protocol == PROTOCOL_IEEE488_2) {
428 switch(devc->wait_event) {
433 if (rigol_ds_trigger_wait(sdi) != SR_OK)
435 if (rigol_ds_channel_start(sdi) != SR_OK)
440 if (rigol_ds_block_wait(sdi) != SR_OK)
445 if (rigol_ds_stop_wait(sdi) != SR_OK)
447 if (rigol_ds_check_stop(sdi) != SR_OK)
449 if (rigol_ds_channel_start(sdi) != SR_OK)
454 sr_err("BUG: Unknown event target encountered");
458 probe = devc->channel_entry->data;
460 if (devc->num_block_bytes == 0 &&
461 devc->model->protocol == PROTOCOL_IEEE488_2) {
462 if (sr_scpi_send(sdi->conn, ":WAV:DATA?") != SR_OK)
466 if (devc->num_block_bytes == 0) {
467 if (sr_scpi_read_begin(scpi) != SR_OK)
469 if (devc->model->protocol == PROTOCOL_IEEE488_2) {
470 sr_dbg("New block header expected");
471 len = rigol_ds_read_header(scpi);
474 /* At slow timebases in live capture the DS2072
475 * sometimes returns "short" data blocks, with
476 * apparently no way to get the rest of the data.
477 * Discard these, the complete data block will
480 if (devc->data_source == DATA_SOURCE_LIVE
481 && (unsigned)len < devc->num_frame_samples) {
482 sr_dbg("Discarding short data block");
483 sr_scpi_read_data(scpi, (char *)devc->buffer, len + 1);
486 devc->num_block_bytes = len;
488 devc->num_block_bytes = probe->type == SR_PROBE_ANALOG ?
489 (devc->model->series == RIGOL_VS5000 ?
490 VS5000_ANALOG_LIVE_WAVEFORM_SIZE :
491 DS1000_ANALOG_LIVE_WAVEFORM_SIZE) :
492 DIGITAL_WAVEFORM_SIZE;
494 devc->num_block_read = 0;
497 len = devc->num_block_bytes - devc->num_block_read;
498 len = sr_scpi_read_data(scpi, (char *)devc->buffer,
499 len < ACQ_BUFFER_SIZE ? len : ACQ_BUFFER_SIZE);
501 sr_dbg("Received %d bytes.", len);
505 devc->num_block_read += len;
507 if (devc->num_frame_samples == 0) {
508 /* Start of a new frame. */
509 packet.type = SR_DF_FRAME_BEGIN;
510 sr_session_send(sdi, &packet);
513 if (probe->type == SR_PROBE_ANALOG) {
514 vref = devc->vert_reference[probe->index];
515 vdiv = devc->vdiv[probe->index] / 25.6;
516 offset = devc->vert_offset[probe->index];
517 if (devc->model->protocol == PROTOCOL_IEEE488_2)
518 for (i = 0; i < len; i++)
519 devc->data[i] = ((int)devc->buffer[i] - vref) * vdiv - offset;
521 for (i = 0; i < len; i++)
522 devc->data[i] = (128 - devc->buffer[i]) * vdiv - offset;
523 analog.probes = g_slist_append(NULL, probe);
524 analog.num_samples = len;
525 analog.data = devc->data;
526 analog.mq = SR_MQ_VOLTAGE;
527 analog.unit = SR_UNIT_VOLT;
529 packet.type = SR_DF_ANALOG;
530 packet.payload = &analog;
531 sr_session_send(cb_data, &packet);
532 g_slist_free(analog.probes);
534 logic.length = len - 10;
536 logic.data = devc->buffer + 10;
537 packet.type = SR_DF_LOGIC;
538 packet.payload = &logic;
539 sr_session_send(cb_data, &packet);
542 if (devc->num_block_read == devc->num_block_bytes) {
543 sr_dbg("Block has been completed");
544 if (devc->model->protocol == PROTOCOL_IEEE488_2) {
545 /* Discard the terminating linefeed and prepare for
546 possible next block */
547 sr_scpi_read_data(scpi, (char *)devc->buffer, 1);
548 devc->num_block_bytes = 0;
549 if (devc->data_source != DATA_SOURCE_LIVE)
550 rigol_ds_set_wait_event(devc, WAIT_BLOCK);
552 devc->num_block_read = 0;
554 sr_dbg("%d of %d block bytes read", devc->num_block_read, devc->num_block_bytes);
557 devc->num_frame_samples += len;
559 if (devc->num_frame_samples < (probe->type == SR_PROBE_ANALOG ?
560 devc->analog_frame_size : DIGITAL_WAVEFORM_SIZE))
561 /* Don't have the whole frame yet. */
564 /* End of the frame. */
565 sr_dbg("Frame completed, %d samples", devc->num_frame_samples);
566 packet.type = SR_DF_FRAME_END;
567 sr_session_send(sdi, &packet);
568 if (devc->model->protocol == PROTOCOL_IEEE488_2) {
569 /* Signal end of data download to scope */
570 if (devc->data_source != DATA_SOURCE_LIVE)
572 * This causes a query error, without it switching
573 * to the next channel causes an error. Fun with
576 sr_scpi_send(sdi->conn, ":WAV:END");
579 if (probe->type == SR_PROBE_ANALOG
580 && devc->channel_entry->next != NULL) {
581 /* We got the frame for this analog channel, but
582 * there's another analog channel. */
583 devc->channel_entry = devc->channel_entry->next;
584 rigol_ds_channel_start(sdi);
586 /* Done with all analog channels in this frame. */
587 if (devc->enabled_digital_probes
588 && devc->channel_entry != devc->enabled_digital_probes) {
589 /* Now we need to get the digital data. */
590 devc->channel_entry = devc->enabled_digital_probes;
591 rigol_ds_channel_start(sdi);
592 } else if (++devc->num_frames == devc->limit_frames) {
593 /* End of last frame. */
594 packet.type = SR_DF_END;
595 sr_session_send(sdi, &packet);
596 sdi->driver->dev_acquisition_stop(sdi, cb_data);
598 /* Get the next frame, starting with the first analog channel. */
599 if (devc->enabled_analog_probes)
600 devc->channel_entry = devc->enabled_analog_probes;
602 devc->channel_entry = devc->enabled_digital_probes;
604 if (devc->model->protocol == PROTOCOL_LEGACY)
605 rigol_ds_channel_start(sdi);
607 rigol_ds_capture_start(sdi);
615 static int get_cfg(const struct sr_dev_inst *sdi, char *cmd, char *reply, size_t maxlen)
618 struct dev_context *devc = sdi->priv;
619 struct sr_scpi_dev_inst *scpi = sdi->conn;
622 if (sr_scpi_get_string(scpi, cmd, &response) != SR_OK)
625 g_strlcpy(reply, response, maxlen);
629 if (devc->model->protocol == PROTOCOL_IEEE488_2) {
630 /* get rid of trailing linefeed */
631 if (len >= 1 && reply[len-1] == '\n')
635 sr_spew("Received '%s'.", reply);
640 static int get_cfg_int(const struct sr_dev_inst *sdi, char *cmd, int *i)
644 if (get_cfg(sdi, cmd, buf, sizeof(buf)) != SR_OK)
647 if (parse_int(buf, i) != SR_OK)
653 static int get_cfg_float(const struct sr_dev_inst *sdi, char *cmd, float *f)
657 if (get_cfg(sdi, cmd, buf, sizeof(buf)) != SR_OK)
659 *f = strtof(buf, &e);
660 if (e == buf || (fpclassify(*f) & (FP_ZERO | FP_NORMAL)) == 0) {
661 sr_dbg("failed to parse response to '%s': '%s'", cmd, buf);
668 static int get_cfg_string(const struct sr_dev_inst *sdi, char *cmd, char **buf)
670 if (!(*buf = g_try_malloc0(256)))
671 return SR_ERR_MALLOC;
673 if (get_cfg(sdi, cmd, *buf, 256) != SR_OK)
679 SR_PRIV int rigol_ds_get_dev_cfg(const struct sr_dev_inst *sdi)
681 struct dev_context *devc;
688 /* Analog channel state. */
689 for (i = 0; i < devc->model->analog_channels; i++) {
690 cmd = g_strdup_printf(":CHAN%d:DISP?", i + 1);
691 res = get_cfg_string(sdi, cmd, &t_s);
695 devc->analog_channels[i] = !strcmp(t_s, "ON") || !strcmp(t_s, "1");
697 sr_dbg("Current analog channel state:");
698 for (i = 0; i < devc->model->analog_channels; i++)
699 sr_dbg("CH%d %s", i + 1, devc->analog_channels[i] ? "on" : "off");
701 /* Digital channel state. */
702 if (devc->model->has_digital) {
703 sr_dbg("Current digital channel state:");
704 for (i = 0; i < 16; i++) {
705 cmd = g_strdup_printf(":DIG%d:TURN?", i);
706 res = get_cfg_string(sdi, cmd, &t_s);
710 devc->digital_channels[i] = !strcmp(t_s, "ON") ? TRUE : FALSE;
712 sr_dbg("D%d: %s", i, devc->digital_channels[i] ? "on" : "off");
717 if (get_cfg_float(sdi, ":TIM:SCAL?", &devc->timebase) != SR_OK)
719 sr_dbg("Current timebase %g", devc->timebase);
722 for (i = 0; i < devc->model->analog_channels; i++) {
723 cmd = g_strdup_printf(":CHAN%d:SCAL?", i + 1);
724 res = get_cfg_float(sdi, cmd, &devc->vdiv[i]);
729 sr_dbg("Current vertical gain:");
730 for (i = 0; i < devc->model->analog_channels; i++)
731 sr_dbg("CH%d %g", i + 1, devc->vdiv[i]);
733 sr_dbg("Current vertical reference:");
734 if (devc->model->protocol == PROTOCOL_IEEE488_2) {
735 /* Vertical reference - not certain if this is the place to read it. */
736 for (i = 0; i < devc->model->analog_channels; i++) {
737 if (sr_scpi_send(sdi->conn, ":WAV:SOUR CHAN%d", i + 1) != SR_OK)
739 if (get_cfg_int(sdi, ":WAV:YREF?", &devc->vert_reference[i]) != SR_OK)
741 sr_dbg("CH%d %d", i + 1, devc->vert_reference[i]);
745 /* Vertical offset. */
746 for (i = 0; i < devc->model->analog_channels; i++) {
747 cmd = g_strdup_printf(":CHAN%d:OFFS?", i + 1);
748 res = get_cfg_float(sdi, cmd, &devc->vert_offset[i]);
753 sr_dbg("Current vertical offset:");
754 for (i = 0; i < devc->model->analog_channels; i++)
755 sr_dbg("CH%d %g", i + 1, devc->vert_offset[i]);
758 for (i = 0; i < devc->model->analog_channels; i++) {
759 cmd = g_strdup_printf(":CHAN%d:COUP?", i + 1);
760 res = get_cfg_string(sdi, cmd, &devc->coupling[i]);
765 sr_dbg("Current coupling:");
766 for (i = 0; i < devc->model->analog_channels; i++)
767 sr_dbg("CH%d %s", i + 1, devc->coupling[i]);
769 /* Trigger source. */
770 if (get_cfg_string(sdi, ":TRIG:EDGE:SOUR?", &devc->trigger_source) != SR_OK)
772 sr_dbg("Current trigger source %s", devc->trigger_source);
774 /* Horizontal trigger position. */
775 if (get_cfg_float(sdi, ":TIM:OFFS?", &devc->horiz_triggerpos) != SR_OK)
777 sr_dbg("Current horizontal trigger position %g", devc->horiz_triggerpos);
780 if (get_cfg_string(sdi, ":TRIG:EDGE:SLOP?", &devc->trigger_slope) != SR_OK)
782 sr_dbg("Current trigger slope %s", devc->trigger_slope);