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;
75 static const struct sr_scpi_dev_inst *scpi_devs[] = {
78 #ifdef HAVE_LIBUSB_1_0
79 &scpi_usbtmc_libusb_dev,
87 #ifdef HAVE_LIBSERIALPORT
88 &scpi_serial_dev, /* must be last as it matches any resource */
92 static struct sr_dev_inst *sr_scpi_scan_resource(struct drv_context *drvc,
93 const char *resource, const char *serialcomm,
94 struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi))
96 struct sr_scpi_dev_inst *scpi;
97 struct sr_dev_inst *sdi;
99 if (!(scpi = scpi_dev_inst_new(drvc, resource, serialcomm)))
102 if (sr_scpi_open(scpi) != SR_OK) {
103 sr_info("Couldn't open SCPI device.");
108 if ((sdi = probe_device(scpi)))
116 SR_PRIV GSList *sr_scpi_scan(struct drv_context *drvc, GSList *options,
117 struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi))
119 GSList *resources, *l, *devices;
120 struct sr_dev_inst *sdi;
121 const char *resource = NULL;
122 const char *serialcomm = NULL;
126 for (l = options; l; l = l->next) {
127 struct sr_config *src = l->data;
130 resource = g_variant_get_string(src->data, NULL);
132 case SR_CONF_SERIALCOMM:
133 serialcomm = g_variant_get_string(src->data, NULL);
139 for (i = 0; i < ARRAY_SIZE(scpi_devs); i++) {
140 if ((resource && strcmp(resource, scpi_devs[i]->prefix))
141 || !scpi_devs[i]->scan)
143 resources = scpi_devs[i]->scan(drvc);
144 for (l = resources; l; l = l->next) {
145 res = g_strsplit(l->data, ":", 2);
146 if (res[0] && (sdi = sr_scpi_scan_resource(drvc, res[0],
147 serialcomm ? serialcomm : res[1], probe_device)))
148 devices = g_slist_append(devices, sdi);
151 g_slist_free_full(resources, g_free);
154 if (!devices && resource) {
155 sdi = sr_scpi_scan_resource(drvc, resource, serialcomm, probe_device);
156 devices = g_slist_append(NULL, sdi);
159 /* Tack a copy of the newly found devices onto the driver list. */
161 drvc->instances = g_slist_concat(drvc->instances, g_slist_copy(devices));
166 SR_PRIV struct sr_scpi_dev_inst *scpi_dev_inst_new(struct drv_context *drvc,
167 const char *resource, const char *serialcomm)
169 struct sr_scpi_dev_inst *scpi = NULL;
170 const struct sr_scpi_dev_inst *scpi_dev;
174 for (i = 0; i < ARRAY_SIZE(scpi_devs); i++) {
175 scpi_dev = scpi_devs[i];
176 if (!strncmp(resource, scpi_dev->prefix, strlen(scpi_dev->prefix))) {
177 sr_dbg("Opening %s device %s.", scpi_dev->name, resource);
178 scpi = g_malloc(sizeof(*scpi));
180 scpi->priv = g_malloc0(scpi->priv_size);
181 params = g_strsplit(resource, "/", 0);
182 if (scpi->dev_inst_new(scpi->priv, drvc, resource,
183 params, serialcomm) != SR_OK) {
198 * @param scpi Previously initialized SCPI device structure.
200 * @return SR_OK on success, SR_ERR on failure.
202 SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi)
204 return scpi->open(scpi->priv);
208 * Add an event source for an SCPI device.
210 * @param session The session to add the event source to.
211 * @param scpi Previously initialized SCPI device structure.
212 * @param events Events to check for.
213 * @param timeout Max time to wait before the callback is called, ignored if 0.
214 * @param cb Callback function to add. Must not be NULL.
215 * @param cb_data Data for the callback function. Can be NULL.
217 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
218 * SR_ERR_MALLOC upon memory allocation errors.
220 SR_PRIV int sr_scpi_source_add(struct sr_session *session,
221 struct sr_scpi_dev_inst *scpi, int events, int timeout,
222 sr_receive_data_callback cb, void *cb_data)
224 return scpi->source_add(session, scpi->priv, events, timeout, cb, cb_data);
228 * Remove event source for an SCPI device.
230 * @param session The session to remove the event source from.
231 * @param scpi Previously initialized SCPI device structure.
233 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
234 * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
237 SR_PRIV int sr_scpi_source_remove(struct sr_session *session,
238 struct sr_scpi_dev_inst *scpi)
240 return scpi->source_remove(session, scpi->priv);
244 * Send a SCPI command.
246 * @param scpi Previously initialized SCPI device structure.
247 * @param format Format string, to be followed by any necessary arguments.
249 * @return SR_OK on success, SR_ERR on failure.
251 SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi,
252 const char *format, ...)
257 va_start(args, format);
258 ret = sr_scpi_send_variadic(scpi, format, args);
265 * Send a SCPI command with a variadic argument list.
267 * @param scpi Previously initialized SCPI device structure.
268 * @param format Format string.
269 * @param args Argument list.
271 * @return SR_OK on success, SR_ERR on failure.
273 SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
274 const char *format, va_list args)
280 /* Get length of buffer required. */
281 va_copy(args_copy, args);
282 len = vsnprintf(NULL, 0, format, args_copy);
285 /* Allocate buffer and write out command. */
286 buf = g_malloc(len + 1);
287 vsprintf(buf, format, args);
290 ret = scpi->send(scpi->priv, buf);
292 /* Free command buffer. */
299 * Begin receiving an SCPI reply.
301 * @param scpi Previously initialised SCPI device structure.
303 * @return SR_OK on success, SR_ERR on failure.
305 SR_PRIV int sr_scpi_read_begin(struct sr_scpi_dev_inst *scpi)
307 return scpi->read_begin(scpi->priv);
311 * Read part of a response from SCPI device.
313 * @param scpi Previously initialised SCPI device structure.
314 * @param buf Buffer to store result.
315 * @param maxlen Maximum number of bytes to read.
317 * @return Number of bytes read, or SR_ERR upon failure.
319 SR_PRIV int sr_scpi_read_data(struct sr_scpi_dev_inst *scpi,
320 char *buf, int maxlen)
322 return scpi->read_data(scpi->priv, buf, maxlen);
326 * Check whether a complete SCPI response has been received.
328 * @param scpi Previously initialised SCPI device structure.
330 * @return 1 if complete, 0 otherwise.
332 SR_PRIV int sr_scpi_read_complete(struct sr_scpi_dev_inst *scpi)
334 return scpi->read_complete(scpi->priv);
340 * @param scpi Previously initialized SCPI device structure.
342 * @return SR_OK on success, SR_ERR on failure.
344 SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi)
346 return scpi->close(scpi->priv);
352 * @param scpi Previously initialized SCPI device structure.
354 * @return SR_OK on success, SR_ERR on failure.
356 SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi)
358 scpi->free(scpi->priv);
364 * Send a SCPI command, receive the reply and store the reply in scpi_response.
366 * @param scpi Previously initialised SCPI device structure.
367 * @param command The SCPI command to send to the device (can be NULL).
368 * @param scpi_response Pointer where to store the SCPI response.
370 * @return SR_OK on success, SR_ERR on failure.
372 SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
373 const char *command, char **scpi_response)
380 if (sr_scpi_send(scpi, command) != SR_OK)
383 if (sr_scpi_read_begin(scpi) != SR_OK)
386 response = g_string_new("");
388 *scpi_response = NULL;
390 while (!sr_scpi_read_complete(scpi)) {
391 len = sr_scpi_read_data(scpi, buf, sizeof(buf));
393 g_string_free(response, TRUE);
396 g_string_append_len(response, buf, len);
399 /* Get rid of trailing linefeed if present */
400 if (response->len >= 1 && response->str[response->len - 1] == '\n')
401 g_string_truncate(response, response->len - 1);
403 *scpi_response = response->str;
404 g_string_free(response, FALSE);
406 sr_spew("Got response: '%.70s'.", *scpi_response);
412 * Send a SCPI command, read the reply, parse it as a bool value and store the
413 * result in scpi_response.
415 * @param scpi Previously initialised SCPI device structure.
416 * @param command The SCPI command to send to the device (can be NULL).
417 * @param scpi_response Pointer where to store the parsed result.
419 * @return SR_OK on success, SR_ERR on failure.
421 SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
422 const char *command, gboolean *scpi_response)
429 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
433 if (parse_strict_bool(response, scpi_response) == SR_OK)
444 * Send a SCPI command, read the reply, parse it as an integer and store the
445 * result in scpi_response.
447 * @param scpi Previously initialised SCPI device structure.
448 * @param command The SCPI command to send to the device (can be NULL).
449 * @param scpi_response Pointer where to store the parsed result.
451 * @return SR_OK on success, SR_ERR on failure.
453 SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
454 const char *command, int *scpi_response)
461 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
465 if (sr_atoi(response, scpi_response) == SR_OK)
476 * Send a SCPI command, read the reply, parse it as a float and store the
477 * result in scpi_response.
479 * @param scpi Previously initialised SCPI device structure.
480 * @param command The SCPI command to send to the device (can be NULL).
481 * @param scpi_response Pointer where to store the parsed result.
483 * @return SR_OK on success, SR_ERR on failure.
485 SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
486 const char *command, float *scpi_response)
493 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
497 if (sr_atof_ascii(response, scpi_response) == SR_OK)
508 * Send a SCPI command, read the reply, parse it as a double and store the
509 * result in scpi_response.
511 * @param scpi Previously initialised SCPI device structure.
512 * @param command The SCPI command to send to the device (can be NULL).
513 * @param scpi_response Pointer where to store the parsed result.
515 * @return SR_OK on success, SR_ERR on failure.
517 SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
518 const char *command, double *scpi_response)
525 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
529 if (sr_atod(response, scpi_response) == SR_OK)
540 * Send a SCPI *OPC? command, read the reply and return the result of the
543 * @param scpi Previously initialised SCPI device structure.
545 * @return SR_OK on success, SR_ERR on failure.
547 SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi)
552 for (i = 0; i < SCPI_READ_RETRIES; ++i) {
553 sr_scpi_get_bool(scpi, SCPI_CMD_OPC, &opc);
556 g_usleep(SCPI_READ_RETRY_TIMEOUT);
563 * Send a SCPI command, read the reply, parse it as comma separated list of
564 * floats and store the as an result in scpi_response.
566 * @param scpi Previously initialised SCPI device structure.
567 * @param command The SCPI command to send to the device (can be NULL).
568 * @param scpi_response Pointer where to store the parsed result.
570 * @return SR_OK upon successfully parsing all values, SR_ERR upon a parsing
571 * error or upon no response. The allocated response must be freed by
572 * the caller in the case of an SR_OK as well as in the case of
575 SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
576 const char *command, GArray **scpi_response)
581 gchar **ptr, **tokens;
582 GArray *response_array;
588 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
592 tokens = g_strsplit(response, ",", 0);
595 response_array = g_array_sized_new(TRUE, FALSE, sizeof(float), 256);
598 if (sr_atof_ascii(*ptr, &tmp) == SR_OK)
599 response_array = g_array_append_val(response_array,
609 if (ret == SR_ERR && response_array->len == 0) {
610 g_array_free(response_array, TRUE);
611 *scpi_response = NULL;
615 *scpi_response = response_array;
621 * Send a SCPI command, read the reply, parse it as comma separated list of
622 * unsigned 8 bit integers and store the as an result in scpi_response.
624 * @param scpi Previously initialised SCPI device structure.
625 * @param command The SCPI command to send to the device (can be NULL).
626 * @param scpi_response Pointer where to store the parsed result.
628 * @return SR_OK upon successfully parsing all values, SR_ERR upon a parsing
629 * error or upon no response. The allocated response must be freed by
630 * the caller in the case of an SR_OK as well as in the case of
633 SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
634 const char *command, GArray **scpi_response)
638 gchar **ptr, **tokens;
639 GArray *response_array;
645 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
649 tokens = g_strsplit(response, ",", 0);
652 response_array = g_array_sized_new(TRUE, FALSE, sizeof(uint8_t), 256);
655 if (sr_atoi(*ptr, &tmp) == SR_OK)
656 response_array = g_array_append_val(response_array,
666 if (response_array->len == 0) {
667 g_array_free(response_array, TRUE);
668 *scpi_response = NULL;
672 *scpi_response = response_array;
678 * Send the *IDN? SCPI command, receive the reply, parse it and store the
679 * reply as a sr_scpi_hw_info structure in the supplied scpi_response pointer.
681 * The hw_info structure must be freed by the caller via sr_scpi_hw_info_free().
683 * @param scpi Previously initialised SCPI device structure.
684 * @param scpi_response Pointer where to store the hw_info structure.
686 * @return SR_OK upon success, SR_ERR on failure.
688 SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
689 struct sr_scpi_hw_info **scpi_response)
694 struct sr_scpi_hw_info *hw_info;
699 if (sr_scpi_get_string(scpi, SCPI_CMD_IDN, &response) != SR_OK)
703 sr_info("Got IDN string: '%s'", response);
706 * The response to a '*IDN?' is specified by the SCPI spec. It contains
707 * a comma-separated list containing the manufacturer name, instrument
708 * model, serial number of the instrument and the firmware version.
710 tokens = g_strsplit(response, ",", 0);
712 for (num_tokens = 0; tokens[num_tokens] != NULL; num_tokens++);
714 if (num_tokens != 4) {
715 sr_dbg("IDN response not according to spec: %80.s.", response);
722 hw_info = g_try_malloc(sizeof(struct sr_scpi_hw_info));
725 return SR_ERR_MALLOC;
728 hw_info->manufacturer = g_strdup(tokens[0]);
729 hw_info->model = g_strdup(tokens[1]);
730 hw_info->serial_number = g_strdup(tokens[2]);
731 hw_info->firmware_version = g_strdup(tokens[3]);
735 *scpi_response = hw_info;
741 * Free a sr_scpi_hw_info struct.
743 * @param hw_info Pointer to the struct to free.
745 * This function is safe to call with a NULL pointer.
747 SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info)
750 g_free(hw_info->manufacturer);
751 g_free(hw_info->model);
752 g_free(hw_info->serial_number);
753 g_free(hw_info->firmware_version);