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_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;
75 static const struct sr_scpi_dev_inst *scpi_devs[] = {
85 #ifdef HAVE_LIBSERIALPORT
86 &scpi_serial_dev, /* must be last as it matches any resource */
90 static GSList *sr_scpi_scan_resource(struct drv_context *drvc,
91 const char *resource, const char *serialcomm,
92 struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi))
94 struct sr_scpi_dev_inst *scpi;
95 struct sr_dev_inst *sdi;
97 if (!(scpi = scpi_dev_inst_new(drvc, resource, serialcomm)))
100 if (sr_scpi_open(scpi) != SR_OK) {
101 sr_info("Couldn't open SCPI device.");
106 if ((sdi = probe_device(scpi)))
107 return g_slist_append(NULL, sdi);
114 SR_PRIV GSList *sr_scpi_scan(struct drv_context *drvc, GSList *options,
115 struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi))
117 GSList *resources, *l, *d, *devices = NULL;
118 const char *resource = NULL;
119 const char *serialcomm = NULL;
123 for (l = options; l; l = l->next) {
124 struct sr_config *src = l->data;
127 resource = g_variant_get_string(src->data, NULL);
129 case SR_CONF_SERIALCOMM:
130 serialcomm = g_variant_get_string(src->data, NULL);
135 for (i = 0; i < ARRAY_SIZE(scpi_devs); i++) {
136 if ((resource && strcmp(resource, scpi_devs[i]->prefix))
137 || !scpi_devs[i]->scan)
139 resources = scpi_devs[i]->scan(drvc);
140 for (l = resources; l; l = l->next) {
141 res = g_strsplit(l->data, ":", 2);
142 if (res[0] && (d = sr_scpi_scan_resource(drvc, res[0],
143 serialcomm ? serialcomm : res[1], probe_device)))
144 devices = g_slist_concat(devices, d);
147 g_slist_free_full(resources, g_free);
150 if (!devices && resource)
151 devices = sr_scpi_scan_resource(drvc, resource, serialcomm,
154 /* Tack a copy of the newly found devices onto the driver list. */
156 drvc->instances = g_slist_concat(drvc->instances,
157 g_slist_copy(devices));
162 SR_PRIV struct sr_scpi_dev_inst *scpi_dev_inst_new(struct drv_context *drvc,
163 const char *resource, const char *serialcomm)
165 struct sr_scpi_dev_inst *scpi = NULL;
166 const struct sr_scpi_dev_inst *scpi_dev;
170 for (i = 0; i < ARRAY_SIZE(scpi_devs); i++) {
171 scpi_dev = scpi_devs[i];
172 if (!strncmp(resource, scpi_dev->prefix, strlen(scpi_dev->prefix))) {
173 sr_dbg("Opening %s device %s.", scpi_dev->name, resource);
174 scpi = g_malloc(sizeof(*scpi));
176 scpi->priv = g_malloc0(scpi->priv_size);
177 params = g_strsplit(resource, "/", 0);
178 if (scpi->dev_inst_new(scpi->priv, drvc, resource,
179 params, serialcomm) != SR_OK) {
194 * @param scpi Previously initialized SCPI device structure.
196 * @return SR_OK on success, SR_ERR on failure.
198 SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi)
200 return scpi->open(scpi->priv);
204 * Add an event source for an SCPI device.
206 * @param scpi Previously initialized SCPI device structure.
207 * @param events Events to check for.
208 * @param timeout Max time to wait before the callback is called, ignored if 0.
209 * @param cb Callback function to add. Must not be NULL.
210 * @param cb_data Data for the callback function. Can be NULL.
212 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
213 * SR_ERR_MALLOC upon memory allocation errors.
215 SR_PRIV int sr_scpi_source_add(struct sr_scpi_dev_inst *scpi, int events,
216 int timeout, sr_receive_data_callback_t cb, void *cb_data)
218 return scpi->source_add(scpi->priv, events, timeout, cb, cb_data);
222 * Remove event source for an SCPI device.
224 * @param scpi Previously initialized SCPI device structure.
226 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
227 * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
230 SR_PRIV int sr_scpi_source_remove(struct sr_scpi_dev_inst *scpi)
232 return scpi->source_remove(scpi->priv);
236 * Send a SCPI command.
238 * @param scpi Previously initialized SCPI device structure.
239 * @param format Format string, to be followed by any necessary arguments.
241 * @return SR_OK on success, SR_ERR on failure.
243 SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi,
244 const char *format, ...)
249 va_start(args, format);
250 ret = sr_scpi_send_variadic(scpi, format, args);
257 * Send a SCPI command with a variadic argument list.
259 * @param scpi Previously initialized SCPI device structure.
260 * @param format Format string.
261 * @param args Argument list.
263 * @return SR_OK on success, SR_ERR on failure.
265 SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
266 const char *format, va_list args)
272 /* Get length of buffer required. */
273 va_copy(args_copy, args);
274 len = vsnprintf(NULL, 0, format, args_copy);
277 /* Allocate buffer and write out command. */
278 buf = g_malloc(len + 1);
279 vsprintf(buf, format, args);
282 ret = scpi->send(scpi->priv, buf);
284 /* Free command buffer. */
291 * Begin receiving an SCPI reply.
293 * @param scpi Previously initialised SCPI device structure.
295 * @return SR_OK on success, SR_ERR on failure.
297 SR_PRIV int sr_scpi_read_begin(struct sr_scpi_dev_inst *scpi)
299 return scpi->read_begin(scpi->priv);
303 * Read part of a response from SCPI device.
305 * @param scpi Previously initialised SCPI device structure.
306 * @param buf Buffer to store result.
307 * @param maxlen Maximum number of bytes to read.
309 * @return Number of bytes read, or SR_ERR upon failure.
311 SR_PRIV int sr_scpi_read_data(struct sr_scpi_dev_inst *scpi,
312 char *buf, int maxlen)
314 return scpi->read_data(scpi->priv, buf, maxlen);
318 * Check whether a complete SCPI response has been received.
320 * @param scpi Previously initialised SCPI device structure.
322 * @return 1 if complete, 0 otherwise.
324 SR_PRIV int sr_scpi_read_complete(struct sr_scpi_dev_inst *scpi)
326 return scpi->read_complete(scpi->priv);
332 * @param scpi Previously initialized SCPI device structure.
334 * @return SR_OK on success, SR_ERR on failure.
336 SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi)
338 return scpi->close(scpi->priv);
344 * @param scpi Previously initialized SCPI device structure.
346 * @return SR_OK on success, SR_ERR on failure.
348 SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi)
350 scpi->free(scpi->priv);
356 * Send a SCPI command, receive the reply and store the reply in scpi_response.
358 * @param scpi Previously initialised SCPI device structure.
359 * @param command The SCPI command to send to the device (can be NULL).
360 * @param scpi_response Pointer where to store the SCPI response.
362 * @return SR_OK on success, SR_ERR on failure.
364 SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
365 const char *command, char **scpi_response)
372 if (sr_scpi_send(scpi, command) != SR_OK)
375 if (sr_scpi_read_begin(scpi) != SR_OK)
378 response = g_string_new("");
380 *scpi_response = NULL;
382 while (!sr_scpi_read_complete(scpi)) {
383 len = sr_scpi_read_data(scpi, buf, sizeof(buf));
385 g_string_free(response, TRUE);
388 g_string_append_len(response, buf, len);
391 /* Get rid of trailing linefeed if present */
392 if (response->len >= 1 && response->str[response->len - 1] == '\n')
393 g_string_truncate(response, response->len - 1);
395 *scpi_response = response->str;
396 g_string_free(response, FALSE);
398 sr_spew("Got response: '%.70s'.", *scpi_response);
404 * Send a SCPI command, read the reply, parse it as a bool value and store the
405 * result in scpi_response.
407 * @param scpi Previously initialised SCPI device structure.
408 * @param command The SCPI command to send to the device (can be NULL).
409 * @param scpi_response Pointer where to store the parsed result.
411 * @return SR_OK on success, SR_ERR on failure.
413 SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
414 const char *command, gboolean *scpi_response)
421 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
425 if (parse_strict_bool(response, scpi_response) == SR_OK)
436 * Send a SCPI command, read the reply, parse it as an integer and store the
437 * result in scpi_response.
439 * @param scpi Previously initialised SCPI device structure.
440 * @param command The SCPI command to send to the device (can be NULL).
441 * @param scpi_response Pointer where to store the parsed result.
443 * @return SR_OK on success, SR_ERR on failure.
445 SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
446 const char *command, int *scpi_response)
453 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
457 if (sr_atoi(response, scpi_response) == SR_OK)
468 * Send a SCPI command, read the reply, parse it as a float and store the
469 * result in scpi_response.
471 * @param scpi Previously initialised SCPI device structure.
472 * @param command The SCPI command to send to the device (can be NULL).
473 * @param scpi_response Pointer where to store the parsed result.
475 * @return SR_OK on success, SR_ERR on failure.
477 SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
478 const char *command, float *scpi_response)
485 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
489 if (sr_atof_ascii(response, scpi_response) == SR_OK)
500 * Send a SCPI command, read the reply, parse it as a double and store the
501 * result in scpi_response.
503 * @param scpi Previously initialised SCPI device structure.
504 * @param command The SCPI command to send to the device (can be NULL).
505 * @param scpi_response Pointer where to store the parsed result.
507 * @return SR_OK on success, SR_ERR on failure.
509 SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
510 const char *command, double *scpi_response)
517 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
521 if (sr_atod(response, scpi_response) == SR_OK)
532 * Send a SCPI *OPC? command, read the reply and return the result of the
535 * @param scpi Previously initialised SCPI device structure.
537 * @return SR_OK on success, SR_ERR on failure.
539 SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi)
544 for (i = 0; i < SCPI_READ_RETRIES; ++i) {
545 sr_scpi_get_bool(scpi, SCPI_CMD_OPC, &opc);
548 g_usleep(SCPI_READ_RETRY_TIMEOUT);
555 * Send a SCPI command, read the reply, parse it as comma separated list of
556 * floats and store the as an result in scpi_response.
558 * @param scpi Previously initialised SCPI device structure.
559 * @param command The SCPI command to send to the device (can be NULL).
560 * @param scpi_response Pointer where to store the parsed result.
562 * @return SR_OK upon successfully parsing all values, SR_ERR upon a parsing
563 * error or upon no response. The allocated response must be freed by
564 * the caller in the case of an SR_OK as well as in the case of
567 SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
568 const char *command, GArray **scpi_response)
573 gchar **ptr, **tokens;
574 GArray *response_array;
580 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
584 tokens = g_strsplit(response, ",", 0);
587 response_array = g_array_sized_new(TRUE, FALSE, sizeof(float), 256);
590 if (sr_atof_ascii(*ptr, &tmp) == SR_OK)
591 response_array = g_array_append_val(response_array,
601 if (ret == SR_ERR && response_array->len == 0) {
602 g_array_free(response_array, TRUE);
603 *scpi_response = NULL;
607 *scpi_response = response_array;
613 * Send a SCPI command, read the reply, parse it as comma separated list of
614 * unsigned 8 bit integers and store the as an result in scpi_response.
616 * @param scpi Previously initialised SCPI device structure.
617 * @param command The SCPI command to send to the device (can be NULL).
618 * @param scpi_response Pointer where to store the parsed result.
620 * @return SR_OK upon successfully parsing all values, SR_ERR upon a parsing
621 * error or upon no response. The allocated response must be freed by
622 * the caller in the case of an SR_OK as well as in the case of
625 SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
626 const char *command, GArray **scpi_response)
630 gchar **ptr, **tokens;
631 GArray *response_array;
637 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
641 tokens = g_strsplit(response, ",", 0);
644 response_array = g_array_sized_new(TRUE, FALSE, sizeof(uint8_t), 256);
647 if (sr_atoi(*ptr, &tmp) == SR_OK)
648 response_array = g_array_append_val(response_array,
658 if (response_array->len == 0) {
659 g_array_free(response_array, TRUE);
660 *scpi_response = NULL;
664 *scpi_response = response_array;
670 * Send the *IDN? SCPI command, receive the reply, parse it and store the
671 * reply as a sr_scpi_hw_info structure in the supplied scpi_response pointer.
673 * The hw_info structure must be freed by the caller via sr_scpi_hw_info_free().
675 * @param scpi Previously initialised SCPI device structure.
676 * @param scpi_response Pointer where to store the hw_info structure.
678 * @return SR_OK upon success, SR_ERR on failure.
680 SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
681 struct sr_scpi_hw_info **scpi_response)
686 struct sr_scpi_hw_info *hw_info;
691 if (sr_scpi_get_string(scpi, SCPI_CMD_IDN, &response) != SR_OK)
695 sr_info("Got IDN string: '%s'", response);
698 * The response to a '*IDN?' is specified by the SCPI spec. It contains
699 * a comma-separated list containing the manufacturer name, instrument
700 * model, serial number of the instrument and the firmware version.
702 tokens = g_strsplit(response, ",", 0);
704 for (num_tokens = 0; tokens[num_tokens] != NULL; num_tokens++);
706 if (num_tokens != 4) {
707 sr_dbg("IDN response not according to spec: %80.s.", response);
714 hw_info = g_try_malloc(sizeof(struct sr_scpi_hw_info));
717 return SR_ERR_MALLOC;
720 hw_info->manufacturer = g_strdup(tokens[0]);
721 hw_info->model = g_strdup(tokens[1]);
722 hw_info->serial_number = g_strdup(tokens[2]);
723 hw_info->firmware_version = g_strdup(tokens[3]);
727 *scpi_response = hw_info;
733 * Free a sr_scpi_hw_info struct.
735 * @param hw_info Pointer to the struct to free.
737 * This function is safe to call with a NULL pointer.
739 SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info)
742 g_free(hw_info->manufacturer);
743 g_free(hw_info->model);
744 g_free(hw_info->serial_number);
745 g_free(hw_info->firmware_version);