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 GSList *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)))
109 return g_slist_append(NULL, sdi);
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, *d, *devices = NULL;
120 const char *resource = NULL;
121 const char *serialcomm = NULL;
125 for (l = options; l; l = l->next) {
126 struct sr_config *src = l->data;
129 resource = g_variant_get_string(src->data, NULL);
131 case SR_CONF_SERIALCOMM:
132 serialcomm = g_variant_get_string(src->data, NULL);
137 for (i = 0; i < ARRAY_SIZE(scpi_devs); i++) {
138 if ((resource && strcmp(resource, scpi_devs[i]->prefix))
139 || !scpi_devs[i]->scan)
141 resources = scpi_devs[i]->scan(drvc);
142 for (l = resources; l; l = l->next) {
143 res = g_strsplit(l->data, ":", 2);
144 if (res[0] && (d = sr_scpi_scan_resource(drvc, res[0],
145 serialcomm ? serialcomm : res[1], probe_device)))
146 devices = g_slist_concat(devices, d);
149 g_slist_free_full(resources, g_free);
152 if (!devices && resource)
153 devices = sr_scpi_scan_resource(drvc, resource, serialcomm,
156 /* Tack a copy of the newly found devices onto the driver list. */
158 drvc->instances = g_slist_concat(drvc->instances,
159 g_slist_copy(devices));
164 SR_PRIV struct sr_scpi_dev_inst *scpi_dev_inst_new(struct drv_context *drvc,
165 const char *resource, const char *serialcomm)
167 struct sr_scpi_dev_inst *scpi = NULL;
168 const struct sr_scpi_dev_inst *scpi_dev;
172 for (i = 0; i < ARRAY_SIZE(scpi_devs); i++) {
173 scpi_dev = scpi_devs[i];
174 if (!strncmp(resource, scpi_dev->prefix, strlen(scpi_dev->prefix))) {
175 sr_dbg("Opening %s device %s.", scpi_dev->name, resource);
176 scpi = g_malloc(sizeof(*scpi));
178 scpi->priv = g_malloc0(scpi->priv_size);
179 params = g_strsplit(resource, "/", 0);
180 if (scpi->dev_inst_new(scpi->priv, drvc, resource,
181 params, serialcomm) != SR_OK) {
196 * @param scpi Previously initialized SCPI device structure.
198 * @return SR_OK on success, SR_ERR on failure.
200 SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi)
202 return scpi->open(scpi->priv);
206 * Add an event source for an SCPI device.
208 * @param scpi Previously initialized SCPI device structure.
209 * @param events Events to check for.
210 * @param timeout Max time to wait before the callback is called, ignored if 0.
211 * @param cb Callback function to add. Must not be NULL.
212 * @param cb_data Data for the callback function. Can be NULL.
214 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
215 * SR_ERR_MALLOC upon memory allocation errors.
217 SR_PRIV int sr_scpi_source_add(struct sr_scpi_dev_inst *scpi, int events,
218 int timeout, sr_receive_data_callback cb, void *cb_data)
220 return scpi->source_add(scpi->priv, events, timeout, cb, cb_data);
224 * Remove event source for an SCPI device.
226 * @param scpi Previously initialized SCPI device structure.
228 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
229 * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
232 SR_PRIV int sr_scpi_source_remove(struct sr_scpi_dev_inst *scpi)
234 return scpi->source_remove(scpi->priv);
238 * Send a SCPI command.
240 * @param scpi Previously initialized SCPI device structure.
241 * @param format Format string, to be followed by any necessary arguments.
243 * @return SR_OK on success, SR_ERR on failure.
245 SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi,
246 const char *format, ...)
251 va_start(args, format);
252 ret = sr_scpi_send_variadic(scpi, format, args);
259 * Send a SCPI command with a variadic argument list.
261 * @param scpi Previously initialized SCPI device structure.
262 * @param format Format string.
263 * @param args Argument list.
265 * @return SR_OK on success, SR_ERR on failure.
267 SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
268 const char *format, va_list args)
274 /* Get length of buffer required. */
275 va_copy(args_copy, args);
276 len = vsnprintf(NULL, 0, format, args_copy);
279 /* Allocate buffer and write out command. */
280 buf = g_malloc(len + 1);
281 vsprintf(buf, format, args);
284 ret = scpi->send(scpi->priv, buf);
286 /* Free command buffer. */
293 * Begin receiving an SCPI reply.
295 * @param scpi Previously initialised SCPI device structure.
297 * @return SR_OK on success, SR_ERR on failure.
299 SR_PRIV int sr_scpi_read_begin(struct sr_scpi_dev_inst *scpi)
301 return scpi->read_begin(scpi->priv);
305 * Read part of a response from SCPI device.
307 * @param scpi Previously initialised SCPI device structure.
308 * @param buf Buffer to store result.
309 * @param maxlen Maximum number of bytes to read.
311 * @return Number of bytes read, or SR_ERR upon failure.
313 SR_PRIV int sr_scpi_read_data(struct sr_scpi_dev_inst *scpi,
314 char *buf, int maxlen)
316 return scpi->read_data(scpi->priv, buf, maxlen);
320 * Check whether a complete SCPI response has been received.
322 * @param scpi Previously initialised SCPI device structure.
324 * @return 1 if complete, 0 otherwise.
326 SR_PRIV int sr_scpi_read_complete(struct sr_scpi_dev_inst *scpi)
328 return scpi->read_complete(scpi->priv);
334 * @param scpi Previously initialized SCPI device structure.
336 * @return SR_OK on success, SR_ERR on failure.
338 SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi)
340 return scpi->close(scpi->priv);
346 * @param scpi Previously initialized SCPI device structure.
348 * @return SR_OK on success, SR_ERR on failure.
350 SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi)
352 scpi->free(scpi->priv);
358 * Send a SCPI command, receive the reply and store the reply in scpi_response.
360 * @param scpi Previously initialised SCPI device structure.
361 * @param command The SCPI command to send to the device (can be NULL).
362 * @param scpi_response Pointer where to store the SCPI response.
364 * @return SR_OK on success, SR_ERR on failure.
366 SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
367 const char *command, char **scpi_response)
374 if (sr_scpi_send(scpi, command) != SR_OK)
377 if (sr_scpi_read_begin(scpi) != SR_OK)
380 response = g_string_new("");
382 *scpi_response = NULL;
384 while (!sr_scpi_read_complete(scpi)) {
385 len = sr_scpi_read_data(scpi, buf, sizeof(buf));
387 g_string_free(response, TRUE);
390 g_string_append_len(response, buf, len);
393 /* Get rid of trailing linefeed if present */
394 if (response->len >= 1 && response->str[response->len - 1] == '\n')
395 g_string_truncate(response, response->len - 1);
397 *scpi_response = response->str;
398 g_string_free(response, FALSE);
400 sr_spew("Got response: '%.70s'.", *scpi_response);
406 * Send a SCPI command, read the reply, parse it as a bool value and store the
407 * result in scpi_response.
409 * @param scpi Previously initialised SCPI device structure.
410 * @param command The SCPI command to send to the device (can be NULL).
411 * @param scpi_response Pointer where to store the parsed result.
413 * @return SR_OK on success, SR_ERR on failure.
415 SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
416 const char *command, gboolean *scpi_response)
423 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
427 if (parse_strict_bool(response, scpi_response) == SR_OK)
438 * Send a SCPI command, read the reply, parse it as an integer and store the
439 * result in scpi_response.
441 * @param scpi Previously initialised SCPI device structure.
442 * @param command The SCPI command to send to the device (can be NULL).
443 * @param scpi_response Pointer where to store the parsed result.
445 * @return SR_OK on success, SR_ERR on failure.
447 SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
448 const char *command, int *scpi_response)
455 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
459 if (sr_atoi(response, scpi_response) == SR_OK)
470 * Send a SCPI command, read the reply, parse it as a float and store the
471 * result in scpi_response.
473 * @param scpi Previously initialised SCPI device structure.
474 * @param command The SCPI command to send to the device (can be NULL).
475 * @param scpi_response Pointer where to store the parsed result.
477 * @return SR_OK on success, SR_ERR on failure.
479 SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
480 const char *command, float *scpi_response)
487 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
491 if (sr_atof_ascii(response, scpi_response) == SR_OK)
502 * Send a SCPI command, read the reply, parse it as a double and store the
503 * result in scpi_response.
505 * @param scpi Previously initialised SCPI device structure.
506 * @param command The SCPI command to send to the device (can be NULL).
507 * @param scpi_response Pointer where to store the parsed result.
509 * @return SR_OK on success, SR_ERR on failure.
511 SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
512 const char *command, double *scpi_response)
519 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
523 if (sr_atod(response, scpi_response) == SR_OK)
534 * Send a SCPI *OPC? command, read the reply and return the result of the
537 * @param scpi Previously initialised SCPI device structure.
539 * @return SR_OK on success, SR_ERR on failure.
541 SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi)
546 for (i = 0; i < SCPI_READ_RETRIES; ++i) {
547 sr_scpi_get_bool(scpi, SCPI_CMD_OPC, &opc);
550 g_usleep(SCPI_READ_RETRY_TIMEOUT);
557 * Send a SCPI command, read the reply, parse it as comma separated list of
558 * floats and store the as an result in scpi_response.
560 * @param scpi Previously initialised SCPI device structure.
561 * @param command The SCPI command to send to the device (can be NULL).
562 * @param scpi_response Pointer where to store the parsed result.
564 * @return SR_OK upon successfully parsing all values, SR_ERR upon a parsing
565 * error or upon no response. The allocated response must be freed by
566 * the caller in the case of an SR_OK as well as in the case of
569 SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
570 const char *command, GArray **scpi_response)
575 gchar **ptr, **tokens;
576 GArray *response_array;
582 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
586 tokens = g_strsplit(response, ",", 0);
589 response_array = g_array_sized_new(TRUE, FALSE, sizeof(float), 256);
592 if (sr_atof_ascii(*ptr, &tmp) == SR_OK)
593 response_array = g_array_append_val(response_array,
603 if (ret == SR_ERR && response_array->len == 0) {
604 g_array_free(response_array, TRUE);
605 *scpi_response = NULL;
609 *scpi_response = response_array;
615 * Send a SCPI command, read the reply, parse it as comma separated list of
616 * unsigned 8 bit integers and store the as an result in scpi_response.
618 * @param scpi Previously initialised SCPI device structure.
619 * @param command The SCPI command to send to the device (can be NULL).
620 * @param scpi_response Pointer where to store the parsed result.
622 * @return SR_OK upon successfully parsing all values, SR_ERR upon a parsing
623 * error or upon no response. The allocated response must be freed by
624 * the caller in the case of an SR_OK as well as in the case of
627 SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
628 const char *command, GArray **scpi_response)
632 gchar **ptr, **tokens;
633 GArray *response_array;
639 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
643 tokens = g_strsplit(response, ",", 0);
646 response_array = g_array_sized_new(TRUE, FALSE, sizeof(uint8_t), 256);
649 if (sr_atoi(*ptr, &tmp) == SR_OK)
650 response_array = g_array_append_val(response_array,
660 if (response_array->len == 0) {
661 g_array_free(response_array, TRUE);
662 *scpi_response = NULL;
666 *scpi_response = response_array;
672 * Send the *IDN? SCPI command, receive the reply, parse it and store the
673 * reply as a sr_scpi_hw_info structure in the supplied scpi_response pointer.
675 * The hw_info structure must be freed by the caller via sr_scpi_hw_info_free().
677 * @param scpi Previously initialised SCPI device structure.
678 * @param scpi_response Pointer where to store the hw_info structure.
680 * @return SR_OK upon success, SR_ERR on failure.
682 SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
683 struct sr_scpi_hw_info **scpi_response)
688 struct sr_scpi_hw_info *hw_info;
693 if (sr_scpi_get_string(scpi, SCPI_CMD_IDN, &response) != SR_OK)
697 sr_info("Got IDN string: '%s'", response);
700 * The response to a '*IDN?' is specified by the SCPI spec. It contains
701 * a comma-separated list containing the manufacturer name, instrument
702 * model, serial number of the instrument and the firmware version.
704 tokens = g_strsplit(response, ",", 0);
706 for (num_tokens = 0; tokens[num_tokens] != NULL; num_tokens++);
708 if (num_tokens != 4) {
709 sr_dbg("IDN response not according to spec: %80.s.", response);
716 hw_info = g_try_malloc(sizeof(struct sr_scpi_hw_info));
719 return SR_ERR_MALLOC;
722 hw_info->manufacturer = g_strdup(tokens[0]);
723 hw_info->model = g_strdup(tokens[1]);
724 hw_info->serial_number = g_strdup(tokens[2]);
725 hw_info->firmware_version = g_strdup(tokens[3]);
729 *scpi_response = hw_info;
735 * Free a sr_scpi_hw_info struct.
737 * @param hw_info Pointer to the struct to free.
739 * This function is safe to call with a NULL pointer.
741 SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info)
744 g_free(hw_info->manufacturer);
745 g_free(hw_info->model);
746 g_free(hw_info->serial_number);
747 g_free(hw_info->firmware_version);