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" },
41 { "Siglent Technologies", "Siglent" },
45 * Parse a string representation of a boolean-like value into a gboolean.
46 * Similar to sr_parse_boolstring but rejects strings which do not represent
47 * a boolean-like value.
49 * @param str String to convert.
50 * @param ret Pointer to a gboolean where the result of the conversion will be
53 * @return SR_OK on success, SR_ERR on failure.
55 static int parse_strict_bool(const char *str, gboolean *ret)
60 if (!g_strcmp0(str, "1") ||
61 !g_ascii_strncasecmp(str, "y", 1) ||
62 !g_ascii_strncasecmp(str, "t", 1) ||
63 !g_ascii_strncasecmp(str, "yes", 3) ||
64 !g_ascii_strncasecmp(str, "true", 4) ||
65 !g_ascii_strncasecmp(str, "on", 2)) {
68 } else if (!g_strcmp0(str, "0") ||
69 !g_ascii_strncasecmp(str, "n", 1) ||
70 !g_ascii_strncasecmp(str, "f", 1) ||
71 !g_ascii_strncasecmp(str, "no", 2) ||
72 !g_ascii_strncasecmp(str, "false", 5) ||
73 !g_ascii_strncasecmp(str, "off", 3)) {
81 SR_PRIV extern const struct sr_scpi_dev_inst scpi_serial_dev;
82 SR_PRIV extern const struct sr_scpi_dev_inst scpi_tcp_raw_dev;
83 SR_PRIV extern const struct sr_scpi_dev_inst scpi_tcp_rigol_dev;
84 SR_PRIV extern const struct sr_scpi_dev_inst scpi_usbtmc_libusb_dev;
85 SR_PRIV extern const struct sr_scpi_dev_inst scpi_vxi_dev;
86 SR_PRIV extern const struct sr_scpi_dev_inst scpi_visa_dev;
87 SR_PRIV extern const struct sr_scpi_dev_inst scpi_libgpib_dev;
89 static const struct sr_scpi_dev_inst *scpi_devs[] = {
92 #ifdef HAVE_LIBUSB_1_0
93 &scpi_usbtmc_libusb_dev,
104 #ifdef HAVE_SERIAL_COMM
105 &scpi_serial_dev, /* Must be last as it matches any resource. */
109 static struct sr_dev_inst *sr_scpi_scan_resource(struct drv_context *drvc,
110 const char *resource, const char *serialcomm,
111 struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi))
113 struct sr_scpi_dev_inst *scpi;
114 struct sr_dev_inst *sdi;
116 if (!(scpi = scpi_dev_inst_new(drvc, resource, serialcomm)))
119 if (sr_scpi_open(scpi) != SR_OK) {
120 sr_info("Couldn't open SCPI device.");
125 sdi = probe_device(scpi);
130 sdi->status = SR_ST_INACTIVE;
138 * Send a SCPI command with a variadic argument list without mutex.
140 * @param scpi Previously initialized SCPI device structure.
141 * @param format Format string.
142 * @param args Argument list.
144 * @return SR_OK on success, SR_ERR on failure.
146 static int scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
147 const char *format, va_list args)
153 /* Get length of buffer required. */
154 va_copy(args_copy, args);
155 len = sr_vsnprintf_ascii(NULL, 0, format, args_copy);
158 /* Allocate buffer and write out command. */
159 buf = g_malloc0(len + 2);
160 sr_vsprintf_ascii(buf, format, args);
161 if (buf[len - 1] != '\n')
165 ret = scpi->send(scpi->priv, buf);
167 /* Free command buffer. */
174 * Send a SCPI command without mutex.
176 * @param scpi Previously initialized SCPI device structure.
177 * @param format Format string, to be followed by any necessary arguments.
179 * @return SR_OK on success, SR_ERR on failure.
181 static int scpi_send(struct sr_scpi_dev_inst *scpi, const char *format, ...)
186 va_start(args, format);
187 ret = scpi_send_variadic(scpi, format, args);
194 * Send data to SCPI device without mutex.
196 * TODO: This is only implemented in TcpRaw, but never used.
197 * TODO: Use Mutex at all?
199 * @param scpi Previously initialised SCPI device structure.
200 * @param buf Buffer with data to send.
201 * @param len Number of bytes to send.
203 * @return Number of bytes read, or SR_ERR upon failure.
205 static int scpi_write_data(struct sr_scpi_dev_inst *scpi, char *buf, int maxlen)
207 return scpi->write_data(scpi->priv, buf, maxlen);
211 * Read part of a response from SCPI device without mutex.
213 * @param scpi Previously initialised SCPI device structure.
214 * @param buf Buffer to store result.
215 * @param maxlen Maximum number of bytes to read.
217 * @return Number of bytes read, or SR_ERR upon failure.
219 static int scpi_read_data(struct sr_scpi_dev_inst *scpi, char *buf, int maxlen)
221 return scpi->read_data(scpi->priv, buf, maxlen);
225 * Do a non-blocking read of up to the allocated length, and
226 * check if a timeout has occured, without mutex.
228 * @param scpi Previously initialised SCPI device structure.
229 * @param response Buffer to which the response is appended.
230 * @param abs_timeout_us Absolute timeout in microseconds
232 * @return read length on success, SR_ERR* on failure.
234 static int scpi_read_response(struct sr_scpi_dev_inst *scpi,
235 GString *response, gint64 abs_timeout_us)
239 space = response->allocated_len - response->len;
240 len = scpi->read_data(scpi->priv, &response->str[response->len], space);
243 sr_err("Incompletely read SCPI response.");
248 g_string_set_size(response, response->len + len);
252 if (g_get_monotonic_time() > abs_timeout_us) {
253 sr_err("Timed out waiting for SCPI response.");
254 return SR_ERR_TIMEOUT;
261 * Send a SCPI command, receive the reply and store the reply in
262 * scpi_response, without mutex.
264 * @param scpi Previously initialised SCPI device structure.
265 * @param command The SCPI command to send to the device.
266 * @param scpi_response Pointer where to store the SCPI response.
268 * @return SR_OK on success, SR_ERR on failure.
270 static int scpi_get_data(struct sr_scpi_dev_inst *scpi,
271 const char *command, GString **scpi_response)
278 /* Optionally send caller provided command. */
280 if (scpi_send(scpi, command) != SR_OK)
284 /* Initiate SCPI read operation. */
285 if (sr_scpi_read_begin(scpi) != SR_OK)
288 /* Keep reading until completion or until timeout. */
289 timeout = g_get_monotonic_time() + scpi->read_timeout_us;
291 response = *scpi_response;
293 while (!sr_scpi_read_complete(scpi)) {
294 /* Resize the buffer when free space drops below a threshold. */
295 space = response->allocated_len - response->len;
297 int oldlen = response->len;
298 g_string_set_size(response, oldlen + 1024);
299 g_string_set_size(response, oldlen);
302 /* Read another chunk of the response. */
303 ret = scpi_read_response(scpi, response, timeout);
308 timeout = g_get_monotonic_time() + scpi->read_timeout_us;
314 SR_PRIV GSList *sr_scpi_scan(struct drv_context *drvc, GSList *options,
315 struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi))
317 GSList *resources, *l, *devices;
318 struct sr_dev_inst *sdi;
319 const char *resource, *conn;
320 const char *serialcomm, *comm;
326 (void)sr_serial_extract_options(options, &resource, &serialcomm);
329 for (i = 0; i < ARRAY_SIZE(scpi_devs); i++) {
330 if (resource && strcmp(resource, scpi_devs[i]->prefix) != 0)
332 if (!scpi_devs[i]->scan)
334 resources = scpi_devs[i]->scan(drvc);
335 for (l = resources; l; l = l->next) {
336 res = g_strsplit(l->data, ":", 2);
342 comm = serialcomm ? : res[1];
343 sdi = sr_scpi_scan_resource(drvc, conn, comm, 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;
867 GArray *response_array;
869 *scpi_response = NULL;
872 ret = sr_scpi_get_string(scpi, command, &response);
873 if (ret != SR_OK && !response)
876 tokens = g_strsplit(response, ",", 0);
877 token_count = g_strv_length(tokens);
879 response_array = g_array_sized_new(TRUE, FALSE,
880 sizeof(float), token_count + 1);
884 ret = sr_atof_ascii(*ptr, &tmp);
889 response_array = g_array_append_val(response_array, tmp);
895 if (ret != SR_OK && response_array->len == 0) {
896 g_array_free(response_array, TRUE);
900 *scpi_response = response_array;
906 * Send a SCPI command, read the reply, parse it as comma separated list of
907 * unsigned 8 bit integers and store the as an result in scpi_response.
909 * Callers must free the allocated memory (unless it's NULL) regardless of
910 * the routine's return code. See @ref g_array_free().
912 * @param[in] scpi Previously initialised SCPI device structure.
913 * @param[in] command The SCPI command to send to the device (can be NULL).
914 * @param[out] scpi_response Pointer where to store the parsed result.
916 * @return SR_OK upon successfully parsing all values, SR_ERR* upon a parsing
917 * error or upon no response.
919 SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
920 const char *command, GArray **scpi_response)
924 gchar **ptr, **tokens;
926 GArray *response_array;
928 *scpi_response = NULL;
931 ret = sr_scpi_get_string(scpi, command, &response);
932 if (ret != SR_OK && !response)
935 tokens = g_strsplit(response, ",", 0);
936 token_count = g_strv_length(tokens);
938 response_array = g_array_sized_new(TRUE, FALSE,
939 sizeof(uint8_t), token_count + 1);
943 ret = sr_atoi(*ptr, &tmp);
948 response_array = g_array_append_val(response_array, tmp);
954 if (response_array->len == 0) {
955 g_array_free(response_array, TRUE);
959 *scpi_response = response_array;
965 * Send a SCPI command, read the reply, parse it as binary data with a
966 * "definite length block" header and store the as an result in scpi_response.
968 * Callers must free the allocated memory (unless it's NULL) regardless of
969 * the routine's return code. See @ref g_byte_array_free().
971 * @param[in] scpi Previously initialised SCPI device structure.
972 * @param[in] command The SCPI command to send to the device (can be NULL).
973 * @param[out] scpi_response Pointer where to store the parsed result.
975 * @return SR_OK upon successfully parsing all values, SR_ERR* upon a parsing
976 * error or upon no response.
978 SR_PRIV int sr_scpi_get_block(struct sr_scpi_dev_inst *scpi,
979 const char *command, GByteArray **scpi_response)
989 *scpi_response = NULL;
991 g_mutex_lock(&scpi->scpi_mutex);
994 if (scpi_send(scpi, command) != SR_OK) {
995 g_mutex_unlock(&scpi->scpi_mutex);
999 if (sr_scpi_read_begin(scpi) != SR_OK) {
1000 g_mutex_unlock(&scpi->scpi_mutex);
1005 * Assume an initial maximum length, optionally gets adjusted below.
1006 * Prepare a NULL return value for when error paths will be taken.
1008 response = g_string_sized_new(1024);
1010 timeout = g_get_monotonic_time() + scpi->read_timeout_us;
1012 /* Get (the first chunk of) the response. */
1014 ret = scpi_read_response(scpi, response, timeout);
1016 g_mutex_unlock(&scpi->scpi_mutex);
1017 g_string_free(response, TRUE);
1020 } while (response->len < 2);
1023 * SCPI protocol data blocks are preceeded with a length spec.
1024 * The length spec consists of a '#' marker, one digit which
1025 * specifies the character count of the length spec, and the
1026 * respective number of characters which specify the data block's
1027 * length. Raw data bytes follow (thus one must no longer assume
1028 * that the received input stream would be an ASCIIZ string).
1030 * Get the data block length, and strip off the length spec from
1031 * the input buffer, leaving just the data bytes.
1033 if (response->str[0] != '#') {
1034 g_mutex_unlock(&scpi->scpi_mutex);
1035 g_string_free(response, TRUE);
1038 buf[0] = response->str[1];
1040 ret = sr_atol(buf, &llen);
1042 * The form "#0..." is legal, and does not mean "empty response",
1043 * but means that the number of data bytes is not known (or was
1044 * not communicated) at this time. Instead the block ends at an
1045 * "END MESSAGE" termination sequence. Which translates to active
1046 * EOI while a text line termination is sent (CR or LF, and this
1047 * text line termination is not part of the block's data value).
1048 * Since this kind of #0... response is considered rare, and
1049 * depends on specific support in physical transports underneath
1050 * the SCPI layer, let's flag the condition and bail out with an
1051 * error here, until it's found to be a genuine issue in the field.
1053 * The SCPI 1999.0 specification (see page 220 and following in
1054 * the "HCOPy" description) references IEEE 488.2, especially
1055 * section 8.7.9 for DEFINITE LENGTH and section 8.7.10 for
1056 * INDEFINITE LENGTH ARBITRARY BLOCK RESPONSE DATA. The latter
1057 * with a leading "#0" length and a trailing "NL^END" marker.
1059 if (ret == SR_OK && !llen) {
1060 sr_err("unsupported INDEFINITE LENGTH ARBITRARY BLOCK RESPONSE");
1064 g_mutex_unlock(&scpi->scpi_mutex);
1065 g_string_free(response, TRUE);
1069 while (response->len < (unsigned long)(2 + llen)) {
1070 ret = scpi_read_response(scpi, response, timeout);
1072 g_mutex_unlock(&scpi->scpi_mutex);
1073 g_string_free(response, TRUE);
1078 memcpy(buf, &response->str[2], llen);
1080 ret = sr_atol(buf, &datalen);
1081 if ((ret != SR_OK) || (datalen == 0)) {
1082 g_mutex_unlock(&scpi->scpi_mutex);
1083 g_string_free(response, TRUE);
1086 g_string_erase(response, 0, 2 + llen);
1089 * Re-allocate the buffer size to the now known length
1090 * and keep reading more chunks of response data.
1092 oldlen = response->len;
1093 g_string_set_size(response, datalen);
1094 g_string_set_size(response, oldlen);
1096 if (oldlen < (unsigned long)(datalen)) {
1098 oldlen = response->len;
1099 ret = scpi_read_response(scpi, response, timeout);
1101 /* On timeout truncate the buffer and send the partial response
1102 * instead of getting stuck on timeouts...
1104 if (ret == SR_ERR_TIMEOUT) {
1109 g_mutex_unlock(&scpi->scpi_mutex);
1110 g_string_free(response, TRUE);
1114 timeout = g_get_monotonic_time() + scpi->read_timeout_us;
1115 } while (response->len < (unsigned long)(datalen));
1118 g_mutex_unlock(&scpi->scpi_mutex);
1120 /* Convert received data to byte array. */
1121 *scpi_response = g_byte_array_new_take(
1122 (guint8*)g_string_free(response, FALSE), datalen);
1128 * Send the *IDN? SCPI command, receive the reply, parse it and store the
1129 * reply as a sr_scpi_hw_info structure in the supplied scpi_response pointer.
1131 * Callers must free the allocated memory regardless of the routine's
1132 * return code. See @ref sr_scpi_hw_info_free().
1134 * @param[in] scpi Previously initialised SCPI device structure.
1135 * @param[out] scpi_response Pointer where to store the hw_info structure.
1137 * @return SR_OK upon success, SR_ERR* on failure.
1139 SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
1140 struct sr_scpi_hw_info **scpi_response)
1142 int num_tokens, ret;
1145 struct sr_scpi_hw_info *hw_info;
1148 *scpi_response = NULL;
1152 ret = sr_scpi_get_string(scpi, SCPI_CMD_IDN, &response);
1153 if (ret != SR_OK && !response)
1157 * The response to a '*IDN?' is specified by the SCPI spec. It contains
1158 * a comma-separated list containing the manufacturer name, instrument
1159 * model, serial number of the instrument and the firmware version.
1161 * BEWARE! Although strictly speaking a smaller field count is invalid,
1162 * this implementation also accepts IDN responses with one field less,
1163 * and assumes that the serial number is missing. Some GWInstek DMMs
1164 * were found to do this. Keep warning about this condition, which may
1165 * need more consideration later.
1167 tokens = g_strsplit(response, ",", 0);
1168 num_tokens = g_strv_length(tokens);
1169 if (num_tokens < 3) {
1170 sr_dbg("IDN response not according to spec: '%s'", response);
1175 if (num_tokens < 4) {
1176 sr_warn("Short IDN response, assume missing serial number.");
1180 hw_info = g_malloc0(sizeof(*hw_info));
1182 idn_substr = g_strstr_len(tokens[0], -1, "IDN ");
1183 if (idn_substr == NULL)
1184 hw_info->manufacturer = g_strstrip(g_strdup(tokens[0]));
1186 hw_info->manufacturer = g_strstrip(g_strdup(idn_substr + 4));
1188 hw_info->model = g_strstrip(g_strdup(tokens[1]));
1189 if (num_tokens < 4) {
1190 hw_info->serial_number = g_strdup("Unknown");
1191 hw_info->firmware_version = g_strstrip(g_strdup(tokens[2]));
1193 hw_info->serial_number = g_strstrip(g_strdup(tokens[2]));
1194 hw_info->firmware_version = g_strstrip(g_strdup(tokens[3]));
1199 *scpi_response = hw_info;
1205 * Free a sr_scpi_hw_info struct.
1207 * @param hw_info Pointer to the struct to free. If NULL, this
1208 * function does nothing.
1210 SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info)
1215 g_free(hw_info->manufacturer);
1216 g_free(hw_info->model);
1217 g_free(hw_info->serial_number);
1218 g_free(hw_info->firmware_version);
1223 * Remove potentially enclosing pairs of quotes, un-escape content.
1224 * This implementation modifies the caller's buffer when quotes are found
1225 * and doubled quote characters need to get removed from the content.
1227 * @param[in, out] s The SCPI string to check and un-quote.
1229 * @return The start of the un-quoted string.
1231 SR_PRIV const char *sr_scpi_unquote_string(char *s)
1237 /* Immediately bail out on invalid or short input. */
1244 /* Check for matching quote characters front and back. */
1245 if (s[0] != '\'' && s[0] != '"')
1247 if (s[0] != s[s_len - 1])
1250 /* Need to strip quotes, and un-double quote chars inside. */
1251 quotes[0] = quotes[1] = *s;
1253 s[s_len - 1] = '\0';
1256 while ((rdptr = strstr(rdptr, quotes)) != NULL) {
1257 memmove(rdptr, rdptr + 1, strlen(rdptr));
1264 SR_PRIV const char *sr_vendor_alias(const char *raw_vendor)
1268 for (i = 0; i < ARRAY_SIZE(scpi_vendors); i++) {
1269 if (!g_ascii_strcasecmp(raw_vendor, scpi_vendors[i][0]))
1270 return scpi_vendors[i][1];
1276 SR_PRIV const char *sr_scpi_cmd_get(const struct scpi_command *cmdtable,
1286 for (i = 0; cmdtable[i].string; i++) {
1287 if (cmdtable[i].command == command) {
1288 cmd = cmdtable[i].string;
1296 SR_PRIV int sr_scpi_cmd(const struct sr_dev_inst *sdi,
1297 const struct scpi_command *cmdtable,
1298 int channel_command, const char *channel_name,
1301 struct sr_scpi_dev_inst *scpi;
1304 const char *channel_cmd;
1309 if (!(cmd = sr_scpi_cmd_get(cmdtable, command))) {
1310 /* Device does not implement this command, that's OK. */
1314 g_mutex_lock(&scpi->scpi_mutex);
1316 /* Select channel. */
1317 channel_cmd = sr_scpi_cmd_get(cmdtable, channel_command);
1318 if (channel_cmd && channel_name &&
1319 g_strcmp0(channel_name, scpi->actual_channel_name)) {
1320 sr_spew("sr_scpi_cmd(): new channel = %s", channel_name);
1321 g_free(scpi->actual_channel_name);
1322 scpi->actual_channel_name = g_strdup(channel_name);
1323 ret = scpi_send(scpi, channel_cmd, channel_name);
1328 va_start(args, command);
1329 ret = scpi_send_variadic(scpi, cmd, args);
1332 g_mutex_unlock(&scpi->scpi_mutex);
1337 SR_PRIV int sr_scpi_cmd_resp(const struct sr_dev_inst *sdi,
1338 const struct scpi_command *cmdtable,
1339 int channel_command, const char *channel_name,
1340 GVariant **gvar, const GVariantType *gvtype, int command, ...)
1342 struct sr_scpi_dev_inst *scpi;
1344 const char *channel_cmd;
1354 if (!(cmd = sr_scpi_cmd_get(cmdtable, command))) {
1355 /* Device does not implement this command. */
1359 g_mutex_lock(&scpi->scpi_mutex);
1361 /* Select channel. */
1362 channel_cmd = sr_scpi_cmd_get(cmdtable, channel_command);
1363 if (channel_cmd && channel_name &&
1364 g_strcmp0(channel_name, scpi->actual_channel_name)) {
1365 sr_spew("sr_scpi_cmd_get(): new channel = %s", channel_name);
1366 g_free(scpi->actual_channel_name);
1367 scpi->actual_channel_name = g_strdup(channel_name);
1368 ret = scpi_send(scpi, channel_cmd, channel_name);
1373 va_start(args, command);
1374 ret = scpi_send_variadic(scpi, cmd, args);
1377 g_mutex_unlock(&scpi->scpi_mutex);
1381 response = g_string_sized_new(1024);
1382 ret = scpi_get_data(scpi, NULL, &response);
1384 g_mutex_unlock(&scpi->scpi_mutex);
1386 g_string_free(response, TRUE);
1390 g_mutex_unlock(&scpi->scpi_mutex);
1392 /* Get rid of trailing linefeed if present */
1393 if (response->len >= 1 && response->str[response->len - 1] == '\n')
1394 g_string_truncate(response, response->len - 1);
1396 /* Get rid of trailing carriage return if present */
1397 if (response->len >= 1 && response->str[response->len - 1] == '\r')
1398 g_string_truncate(response, response->len - 1);
1400 s = g_string_free(response, FALSE);
1403 if (g_variant_type_equal(gvtype, G_VARIANT_TYPE_BOOLEAN)) {
1404 if ((ret = parse_strict_bool(s, &b)) == SR_OK)
1405 *gvar = g_variant_new_boolean(b);
1406 } else if (g_variant_type_equal(gvtype, G_VARIANT_TYPE_DOUBLE)) {
1407 if ((ret = sr_atod_ascii(s, &d)) == SR_OK)
1408 *gvar = g_variant_new_double(d);
1409 } else if (g_variant_type_equal(gvtype, G_VARIANT_TYPE_STRING)) {
1410 *gvar = g_variant_new_string(s);
1412 sr_err("Unable to convert to desired GVariant type.");