2 * This file is part of the libsigrok project.
4 * Copyright (C) 2016 mhooijboer <marchelh@gmail.com>
5 * Copyright (C) 2012 Martin Ling <martin-git@earth.li>
6 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
7 * Copyright (C) 2013 Mathias Grimmberger <mgri@zaphod.sax.de>
9 * This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation, either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
34 #include <libsigrok/libsigrok.h>
35 #include "libsigrok-internal.h"
39 /* Set the next event to wait for in siglent_sds_receive(). */
40 static void siglent_sds_set_wait_event(struct dev_context *devc, enum wait_events event)
42 if (event == WAIT_STOP) {
43 devc->wait_status = 2;
45 devc->wait_status = 1;
46 devc->wait_event = event;
51 * Waiting for a event will return a timeout after 2 to 3 seconds in order
52 * to not block the application.
54 static int siglent_sds_event_wait(const struct sr_dev_inst *sdi)
59 struct dev_context *devc;
62 if (!(devc = sdi->priv))
67 s = 10000; /* Sleep time for status refresh. */
68 if (devc->wait_status == 1) {
70 if (time(NULL) - start >= 3) {
71 sr_dbg("Timeout waiting for trigger.");
72 return SR_ERR_TIMEOUT;
75 if (sr_scpi_get_string(sdi->conn, ":INR?", &buf) != SR_OK)
81 sr_dbg("Device triggered.");
83 if ((devc->timebase < 0.51) && (devc->timebase > 0.99e-6)) {
85 * Timebase * num hor. divs * 85(%) * 1e6(usecs) / 100
86 * -> 85 percent of sweep time
88 s = (devc->timebase * devc->model->series->num_horizontal_divs * 1000);
89 sr_spew("Sleeping for %ld usecs after trigger, "
90 "to let the acq buffer in the device fill", s);
94 if (devc->wait_status == 2) {
96 if (time(NULL) - start >= 3) {
97 sr_dbg("Timeout waiting for trigger.");
98 return SR_ERR_TIMEOUT;
100 if (sr_scpi_get_string(sdi->conn, ":INR?", &buf) != SR_OK)
105 * Now this loop condition looks suspicious! A bitwise
106 * OR of a variable and a non-zero literal should be
107 * non-zero. Logical AND of several non-zero values
108 * should be non-zero. Are many parts of the condition
109 * not taking effect? Was some different condition meant
110 * to get encoded? This needs review, and adjustment.
112 } while ((out | DEVICE_STATE_TRIG_RDY && out | DEVICE_STATE_DATA_ACQ) && out | DEVICE_STATE_STOPPED);
113 sr_dbg("Device triggerd 2.");
114 siglent_sds_set_wait_event(devc, WAIT_NONE);
120 static int siglent_sds_trigger_wait(const struct sr_dev_inst *sdi)
122 struct dev_context *devc;
124 if (!(devc = sdi->priv))
126 return siglent_sds_event_wait(sdi);
129 /* Wait for scope to got to "Stop" in single shot mode. */
130 static int siglent_sds_stop_wait(const struct sr_dev_inst *sdi)
132 return siglent_sds_event_wait(sdi);
135 /* Send a configuration setting. */
136 SR_PRIV int siglent_sds_config_set(const struct sr_dev_inst *sdi, const char *format, ...)
141 va_start(args, format);
142 ret = sr_scpi_send_variadic(sdi->conn, format, args);
148 /* Start capturing a new frameset. */
149 SR_PRIV int siglent_sds_capture_start(const struct sr_dev_inst *sdi)
151 struct dev_context *devc;
153 if (!(devc = sdi->priv))
156 switch (devc->model->series->protocol) {
158 if (devc->data_source == DATA_SOURCE_SCREEN) {
162 sr_dbg("Starting data capture for active frameset %" PRIu64 " of %" PRIu64,
163 devc->num_frames + 1, devc->limit_frames);
164 if (siglent_sds_config_set(sdi, "ARM") != SR_OK)
166 if (sr_scpi_get_string(sdi->conn, ":INR?", &buf) != SR_OK)
169 if (out == DEVICE_STATE_TRIG_RDY) {
170 siglent_sds_set_wait_event(devc, WAIT_TRIGGER);
171 } else if (out == DEVICE_STATE_TRIG_RDY + 1) {
172 sr_spew("Device triggered.");
173 siglent_sds_set_wait_event(devc, WAIT_BLOCK);
176 sr_spew("Device did not enter ARM mode.");
179 } else { /* TODO: Implement history retrieval. */
180 unsigned int framecount;
184 sr_dbg("Starting data capture for history frameset.");
185 if (siglent_sds_config_set(sdi, "FPAR?") != SR_OK)
187 ret = sr_scpi_read_data(sdi->conn, buf, 200);
189 sr_err("Read error while reading data header.");
192 memcpy(&framecount, buf + 40, 4);
193 if (devc->limit_frames > framecount)
194 sr_err("Frame limit higher than frames in buffer of device!");
195 else if (devc->limit_frames == 0)
196 devc->limit_frames = framecount;
197 sr_dbg("Starting data capture for history frameset %" PRIu64 " of %" PRIu64,
198 devc->num_frames + 1, devc->limit_frames);
199 if (siglent_sds_config_set(sdi, "FRAM %i", devc->num_frames + 1) != SR_OK)
201 if (siglent_sds_channel_start(sdi) != SR_OK)
203 siglent_sds_set_wait_event(devc, WAIT_STOP);
207 siglent_sds_set_wait_event(devc, WAIT_TRIGGER);
214 /* Start reading data from the current channel. */
215 SR_PRIV int siglent_sds_channel_start(const struct sr_dev_inst *sdi)
217 struct dev_context *devc;
218 struct sr_channel *ch;
221 if (!(devc = sdi->priv))
224 ch = devc->channel_entry->data;
226 sr_dbg("Starting reading data from channel %d.", ch->index + 1);
228 switch (devc->model->series->protocol) {
231 s = (ch->type == SR_CHANNEL_LOGIC) ? "D%d:WF?" : "C%d:WF? ALL";
232 if (sr_scpi_send(sdi->conn, s, ch->index + 1) != SR_OK)
234 siglent_sds_set_wait_event(devc, WAIT_NONE);
238 siglent_sds_set_wait_event(devc, WAIT_BLOCK);
240 devc->num_channel_bytes = 0;
241 devc->num_header_bytes = 0;
242 devc->num_block_bytes = 0;
247 /* Read the header of a data block. */
248 static int siglent_sds_read_header(struct sr_dev_inst *sdi)
250 struct sr_scpi_dev_inst *scpi = sdi->conn;
251 struct dev_context *devc = sdi->priv;
252 char *buf = (char *)devc->buffer;
253 int ret, desc_length;
254 int block_offset = 15; /* Offset for descriptor block. */
255 long data_length = 0;
257 /* Read header from device. */
258 ret = sr_scpi_read_data(scpi, buf, SIGLENT_HEADER_SIZE);
259 if (ret < SIGLENT_HEADER_SIZE) {
260 sr_err("Read error while reading data header.");
263 sr_dbg("Device returned %i bytes.", ret);
264 devc->num_header_bytes += ret;
265 buf += block_offset; /* Skip to start descriptor block. */
267 /* Parse WaveDescriptor header. */
268 memcpy(&desc_length, buf + 36, 4); /* Descriptor block length */
269 memcpy(&data_length, buf + 60, 4); /* Data block length */
271 devc->block_header_size = desc_length + 15;
272 devc->num_samples = data_length;
274 sr_dbg("Received data block header: '%s' -> block length %d.", buf, ret);
279 SR_PRIV int siglent_sds_receive(int fd, int revents, void *cb_data)
281 struct sr_dev_inst *sdi;
282 struct sr_scpi_dev_inst *scpi;
283 struct dev_context *devc;
284 struct sr_datafeed_packet packet;
285 struct sr_datafeed_analog analog;
286 struct sr_analog_encoding encoding;
287 struct sr_analog_meaning meaning;
288 struct sr_analog_spec spec;
289 struct sr_datafeed_logic logic;
291 struct sr_channel *ch;
295 if (!(sdi = cb_data))
298 if (!(devc = sdi->priv))
303 if (!(revents == G_IO_IN || revents == 0))
306 switch (devc->wait_event) {
310 if (siglent_sds_trigger_wait(sdi) != SR_OK)
312 if (siglent_sds_channel_start(sdi) != SR_OK)
316 if (siglent_sds_channel_start(sdi) != SR_OK)
320 if (siglent_sds_stop_wait(sdi) != SR_OK)
322 if (siglent_sds_channel_start(sdi) != SR_OK)
326 sr_err("BUG: Unknown event target encountered.");
329 ch = devc->channel_entry->data;
332 if (devc->num_block_bytes == 0) {
333 if (devc->memory_depth >= 14000000) {
334 sr_err("Device memory depth is set to 14Mpts, so please be patient.");
335 g_usleep(4900000); /* Sleep for large memory set. */
337 if (sr_scpi_read_begin(scpi) != SR_OK)
339 sr_dbg("New block header expected.");
340 len = siglent_sds_read_header(sdi);
342 /* Still reading the header. */
345 sr_err("Read error, aborting capture.");
346 packet.type = SR_DF_FRAME_END;
347 sr_session_send(sdi, &packet);
348 sdi->driver->dev_acquisition_stop(sdi);
351 devc->num_block_bytes = 0;
352 devc->num_block_read = 0;
356 sr_err("Read error, aborting capture.");
357 packet.type = SR_DF_FRAME_END;
358 sr_session_send(sdi, &packet);
359 sdi->driver->dev_acquisition_stop(sdi);
363 while (devc->num_block_bytes < devc->num_samples) {
364 len = sr_scpi_read_data(scpi, (char *)devc->buffer, devc->num_samples);
366 sr_err("Read error, aborting capture.");
367 packet.type = SR_DF_FRAME_END;
368 sr_session_send(sdi, &packet);
369 sdi->driver->dev_acquisition_stop(sdi);
372 devc->num_block_read += 1;
373 devc->num_block_bytes += len;
374 if (devc->num_block_bytes >= devc->num_samples ) {
375 /* Offset the data block buffer past the IEEE header and description header. */
376 devc->buffer += devc->block_header_size;
377 len = devc->num_samples;
379 sr_dbg("Received block: %i, %d bytes.", devc->num_block_read, len);
380 if (ch->type == SR_CHANNEL_ANALOG) {
381 float vdiv = devc->vdiv[ch->index];
382 float offset = devc->vert_offset[ch->index];
385 float voltage, vdivlog;
388 data = g_array_sized_new(FALSE, FALSE, sizeof(uint8_t), len);
389 g_array_append_vals(data, devc->buffer, len);
390 float_data = g_array_new(FALSE, FALSE, sizeof(float));
391 for (i = 0; i < len; i++) {
392 voltage = (float)g_array_index(data, int8_t, i) / 25;
393 voltage = ((vdiv * voltage) - offset);
394 g_array_append_val(float_data, voltage);
396 vdivlog = log10f(vdiv);
397 digits = -(int) vdivlog + (vdivlog < 0.0);
398 sr_analog_init(&analog, &encoding, &meaning, &spec, digits);
399 analog.meaning->channels = g_slist_append(NULL, ch);
400 analog.num_samples = float_data->len;
401 analog.data = (float *)float_data->data;
402 analog.meaning->mq = SR_MQ_VOLTAGE;
403 analog.meaning->unit = SR_UNIT_VOLT;
404 analog.meaning->mqflags = 0;
405 packet.type = SR_DF_ANALOG;
406 packet.payload = &analog;
407 sr_session_send(sdi, &packet);
408 g_slist_free(analog.meaning->channels);
409 g_array_free(data, TRUE);
413 logic.data = devc->buffer;
414 packet.type = SR_DF_LOGIC;
415 packet.payload = &logic;
416 sr_session_send(sdi, &packet);
419 if (devc->num_samples == devc->num_block_bytes) {
420 sr_dbg("Transfer has been completed.");
421 devc->num_header_bytes = 0;
422 devc->num_block_bytes = 0;
423 if (!sr_scpi_read_complete(scpi)) {
424 sr_err("Read should have been completed.");
425 packet.type = SR_DF_FRAME_END;
426 sr_session_send(sdi, &packet);
427 sdi->driver->dev_acquisition_stop(sdi);
430 devc->num_block_read = 0;
432 sr_dbg("%" PRIu64 " of %" PRIu64 " block bytes read.",
433 devc->num_block_bytes, devc->num_samples);
437 if (devc->channel_entry->next) {
438 /* We got the frame for this channel, now get the next channel. */
439 devc->channel_entry = devc->channel_entry->next;
440 siglent_sds_channel_start(sdi);
442 /* Done with this frame. */
443 packet.type = SR_DF_FRAME_END;
444 sr_session_send(sdi, &packet);
446 if (++devc->num_frames == devc->limit_frames) {
447 /* Last frame, stop capture. */
448 sdi->driver->dev_acquisition_stop(sdi);
450 /* Get the next frame, starting with the first channel. */
451 devc->channel_entry = devc->enabled_channels;
452 siglent_sds_capture_start(sdi);
454 /* Start of next frame. */
455 packet.type = SR_DF_FRAME_BEGIN;
456 sr_session_send(sdi, &packet);
463 SR_PRIV int siglent_sds_get_dev_cfg(const struct sr_dev_inst *sdi)
465 struct dev_context *devc;
466 struct sr_channel *ch;
467 char *cmd, *response;
476 /* Analog channel state. */
477 for (i = 0; i < devc->model->analog_channels; i++) {
478 cmd = g_strdup_printf("C%i:TRA?", i + 1);
479 res = sr_scpi_get_bool(sdi->conn, cmd, &devc->analog_channels[i]);
483 ch = g_slist_nth_data(sdi->channels, i);
484 ch->enabled = devc->analog_channels[i];
486 sr_dbg("Current analog channel state:");
487 for (i = 0; i < devc->model->analog_channels; i++)
488 sr_dbg("CH%d %s", i + 1, devc->analog_channels[i] ? "On" : "Off");
490 /* Digital channel state. */
491 if (devc->model->has_digital) {
494 sr_dbg("Check logic analyzer channel state.");
495 devc->la_enabled = FALSE;
496 cmd = g_strdup_printf("DGST?");
497 res = sr_scpi_get_bool(sdi->conn, cmd, &status);
501 sr_dbg("Logic analyzer status: %s", status ? "On" : "Off");
503 devc->la_enabled = TRUE;
504 for (i = 0; i < ARRAY_SIZE(devc->digital_channels); i++) {
505 cmd = g_strdup_printf("D%i:DGCH?", i);
506 res = sr_scpi_get_bool(sdi->conn, cmd, &devc->digital_channels[i]);
510 ch = g_slist_nth_data(sdi->channels, i + devc->model->analog_channels);
511 ch->enabled = devc->digital_channels[i];
512 sr_dbg("D%d: %s", i, devc->digital_channels[i] ? "On" : "Off");
515 for (i = 0; i < ARRAY_SIZE(devc->digital_channels); i++) {
516 ch = g_slist_nth_data(sdi->channels, i + devc->model->analog_channels);
517 devc->digital_channels[i] = FALSE;
518 ch->enabled = devc->digital_channels[i];
519 sr_dbg("D%d: %s", i, devc->digital_channels[i] ? "On" : "Off");
525 if (sr_scpi_get_float(sdi->conn, ":TDIV?", &devc->timebase) != SR_OK)
527 sr_dbg("Current timebase: %g.", devc->timebase);
529 /* Probe attenuation. */
530 for (i = 0; i < devc->model->analog_channels; i++) {
531 cmd = g_strdup_printf("C%d:ATTN?", i + 1);
532 res = sr_scpi_get_float(sdi->conn, cmd, &devc->attenuation[i]);
537 sr_dbg("Current probe attenuation:");
538 for (i = 0; i < devc->model->analog_channels; i++)
539 sr_dbg("CH%d %g", i + 1, devc->attenuation[i]);
541 /* Vertical gain and offset. */
542 if (siglent_sds_get_dev_cfg_vertical(sdi) != SR_OK)
546 for (i = 0; i < devc->model->analog_channels; i++) {
547 cmd = g_strdup_printf("C%d:CPL?", i + 1);
548 res = sr_scpi_get_string(sdi->conn, cmd, &devc->coupling[i]);
554 sr_dbg("Current coupling:");
555 for (i = 0; i < devc->model->analog_channels; i++)
556 sr_dbg("CH%d %s", i + 1, devc->coupling[i]);
558 /* Trigger source. */
561 if (sr_scpi_get_string(sdi->conn, "TRSE?", &response) != SR_OK)
563 tokens = g_strsplit(response, ",", 0);
564 for (num_tokens = 0; tokens[num_tokens] != NULL; num_tokens++);
565 if (num_tokens < 4) {
566 sr_dbg("IDN response not according to spec: %80.s.", response);
572 devc->trigger_source = g_strstrip(g_strdup(tokens[2]));
573 sr_dbg("Current trigger source: %s.", devc->trigger_source);
575 /* TODO: Horizontal trigger position. */
578 if (sr_scpi_get_string(sdi->conn, g_strdup_printf("%s:TRDL?", devc->trigger_source), &response) != SR_OK)
580 len = strlen(response);
581 if (!g_ascii_strcasecmp(response + (len - 2), "us")) {
582 trigger_pos = atof(response) / SR_GHZ(1);
583 sr_dbg("Current trigger position us %s.", response);
584 } else if (!g_ascii_strcasecmp(response + (len - 2), "ns")) {
585 trigger_pos = atof(response) / SR_MHZ(1);
586 sr_dbg("Current trigger position ms %s.", response);
587 } else if (!g_ascii_strcasecmp(response + (len - 2), "ms")) {
588 trigger_pos = atof(response) / SR_KHZ(1);
589 sr_dbg("Current trigger position ns %s.", response);
590 } else if (!g_ascii_strcasecmp(response + (len - 2), "s")) {
591 trigger_pos = atof(response);
592 sr_dbg("Current trigger position s %s.", response);
594 devc->horiz_triggerpos = trigger_pos;
596 sr_dbg("Current horizontal trigger position %.10f", devc->horiz_triggerpos);
599 cmd = g_strdup_printf("%s:TRSL?", devc->trigger_source);
600 res = sr_scpi_get_string(sdi->conn, cmd, &devc->trigger_slope);
604 sr_dbg("Current trigger slope: %s.", devc->trigger_slope);
607 cmd = g_strdup_printf("%s:TRLV?", devc->trigger_source);
608 res = sr_scpi_get_float(sdi->conn, cmd, &devc->trigger_level);
612 sr_dbg("Current trigger level: %g.", devc->trigger_level);
616 SR_PRIV int siglent_sds_get_dev_cfg_vertical(const struct sr_dev_inst *sdi)
618 struct dev_context *devc;
626 for (i = 0; i < devc->model->analog_channels; i++) {
627 cmd = g_strdup_printf("C%d:VDIV?", i + 1);
628 res = sr_scpi_get_float(sdi->conn, cmd, &devc->vdiv[i]);
633 sr_dbg("Current vertical gain:");
634 for (i = 0; i < devc->model->analog_channels; i++)
635 sr_dbg("CH%d %g", i + 1, devc->vdiv[i]);
637 /* Vertical offset. */
638 for (i = 0; i < devc->model->analog_channels; i++) {
639 cmd = g_strdup_printf("C%d:OFST?", i + 1);
640 res = sr_scpi_get_float(sdi->conn, cmd, &devc->vert_offset[i]);
645 sr_dbg("Current vertical offset:");
646 for (i = 0; i < devc->model->analog_channels; i++)
647 sr_dbg("CH%d %g", i + 1, devc->vert_offset[i]);
652 SR_PRIV int siglent_sds_get_dev_cfg_horizontal(const struct sr_dev_inst *sdi)
654 struct dev_context *devc;
657 char *sample_points_string;
658 float samplerate_scope, fvalue;
661 cmd = g_strdup_printf("SANU? C1");
662 res = sr_scpi_get_string(sdi->conn, cmd, &sample_points_string);
664 samplerate_scope = 0;
669 if (g_strstr_len(sample_points_string, -1, "Mpts") != NULL) {
670 sample_points_string[strlen(sample_points_string) -4] = '\0';
671 if (sr_atof_ascii(sample_points_string, &fvalue) != SR_OK) {
672 sr_dbg("Invalid float converted from scope response.");
675 samplerate_scope = fvalue * 1000000;
676 } else if (g_strstr_len(sample_points_string, -1, "Kpts") != NULL){
677 sample_points_string[strlen(sample_points_string) -4] = '\0';
678 if (sr_atof_ascii(sample_points_string, &fvalue) != SR_OK) {
679 sr_dbg("Invalid float converted from scope response.");
682 samplerate_scope = fvalue * 10000;
684 samplerate_scope = fvalue;
686 g_free(sample_points_string);
687 /* Get the timebase. */
688 if (sr_scpi_get_float(sdi->conn, ":TDIV?", &devc->timebase) != SR_OK)
690 sr_dbg("Current timebase: %g.", devc->timebase);
691 devc->samplerate = samplerate_scope / (devc->timebase * devc->model->series->num_horizontal_divs);
692 devc->memory_depth = samplerate_scope;