]>
Commit | Line | Data |
---|---|---|
7b9d7320 DJ |
1 | /* |
2 | * This file is part of the libsigrok project. | |
3 | * | |
4 | * Copyright (C) 2013 poljar (Damir Jelić) <poljarinho@gmail.com> | |
5 | * | |
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. | |
10 | * | |
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. | |
15 | * | |
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/>. | |
18 | */ | |
19 | ||
6ec6c43b | 20 | #include <config.h> |
7b9d7320 DJ |
21 | #include <glib.h> |
22 | #include <string.h> | |
c1aae900 | 23 | #include <libsigrok/libsigrok.h> |
515ab088 | 24 | #include "libsigrok-internal.h" |
5a1afc09 | 25 | #include "scpi.h" |
7b9d7320 | 26 | |
3544f848 | 27 | #define LOG_PREFIX "scpi" |
7b9d7320 DJ |
28 | |
29 | #define SCPI_READ_RETRIES 100 | |
1a46cc62 | 30 | #define SCPI_READ_RETRY_TIMEOUT_US (10 * 1000) |
7b9d7320 | 31 | |
aa1e3b40 DJ |
32 | /** |
33 | * Parse a string representation of a boolean-like value into a gboolean. | |
34 | * Similar to sr_parse_boolstring but rejects strings which do not represent | |
35 | * a boolean-like value. | |
36 | * | |
37 | * @param str String to convert. | |
38 | * @param ret Pointer to a gboolean where the result of the conversion will be | |
39 | * stored. | |
40 | * | |
41 | * @return SR_OK on success, SR_ERR on failure. | |
42 | */ | |
d5976d8b | 43 | static int parse_strict_bool(const char *str, gboolean *ret) |
aa1e3b40 DJ |
44 | { |
45 | if (!str) | |
46 | return SR_ERR_ARG; | |
47 | ||
48 | if (!g_strcmp0(str, "1") || | |
49 | !g_ascii_strncasecmp(str, "y", 1) || | |
50 | !g_ascii_strncasecmp(str, "t", 1) || | |
51 | !g_ascii_strncasecmp(str, "yes", 3) || | |
52 | !g_ascii_strncasecmp(str, "true", 4) || | |
53 | !g_ascii_strncasecmp(str, "on", 2)) { | |
aa1e3b40 DJ |
54 | *ret = TRUE; |
55 | return SR_OK; | |
aa1e3b40 DJ |
56 | } else if (!g_strcmp0(str, "0") || |
57 | !g_ascii_strncasecmp(str, "n", 1) || | |
58 | !g_ascii_strncasecmp(str, "f", 1) || | |
59 | !g_ascii_strncasecmp(str, "no", 2) || | |
60 | !g_ascii_strncasecmp(str, "false", 5) || | |
61 | !g_ascii_strncasecmp(str, "off", 3)) { | |
aa1e3b40 DJ |
62 | *ret = FALSE; |
63 | return SR_OK; | |
64 | } | |
65 | ||
66 | return SR_ERR; | |
67 | } | |
68 | ||
f754c146 | 69 | SR_PRIV extern const struct sr_scpi_dev_inst scpi_serial_dev; |
104ed125 AJ |
70 | SR_PRIV extern const struct sr_scpi_dev_inst scpi_tcp_raw_dev; |
71 | SR_PRIV extern const struct sr_scpi_dev_inst scpi_tcp_rigol_dev; | |
20ed3cee | 72 | SR_PRIV extern const struct sr_scpi_dev_inst scpi_usbtmc_libusb_dev; |
f754c146 | 73 | SR_PRIV extern const struct sr_scpi_dev_inst scpi_vxi_dev; |
1fb2312f | 74 | SR_PRIV extern const struct sr_scpi_dev_inst scpi_visa_dev; |
7343ad1e | 75 | SR_PRIV extern const struct sr_scpi_dev_inst scpi_libgpib_dev; |
f754c146 AJ |
76 | |
77 | static const struct sr_scpi_dev_inst *scpi_devs[] = { | |
104ed125 AJ |
78 | &scpi_tcp_raw_dev, |
79 | &scpi_tcp_rigol_dev, | |
20ed3cee AJ |
80 | #ifdef HAVE_LIBUSB_1_0 |
81 | &scpi_usbtmc_libusb_dev, | |
82 | #endif | |
613c1108 | 83 | #if HAVE_RPC |
f754c146 AJ |
84 | &scpi_vxi_dev, |
85 | #endif | |
1fb2312f ML |
86 | #ifdef HAVE_LIBREVISA |
87 | &scpi_visa_dev, | |
88 | #endif | |
bb2a4ed4 | 89 | #ifdef HAVE_LIBGPIB |
7343ad1e | 90 | &scpi_libgpib_dev, |
bb2a4ed4 | 91 | #endif |
f754c146 AJ |
92 | #ifdef HAVE_LIBSERIALPORT |
93 | &scpi_serial_dev, /* must be last as it matches any resource */ | |
94 | #endif | |
95 | }; | |
96 | ||
85b69c2b | 97 | static struct sr_dev_inst *sr_scpi_scan_resource(struct drv_context *drvc, |
b541f837 AJ |
98 | const char *resource, const char *serialcomm, |
99 | struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi)) | |
100 | { | |
101 | struct sr_scpi_dev_inst *scpi; | |
102 | struct sr_dev_inst *sdi; | |
103 | ||
104 | if (!(scpi = scpi_dev_inst_new(drvc, resource, serialcomm))) | |
105 | return NULL; | |
106 | ||
107 | if (sr_scpi_open(scpi) != SR_OK) { | |
108 | sr_info("Couldn't open SCPI device."); | |
109 | sr_scpi_free(scpi); | |
110 | return NULL; | |
111 | }; | |
112 | ||
113 | if ((sdi = probe_device(scpi))) | |
85b69c2b | 114 | return sdi; |
b541f837 AJ |
115 | |
116 | sr_scpi_close(scpi); | |
117 | sr_scpi_free(scpi); | |
118 | return NULL; | |
119 | } | |
120 | ||
121 | SR_PRIV GSList *sr_scpi_scan(struct drv_context *drvc, GSList *options, | |
122 | struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi)) | |
123 | { | |
85b69c2b BV |
124 | GSList *resources, *l, *devices; |
125 | struct sr_dev_inst *sdi; | |
b541f837 AJ |
126 | const char *resource = NULL; |
127 | const char *serialcomm = NULL; | |
128 | gchar **res; | |
129 | unsigned i; | |
130 | ||
131 | for (l = options; l; l = l->next) { | |
132 | struct sr_config *src = l->data; | |
133 | switch (src->key) { | |
134 | case SR_CONF_CONN: | |
135 | resource = g_variant_get_string(src->data, NULL); | |
136 | break; | |
137 | case SR_CONF_SERIALCOMM: | |
138 | serialcomm = g_variant_get_string(src->data, NULL); | |
139 | break; | |
140 | } | |
141 | } | |
142 | ||
85b69c2b | 143 | devices = NULL; |
b541f837 AJ |
144 | for (i = 0; i < ARRAY_SIZE(scpi_devs); i++) { |
145 | if ((resource && strcmp(resource, scpi_devs[i]->prefix)) | |
146 | || !scpi_devs[i]->scan) | |
147 | continue; | |
148 | resources = scpi_devs[i]->scan(drvc); | |
149 | for (l = resources; l; l = l->next) { | |
150 | res = g_strsplit(l->data, ":", 2); | |
85b69c2b | 151 | if (res[0] && (sdi = sr_scpi_scan_resource(drvc, res[0], |
b2c02b07 | 152 | serialcomm ? serialcomm : res[1], probe_device))) { |
85b69c2b | 153 | devices = g_slist_append(devices, sdi); |
b2c02b07 SA |
154 | sdi->connection_id = g_strdup(l->data); |
155 | } | |
b541f837 AJ |
156 | g_strfreev(res); |
157 | } | |
158 | g_slist_free_full(resources, g_free); | |
159 | } | |
160 | ||
85b69c2b BV |
161 | if (!devices && resource) { |
162 | sdi = sr_scpi_scan_resource(drvc, resource, serialcomm, probe_device); | |
cfd8ec53 BV |
163 | if (sdi) |
164 | devices = g_slist_append(NULL, sdi); | |
85b69c2b | 165 | } |
b541f837 AJ |
166 | |
167 | /* Tack a copy of the newly found devices onto the driver list. */ | |
168 | if (devices) | |
85b69c2b | 169 | drvc->instances = g_slist_concat(drvc->instances, g_slist_copy(devices)); |
b541f837 AJ |
170 | |
171 | return devices; | |
172 | } | |
173 | ||
17bdda58 AJ |
174 | SR_PRIV struct sr_scpi_dev_inst *scpi_dev_inst_new(struct drv_context *drvc, |
175 | const char *resource, const char *serialcomm) | |
c3515cea AJ |
176 | { |
177 | struct sr_scpi_dev_inst *scpi = NULL; | |
f754c146 AJ |
178 | const struct sr_scpi_dev_inst *scpi_dev; |
179 | gchar **params; | |
180 | unsigned i; | |
c3515cea | 181 | |
f754c146 AJ |
182 | for (i = 0; i < ARRAY_SIZE(scpi_devs); i++) { |
183 | scpi_dev = scpi_devs[i]; | |
184 | if (!strncmp(resource, scpi_dev->prefix, strlen(scpi_dev->prefix))) { | |
185 | sr_dbg("Opening %s device %s.", scpi_dev->name, resource); | |
186 | scpi = g_malloc(sizeof(*scpi)); | |
187 | *scpi = *scpi_dev; | |
188 | scpi->priv = g_malloc0(scpi->priv_size); | |
9092e668 | 189 | scpi->read_timeout_ms = 1000; |
f754c146 | 190 | params = g_strsplit(resource, "/", 0); |
17bdda58 | 191 | if (scpi->dev_inst_new(scpi->priv, drvc, resource, |
f754c146 AJ |
192 | params, serialcomm) != SR_OK) { |
193 | sr_scpi_free(scpi); | |
194 | scpi = NULL; | |
195 | } | |
196 | g_strfreev(params); | |
197 | break; | |
198 | } | |
c3515cea | 199 | } |
f754c146 | 200 | |
c3515cea AJ |
201 | return scpi; |
202 | } | |
203 | ||
23f43dff ML |
204 | /** |
205 | * Open SCPI device. | |
206 | * | |
207 | * @param scpi Previously initialized SCPI device structure. | |
208 | * | |
209 | * @return SR_OK on success, SR_ERR on failure. | |
210 | */ | |
211 | SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi) | |
212 | { | |
04229f7b | 213 | return scpi->open(scpi); |
23f43dff ML |
214 | } |
215 | ||
216 | /** | |
217 | * Add an event source for an SCPI device. | |
218 | * | |
7efe889e | 219 | * @param session The session to add the event source to. |
23f43dff ML |
220 | * @param scpi Previously initialized SCPI device structure. |
221 | * @param events Events to check for. | |
222 | * @param timeout Max time to wait before the callback is called, ignored if 0. | |
223 | * @param cb Callback function to add. Must not be NULL. | |
224 | * @param cb_data Data for the callback function. Can be NULL. | |
225 | * | |
226 | * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or | |
227 | * SR_ERR_MALLOC upon memory allocation errors. | |
228 | */ | |
102f1239 BV |
229 | SR_PRIV int sr_scpi_source_add(struct sr_session *session, |
230 | struct sr_scpi_dev_inst *scpi, int events, int timeout, | |
231 | sr_receive_data_callback cb, void *cb_data) | |
23f43dff | 232 | { |
102f1239 | 233 | return scpi->source_add(session, scpi->priv, events, timeout, cb, cb_data); |
23f43dff ML |
234 | } |
235 | ||
236 | /** | |
237 | * Remove event source for an SCPI device. | |
238 | * | |
7efe889e | 239 | * @param session The session to remove the event source from. |
23f43dff ML |
240 | * @param scpi Previously initialized SCPI device structure. |
241 | * | |
242 | * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or | |
243 | * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon | |
244 | * internal errors. | |
245 | */ | |
102f1239 BV |
246 | SR_PRIV int sr_scpi_source_remove(struct sr_session *session, |
247 | struct sr_scpi_dev_inst *scpi) | |
23f43dff | 248 | { |
102f1239 | 249 | return scpi->source_remove(session, scpi->priv); |
23f43dff ML |
250 | } |
251 | ||
7b9d7320 DJ |
252 | /** |
253 | * Send a SCPI command. | |
254 | * | |
23f43dff | 255 | * @param scpi Previously initialized SCPI device structure. |
504f40a5 | 256 | * @param format Format string, to be followed by any necessary arguments. |
7b9d7320 DJ |
257 | * |
258 | * @return SR_OK on success, SR_ERR on failure. | |
259 | */ | |
23f43dff | 260 | SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi, |
504f40a5 | 261 | const char *format, ...) |
7b9d7320 | 262 | { |
87c41083 ML |
263 | va_list args; |
264 | int ret; | |
265 | ||
266 | va_start(args, format); | |
267 | ret = sr_scpi_send_variadic(scpi, format, args); | |
268 | va_end(args); | |
269 | ||
270 | return ret; | |
271 | } | |
272 | ||
273 | /** | |
274 | * Send a SCPI command with a variadic argument list. | |
275 | * | |
276 | * @param scpi Previously initialized SCPI device structure. | |
277 | * @param format Format string. | |
278 | * @param args Argument list. | |
279 | * | |
280 | * @return SR_OK on success, SR_ERR on failure. | |
281 | */ | |
282 | SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi, | |
283 | const char *format, va_list args) | |
284 | { | |
285 | va_list args_copy; | |
504f40a5 ML |
286 | char *buf; |
287 | int len, ret; | |
288 | ||
504f40a5 | 289 | /* Get length of buffer required. */ |
87c41083 ML |
290 | va_copy(args_copy, args); |
291 | len = vsnprintf(NULL, 0, format, args_copy); | |
292 | va_end(args_copy); | |
504f40a5 ML |
293 | |
294 | /* Allocate buffer and write out command. */ | |
295 | buf = g_malloc(len + 1); | |
87c41083 | 296 | vsprintf(buf, format, args); |
504f40a5 ML |
297 | |
298 | /* Send command. */ | |
299 | ret = scpi->send(scpi->priv, buf); | |
300 | ||
301 | /* Free command buffer. */ | |
302 | g_free(buf); | |
303 | ||
304 | return ret; | |
23f43dff | 305 | } |
7b9d7320 | 306 | |
23f43dff | 307 | /** |
05c644ea | 308 | * Begin receiving an SCPI reply. |
23f43dff ML |
309 | * |
310 | * @param scpi Previously initialised SCPI device structure. | |
23f43dff | 311 | * |
05c644ea | 312 | * @return SR_OK on success, SR_ERR on failure. |
23f43dff | 313 | */ |
05c644ea | 314 | SR_PRIV int sr_scpi_read_begin(struct sr_scpi_dev_inst *scpi) |
23f43dff | 315 | { |
05c644ea | 316 | return scpi->read_begin(scpi->priv); |
23f43dff | 317 | } |
7b9d7320 | 318 | |
a1ff9c18 ML |
319 | /** |
320 | * Read part of a response from SCPI device. | |
321 | * | |
322 | * @param scpi Previously initialised SCPI device structure. | |
323 | * @param buf Buffer to store result. | |
324 | * @param maxlen Maximum number of bytes to read. | |
325 | * | |
326 | * @return Number of bytes read, or SR_ERR upon failure. | |
327 | */ | |
05c644ea | 328 | SR_PRIV int sr_scpi_read_data(struct sr_scpi_dev_inst *scpi, |
a1ff9c18 ML |
329 | char *buf, int maxlen) |
330 | { | |
05c644ea ML |
331 | return scpi->read_data(scpi->priv, buf, maxlen); |
332 | } | |
333 | ||
334 | /** | |
335 | * Check whether a complete SCPI response has been received. | |
336 | * | |
337 | * @param scpi Previously initialised SCPI device structure. | |
338 | * | |
339 | * @return 1 if complete, 0 otherwise. | |
340 | */ | |
341 | SR_PRIV int sr_scpi_read_complete(struct sr_scpi_dev_inst *scpi) | |
342 | { | |
343 | return scpi->read_complete(scpi->priv); | |
a1ff9c18 ML |
344 | } |
345 | ||
23f43dff ML |
346 | /** |
347 | * Close SCPI device. | |
348 | * | |
349 | * @param scpi Previously initialized SCPI device structure. | |
350 | * | |
351 | * @return SR_OK on success, SR_ERR on failure. | |
352 | */ | |
353 | SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi) | |
354 | { | |
04229f7b | 355 | return scpi->close(scpi); |
23f43dff | 356 | } |
7b9d7320 | 357 | |
23f43dff ML |
358 | /** |
359 | * Free SCPI device. | |
360 | * | |
361 | * @param scpi Previously initialized SCPI device structure. | |
362 | * | |
363 | * @return SR_OK on success, SR_ERR on failure. | |
364 | */ | |
365 | SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi) | |
366 | { | |
367 | scpi->free(scpi->priv); | |
f754c146 | 368 | g_free(scpi->priv); |
23f43dff | 369 | g_free(scpi); |
7b9d7320 DJ |
370 | } |
371 | ||
372 | /** | |
373 | * Send a SCPI command, receive the reply and store the reply in scpi_response. | |
374 | * | |
23f43dff | 375 | * @param scpi Previously initialised SCPI device structure. |
7b9d7320 | 376 | * @param command The SCPI command to send to the device (can be NULL). |
d5976d8b | 377 | * @param scpi_response Pointer where to store the SCPI response. |
7b9d7320 | 378 | * |
c0d25779 | 379 | * @return SR_OK on success, SR_ERR* on failure. |
7b9d7320 | 380 | */ |
23f43dff | 381 | SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi, |
d5976d8b | 382 | const char *command, char **scpi_response) |
7b9d7320 | 383 | { |
05c644ea ML |
384 | char buf[256]; |
385 | int len; | |
386 | GString *response; | |
3b95bd91 | 387 | gint64 laststart; |
9092e668 | 388 | unsigned int elapsed_ms; |
05c644ea | 389 | |
7b9d7320 | 390 | if (command) |
23f43dff | 391 | if (sr_scpi_send(scpi, command) != SR_OK) |
7b9d7320 DJ |
392 | return SR_ERR; |
393 | ||
05c644ea ML |
394 | if (sr_scpi_read_begin(scpi) != SR_OK) |
395 | return SR_ERR; | |
396 | ||
3b95bd91 | 397 | laststart = g_get_monotonic_time(); |
9092e668 | 398 | |
05c644ea ML |
399 | response = g_string_new(""); |
400 | ||
401 | *scpi_response = NULL; | |
402 | ||
403 | while (!sr_scpi_read_complete(scpi)) { | |
404 | len = sr_scpi_read_data(scpi, buf, sizeof(buf)); | |
405 | if (len < 0) { | |
3b95bd91 | 406 | sr_err("Incompletely read SCPI response."); |
05c644ea ML |
407 | g_string_free(response, TRUE); |
408 | return SR_ERR; | |
3b95bd91 MK |
409 | } else if (len > 0) { |
410 | laststart = g_get_monotonic_time(); | |
05c644ea ML |
411 | } |
412 | g_string_append_len(response, buf, len); | |
3b95bd91 MK |
413 | elapsed_ms = (g_get_monotonic_time() - laststart) / 1000; |
414 | if (elapsed_ms >= scpi->read_timeout_ms) { | |
9092e668 ML |
415 | sr_err("Timed out waiting for SCPI response."); |
416 | g_string_free(response, TRUE); | |
417 | return SR_ERR; | |
418 | } | |
05c644ea ML |
419 | } |
420 | ||
d03dfac6 ML |
421 | /* Get rid of trailing linefeed if present */ |
422 | if (response->len >= 1 && response->str[response->len - 1] == '\n') | |
423 | g_string_truncate(response, response->len - 1); | |
424 | ||
edbd0925 ML |
425 | /* Get rid of trailing carriage return if present */ |
426 | if (response->len >= 1 && response->str[response->len - 1] == '\r') | |
427 | g_string_truncate(response, response->len - 1); | |
428 | ||
6433156c DE |
429 | sr_spew("Got response: '%.70s', length %" G_GSIZE_FORMAT ".", |
430 | response->str, response->len); | |
05c644ea | 431 | |
6433156c | 432 | *scpi_response = g_string_free(response, FALSE); |
cf9f4bc5 | 433 | |
05c644ea | 434 | return SR_OK; |
d730f70e DJ |
435 | } |
436 | ||
437 | /** | |
438 | * Send a SCPI command, read the reply, parse it as a bool value and store the | |
439 | * result in scpi_response. | |
440 | * | |
23f43dff | 441 | * @param scpi Previously initialised SCPI device structure. |
d730f70e DJ |
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. | |
444 | * | |
c0d25779 | 445 | * @return SR_OK on success, SR_ERR* on failure. |
d730f70e | 446 | */ |
23f43dff | 447 | SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi, |
d730f70e DJ |
448 | const char *command, gboolean *scpi_response) |
449 | { | |
450 | int ret; | |
451 | char *response; | |
452 | ||
453 | response = NULL; | |
454 | ||
c0d25779 BV |
455 | ret = sr_scpi_get_string(scpi, command, &response); |
456 | if (ret != SR_OK && !response) | |
457 | return ret; | |
d730f70e | 458 | |
d5976d8b | 459 | if (parse_strict_bool(response, scpi_response) == SR_OK) |
d730f70e DJ |
460 | ret = SR_OK; |
461 | else | |
c0d25779 | 462 | ret = SR_ERR_DATA; |
d730f70e DJ |
463 | |
464 | g_free(response); | |
465 | ||
466 | return ret; | |
467 | } | |
468 | ||
469 | /** | |
470 | * Send a SCPI command, read the reply, parse it as an integer and store the | |
471 | * result in scpi_response. | |
472 | * | |
23f43dff | 473 | * @param scpi Previously initialised SCPI device structure. |
d730f70e DJ |
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. | |
476 | * | |
c0d25779 | 477 | * @return SR_OK on success, SR_ERR* on failure. |
d730f70e | 478 | */ |
23f43dff | 479 | SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi, |
d5976d8b | 480 | const char *command, int *scpi_response) |
d730f70e DJ |
481 | { |
482 | int ret; | |
483 | char *response; | |
484 | ||
485 | response = NULL; | |
486 | ||
c0d25779 BV |
487 | ret = sr_scpi_get_string(scpi, command, &response); |
488 | if (ret != SR_OK && !response) | |
489 | return ret; | |
d730f70e DJ |
490 | |
491 | if (sr_atoi(response, scpi_response) == SR_OK) | |
492 | ret = SR_OK; | |
493 | else | |
c0d25779 | 494 | ret = SR_ERR_DATA; |
d730f70e DJ |
495 | |
496 | g_free(response); | |
497 | ||
498 | return ret; | |
499 | } | |
500 | ||
501 | /** | |
502 | * Send a SCPI command, read the reply, parse it as a float and store the | |
503 | * result in scpi_response. | |
504 | * | |
23f43dff | 505 | * @param scpi Previously initialised SCPI device structure. |
d730f70e DJ |
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. | |
508 | * | |
c0d25779 | 509 | * @return SR_OK on success, SR_ERR* on failure. |
d730f70e | 510 | */ |
23f43dff | 511 | SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi, |
d730f70e DJ |
512 | const char *command, float *scpi_response) |
513 | { | |
514 | int ret; | |
515 | char *response; | |
516 | ||
517 | response = NULL; | |
518 | ||
c0d25779 BV |
519 | ret = sr_scpi_get_string(scpi, command, &response); |
520 | if (ret != SR_OK && !response) | |
521 | return ret; | |
d730f70e | 522 | |
13dbd151 | 523 | if (sr_atof_ascii(response, scpi_response) == SR_OK) |
d730f70e DJ |
524 | ret = SR_OK; |
525 | else | |
c0d25779 | 526 | ret = SR_ERR_DATA; |
d730f70e DJ |
527 | |
528 | g_free(response); | |
529 | ||
530 | return ret; | |
531 | } | |
532 | ||
533 | /** | |
534 | * Send a SCPI command, read the reply, parse it as a double and store the | |
535 | * result in scpi_response. | |
536 | * | |
23f43dff | 537 | * @param scpi Previously initialised SCPI device structure. |
d730f70e DJ |
538 | * @param command The SCPI command to send to the device (can be NULL). |
539 | * @param scpi_response Pointer where to store the parsed result. | |
540 | * | |
c0d25779 | 541 | * @return SR_OK on success, SR_ERR* on failure. |
d730f70e | 542 | */ |
23f43dff | 543 | SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi, |
d5976d8b | 544 | const char *command, double *scpi_response) |
d730f70e DJ |
545 | { |
546 | int ret; | |
547 | char *response; | |
548 | ||
549 | response = NULL; | |
550 | ||
c0d25779 BV |
551 | ret = sr_scpi_get_string(scpi, command, &response); |
552 | if (ret != SR_OK && !response) | |
553 | return ret; | |
d730f70e DJ |
554 | |
555 | if (sr_atod(response, scpi_response) == SR_OK) | |
556 | ret = SR_OK; | |
557 | else | |
c0d25779 | 558 | ret = SR_ERR_DATA; |
d730f70e DJ |
559 | |
560 | g_free(response); | |
561 | ||
7b9d7320 DJ |
562 | return ret; |
563 | } | |
564 | ||
f5922ade DJ |
565 | /** |
566 | * Send a SCPI *OPC? command, read the reply and return the result of the | |
567 | * command. | |
568 | * | |
23f43dff | 569 | * @param scpi Previously initialised SCPI device structure. |
f5922ade | 570 | * |
c0d25779 | 571 | * @return SR_OK on success, SR_ERR* on failure. |
f5922ade | 572 | */ |
23f43dff | 573 | SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi) |
f5922ade DJ |
574 | { |
575 | unsigned int i; | |
576 | gboolean opc; | |
577 | ||
578 | for (i = 0; i < SCPI_READ_RETRIES; ++i) { | |
23f43dff | 579 | sr_scpi_get_bool(scpi, SCPI_CMD_OPC, &opc); |
f5922ade DJ |
580 | if (opc) |
581 | return SR_OK; | |
1a46cc62 | 582 | g_usleep(SCPI_READ_RETRY_TIMEOUT_US); |
f5922ade DJ |
583 | } |
584 | ||
585 | return SR_ERR; | |
586 | } | |
587 | ||
8acbb89a DJ |
588 | /** |
589 | * Send a SCPI command, read the reply, parse it as comma separated list of | |
590 | * floats and store the as an result in scpi_response. | |
591 | * | |
23f43dff | 592 | * @param scpi Previously initialised SCPI device structure. |
8acbb89a DJ |
593 | * @param command The SCPI command to send to the device (can be NULL). |
594 | * @param scpi_response Pointer where to store the parsed result. | |
595 | * | |
c0d25779 | 596 | * @return SR_OK upon successfully parsing all values, SR_ERR* upon a parsing |
d5976d8b UH |
597 | * error or upon no response. The allocated response must be freed by |
598 | * the caller in the case of an SR_OK as well as in the case of | |
599 | * parsing error. | |
8acbb89a | 600 | */ |
23f43dff | 601 | SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi, |
d5976d8b | 602 | const char *command, GArray **scpi_response) |
8acbb89a DJ |
603 | { |
604 | int ret; | |
605 | float tmp; | |
606 | char *response; | |
d5976d8b | 607 | gchar **ptr, **tokens; |
8acbb89a DJ |
608 | GArray *response_array; |
609 | ||
8acbb89a DJ |
610 | response = NULL; |
611 | tokens = NULL; | |
612 | ||
c0d25779 BV |
613 | ret = sr_scpi_get_string(scpi, command, &response); |
614 | if (ret != SR_OK && !response) | |
615 | return ret; | |
8acbb89a DJ |
616 | |
617 | tokens = g_strsplit(response, ",", 0); | |
618 | ptr = tokens; | |
619 | ||
620 | response_array = g_array_sized_new(TRUE, FALSE, sizeof(float), 256); | |
621 | ||
d5976d8b | 622 | while (*ptr) { |
13dbd151 | 623 | if (sr_atof_ascii(*ptr, &tmp) == SR_OK) |
8acbb89a DJ |
624 | response_array = g_array_append_val(response_array, |
625 | tmp); | |
626 | else | |
c0d25779 | 627 | ret = SR_ERR_DATA; |
8acbb89a DJ |
628 | |
629 | ptr++; | |
630 | } | |
631 | g_strfreev(tokens); | |
632 | g_free(response); | |
633 | ||
c0d25779 | 634 | if (ret != SR_OK && response_array->len == 0) { |
8acbb89a DJ |
635 | g_array_free(response_array, TRUE); |
636 | *scpi_response = NULL; | |
c0d25779 | 637 | return SR_ERR_DATA; |
8acbb89a DJ |
638 | } |
639 | ||
640 | *scpi_response = response_array; | |
641 | ||
1a323dd8 DJ |
642 | return ret; |
643 | } | |
644 | ||
645 | /** | |
646 | * Send a SCPI command, read the reply, parse it as comma separated list of | |
647 | * unsigned 8 bit integers and store the as an result in scpi_response. | |
648 | * | |
23f43dff | 649 | * @param scpi Previously initialised SCPI device structure. |
1a323dd8 DJ |
650 | * @param command The SCPI command to send to the device (can be NULL). |
651 | * @param scpi_response Pointer where to store the parsed result. | |
652 | * | |
c0d25779 | 653 | * @return SR_OK upon successfully parsing all values, SR_ERR* upon a parsing |
d5976d8b UH |
654 | * error or upon no response. The allocated response must be freed by |
655 | * the caller in the case of an SR_OK as well as in the case of | |
656 | * parsing error. | |
1a323dd8 | 657 | */ |
23f43dff | 658 | SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi, |
d5976d8b | 659 | const char *command, GArray **scpi_response) |
1a323dd8 | 660 | { |
d5976d8b | 661 | int tmp, ret; |
1a323dd8 | 662 | char *response; |
d5976d8b | 663 | gchar **ptr, **tokens; |
1a323dd8 DJ |
664 | GArray *response_array; |
665 | ||
1a323dd8 DJ |
666 | response = NULL; |
667 | tokens = NULL; | |
668 | ||
c0d25779 BV |
669 | ret = sr_scpi_get_string(scpi, command, &response); |
670 | if (ret != SR_OK && !response) | |
671 | return ret; | |
1a323dd8 DJ |
672 | |
673 | tokens = g_strsplit(response, ",", 0); | |
674 | ptr = tokens; | |
675 | ||
676 | response_array = g_array_sized_new(TRUE, FALSE, sizeof(uint8_t), 256); | |
677 | ||
d5976d8b | 678 | while (*ptr) { |
1a323dd8 DJ |
679 | if (sr_atoi(*ptr, &tmp) == SR_OK) |
680 | response_array = g_array_append_val(response_array, | |
681 | tmp); | |
682 | else | |
c0d25779 | 683 | ret = SR_ERR_DATA; |
1a323dd8 DJ |
684 | |
685 | ptr++; | |
686 | } | |
687 | g_strfreev(tokens); | |
688 | g_free(response); | |
689 | ||
690 | if (response_array->len == 0) { | |
691 | g_array_free(response_array, TRUE); | |
692 | *scpi_response = NULL; | |
c0d25779 | 693 | return SR_ERR_DATA; |
1a323dd8 DJ |
694 | } |
695 | ||
696 | *scpi_response = response_array; | |
697 | ||
8acbb89a DJ |
698 | return ret; |
699 | } | |
700 | ||
7b9d7320 DJ |
701 | /** |
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. | |
704 | * | |
d5976d8b UH |
705 | * The hw_info structure must be freed by the caller via sr_scpi_hw_info_free(). |
706 | * | |
23f43dff | 707 | * @param scpi Previously initialised SCPI device structure. |
7b9d7320 DJ |
708 | * @param scpi_response Pointer where to store the hw_info structure. |
709 | * | |
c0d25779 | 710 | * @return SR_OK upon success, SR_ERR* on failure. |
7b9d7320 | 711 | */ |
23f43dff | 712 | SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi, |
7b9d7320 DJ |
713 | struct sr_scpi_hw_info **scpi_response) |
714 | { | |
c0d25779 | 715 | int num_tokens, ret; |
7b9d7320 DJ |
716 | char *response; |
717 | gchar **tokens; | |
7b9d7320 DJ |
718 | struct sr_scpi_hw_info *hw_info; |
719 | ||
720 | response = NULL; | |
721 | tokens = NULL; | |
722 | ||
c0d25779 BV |
723 | ret = sr_scpi_get_string(scpi, SCPI_CMD_IDN, &response); |
724 | if (ret != SR_OK && !response) | |
725 | return ret; | |
7b9d7320 | 726 | |
77c16c04 ML |
727 | sr_info("Got IDN string: '%s'", response); |
728 | ||
7b9d7320 DJ |
729 | /* |
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. | |
733 | */ | |
734 | tokens = g_strsplit(response, ",", 0); | |
735 | ||
736 | for (num_tokens = 0; tokens[num_tokens] != NULL; num_tokens++); | |
737 | ||
0c08023f | 738 | if (num_tokens < 4) { |
d5976d8b | 739 | sr_dbg("IDN response not according to spec: %80.s.", response); |
7b9d7320 DJ |
740 | g_strfreev(tokens); |
741 | g_free(response); | |
c0d25779 | 742 | return SR_ERR_DATA; |
7b9d7320 DJ |
743 | } |
744 | g_free(response); | |
745 | ||
91219afc | 746 | hw_info = g_malloc0(sizeof(struct sr_scpi_hw_info)); |
558d438d BV |
747 | hw_info->manufacturer = g_strstrip(g_strdup(tokens[0])); |
748 | hw_info->model = g_strstrip(g_strdup(tokens[1])); | |
749 | hw_info->serial_number = g_strstrip(g_strdup(tokens[2])); | |
750 | hw_info->firmware_version = g_strstrip(g_strdup(tokens[3])); | |
7b9d7320 DJ |
751 | |
752 | g_strfreev(tokens); | |
753 | ||
754 | *scpi_response = hw_info; | |
755 | ||
756 | return SR_OK; | |
757 | } | |
758 | ||
759 | /** | |
760 | * Free a sr_scpi_hw_info struct. | |
761 | * | |
762 | * @param hw_info Pointer to the struct to free. | |
763 | * | |
764 | * This function is safe to call with a NULL pointer. | |
765 | */ | |
766 | SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info) | |
767 | { | |
768 | if (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); | |
773 | g_free(hw_info); | |
774 | } | |
775 | } |