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 struct sr_scpi_dev_inst *scpi_dev_inst_new(const char *resource,
69 const char *serialcomm)
71 struct sr_scpi_dev_inst *scpi = NULL;
72 const char *usbtmc_prefix = "/dev/usbtmc";
73 const char *tcp_prefix = "tcp/";
74 const char *vxi_prefix = "vxi/";
75 gchar **tokens, *address, *port, *instrument;
77 if (strncmp(resource, usbtmc_prefix, strlen(usbtmc_prefix)) == 0) {
78 sr_dbg("Opening USBTMC device %s.", resource);
79 scpi = scpi_usbtmc_dev_inst_new(resource);
80 } else if (strncmp(resource, tcp_prefix, strlen(tcp_prefix)) == 0) {
81 sr_dbg("Opening TCP connection %s.", resource);
82 tokens = g_strsplit(resource + strlen(tcp_prefix), "/", 0);
85 if (address && port && !tokens[2])
86 scpi = scpi_tcp_dev_inst_new(address, port);
88 sr_err("Invalid parameters.");
90 } else if (HAVE_RPC && !strncmp(resource, vxi_prefix, strlen(vxi_prefix))) {
91 sr_dbg("Opening VXI connection %s.", resource);
92 tokens = g_strsplit(resource + strlen(tcp_prefix), "/", 0);
94 instrument = tokens[1];
95 if (address && (!instrument || !tokens[2]))
96 scpi = scpi_vxi_dev_inst_new(address, instrument);
98 sr_err("Invalid parameters.");
101 sr_dbg("Opening serial device %s.", resource);
102 scpi = scpi_serial_dev_inst_new(resource, serialcomm);
110 * @param scpi Previously initialized SCPI device structure.
112 * @return SR_OK on success, SR_ERR on failure.
114 SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi)
116 return scpi->open(scpi->priv);
120 * Add an event source for an SCPI device.
122 * @param scpi Previously initialized SCPI device structure.
123 * @param events Events to check for.
124 * @param timeout Max time to wait before the callback is called, ignored if 0.
125 * @param cb Callback function to add. Must not be NULL.
126 * @param cb_data Data for the callback function. Can be NULL.
128 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
129 * SR_ERR_MALLOC upon memory allocation errors.
131 SR_PRIV int sr_scpi_source_add(struct sr_scpi_dev_inst *scpi, int events,
132 int timeout, sr_receive_data_callback_t cb, void *cb_data)
134 return scpi->source_add(scpi->priv, events, timeout, cb, cb_data);
138 * Remove event source for an SCPI device.
140 * @param scpi Previously initialized SCPI device structure.
142 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
143 * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
146 SR_PRIV int sr_scpi_source_remove(struct sr_scpi_dev_inst *scpi)
148 return scpi->source_remove(scpi->priv);
152 * Send a SCPI command.
154 * @param scpi Previously initialized SCPI device structure.
155 * @param format Format string, to be followed by any necessary arguments.
157 * @return SR_OK on success, SR_ERR on failure.
159 SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi,
160 const char *format, ...)
165 va_start(args, format);
166 ret = sr_scpi_send_variadic(scpi, format, args);
173 * Send a SCPI command with a variadic argument list.
175 * @param scpi Previously initialized SCPI device structure.
176 * @param format Format string.
177 * @param args Argument list.
179 * @return SR_OK on success, SR_ERR on failure.
181 SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
182 const char *format, va_list args)
188 /* Get length of buffer required. */
189 va_copy(args_copy, args);
190 len = vsnprintf(NULL, 0, format, args_copy);
193 /* Allocate buffer and write out command. */
194 buf = g_malloc(len + 1);
195 vsprintf(buf, format, args);
198 ret = scpi->send(scpi->priv, buf);
200 /* Free command buffer. */
207 * Begin receiving an SCPI reply.
209 * @param scpi Previously initialised SCPI device structure.
211 * @return SR_OK on success, SR_ERR on failure.
213 SR_PRIV int sr_scpi_read_begin(struct sr_scpi_dev_inst *scpi)
215 return scpi->read_begin(scpi->priv);
219 * Read part of a response from SCPI device.
221 * @param scpi Previously initialised SCPI device structure.
222 * @param buf Buffer to store result.
223 * @param maxlen Maximum number of bytes to read.
225 * @return Number of bytes read, or SR_ERR upon failure.
227 SR_PRIV int sr_scpi_read_data(struct sr_scpi_dev_inst *scpi,
228 char *buf, int maxlen)
230 return scpi->read_data(scpi->priv, buf, maxlen);
234 * Check whether a complete SCPI response has been received.
236 * @param scpi Previously initialised SCPI device structure.
238 * @return 1 if complete, 0 otherwise.
240 SR_PRIV int sr_scpi_read_complete(struct sr_scpi_dev_inst *scpi)
242 return scpi->read_complete(scpi->priv);
248 * @param scpi Previously initialized SCPI device structure.
250 * @return SR_OK on success, SR_ERR on failure.
252 SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi)
254 return scpi->close(scpi->priv);
260 * @param scpi Previously initialized SCPI device structure.
262 * @return SR_OK on success, SR_ERR on failure.
264 SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi)
266 scpi->free(scpi->priv);
271 * Send a SCPI command, receive the reply and store the reply in scpi_response.
273 * @param scpi Previously initialised SCPI device structure.
274 * @param command The SCPI command to send to the device (can be NULL).
275 * @param scpi_response Pointer where to store the SCPI response.
277 * @return SR_OK on success, SR_ERR on failure.
279 SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
280 const char *command, char **scpi_response)
287 if (sr_scpi_send(scpi, command) != SR_OK)
290 if (sr_scpi_read_begin(scpi) != SR_OK)
293 response = g_string_new("");
295 *scpi_response = NULL;
297 while (!sr_scpi_read_complete(scpi)) {
298 len = sr_scpi_read_data(scpi, buf, sizeof(buf));
300 g_string_free(response, TRUE);
303 g_string_append_len(response, buf, len);
306 *scpi_response = response->str;
307 g_string_free(response, FALSE);
313 * Send a SCPI command, read the reply, parse it as a bool value and store the
314 * result in scpi_response.
316 * @param scpi Previously initialised SCPI device structure.
317 * @param command The SCPI command to send to the device (can be NULL).
318 * @param scpi_response Pointer where to store the parsed result.
320 * @return SR_OK on success, SR_ERR on failure.
322 SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
323 const char *command, gboolean *scpi_response)
330 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
334 if (parse_strict_bool(response, scpi_response) == SR_OK)
345 * Send a SCPI command, read the reply, parse it as an integer and store the
346 * result in scpi_response.
348 * @param scpi Previously initialised SCPI device structure.
349 * @param command The SCPI command to send to the device (can be NULL).
350 * @param scpi_response Pointer where to store the parsed result.
352 * @return SR_OK on success, SR_ERR on failure.
354 SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
355 const char *command, int *scpi_response)
362 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
366 if (sr_atoi(response, scpi_response) == SR_OK)
377 * Send a SCPI command, read the reply, parse it as a float and store the
378 * result in scpi_response.
380 * @param scpi Previously initialised SCPI device structure.
381 * @param command The SCPI command to send to the device (can be NULL).
382 * @param scpi_response Pointer where to store the parsed result.
384 * @return SR_OK on success, SR_ERR on failure.
386 SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
387 const char *command, float *scpi_response)
394 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
398 if (sr_atof(response, scpi_response) == SR_OK)
409 * Send a SCPI command, read the reply, parse it as a double and store the
410 * result in scpi_response.
412 * @param scpi Previously initialised SCPI device structure.
413 * @param command The SCPI command to send to the device (can be NULL).
414 * @param scpi_response Pointer where to store the parsed result.
416 * @return SR_OK on success, SR_ERR on failure.
418 SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
419 const char *command, double *scpi_response)
426 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
430 if (sr_atod(response, scpi_response) == SR_OK)
441 * Send a SCPI *OPC? command, read the reply and return the result of the
444 * @param scpi Previously initialised SCPI device structure.
446 * @return SR_OK on success, SR_ERR on failure.
448 SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi)
453 for (i = 0; i < SCPI_READ_RETRIES; ++i) {
454 sr_scpi_get_bool(scpi, SCPI_CMD_OPC, &opc);
457 g_usleep(SCPI_READ_RETRY_TIMEOUT);
464 * Send a SCPI command, read the reply, parse it as comma separated list of
465 * floats and store the as an result in scpi_response.
467 * @param scpi Previously initialised SCPI device structure.
468 * @param command The SCPI command to send to the device (can be NULL).
469 * @param scpi_response Pointer where to store the parsed result.
471 * @return SR_OK upon successfully parsing all values, SR_ERR upon a parsing
472 * error or upon no response. The allocated response must be freed by
473 * the caller in the case of an SR_OK as well as in the case of
476 SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
477 const char *command, GArray **scpi_response)
482 gchar **ptr, **tokens;
483 GArray *response_array;
489 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
493 tokens = g_strsplit(response, ",", 0);
496 response_array = g_array_sized_new(TRUE, FALSE, sizeof(float), 256);
499 if (sr_atof(*ptr, &tmp) == SR_OK)
500 response_array = g_array_append_val(response_array,
510 if (ret == SR_ERR && response_array->len == 0) {
511 g_array_free(response_array, TRUE);
512 *scpi_response = NULL;
516 *scpi_response = response_array;
522 * Send a SCPI command, read the reply, parse it as comma separated list of
523 * unsigned 8 bit integers and store the as an result in scpi_response.
525 * @param scpi Previously initialised SCPI device structure.
526 * @param command The SCPI command to send to the device (can be NULL).
527 * @param scpi_response Pointer where to store the parsed result.
529 * @return SR_OK upon successfully parsing all values, SR_ERR upon a parsing
530 * error or upon no response. The allocated response must be freed by
531 * the caller in the case of an SR_OK as well as in the case of
534 SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
535 const char *command, GArray **scpi_response)
539 gchar **ptr, **tokens;
540 GArray *response_array;
546 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
550 tokens = g_strsplit(response, ",", 0);
553 response_array = g_array_sized_new(TRUE, FALSE, sizeof(uint8_t), 256);
556 if (sr_atoi(*ptr, &tmp) == SR_OK)
557 response_array = g_array_append_val(response_array,
567 if (response_array->len == 0) {
568 g_array_free(response_array, TRUE);
569 *scpi_response = NULL;
573 *scpi_response = response_array;
579 * Send the *IDN? SCPI command, receive the reply, parse it and store the
580 * reply as a sr_scpi_hw_info structure in the supplied scpi_response pointer.
582 * The hw_info structure must be freed by the caller via sr_scpi_hw_info_free().
584 * @param scpi Previously initialised SCPI device structure.
585 * @param scpi_response Pointer where to store the hw_info structure.
587 * @return SR_OK upon success, SR_ERR on failure.
589 SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
590 struct sr_scpi_hw_info **scpi_response)
596 struct sr_scpi_hw_info *hw_info;
601 if (sr_scpi_get_string(scpi, SCPI_CMD_IDN, &response) != SR_OK)
605 sr_info("Got IDN string: '%s'", response);
607 /* Remove trailing newline if present. */
608 if ((newline = g_strrstr(response, "\n")))
612 * The response to a '*IDN?' is specified by the SCPI spec. It contains
613 * a comma-separated list containing the manufacturer name, instrument
614 * model, serial number of the instrument and the firmware version.
616 tokens = g_strsplit(response, ",", 0);
618 for (num_tokens = 0; tokens[num_tokens] != NULL; num_tokens++);
620 if (num_tokens != 4) {
621 sr_dbg("IDN response not according to spec: %80.s.", response);
628 hw_info = g_try_malloc(sizeof(struct sr_scpi_hw_info));
631 return SR_ERR_MALLOC;
634 hw_info->manufacturer = g_strdup(tokens[0]);
635 hw_info->model = g_strdup(tokens[1]);
636 hw_info->serial_number = g_strdup(tokens[2]);
637 hw_info->firmware_version = g_strdup(tokens[3]);
641 *scpi_response = hw_info;
647 * Free a sr_scpi_hw_info struct.
649 * @param hw_info Pointer to the struct to free.
651 * This function is safe to call with a NULL pointer.
653 SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info)
656 g_free(hw_info->manufacturer);
657 g_free(hw_info->model);
658 g_free(hw_info->serial_number);
659 g_free(hw_info->firmware_version);