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 if ((sdi = probe_device(scpi)))
121 SR_PRIV GSList *sr_scpi_scan(struct drv_context *drvc, GSList *options,
122 struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi))
124 GSList *resources, *l, *devices;
125 struct sr_dev_inst *sdi;
126 const char *resource = NULL;
127 const char *serialcomm = NULL;
131 for (l = options; l; l = l->next) {
132 struct sr_config *src = l->data;
135 resource = g_variant_get_string(src->data, NULL);
137 case SR_CONF_SERIALCOMM:
138 serialcomm = g_variant_get_string(src->data, NULL);
144 for (i = 0; i < ARRAY_SIZE(scpi_devs); i++) {
145 if ((resource && strcmp(resource, scpi_devs[i]->prefix))
146 || !scpi_devs[i]->scan)
148 resources = scpi_devs[i]->scan(drvc);
149 for (l = resources; l; l = l->next) {
150 res = g_strsplit(l->data, ":", 2);
151 if (res[0] && (sdi = sr_scpi_scan_resource(drvc, res[0],
152 serialcomm ? serialcomm : res[1], probe_device))) {
153 devices = g_slist_append(devices, sdi);
154 sdi->connection_id = g_strdup(l->data);
158 g_slist_free_full(resources, g_free);
161 if (!devices && resource) {
162 sdi = sr_scpi_scan_resource(drvc, resource, serialcomm, probe_device);
164 devices = g_slist_append(NULL, sdi);
167 /* Tack a copy of the newly found devices onto the driver list. */
169 drvc->instances = g_slist_concat(drvc->instances, g_slist_copy(devices));
174 SR_PRIV struct sr_scpi_dev_inst *scpi_dev_inst_new(struct drv_context *drvc,
175 const char *resource, const char *serialcomm)
177 struct sr_scpi_dev_inst *scpi = NULL;
178 const struct sr_scpi_dev_inst *scpi_dev;
182 for (i = 0; i < ARRAY_SIZE(scpi_devs); i++) {
183 scpi_dev = scpi_devs[i];
184 if (!strncmp(resource, scpi_dev->prefix, strlen(scpi_dev->prefix))) {
185 sr_dbg("Opening %s device %s.", scpi_dev->name, resource);
186 scpi = g_malloc(sizeof(*scpi));
188 scpi->priv = g_malloc0(scpi->priv_size);
189 scpi->read_timeout_ms = 1000;
190 params = g_strsplit(resource, "/", 0);
191 if (scpi->dev_inst_new(scpi->priv, drvc, resource,
192 params, serialcomm) != SR_OK) {
207 * @param scpi Previously initialized SCPI device structure.
209 * @return SR_OK on success, SR_ERR on failure.
211 SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi)
213 return scpi->open(scpi->priv);
217 * Add an event source for an SCPI device.
219 * @param session The session to add the event source to.
220 * @param scpi Previously initialized SCPI device structure.
221 * @param events Events to check for.
222 * @param timeout Max time to wait before the callback is called, ignored if 0.
223 * @param cb Callback function to add. Must not be NULL.
224 * @param cb_data Data for the callback function. Can be NULL.
226 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
227 * SR_ERR_MALLOC upon memory allocation errors.
229 SR_PRIV int sr_scpi_source_add(struct sr_session *session,
230 struct sr_scpi_dev_inst *scpi, int events, int timeout,
231 sr_receive_data_callback cb, void *cb_data)
233 return scpi->source_add(session, scpi->priv, events, timeout, cb, cb_data);
237 * Remove event source for an SCPI device.
239 * @param session The session to remove the event source from.
240 * @param scpi Previously initialized SCPI device structure.
242 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
243 * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
246 SR_PRIV int sr_scpi_source_remove(struct sr_session *session,
247 struct sr_scpi_dev_inst *scpi)
249 return scpi->source_remove(session, scpi->priv);
253 * Send a SCPI command.
255 * @param scpi Previously initialized SCPI device structure.
256 * @param format Format string, to be followed by any necessary arguments.
258 * @return SR_OK on success, SR_ERR on failure.
260 SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi,
261 const char *format, ...)
266 va_start(args, format);
267 ret = sr_scpi_send_variadic(scpi, format, args);
274 * Send a SCPI command with a variadic argument list.
276 * @param scpi Previously initialized SCPI device structure.
277 * @param format Format string.
278 * @param args Argument list.
280 * @return SR_OK on success, SR_ERR on failure.
282 SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
283 const char *format, va_list args)
289 /* Get length of buffer required. */
290 va_copy(args_copy, args);
291 len = vsnprintf(NULL, 0, format, args_copy);
294 /* Allocate buffer and write out command. */
295 buf = g_malloc(len + 1);
296 vsprintf(buf, format, args);
299 ret = scpi->send(scpi->priv, buf);
301 /* Free command buffer. */
308 * Begin receiving an SCPI reply.
310 * @param scpi Previously initialised SCPI device structure.
312 * @return SR_OK on success, SR_ERR on failure.
314 SR_PRIV int sr_scpi_read_begin(struct sr_scpi_dev_inst *scpi)
316 return scpi->read_begin(scpi->priv);
320 * Read part of a response from SCPI device.
322 * @param scpi Previously initialised SCPI device structure.
323 * @param buf Buffer to store result.
324 * @param maxlen Maximum number of bytes to read.
326 * @return Number of bytes read, or SR_ERR upon failure.
328 SR_PRIV int sr_scpi_read_data(struct sr_scpi_dev_inst *scpi,
329 char *buf, int maxlen)
331 return scpi->read_data(scpi->priv, buf, maxlen);
335 * Check whether a complete SCPI response has been received.
337 * @param scpi Previously initialised SCPI device structure.
339 * @return 1 if complete, 0 otherwise.
341 SR_PRIV int sr_scpi_read_complete(struct sr_scpi_dev_inst *scpi)
343 return scpi->read_complete(scpi->priv);
349 * @param scpi Previously initialized SCPI device structure.
351 * @return SR_OK on success, SR_ERR on failure.
353 SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi)
355 return scpi->close(scpi->priv);
361 * @param scpi Previously initialized SCPI device structure.
363 * @return SR_OK on success, SR_ERR on failure.
365 SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi)
367 scpi->free(scpi->priv);
373 * Send a SCPI command, receive the reply and store the reply in scpi_response.
375 * @param scpi Previously initialised SCPI device structure.
376 * @param command The SCPI command to send to the device (can be NULL).
377 * @param scpi_response Pointer where to store the SCPI response.
379 * @return SR_OK on success, SR_ERR* on failure.
381 SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
382 const char *command, char **scpi_response)
388 unsigned int elapsed_ms;
391 if (sr_scpi_send(scpi, command) != SR_OK)
394 if (sr_scpi_read_begin(scpi) != SR_OK)
397 laststart = g_get_monotonic_time();
399 response = g_string_new("");
401 *scpi_response = NULL;
403 while (!sr_scpi_read_complete(scpi)) {
404 len = sr_scpi_read_data(scpi, buf, sizeof(buf));
406 sr_err("Incompletely read SCPI response.");
407 g_string_free(response, TRUE);
409 } else if (len > 0) {
410 laststart = g_get_monotonic_time();
412 g_string_append_len(response, buf, len);
413 elapsed_ms = (g_get_monotonic_time() - laststart) / 1000;
414 if (elapsed_ms >= scpi->read_timeout_ms) {
415 sr_err("Timed out waiting for SCPI response.");
416 g_string_free(response, TRUE);
421 /* Get rid of trailing linefeed if present */
422 if (response->len >= 1 && response->str[response->len - 1] == '\n')
423 g_string_truncate(response, response->len - 1);
425 /* Get rid of trailing carriage return if present */
426 if (response->len >= 1 && response->str[response->len - 1] == '\r')
427 g_string_truncate(response, response->len - 1);
429 sr_spew("Got response: '%.70s', length %" G_GSIZE_FORMAT ".",
430 response->str, response->len);
432 *scpi_response = g_string_free(response, FALSE);
438 * Send a SCPI command, read the reply, parse it as a bool value and store the
439 * result in scpi_response.
441 * @param scpi Previously initialised SCPI device structure.
442 * @param command The SCPI command to send to the device (can be NULL).
443 * @param scpi_response Pointer where to store the parsed result.
445 * @return SR_OK on success, SR_ERR* on failure.
447 SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
448 const char *command, gboolean *scpi_response)
455 ret = sr_scpi_get_string(scpi, command, &response);
456 if (ret != SR_OK && !response)
459 if (parse_strict_bool(response, scpi_response) == SR_OK)
470 * Send a SCPI command, read the reply, parse it as an integer and store the
471 * result in scpi_response.
473 * @param scpi Previously initialised SCPI device structure.
474 * @param command The SCPI command to send to the device (can be NULL).
475 * @param scpi_response Pointer where to store the parsed result.
477 * @return SR_OK on success, SR_ERR* on failure.
479 SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
480 const char *command, int *scpi_response)
487 ret = sr_scpi_get_string(scpi, command, &response);
488 if (ret != SR_OK && !response)
491 if (sr_atoi(response, scpi_response) == SR_OK)
502 * Send a SCPI command, read the reply, parse it as a float and store the
503 * result in scpi_response.
505 * @param scpi Previously initialised SCPI device structure.
506 * @param command The SCPI command to send to the device (can be NULL).
507 * @param scpi_response Pointer where to store the parsed result.
509 * @return SR_OK on success, SR_ERR* on failure.
511 SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
512 const char *command, float *scpi_response)
519 ret = sr_scpi_get_string(scpi, command, &response);
520 if (ret != SR_OK && !response)
523 if (sr_atof_ascii(response, scpi_response) == SR_OK)
534 * Send a SCPI command, read the reply, parse it as a double and store the
535 * result in scpi_response.
537 * @param scpi Previously initialised SCPI device structure.
538 * @param command The SCPI command to send to the device (can be NULL).
539 * @param scpi_response Pointer where to store the parsed result.
541 * @return SR_OK on success, SR_ERR* on failure.
543 SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
544 const char *command, double *scpi_response)
551 ret = sr_scpi_get_string(scpi, command, &response);
552 if (ret != SR_OK && !response)
555 if (sr_atod(response, scpi_response) == SR_OK)
566 * Send a SCPI *OPC? command, read the reply and return the result of the
569 * @param scpi Previously initialised SCPI device structure.
571 * @return SR_OK on success, SR_ERR* on failure.
573 SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi)
578 for (i = 0; i < SCPI_READ_RETRIES; ++i) {
579 sr_scpi_get_bool(scpi, SCPI_CMD_OPC, &opc);
582 g_usleep(SCPI_READ_RETRY_TIMEOUT_US);
589 * Send a SCPI command, read the reply, parse it as comma separated list of
590 * floats and store the as an result in scpi_response.
592 * @param scpi Previously initialised SCPI device structure.
593 * @param command The SCPI command to send to the device (can be NULL).
594 * @param scpi_response Pointer where to store the parsed result.
596 * @return SR_OK upon successfully parsing all values, SR_ERR* upon a parsing
597 * error or upon no response. The allocated response must be freed by
598 * the caller in the case of an SR_OK as well as in the case of
601 SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
602 const char *command, GArray **scpi_response)
607 gchar **ptr, **tokens;
608 GArray *response_array;
614 ret = sr_scpi_get_string(scpi, command, &response);
615 if (ret != SR_OK && !response)
618 tokens = g_strsplit(response, ",", 0);
621 response_array = g_array_sized_new(TRUE, FALSE, sizeof(float), 256);
624 if (sr_atof_ascii(*ptr, &tmp) == SR_OK)
625 response_array = g_array_append_val(response_array,
635 if (ret != SR_OK && response_array->len == 0) {
636 g_array_free(response_array, TRUE);
637 *scpi_response = NULL;
641 *scpi_response = response_array;
647 * Send a SCPI command, read the reply, parse it as comma separated list of
648 * unsigned 8 bit integers 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_uint8v(struct sr_scpi_dev_inst *scpi,
660 const char *command, GArray **scpi_response)
664 gchar **ptr, **tokens;
665 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(uint8_t), 256);
681 if (sr_atoi(*ptr, &tmp) == SR_OK)
682 response_array = g_array_append_val(response_array,
692 if (response_array->len == 0) {
693 g_array_free(response_array, TRUE);
694 *scpi_response = NULL;
698 *scpi_response = response_array;
704 * Send the *IDN? SCPI command, receive the reply, parse it and store the
705 * reply as a sr_scpi_hw_info structure in the supplied scpi_response pointer.
707 * The hw_info structure must be freed by the caller via sr_scpi_hw_info_free().
709 * @param scpi Previously initialised SCPI device structure.
710 * @param scpi_response Pointer where to store the hw_info structure.
712 * @return SR_OK upon success, SR_ERR* on failure.
714 SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
715 struct sr_scpi_hw_info **scpi_response)
720 struct sr_scpi_hw_info *hw_info;
725 ret = sr_scpi_get_string(scpi, SCPI_CMD_IDN, &response);
726 if (ret != SR_OK && !response)
729 sr_info("Got IDN string: '%s'", response);
732 * The response to a '*IDN?' is specified by the SCPI spec. It contains
733 * a comma-separated list containing the manufacturer name, instrument
734 * model, serial number of the instrument and the firmware version.
736 tokens = g_strsplit(response, ",", 0);
738 for (num_tokens = 0; tokens[num_tokens] != NULL; num_tokens++);
740 if (num_tokens < 4) {
741 sr_dbg("IDN response not according to spec: %80.s.", response);
748 hw_info = g_malloc0(sizeof(struct sr_scpi_hw_info));
749 hw_info->manufacturer = g_strstrip(g_strdup(tokens[0]));
750 hw_info->model = g_strstrip(g_strdup(tokens[1]));
751 hw_info->serial_number = g_strstrip(g_strdup(tokens[2]));
752 hw_info->firmware_version = g_strstrip(g_strdup(tokens[3]));
756 *scpi_response = hw_info;
762 * Free a sr_scpi_hw_info struct.
764 * @param hw_info Pointer to the struct to free.
766 * This function is safe to call with a NULL pointer.
768 SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info)
771 g_free(hw_info->manufacturer);
772 g_free(hw_info->model);
773 g_free(hw_info->serial_number);
774 g_free(hw_info->firmware_version);