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 * Receive an SCPI reply and store the reply in scpi_response.
170 * @param scpi Previously initialised SCPI device structure.
171 * @param scpi_response Pointer where to store the SCPI response.
173 * @return SR_OK upon fetching a full SCPI response, SR_ERR upon fetching an
174 * incomplete or no response. The allocated response must be freed by
175 * the caller in the case of a full response as well in the case of
178 SR_PRIV int sr_scpi_receive(struct sr_scpi_dev_inst *scpi,
179 char **scpi_response)
181 return scpi->receive(scpi->priv, scpi_response);
185 * Read part of a response from SCPI device.
187 * @param scpi Previously initialised SCPI device structure.
188 * @param buf Buffer to store result.
189 * @param maxlen Maximum number of bytes to read.
191 * @return Number of bytes read, or SR_ERR upon failure.
193 SR_PRIV int sr_scpi_read(struct sr_scpi_dev_inst *scpi,
194 char *buf, int maxlen)
196 return scpi->read(scpi->priv, buf, maxlen);
202 * @param scpi Previously initialized SCPI device structure.
204 * @return SR_OK on success, SR_ERR on failure.
206 SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi)
208 return scpi->close(scpi->priv);
214 * @param scpi Previously initialized SCPI device structure.
216 * @return SR_OK on success, SR_ERR on failure.
218 SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi)
220 scpi->free(scpi->priv);
225 * Send a SCPI command, receive the reply and store the reply in scpi_response.
227 * @param scpi Previously initialised SCPI device structure.
228 * @param command The SCPI command to send to the device (can be NULL).
229 * @param scpi_response Pointer where to store the SCPI response.
231 * @return SR_OK upon fetching a full SCPI response, SR_ERR upon fetching an
232 * incomplete or no response. The allocated response must be freed by
233 * the caller in the case of a full response as well in the case of
236 SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
237 const char *command, char **scpi_response)
240 if (sr_scpi_send(scpi, command) != SR_OK)
243 return sr_scpi_receive(scpi, scpi_response);
247 * Send a SCPI command, read the reply, parse it as a bool value and store the
248 * result in scpi_response.
250 * @param scpi Previously initialised SCPI device structure.
251 * @param command The SCPI command to send to the device (can be NULL).
252 * @param scpi_response Pointer where to store the parsed result.
254 * @return SR_OK on success, SR_ERR on failure.
256 SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
257 const char *command, gboolean *scpi_response)
264 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
268 if (parse_strict_bool(response, scpi_response) == SR_OK)
279 * Send a SCPI command, read the reply, parse it as an integer and store the
280 * result in scpi_response.
282 * @param scpi Previously initialised SCPI device structure.
283 * @param command The SCPI command to send to the device (can be NULL).
284 * @param scpi_response Pointer where to store the parsed result.
286 * @return SR_OK on success, SR_ERR on failure.
288 SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
289 const char *command, int *scpi_response)
296 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
300 if (sr_atoi(response, scpi_response) == SR_OK)
311 * Send a SCPI command, read the reply, parse it as a float and store the
312 * result in scpi_response.
314 * @param scpi Previously initialised SCPI device structure.
315 * @param command The SCPI command to send to the device (can be NULL).
316 * @param scpi_response Pointer where to store the parsed result.
318 * @return SR_OK on success, SR_ERR on failure.
320 SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
321 const char *command, float *scpi_response)
328 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
332 if (sr_atof(response, scpi_response) == SR_OK)
343 * Send a SCPI command, read the reply, parse it as a double and store the
344 * result in scpi_response.
346 * @param scpi Previously initialised SCPI device structure.
347 * @param command The SCPI command to send to the device (can be NULL).
348 * @param scpi_response Pointer where to store the parsed result.
350 * @return SR_OK on success, SR_ERR on failure.
352 SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
353 const char *command, double *scpi_response)
360 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
364 if (sr_atod(response, scpi_response) == SR_OK)
375 * Send a SCPI *OPC? command, read the reply and return the result of the
378 * @param scpi Previously initialised SCPI device structure.
380 * @return SR_OK on success, SR_ERR on failure.
382 SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi)
387 for (i = 0; i < SCPI_READ_RETRIES; ++i) {
388 sr_scpi_get_bool(scpi, SCPI_CMD_OPC, &opc);
391 g_usleep(SCPI_READ_RETRY_TIMEOUT);
398 * Send a SCPI command, read the reply, parse it as comma separated list of
399 * floats and store the as an result in scpi_response.
401 * @param scpi Previously initialised SCPI device structure.
402 * @param command The SCPI command to send to the device (can be NULL).
403 * @param scpi_response Pointer where to store the parsed result.
405 * @return SR_OK upon successfully parsing all values, SR_ERR upon a parsing
406 * error or upon no response. The allocated response must be freed by
407 * the caller in the case of an SR_OK as well as in the case of
410 SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
411 const char *command, GArray **scpi_response)
416 gchar **ptr, **tokens;
417 GArray *response_array;
423 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
427 tokens = g_strsplit(response, ",", 0);
430 response_array = g_array_sized_new(TRUE, FALSE, sizeof(float), 256);
433 if (sr_atof(*ptr, &tmp) == SR_OK)
434 response_array = g_array_append_val(response_array,
444 if (ret == SR_ERR && response_array->len == 0) {
445 g_array_free(response_array, TRUE);
446 *scpi_response = NULL;
450 *scpi_response = response_array;
456 * Send a SCPI command, read the reply, parse it as comma separated list of
457 * unsigned 8 bit integers and store the as an result in scpi_response.
459 * @param scpi Previously initialised SCPI device structure.
460 * @param command The SCPI command to send to the device (can be NULL).
461 * @param scpi_response Pointer where to store the parsed result.
463 * @return SR_OK upon successfully parsing all values, SR_ERR upon a parsing
464 * error or upon no response. The allocated response must be freed by
465 * the caller in the case of an SR_OK as well as in the case of
468 SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
469 const char *command, GArray **scpi_response)
473 gchar **ptr, **tokens;
474 GArray *response_array;
480 if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
484 tokens = g_strsplit(response, ",", 0);
487 response_array = g_array_sized_new(TRUE, FALSE, sizeof(uint8_t), 256);
490 if (sr_atoi(*ptr, &tmp) == SR_OK)
491 response_array = g_array_append_val(response_array,
501 if (response_array->len == 0) {
502 g_array_free(response_array, TRUE);
503 *scpi_response = NULL;
507 *scpi_response = response_array;
513 * Send the *IDN? SCPI command, receive the reply, parse it and store the
514 * reply as a sr_scpi_hw_info structure in the supplied scpi_response pointer.
516 * The hw_info structure must be freed by the caller via sr_scpi_hw_info_free().
518 * @param scpi Previously initialised SCPI device structure.
519 * @param scpi_response Pointer where to store the hw_info structure.
521 * @return SR_OK upon success, SR_ERR on failure.
523 SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
524 struct sr_scpi_hw_info **scpi_response)
529 struct sr_scpi_hw_info *hw_info;
534 if (sr_scpi_get_string(scpi, SCPI_CMD_IDN, &response) != SR_OK)
538 sr_info("Got IDN string: '%s'", response);
541 * The response to a '*IDN?' is specified by the SCPI spec. It contains
542 * a comma-separated list containing the manufacturer name, instrument
543 * model, serial number of the instrument and the firmware version.
545 tokens = g_strsplit(response, ",", 0);
547 for (num_tokens = 0; tokens[num_tokens] != NULL; num_tokens++);
549 if (num_tokens != 4) {
550 sr_dbg("IDN response not according to spec: %80.s.", response);
557 hw_info = g_try_malloc(sizeof(struct sr_scpi_hw_info));
560 return SR_ERR_MALLOC;
563 hw_info->manufacturer = g_strdup(tokens[0]);
564 hw_info->model = g_strdup(tokens[1]);
565 hw_info->serial_number = g_strdup(tokens[2]);
566 hw_info->firmware_version = g_strdup(tokens[3]);
570 *scpi_response = hw_info;
576 * Free a sr_scpi_hw_info struct.
578 * @param hw_info Pointer to the struct to free.
580 * This function is safe to call with a NULL pointer.
582 SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info)
585 g_free(hw_info->manufacturer);
586 g_free(hw_info->model);
587 g_free(hw_info->serial_number);
588 g_free(hw_info->firmware_version);