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)) {
71 * @param scpi Previously initialized SCPI device structure.
73 * @return SR_OK on success, SR_ERR on failure.
75 SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi)
77 return scpi->open(scpi->priv);
81 * Add an event source for an SCPI device.
83 * @param scpi Previously initialized SCPI device structure.
84 * @param events Events to check for.
85 * @param timeout Max time to wait before the callback is called, ignored if 0.
86 * @param cb Callback function to add. Must not be NULL.
87 * @param cb_data Data for the callback function. Can be NULL.
89 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
90 * SR_ERR_MALLOC upon memory allocation errors.
92 SR_PRIV int sr_scpi_source_add(struct sr_scpi_dev_inst *scpi, int events,
93 int timeout, sr_receive_data_callback_t cb, void *cb_data)
95 return scpi->source_add(scpi->priv, events, timeout, cb, cb_data);
99 * Remove event source for an SCPI device.
101 * @param scpi Previously initialized SCPI device structure.
103 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
104 * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
107 SR_PRIV int sr_scpi_source_remove(struct sr_scpi_dev_inst *scpi)
109 return scpi->source_remove(scpi->priv);
113 * Send a SCPI command.
115 * @param scpi Previously initialized SCPI device structure.
116 * @param format Format string, to be followed by any necessary arguments.
118 * @return SR_OK on success, SR_ERR on failure.
120 SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi,
121 const char *format, ...)
126 va_start(args, format);
127 ret = sr_scpi_send_variadic(scpi, format, args);
134 * Send a SCPI command with a variadic argument list.
136 * @param scpi Previously initialized SCPI device structure.
137 * @param format Format string.
138 * @param args Argument list.
140 * @return SR_OK on success, SR_ERR on failure.
142 SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
143 const char *format, va_list args)
149 /* Get length of buffer required. */
150 va_copy(args_copy, args);
151 len = vsnprintf(NULL, 0, format, args_copy);
154 /* Allocate buffer and write out command. */
155 buf = g_malloc(len + 1);
156 vsprintf(buf, format, args);
159 ret = scpi->send(scpi->priv, buf);
161 /* Free command buffer. */
168 * Begin receiving an SCPI reply.
170 * @param scpi Previously initialised SCPI device structure.
172 * @return SR_OK on success, SR_ERR on failure.
174 SR_PRIV int sr_scpi_read_begin(struct sr_scpi_dev_inst *scpi)
176 return scpi->read_begin(scpi->priv);
180 * Read part of a response from SCPI device.
182 * @param scpi Previously initialised SCPI device structure.
183 * @param buf Buffer to store result.
184 * @param maxlen Maximum number of bytes to read.
186 * @return Number of bytes read, or SR_ERR upon failure.
188 SR_PRIV int sr_scpi_read_data(struct sr_scpi_dev_inst *scpi,
189 char *buf, int maxlen)
191 return scpi->read_data(scpi->priv, buf, maxlen);
195 * Check whether a complete SCPI response has been received.
197 * @param scpi Previously initialised SCPI device structure.
199 * @return 1 if complete, 0 otherwise.
201 SR_PRIV int sr_scpi_read_complete(struct sr_scpi_dev_inst *scpi)
203 return scpi->read_complete(scpi->priv);
209 * @param scpi Previously initialized SCPI device structure.
211 * @return SR_OK on success, SR_ERR on failure.
213 SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi)
215 return scpi->close(scpi->priv);
221 * @param scpi Previously initialized SCPI device structure.
223 * @return SR_OK on success, SR_ERR on failure.
225 SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi)
227 scpi->free(scpi->priv);
232 * Send a SCPI command, receive the reply and store the reply in scpi_response.
234 * @param scpi Previously initialised SCPI device structure.
235 * @param command The SCPI command to send to the device (can be NULL).
236 * @param scpi_response Pointer where to store the SCPI response.
238 * @return SR_OK on success, SR_ERR on failure.
240 SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
241 const char *command, char **scpi_response)
248 if (sr_scpi_send(scpi, command) != SR_OK)
251 if (sr_scpi_read_begin(scpi) != SR_OK)
254 response = g_string_new("");
256 *scpi_response = NULL;
258 while (!sr_scpi_read_complete(scpi)) {
259 len = sr_scpi_read_data(scpi, buf, sizeof(buf));
261 g_string_free(response, TRUE);
264 g_string_append_len(response, buf, len);
267 *scpi_response = response->str;
268 g_string_free(response, FALSE);
274 * Send a SCPI command, read the reply, parse it as a bool value and store the
275 * result in scpi_response.
277 * @param scpi Previously initialised SCPI device structure.
278 * @param command The SCPI command to send to the device (can be NULL).
279 * @param scpi_response Pointer where to store the parsed result.
281 * @return SR_OK on success, SR_ERR on failure.
283 SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
284 const char *command, gboolean *scpi_response)
291 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
295 if (parse_strict_bool(response, scpi_response) == SR_OK)
306 * Send a SCPI command, read the reply, parse it as an integer and store the
307 * result in scpi_response.
309 * @param scpi Previously initialised SCPI device structure.
310 * @param command The SCPI command to send to the device (can be NULL).
311 * @param scpi_response Pointer where to store the parsed result.
313 * @return SR_OK on success, SR_ERR on failure.
315 SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
316 const char *command, int *scpi_response)
323 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
327 if (sr_atoi(response, scpi_response) == SR_OK)
338 * Send a SCPI command, read the reply, parse it as a float and store the
339 * result in scpi_response.
341 * @param scpi Previously initialised SCPI device structure.
342 * @param command The SCPI command to send to the device (can be NULL).
343 * @param scpi_response Pointer where to store the parsed result.
345 * @return SR_OK on success, SR_ERR on failure.
347 SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
348 const char *command, float *scpi_response)
355 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
359 if (sr_atof(response, scpi_response) == SR_OK)
370 * Send a SCPI command, read the reply, parse it as a double and store the
371 * result 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 parsed result.
377 * @return SR_OK on success, SR_ERR on failure.
379 SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
380 const char *command, double *scpi_response)
387 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
391 if (sr_atod(response, scpi_response) == SR_OK)
402 * Send a SCPI *OPC? command, read the reply and return the result of the
405 * @param scpi Previously initialised SCPI device structure.
407 * @return SR_OK on success, SR_ERR on failure.
409 SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi)
414 for (i = 0; i < SCPI_READ_RETRIES; ++i) {
415 sr_scpi_get_bool(scpi, SCPI_CMD_OPC, &opc);
418 g_usleep(SCPI_READ_RETRY_TIMEOUT);
425 * Send a SCPI command, read the reply, parse it as comma separated list of
426 * floats and store the as an result in scpi_response.
428 * @param scpi Previously initialised SCPI device structure.
429 * @param command The SCPI command to send to the device (can be NULL).
430 * @param scpi_response Pointer where to store the parsed result.
432 * @return SR_OK upon successfully parsing all values, SR_ERR upon a parsing
433 * error or upon no response. The allocated response must be freed by
434 * the caller in the case of an SR_OK as well as in the case of
437 SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
438 const char *command, GArray **scpi_response)
443 gchar **ptr, **tokens;
444 GArray *response_array;
450 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
454 tokens = g_strsplit(response, ",", 0);
457 response_array = g_array_sized_new(TRUE, FALSE, sizeof(float), 256);
460 if (sr_atof(*ptr, &tmp) == SR_OK)
461 response_array = g_array_append_val(response_array,
471 if (ret == SR_ERR && response_array->len == 0) {
472 g_array_free(response_array, TRUE);
473 *scpi_response = NULL;
477 *scpi_response = response_array;
483 * Send a SCPI command, read the reply, parse it as comma separated list of
484 * unsigned 8 bit integers 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_uint8v(struct sr_scpi_dev_inst *scpi,
496 const char *command, GArray **scpi_response)
500 gchar **ptr, **tokens;
501 GArray *response_array;
507 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
511 tokens = g_strsplit(response, ",", 0);
514 response_array = g_array_sized_new(TRUE, FALSE, sizeof(uint8_t), 256);
517 if (sr_atoi(*ptr, &tmp) == SR_OK)
518 response_array = g_array_append_val(response_array,
528 if (response_array->len == 0) {
529 g_array_free(response_array, TRUE);
530 *scpi_response = NULL;
534 *scpi_response = response_array;
540 * Send the *IDN? SCPI command, receive the reply, parse it and store the
541 * reply as a sr_scpi_hw_info structure in the supplied scpi_response pointer.
543 * The hw_info structure must be freed by the caller via sr_scpi_hw_info_free().
545 * @param scpi Previously initialised SCPI device structure.
546 * @param scpi_response Pointer where to store the hw_info structure.
548 * @return SR_OK upon success, SR_ERR on failure.
550 SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
551 struct sr_scpi_hw_info **scpi_response)
557 struct sr_scpi_hw_info *hw_info;
562 if (sr_scpi_get_string(scpi, SCPI_CMD_IDN, &response) != SR_OK)
566 sr_info("Got IDN string: '%s'", response);
568 /* Remove trailing newline if present. */
569 if ((newline = g_strrstr(response, "\n")))
573 * The response to a '*IDN?' is specified by the SCPI spec. It contains
574 * a comma-separated list containing the manufacturer name, instrument
575 * model, serial number of the instrument and the firmware version.
577 tokens = g_strsplit(response, ",", 0);
579 for (num_tokens = 0; tokens[num_tokens] != NULL; num_tokens++);
581 if (num_tokens != 4) {
582 sr_dbg("IDN response not according to spec: %80.s.", response);
589 hw_info = g_try_malloc(sizeof(struct sr_scpi_hw_info));
592 return SR_ERR_MALLOC;
595 hw_info->manufacturer = g_strdup(tokens[0]);
596 hw_info->model = g_strdup(tokens[1]);
597 hw_info->serial_number = g_strdup(tokens[2]);
598 hw_info->firmware_version = g_strdup(tokens[3]);
602 *scpi_response = hw_info;
608 * Free a sr_scpi_hw_info struct.
610 * @param hw_info Pointer to the struct to free.
612 * This function is safe to call with a NULL pointer.
614 SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info)
617 g_free(hw_info->manufacturer);
618 g_free(hw_info->model);
619 g_free(hw_info->serial_number);
620 g_free(hw_info->firmware_version);