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/>.
22 #include "libsigrok.h"
23 #include "libsigrok-internal.h"
25 #define LOG_PREFIX "scpi"
27 #define SCPI_READ_RETRIES 100
28 #define SCPI_READ_RETRY_TIMEOUT_US (10 * 1000)
31 * Parse a string representation of a boolean-like value into a gboolean.
32 * Similar to sr_parse_boolstring but rejects strings which do not represent
33 * a boolean-like value.
35 * @param str String to convert.
36 * @param ret Pointer to a gboolean where the result of the conversion will be
39 * @return SR_OK on success, SR_ERR on failure.
41 static int parse_strict_bool(const char *str, gboolean *ret)
46 if (!g_strcmp0(str, "1") ||
47 !g_ascii_strncasecmp(str, "y", 1) ||
48 !g_ascii_strncasecmp(str, "t", 1) ||
49 !g_ascii_strncasecmp(str, "yes", 3) ||
50 !g_ascii_strncasecmp(str, "true", 4) ||
51 !g_ascii_strncasecmp(str, "on", 2)) {
54 } else if (!g_strcmp0(str, "0") ||
55 !g_ascii_strncasecmp(str, "n", 1) ||
56 !g_ascii_strncasecmp(str, "f", 1) ||
57 !g_ascii_strncasecmp(str, "no", 2) ||
58 !g_ascii_strncasecmp(str, "false", 5) ||
59 !g_ascii_strncasecmp(str, "off", 3)) {
67 SR_PRIV extern const struct sr_scpi_dev_inst scpi_serial_dev;
68 SR_PRIV extern const struct sr_scpi_dev_inst scpi_tcp_raw_dev;
69 SR_PRIV extern const struct sr_scpi_dev_inst scpi_tcp_rigol_dev;
70 SR_PRIV extern const struct sr_scpi_dev_inst scpi_usbtmc_libusb_dev;
71 SR_PRIV extern const struct sr_scpi_dev_inst scpi_vxi_dev;
72 SR_PRIV extern const struct sr_scpi_dev_inst scpi_visa_dev;
73 SR_PRIV extern const struct sr_scpi_dev_inst scpi_libgpib_dev;
75 static const struct sr_scpi_dev_inst *scpi_devs[] = {
78 #ifdef HAVE_LIBUSB_1_0
79 &scpi_usbtmc_libusb_dev,
90 #ifdef HAVE_LIBSERIALPORT
91 &scpi_serial_dev, /* must be last as it matches any resource */
95 static struct sr_dev_inst *sr_scpi_scan_resource(struct drv_context *drvc,
96 const char *resource, const char *serialcomm,
97 struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi))
99 struct sr_scpi_dev_inst *scpi;
100 struct sr_dev_inst *sdi;
102 if (!(scpi = scpi_dev_inst_new(drvc, resource, serialcomm)))
105 if (sr_scpi_open(scpi) != SR_OK) {
106 sr_info("Couldn't open SCPI device.");
111 if ((sdi = probe_device(scpi)))
119 SR_PRIV GSList *sr_scpi_scan(struct drv_context *drvc, GSList *options,
120 struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi))
122 GSList *resources, *l, *devices;
123 struct sr_dev_inst *sdi;
124 const char *resource = NULL;
125 const char *serialcomm = NULL;
129 for (l = options; l; l = l->next) {
130 struct sr_config *src = l->data;
133 resource = g_variant_get_string(src->data, NULL);
135 case SR_CONF_SERIALCOMM:
136 serialcomm = g_variant_get_string(src->data, NULL);
142 for (i = 0; i < ARRAY_SIZE(scpi_devs); i++) {
143 if ((resource && strcmp(resource, scpi_devs[i]->prefix))
144 || !scpi_devs[i]->scan)
146 resources = scpi_devs[i]->scan(drvc);
147 for (l = resources; l; l = l->next) {
148 res = g_strsplit(l->data, ":", 2);
149 if (res[0] && (sdi = sr_scpi_scan_resource(drvc, res[0],
150 serialcomm ? serialcomm : res[1], probe_device))) {
151 devices = g_slist_append(devices, sdi);
152 sdi->connection_id = g_strdup(l->data);
156 g_slist_free_full(resources, g_free);
159 if (!devices && resource) {
160 sdi = sr_scpi_scan_resource(drvc, resource, serialcomm, probe_device);
162 devices = g_slist_append(NULL, sdi);
165 /* Tack a copy of the newly found devices onto the driver list. */
167 drvc->instances = g_slist_concat(drvc->instances, g_slist_copy(devices));
172 SR_PRIV struct sr_scpi_dev_inst *scpi_dev_inst_new(struct drv_context *drvc,
173 const char *resource, const char *serialcomm)
175 struct sr_scpi_dev_inst *scpi = NULL;
176 const struct sr_scpi_dev_inst *scpi_dev;
180 for (i = 0; i < ARRAY_SIZE(scpi_devs); i++) {
181 scpi_dev = scpi_devs[i];
182 if (!strncmp(resource, scpi_dev->prefix, strlen(scpi_dev->prefix))) {
183 sr_dbg("Opening %s device %s.", scpi_dev->name, resource);
184 scpi = g_malloc(sizeof(*scpi));
186 scpi->priv = g_malloc0(scpi->priv_size);
187 scpi->read_timeout_ms = 1000;
188 params = g_strsplit(resource, "/", 0);
189 if (scpi->dev_inst_new(scpi->priv, drvc, resource,
190 params, serialcomm) != SR_OK) {
205 * @param scpi Previously initialized SCPI device structure.
207 * @return SR_OK on success, SR_ERR on failure.
209 SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi)
211 return scpi->open(scpi->priv);
215 * Add an event source for an SCPI device.
217 * @param session The session to add the event source to.
218 * @param scpi Previously initialized SCPI device structure.
219 * @param events Events to check for.
220 * @param timeout Max time to wait before the callback is called, ignored if 0.
221 * @param cb Callback function to add. Must not be NULL.
222 * @param cb_data Data for the callback function. Can be NULL.
224 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
225 * SR_ERR_MALLOC upon memory allocation errors.
227 SR_PRIV int sr_scpi_source_add(struct sr_session *session,
228 struct sr_scpi_dev_inst *scpi, int events, int timeout,
229 sr_receive_data_callback cb, void *cb_data)
231 return scpi->source_add(session, scpi->priv, events, timeout, cb, cb_data);
235 * Remove event source for an SCPI device.
237 * @param session The session to remove the event source from.
238 * @param scpi Previously initialized SCPI device structure.
240 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
241 * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
244 SR_PRIV int sr_scpi_source_remove(struct sr_session *session,
245 struct sr_scpi_dev_inst *scpi)
247 return scpi->source_remove(session, scpi->priv);
251 * Send a SCPI command.
253 * @param scpi Previously initialized SCPI device structure.
254 * @param format Format string, to be followed by any necessary arguments.
256 * @return SR_OK on success, SR_ERR on failure.
258 SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi,
259 const char *format, ...)
264 va_start(args, format);
265 ret = sr_scpi_send_variadic(scpi, format, args);
272 * Send a SCPI command with a variadic argument list.
274 * @param scpi Previously initialized SCPI device structure.
275 * @param format Format string.
276 * @param args Argument list.
278 * @return SR_OK on success, SR_ERR on failure.
280 SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
281 const char *format, va_list args)
287 /* Get length of buffer required. */
288 va_copy(args_copy, args);
289 len = vsnprintf(NULL, 0, format, args_copy);
292 /* Allocate buffer and write out command. */
293 buf = g_malloc(len + 1);
294 vsprintf(buf, format, args);
297 ret = scpi->send(scpi->priv, buf);
299 /* Free command buffer. */
306 * Begin receiving an SCPI reply.
308 * @param scpi Previously initialised SCPI device structure.
310 * @return SR_OK on success, SR_ERR on failure.
312 SR_PRIV int sr_scpi_read_begin(struct sr_scpi_dev_inst *scpi)
314 return scpi->read_begin(scpi->priv);
318 * Read part of a response from SCPI device.
320 * @param scpi Previously initialised SCPI device structure.
321 * @param buf Buffer to store result.
322 * @param maxlen Maximum number of bytes to read.
324 * @return Number of bytes read, or SR_ERR upon failure.
326 SR_PRIV int sr_scpi_read_data(struct sr_scpi_dev_inst *scpi,
327 char *buf, int maxlen)
329 return scpi->read_data(scpi->priv, buf, maxlen);
333 * Check whether a complete SCPI response has been received.
335 * @param scpi Previously initialised SCPI device structure.
337 * @return 1 if complete, 0 otherwise.
339 SR_PRIV int sr_scpi_read_complete(struct sr_scpi_dev_inst *scpi)
341 return scpi->read_complete(scpi->priv);
347 * @param scpi Previously initialized SCPI device structure.
349 * @return SR_OK on success, SR_ERR on failure.
351 SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi)
353 return scpi->close(scpi->priv);
359 * @param scpi Previously initialized SCPI device structure.
361 * @return SR_OK on success, SR_ERR on failure.
363 SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi)
365 scpi->free(scpi->priv);
371 * Send a SCPI command, receive the reply and store the reply in scpi_response.
373 * @param scpi Previously initialised SCPI device structure.
374 * @param command The SCPI command to send to the device (can be NULL).
375 * @param scpi_response Pointer where to store the SCPI response.
377 * @return SR_OK on success, SR_ERR on failure.
379 SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
380 const char *command, char **scpi_response)
386 unsigned int elapsed_ms;
389 if (sr_scpi_send(scpi, command) != SR_OK)
392 if (sr_scpi_read_begin(scpi) != SR_OK)
395 laststart = g_get_monotonic_time();
397 response = g_string_new("");
399 *scpi_response = NULL;
401 while (!sr_scpi_read_complete(scpi)) {
402 len = sr_scpi_read_data(scpi, buf, sizeof(buf));
404 sr_err("Incompletely read SCPI response.");
405 g_string_free(response, TRUE);
407 } else if (len > 0) {
408 laststart = g_get_monotonic_time();
410 g_string_append_len(response, buf, len);
411 elapsed_ms = (g_get_monotonic_time() - laststart) / 1000;
412 if (elapsed_ms >= scpi->read_timeout_ms) {
413 sr_err("Timed out waiting for SCPI response.");
414 g_string_free(response, TRUE);
419 /* Get rid of trailing linefeed if present */
420 if (response->len >= 1 && response->str[response->len - 1] == '\n')
421 g_string_truncate(response, response->len - 1);
423 /* Get rid of trailing carriage return if present */
424 if (response->len >= 1 && response->str[response->len - 1] == '\r')
425 g_string_truncate(response, response->len - 1);
427 *scpi_response = response->str;
428 g_string_free(response, FALSE);
430 sr_spew("Got response: '%.70s', length %d.", *scpi_response, strlen(*scpi_response));
436 * Send a SCPI command, read the reply, parse it as a bool value 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_bool(struct sr_scpi_dev_inst *scpi,
446 const char *command, gboolean *scpi_response)
453 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
457 if (parse_strict_bool(response, scpi_response) == SR_OK)
468 * Send a SCPI command, read the reply, parse it as an integer 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_int(struct sr_scpi_dev_inst *scpi,
478 const char *command, int *scpi_response)
485 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
489 if (sr_atoi(response, scpi_response) == SR_OK)
500 * Send a SCPI command, read the reply, parse it as a float 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_float(struct sr_scpi_dev_inst *scpi,
510 const char *command, float *scpi_response)
517 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
521 if (sr_atof_ascii(response, scpi_response) == SR_OK)
532 * Send a SCPI command, read the reply, parse it as a double and store the
533 * result in scpi_response.
535 * @param scpi Previously initialised SCPI device structure.
536 * @param command The SCPI command to send to the device (can be NULL).
537 * @param scpi_response Pointer where to store the parsed result.
539 * @return SR_OK on success, SR_ERR on failure.
541 SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
542 const char *command, double *scpi_response)
549 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
553 if (sr_atod(response, scpi_response) == SR_OK)
564 * Send a SCPI *OPC? command, read the reply and return the result of the
567 * @param scpi Previously initialised SCPI device structure.
569 * @return SR_OK on success, SR_ERR on failure.
571 SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi)
576 for (i = 0; i < SCPI_READ_RETRIES; ++i) {
577 sr_scpi_get_bool(scpi, SCPI_CMD_OPC, &opc);
580 g_usleep(SCPI_READ_RETRY_TIMEOUT_US);
587 * Send a SCPI command, read the reply, parse it as comma separated list of
588 * floats and store the as an result in scpi_response.
590 * @param scpi Previously initialised SCPI device structure.
591 * @param command The SCPI command to send to the device (can be NULL).
592 * @param scpi_response Pointer where to store the parsed result.
594 * @return SR_OK upon successfully parsing all values, SR_ERR upon a parsing
595 * error or upon no response. The allocated response must be freed by
596 * the caller in the case of an SR_OK as well as in the case of
599 SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
600 const char *command, GArray **scpi_response)
605 gchar **ptr, **tokens;
606 GArray *response_array;
612 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
616 tokens = g_strsplit(response, ",", 0);
619 response_array = g_array_sized_new(TRUE, FALSE, sizeof(float), 256);
622 if (sr_atof_ascii(*ptr, &tmp) == SR_OK)
623 response_array = g_array_append_val(response_array,
633 if (ret == SR_ERR && response_array->len == 0) {
634 g_array_free(response_array, TRUE);
635 *scpi_response = NULL;
639 *scpi_response = response_array;
645 * Send a SCPI command, read the reply, parse it as comma separated list of
646 * unsigned 8 bit integers and store the as an result in scpi_response.
648 * @param scpi Previously initialised SCPI device structure.
649 * @param command The SCPI command to send to the device (can be NULL).
650 * @param scpi_response Pointer where to store the parsed result.
652 * @return SR_OK upon successfully parsing all values, SR_ERR upon a parsing
653 * error or upon no response. The allocated response must be freed by
654 * the caller in the case of an SR_OK as well as in the case of
657 SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
658 const char *command, GArray **scpi_response)
662 gchar **ptr, **tokens;
663 GArray *response_array;
669 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
673 tokens = g_strsplit(response, ",", 0);
676 response_array = g_array_sized_new(TRUE, FALSE, sizeof(uint8_t), 256);
679 if (sr_atoi(*ptr, &tmp) == SR_OK)
680 response_array = g_array_append_val(response_array,
690 if (response_array->len == 0) {
691 g_array_free(response_array, TRUE);
692 *scpi_response = NULL;
696 *scpi_response = response_array;
702 * Send the *IDN? SCPI command, receive the reply, parse it and store the
703 * reply as a sr_scpi_hw_info structure in the supplied scpi_response pointer.
705 * The hw_info structure must be freed by the caller via sr_scpi_hw_info_free().
707 * @param scpi Previously initialised SCPI device structure.
708 * @param scpi_response Pointer where to store the hw_info structure.
710 * @return SR_OK upon success, SR_ERR on failure.
712 SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
713 struct sr_scpi_hw_info **scpi_response)
718 struct sr_scpi_hw_info *hw_info;
723 if (sr_scpi_get_string(scpi, SCPI_CMD_IDN, &response) != SR_OK)
727 sr_info("Got IDN string: '%s'", response);
730 * The response to a '*IDN?' is specified by the SCPI spec. It contains
731 * a comma-separated list containing the manufacturer name, instrument
732 * model, serial number of the instrument and the firmware version.
734 tokens = g_strsplit(response, ",", 0);
736 for (num_tokens = 0; tokens[num_tokens] != NULL; num_tokens++);
738 if (num_tokens < 4) {
739 sr_dbg("IDN response not according to spec: %80.s.", response);
746 hw_info = g_malloc0(sizeof(struct sr_scpi_hw_info));
747 hw_info->manufacturer = g_strdup(tokens[0]);
748 hw_info->model = g_strdup(tokens[1]);
749 hw_info->serial_number = g_strdup(tokens[2]);
750 hw_info->firmware_version = g_strdup(tokens[3]);
754 *scpi_response = hw_info;
760 * Free a sr_scpi_hw_info struct.
762 * @param hw_info Pointer to the struct to free.
764 * This function is safe to call with a NULL pointer.
766 SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info)
769 g_free(hw_info->manufacturer);
770 g_free(hw_info->model);
771 g_free(hw_info->serial_number);
772 g_free(hw_info->firmware_version);