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;
74 static const struct sr_scpi_dev_inst *scpi_devs[] = {
81 #ifdef HAVE_LIBSERIALPORT
82 &scpi_serial_dev, /* must be last as it matches any resource */
86 SR_PRIV struct sr_scpi_dev_inst *scpi_dev_inst_new(const char *resource,
87 const char *serialcomm)
89 struct sr_scpi_dev_inst *scpi = NULL;
90 const struct sr_scpi_dev_inst *scpi_dev;
94 for (i = 0; i < ARRAY_SIZE(scpi_devs); i++) {
95 scpi_dev = scpi_devs[i];
96 if (!strncmp(resource, scpi_dev->prefix, strlen(scpi_dev->prefix))) {
97 sr_dbg("Opening %s device %s.", scpi_dev->name, resource);
98 scpi = g_malloc(sizeof(*scpi));
100 scpi->priv = g_malloc0(scpi->priv_size);
101 params = g_strsplit(resource, "/", 0);
102 if (scpi->dev_inst_new(scpi->priv, resource,
103 params, serialcomm) != SR_OK) {
118 * @param scpi Previously initialized SCPI device structure.
120 * @return SR_OK on success, SR_ERR on failure.
122 SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi)
124 return scpi->open(scpi->priv);
128 * Add an event source for an SCPI device.
130 * @param scpi Previously initialized SCPI device structure.
131 * @param events Events to check for.
132 * @param timeout Max time to wait before the callback is called, ignored if 0.
133 * @param cb Callback function to add. Must not be NULL.
134 * @param cb_data Data for the callback function. Can be NULL.
136 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
137 * SR_ERR_MALLOC upon memory allocation errors.
139 SR_PRIV int sr_scpi_source_add(struct sr_scpi_dev_inst *scpi, int events,
140 int timeout, sr_receive_data_callback_t cb, void *cb_data)
142 return scpi->source_add(scpi->priv, events, timeout, cb, cb_data);
146 * Remove event source for an SCPI device.
148 * @param scpi Previously initialized SCPI device structure.
150 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
151 * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
154 SR_PRIV int sr_scpi_source_remove(struct sr_scpi_dev_inst *scpi)
156 return scpi->source_remove(scpi->priv);
160 * Send a SCPI command.
162 * @param scpi Previously initialized SCPI device structure.
163 * @param format Format string, to be followed by any necessary arguments.
165 * @return SR_OK on success, SR_ERR on failure.
167 SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi,
168 const char *format, ...)
173 va_start(args, format);
174 ret = sr_scpi_send_variadic(scpi, format, args);
181 * Send a SCPI command with a variadic argument list.
183 * @param scpi Previously initialized SCPI device structure.
184 * @param format Format string.
185 * @param args Argument list.
187 * @return SR_OK on success, SR_ERR on failure.
189 SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
190 const char *format, va_list args)
196 /* Get length of buffer required. */
197 va_copy(args_copy, args);
198 len = vsnprintf(NULL, 0, format, args_copy);
201 /* Allocate buffer and write out command. */
202 buf = g_malloc(len + 1);
203 vsprintf(buf, format, args);
206 ret = scpi->send(scpi->priv, buf);
208 /* Free command buffer. */
215 * Begin receiving an SCPI reply.
217 * @param scpi Previously initialised SCPI device structure.
219 * @return SR_OK on success, SR_ERR on failure.
221 SR_PRIV int sr_scpi_read_begin(struct sr_scpi_dev_inst *scpi)
223 return scpi->read_begin(scpi->priv);
227 * Read part of a response from SCPI device.
229 * @param scpi Previously initialised SCPI device structure.
230 * @param buf Buffer to store result.
231 * @param maxlen Maximum number of bytes to read.
233 * @return Number of bytes read, or SR_ERR upon failure.
235 SR_PRIV int sr_scpi_read_data(struct sr_scpi_dev_inst *scpi,
236 char *buf, int maxlen)
238 return scpi->read_data(scpi->priv, buf, maxlen);
242 * Check whether a complete SCPI response has been received.
244 * @param scpi Previously initialised SCPI device structure.
246 * @return 1 if complete, 0 otherwise.
248 SR_PRIV int sr_scpi_read_complete(struct sr_scpi_dev_inst *scpi)
250 return scpi->read_complete(scpi->priv);
256 * @param scpi Previously initialized SCPI device structure.
258 * @return SR_OK on success, SR_ERR on failure.
260 SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi)
262 return scpi->close(scpi->priv);
268 * @param scpi Previously initialized SCPI device structure.
270 * @return SR_OK on success, SR_ERR on failure.
272 SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi)
274 scpi->free(scpi->priv);
280 * Send a SCPI command, receive the reply and store the reply in scpi_response.
282 * @param scpi Previously initialised SCPI device structure.
283 * @param command The SCPI command to send to the device (can be NULL).
284 * @param scpi_response Pointer where to store the SCPI response.
286 * @return SR_OK on success, SR_ERR on failure.
288 SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
289 const char *command, char **scpi_response)
296 if (sr_scpi_send(scpi, command) != SR_OK)
299 if (sr_scpi_read_begin(scpi) != SR_OK)
302 response = g_string_new("");
304 *scpi_response = NULL;
306 while (!sr_scpi_read_complete(scpi)) {
307 len = sr_scpi_read_data(scpi, buf, sizeof(buf));
309 g_string_free(response, TRUE);
312 g_string_append_len(response, buf, len);
315 /* Get rid of trailing linefeed if present */
316 if (response->len >= 1 && response->str[response->len - 1] == '\n')
317 g_string_truncate(response, response->len - 1);
319 *scpi_response = response->str;
320 g_string_free(response, FALSE);
326 * Send a SCPI command, read the reply, parse it as a bool value and store the
327 * result in scpi_response.
329 * @param scpi Previously initialised SCPI device structure.
330 * @param command The SCPI command to send to the device (can be NULL).
331 * @param scpi_response Pointer where to store the parsed result.
333 * @return SR_OK on success, SR_ERR on failure.
335 SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
336 const char *command, gboolean *scpi_response)
343 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
347 if (parse_strict_bool(response, scpi_response) == SR_OK)
358 * Send a SCPI command, read the reply, parse it as an integer and store the
359 * result in scpi_response.
361 * @param scpi Previously initialised SCPI device structure.
362 * @param command The SCPI command to send to the device (can be NULL).
363 * @param scpi_response Pointer where to store the parsed result.
365 * @return SR_OK on success, SR_ERR on failure.
367 SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
368 const char *command, int *scpi_response)
375 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
379 if (sr_atoi(response, scpi_response) == SR_OK)
390 * Send a SCPI command, read the reply, parse it as a float and store the
391 * result in scpi_response.
393 * @param scpi Previously initialised SCPI device structure.
394 * @param command The SCPI command to send to the device (can be NULL).
395 * @param scpi_response Pointer where to store the parsed result.
397 * @return SR_OK on success, SR_ERR on failure.
399 SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
400 const char *command, float *scpi_response)
407 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
411 if (sr_atof_ascii(response, scpi_response) == SR_OK)
422 * Send a SCPI command, read the reply, parse it as a double and store the
423 * result in scpi_response.
425 * @param scpi Previously initialised SCPI device structure.
426 * @param command The SCPI command to send to the device (can be NULL).
427 * @param scpi_response Pointer where to store the parsed result.
429 * @return SR_OK on success, SR_ERR on failure.
431 SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
432 const char *command, double *scpi_response)
439 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
443 if (sr_atod(response, scpi_response) == SR_OK)
454 * Send a SCPI *OPC? command, read the reply and return the result of the
457 * @param scpi Previously initialised SCPI device structure.
459 * @return SR_OK on success, SR_ERR on failure.
461 SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi)
466 for (i = 0; i < SCPI_READ_RETRIES; ++i) {
467 sr_scpi_get_bool(scpi, SCPI_CMD_OPC, &opc);
470 g_usleep(SCPI_READ_RETRY_TIMEOUT);
477 * Send a SCPI command, read the reply, parse it as comma separated list of
478 * floats and store the as an result in scpi_response.
480 * @param scpi Previously initialised SCPI device structure.
481 * @param command The SCPI command to send to the device (can be NULL).
482 * @param scpi_response Pointer where to store the parsed result.
484 * @return SR_OK upon successfully parsing all values, SR_ERR upon a parsing
485 * error or upon no response. The allocated response must be freed by
486 * the caller in the case of an SR_OK as well as in the case of
489 SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
490 const char *command, GArray **scpi_response)
495 gchar **ptr, **tokens;
496 GArray *response_array;
502 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
506 tokens = g_strsplit(response, ",", 0);
509 response_array = g_array_sized_new(TRUE, FALSE, sizeof(float), 256);
512 if (sr_atof_ascii(*ptr, &tmp) == SR_OK)
513 response_array = g_array_append_val(response_array,
523 if (ret == SR_ERR && response_array->len == 0) {
524 g_array_free(response_array, TRUE);
525 *scpi_response = NULL;
529 *scpi_response = response_array;
535 * Send a SCPI command, read the reply, parse it as comma separated list of
536 * unsigned 8 bit integers and store the as an result in scpi_response.
538 * @param scpi Previously initialised SCPI device structure.
539 * @param command The SCPI command to send to the device (can be NULL).
540 * @param scpi_response Pointer where to store the parsed result.
542 * @return SR_OK upon successfully parsing all values, SR_ERR upon a parsing
543 * error or upon no response. The allocated response must be freed by
544 * the caller in the case of an SR_OK as well as in the case of
547 SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
548 const char *command, GArray **scpi_response)
552 gchar **ptr, **tokens;
553 GArray *response_array;
559 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
563 tokens = g_strsplit(response, ",", 0);
566 response_array = g_array_sized_new(TRUE, FALSE, sizeof(uint8_t), 256);
569 if (sr_atoi(*ptr, &tmp) == SR_OK)
570 response_array = g_array_append_val(response_array,
580 if (response_array->len == 0) {
581 g_array_free(response_array, TRUE);
582 *scpi_response = NULL;
586 *scpi_response = response_array;
592 * Send the *IDN? SCPI command, receive the reply, parse it and store the
593 * reply as a sr_scpi_hw_info structure in the supplied scpi_response pointer.
595 * The hw_info structure must be freed by the caller via sr_scpi_hw_info_free().
597 * @param scpi Previously initialised SCPI device structure.
598 * @param scpi_response Pointer where to store the hw_info structure.
600 * @return SR_OK upon success, SR_ERR on failure.
602 SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
603 struct sr_scpi_hw_info **scpi_response)
609 struct sr_scpi_hw_info *hw_info;
614 if (sr_scpi_get_string(scpi, SCPI_CMD_IDN, &response) != SR_OK)
618 sr_info("Got IDN string: '%s'", response);
620 /* Remove trailing newline if present. */
621 if ((newline = g_strrstr(response, "\n")))
625 * The response to a '*IDN?' is specified by the SCPI spec. It contains
626 * a comma-separated list containing the manufacturer name, instrument
627 * model, serial number of the instrument and the firmware version.
629 tokens = g_strsplit(response, ",", 0);
631 for (num_tokens = 0; tokens[num_tokens] != NULL; num_tokens++);
633 if (num_tokens != 4) {
634 sr_dbg("IDN response not according to spec: %80.s.", response);
641 hw_info = g_try_malloc(sizeof(struct sr_scpi_hw_info));
644 return SR_ERR_MALLOC;
647 hw_info->manufacturer = g_strdup(tokens[0]);
648 hw_info->model = g_strdup(tokens[1]);
649 hw_info->serial_number = g_strdup(tokens[2]);
650 hw_info->firmware_version = g_strdup(tokens[3]);
654 *scpi_response = hw_info;
660 * Free a sr_scpi_hw_info struct.
662 * @param hw_info Pointer to the struct to free.
664 * This function is safe to call with a NULL pointer.
666 SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info)
669 g_free(hw_info->manufacturer);
670 g_free(hw_info->model);
671 g_free(hw_info->serial_number);
672 g_free(hw_info->firmware_version);