2 * This file is part of the libsigrok project.
4 * Copyright (C) 2013 poljar (Damir Jelić) <poljarinho@gmail.com>
5 * Copyright (C) 2015 Bert Vermeulen <bert@biot.com>
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 #include <libsigrok/libsigrok.h>
25 #include "libsigrok-internal.h"
28 #define LOG_PREFIX "scpi"
30 #define SCPI_READ_RETRIES 100
31 #define SCPI_READ_RETRY_TIMEOUT_US (10 * 1000)
33 static const char *scpi_vendors[][2] = {
34 { "Agilent Technologies", "Agilent" },
35 { "CHROMA", "Chroma" },
36 { "Chroma ATE", "Chroma" },
37 { "HEWLETT-PACKARD", "HP" },
38 { "Keysight Technologies", "Keysight" },
39 { "PHILIPS", "Philips" },
40 { "RIGOL TECHNOLOGIES", "Rigol" },
44 * Parse a string representation of a boolean-like value into a gboolean.
45 * Similar to sr_parse_boolstring but rejects strings which do not represent
46 * a boolean-like value.
48 * @param str String to convert.
49 * @param ret Pointer to a gboolean where the result of the conversion will be
52 * @return SR_OK on success, SR_ERR on failure.
54 static int parse_strict_bool(const char *str, gboolean *ret)
59 if (!g_strcmp0(str, "1") ||
60 !g_ascii_strncasecmp(str, "y", 1) ||
61 !g_ascii_strncasecmp(str, "t", 1) ||
62 !g_ascii_strncasecmp(str, "yes", 3) ||
63 !g_ascii_strncasecmp(str, "true", 4) ||
64 !g_ascii_strncasecmp(str, "on", 2)) {
67 } else if (!g_strcmp0(str, "0") ||
68 !g_ascii_strncasecmp(str, "n", 1) ||
69 !g_ascii_strncasecmp(str, "f", 1) ||
70 !g_ascii_strncasecmp(str, "no", 2) ||
71 !g_ascii_strncasecmp(str, "false", 5) ||
72 !g_ascii_strncasecmp(str, "off", 3)) {
80 SR_PRIV extern const struct sr_scpi_dev_inst scpi_serial_dev;
81 SR_PRIV extern const struct sr_scpi_dev_inst scpi_tcp_raw_dev;
82 SR_PRIV extern const struct sr_scpi_dev_inst scpi_tcp_rigol_dev;
83 SR_PRIV extern const struct sr_scpi_dev_inst scpi_usbtmc_libusb_dev;
84 SR_PRIV extern const struct sr_scpi_dev_inst scpi_vxi_dev;
85 SR_PRIV extern const struct sr_scpi_dev_inst scpi_visa_dev;
86 SR_PRIV extern const struct sr_scpi_dev_inst scpi_libgpib_dev;
88 static const struct sr_scpi_dev_inst *scpi_devs[] = {
91 #ifdef HAVE_LIBUSB_1_0
92 &scpi_usbtmc_libusb_dev,
103 #ifdef HAVE_SERIAL_COMM
104 &scpi_serial_dev, /* Must be last as it matches any resource. */
108 static struct sr_dev_inst *sr_scpi_scan_resource(struct drv_context *drvc,
109 const char *resource, const char *serialcomm,
110 struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi))
112 struct sr_scpi_dev_inst *scpi;
113 struct sr_dev_inst *sdi;
115 if (!(scpi = scpi_dev_inst_new(drvc, resource, serialcomm)))
118 if (sr_scpi_open(scpi) != SR_OK) {
119 sr_info("Couldn't open SCPI device.");
124 sdi = probe_device(scpi);
129 sdi->status = SR_ST_INACTIVE;
137 * Send a SCPI command with a variadic argument list without mutex.
139 * @param scpi Previously initialized SCPI device structure.
140 * @param format Format string.
141 * @param args Argument list.
143 * @return SR_OK on success, SR_ERR on failure.
145 static int scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
146 const char *format, va_list args)
152 /* Get length of buffer required. */
153 va_copy(args_copy, args);
154 len = sr_vsnprintf_ascii(NULL, 0, format, args_copy);
157 /* Allocate buffer and write out command. */
158 buf = g_malloc0(len + 2);
159 sr_vsprintf_ascii(buf, format, args);
160 if (buf[len - 1] != '\n')
164 ret = scpi->send(scpi->priv, buf);
166 /* Free command buffer. */
173 * Send a SCPI command without mutex.
175 * @param scpi Previously initialized SCPI device structure.
176 * @param format Format string, to be followed by any necessary arguments.
178 * @return SR_OK on success, SR_ERR on failure.
180 static int scpi_send(struct sr_scpi_dev_inst *scpi, const char *format, ...)
185 va_start(args, format);
186 ret = scpi_send_variadic(scpi, format, args);
193 * Send data to SCPI device without mutex.
195 * TODO: This is only implemented in TcpRaw, but never used.
196 * TODO: Use Mutex at all?
198 * @param scpi Previously initialised SCPI device structure.
199 * @param buf Buffer with data to send.
200 * @param len Number of bytes to send.
202 * @return Number of bytes read, or SR_ERR upon failure.
204 static int scpi_write_data(struct sr_scpi_dev_inst *scpi, char *buf, int maxlen)
206 return scpi->write_data(scpi->priv, buf, maxlen);
210 * Read part of a response from SCPI device without mutex.
212 * @param scpi Previously initialised SCPI device structure.
213 * @param buf Buffer to store result.
214 * @param maxlen Maximum number of bytes to read.
216 * @return Number of bytes read, or SR_ERR upon failure.
218 static int scpi_read_data(struct sr_scpi_dev_inst *scpi, char *buf, int maxlen)
220 return scpi->read_data(scpi->priv, buf, maxlen);
224 * Do a non-blocking read of up to the allocated length, and
225 * check if a timeout has occured, without mutex.
227 * @param scpi Previously initialised SCPI device structure.
228 * @param response Buffer to which the response is appended.
229 * @param abs_timeout_us Absolute timeout in microseconds
231 * @return read length on success, SR_ERR* on failure.
233 static int scpi_read_response(struct sr_scpi_dev_inst *scpi,
234 GString *response, gint64 abs_timeout_us)
238 space = response->allocated_len - response->len;
239 len = scpi->read_data(scpi->priv, &response->str[response->len], space);
242 sr_err("Incompletely read SCPI response.");
247 g_string_set_size(response, response->len + len);
251 if (g_get_monotonic_time() > abs_timeout_us) {
252 sr_err("Timed out waiting for SCPI response.");
253 return SR_ERR_TIMEOUT;
260 * Send a SCPI command, receive the reply and store the reply in
261 * scpi_response, without mutex.
263 * @param scpi Previously initialised SCPI device structure.
264 * @param command The SCPI command to send to the device.
265 * @param scpi_response Pointer where to store the SCPI response.
267 * @return SR_OK on success, SR_ERR on failure.
269 static int scpi_get_data(struct sr_scpi_dev_inst *scpi,
270 const char *command, GString **scpi_response)
277 /* Optionally send caller provided command. */
279 if (scpi_send(scpi, command) != SR_OK)
283 /* Initiate SCPI read operation. */
284 if (sr_scpi_read_begin(scpi) != SR_OK)
287 /* Keep reading until completion or until timeout. */
288 timeout = g_get_monotonic_time() + scpi->read_timeout_us;
290 response = *scpi_response;
292 while (!sr_scpi_read_complete(scpi)) {
293 /* Resize the buffer when free space drops below a threshold. */
294 space = response->allocated_len - response->len;
296 int oldlen = response->len;
297 g_string_set_size(response, oldlen + 1024);
298 g_string_set_size(response, oldlen);
301 /* Read another chunk of the response. */
302 ret = scpi_read_response(scpi, response, timeout);
307 timeout = g_get_monotonic_time() + scpi->read_timeout_us;
313 SR_PRIV GSList *sr_scpi_scan(struct drv_context *drvc, GSList *options,
314 struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi))
316 GSList *resources, *l, *devices;
317 struct sr_dev_inst *sdi;
318 const char *resource = NULL;
319 const char *serialcomm = NULL;
323 for (l = options; l; l = l->next) {
324 struct sr_config *src = l->data;
327 resource = g_variant_get_string(src->data, NULL);
329 case SR_CONF_SERIALCOMM:
330 serialcomm = g_variant_get_string(src->data, NULL);
336 for (i = 0; i < ARRAY_SIZE(scpi_devs); i++) {
337 if ((resource && strcmp(resource, scpi_devs[i]->prefix))
338 || !scpi_devs[i]->scan)
340 resources = scpi_devs[i]->scan(drvc);
341 for (l = resources; l; l = l->next) {
342 res = g_strsplit(l->data, ":", 2);
343 if (res[0] && (sdi = sr_scpi_scan_resource(drvc, res[0],
344 serialcomm ? serialcomm : res[1], probe_device))) {
345 devices = g_slist_append(devices, sdi);
346 sdi->connection_id = g_strdup(l->data);
350 g_slist_free_full(resources, g_free);
353 if (!devices && resource) {
354 sdi = sr_scpi_scan_resource(drvc, resource, serialcomm, probe_device);
356 devices = g_slist_append(NULL, sdi);
359 /* Tack a copy of the newly found devices onto the driver list. */
361 drvc->instances = g_slist_concat(drvc->instances, g_slist_copy(devices));
366 SR_PRIV struct sr_scpi_dev_inst *scpi_dev_inst_new(struct drv_context *drvc,
367 const char *resource, const char *serialcomm)
369 struct sr_scpi_dev_inst *scpi = NULL;
370 const struct sr_scpi_dev_inst *scpi_dev;
374 for (i = 0; i < ARRAY_SIZE(scpi_devs); i++) {
375 scpi_dev = scpi_devs[i];
376 if (!strncmp(resource, scpi_dev->prefix, strlen(scpi_dev->prefix))) {
377 sr_dbg("Opening %s device %s.", scpi_dev->name, resource);
378 scpi = g_malloc(sizeof(*scpi));
380 scpi->priv = g_malloc0(scpi->priv_size);
381 scpi->read_timeout_us = 1000 * 1000;
382 params = g_strsplit(resource, "/", 0);
383 if (scpi->dev_inst_new(scpi->priv, drvc, resource,
384 params, serialcomm) != SR_OK) {
399 * @param scpi Previously initialized SCPI device structure.
401 * @return SR_OK on success, SR_ERR on failure.
403 SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi)
405 g_mutex_init(&scpi->scpi_mutex);
407 return scpi->open(scpi);
411 * Get the connection ID of the SCPI device.
413 * Callers must free the allocated memory regardless of the routine's
414 * return code. See @ref g_free().
416 * @param[in] scpi Previously initialized SCPI device structure.
417 * @param[out] connection_id Pointer where to store the connection ID.
419 * @return SR_OK on success, SR_ERR on failure.
421 SR_PRIV int sr_scpi_connection_id(struct sr_scpi_dev_inst *scpi,
422 char **connection_id)
424 return scpi->connection_id(scpi, connection_id);
428 * Add an event source for an SCPI device.
430 * @param session The session to add the event source to.
431 * @param scpi Previously initialized SCPI device structure.
432 * @param events Events to check for.
433 * @param timeout Max time to wait before the callback is called, ignored if 0.
434 * @param cb Callback function to add. Must not be NULL.
435 * @param cb_data Data for the callback function. Can be NULL.
437 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
438 * SR_ERR_MALLOC upon memory allocation errors.
440 SR_PRIV int sr_scpi_source_add(struct sr_session *session,
441 struct sr_scpi_dev_inst *scpi, int events, int timeout,
442 sr_receive_data_callback cb, void *cb_data)
444 return scpi->source_add(session, scpi->priv, events, timeout, cb, cb_data);
448 * Remove event source for an SCPI device.
450 * @param session The session to remove the event source from.
451 * @param scpi Previously initialized SCPI device structure.
453 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
454 * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
457 SR_PRIV int sr_scpi_source_remove(struct sr_session *session,
458 struct sr_scpi_dev_inst *scpi)
460 return scpi->source_remove(session, scpi->priv);
464 * Send a SCPI command.
466 * @param scpi Previously initialized SCPI device structure.
467 * @param format Format string, to be followed by any necessary arguments.
469 * @return SR_OK on success, SR_ERR on failure.
471 SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi,
472 const char *format, ...)
477 va_start(args, format);
478 g_mutex_lock(&scpi->scpi_mutex);
479 ret = scpi_send_variadic(scpi, format, args);
480 g_mutex_unlock(&scpi->scpi_mutex);
487 * Send a SCPI command with a variadic argument list.
489 * @param scpi Previously initialized SCPI device structure.
490 * @param format Format string.
491 * @param args Argument list.
493 * @return SR_OK on success, SR_ERR on failure.
495 SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
496 const char *format, va_list args)
500 g_mutex_lock(&scpi->scpi_mutex);
501 ret = scpi_send_variadic(scpi, format, args);
502 g_mutex_unlock(&scpi->scpi_mutex);
508 * Begin receiving an SCPI reply.
510 * @param scpi Previously initialised SCPI device structure.
512 * @return SR_OK on success, SR_ERR on failure.
514 SR_PRIV int sr_scpi_read_begin(struct sr_scpi_dev_inst *scpi)
516 return scpi->read_begin(scpi->priv);
520 * Read part of a response from SCPI device.
522 * @param scpi Previously initialised SCPI device structure.
523 * @param buf Buffer to store result.
524 * @param maxlen Maximum number of bytes to read.
526 * @return Number of bytes read, or SR_ERR upon failure.
528 SR_PRIV int sr_scpi_read_data(struct sr_scpi_dev_inst *scpi,
529 char *buf, int maxlen)
533 g_mutex_lock(&scpi->scpi_mutex);
534 ret = scpi_read_data(scpi, buf, maxlen);
535 g_mutex_unlock(&scpi->scpi_mutex);
541 * Send data to SCPI device.
543 * TODO: This is only implemented in TcpRaw, but never used.
544 * TODO: Use Mutex at all?
546 * @param scpi Previously initialised SCPI device structure.
547 * @param buf Buffer with data to send.
548 * @param len Number of bytes to send.
550 * @return Number of bytes read, or SR_ERR upon failure.
552 SR_PRIV int sr_scpi_write_data(struct sr_scpi_dev_inst *scpi,
553 char *buf, int maxlen)
557 g_mutex_lock(&scpi->scpi_mutex);
558 ret = scpi_write_data(scpi, buf, maxlen);
559 g_mutex_unlock(&scpi->scpi_mutex);
565 * Check whether a complete SCPI response has been received.
567 * @param scpi Previously initialised SCPI device structure.
569 * @return 1 if complete, 0 otherwise.
571 SR_PRIV int sr_scpi_read_complete(struct sr_scpi_dev_inst *scpi)
573 return scpi->read_complete(scpi->priv);
579 * @param scpi Previously initialized SCPI device structure.
581 * @return SR_OK on success, SR_ERR on failure.
583 SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi)
587 g_mutex_lock(&scpi->scpi_mutex);
588 ret = scpi->close(scpi);
589 g_mutex_unlock(&scpi->scpi_mutex);
590 g_mutex_clear(&scpi->scpi_mutex);
598 * @param scpi Previously initialized SCPI device structure. If NULL,
599 * this function does nothing.
601 SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi)
606 scpi->free(scpi->priv);
608 g_free(scpi->actual_channel_name);
613 * Send a SCPI command, receive the reply and store the reply in scpi_response.
615 * Callers must free the allocated memory regardless of the routine's
616 * return code. See @ref g_free().
618 * @param[in] scpi Previously initialised SCPI device structure.
619 * @param[in] command The SCPI command to send to the device (can be NULL).
620 * @param[out] scpi_response Pointer where to store the SCPI response.
622 * @return SR_OK on success, SR_ERR* on failure.
624 SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
625 const char *command, char **scpi_response)
629 *scpi_response = NULL;
631 response = g_string_sized_new(1024);
632 if (sr_scpi_get_data(scpi, command, &response) != SR_OK) {
634 g_string_free(response, TRUE);
638 /* Get rid of trailing linefeed if present */
639 if (response->len >= 1 && response->str[response->len - 1] == '\n')
640 g_string_truncate(response, response->len - 1);
642 /* Get rid of trailing carriage return if present */
643 if (response->len >= 1 && response->str[response->len - 1] == '\r')
644 g_string_truncate(response, response->len - 1);
646 sr_spew("Got response: '%.70s', length %" G_GSIZE_FORMAT ".",
647 response->str, response->len);
649 *scpi_response = g_string_free(response, FALSE);
655 * Do a non-blocking read of up to the allocated length, and
656 * check if a timeout has occured.
658 * @param scpi Previously initialised SCPI device structure.
659 * @param response Buffer to which the response is appended.
660 * @param abs_timeout_us Absolute timeout in microseconds
662 * @return read length on success, SR_ERR* on failure.
664 SR_PRIV int sr_scpi_read_response(struct sr_scpi_dev_inst *scpi,
665 GString *response, gint64 abs_timeout_us)
669 g_mutex_lock(&scpi->scpi_mutex);
670 ret = scpi_read_response(scpi, response, abs_timeout_us);
671 g_mutex_unlock(&scpi->scpi_mutex);
676 SR_PRIV int sr_scpi_get_data(struct sr_scpi_dev_inst *scpi,
677 const char *command, GString **scpi_response)
681 g_mutex_lock(&scpi->scpi_mutex);
682 ret = scpi_get_data(scpi, command, scpi_response);
683 g_mutex_unlock(&scpi->scpi_mutex);
689 * Send a SCPI command, read the reply, parse it as a bool value and store the
690 * result in scpi_response.
692 * @param scpi Previously initialised SCPI device structure.
693 * @param command The SCPI command to send to the device (can be NULL).
694 * @param scpi_response Pointer where to store the parsed result.
696 * @return SR_OK on success, SR_ERR* on failure.
698 SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
699 const char *command, gboolean *scpi_response)
706 ret = sr_scpi_get_string(scpi, command, &response);
707 if (ret != SR_OK && !response)
710 if (parse_strict_bool(response, scpi_response) == SR_OK)
721 * Send a SCPI command, read the reply, parse it as an integer and store the
722 * result in scpi_response.
724 * @param scpi Previously initialised SCPI device structure.
725 * @param command The SCPI command to send to the device (can be NULL).
726 * @param scpi_response Pointer where to store the parsed result.
728 * @return SR_OK on success, SR_ERR* on failure.
730 SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
731 const char *command, int *scpi_response)
734 struct sr_rational ret_rational;
739 ret = sr_scpi_get_string(scpi, command, &response);
740 if (ret != SR_OK && !response)
743 ret = sr_parse_rational(response, &ret_rational);
744 if (ret == SR_OK && (ret_rational.p % ret_rational.q) == 0) {
745 *scpi_response = ret_rational.p / ret_rational.q;
747 sr_dbg("get_int: non-integer rational=%" PRId64 "/%" PRIu64,
748 ret_rational.p, ret_rational.q);
758 * Send a SCPI command, read the reply, parse it as a float and store the
759 * result in scpi_response.
761 * @param scpi Previously initialised SCPI device structure.
762 * @param command The SCPI command to send to the device (can be NULL).
763 * @param scpi_response Pointer where to store the parsed result.
765 * @return SR_OK on success, SR_ERR* on failure.
767 SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
768 const char *command, float *scpi_response)
775 ret = sr_scpi_get_string(scpi, command, &response);
776 if (ret != SR_OK && !response)
779 if (sr_atof_ascii(response, scpi_response) == SR_OK)
790 * Send a SCPI command, read the reply, parse it as a double and store the
791 * result in scpi_response.
793 * @param scpi Previously initialised SCPI device structure.
794 * @param command The SCPI command to send to the device (can be NULL).
795 * @param scpi_response Pointer where to store the parsed result.
797 * @return SR_OK on success, SR_ERR* on failure.
799 SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
800 const char *command, double *scpi_response)
807 ret = sr_scpi_get_string(scpi, command, &response);
808 if (ret != SR_OK && !response)
811 if (sr_atod_ascii(response, scpi_response) == SR_OK)
822 * Send a SCPI *OPC? command, read the reply and return the result of the
825 * @param scpi Previously initialised SCPI device structure.
827 * @return SR_OK on success, SR_ERR* on failure.
829 SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi)
834 for (i = 0; i < SCPI_READ_RETRIES; i++) {
836 sr_scpi_get_bool(scpi, SCPI_CMD_OPC, &opc);
839 g_usleep(SCPI_READ_RETRY_TIMEOUT_US);
846 * Send a SCPI command, read the reply, parse it as comma separated list of
847 * floats and store the as an result in scpi_response.
849 * Callers must free the allocated memory (unless it's NULL) regardless of
850 * the routine's return code. See @ref g_array_free().
852 * @param[in] scpi Previously initialised SCPI device structure.
853 * @param[in] command The SCPI command to send to the device (can be NULL).
854 * @param[out] scpi_response Pointer where to store the parsed result.
856 * @return SR_OK upon successfully parsing all values, SR_ERR* upon a parsing
857 * error or upon no response.
859 SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
860 const char *command, GArray **scpi_response)
865 gchar **ptr, **tokens;
866 GArray *response_array;
868 *scpi_response = NULL;
872 ret = sr_scpi_get_string(scpi, command, &response);
873 if (ret != SR_OK && !response)
876 tokens = g_strsplit(response, ",", 0);
879 response_array = g_array_sized_new(TRUE, FALSE, sizeof(float), 256);
882 if (sr_atof_ascii(*ptr, &tmp) == SR_OK)
883 response_array = g_array_append_val(response_array,
893 if (ret != SR_OK && response_array->len == 0) {
894 g_array_free(response_array, TRUE);
898 *scpi_response = response_array;
904 * Send a SCPI command, read the reply, parse it as comma separated list of
905 * unsigned 8 bit integers and store the as an result in scpi_response.
907 * Callers must free the allocated memory (unless it's NULL) regardless of
908 * the routine's return code. See @ref g_array_free().
910 * @param[in] scpi Previously initialised SCPI device structure.
911 * @param[in] command The SCPI command to send to the device (can be NULL).
912 * @param[out] scpi_response Pointer where to store the parsed result.
914 * @return SR_OK upon successfully parsing all values, SR_ERR* upon a parsing
915 * error or upon no response.
917 SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
918 const char *command, GArray **scpi_response)
922 gchar **ptr, **tokens;
923 GArray *response_array;
925 *scpi_response = NULL;
929 ret = sr_scpi_get_string(scpi, command, &response);
930 if (ret != SR_OK && !response)
933 tokens = g_strsplit(response, ",", 0);
936 response_array = g_array_sized_new(TRUE, FALSE, sizeof(uint8_t), 256);
939 if (sr_atoi(*ptr, &tmp) == SR_OK)
940 response_array = g_array_append_val(response_array,
950 if (response_array->len == 0) {
951 g_array_free(response_array, TRUE);
955 *scpi_response = response_array;
961 * Send a SCPI command, read the reply, parse it as binary data with a
962 * "definite length block" header and store the as an result in scpi_response.
964 * Callers must free the allocated memory (unless it's NULL) regardless of
965 * the routine's return code. See @ref g_byte_array_free().
967 * @param[in] scpi Previously initialised SCPI device structure.
968 * @param[in] command The SCPI command to send to the device (can be NULL).
969 * @param[out] scpi_response Pointer where to store the parsed result.
971 * @return SR_OK upon successfully parsing all values, SR_ERR* upon a parsing
972 * error or upon no response.
974 SR_PRIV int sr_scpi_get_block(struct sr_scpi_dev_inst *scpi,
975 const char *command, GByteArray **scpi_response)
985 *scpi_response = NULL;
987 g_mutex_lock(&scpi->scpi_mutex);
990 if (scpi_send(scpi, command) != SR_OK) {
991 g_mutex_unlock(&scpi->scpi_mutex);
995 if (sr_scpi_read_begin(scpi) != SR_OK) {
996 g_mutex_unlock(&scpi->scpi_mutex);
1001 * Assume an initial maximum length, optionally gets adjusted below.
1002 * Prepare a NULL return value for when error paths will be taken.
1004 response = g_string_sized_new(1024);
1006 timeout = g_get_monotonic_time() + scpi->read_timeout_us;
1008 /* Get (the first chunk of) the response. */
1010 ret = scpi_read_response(scpi, response, timeout);
1012 g_mutex_unlock(&scpi->scpi_mutex);
1013 g_string_free(response, TRUE);
1016 } while (response->len < 2);
1019 * SCPI protocol data blocks are preceeded with a length spec.
1020 * The length spec consists of a '#' marker, one digit which
1021 * specifies the character count of the length spec, and the
1022 * respective number of characters which specify the data block's
1023 * length. Raw data bytes follow (thus one must no longer assume
1024 * that the received input stream would be an ASCIIZ string).
1026 * Get the data block length, and strip off the length spec from
1027 * the input buffer, leaving just the data bytes.
1029 if (response->str[0] != '#') {
1030 g_mutex_unlock(&scpi->scpi_mutex);
1031 g_string_free(response, TRUE);
1034 buf[0] = response->str[1];
1036 ret = sr_atol(buf, &llen);
1037 if ((ret != SR_OK) || (llen == 0)) {
1038 g_mutex_unlock(&scpi->scpi_mutex);
1039 g_string_free(response, TRUE);
1043 while (response->len < (unsigned long)(2 + llen)) {
1044 ret = scpi_read_response(scpi, response, timeout);
1046 g_mutex_unlock(&scpi->scpi_mutex);
1047 g_string_free(response, TRUE);
1052 memcpy(buf, &response->str[2], llen);
1054 ret = sr_atol(buf, &datalen);
1055 if ((ret != SR_OK) || (datalen == 0)) {
1056 g_mutex_unlock(&scpi->scpi_mutex);
1057 g_string_free(response, TRUE);
1060 g_string_erase(response, 0, 2 + llen);
1063 * Re-allocate the buffer size to the now known length
1064 * and keep reading more chunks of response data.
1066 oldlen = response->len;
1067 g_string_set_size(response, datalen);
1068 g_string_set_size(response, oldlen);
1070 if (oldlen < (unsigned long)(datalen)) {
1072 oldlen = response->len;
1073 ret = scpi_read_response(scpi, response, timeout);
1075 /* On timeout truncate the buffer and send the partial response
1076 * instead of getting stuck on timeouts...
1078 if (ret == SR_ERR_TIMEOUT) {
1083 g_mutex_unlock(&scpi->scpi_mutex);
1084 g_string_free(response, TRUE);
1088 timeout = g_get_monotonic_time() + scpi->read_timeout_us;
1089 } while (response->len < (unsigned long)(datalen));
1092 g_mutex_unlock(&scpi->scpi_mutex);
1094 /* Convert received data to byte array. */
1095 *scpi_response = g_byte_array_new_take(
1096 (guint8*)g_string_free(response, FALSE), datalen);
1102 * Send the *IDN? SCPI command, receive the reply, parse it and store the
1103 * reply as a sr_scpi_hw_info structure in the supplied scpi_response pointer.
1105 * Callers must free the allocated memory regardless of the routine's
1106 * return code. See @ref sr_scpi_hw_info_free().
1108 * @param[in] scpi Previously initialised SCPI device structure.
1109 * @param[out] scpi_response Pointer where to store the hw_info structure.
1111 * @return SR_OK upon success, SR_ERR* on failure.
1113 SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
1114 struct sr_scpi_hw_info **scpi_response)
1116 int num_tokens, ret;
1119 struct sr_scpi_hw_info *hw_info;
1122 *scpi_response = NULL;
1126 ret = sr_scpi_get_string(scpi, SCPI_CMD_IDN, &response);
1127 if (ret != SR_OK && !response)
1131 * The response to a '*IDN?' is specified by the SCPI spec. It contains
1132 * a comma-separated list containing the manufacturer name, instrument
1133 * model, serial number of the instrument and the firmware version.
1135 * BEWARE! Although strictly speaking a smaller field count is invalid,
1136 * this implementation also accepts IDN responses with one field less,
1137 * and assumes that the serial number is missing. Some GWInstek DMMs
1138 * were found to do this. Keep warning about this condition, which may
1139 * need more consideration later.
1141 tokens = g_strsplit(response, ",", 0);
1142 num_tokens = g_strv_length(tokens);
1143 if (num_tokens < 3) {
1144 sr_dbg("IDN response not according to spec: '%s'", response);
1149 if (num_tokens < 4) {
1150 sr_warn("Short IDN response, assume missing serial number.");
1154 hw_info = g_malloc0(sizeof(struct sr_scpi_hw_info));
1156 idn_substr = g_strstr_len(tokens[0], -1, "IDN ");
1157 if (idn_substr == NULL)
1158 hw_info->manufacturer = g_strstrip(g_strdup(tokens[0]));
1160 hw_info->manufacturer = g_strstrip(g_strdup(idn_substr + 4));
1162 hw_info->model = g_strstrip(g_strdup(tokens[1]));
1163 if (num_tokens < 4) {
1164 hw_info->serial_number = g_strdup("Unknown");
1165 hw_info->firmware_version = g_strstrip(g_strdup(tokens[2]));
1167 hw_info->serial_number = g_strstrip(g_strdup(tokens[2]));
1168 hw_info->firmware_version = g_strstrip(g_strdup(tokens[3]));
1173 *scpi_response = hw_info;
1179 * Free a sr_scpi_hw_info struct.
1181 * @param hw_info Pointer to the struct to free. If NULL, this
1182 * function does nothing.
1184 SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info)
1189 g_free(hw_info->manufacturer);
1190 g_free(hw_info->model);
1191 g_free(hw_info->serial_number);
1192 g_free(hw_info->firmware_version);
1197 * Remove potentially enclosing pairs of quotes, un-escape content.
1198 * This implementation modifies the caller's buffer when quotes are found
1199 * and doubled quote characters need to get removed from the content.
1201 * @param[in, out] s The SCPI string to check and un-quote.
1203 * @return The start of the un-quoted string.
1205 SR_PRIV const char *sr_scpi_unquote_string(char *s)
1211 /* Immediately bail out on invalid or short input. */
1218 /* Check for matching quote characters front and back. */
1219 if (s[0] != '\'' && s[0] != '"')
1221 if (s[0] != s[s_len - 1])
1224 /* Need to strip quotes, and un-double quote chars inside. */
1225 quotes[0] = quotes[1] = *s;
1227 s[s_len - 1] = '\0';
1230 while ((rdptr = strstr(rdptr, quotes)) != NULL) {
1231 memmove(rdptr, rdptr + 1, strlen(rdptr));
1238 SR_PRIV const char *sr_vendor_alias(const char *raw_vendor)
1242 for (i = 0; i < ARRAY_SIZE(scpi_vendors); i++) {
1243 if (!g_ascii_strcasecmp(raw_vendor, scpi_vendors[i][0]))
1244 return scpi_vendors[i][1];
1250 SR_PRIV const char *sr_scpi_cmd_get(const struct scpi_command *cmdtable,
1260 for (i = 0; cmdtable[i].string; i++) {
1261 if (cmdtable[i].command == command) {
1262 cmd = cmdtable[i].string;
1270 SR_PRIV int sr_scpi_cmd(const struct sr_dev_inst *sdi,
1271 const struct scpi_command *cmdtable,
1272 int channel_command, const char *channel_name,
1275 struct sr_scpi_dev_inst *scpi;
1278 const char *channel_cmd;
1283 if (!(cmd = sr_scpi_cmd_get(cmdtable, command))) {
1284 /* Device does not implement this command, that's OK. */
1288 g_mutex_lock(&scpi->scpi_mutex);
1290 /* Select channel. */
1291 channel_cmd = sr_scpi_cmd_get(cmdtable, channel_command);
1292 if (channel_cmd && channel_name &&
1293 g_strcmp0(channel_name, scpi->actual_channel_name)) {
1294 sr_spew("sr_scpi_cmd(): new channel = %s", channel_name);
1295 g_free(scpi->actual_channel_name);
1296 scpi->actual_channel_name = g_strdup(channel_name);
1297 ret = scpi_send(scpi, channel_cmd, channel_name);
1302 va_start(args, command);
1303 ret = scpi_send_variadic(scpi, cmd, args);
1306 g_mutex_unlock(&scpi->scpi_mutex);
1311 SR_PRIV int sr_scpi_cmd_resp(const struct sr_dev_inst *sdi,
1312 const struct scpi_command *cmdtable,
1313 int channel_command, const char *channel_name,
1314 GVariant **gvar, const GVariantType *gvtype, int command, ...)
1316 struct sr_scpi_dev_inst *scpi;
1318 const char *channel_cmd;
1328 if (!(cmd = sr_scpi_cmd_get(cmdtable, command))) {
1329 /* Device does not implement this command. */
1333 g_mutex_lock(&scpi->scpi_mutex);
1335 /* Select channel. */
1336 channel_cmd = sr_scpi_cmd_get(cmdtable, channel_command);
1337 if (channel_cmd && channel_name &&
1338 g_strcmp0(channel_name, scpi->actual_channel_name)) {
1339 sr_spew("sr_scpi_cmd_get(): new channel = %s", channel_name);
1340 g_free(scpi->actual_channel_name);
1341 scpi->actual_channel_name = g_strdup(channel_name);
1342 ret = scpi_send(scpi, channel_cmd, channel_name);
1347 va_start(args, command);
1348 ret = scpi_send_variadic(scpi, cmd, args);
1351 g_mutex_unlock(&scpi->scpi_mutex);
1355 response = g_string_sized_new(1024);
1356 ret = scpi_get_data(scpi, NULL, &response);
1358 g_mutex_unlock(&scpi->scpi_mutex);
1360 g_string_free(response, TRUE);
1364 g_mutex_unlock(&scpi->scpi_mutex);
1366 /* Get rid of trailing linefeed if present */
1367 if (response->len >= 1 && response->str[response->len - 1] == '\n')
1368 g_string_truncate(response, response->len - 1);
1370 /* Get rid of trailing carriage return if present */
1371 if (response->len >= 1 && response->str[response->len - 1] == '\r')
1372 g_string_truncate(response, response->len - 1);
1374 s = g_string_free(response, FALSE);
1377 if (g_variant_type_equal(gvtype, G_VARIANT_TYPE_BOOLEAN)) {
1378 if ((ret = parse_strict_bool(s, &b)) == SR_OK)
1379 *gvar = g_variant_new_boolean(b);
1380 } else if (g_variant_type_equal(gvtype, G_VARIANT_TYPE_DOUBLE)) {
1381 if ((ret = sr_atod_ascii(s, &d)) == SR_OK)
1382 *gvar = g_variant_new_double(d);
1383 } else if (g_variant_type_equal(gvtype, G_VARIANT_TYPE_STRING)) {
1384 *gvar = g_variant_new_string(s);
1386 sr_err("Unable to convert to desired GVariant type.");