2 * This file is part of the libsigrok project.
4 * Copyright (C) 2013 poljar (Damir Jelić) <poljarinho@gmail.com>
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
23 #include <libsigrok/libsigrok.h>
24 #include "libsigrok-internal.h"
27 #define LOG_PREFIX "scpi"
29 #define SCPI_READ_RETRIES 100
30 #define SCPI_READ_RETRY_TIMEOUT_US (10 * 1000)
33 * Parse a string representation of a boolean-like value into a gboolean.
34 * Similar to sr_parse_boolstring but rejects strings which do not represent
35 * a boolean-like value.
37 * @param str String to convert.
38 * @param ret Pointer to a gboolean where the result of the conversion will be
41 * @return SR_OK on success, SR_ERR on failure.
43 static int parse_strict_bool(const char *str, gboolean *ret)
48 if (!g_strcmp0(str, "1") ||
49 !g_ascii_strncasecmp(str, "y", 1) ||
50 !g_ascii_strncasecmp(str, "t", 1) ||
51 !g_ascii_strncasecmp(str, "yes", 3) ||
52 !g_ascii_strncasecmp(str, "true", 4) ||
53 !g_ascii_strncasecmp(str, "on", 2)) {
56 } else if (!g_strcmp0(str, "0") ||
57 !g_ascii_strncasecmp(str, "n", 1) ||
58 !g_ascii_strncasecmp(str, "f", 1) ||
59 !g_ascii_strncasecmp(str, "no", 2) ||
60 !g_ascii_strncasecmp(str, "false", 5) ||
61 !g_ascii_strncasecmp(str, "off", 3)) {
69 SR_PRIV extern const struct sr_scpi_dev_inst scpi_serial_dev;
70 SR_PRIV extern const struct sr_scpi_dev_inst scpi_tcp_raw_dev;
71 SR_PRIV extern const struct sr_scpi_dev_inst scpi_tcp_rigol_dev;
72 SR_PRIV extern const struct sr_scpi_dev_inst scpi_usbtmc_libusb_dev;
73 SR_PRIV extern const struct sr_scpi_dev_inst scpi_vxi_dev;
74 SR_PRIV extern const struct sr_scpi_dev_inst scpi_visa_dev;
75 SR_PRIV extern const struct sr_scpi_dev_inst scpi_libgpib_dev;
77 static const struct sr_scpi_dev_inst *scpi_devs[] = {
80 #ifdef HAVE_LIBUSB_1_0
81 &scpi_usbtmc_libusb_dev,
92 #ifdef HAVE_LIBSERIALPORT
93 &scpi_serial_dev, /* Must be last as it matches any resource. */
97 static struct sr_dev_inst *sr_scpi_scan_resource(struct drv_context *drvc,
98 const char *resource, const char *serialcomm,
99 struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi))
101 struct sr_scpi_dev_inst *scpi;
102 struct sr_dev_inst *sdi;
104 if (!(scpi = scpi_dev_inst_new(drvc, resource, serialcomm)))
107 if (sr_scpi_open(scpi) != SR_OK) {
108 sr_info("Couldn't open SCPI device.");
113 sdi = probe_device(scpi);
118 sdi->status = SR_ST_INACTIVE;
125 SR_PRIV GSList *sr_scpi_scan(struct drv_context *drvc, GSList *options,
126 struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi))
128 GSList *resources, *l, *devices;
129 struct sr_dev_inst *sdi;
130 const char *resource = NULL;
131 const char *serialcomm = NULL;
135 for (l = options; l; l = l->next) {
136 struct sr_config *src = l->data;
139 resource = g_variant_get_string(src->data, NULL);
141 case SR_CONF_SERIALCOMM:
142 serialcomm = g_variant_get_string(src->data, NULL);
148 for (i = 0; i < ARRAY_SIZE(scpi_devs); i++) {
149 if ((resource && strcmp(resource, scpi_devs[i]->prefix))
150 || !scpi_devs[i]->scan)
152 resources = scpi_devs[i]->scan(drvc);
153 for (l = resources; l; l = l->next) {
154 res = g_strsplit(l->data, ":", 2);
155 if (res[0] && (sdi = sr_scpi_scan_resource(drvc, res[0],
156 serialcomm ? serialcomm : res[1], probe_device))) {
157 devices = g_slist_append(devices, sdi);
158 sdi->connection_id = g_strdup(l->data);
162 g_slist_free_full(resources, g_free);
165 if (!devices && resource) {
166 sdi = sr_scpi_scan_resource(drvc, resource, serialcomm, probe_device);
168 devices = g_slist_append(NULL, sdi);
171 /* Tack a copy of the newly found devices onto the driver list. */
173 drvc->instances = g_slist_concat(drvc->instances, g_slist_copy(devices));
178 SR_PRIV struct sr_scpi_dev_inst *scpi_dev_inst_new(struct drv_context *drvc,
179 const char *resource, const char *serialcomm)
181 struct sr_scpi_dev_inst *scpi = NULL;
182 const struct sr_scpi_dev_inst *scpi_dev;
186 for (i = 0; i < ARRAY_SIZE(scpi_devs); i++) {
187 scpi_dev = scpi_devs[i];
188 if (!strncmp(resource, scpi_dev->prefix, strlen(scpi_dev->prefix))) {
189 sr_dbg("Opening %s device %s.", scpi_dev->name, resource);
190 scpi = g_malloc(sizeof(*scpi));
192 scpi->priv = g_malloc0(scpi->priv_size);
193 scpi->read_timeout_us = 1000 * 1000;
194 params = g_strsplit(resource, "/", 0);
195 if (scpi->dev_inst_new(scpi->priv, drvc, resource,
196 params, serialcomm) != SR_OK) {
211 * @param scpi Previously initialized SCPI device structure.
213 * @return SR_OK on success, SR_ERR on failure.
215 SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi)
217 return scpi->open(scpi);
221 * Add an event source for an SCPI device.
223 * @param session The session to add the event source to.
224 * @param scpi Previously initialized SCPI device structure.
225 * @param events Events to check for.
226 * @param timeout Max time to wait before the callback is called, ignored if 0.
227 * @param cb Callback function to add. Must not be NULL.
228 * @param cb_data Data for the callback function. Can be NULL.
230 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
231 * SR_ERR_MALLOC upon memory allocation errors.
233 SR_PRIV int sr_scpi_source_add(struct sr_session *session,
234 struct sr_scpi_dev_inst *scpi, int events, int timeout,
235 sr_receive_data_callback cb, void *cb_data)
237 return scpi->source_add(session, scpi->priv, events, timeout, cb, cb_data);
241 * Remove event source for an SCPI device.
243 * @param session The session to remove the event source from.
244 * @param scpi Previously initialized SCPI device structure.
246 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
247 * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
250 SR_PRIV int sr_scpi_source_remove(struct sr_session *session,
251 struct sr_scpi_dev_inst *scpi)
253 return scpi->source_remove(session, scpi->priv);
257 * Send a SCPI command.
259 * @param scpi Previously initialized SCPI device structure.
260 * @param format Format string, to be followed by any necessary arguments.
262 * @return SR_OK on success, SR_ERR on failure.
264 SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi,
265 const char *format, ...)
270 va_start(args, format);
271 ret = sr_scpi_send_variadic(scpi, format, args);
278 * Send a SCPI command with a variadic argument list.
280 * @param scpi Previously initialized SCPI device structure.
281 * @param format Format string.
282 * @param args Argument list.
284 * @return SR_OK on success, SR_ERR on failure.
286 SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
287 const char *format, va_list args)
293 /* Get length of buffer required. */
294 va_copy(args_copy, args);
295 len = vsnprintf(NULL, 0, format, args_copy);
298 /* Allocate buffer and write out command. */
299 buf = g_malloc0(len + 2);
300 vsprintf(buf, format, args);
301 if (buf[len - 1] != '\n')
305 ret = scpi->send(scpi->priv, buf);
307 /* Free command buffer. */
314 * Begin receiving an SCPI reply.
316 * @param scpi Previously initialised SCPI device structure.
318 * @return SR_OK on success, SR_ERR on failure.
320 SR_PRIV int sr_scpi_read_begin(struct sr_scpi_dev_inst *scpi)
322 return scpi->read_begin(scpi->priv);
326 * Read part of a response from SCPI device.
328 * @param scpi Previously initialised SCPI device structure.
329 * @param buf Buffer to store result.
330 * @param maxlen Maximum number of bytes to read.
332 * @return Number of bytes read, or SR_ERR upon failure.
334 SR_PRIV int sr_scpi_read_data(struct sr_scpi_dev_inst *scpi,
335 char *buf, int maxlen)
337 return scpi->read_data(scpi->priv, buf, maxlen);
341 * Check whether a complete SCPI response has been received.
343 * @param scpi Previously initialised SCPI device structure.
345 * @return 1 if complete, 0 otherwise.
347 SR_PRIV int sr_scpi_read_complete(struct sr_scpi_dev_inst *scpi)
349 return scpi->read_complete(scpi->priv);
355 * @param scpi Previously initialized SCPI device structure.
357 * @return SR_OK on success, SR_ERR on failure.
359 SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi)
361 return scpi->close(scpi);
367 * @param scpi Previously initialized SCPI device structure.
369 * @return SR_OK on success, SR_ERR on failure.
371 SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi)
373 scpi->free(scpi->priv);
379 * Send a SCPI command, receive the reply and store the reply in scpi_response.
381 * @param scpi Previously initialised SCPI device structure.
382 * @param command The SCPI command to send to the device (can be NULL).
383 * @param scpi_response Pointer where to store the SCPI response.
385 * @return SR_OK on success, SR_ERR* on failure.
387 SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
388 const char *command, char **scpi_response)
391 response = g_string_sized_new(1024);
393 if (sr_scpi_get_data(scpi, command, &response) != SR_OK) {
395 g_string_free(response, TRUE);
399 /* Get rid of trailing linefeed if present */
400 if (response->len >= 1 && response->str[response->len - 1] == '\n')
401 g_string_truncate(response, response->len - 1);
403 /* Get rid of trailing carriage return if present */
404 if (response->len >= 1 && response->str[response->len - 1] == '\r')
405 g_string_truncate(response, response->len - 1);
407 sr_spew("Got response: '%.70s', length %" G_GSIZE_FORMAT ".",
408 response->str, response->len);
410 *scpi_response = g_string_free(response, FALSE);
416 * Do a non-blocking read of up to the allocated length, and
417 * check if a timeout has occured.
419 * @param scpi Previously initialised SCPI device structure.
420 * @param response Buffer to which the response is appended.
421 * @param abs_timeout_us Absolute timeout in microseconds
423 * @return read length on success, SR_ERR* on failure.
425 SR_PRIV int sr_scpi_read_response(struct sr_scpi_dev_inst *scpi,
426 GString *response, gint64 abs_timeout_us)
430 space = response->allocated_len - response->len;
431 len = sr_scpi_read_data(scpi, &response->str[response->len], space);
434 sr_err("Incompletely read SCPI response.");
439 g_string_set_size(response, response->len + len);
443 if (g_get_monotonic_time() > abs_timeout_us) {
444 sr_err("Timed out waiting for SCPI response.");
445 return SR_ERR_TIMEOUT;
451 SR_PRIV int sr_scpi_get_data(struct sr_scpi_dev_inst *scpi,
452 const char *command, GString **scpi_response)
459 /* Optionally send caller provided command. */
461 if (sr_scpi_send(scpi, command) != SR_OK)
465 /* Initiate SCPI read operation. */
466 if (sr_scpi_read_begin(scpi) != SR_OK)
469 /* Keep reading until completion or until timeout. */
470 timeout = g_get_monotonic_time() + scpi->read_timeout_us;
472 response = *scpi_response;
474 while (!sr_scpi_read_complete(scpi)) {
475 /* Resize the buffer when free space drops below a threshold. */
476 space = response->allocated_len - response->len;
478 int oldlen = response->len;
479 g_string_set_size(response, oldlen + 1024);
480 g_string_set_size(response, oldlen);
483 /* Read another chunk of the response. */
484 ret = sr_scpi_read_response(scpi, response, timeout);
489 timeout = g_get_monotonic_time() + scpi->read_timeout_us;
496 * Send a SCPI command, read the reply, parse it as a bool value and store the
497 * result in scpi_response.
499 * @param scpi Previously initialised SCPI device structure.
500 * @param command The SCPI command to send to the device (can be NULL).
501 * @param scpi_response Pointer where to store the parsed result.
503 * @return SR_OK on success, SR_ERR* on failure.
505 SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
506 const char *command, gboolean *scpi_response)
513 ret = sr_scpi_get_string(scpi, command, &response);
514 if (ret != SR_OK && !response)
517 if (parse_strict_bool(response, scpi_response) == SR_OK)
528 * Send a SCPI command, read the reply, parse it as an integer and store the
529 * result in scpi_response.
531 * @param scpi Previously initialised SCPI device structure.
532 * @param command The SCPI command to send to the device (can be NULL).
533 * @param scpi_response Pointer where to store the parsed result.
535 * @return SR_OK on success, SR_ERR* on failure.
537 SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
538 const char *command, int *scpi_response)
545 ret = sr_scpi_get_string(scpi, command, &response);
546 if (ret != SR_OK && !response)
549 if (sr_atoi(response, scpi_response) == SR_OK)
560 * Send a SCPI command, read the reply, parse it as a float and store the
561 * result in scpi_response.
563 * @param scpi Previously initialised SCPI device structure.
564 * @param command The SCPI command to send to the device (can be NULL).
565 * @param scpi_response Pointer where to store the parsed result.
567 * @return SR_OK on success, SR_ERR* on failure.
569 SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
570 const char *command, float *scpi_response)
577 ret = sr_scpi_get_string(scpi, command, &response);
578 if (ret != SR_OK && !response)
581 if (sr_atof_ascii(response, scpi_response) == SR_OK)
592 * Send a SCPI command, read the reply, parse it as a double and store the
593 * result in scpi_response.
595 * @param scpi Previously initialised SCPI device structure.
596 * @param command The SCPI command to send to the device (can be NULL).
597 * @param scpi_response Pointer where to store the parsed result.
599 * @return SR_OK on success, SR_ERR* on failure.
601 SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
602 const char *command, double *scpi_response)
609 ret = sr_scpi_get_string(scpi, command, &response);
610 if (ret != SR_OK && !response)
613 if (sr_atod(response, scpi_response) == SR_OK)
624 * Send a SCPI *OPC? command, read the reply and return the result of the
627 * @param scpi Previously initialised SCPI device structure.
629 * @return SR_OK on success, SR_ERR* on failure.
631 SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi)
636 for (i = 0; i < SCPI_READ_RETRIES; i++) {
637 sr_scpi_get_bool(scpi, SCPI_CMD_OPC, &opc);
640 g_usleep(SCPI_READ_RETRY_TIMEOUT_US);
647 * Send a SCPI command, read the reply, parse it as comma separated list of
648 * floats and store the as an result in scpi_response.
650 * @param scpi Previously initialised SCPI device structure.
651 * @param command The SCPI command to send to the device (can be NULL).
652 * @param scpi_response Pointer where to store the parsed result.
654 * @return SR_OK upon successfully parsing all values, SR_ERR* upon a parsing
655 * error or upon no response. The allocated response must be freed by
656 * the caller in the case of an SR_OK as well as in the case of
659 SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
660 const char *command, GArray **scpi_response)
665 gchar **ptr, **tokens;
666 GArray *response_array;
671 ret = sr_scpi_get_string(scpi, command, &response);
672 if (ret != SR_OK && !response)
675 tokens = g_strsplit(response, ",", 0);
678 response_array = g_array_sized_new(TRUE, FALSE, sizeof(float), 256);
681 if (sr_atof_ascii(*ptr, &tmp) == SR_OK)
682 response_array = g_array_append_val(response_array,
692 if (ret != SR_OK && response_array->len == 0) {
693 g_array_free(response_array, TRUE);
694 *scpi_response = NULL;
698 *scpi_response = response_array;
704 * Send a SCPI command, read the reply, parse it as comma separated list of
705 * unsigned 8 bit integers and store the as an result in scpi_response.
707 * @param scpi Previously initialised SCPI device structure.
708 * @param command The SCPI command to send to the device (can be NULL).
709 * @param scpi_response Pointer where to store the parsed result.
711 * @return SR_OK upon successfully parsing all values, SR_ERR* upon a parsing
712 * error or upon no response. The allocated response must be freed by
713 * the caller in the case of an SR_OK as well as in the case of
716 SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
717 const char *command, GArray **scpi_response)
721 gchar **ptr, **tokens;
722 GArray *response_array;
727 ret = sr_scpi_get_string(scpi, command, &response);
728 if (ret != SR_OK && !response)
731 tokens = g_strsplit(response, ",", 0);
734 response_array = g_array_sized_new(TRUE, FALSE, sizeof(uint8_t), 256);
737 if (sr_atoi(*ptr, &tmp) == SR_OK)
738 response_array = g_array_append_val(response_array,
748 if (response_array->len == 0) {
749 g_array_free(response_array, TRUE);
750 *scpi_response = NULL;
754 *scpi_response = response_array;
760 * Send a SCPI command, read the reply, parse it as binary data with a
761 * "definite length block" header and store the as an result in scpi_response.
763 * @param scpi Previously initialised SCPI device structure.
764 * @param command The SCPI command to send to the device (can be NULL).
765 * @param scpi_response Pointer where to store the parsed result.
767 * @return SR_OK upon successfully parsing all values, SR_ERR* upon a parsing
768 * error or upon no response. The allocated response must be freed by
769 * the caller in the case of an SR_OK as well as in the case of
772 SR_PRIV int sr_scpi_get_block(struct sr_scpi_dev_inst *scpi,
773 const char *command, GByteArray **scpi_response)
783 if (sr_scpi_send(scpi, command) != SR_OK)
786 if (sr_scpi_read_begin(scpi) != SR_OK)
790 * Assume an initial maximum length, optionally gets adjusted below.
791 * Prepare a NULL return value for when error paths will be taken.
793 response = g_string_sized_new(1024);
795 timeout = g_get_monotonic_time() + scpi->read_timeout_us;
797 *scpi_response = NULL;
799 /* Get (the first chunk of) the response. */
800 while (response->len < 2) {
801 ret = sr_scpi_read_response(scpi, response, timeout);
803 g_string_free(response, TRUE);
809 * SCPI protocol data blocks are preceeded with a length spec.
810 * The length spec consists of a '#' marker, one digit which
811 * specifies the character count of the length spec, and the
812 * respective number of characters which specify the data block's
813 * length. Raw data bytes follow (thus one must no longer assume
814 * that the received input stream would be an ASCIIZ string).
816 * Get the data block length, and strip off the length spec from
817 * the input buffer, leaving just the data bytes.
819 if (response->str[0] != '#') {
820 g_string_free(response, TRUE);
823 buf[0] = response->str[1];
825 ret = sr_atol(buf, &llen);
826 if ((ret != SR_OK) || (llen == 0)) {
827 g_string_free(response, TRUE);
831 while (response->len < (unsigned long)(2 + llen)) {
832 ret = sr_scpi_read_response(scpi, response, timeout);
834 g_string_free(response, TRUE);
839 memcpy(buf, &response->str[2], llen);
841 ret = sr_atol(buf, &datalen);
842 if ((ret != SR_OK) || (datalen == 0)) {
843 g_string_free(response, TRUE);
846 g_string_erase(response, 0, 2 + llen);
849 * If the initially assumed length does not cover the data block
850 * length, then re-allocate the buffer size to the now known
851 * length, and keep reading more chunks of response data.
853 if (response->len < (unsigned long)(datalen)) {
854 int oldlen = response->len;
855 g_string_set_size(response, datalen);
856 g_string_set_size(response, oldlen);
859 while (response->len < (unsigned long)(datalen)) {
860 ret = sr_scpi_read_response(scpi, response, timeout);
862 g_string_free(response, TRUE);
866 timeout = g_get_monotonic_time() + scpi->read_timeout_us;
869 /* Convert received data to byte array. */
870 *scpi_response = g_byte_array_new_take(
871 (guint8*)g_string_free(response, FALSE), datalen);
877 * Send the *IDN? SCPI command, receive the reply, parse it and store the
878 * reply as a sr_scpi_hw_info structure in the supplied scpi_response pointer.
880 * The hw_info structure must be freed by the caller via sr_scpi_hw_info_free().
882 * @param scpi Previously initialised SCPI device structure.
883 * @param scpi_response Pointer where to store the hw_info structure.
885 * @return SR_OK upon success, SR_ERR* on failure.
887 SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
888 struct sr_scpi_hw_info **scpi_response)
893 struct sr_scpi_hw_info *hw_info;
898 ret = sr_scpi_get_string(scpi, SCPI_CMD_IDN, &response);
899 if (ret != SR_OK && !response)
902 sr_info("Got IDN string: '%s'", response);
905 * The response to a '*IDN?' is specified by the SCPI spec. It contains
906 * a comma-separated list containing the manufacturer name, instrument
907 * model, serial number of the instrument and the firmware version.
909 tokens = g_strsplit(response, ",", 0);
911 for (num_tokens = 0; tokens[num_tokens] != NULL; num_tokens++);
913 if (num_tokens < 4) {
914 sr_dbg("IDN response not according to spec: %80.s.", response);
921 hw_info = g_malloc0(sizeof(struct sr_scpi_hw_info));
922 hw_info->manufacturer = g_strstrip(g_strdup(tokens[0]));
923 hw_info->model = g_strstrip(g_strdup(tokens[1]));
924 hw_info->serial_number = g_strstrip(g_strdup(tokens[2]));
925 hw_info->firmware_version = g_strstrip(g_strdup(tokens[3]));
929 *scpi_response = hw_info;
935 * Free a sr_scpi_hw_info struct.
937 * @param hw_info Pointer to the struct to free.
939 * This function is safe to call with a NULL pointer.
941 SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info)
944 g_free(hw_info->manufacturer);
945 g_free(hw_info->model);
946 g_free(hw_info->serial_number);
947 g_free(hw_info->firmware_version);