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 SR_PRIV struct sr_scpi_dev_inst *scpi_dev_inst_new(struct drv_context *drvc,
91 const char *resource, const char *serialcomm)
93 struct sr_scpi_dev_inst *scpi = NULL;
94 const struct sr_scpi_dev_inst *scpi_dev;
98 for (i = 0; i < ARRAY_SIZE(scpi_devs); i++) {
99 scpi_dev = scpi_devs[i];
100 if (!strncmp(resource, scpi_dev->prefix, strlen(scpi_dev->prefix))) {
101 sr_dbg("Opening %s device %s.", scpi_dev->name, resource);
102 scpi = g_malloc(sizeof(*scpi));
104 scpi->priv = g_malloc0(scpi->priv_size);
105 params = g_strsplit(resource, "/", 0);
106 if (scpi->dev_inst_new(scpi->priv, drvc, resource,
107 params, serialcomm) != SR_OK) {
122 * @param scpi Previously initialized SCPI device structure.
124 * @return SR_OK on success, SR_ERR on failure.
126 SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi)
128 return scpi->open(scpi->priv);
132 * Add an event source for an SCPI device.
134 * @param scpi Previously initialized SCPI device structure.
135 * @param events Events to check for.
136 * @param timeout Max time to wait before the callback is called, ignored if 0.
137 * @param cb Callback function to add. Must not be NULL.
138 * @param cb_data Data for the callback function. Can be NULL.
140 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
141 * SR_ERR_MALLOC upon memory allocation errors.
143 SR_PRIV int sr_scpi_source_add(struct sr_scpi_dev_inst *scpi, int events,
144 int timeout, sr_receive_data_callback_t cb, void *cb_data)
146 return scpi->source_add(scpi->priv, events, timeout, cb, cb_data);
150 * Remove event source for an SCPI device.
152 * @param scpi Previously initialized SCPI device structure.
154 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
155 * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
158 SR_PRIV int sr_scpi_source_remove(struct sr_scpi_dev_inst *scpi)
160 return scpi->source_remove(scpi->priv);
164 * Send a SCPI command.
166 * @param scpi Previously initialized SCPI device structure.
167 * @param format Format string, to be followed by any necessary arguments.
169 * @return SR_OK on success, SR_ERR on failure.
171 SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi,
172 const char *format, ...)
177 va_start(args, format);
178 ret = sr_scpi_send_variadic(scpi, format, args);
185 * Send a SCPI command with a variadic argument list.
187 * @param scpi Previously initialized SCPI device structure.
188 * @param format Format string.
189 * @param args Argument list.
191 * @return SR_OK on success, SR_ERR on failure.
193 SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
194 const char *format, va_list args)
200 /* Get length of buffer required. */
201 va_copy(args_copy, args);
202 len = vsnprintf(NULL, 0, format, args_copy);
205 /* Allocate buffer and write out command. */
206 buf = g_malloc(len + 1);
207 vsprintf(buf, format, args);
210 ret = scpi->send(scpi->priv, buf);
212 /* Free command buffer. */
219 * Begin receiving an SCPI reply.
221 * @param scpi Previously initialised SCPI device structure.
223 * @return SR_OK on success, SR_ERR on failure.
225 SR_PRIV int sr_scpi_read_begin(struct sr_scpi_dev_inst *scpi)
227 return scpi->read_begin(scpi->priv);
231 * Read part of a response from SCPI device.
233 * @param scpi Previously initialised SCPI device structure.
234 * @param buf Buffer to store result.
235 * @param maxlen Maximum number of bytes to read.
237 * @return Number of bytes read, or SR_ERR upon failure.
239 SR_PRIV int sr_scpi_read_data(struct sr_scpi_dev_inst *scpi,
240 char *buf, int maxlen)
242 return scpi->read_data(scpi->priv, buf, maxlen);
246 * Check whether a complete SCPI response has been received.
248 * @param scpi Previously initialised SCPI device structure.
250 * @return 1 if complete, 0 otherwise.
252 SR_PRIV int sr_scpi_read_complete(struct sr_scpi_dev_inst *scpi)
254 return scpi->read_complete(scpi->priv);
260 * @param scpi Previously initialized SCPI device structure.
262 * @return SR_OK on success, SR_ERR on failure.
264 SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi)
266 return scpi->close(scpi->priv);
272 * @param scpi Previously initialized SCPI device structure.
274 * @return SR_OK on success, SR_ERR on failure.
276 SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi)
278 scpi->free(scpi->priv);
284 * Send a SCPI command, receive the reply and store the reply in scpi_response.
286 * @param scpi Previously initialised SCPI device structure.
287 * @param command The SCPI command to send to the device (can be NULL).
288 * @param scpi_response Pointer where to store the SCPI response.
290 * @return SR_OK on success, SR_ERR on failure.
292 SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
293 const char *command, char **scpi_response)
300 if (sr_scpi_send(scpi, command) != SR_OK)
303 if (sr_scpi_read_begin(scpi) != SR_OK)
306 response = g_string_new("");
308 *scpi_response = NULL;
310 while (!sr_scpi_read_complete(scpi)) {
311 len = sr_scpi_read_data(scpi, buf, sizeof(buf));
313 g_string_free(response, TRUE);
316 g_string_append_len(response, buf, len);
319 /* Get rid of trailing linefeed if present */
320 if (response->len >= 1 && response->str[response->len - 1] == '\n')
321 g_string_truncate(response, response->len - 1);
323 *scpi_response = response->str;
324 g_string_free(response, FALSE);
326 sr_spew("Got response: '%.70s'.", *scpi_response);
332 * Send a SCPI command, read the reply, parse it as a bool value and store the
333 * result in scpi_response.
335 * @param scpi Previously initialised SCPI device structure.
336 * @param command The SCPI command to send to the device (can be NULL).
337 * @param scpi_response Pointer where to store the parsed result.
339 * @return SR_OK on success, SR_ERR on failure.
341 SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
342 const char *command, gboolean *scpi_response)
349 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
353 if (parse_strict_bool(response, scpi_response) == SR_OK)
364 * Send a SCPI command, read the reply, parse it as an integer and store the
365 * result in scpi_response.
367 * @param scpi Previously initialised SCPI device structure.
368 * @param command The SCPI command to send to the device (can be NULL).
369 * @param scpi_response Pointer where to store the parsed result.
371 * @return SR_OK on success, SR_ERR on failure.
373 SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
374 const char *command, int *scpi_response)
381 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
385 if (sr_atoi(response, scpi_response) == SR_OK)
396 * Send a SCPI command, read the reply, parse it as a float and store the
397 * result in scpi_response.
399 * @param scpi Previously initialised SCPI device structure.
400 * @param command The SCPI command to send to the device (can be NULL).
401 * @param scpi_response Pointer where to store the parsed result.
403 * @return SR_OK on success, SR_ERR on failure.
405 SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
406 const char *command, float *scpi_response)
413 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
417 if (sr_atof_ascii(response, scpi_response) == SR_OK)
428 * Send a SCPI command, read the reply, parse it as a double and store the
429 * result in scpi_response.
431 * @param scpi Previously initialised SCPI device structure.
432 * @param command The SCPI command to send to the device (can be NULL).
433 * @param scpi_response Pointer where to store the parsed result.
435 * @return SR_OK on success, SR_ERR on failure.
437 SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
438 const char *command, double *scpi_response)
445 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
449 if (sr_atod(response, scpi_response) == SR_OK)
460 * Send a SCPI *OPC? command, read the reply and return the result of the
463 * @param scpi Previously initialised SCPI device structure.
465 * @return SR_OK on success, SR_ERR on failure.
467 SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi)
472 for (i = 0; i < SCPI_READ_RETRIES; ++i) {
473 sr_scpi_get_bool(scpi, SCPI_CMD_OPC, &opc);
476 g_usleep(SCPI_READ_RETRY_TIMEOUT);
483 * Send a SCPI command, read the reply, parse it as comma separated list of
484 * floats and store the as an result in scpi_response.
486 * @param scpi Previously initialised SCPI device structure.
487 * @param command The SCPI command to send to the device (can be NULL).
488 * @param scpi_response Pointer where to store the parsed result.
490 * @return SR_OK upon successfully parsing all values, SR_ERR upon a parsing
491 * error or upon no response. The allocated response must be freed by
492 * the caller in the case of an SR_OK as well as in the case of
495 SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
496 const char *command, GArray **scpi_response)
501 gchar **ptr, **tokens;
502 GArray *response_array;
508 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
512 tokens = g_strsplit(response, ",", 0);
515 response_array = g_array_sized_new(TRUE, FALSE, sizeof(float), 256);
518 if (sr_atof_ascii(*ptr, &tmp) == SR_OK)
519 response_array = g_array_append_val(response_array,
529 if (ret == SR_ERR && response_array->len == 0) {
530 g_array_free(response_array, TRUE);
531 *scpi_response = NULL;
535 *scpi_response = response_array;
541 * Send a SCPI command, read the reply, parse it as comma separated list of
542 * unsigned 8 bit integers and store the as an result in scpi_response.
544 * @param scpi Previously initialised SCPI device structure.
545 * @param command The SCPI command to send to the device (can be NULL).
546 * @param scpi_response Pointer where to store the parsed result.
548 * @return SR_OK upon successfully parsing all values, SR_ERR upon a parsing
549 * error or upon no response. The allocated response must be freed by
550 * the caller in the case of an SR_OK as well as in the case of
553 SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
554 const char *command, GArray **scpi_response)
558 gchar **ptr, **tokens;
559 GArray *response_array;
565 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
569 tokens = g_strsplit(response, ",", 0);
572 response_array = g_array_sized_new(TRUE, FALSE, sizeof(uint8_t), 256);
575 if (sr_atoi(*ptr, &tmp) == SR_OK)
576 response_array = g_array_append_val(response_array,
586 if (response_array->len == 0) {
587 g_array_free(response_array, TRUE);
588 *scpi_response = NULL;
592 *scpi_response = response_array;
598 * Send the *IDN? SCPI command, receive the reply, parse it and store the
599 * reply as a sr_scpi_hw_info structure in the supplied scpi_response pointer.
601 * The hw_info structure must be freed by the caller via sr_scpi_hw_info_free().
603 * @param scpi Previously initialised SCPI device structure.
604 * @param scpi_response Pointer where to store the hw_info structure.
606 * @return SR_OK upon success, SR_ERR on failure.
608 SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
609 struct sr_scpi_hw_info **scpi_response)
614 struct sr_scpi_hw_info *hw_info;
619 if (sr_scpi_get_string(scpi, SCPI_CMD_IDN, &response) != SR_OK)
623 sr_info("Got IDN string: '%s'", response);
626 * The response to a '*IDN?' is specified by the SCPI spec. It contains
627 * a comma-separated list containing the manufacturer name, instrument
628 * model, serial number of the instrument and the firmware version.
630 tokens = g_strsplit(response, ",", 0);
632 for (num_tokens = 0; tokens[num_tokens] != NULL; num_tokens++);
634 if (num_tokens != 4) {
635 sr_dbg("IDN response not according to spec: %80.s.", response);
642 hw_info = g_try_malloc(sizeof(struct sr_scpi_hw_info));
645 return SR_ERR_MALLOC;
648 hw_info->manufacturer = g_strdup(tokens[0]);
649 hw_info->model = g_strdup(tokens[1]);
650 hw_info->serial_number = g_strdup(tokens[2]);
651 hw_info->firmware_version = g_strdup(tokens[3]);
655 *scpi_response = hw_info;
661 * Free a sr_scpi_hw_info struct.
663 * @param hw_info Pointer to the struct to free.
665 * This function is safe to call with a NULL pointer.
667 SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info)
670 g_free(hw_info->manufacturer);
671 g_free(hw_info->model);
672 g_free(hw_info->serial_number);
673 g_free(hw_info->firmware_version);