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 scpi Previously initialized SCPI device structure.
211 * @param events Events to check for.
212 * @param timeout Max time to wait before the callback is called, ignored if 0.
213 * @param cb Callback function to add. Must not be NULL.
214 * @param cb_data Data for the callback function. Can be NULL.
216 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
217 * SR_ERR_MALLOC upon memory allocation errors.
219 SR_PRIV int sr_scpi_source_add(struct sr_session *session,
220 struct sr_scpi_dev_inst *scpi, int events, int timeout,
221 sr_receive_data_callback cb, void *cb_data)
223 return scpi->source_add(session, scpi->priv, events, timeout, cb, cb_data);
227 * Remove event source for an SCPI device.
229 * @param scpi Previously initialized SCPI device structure.
231 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
232 * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
235 SR_PRIV int sr_scpi_source_remove(struct sr_session *session,
236 struct sr_scpi_dev_inst *scpi)
238 return scpi->source_remove(session, scpi->priv);
242 * Send a SCPI command.
244 * @param scpi Previously initialized SCPI device structure.
245 * @param format Format string, to be followed by any necessary arguments.
247 * @return SR_OK on success, SR_ERR on failure.
249 SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi,
250 const char *format, ...)
255 va_start(args, format);
256 ret = sr_scpi_send_variadic(scpi, format, args);
263 * Send a SCPI command with a variadic argument list.
265 * @param scpi Previously initialized SCPI device structure.
266 * @param format Format string.
267 * @param args Argument list.
269 * @return SR_OK on success, SR_ERR on failure.
271 SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
272 const char *format, va_list args)
278 /* Get length of buffer required. */
279 va_copy(args_copy, args);
280 len = vsnprintf(NULL, 0, format, args_copy);
283 /* Allocate buffer and write out command. */
284 buf = g_malloc(len + 1);
285 vsprintf(buf, format, args);
288 ret = scpi->send(scpi->priv, buf);
290 /* Free command buffer. */
297 * Begin receiving an SCPI reply.
299 * @param scpi Previously initialised SCPI device structure.
301 * @return SR_OK on success, SR_ERR on failure.
303 SR_PRIV int sr_scpi_read_begin(struct sr_scpi_dev_inst *scpi)
305 return scpi->read_begin(scpi->priv);
309 * Read part of a response from SCPI device.
311 * @param scpi Previously initialised SCPI device structure.
312 * @param buf Buffer to store result.
313 * @param maxlen Maximum number of bytes to read.
315 * @return Number of bytes read, or SR_ERR upon failure.
317 SR_PRIV int sr_scpi_read_data(struct sr_scpi_dev_inst *scpi,
318 char *buf, int maxlen)
320 return scpi->read_data(scpi->priv, buf, maxlen);
324 * Check whether a complete SCPI response has been received.
326 * @param scpi Previously initialised SCPI device structure.
328 * @return 1 if complete, 0 otherwise.
330 SR_PRIV int sr_scpi_read_complete(struct sr_scpi_dev_inst *scpi)
332 return scpi->read_complete(scpi->priv);
338 * @param scpi Previously initialized SCPI device structure.
340 * @return SR_OK on success, SR_ERR on failure.
342 SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi)
344 return scpi->close(scpi->priv);
350 * @param scpi Previously initialized SCPI device structure.
352 * @return SR_OK on success, SR_ERR on failure.
354 SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi)
356 scpi->free(scpi->priv);
362 * Send a SCPI command, receive the reply and store the reply in scpi_response.
364 * @param scpi Previously initialised SCPI device structure.
365 * @param command The SCPI command to send to the device (can be NULL).
366 * @param scpi_response Pointer where to store the SCPI response.
368 * @return SR_OK on success, SR_ERR on failure.
370 SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
371 const char *command, char **scpi_response)
378 if (sr_scpi_send(scpi, command) != SR_OK)
381 if (sr_scpi_read_begin(scpi) != SR_OK)
384 response = g_string_new("");
386 *scpi_response = NULL;
388 while (!sr_scpi_read_complete(scpi)) {
389 len = sr_scpi_read_data(scpi, buf, sizeof(buf));
391 g_string_free(response, TRUE);
394 g_string_append_len(response, buf, len);
397 /* Get rid of trailing linefeed if present */
398 if (response->len >= 1 && response->str[response->len - 1] == '\n')
399 g_string_truncate(response, response->len - 1);
401 *scpi_response = response->str;
402 g_string_free(response, FALSE);
404 sr_spew("Got response: '%.70s'.", *scpi_response);
410 * Send a SCPI command, read the reply, parse it as a bool value and store the
411 * result in scpi_response.
413 * @param scpi Previously initialised SCPI device structure.
414 * @param command The SCPI command to send to the device (can be NULL).
415 * @param scpi_response Pointer where to store the parsed result.
417 * @return SR_OK on success, SR_ERR on failure.
419 SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
420 const char *command, gboolean *scpi_response)
427 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
431 if (parse_strict_bool(response, scpi_response) == SR_OK)
442 * Send a SCPI command, read the reply, parse it as an integer and store the
443 * result in scpi_response.
445 * @param scpi Previously initialised SCPI device structure.
446 * @param command The SCPI command to send to the device (can be NULL).
447 * @param scpi_response Pointer where to store the parsed result.
449 * @return SR_OK on success, SR_ERR on failure.
451 SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
452 const char *command, int *scpi_response)
459 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
463 if (sr_atoi(response, scpi_response) == SR_OK)
474 * Send a SCPI command, read the reply, parse it as a float and store the
475 * result in scpi_response.
477 * @param scpi Previously initialised SCPI device structure.
478 * @param command The SCPI command to send to the device (can be NULL).
479 * @param scpi_response Pointer where to store the parsed result.
481 * @return SR_OK on success, SR_ERR on failure.
483 SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
484 const char *command, float *scpi_response)
491 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
495 if (sr_atof_ascii(response, scpi_response) == SR_OK)
506 * Send a SCPI command, read the reply, parse it as a double and store the
507 * result in scpi_response.
509 * @param scpi Previously initialised SCPI device structure.
510 * @param command The SCPI command to send to the device (can be NULL).
511 * @param scpi_response Pointer where to store the parsed result.
513 * @return SR_OK on success, SR_ERR on failure.
515 SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
516 const char *command, double *scpi_response)
523 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
527 if (sr_atod(response, scpi_response) == SR_OK)
538 * Send a SCPI *OPC? command, read the reply and return the result of the
541 * @param scpi Previously initialised SCPI device structure.
543 * @return SR_OK on success, SR_ERR on failure.
545 SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi)
550 for (i = 0; i < SCPI_READ_RETRIES; ++i) {
551 sr_scpi_get_bool(scpi, SCPI_CMD_OPC, &opc);
554 g_usleep(SCPI_READ_RETRY_TIMEOUT);
561 * Send a SCPI command, read the reply, parse it as comma separated list of
562 * floats and store the as an result in scpi_response.
564 * @param scpi Previously initialised SCPI device structure.
565 * @param command The SCPI command to send to the device (can be NULL).
566 * @param scpi_response Pointer where to store the parsed result.
568 * @return SR_OK upon successfully parsing all values, SR_ERR upon a parsing
569 * error or upon no response. The allocated response must be freed by
570 * the caller in the case of an SR_OK as well as in the case of
573 SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
574 const char *command, GArray **scpi_response)
579 gchar **ptr, **tokens;
580 GArray *response_array;
586 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
590 tokens = g_strsplit(response, ",", 0);
593 response_array = g_array_sized_new(TRUE, FALSE, sizeof(float), 256);
596 if (sr_atof_ascii(*ptr, &tmp) == SR_OK)
597 response_array = g_array_append_val(response_array,
607 if (ret == SR_ERR && response_array->len == 0) {
608 g_array_free(response_array, TRUE);
609 *scpi_response = NULL;
613 *scpi_response = response_array;
619 * Send a SCPI command, read the reply, parse it as comma separated list of
620 * unsigned 8 bit integers and store the as an result in scpi_response.
622 * @param scpi Previously initialised SCPI device structure.
623 * @param command The SCPI command to send to the device (can be NULL).
624 * @param scpi_response Pointer where to store the parsed result.
626 * @return SR_OK upon successfully parsing all values, SR_ERR upon a parsing
627 * error or upon no response. The allocated response must be freed by
628 * the caller in the case of an SR_OK as well as in the case of
631 SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
632 const char *command, GArray **scpi_response)
636 gchar **ptr, **tokens;
637 GArray *response_array;
643 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
647 tokens = g_strsplit(response, ",", 0);
650 response_array = g_array_sized_new(TRUE, FALSE, sizeof(uint8_t), 256);
653 if (sr_atoi(*ptr, &tmp) == SR_OK)
654 response_array = g_array_append_val(response_array,
664 if (response_array->len == 0) {
665 g_array_free(response_array, TRUE);
666 *scpi_response = NULL;
670 *scpi_response = response_array;
676 * Send the *IDN? SCPI command, receive the reply, parse it and store the
677 * reply as a sr_scpi_hw_info structure in the supplied scpi_response pointer.
679 * The hw_info structure must be freed by the caller via sr_scpi_hw_info_free().
681 * @param scpi Previously initialised SCPI device structure.
682 * @param scpi_response Pointer where to store the hw_info structure.
684 * @return SR_OK upon success, SR_ERR on failure.
686 SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
687 struct sr_scpi_hw_info **scpi_response)
692 struct sr_scpi_hw_info *hw_info;
697 if (sr_scpi_get_string(scpi, SCPI_CMD_IDN, &response) != SR_OK)
701 sr_info("Got IDN string: '%s'", response);
704 * The response to a '*IDN?' is specified by the SCPI spec. It contains
705 * a comma-separated list containing the manufacturer name, instrument
706 * model, serial number of the instrument and the firmware version.
708 tokens = g_strsplit(response, ",", 0);
710 for (num_tokens = 0; tokens[num_tokens] != NULL; num_tokens++);
712 if (num_tokens != 4) {
713 sr_dbg("IDN response not according to spec: %80.s.", response);
720 hw_info = g_try_malloc(sizeof(struct sr_scpi_hw_info));
723 return SR_ERR_MALLOC;
726 hw_info->manufacturer = g_strdup(tokens[0]);
727 hw_info->model = g_strdup(tokens[1]);
728 hw_info->serial_number = g_strdup(tokens[2]);
729 hw_info->firmware_version = g_strdup(tokens[3]);
733 *scpi_response = hw_info;
739 * Free a sr_scpi_hw_info struct.
741 * @param hw_info Pointer to the struct to free.
743 * This function is safe to call with a NULL pointer.
745 SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info)
748 g_free(hw_info->manufacturer);
749 g_free(hw_info->model);
750 g_free(hw_info->serial_number);
751 g_free(hw_info->firmware_version);