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;
216 if (!(devc = sdi->priv))
219 if (sr_scpi_send(sdi->conn, ":WAV:SOUR CHAN%d",
220 devc->channel_frame->index + 1) != SR_OK)
222 /* Check that the number of samples will be accepted */
223 if (sr_scpi_send(sdi->conn, ":WAV:POIN %d;*OPC", devc->analog_frame_size) != SR_OK)
225 if (get_cfg_int(sdi, "*ESR?", &tmp) != SR_OK)
228 * If we get an "Execution error" the scope went from "Single" to
229 * "Stop" without actually triggering. There is no waveform
230 * displayed and trying to download one will fail - the scope thinks
231 * it has 1400 samples (like display memory) and the driver thinks
232 * it has a different number of samples.
234 * In that case just try to capture something again. Might still
235 * fail in interesting ways.
237 * Ain't firmware fun?
240 sr_warn("Single shot acquisition failed, retrying...");
241 /* Sleep a bit, otherwise the single shot will often fail */
243 sr_scpi_send(sdi->conn, ":SING");
244 rigol_ds_set_wait_event(devc, WAIT_STOP);
251 /* Wait for enough data becoming available in scope output buffer */
252 static int rigol_ds_block_wait(const struct sr_dev_inst *sdi)
255 struct dev_context *devc;
259 if (!(devc = sdi->priv))
265 if (time(NULL) - start >= 3) {
266 sr_dbg("Timeout waiting for data block");
267 return SR_ERR_TIMEOUT;
271 * The scope copies data really slowly from sample
272 * memory to its output buffer, so try not to bother
273 * it too much with SCPI requests but don't wait too
274 * long for short sample frame sizes.
276 g_usleep(devc->analog_frame_size < 15000 ? 100000 : 1000000);
278 /* "READ,nnnn" (still working) or "IDLE,nnnn" (finished) */
279 if (get_cfg(sdi, ":WAV:STAT?", buf, sizeof(buf)) != SR_OK)
282 if (parse_int(buf + 5, &len) != SR_OK)
284 } while (buf[0] == 'R' && len < 1000000);
286 rigol_ds_set_wait_event(devc, WAIT_NONE);
291 /* Start capturing a new frameset */
292 SR_PRIV int rigol_ds_capture_start(const struct sr_dev_inst *sdi)
294 struct dev_context *devc;
296 if (!(devc = sdi->priv))
299 sr_dbg("Starting data capture for frameset %lu of %lu",
300 devc->num_frames + 1, devc->limit_frames);
302 if (sr_scpi_send(sdi->conn, ":WAV:FORM BYTE") != SR_OK)
304 if (devc->data_source == DATA_SOURCE_LIVE) {
305 if (sr_scpi_send(sdi->conn, ":WAV:MODE NORM") != SR_OK)
307 rigol_ds_set_wait_event(devc, WAIT_TRIGGER);
309 if (sr_scpi_send(sdi->conn, ":WAV:MODE RAW") != SR_OK)
311 if (sr_scpi_send(sdi->conn, ":SING", devc->analog_frame_size) != SR_OK)
313 rigol_ds_set_wait_event(devc, WAIT_STOP);
319 /* Start reading data from the current channel */
320 SR_PRIV int rigol_ds_channel_start(const struct sr_dev_inst *sdi)
322 struct dev_context *devc;
324 if (!(devc = sdi->priv))
327 sr_dbg("Starting reading data from channel %d",
328 devc->channel_frame->index + 1);
330 if (sr_scpi_send(sdi->conn, ":WAV:SOUR CHAN%d",
331 devc->channel_frame->index + 1) != SR_OK)
333 if (devc->data_source != DATA_SOURCE_LIVE) {
334 if (sr_scpi_send(sdi->conn, ":WAV:RES") != SR_OK)
336 if (sr_scpi_send(sdi->conn, ":WAV:BEG") != SR_OK)
338 rigol_ds_set_wait_event(devc, WAIT_BLOCK);
340 rigol_ds_set_wait_event(devc, WAIT_NONE);
342 devc->num_frame_bytes = 0;
343 devc->num_block_bytes = 0;
348 /* Read the header of a data block */
349 static int rigol_ds_read_header(struct sr_scpi_dev_inst *scpi)
351 char start[3], length[10];
354 /* Read the hashsign and length digit. */
355 tmp = sr_scpi_read(scpi, start, 2);
359 sr_err("Failed to read first two bytes of data block header.");
362 if (start[0] != '#' || !isdigit(start[1]) || start[1] == '0')
364 sr_err("Received invalid data block header start '%s'.", start);
367 len = atoi(start + 1);
369 /* Read the data length. */
370 tmp = sr_scpi_read(scpi, length, len);
374 sr_err("Failed to read %d bytes of data block length.", len);
377 if (parse_int(length, &len) != SR_OK)
379 sr_err("Received invalid data block length '%s'.", length);
383 sr_dbg("Received data block header: %s%s -> block length %d", start, length, len);
388 SR_PRIV int rigol_ds_receive(int fd, int revents, void *cb_data)
390 struct sr_dev_inst *sdi;
391 struct sr_scpi_dev_inst *scpi;
392 struct dev_context *devc;
393 struct sr_datafeed_packet packet;
394 struct sr_datafeed_analog analog;
395 struct sr_datafeed_logic logic;
397 int len, i, waveform_size, vref;
398 struct sr_probe *probe;
402 if (!(sdi = cb_data))
405 if (!(devc = sdi->priv))
410 if (revents == G_IO_IN) {
411 if (devc->model->protocol == PROTOCOL_IEEE488_2) {
412 switch(devc->wait_event) {
417 if (rigol_ds_trigger_wait(sdi) != SR_OK)
419 if (rigol_ds_channel_start(sdi) != SR_OK)
424 if (rigol_ds_block_wait(sdi) != SR_OK)
429 if (rigol_ds_stop_wait(sdi) != SR_OK)
431 if (rigol_ds_check_stop(sdi) != SR_OK)
433 if (rigol_ds_channel_start(sdi) != SR_OK)
438 sr_err("BUG: Unknown event target encountered");
441 if (devc->num_block_bytes == 0) {
442 sr_dbg("New block header expected");
443 if (sr_scpi_send(sdi->conn, ":WAV:DATA?") != SR_OK)
445 len = rigol_ds_read_header(scpi);
448 /* At slow timebases in live capture the DS2072
449 * sometimes returns "short" data blocks, with
450 * apparently no way to get the rest of the data.
451 * Discard these, the complete data block will
454 if (devc->data_source == DATA_SOURCE_LIVE
455 && (unsigned)len < devc->num_frame_bytes) {
456 sr_dbg("Discarding short data block");
457 sr_scpi_read(scpi, (char *)devc->buffer, len + 1);
460 devc->num_block_bytes = len;
461 devc->num_block_read = 0;
465 probe = devc->channel_frame;
466 if (devc->model->protocol == PROTOCOL_IEEE488_2) {
467 len = devc->num_block_bytes - devc->num_block_read;
468 len = sr_scpi_read(scpi, (char *)devc->buffer,
469 len < ACQ_BUFFER_SIZE ? len : ACQ_BUFFER_SIZE);
471 waveform_size = probe->type == SR_PROBE_ANALOG ?
472 DS1000_ANALOG_LIVE_WAVEFORM_SIZE : DIGITAL_WAVEFORM_SIZE;
473 len = sr_scpi_read(scpi, (char *)devc->buffer,
474 waveform_size - devc->num_frame_bytes);
476 sr_dbg("Received %d bytes.", len);
480 if (devc->num_frame_bytes == 0) {
481 /* Start of a new frame. */
482 packet.type = SR_DF_FRAME_BEGIN;
483 sr_session_send(sdi, &packet);
486 if (probe->type == SR_PROBE_ANALOG) {
487 if (devc->model->protocol == PROTOCOL_IEEE488_2)
488 devc->num_block_read += len;
489 vref = devc->vert_reference[probe->index];
490 vdiv = devc->vdiv[probe->index] / 25.6;
491 offset = devc->vert_offset[probe->index];
492 if (devc->model->protocol == PROTOCOL_IEEE488_2)
493 for (i = 0; i < len; i++)
494 devc->data[i] = ((int)devc->buffer[i] - vref) * vdiv - offset;
496 for (i = 0; i < len; i++)
497 devc->data[i] = (128 - devc->buffer[i]) * vdiv - offset;
498 analog.probes = g_slist_append(NULL, probe);
499 analog.num_samples = len;
500 analog.data = devc->data;
501 analog.mq = SR_MQ_VOLTAGE;
502 analog.unit = SR_UNIT_VOLT;
504 packet.type = SR_DF_ANALOG;
505 packet.payload = &analog;
506 sr_session_send(cb_data, &packet);
507 g_slist_free(analog.probes);
509 if (devc->model->protocol == PROTOCOL_IEEE488_2) {
510 if (devc->num_block_read == devc->num_block_bytes) {
511 sr_dbg("Block has been completed");
512 /* Discard the terminating linefeed and prepare for
513 possible next block */
514 sr_scpi_read(scpi, (char *)devc->buffer, 1);
515 devc->num_block_bytes = 0;
516 if (devc->data_source != DATA_SOURCE_LIVE)
517 rigol_ds_set_wait_event(devc, WAIT_BLOCK);
519 sr_dbg("%d of %d block bytes read", devc->num_block_read, devc->num_block_bytes);
522 devc->num_frame_bytes += len;
524 if (devc->num_frame_bytes < devc->analog_frame_size)
525 /* Don't have the whole frame yet. */
528 sr_dbg("Frame completed, %d samples", devc->num_frame_bytes);
530 logic.length = len - 10;
532 logic.data = devc->buffer + 10;
533 packet.type = SR_DF_LOGIC;
534 packet.payload = &logic;
535 sr_session_send(cb_data, &packet);
537 if (len != DIGITAL_WAVEFORM_SIZE)
538 /* Don't have the whole frame yet. */
542 /* End of the frame. */
543 packet.type = SR_DF_FRAME_END;
544 sr_session_send(sdi, &packet);
545 if (devc->model->protocol == PROTOCOL_LEGACY)
546 devc->num_frame_bytes = 0;
548 /* Signal end of data download to scope */
549 if (devc->data_source != DATA_SOURCE_LIVE)
551 * This causes a query error, without it switching
552 * to the next channel causes an error. Fun with
555 sr_scpi_send(sdi->conn, ":WAV:END");
558 if (devc->enabled_analog_probes
559 && devc->channel_frame == devc->enabled_analog_probes->data
560 && devc->enabled_analog_probes->next != NULL) {
561 /* We got the frame for the first analog channel, but
562 * there's a second analog channel. */
563 devc->channel_frame = devc->enabled_analog_probes->next->data;
564 if (devc->model->protocol == PROTOCOL_IEEE488_2) {
565 rigol_ds_channel_start(sdi);
567 sr_scpi_send(sdi->conn, ":WAV:DATA? CHAN%c",
568 devc->channel_frame->name[2]);
571 /* Done with both analog channels in this frame. */
572 if (devc->enabled_digital_probes
573 && devc->channel_frame != devc->enabled_digital_probes->data) {
574 /* Now we need to get the digital data. */
575 devc->channel_frame = devc->enabled_digital_probes->data;
576 sr_scpi_send(sdi->conn, ":WAV:DATA? DIG");
577 } else if (++devc->num_frames == devc->limit_frames) {
578 /* End of last frame. */
579 packet.type = SR_DF_END;
580 sr_session_send(sdi, &packet);
581 sdi->driver->dev_acquisition_stop(sdi, cb_data);
583 /* Get the next frame, starting with the first analog channel. */
584 if (devc->model->protocol == PROTOCOL_IEEE488_2) {
585 if (devc->enabled_analog_probes) {
586 devc->channel_frame = devc->enabled_analog_probes->data;
587 rigol_ds_capture_start(sdi);
590 if (devc->enabled_analog_probes) {
591 devc->channel_frame = devc->enabled_analog_probes->data;
592 sr_scpi_send(sdi->conn, ":WAV:DATA? CHAN%c",
593 devc->channel_frame->name[2]);
595 devc->channel_frame = devc->enabled_digital_probes->data;
596 sr_scpi_send(sdi->conn, ":WAV:DATA? DIG");
606 static int get_cfg(const struct sr_dev_inst *sdi, char *cmd, char *reply, size_t maxlen)
609 struct dev_context *devc = sdi->priv;
610 struct sr_scpi_dev_inst *scpi = sdi->conn;
613 if (sr_scpi_send(scpi, cmd) != SR_OK)
616 if (sr_scpi_receive(scpi, &response) != SR_OK)
619 g_strlcpy(reply, response, maxlen);
623 if (devc->model->protocol == PROTOCOL_IEEE488_2) {
624 /* get rid of trailing linefeed */
625 if (len >= 1 && reply[len-1] == '\n')
629 sr_spew("Received '%s'.", reply);
634 static int get_cfg_int(const struct sr_dev_inst *sdi, char *cmd, int *i)
638 if (get_cfg(sdi, cmd, buf, sizeof(buf)) != SR_OK)
641 if (parse_int(buf, i) != SR_OK)
647 static int get_cfg_float(const struct sr_dev_inst *sdi, char *cmd, float *f)
651 if (get_cfg(sdi, cmd, buf, sizeof(buf)) != SR_OK)
653 *f = strtof(buf, &e);
654 if (e == buf || (fpclassify(*f) & (FP_ZERO | FP_NORMAL)) == 0) {
655 sr_dbg("failed to parse response to '%s': '%s'", cmd, buf);
662 static int get_cfg_string(const struct sr_dev_inst *sdi, char *cmd, char **buf)
664 if (!(*buf = g_try_malloc0(256)))
665 return SR_ERR_MALLOC;
667 if (get_cfg(sdi, cmd, *buf, 256) != SR_OK)
673 SR_PRIV int rigol_ds_get_dev_cfg(const struct sr_dev_inst *sdi)
675 struct dev_context *devc;
681 /* Analog channel state. */
682 if (get_cfg_string(sdi, ":CHAN1:DISP?", &t_s) != SR_OK)
684 devc->analog_channels[0] = !strcmp(t_s, "ON") || !strcmp(t_s, "1");
686 if (get_cfg_string(sdi, ":CHAN2:DISP?", &t_s) != SR_OK)
688 devc->analog_channels[1] = !strcmp(t_s, "ON") || !strcmp(t_s, "1");
690 sr_dbg("Current analog channel state CH1 %s CH2 %s",
691 devc->analog_channels[0] ? "on" : "off",
692 devc->analog_channels[1] ? "on" : "off");
694 /* Digital channel state. */
695 if (devc->model->has_digital) {
696 sr_dbg("Current digital channel state:");
697 for (i = 0; i < 16; i++) {
698 cmd = g_strdup_printf(":DIG%d:TURN?", i);
699 res = get_cfg_string(sdi, cmd, &t_s);
703 devc->digital_channels[i] = !strcmp(t_s, "ON") ? TRUE : FALSE;
705 sr_dbg("D%d: %s", i, devc->digital_channels[i] ? "on" : "off");
710 if (get_cfg_float(sdi, ":TIM:SCAL?", &devc->timebase) != SR_OK)
712 sr_dbg("Current timebase %g", devc->timebase);
715 if (get_cfg_float(sdi, ":CHAN1:SCAL?", &devc->vdiv[0]) != SR_OK)
717 if (get_cfg_float(sdi, ":CHAN2:SCAL?", &devc->vdiv[1]) != SR_OK)
719 sr_dbg("Current vertical gain CH1 %g CH2 %g", devc->vdiv[0], devc->vdiv[1]);
721 if (devc->model->protocol == PROTOCOL_IEEE488_2) {
722 /* Vertical reference - not certain if this is the place to read it. */
723 if (sr_scpi_send(sdi->conn, ":WAV:SOUR CHAN1") != SR_OK)
725 if (get_cfg_int(sdi, ":WAV:YREF?", &devc->vert_reference[0]) != SR_OK)
727 if (sr_scpi_send(sdi->conn, ":WAV:SOUR CHAN2") != SR_OK)
729 if (get_cfg_int(sdi, ":WAV:YREF?", &devc->vert_reference[1]) != SR_OK)
731 sr_dbg("Current vertical reference CH1 %d CH2 %d",
732 devc->vert_reference[0], devc->vert_reference[1]);
735 /* Vertical offset. */
736 if (get_cfg_float(sdi, ":CHAN1:OFFS?", &devc->vert_offset[0]) != SR_OK)
738 if (get_cfg_float(sdi, ":CHAN2:OFFS?", &devc->vert_offset[1]) != SR_OK)
740 sr_dbg("Current vertical offset CH1 %g CH2 %g", devc->vert_offset[0],
741 devc->vert_offset[1]);
744 if (get_cfg_string(sdi, ":CHAN1:COUP?", &devc->coupling[0]) != SR_OK)
746 if (get_cfg_string(sdi, ":CHAN2:COUP?", &devc->coupling[1]) != SR_OK)
748 sr_dbg("Current coupling CH1 %s CH2 %s", devc->coupling[0],
751 /* Trigger source. */
752 if (get_cfg_string(sdi, ":TRIG:EDGE:SOUR?", &devc->trigger_source) != SR_OK)
754 sr_dbg("Current trigger source %s", devc->trigger_source);
756 /* Horizontal trigger position. */
757 if (get_cfg_float(sdi, ":TIM:OFFS?", &devc->horiz_triggerpos) != SR_OK)
759 sr_dbg("Current horizontal trigger position %g", devc->horiz_triggerpos);
762 if (get_cfg_string(sdi, ":TRIG:EDGE:SLOP?", &devc->trigger_slope) != SR_OK)
764 sr_dbg("Current trigger slope %s", devc->trigger_slope);