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;
220 if (!(devc = sdi->priv))
223 ch = devc->channel_entry->data;
225 sr_dbg("Starting reading data from channel %d.", ch->index + 1);
227 switch (devc->model->series->protocol) {
230 if (ch->type == SR_CHANNEL_LOGIC) {
231 if (sr_scpi_send(sdi->conn, "D%d:WF?",
232 ch->index + 1) != SR_OK)
235 if (sr_scpi_send(sdi->conn, "C%d:WF? ALL",
236 ch->index + 1) != SR_OK)
239 siglent_sds_set_wait_event(devc, WAIT_NONE);
243 siglent_sds_set_wait_event(devc, WAIT_BLOCK);
245 devc->num_channel_bytes = 0;
246 devc->num_header_bytes = 0;
247 devc->num_block_bytes = 0;
252 /* Read the header of a data block. */
253 static int siglent_sds_read_header(struct sr_dev_inst *sdi)
255 struct sr_scpi_dev_inst *scpi = sdi->conn;
256 struct dev_context *devc = sdi->priv;
257 char *buf = (char *)devc->buffer;
258 int ret, desc_length;
259 int block_offset = 15; /* Offset for descriptor block. */
262 /* Read header from device. */
263 ret = sr_scpi_read_data(scpi, buf + devc->num_header_bytes,
264 devc->model->series->buffer_samples);
266 sr_err("Read error while reading data header.");
269 sr_dbg("Device returned %i bytes.", ret);
270 devc->num_header_bytes += ret;
271 buf += block_offset; /* Skip to start descriptor block. */
273 /* Parse WaveDescriptor header. */
274 memcpy(&desc_length, buf + 36, 4); /* Descriptor block length */
275 memcpy(&dataLength, buf + 60, 4); /* Data block length */
277 devc->vdiv[channelIndex] = 2;
278 devc->vert_offset[channelIndex] = 0;
279 devc->block_header_size = desc_length + 15;
282 sr_dbg("Received data block header: '%s' -> block length %d.", buf, ret);
287 SR_PRIV int siglent_sds_receive(int fd, int revents, void *cb_data)
289 struct sr_dev_inst *sdi;
290 struct sr_scpi_dev_inst *scpi;
291 struct dev_context *devc;
292 struct sr_datafeed_packet packet;
293 struct sr_datafeed_analog analog;
294 struct sr_analog_encoding encoding;
295 struct sr_analog_meaning meaning;
296 struct sr_analog_spec spec;
297 struct sr_datafeed_logic logic;
299 struct sr_channel *ch;
300 gsize expected_data_bytes = 0;
305 if (!(sdi = cb_data))
308 if (!(devc = sdi->priv))
313 if (!(revents == G_IO_IN || revents == 0))
317 if (sr_scpi_get_string(sdi->conn, "MSIZ?", &memsize) != SR_OK)
320 switch (devc->wait_event) {
324 if (siglent_sds_trigger_wait(sdi) != SR_OK)
326 if (siglent_sds_channel_start(sdi) != SR_OK)
330 if (siglent_sds_channel_start(sdi) != SR_OK)
334 if (siglent_sds_stop_wait(sdi) != SR_OK)
336 if (siglent_sds_channel_start(sdi) != SR_OK)
340 sr_err("BUG: Unknown event target encountered.");
344 ch = devc->channel_entry->data;
346 if (devc->num_block_bytes == 0) {
348 if (g_ascii_strcasecmp(memsize, "14M") == 0) {
349 sr_err("Device memory depth is set to 14Mpts, so please be patient.");
350 g_usleep(4900000); /* Sleep for large memory set. */
352 sr_dbg("New block header expected.");
353 len = siglent_sds_read_header(sdi);
354 expected_data_bytes = len;
356 /* Still reading the header. */
359 sr_err("Read error, aborting capture.");
360 packet.type = SR_DF_FRAME_END;
361 sr_session_send(sdi, &packet);
362 sdi->driver->dev_acquisition_stop(sdi);
366 if (devc->data_source == DATA_SOURCE_SCREEN
367 && (unsigned)len < expected_data_bytes) {
368 sr_dbg("Discarding short data block.");
369 sr_scpi_read_data(scpi, (char *)devc->buffer, len + 1);
372 devc->num_block_bytes = len;
373 devc->num_block_read = 0;
376 len = devc->num_block_bytes - devc->num_block_read;
377 if (len > ACQ_BUFFER_SIZE)
378 len = ACQ_BUFFER_SIZE;
380 /* Offset the data block buffer past the IEEE header and description header. */
381 devc->buffer += devc->block_header_size;
384 sr_err("Read error, aborting capture.");
385 packet.type = SR_DF_FRAME_END;
386 sr_session_send(sdi, &packet);
387 sdi->driver->dev_acquisition_stop(sdi);
391 sr_dbg("Received %d bytes.", len);
393 devc->num_block_read += len;
395 if (ch->type == SR_CHANNEL_ANALOG) {
396 float vdiv = devc->vdiv[ch->index];
397 float offset = devc->vert_offset[ch->index];
400 float voltage, vdivlog;
403 data = g_array_sized_new(FALSE, FALSE, sizeof(uint8_t), len);
404 g_array_append_vals(data, devc->buffer, len);
405 float_data = g_array_new(FALSE, FALSE, sizeof(float));
406 for (i = 0; i < len; i++) {
407 voltage = (float)g_array_index(data, int8_t, i) / 25;
408 voltage = ((vdiv * voltage) - offset);
409 g_array_append_val(float_data, voltage);
411 vdivlog = log10f(vdiv);
412 digits = -(int) vdivlog + (vdivlog < 0.0);
413 sr_analog_init(&analog, &encoding, &meaning, &spec, digits);
414 analog.meaning->channels = g_slist_append(NULL, ch);
415 analog.num_samples = float_data->len;
416 analog.data = (float *)float_data->data;
417 analog.meaning->mq = SR_MQ_VOLTAGE;
418 analog.meaning->unit = SR_UNIT_VOLT;
419 analog.meaning->mqflags = 0;
420 packet.type = SR_DF_ANALOG;
421 packet.payload = &analog;
422 sr_session_send(sdi, &packet);
423 g_slist_free(analog.meaning->channels);
424 g_array_free(data, TRUE);
428 logic.data = devc->buffer;
429 packet.type = SR_DF_LOGIC;
430 packet.payload = &logic;
431 sr_session_send(sdi, &packet);
434 if (devc->num_block_read == devc->num_block_bytes) {
435 sr_dbg("Block has been completed.");
436 sr_dbg("Preparing for possible next block.");
437 devc->num_header_bytes = 0;
438 devc->num_block_bytes = 0;
439 if (devc->data_source != DATA_SOURCE_SCREEN)
440 siglent_sds_set_wait_event(devc, WAIT_BLOCK);
441 if (!sr_scpi_read_complete(scpi)) {
442 sr_err("Read should have been completed.");
443 packet.type = SR_DF_FRAME_END;
444 sr_session_send(sdi, &packet);
445 sdi->driver->dev_acquisition_stop(sdi);
448 devc->num_block_read = 0;
450 sr_dbg("%" PRIu64 " of %" PRIu64 " block bytes read.",
451 devc->num_block_read, devc->num_block_bytes);
453 devc->num_channel_bytes += len;
454 if (devc->num_channel_bytes < expected_data_bytes) {
455 /* Don't have the full data for this channel yet, re-run. */
458 if (devc->channel_entry->next) {
459 /* We got the frame for this channel, now get the next channel. */
460 devc->channel_entry = devc->channel_entry->next;
461 siglent_sds_channel_start(sdi);
463 /* Done with this frame. */
464 packet.type = SR_DF_FRAME_END;
465 sr_session_send(sdi, &packet);
467 if (++devc->num_frames == devc->limit_frames) {
468 /* Last frame, stop capture. */
469 sdi->driver->dev_acquisition_stop(sdi);
471 /* Get the next frame, starting with the first channel. */
472 devc->channel_entry = devc->enabled_channels;
473 siglent_sds_capture_start(sdi);
475 /* Start of next frame. */
476 packet.type = SR_DF_FRAME_BEGIN;
477 sr_session_send(sdi, &packet);
484 SR_PRIV int siglent_sds_get_dev_cfg(const struct sr_dev_inst *sdi)
486 struct dev_context *devc;
487 struct sr_channel *ch;
488 char *cmd, *response;
495 /* Analog channel state. */
496 for (i = 0; i < devc->model->analog_channels; i++) {
497 cmd = g_strdup_printf("C%i:TRA?", i + 1);
498 res = sr_scpi_get_bool(sdi->conn, cmd, &devc->analog_channels[i]);
502 ch = g_slist_nth_data(sdi->channels, i);
503 ch->enabled = devc->analog_channels[i];
505 sr_dbg("Current analog channel state:");
506 for (i = 0; i < devc->model->analog_channels; i++)
507 sr_dbg("CH%d %s", i + 1, devc->analog_channels[i] ? "On" : "Off");
509 /* Digital channel state. */
510 if (devc->model->has_digital) {
513 sr_dbg("Check logic analyzer channel state.");
514 devc->la_enabled = FALSE;
515 cmd = g_strdup_printf("DGST?");
516 res = sr_scpi_get_bool(sdi->conn, cmd, &status);
520 sr_dbg("Logic analyzer status: %s", status ? "On" : "Off");
522 devc->la_enabled = TRUE;
523 for (i = 0; i < ARRAY_SIZE(devc->digital_channels); i++) {
524 cmd = g_strdup_printf("D%i:DGCH?", i);
525 res = sr_scpi_get_bool(sdi->conn, cmd, &devc->digital_channels[i]);
529 ch = g_slist_nth_data(sdi->channels, i + devc->model->analog_channels);
530 ch->enabled = devc->digital_channels[i];
531 sr_dbg("D%d: %s", i, devc->digital_channels[i] ? "On" : "Off");
534 for (i = 0; i < ARRAY_SIZE(devc->digital_channels); i++) {
535 ch = g_slist_nth_data(sdi->channels, i + devc->model->analog_channels);
536 devc->digital_channels[i] = FALSE;
537 ch->enabled = devc->digital_channels[i];
538 sr_dbg("D%d: %s", i, devc->digital_channels[i] ? "On" : "Off");
544 if (sr_scpi_get_float(sdi->conn, ":TDIV?", &devc->timebase) != SR_OK)
546 sr_dbg("Current timebase: %g.", devc->timebase);
548 /* Probe attenuation. */
549 for (i = 0; i < devc->model->analog_channels; i++) {
550 cmd = g_strdup_printf("C%d:ATTN?", i + 1);
551 res = sr_scpi_get_float(sdi->conn, cmd, &devc->attenuation[i]);
556 sr_dbg("Current probe attenuation:");
557 for (i = 0; i < devc->model->analog_channels; i++)
558 sr_dbg("CH%d %g", i + 1, devc->attenuation[i]);
560 /* Vertical gain and offset. */
561 if (siglent_sds_get_dev_cfg_vertical(sdi) != SR_OK)
565 for (i = 0; i < devc->model->analog_channels; i++) {
566 cmd = g_strdup_printf("C%d:CPL?", i + 1);
567 res = sr_scpi_get_string(sdi->conn, cmd, &devc->coupling[i]);
573 sr_dbg("Current coupling:");
574 for (i = 0; i < devc->model->analog_channels; i++)
575 sr_dbg("CH%d %s", i + 1, devc->coupling[i]);
577 /* Trigger source. */
580 if (sr_scpi_get_string(sdi->conn, "TRSE?", &response) != SR_OK)
582 tokens = g_strsplit(response, ",", 0);
583 for (num_tokens = 0; tokens[num_tokens] != NULL; num_tokens++);
584 if (num_tokens < 4) {
585 sr_dbg("IDN response not according to spec: %80.s.", response);
591 devc->trigger_source = g_strstrip(g_strdup(tokens[2]));
592 sr_dbg("Current trigger source: %s.", devc->trigger_source);
594 /* TODO: Horizontal trigger position. */
596 devc->horiz_triggerpos = 0;
597 sr_dbg("Current horizontal trigger position: %g.", devc->horiz_triggerpos);
600 cmd = g_strdup_printf("%s:TRSL?", devc->trigger_source);
601 res = sr_scpi_get_string(sdi->conn, cmd, &devc->trigger_slope);
605 sr_dbg("Current trigger slope: %s.", devc->trigger_slope);
608 cmd = g_strdup_printf("%s:TRLV?", devc->trigger_source);
609 res = sr_scpi_get_float(sdi->conn, cmd, &devc->trigger_level);
613 sr_dbg("Current trigger level: %g.", devc->trigger_level);
617 SR_PRIV int siglent_sds_get_dev_cfg_vertical(const struct sr_dev_inst *sdi)
619 struct dev_context *devc;
627 for (i = 0; i < devc->model->analog_channels; i++) {
628 cmd = g_strdup_printf("C%d:VDIV?", i + 1);
629 res = sr_scpi_get_float(sdi->conn, cmd, &devc->vdiv[i]);
634 sr_dbg("Current vertical gain:");
635 for (i = 0; i < devc->model->analog_channels; i++)
636 sr_dbg("CH%d %g", i + 1, devc->vdiv[i]);
638 /* Vertical offset. */
639 for (i = 0; i < devc->model->analog_channels; i++) {
640 cmd = g_strdup_printf("C%d:OFST?", i + 1);
641 res = sr_scpi_get_float(sdi->conn, cmd, &devc->vert_offset[i]);
646 sr_dbg("Current vertical offset:");
647 for (i = 0; i < devc->model->analog_channels; i++)
648 sr_dbg("CH%d %g", i + 1, devc->vert_offset[i]);
653 SR_PRIV int siglent_sds_get_dev_cfg_horizontal(const struct sr_dev_inst *sdi)
655 struct dev_context *devc;
658 char *sample_points_string;
659 float samplerate_scope, fvalue;
660 char *first, *concat;
663 cmd = g_strdup_printf("SANU? C1");
664 res = sr_scpi_get_string(sdi->conn, cmd, &sample_points_string);
668 if (g_strstr_len(sample_points_string, -1, "Mpts") != NULL) {
669 sample_points_string[strlen(sample_points_string) - 4] = '\0';
671 if (g_strstr_len(sample_points_string, -1, ".") != NULL) {
672 first = strtok(sample_points_string, ".");
673 concat = strcat(first, strtok(NULL, "."));
674 if (sr_atof_ascii(concat, &fvalue) != SR_OK || fvalue == 0.0) {
675 sr_dbg("Invalid float converted from scope response.");
679 if (sr_atof_ascii(sample_points_string, &fvalue) != SR_OK || fvalue == 0.0) {
680 sr_dbg("Invalid float converted from scope response.");
684 samplerate_scope = fvalue * 100000;
686 sample_points_string[strlen(sample_points_string) - 4] = '\0';
687 if (sr_atof_ascii(sample_points_string, &fvalue) != SR_OK || fvalue == 0.0) {
688 sr_dbg("Invalid float converted from scope response.");
691 samplerate_scope = fvalue * 1000;
693 /* Get the timebase. */
694 if (sr_scpi_get_float(sdi->conn, ":TDIV?", &devc->timebase) != SR_OK)
696 sr_dbg("Current timebase: %g.", devc->timebase);
697 devc->samplerate = samplerate_scope / (devc->timebase * devc->model->series->num_horizontal_divs);