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/>.
20 #include "libsigrok.h"
21 #include "libsigrok-internal.h"
26 #define LOG_PREFIX "scpi"
28 #define SCPI_READ_RETRIES 100
29 #define SCPI_READ_RETRY_TIMEOUT 10000
32 * Parse a string representation of a boolean-like value into a gboolean.
33 * Similar to sr_parse_boolstring but rejects strings which do not represent
34 * a boolean-like value.
36 * @param str String to convert.
37 * @param ret Pointer to a gboolean where the result of the conversion will be
40 * @return SR_OK on success, SR_ERR on failure.
42 static int parse_strict_bool(const char *str, gboolean *ret)
47 if (!g_strcmp0(str, "1") ||
48 !g_ascii_strncasecmp(str, "y", 1) ||
49 !g_ascii_strncasecmp(str, "t", 1) ||
50 !g_ascii_strncasecmp(str, "yes", 3) ||
51 !g_ascii_strncasecmp(str, "true", 4) ||
52 !g_ascii_strncasecmp(str, "on", 2)) {
55 } else if (!g_strcmp0(str, "0") ||
56 !g_ascii_strncasecmp(str, "n", 1) ||
57 !g_ascii_strncasecmp(str, "f", 1) ||
58 !g_ascii_strncasecmp(str, "no", 2) ||
59 !g_ascii_strncasecmp(str, "false", 5) ||
60 !g_ascii_strncasecmp(str, "off", 3)) {
68 SR_PRIV extern const struct sr_scpi_dev_inst scpi_serial_dev;
69 SR_PRIV extern const struct sr_scpi_dev_inst scpi_tcp_raw_dev;
70 SR_PRIV extern const struct sr_scpi_dev_inst scpi_tcp_rigol_dev;
71 SR_PRIV extern const struct sr_scpi_dev_inst scpi_usbtmc_libusb_dev;
72 SR_PRIV extern const struct sr_scpi_dev_inst scpi_vxi_dev;
73 SR_PRIV extern const struct sr_scpi_dev_inst scpi_visa_dev;
74 SR_PRIV extern const struct sr_scpi_dev_inst scpi_libgpib_dev;
76 static const struct sr_scpi_dev_inst *scpi_devs[] = {
79 #ifdef HAVE_LIBUSB_1_0
80 &scpi_usbtmc_libusb_dev,
91 #ifdef HAVE_LIBSERIALPORT
92 &scpi_serial_dev, /* must be last as it matches any resource */
96 static struct sr_dev_inst *sr_scpi_scan_resource(struct drv_context *drvc,
97 const char *resource, const char *serialcomm,
98 struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi))
100 struct sr_scpi_dev_inst *scpi;
101 struct sr_dev_inst *sdi;
103 if (!(scpi = scpi_dev_inst_new(drvc, resource, serialcomm)))
106 if (sr_scpi_open(scpi) != SR_OK) {
107 sr_info("Couldn't open SCPI device.");
112 if ((sdi = probe_device(scpi)))
120 SR_PRIV GSList *sr_scpi_scan(struct drv_context *drvc, GSList *options,
121 struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi))
123 GSList *resources, *l, *devices;
124 struct sr_dev_inst *sdi;
125 const char *resource = NULL;
126 const char *serialcomm = NULL;
130 for (l = options; l; l = l->next) {
131 struct sr_config *src = l->data;
134 resource = g_variant_get_string(src->data, NULL);
136 case SR_CONF_SERIALCOMM:
137 serialcomm = g_variant_get_string(src->data, NULL);
143 for (i = 0; i < ARRAY_SIZE(scpi_devs); i++) {
144 if ((resource && strcmp(resource, scpi_devs[i]->prefix))
145 || !scpi_devs[i]->scan)
147 resources = scpi_devs[i]->scan(drvc);
148 for (l = resources; l; l = l->next) {
149 res = g_strsplit(l->data, ":", 2);
150 if (res[0] && (sdi = sr_scpi_scan_resource(drvc, res[0],
151 serialcomm ? serialcomm : res[1], probe_device))) {
152 devices = g_slist_append(devices, sdi);
153 sdi->connection_id = g_strdup(l->data);
157 g_slist_free_full(resources, g_free);
160 if (!devices && resource) {
161 sdi = sr_scpi_scan_resource(drvc, resource, serialcomm, probe_device);
163 devices = g_slist_append(NULL, sdi);
166 /* Tack a copy of the newly found devices onto the driver list. */
168 drvc->instances = g_slist_concat(drvc->instances, g_slist_copy(devices));
173 SR_PRIV struct sr_scpi_dev_inst *scpi_dev_inst_new(struct drv_context *drvc,
174 const char *resource, const char *serialcomm)
176 struct sr_scpi_dev_inst *scpi = NULL;
177 const struct sr_scpi_dev_inst *scpi_dev;
181 for (i = 0; i < ARRAY_SIZE(scpi_devs); i++) {
182 scpi_dev = scpi_devs[i];
183 if (!strncmp(resource, scpi_dev->prefix, strlen(scpi_dev->prefix))) {
184 sr_dbg("Opening %s device %s.", scpi_dev->name, resource);
185 scpi = g_malloc(sizeof(*scpi));
187 scpi->priv = g_malloc0(scpi->priv_size);
188 scpi->read_timeout_ms = 1000;
189 params = g_strsplit(resource, "/", 0);
190 if (scpi->dev_inst_new(scpi->priv, drvc, resource,
191 params, serialcomm) != SR_OK) {
206 * @param scpi Previously initialized SCPI device structure.
208 * @return SR_OK on success, SR_ERR on failure.
210 SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi)
212 return scpi->open(scpi->priv);
216 * Add an event source for an SCPI device.
218 * @param session The session to add the event source to.
219 * @param scpi Previously initialized SCPI device structure.
220 * @param events Events to check for.
221 * @param timeout Max time to wait before the callback is called, ignored if 0.
222 * @param cb Callback function to add. Must not be NULL.
223 * @param cb_data Data for the callback function. Can be NULL.
225 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
226 * SR_ERR_MALLOC upon memory allocation errors.
228 SR_PRIV int sr_scpi_source_add(struct sr_session *session,
229 struct sr_scpi_dev_inst *scpi, int events, int timeout,
230 sr_receive_data_callback cb, void *cb_data)
232 return scpi->source_add(session, scpi->priv, events, timeout, cb, cb_data);
236 * Remove event source for an SCPI device.
238 * @param session The session to remove the event source from.
239 * @param scpi Previously initialized SCPI device structure.
241 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
242 * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
245 SR_PRIV int sr_scpi_source_remove(struct sr_session *session,
246 struct sr_scpi_dev_inst *scpi)
248 return scpi->source_remove(session, scpi->priv);
252 * Send a SCPI command.
254 * @param scpi Previously initialized SCPI device structure.
255 * @param format Format string, to be followed by any necessary arguments.
257 * @return SR_OK on success, SR_ERR on failure.
259 SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi,
260 const char *format, ...)
265 va_start(args, format);
266 ret = sr_scpi_send_variadic(scpi, format, args);
273 * Send a SCPI command with a variadic argument list.
275 * @param scpi Previously initialized SCPI device structure.
276 * @param format Format string.
277 * @param args Argument list.
279 * @return SR_OK on success, SR_ERR on failure.
281 SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
282 const char *format, va_list args)
288 /* Get length of buffer required. */
289 va_copy(args_copy, args);
290 len = vsnprintf(NULL, 0, format, args_copy);
293 /* Allocate buffer and write out command. */
294 buf = g_malloc(len + 1);
295 vsprintf(buf, format, args);
298 ret = scpi->send(scpi->priv, buf);
300 /* Free command buffer. */
307 * Begin receiving an SCPI reply.
309 * @param scpi Previously initialised SCPI device structure.
311 * @return SR_OK on success, SR_ERR on failure.
313 SR_PRIV int sr_scpi_read_begin(struct sr_scpi_dev_inst *scpi)
315 return scpi->read_begin(scpi->priv);
319 * Read part of a response from SCPI device.
321 * @param scpi Previously initialised SCPI device structure.
322 * @param buf Buffer to store result.
323 * @param maxlen Maximum number of bytes to read.
325 * @return Number of bytes read, or SR_ERR upon failure.
327 SR_PRIV int sr_scpi_read_data(struct sr_scpi_dev_inst *scpi,
328 char *buf, int maxlen)
330 return scpi->read_data(scpi->priv, buf, maxlen);
334 * Check whether a complete SCPI response has been received.
336 * @param scpi Previously initialised SCPI device structure.
338 * @return 1 if complete, 0 otherwise.
340 SR_PRIV int sr_scpi_read_complete(struct sr_scpi_dev_inst *scpi)
342 return scpi->read_complete(scpi->priv);
348 * @param scpi Previously initialized SCPI device structure.
350 * @return SR_OK on success, SR_ERR on failure.
352 SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi)
354 return scpi->close(scpi->priv);
360 * @param scpi Previously initialized SCPI device structure.
362 * @return SR_OK on success, SR_ERR on failure.
364 SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi)
366 scpi->free(scpi->priv);
372 * Send a SCPI command, receive the reply and store the reply in scpi_response.
374 * @param scpi Previously initialised SCPI device structure.
375 * @param command The SCPI command to send to the device (can be NULL).
376 * @param scpi_response Pointer where to store the SCPI response.
378 * @return SR_OK on success, SR_ERR on failure.
380 SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
381 const char *command, char **scpi_response)
387 unsigned int elapsed_ms;
390 if (sr_scpi_send(scpi, command) != SR_OK)
393 if (sr_scpi_read_begin(scpi) != SR_OK)
396 start = g_get_monotonic_time();
398 response = g_string_new("");
400 *scpi_response = NULL;
402 while (!sr_scpi_read_complete(scpi)) {
403 len = sr_scpi_read_data(scpi, buf, sizeof(buf));
405 g_string_free(response, TRUE);
408 g_string_append_len(response, buf, len);
409 elapsed_ms = (g_get_monotonic_time() - start) / 1000;
410 if (elapsed_ms >= scpi->read_timeout_ms)
412 sr_err("Timed out waiting for SCPI response.");
413 g_string_free(response, TRUE);
418 /* Get rid of trailing linefeed if present */
419 if (response->len >= 1 && response->str[response->len - 1] == '\n')
420 g_string_truncate(response, response->len - 1);
422 /* Get rid of trailing carriage return if present */
423 if (response->len >= 1 && response->str[response->len - 1] == '\r')
424 g_string_truncate(response, response->len - 1);
426 *scpi_response = response->str;
427 g_string_free(response, FALSE);
429 sr_spew("Got response: '%.70s'.", *scpi_response);
435 * Send a SCPI command, read the reply, parse it as a bool value and store the
436 * result in scpi_response.
438 * @param scpi Previously initialised SCPI device structure.
439 * @param command The SCPI command to send to the device (can be NULL).
440 * @param scpi_response Pointer where to store the parsed result.
442 * @return SR_OK on success, SR_ERR on failure.
444 SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
445 const char *command, gboolean *scpi_response)
452 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
456 if (parse_strict_bool(response, scpi_response) == SR_OK)
467 * Send a SCPI command, read the reply, parse it as an integer and store the
468 * result in scpi_response.
470 * @param scpi Previously initialised SCPI device structure.
471 * @param command The SCPI command to send to the device (can be NULL).
472 * @param scpi_response Pointer where to store the parsed result.
474 * @return SR_OK on success, SR_ERR on failure.
476 SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
477 const char *command, int *scpi_response)
484 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
488 if (sr_atoi(response, scpi_response) == SR_OK)
499 * Send a SCPI command, read the reply, parse it as a float and store the
500 * result in scpi_response.
502 * @param scpi Previously initialised SCPI device structure.
503 * @param command The SCPI command to send to the device (can be NULL).
504 * @param scpi_response Pointer where to store the parsed result.
506 * @return SR_OK on success, SR_ERR on failure.
508 SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
509 const char *command, float *scpi_response)
516 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
520 if (sr_atof_ascii(response, scpi_response) == SR_OK)
531 * Send a SCPI command, read the reply, parse it as a double and store the
532 * result in scpi_response.
534 * @param scpi Previously initialised SCPI device structure.
535 * @param command The SCPI command to send to the device (can be NULL).
536 * @param scpi_response Pointer where to store the parsed result.
538 * @return SR_OK on success, SR_ERR on failure.
540 SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
541 const char *command, double *scpi_response)
548 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
552 if (sr_atod(response, scpi_response) == SR_OK)
563 * Send a SCPI *OPC? command, read the reply and return the result of the
566 * @param scpi Previously initialised SCPI device structure.
568 * @return SR_OK on success, SR_ERR on failure.
570 SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi)
575 for (i = 0; i < SCPI_READ_RETRIES; ++i) {
576 sr_scpi_get_bool(scpi, SCPI_CMD_OPC, &opc);
579 g_usleep(SCPI_READ_RETRY_TIMEOUT);
586 * Send a SCPI command, read the reply, parse it as comma separated list of
587 * floats and store the as an result in scpi_response.
589 * @param scpi Previously initialised SCPI device structure.
590 * @param command The SCPI command to send to the device (can be NULL).
591 * @param scpi_response Pointer where to store the parsed result.
593 * @return SR_OK upon successfully parsing all values, SR_ERR upon a parsing
594 * error or upon no response. The allocated response must be freed by
595 * the caller in the case of an SR_OK as well as in the case of
598 SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
599 const char *command, GArray **scpi_response)
604 gchar **ptr, **tokens;
605 GArray *response_array;
611 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
615 tokens = g_strsplit(response, ",", 0);
618 response_array = g_array_sized_new(TRUE, FALSE, sizeof(float), 256);
621 if (sr_atof_ascii(*ptr, &tmp) == SR_OK)
622 response_array = g_array_append_val(response_array,
632 if (ret == SR_ERR && response_array->len == 0) {
633 g_array_free(response_array, TRUE);
634 *scpi_response = NULL;
638 *scpi_response = response_array;
644 * Send a SCPI command, read the reply, parse it as comma separated list of
645 * unsigned 8 bit integers and store the as an result in scpi_response.
647 * @param scpi Previously initialised SCPI device structure.
648 * @param command The SCPI command to send to the device (can be NULL).
649 * @param scpi_response Pointer where to store the parsed result.
651 * @return SR_OK upon successfully parsing all values, SR_ERR upon a parsing
652 * error or upon no response. The allocated response must be freed by
653 * the caller in the case of an SR_OK as well as in the case of
656 SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
657 const char *command, GArray **scpi_response)
661 gchar **ptr, **tokens;
662 GArray *response_array;
668 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
672 tokens = g_strsplit(response, ",", 0);
675 response_array = g_array_sized_new(TRUE, FALSE, sizeof(uint8_t), 256);
678 if (sr_atoi(*ptr, &tmp) == SR_OK)
679 response_array = g_array_append_val(response_array,
689 if (response_array->len == 0) {
690 g_array_free(response_array, TRUE);
691 *scpi_response = NULL;
695 *scpi_response = response_array;
701 * Send the *IDN? SCPI command, receive the reply, parse it and store the
702 * reply as a sr_scpi_hw_info structure in the supplied scpi_response pointer.
704 * The hw_info structure must be freed by the caller via sr_scpi_hw_info_free().
706 * @param scpi Previously initialised SCPI device structure.
707 * @param scpi_response Pointer where to store the hw_info structure.
709 * @return SR_OK upon success, SR_ERR on failure.
711 SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
712 struct sr_scpi_hw_info **scpi_response)
717 struct sr_scpi_hw_info *hw_info;
722 if (sr_scpi_get_string(scpi, SCPI_CMD_IDN, &response) != SR_OK)
726 sr_info("Got IDN string: '%s'", response);
729 * The response to a '*IDN?' is specified by the SCPI spec. It contains
730 * a comma-separated list containing the manufacturer name, instrument
731 * model, serial number of the instrument and the firmware version.
733 tokens = g_strsplit(response, ",", 0);
735 for (num_tokens = 0; tokens[num_tokens] != NULL; num_tokens++);
737 if (num_tokens != 4) {
738 sr_dbg("IDN response not according to spec: %80.s.", response);
745 hw_info = g_try_malloc(sizeof(struct sr_scpi_hw_info));
748 return SR_ERR_MALLOC;
751 hw_info->manufacturer = g_strdup(tokens[0]);
752 hw_info->model = g_strdup(tokens[1]);
753 hw_info->serial_number = g_strdup(tokens[2]);
754 hw_info->firmware_version = g_strdup(tokens[3]);
758 *scpi_response = hw_info;
764 * Free a sr_scpi_hw_info struct.
766 * @param hw_info Pointer to the struct to free.
768 * This function is safe to call with a NULL pointer.
770 SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info)
773 g_free(hw_info->manufacturer);
774 g_free(hw_info->model);
775 g_free(hw_info->serial_number);
776 g_free(hw_info->firmware_version);