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) {
186 if (devc->timebase > 0.99e-6) {
188 * Timebase * num hor. divs * 85(%) * 1e6(usecs) / 100
189 * -> 85 percent of sweep time
191 s = (devc->timebase * devc->model->num_horizontal_divs
193 sr_spew("Sleeping for %ld usecs instead of trigger-wait", s);
196 rigol_ds_set_wait_event(devc, WAIT_NONE);
199 return rigol_ds_event_wait(sdi, 'T', 'A');
203 /* Wait for scope to got to "Stop" in single shot mode */
204 static int rigol_ds_stop_wait(const struct sr_dev_inst *sdi)
206 return rigol_ds_event_wait(sdi, 'S', 'S');
209 /* Check that a single shot acquisition actually succeeded on the DS2000 */
210 static int rigol_ds_check_stop(const struct sr_dev_inst *sdi)
212 struct dev_context *devc;
213 struct sr_probe *probe;
216 if (!(devc = sdi->priv))
219 probe = devc->channel_entry->data;
221 if (sr_scpi_send(sdi->conn, ":WAV:SOUR CHAN%d",
222 probe->index + 1) != SR_OK)
224 /* Check that the number of samples will be accepted */
225 if (sr_scpi_send(sdi->conn, ":WAV:POIN %d;*OPC", devc->analog_frame_size) != SR_OK)
227 if (get_cfg_int(sdi, "*ESR?", &tmp) != SR_OK)
230 * If we get an "Execution error" the scope went from "Single" to
231 * "Stop" without actually triggering. There is no waveform
232 * displayed and trying to download one will fail - the scope thinks
233 * it has 1400 samples (like display memory) and the driver thinks
234 * it has a different number of samples.
236 * In that case just try to capture something again. Might still
237 * fail in interesting ways.
239 * Ain't firmware fun?
242 sr_warn("Single shot acquisition failed, retrying...");
243 /* Sleep a bit, otherwise the single shot will often fail */
245 sr_scpi_send(sdi->conn, ":SING");
246 rigol_ds_set_wait_event(devc, WAIT_STOP);
253 /* Wait for enough data becoming available in scope output buffer */
254 static int rigol_ds_block_wait(const struct sr_dev_inst *sdi)
257 struct dev_context *devc;
261 if (!(devc = sdi->priv))
267 if (time(NULL) - start >= 3) {
268 sr_dbg("Timeout waiting for data block");
269 return SR_ERR_TIMEOUT;
273 * The scope copies data really slowly from sample
274 * memory to its output buffer, so try not to bother
275 * it too much with SCPI requests but don't wait too
276 * long for short sample frame sizes.
278 g_usleep(devc->analog_frame_size < 15000 ? 100000 : 1000000);
280 /* "READ,nnnn" (still working) or "IDLE,nnnn" (finished) */
281 if (get_cfg(sdi, ":WAV:STAT?", buf, sizeof(buf)) != SR_OK)
284 if (parse_int(buf + 5, &len) != SR_OK)
286 } while (buf[0] == 'R' && len < 1000000);
288 rigol_ds_set_wait_event(devc, WAIT_NONE);
293 /* Start capturing a new frameset */
294 SR_PRIV int rigol_ds_capture_start(const struct sr_dev_inst *sdi)
296 struct dev_context *devc;
298 if (!(devc = sdi->priv))
301 sr_dbg("Starting data capture for frameset %lu of %lu",
302 devc->num_frames + 1, devc->limit_frames);
304 if (sr_scpi_send(sdi->conn, ":WAV:FORM BYTE") != SR_OK)
306 if (devc->data_source == DATA_SOURCE_LIVE) {
307 if (sr_scpi_send(sdi->conn, ":WAV:MODE NORM") != SR_OK)
309 rigol_ds_set_wait_event(devc, WAIT_TRIGGER);
311 if (sr_scpi_send(sdi->conn, ":WAV:MODE RAW") != SR_OK)
313 if (sr_scpi_send(sdi->conn, ":SING", devc->analog_frame_size) != SR_OK)
315 rigol_ds_set_wait_event(devc, WAIT_STOP);
321 /* Start reading data from the current channel */
322 SR_PRIV int rigol_ds_channel_start(const struct sr_dev_inst *sdi)
324 struct dev_context *devc;
325 struct sr_probe *probe;
327 if (!(devc = sdi->priv))
330 probe = devc->channel_entry->data;
332 sr_dbg("Starting reading data from channel %d", probe->index + 1);
334 if (devc->model->series < RIGOL_DS1000Z) {
335 if (probe->type == SR_PROBE_LOGIC) {
336 if (sr_scpi_send(sdi->conn, ":WAV:DATA? DIG") != SR_OK)
339 if (sr_scpi_send(sdi->conn, ":WAV:DATA? CHAN%d",
340 probe->index + 1) != SR_OK)
344 if (sr_scpi_send(sdi->conn, ":WAV:SOUR CHAN%d",
345 probe->index + 1) != SR_OK)
347 if (devc->data_source != DATA_SOURCE_LIVE) {
348 if (sr_scpi_send(sdi->conn, ":WAV:RES") != SR_OK)
350 if (sr_scpi_send(sdi->conn, ":WAV:BEG") != SR_OK)
352 rigol_ds_set_wait_event(devc, WAIT_BLOCK);
354 rigol_ds_set_wait_event(devc, WAIT_NONE);
357 devc->num_frame_samples = 0;
358 devc->num_block_bytes = 0;
363 /* Read the header of a data block */
364 static int rigol_ds_read_header(struct sr_scpi_dev_inst *scpi)
366 char start[3], length[10];
369 /* Read the hashsign and length digit. */
370 tmp = sr_scpi_read_data(scpi, start, 2);
373 sr_err("Failed to read first two bytes of data block header.");
376 if (start[0] != '#' || !isdigit(start[1]) || start[1] == '0') {
377 sr_err("Received invalid data block header start '%s'.", start);
380 len = atoi(start + 1);
382 /* Read the data length. */
383 tmp = sr_scpi_read_data(scpi, length, len);
386 sr_err("Failed to read %d bytes of data block length.", len);
389 if (parse_int(length, &len) != SR_OK) {
390 sr_err("Received invalid data block length '%s'.", length);
394 sr_dbg("Received data block header: %s%s -> block length %d", start, length, len);
399 SR_PRIV int rigol_ds_receive(int fd, int revents, void *cb_data)
401 struct sr_dev_inst *sdi;
402 struct sr_scpi_dev_inst *scpi;
403 struct dev_context *devc;
404 struct sr_datafeed_packet packet;
405 struct sr_datafeed_analog analog;
406 struct sr_datafeed_logic logic;
409 struct sr_probe *probe;
413 if (!(sdi = cb_data))
416 if (!(devc = sdi->priv))
421 if (revents == G_IO_IN || revents == 0) {
422 if (devc->model->series >= RIGOL_DS1000Z) {
423 switch(devc->wait_event) {
427 if (rigol_ds_trigger_wait(sdi) != SR_OK)
429 if (rigol_ds_channel_start(sdi) != SR_OK)
433 if (rigol_ds_block_wait(sdi) != SR_OK)
437 if (rigol_ds_stop_wait(sdi) != SR_OK)
439 if (rigol_ds_check_stop(sdi) != SR_OK)
441 if (rigol_ds_channel_start(sdi) != SR_OK)
445 sr_err("BUG: Unknown event target encountered");
449 probe = devc->channel_entry->data;
451 if (devc->num_block_bytes == 0 &&
452 devc->model->series >= RIGOL_DS1000Z) {
453 if (sr_scpi_send(sdi->conn, ":WAV:DATA?") != SR_OK)
457 if (devc->num_block_bytes == 0) {
458 if (sr_scpi_read_begin(scpi) != SR_OK)
460 if (devc->model->protocol == PROTOCOL_IEEE488_2) {
461 sr_dbg("New block header expected");
462 len = rigol_ds_read_header(scpi);
465 /* At slow timebases in live capture the DS2072
466 * sometimes returns "short" data blocks, with
467 * apparently no way to get the rest of the data.
468 * Discard these, the complete data block will
471 if (devc->data_source == DATA_SOURCE_LIVE
472 && (unsigned)len < devc->num_frame_samples) {
473 sr_dbg("Discarding short data block");
474 sr_scpi_read_data(scpi, (char *)devc->buffer, len + 1);
477 devc->num_block_bytes = len;
479 devc->num_block_bytes = probe->type == SR_PROBE_ANALOG ?
480 devc->analog_frame_size : devc->digital_frame_size;
482 devc->num_block_read = 0;
485 len = devc->num_block_bytes - devc->num_block_read;
486 len = sr_scpi_read_data(scpi, (char *)devc->buffer,
487 len < ACQ_BUFFER_SIZE ? len : ACQ_BUFFER_SIZE);
489 sr_dbg("Received %d bytes.", len);
493 devc->num_block_read += len;
495 if (devc->num_frame_samples == 0) {
496 /* Start of a new frame. */
497 packet.type = SR_DF_FRAME_BEGIN;
498 sr_session_send(sdi, &packet);
501 if (probe->type == SR_PROBE_ANALOG) {
502 vref = devc->vert_reference[probe->index];
503 vdiv = devc->vdiv[probe->index] / 25.6;
504 offset = devc->vert_offset[probe->index];
505 if (devc->model->series >= RIGOL_DS1000Z)
506 for (i = 0; i < len; i++)
507 devc->data[i] = ((int)devc->buffer[i] - vref) * vdiv - offset;
509 for (i = 0; i < len; i++)
510 devc->data[i] = (128 - devc->buffer[i]) * vdiv - offset;
511 analog.probes = g_slist_append(NULL, probe);
512 analog.num_samples = len;
513 analog.data = devc->data;
514 analog.mq = SR_MQ_VOLTAGE;
515 analog.unit = SR_UNIT_VOLT;
517 packet.type = SR_DF_ANALOG;
518 packet.payload = &analog;
519 sr_session_send(cb_data, &packet);
520 g_slist_free(analog.probes);
524 logic.data = devc->buffer;
525 packet.type = SR_DF_LOGIC;
526 packet.payload = &logic;
527 sr_session_send(cb_data, &packet);
530 if (devc->num_block_read == devc->num_block_bytes) {
531 sr_dbg("Block has been completed");
532 if (devc->model->series >= RIGOL_DS1000Z) {
533 /* Discard the terminating linefeed */
534 sr_scpi_read_data(scpi, (char *)devc->buffer, 1);
536 if (devc->model->protocol == PROTOCOL_IEEE488_2) {
537 /* Prepare for possible next block */
538 devc->num_block_bytes = 0;
539 if (devc->data_source != DATA_SOURCE_LIVE)
540 rigol_ds_set_wait_event(devc, WAIT_BLOCK);
542 if (!sr_scpi_read_complete(scpi)) {
543 sr_err("Read should have been completed");
544 sdi->driver->dev_acquisition_stop(sdi, cb_data);
547 devc->num_block_read = 0;
549 sr_dbg("%d of %d block bytes read", devc->num_block_read, devc->num_block_bytes);
552 devc->num_frame_samples += len;
554 if (devc->num_frame_samples < (probe->type == SR_PROBE_ANALOG ?
555 devc->analog_frame_size : devc->digital_frame_size))
556 /* Don't have the whole frame yet. */
559 /* End of the frame. */
560 sr_dbg("Frame completed, %d samples", devc->num_frame_samples);
561 packet.type = SR_DF_FRAME_END;
562 sr_session_send(sdi, &packet);
563 if (devc->model->series >= RIGOL_DS1000Z) {
564 /* Signal end of data download to scope */
565 if (devc->data_source != DATA_SOURCE_LIVE)
567 * This causes a query error, without it switching
568 * to the next channel causes an error. Fun with
571 sr_scpi_send(sdi->conn, ":WAV:END");
574 if (probe->type == SR_PROBE_ANALOG
575 && devc->channel_entry->next != NULL) {
576 /* We got the frame for this analog channel, but
577 * there's another analog channel. */
578 devc->channel_entry = devc->channel_entry->next;
579 rigol_ds_channel_start(sdi);
581 /* Done with all analog channels in this frame. */
582 if (devc->enabled_digital_probes
583 && devc->channel_entry != devc->enabled_digital_probes) {
584 /* Now we need to get the digital data. */
585 devc->channel_entry = devc->enabled_digital_probes;
586 rigol_ds_channel_start(sdi);
587 } else if (++devc->num_frames == devc->limit_frames) {
588 sdi->driver->dev_acquisition_stop(sdi, cb_data);
590 /* Get the next frame, starting with the first analog channel. */
591 if (devc->enabled_analog_probes)
592 devc->channel_entry = devc->enabled_analog_probes;
594 devc->channel_entry = devc->enabled_digital_probes;
596 if (devc->model->series < RIGOL_DS1000Z)
597 rigol_ds_channel_start(sdi);
599 rigol_ds_capture_start(sdi);
607 static int get_cfg(const struct sr_dev_inst *sdi, char *cmd, char *reply, size_t maxlen)
610 struct dev_context *devc = sdi->priv;
611 struct sr_scpi_dev_inst *scpi = sdi->conn;
614 if (sr_scpi_get_string(scpi, cmd, &response) != SR_OK)
617 g_strlcpy(reply, response, maxlen);
621 if (devc->model->series >= RIGOL_DS1000Z) {
622 /* get rid of trailing linefeed */
623 if (len >= 1 && reply[len-1] == '\n')
627 sr_spew("Received '%s'.", reply);
632 static int get_cfg_int(const struct sr_dev_inst *sdi, char *cmd, int *i)
636 if (get_cfg(sdi, cmd, buf, sizeof(buf)) != SR_OK)
639 if (parse_int(buf, i) != SR_OK)
645 static int get_cfg_float(const struct sr_dev_inst *sdi, char *cmd, float *f)
649 if (get_cfg(sdi, cmd, buf, sizeof(buf)) != SR_OK)
651 *f = strtof(buf, &e);
652 if (e == buf || (fpclassify(*f) & (FP_ZERO | FP_NORMAL)) == 0) {
653 sr_dbg("failed to parse response to '%s': '%s'", cmd, buf);
660 static int get_cfg_string(const struct sr_dev_inst *sdi, char *cmd, char **buf)
662 if (!(*buf = g_try_malloc0(256)))
663 return SR_ERR_MALLOC;
665 if (get_cfg(sdi, cmd, *buf, 256) != SR_OK)
671 SR_PRIV int rigol_ds_get_dev_cfg(const struct sr_dev_inst *sdi)
673 struct dev_context *devc;
680 /* Analog channel state. */
681 for (i = 0; i < devc->model->analog_channels; i++) {
682 cmd = g_strdup_printf(":CHAN%d:DISP?", i + 1);
683 res = get_cfg_string(sdi, cmd, &t_s);
687 devc->analog_channels[i] = !strcmp(t_s, "ON") || !strcmp(t_s, "1");
689 sr_dbg("Current analog channel state:");
690 for (i = 0; i < devc->model->analog_channels; i++)
691 sr_dbg("CH%d %s", i + 1, devc->analog_channels[i] ? "on" : "off");
693 /* Digital channel state. */
694 if (devc->model->has_digital) {
695 if (get_cfg_string(sdi, ":LA:DISP?", &t_s) != SR_OK)
697 devc->la_enabled = !strcmp(t_s, "ON") ? TRUE : FALSE;
698 sr_dbg("Logic analyzer %s, current digital channel state:",
699 devc->la_enabled ? "enabled" : "disabled");
700 for (i = 0; i < 16; i++) {
701 cmd = g_strdup_printf(":DIG%d:TURN?", i);
702 res = get_cfg_string(sdi, cmd, &t_s);
706 devc->digital_channels[i] = !strcmp(t_s, "ON") ? TRUE : FALSE;
708 sr_dbg("D%d: %s", i, devc->digital_channels[i] ? "on" : "off");
713 if (get_cfg_float(sdi, ":TIM:SCAL?", &devc->timebase) != SR_OK)
715 sr_dbg("Current timebase %g", devc->timebase);
718 for (i = 0; i < devc->model->analog_channels; i++) {
719 cmd = g_strdup_printf(":CHAN%d:SCAL?", i + 1);
720 res = get_cfg_float(sdi, cmd, &devc->vdiv[i]);
725 sr_dbg("Current vertical gain:");
726 for (i = 0; i < devc->model->analog_channels; i++)
727 sr_dbg("CH%d %g", i + 1, devc->vdiv[i]);
729 sr_dbg("Current vertical reference:");
730 if (devc->model->series >= RIGOL_DS1000Z) {
731 /* Vertical reference - not certain if this is the place to read it. */
732 for (i = 0; i < devc->model->analog_channels; i++) {
733 if (sr_scpi_send(sdi->conn, ":WAV:SOUR CHAN%d", i + 1) != SR_OK)
735 if (get_cfg_int(sdi, ":WAV:YREF?", &devc->vert_reference[i]) != SR_OK)
737 sr_dbg("CH%d %d", i + 1, devc->vert_reference[i]);
741 /* Vertical offset. */
742 for (i = 0; i < devc->model->analog_channels; i++) {
743 cmd = g_strdup_printf(":CHAN%d:OFFS?", i + 1);
744 res = get_cfg_float(sdi, cmd, &devc->vert_offset[i]);
749 sr_dbg("Current vertical offset:");
750 for (i = 0; i < devc->model->analog_channels; i++)
751 sr_dbg("CH%d %g", i + 1, devc->vert_offset[i]);
754 for (i = 0; i < devc->model->analog_channels; i++) {
755 cmd = g_strdup_printf(":CHAN%d:COUP?", i + 1);
756 res = get_cfg_string(sdi, cmd, &devc->coupling[i]);
761 sr_dbg("Current coupling:");
762 for (i = 0; i < devc->model->analog_channels; i++)
763 sr_dbg("CH%d %s", i + 1, devc->coupling[i]);
765 /* Trigger source. */
766 if (get_cfg_string(sdi, ":TRIG:EDGE:SOUR?", &devc->trigger_source) != SR_OK)
768 sr_dbg("Current trigger source %s", devc->trigger_source);
770 /* Horizontal trigger position. */
771 if (get_cfg_float(sdi, ":TIM:OFFS?", &devc->horiz_triggerpos) != SR_OK)
773 sr_dbg("Current horizontal trigger position %g", devc->horiz_triggerpos);
776 if (get_cfg_string(sdi, ":TRIG:EDGE:SLOP?", &devc->trigger_slope) != SR_OK)
778 sr_dbg("Current trigger slope %s", devc->trigger_slope);