]>
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 | 92 | #ifdef HAVE_LIBSERIALPORT |
d9251a2c | 93 | &scpi_serial_dev, /* Must be last as it matches any resource. */ |
f754c146 AJ |
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 | ||
a00106b7 | 113 | sdi = probe_device(scpi); |
b541f837 AJ |
114 | |
115 | sr_scpi_close(scpi); | |
a00106b7 ML |
116 | |
117 | if (sdi) | |
118 | sdi->status = SR_ST_INACTIVE; | |
119 | else | |
120 | sr_scpi_free(scpi); | |
121 | ||
122 | return sdi; | |
b541f837 AJ |
123 | } |
124 | ||
125 | SR_PRIV GSList *sr_scpi_scan(struct drv_context *drvc, GSList *options, | |
126 | struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi)) | |
127 | { | |
85b69c2b BV |
128 | GSList *resources, *l, *devices; |
129 | struct sr_dev_inst *sdi; | |
b541f837 AJ |
130 | const char *resource = NULL; |
131 | const char *serialcomm = NULL; | |
132 | gchar **res; | |
133 | unsigned i; | |
134 | ||
135 | for (l = options; l; l = l->next) { | |
136 | struct sr_config *src = l->data; | |
137 | switch (src->key) { | |
138 | case SR_CONF_CONN: | |
139 | resource = g_variant_get_string(src->data, NULL); | |
140 | break; | |
141 | case SR_CONF_SERIALCOMM: | |
142 | serialcomm = g_variant_get_string(src->data, NULL); | |
143 | break; | |
144 | } | |
145 | } | |
146 | ||
85b69c2b | 147 | devices = NULL; |
b541f837 AJ |
148 | for (i = 0; i < ARRAY_SIZE(scpi_devs); i++) { |
149 | if ((resource && strcmp(resource, scpi_devs[i]->prefix)) | |
150 | || !scpi_devs[i]->scan) | |
151 | continue; | |
152 | resources = scpi_devs[i]->scan(drvc); | |
153 | for (l = resources; l; l = l->next) { | |
154 | res = g_strsplit(l->data, ":", 2); | |
85b69c2b | 155 | if (res[0] && (sdi = sr_scpi_scan_resource(drvc, res[0], |
b2c02b07 | 156 | serialcomm ? serialcomm : res[1], probe_device))) { |
85b69c2b | 157 | devices = g_slist_append(devices, sdi); |
b2c02b07 SA |
158 | sdi->connection_id = g_strdup(l->data); |
159 | } | |
b541f837 AJ |
160 | g_strfreev(res); |
161 | } | |
162 | g_slist_free_full(resources, g_free); | |
163 | } | |
164 | ||
85b69c2b BV |
165 | if (!devices && resource) { |
166 | sdi = sr_scpi_scan_resource(drvc, resource, serialcomm, probe_device); | |
cfd8ec53 BV |
167 | if (sdi) |
168 | devices = g_slist_append(NULL, sdi); | |
85b69c2b | 169 | } |
b541f837 AJ |
170 | |
171 | /* Tack a copy of the newly found devices onto the driver list. */ | |
172 | if (devices) | |
85b69c2b | 173 | drvc->instances = g_slist_concat(drvc->instances, g_slist_copy(devices)); |
b541f837 AJ |
174 | |
175 | return devices; | |
176 | } | |
177 | ||
17bdda58 AJ |
178 | SR_PRIV struct sr_scpi_dev_inst *scpi_dev_inst_new(struct drv_context *drvc, |
179 | const char *resource, const char *serialcomm) | |
c3515cea AJ |
180 | { |
181 | struct sr_scpi_dev_inst *scpi = NULL; | |
f754c146 AJ |
182 | const struct sr_scpi_dev_inst *scpi_dev; |
183 | gchar **params; | |
184 | unsigned i; | |
c3515cea | 185 | |
f754c146 AJ |
186 | for (i = 0; i < ARRAY_SIZE(scpi_devs); i++) { |
187 | scpi_dev = scpi_devs[i]; | |
188 | if (!strncmp(resource, scpi_dev->prefix, strlen(scpi_dev->prefix))) { | |
189 | sr_dbg("Opening %s device %s.", scpi_dev->name, resource); | |
190 | scpi = g_malloc(sizeof(*scpi)); | |
191 | *scpi = *scpi_dev; | |
192 | scpi->priv = g_malloc0(scpi->priv_size); | |
37ef582d | 193 | scpi->read_timeout_us = 1000 * 1000; |
f754c146 | 194 | params = g_strsplit(resource, "/", 0); |
17bdda58 | 195 | if (scpi->dev_inst_new(scpi->priv, drvc, resource, |
f754c146 AJ |
196 | params, serialcomm) != SR_OK) { |
197 | sr_scpi_free(scpi); | |
198 | scpi = NULL; | |
199 | } | |
200 | g_strfreev(params); | |
201 | break; | |
202 | } | |
c3515cea | 203 | } |
f754c146 | 204 | |
c3515cea AJ |
205 | return scpi; |
206 | } | |
207 | ||
23f43dff ML |
208 | /** |
209 | * Open SCPI device. | |
210 | * | |
211 | * @param scpi Previously initialized SCPI device structure. | |
212 | * | |
213 | * @return SR_OK on success, SR_ERR on failure. | |
214 | */ | |
215 | SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi) | |
216 | { | |
04229f7b | 217 | return scpi->open(scpi); |
23f43dff ML |
218 | } |
219 | ||
220 | /** | |
221 | * Add an event source for an SCPI device. | |
222 | * | |
7efe889e | 223 | * @param session The session to add the event source to. |
23f43dff ML |
224 | * @param scpi Previously initialized SCPI device structure. |
225 | * @param events Events to check for. | |
226 | * @param timeout Max time to wait before the callback is called, ignored if 0. | |
227 | * @param cb Callback function to add. Must not be NULL. | |
228 | * @param cb_data Data for the callback function. Can be NULL. | |
229 | * | |
230 | * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or | |
231 | * SR_ERR_MALLOC upon memory allocation errors. | |
232 | */ | |
102f1239 BV |
233 | SR_PRIV int sr_scpi_source_add(struct sr_session *session, |
234 | struct sr_scpi_dev_inst *scpi, int events, int timeout, | |
235 | sr_receive_data_callback cb, void *cb_data) | |
23f43dff | 236 | { |
102f1239 | 237 | return scpi->source_add(session, scpi->priv, events, timeout, cb, cb_data); |
23f43dff ML |
238 | } |
239 | ||
240 | /** | |
241 | * Remove event source for an SCPI device. | |
242 | * | |
7efe889e | 243 | * @param session The session to remove the event source from. |
23f43dff ML |
244 | * @param scpi Previously initialized SCPI device structure. |
245 | * | |
246 | * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or | |
247 | * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon | |
248 | * internal errors. | |
249 | */ | |
102f1239 BV |
250 | SR_PRIV int sr_scpi_source_remove(struct sr_session *session, |
251 | struct sr_scpi_dev_inst *scpi) | |
23f43dff | 252 | { |
102f1239 | 253 | return scpi->source_remove(session, scpi->priv); |
23f43dff ML |
254 | } |
255 | ||
7b9d7320 DJ |
256 | /** |
257 | * Send a SCPI command. | |
258 | * | |
23f43dff | 259 | * @param scpi Previously initialized SCPI device structure. |
504f40a5 | 260 | * @param format Format string, to be followed by any necessary arguments. |
7b9d7320 DJ |
261 | * |
262 | * @return SR_OK on success, SR_ERR on failure. | |
263 | */ | |
23f43dff | 264 | SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi, |
504f40a5 | 265 | const char *format, ...) |
7b9d7320 | 266 | { |
87c41083 ML |
267 | va_list args; |
268 | int ret; | |
269 | ||
270 | va_start(args, format); | |
271 | ret = sr_scpi_send_variadic(scpi, format, args); | |
272 | va_end(args); | |
273 | ||
274 | return ret; | |
275 | } | |
276 | ||
277 | /** | |
278 | * Send a SCPI command with a variadic argument list. | |
279 | * | |
280 | * @param scpi Previously initialized SCPI device structure. | |
281 | * @param format Format string. | |
282 | * @param args Argument list. | |
283 | * | |
284 | * @return SR_OK on success, SR_ERR on failure. | |
285 | */ | |
286 | SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi, | |
287 | const char *format, va_list args) | |
288 | { | |
289 | va_list args_copy; | |
504f40a5 ML |
290 | char *buf; |
291 | int len, ret; | |
292 | ||
504f40a5 | 293 | /* Get length of buffer required. */ |
87c41083 ML |
294 | va_copy(args_copy, args); |
295 | len = vsnprintf(NULL, 0, format, args_copy); | |
296 | va_end(args_copy); | |
504f40a5 ML |
297 | |
298 | /* Allocate buffer and write out command. */ | |
055804e8 | 299 | buf = g_malloc0(len + 2); |
87c41083 | 300 | vsprintf(buf, format, args); |
055804e8 SB |
301 | if (buf[len - 1] != '\n') |
302 | buf[len] = '\n'; | |
504f40a5 ML |
303 | |
304 | /* Send command. */ | |
305 | ret = scpi->send(scpi->priv, buf); | |
306 | ||
307 | /* Free command buffer. */ | |
308 | g_free(buf); | |
309 | ||
310 | return ret; | |
23f43dff | 311 | } |
7b9d7320 | 312 | |
23f43dff | 313 | /** |
05c644ea | 314 | * Begin receiving an SCPI reply. |
23f43dff ML |
315 | * |
316 | * @param scpi Previously initialised SCPI device structure. | |
23f43dff | 317 | * |
05c644ea | 318 | * @return SR_OK on success, SR_ERR on failure. |
23f43dff | 319 | */ |
05c644ea | 320 | SR_PRIV int sr_scpi_read_begin(struct sr_scpi_dev_inst *scpi) |
23f43dff | 321 | { |
05c644ea | 322 | return scpi->read_begin(scpi->priv); |
23f43dff | 323 | } |
7b9d7320 | 324 | |
a1ff9c18 ML |
325 | /** |
326 | * Read part of a response from SCPI device. | |
327 | * | |
328 | * @param scpi Previously initialised SCPI device structure. | |
329 | * @param buf Buffer to store result. | |
330 | * @param maxlen Maximum number of bytes to read. | |
331 | * | |
332 | * @return Number of bytes read, or SR_ERR upon failure. | |
333 | */ | |
05c644ea | 334 | SR_PRIV int sr_scpi_read_data(struct sr_scpi_dev_inst *scpi, |
a1ff9c18 ML |
335 | char *buf, int maxlen) |
336 | { | |
05c644ea ML |
337 | return scpi->read_data(scpi->priv, buf, maxlen); |
338 | } | |
339 | ||
340 | /** | |
341 | * Check whether a complete SCPI response has been received. | |
342 | * | |
343 | * @param scpi Previously initialised SCPI device structure. | |
344 | * | |
345 | * @return 1 if complete, 0 otherwise. | |
346 | */ | |
347 | SR_PRIV int sr_scpi_read_complete(struct sr_scpi_dev_inst *scpi) | |
348 | { | |
349 | return scpi->read_complete(scpi->priv); | |
a1ff9c18 ML |
350 | } |
351 | ||
23f43dff ML |
352 | /** |
353 | * Close SCPI device. | |
354 | * | |
355 | * @param scpi Previously initialized SCPI device structure. | |
356 | * | |
357 | * @return SR_OK on success, SR_ERR on failure. | |
358 | */ | |
359 | SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi) | |
360 | { | |
04229f7b | 361 | return scpi->close(scpi); |
23f43dff | 362 | } |
7b9d7320 | 363 | |
23f43dff ML |
364 | /** |
365 | * Free SCPI device. | |
366 | * | |
367 | * @param scpi Previously initialized SCPI device structure. | |
368 | * | |
369 | * @return SR_OK on success, SR_ERR on failure. | |
370 | */ | |
371 | SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi) | |
372 | { | |
373 | scpi->free(scpi->priv); | |
f754c146 | 374 | g_free(scpi->priv); |
23f43dff | 375 | g_free(scpi); |
7b9d7320 DJ |
376 | } |
377 | ||
378 | /** | |
379 | * Send a SCPI command, receive the reply and store the reply in scpi_response. | |
380 | * | |
23f43dff | 381 | * @param scpi Previously initialised SCPI device structure. |
7b9d7320 | 382 | * @param command The SCPI command to send to the device (can be NULL). |
d5976d8b | 383 | * @param scpi_response Pointer where to store the SCPI response. |
7b9d7320 | 384 | * |
c0d25779 | 385 | * @return SR_OK on success, SR_ERR* on failure. |
7b9d7320 | 386 | */ |
23f43dff | 387 | SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi, |
d5976d8b | 388 | const char *command, char **scpi_response) |
7b9d7320 | 389 | { |
ff01b0ea SB |
390 | GString *response; |
391 | response = g_string_sized_new(1024); | |
392 | ||
393 | if (sr_scpi_get_data(scpi, command, &response) != SR_OK) { | |
394 | if (response) | |
395 | g_string_free(response, TRUE); | |
396 | return SR_ERR; | |
397 | } | |
398 | ||
399 | /* Get rid of trailing linefeed if present */ | |
400 | if (response->len >= 1 && response->str[response->len - 1] == '\n') | |
401 | g_string_truncate(response, response->len - 1); | |
402 | ||
403 | /* Get rid of trailing carriage return if present */ | |
404 | if (response->len >= 1 && response->str[response->len - 1] == '\r') | |
405 | g_string_truncate(response, response->len - 1); | |
406 | ||
407 | sr_spew("Got response: '%.70s', length %" G_GSIZE_FORMAT ".", | |
408 | response->str, response->len); | |
409 | ||
410 | *scpi_response = g_string_free(response, FALSE); | |
411 | ||
412 | return SR_OK; | |
413 | } | |
414 | ||
d64be25b SB |
415 | /** |
416 | * Do a non-blocking read of up to the allocated length, and | |
417 | * check if a timeout has occured. | |
418 | * | |
419 | * @param scpi Previously initialised SCPI device structure. | |
420 | * @param response Buffer to which the response is appended. | |
421 | * @param abs_timeout_us Absolute timeout in microseconds | |
422 | * | |
423 | * @return read length on success, SR_ERR* on failure. | |
424 | */ | |
425 | SR_PRIV int sr_scpi_read_response(struct sr_scpi_dev_inst *scpi, | |
426 | GString *response, gint64 abs_timeout_us) | |
427 | { | |
428 | int len, space; | |
429 | ||
430 | space = response->allocated_len - response->len; | |
431 | len = sr_scpi_read_data(scpi, &response->str[response->len], space); | |
432 | ||
433 | if (len < 0) { | |
434 | sr_err("Incompletely read SCPI response."); | |
435 | return SR_ERR; | |
436 | } | |
437 | ||
438 | if (len > 0) { | |
439 | g_string_set_size(response, response->len + len); | |
440 | return len; | |
441 | } | |
442 | ||
443 | if (g_get_monotonic_time() > abs_timeout_us) { | |
444 | sr_err("Timed out waiting for SCPI response."); | |
445 | return SR_ERR_TIMEOUT; | |
446 | } | |
447 | ||
448 | return 0; | |
449 | } | |
450 | ||
ff01b0ea SB |
451 | SR_PRIV int sr_scpi_get_data(struct sr_scpi_dev_inst *scpi, |
452 | const char *command, GString **scpi_response) | |
453 | { | |
d64be25b | 454 | int ret; |
05c644ea | 455 | GString *response; |
ff01b0ea | 456 | int space; |
d64be25b | 457 | gint64 timeout; |
05c644ea | 458 | |
ad21865f | 459 | /* Optionally send caller provided command. */ |
d3de86f3 | 460 | if (command) { |
23f43dff | 461 | if (sr_scpi_send(scpi, command) != SR_OK) |
7b9d7320 | 462 | return SR_ERR; |
d3de86f3 | 463 | } |
7b9d7320 | 464 | |
ad21865f | 465 | /* Initiate SCPI read operation. */ |
05c644ea ML |
466 | if (sr_scpi_read_begin(scpi) != SR_OK) |
467 | return SR_ERR; | |
468 | ||
ad21865f | 469 | /* Keep reading until completion or until timeout. */ |
d64be25b | 470 | timeout = g_get_monotonic_time() + scpi->read_timeout_us; |
9092e668 | 471 | |
ff01b0ea | 472 | response = *scpi_response; |
05c644ea ML |
473 | |
474 | while (!sr_scpi_read_complete(scpi)) { | |
ad21865f | 475 | /* Resize the buffer when free space drops below a threshold. */ |
ff01b0ea SB |
476 | space = response->allocated_len - response->len; |
477 | if (space < 128) { | |
d64be25b SB |
478 | int oldlen = response->len; |
479 | g_string_set_size(response, oldlen + 1024); | |
480 | g_string_set_size(response, oldlen); | |
37ef582d SB |
481 | } |
482 | ||
d64be25b SB |
483 | /* Read another chunk of the response. */ |
484 | ret = sr_scpi_read_response(scpi, response, timeout); | |
37ef582d | 485 | |
d64be25b SB |
486 | if (ret < 0) |
487 | return ret; | |
488 | if (ret > 0) | |
489 | timeout = g_get_monotonic_time() + scpi->read_timeout_us; | |
05c644ea ML |
490 | } |
491 | ||
05c644ea | 492 | return SR_OK; |
d730f70e DJ |
493 | } |
494 | ||
495 | /** | |
496 | * Send a SCPI command, read the reply, parse it as a bool value and store the | |
497 | * result in scpi_response. | |
498 | * | |
23f43dff | 499 | * @param scpi Previously initialised SCPI device structure. |
d730f70e DJ |
500 | * @param command The SCPI command to send to the device (can be NULL). |
501 | * @param scpi_response Pointer where to store the parsed result. | |
502 | * | |
c0d25779 | 503 | * @return SR_OK on success, SR_ERR* on failure. |
d730f70e | 504 | */ |
23f43dff | 505 | SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi, |
d730f70e DJ |
506 | const char *command, gboolean *scpi_response) |
507 | { | |
508 | int ret; | |
509 | char *response; | |
510 | ||
511 | response = NULL; | |
512 | ||
c0d25779 BV |
513 | ret = sr_scpi_get_string(scpi, command, &response); |
514 | if (ret != SR_OK && !response) | |
515 | return ret; | |
d730f70e | 516 | |
d5976d8b | 517 | if (parse_strict_bool(response, scpi_response) == SR_OK) |
d730f70e DJ |
518 | ret = SR_OK; |
519 | else | |
c0d25779 | 520 | ret = SR_ERR_DATA; |
d730f70e DJ |
521 | |
522 | g_free(response); | |
523 | ||
524 | return ret; | |
525 | } | |
526 | ||
527 | /** | |
528 | * Send a SCPI command, read the reply, parse it as an integer and store the | |
529 | * result in scpi_response. | |
530 | * | |
23f43dff | 531 | * @param scpi Previously initialised SCPI device structure. |
d730f70e DJ |
532 | * @param command The SCPI command to send to the device (can be NULL). |
533 | * @param scpi_response Pointer where to store the parsed result. | |
534 | * | |
c0d25779 | 535 | * @return SR_OK on success, SR_ERR* on failure. |
d730f70e | 536 | */ |
23f43dff | 537 | SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi, |
d5976d8b | 538 | const char *command, int *scpi_response) |
d730f70e DJ |
539 | { |
540 | int ret; | |
541 | char *response; | |
542 | ||
543 | response = NULL; | |
544 | ||
c0d25779 BV |
545 | ret = sr_scpi_get_string(scpi, command, &response); |
546 | if (ret != SR_OK && !response) | |
547 | return ret; | |
d730f70e DJ |
548 | |
549 | if (sr_atoi(response, scpi_response) == SR_OK) | |
550 | ret = SR_OK; | |
551 | else | |
c0d25779 | 552 | ret = SR_ERR_DATA; |
d730f70e DJ |
553 | |
554 | g_free(response); | |
555 | ||
556 | return ret; | |
557 | } | |
558 | ||
559 | /** | |
560 | * Send a SCPI command, read the reply, parse it as a float and store the | |
561 | * result in scpi_response. | |
562 | * | |
23f43dff | 563 | * @param scpi Previously initialised SCPI device structure. |
d730f70e DJ |
564 | * @param command The SCPI command to send to the device (can be NULL). |
565 | * @param scpi_response Pointer where to store the parsed result. | |
566 | * | |
c0d25779 | 567 | * @return SR_OK on success, SR_ERR* on failure. |
d730f70e | 568 | */ |
23f43dff | 569 | SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi, |
d730f70e DJ |
570 | const char *command, float *scpi_response) |
571 | { | |
572 | int ret; | |
573 | char *response; | |
574 | ||
575 | response = NULL; | |
576 | ||
c0d25779 BV |
577 | ret = sr_scpi_get_string(scpi, command, &response); |
578 | if (ret != SR_OK && !response) | |
579 | return ret; | |
d730f70e | 580 | |
13dbd151 | 581 | if (sr_atof_ascii(response, scpi_response) == SR_OK) |
d730f70e DJ |
582 | ret = SR_OK; |
583 | else | |
c0d25779 | 584 | ret = SR_ERR_DATA; |
d730f70e DJ |
585 | |
586 | g_free(response); | |
587 | ||
588 | return ret; | |
589 | } | |
590 | ||
591 | /** | |
592 | * Send a SCPI command, read the reply, parse it as a double and store the | |
593 | * result in scpi_response. | |
594 | * | |
23f43dff | 595 | * @param scpi Previously initialised SCPI device structure. |
d730f70e DJ |
596 | * @param command The SCPI command to send to the device (can be NULL). |
597 | * @param scpi_response Pointer where to store the parsed result. | |
598 | * | |
c0d25779 | 599 | * @return SR_OK on success, SR_ERR* on failure. |
d730f70e | 600 | */ |
23f43dff | 601 | SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi, |
d5976d8b | 602 | const char *command, double *scpi_response) |
d730f70e DJ |
603 | { |
604 | int ret; | |
605 | char *response; | |
606 | ||
607 | response = NULL; | |
608 | ||
c0d25779 BV |
609 | ret = sr_scpi_get_string(scpi, command, &response); |
610 | if (ret != SR_OK && !response) | |
611 | return ret; | |
d730f70e DJ |
612 | |
613 | if (sr_atod(response, scpi_response) == SR_OK) | |
614 | ret = SR_OK; | |
615 | else | |
c0d25779 | 616 | ret = SR_ERR_DATA; |
d730f70e DJ |
617 | |
618 | g_free(response); | |
619 | ||
7b9d7320 DJ |
620 | return ret; |
621 | } | |
622 | ||
f5922ade DJ |
623 | /** |
624 | * Send a SCPI *OPC? command, read the reply and return the result of the | |
625 | * command. | |
626 | * | |
23f43dff | 627 | * @param scpi Previously initialised SCPI device structure. |
f5922ade | 628 | * |
c0d25779 | 629 | * @return SR_OK on success, SR_ERR* on failure. |
f5922ade | 630 | */ |
23f43dff | 631 | SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi) |
f5922ade DJ |
632 | { |
633 | unsigned int i; | |
634 | gboolean opc; | |
635 | ||
0a1f7b09 | 636 | for (i = 0; i < SCPI_READ_RETRIES; i++) { |
23f43dff | 637 | sr_scpi_get_bool(scpi, SCPI_CMD_OPC, &opc); |
f5922ade DJ |
638 | if (opc) |
639 | return SR_OK; | |
1a46cc62 | 640 | g_usleep(SCPI_READ_RETRY_TIMEOUT_US); |
f5922ade DJ |
641 | } |
642 | ||
643 | return SR_ERR; | |
644 | } | |
645 | ||
8acbb89a DJ |
646 | /** |
647 | * Send a SCPI command, read the reply, parse it as comma separated list of | |
648 | * floats and store the as an result in scpi_response. | |
649 | * | |
23f43dff | 650 | * @param scpi Previously initialised SCPI device structure. |
8acbb89a DJ |
651 | * @param command The SCPI command to send to the device (can be NULL). |
652 | * @param scpi_response Pointer where to store the parsed result. | |
653 | * | |
c0d25779 | 654 | * @return SR_OK upon successfully parsing all values, SR_ERR* upon a parsing |
d5976d8b UH |
655 | * error or upon no response. The allocated response must be freed by |
656 | * the caller in the case of an SR_OK as well as in the case of | |
657 | * parsing error. | |
8acbb89a | 658 | */ |
23f43dff | 659 | SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi, |
d5976d8b | 660 | const char *command, GArray **scpi_response) |
8acbb89a DJ |
661 | { |
662 | int ret; | |
663 | float tmp; | |
664 | char *response; | |
d5976d8b | 665 | gchar **ptr, **tokens; |
8acbb89a DJ |
666 | GArray *response_array; |
667 | ||
8acbb89a DJ |
668 | response = NULL; |
669 | tokens = NULL; | |
670 | ||
c0d25779 BV |
671 | ret = sr_scpi_get_string(scpi, command, &response); |
672 | if (ret != SR_OK && !response) | |
673 | return ret; | |
8acbb89a DJ |
674 | |
675 | tokens = g_strsplit(response, ",", 0); | |
676 | ptr = tokens; | |
677 | ||
678 | response_array = g_array_sized_new(TRUE, FALSE, sizeof(float), 256); | |
679 | ||
d5976d8b | 680 | while (*ptr) { |
13dbd151 | 681 | if (sr_atof_ascii(*ptr, &tmp) == SR_OK) |
8acbb89a DJ |
682 | response_array = g_array_append_val(response_array, |
683 | tmp); | |
684 | else | |
c0d25779 | 685 | ret = SR_ERR_DATA; |
8acbb89a DJ |
686 | |
687 | ptr++; | |
688 | } | |
689 | g_strfreev(tokens); | |
690 | g_free(response); | |
691 | ||
c0d25779 | 692 | if (ret != SR_OK && response_array->len == 0) { |
8acbb89a DJ |
693 | g_array_free(response_array, TRUE); |
694 | *scpi_response = NULL; | |
c0d25779 | 695 | return SR_ERR_DATA; |
8acbb89a DJ |
696 | } |
697 | ||
698 | *scpi_response = response_array; | |
699 | ||
1a323dd8 DJ |
700 | return ret; |
701 | } | |
702 | ||
703 | /** | |
704 | * Send a SCPI command, read the reply, parse it as comma separated list of | |
705 | * unsigned 8 bit integers and store the as an result in scpi_response. | |
706 | * | |
23f43dff | 707 | * @param scpi Previously initialised SCPI device structure. |
1a323dd8 DJ |
708 | * @param command The SCPI command to send to the device (can be NULL). |
709 | * @param scpi_response Pointer where to store the parsed result. | |
710 | * | |
c0d25779 | 711 | * @return SR_OK upon successfully parsing all values, SR_ERR* upon a parsing |
d5976d8b UH |
712 | * error or upon no response. The allocated response must be freed by |
713 | * the caller in the case of an SR_OK as well as in the case of | |
714 | * parsing error. | |
1a323dd8 | 715 | */ |
23f43dff | 716 | SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi, |
d5976d8b | 717 | const char *command, GArray **scpi_response) |
1a323dd8 | 718 | { |
d5976d8b | 719 | int tmp, ret; |
1a323dd8 | 720 | char *response; |
d5976d8b | 721 | gchar **ptr, **tokens; |
1a323dd8 DJ |
722 | GArray *response_array; |
723 | ||
1a323dd8 DJ |
724 | response = NULL; |
725 | tokens = NULL; | |
726 | ||
c0d25779 BV |
727 | ret = sr_scpi_get_string(scpi, command, &response); |
728 | if (ret != SR_OK && !response) | |
729 | return ret; | |
1a323dd8 DJ |
730 | |
731 | tokens = g_strsplit(response, ",", 0); | |
732 | ptr = tokens; | |
733 | ||
734 | response_array = g_array_sized_new(TRUE, FALSE, sizeof(uint8_t), 256); | |
735 | ||
d5976d8b | 736 | while (*ptr) { |
1a323dd8 DJ |
737 | if (sr_atoi(*ptr, &tmp) == SR_OK) |
738 | response_array = g_array_append_val(response_array, | |
739 | tmp); | |
740 | else | |
c0d25779 | 741 | ret = SR_ERR_DATA; |
1a323dd8 DJ |
742 | |
743 | ptr++; | |
744 | } | |
745 | g_strfreev(tokens); | |
746 | g_free(response); | |
747 | ||
748 | if (response_array->len == 0) { | |
749 | g_array_free(response_array, TRUE); | |
750 | *scpi_response = NULL; | |
c0d25779 | 751 | return SR_ERR_DATA; |
1a323dd8 DJ |
752 | } |
753 | ||
754 | *scpi_response = response_array; | |
755 | ||
8acbb89a DJ |
756 | return ret; |
757 | } | |
d3de86f3 | 758 | |
ff01b0ea SB |
759 | /** |
760 | * Send a SCPI command, read the reply, parse it as binary data with a | |
761 | * "definite length block" header and store the as an result in scpi_response. | |
762 | * | |
763 | * @param scpi Previously initialised SCPI device structure. | |
764 | * @param command The SCPI command to send to the device (can be NULL). | |
765 | * @param scpi_response Pointer where to store the parsed result. | |
766 | * | |
767 | * @return SR_OK upon successfully parsing all values, SR_ERR* upon a parsing | |
768 | * error or upon no response. The allocated response must be freed by | |
769 | * the caller in the case of an SR_OK as well as in the case of | |
770 | * parsing error. | |
771 | */ | |
772 | SR_PRIV int sr_scpi_get_block(struct sr_scpi_dev_inst *scpi, | |
773 | const char *command, GByteArray **scpi_response) | |
774 | { | |
775 | int ret; | |
776 | GString* response; | |
26e8c6a2 | 777 | char buf[10]; |
ff01b0ea SB |
778 | long llen; |
779 | long datalen; | |
d64be25b SB |
780 | gint64 timeout; |
781 | ||
782 | if (command) | |
783 | if (sr_scpi_send(scpi, command) != SR_OK) | |
784 | return SR_ERR; | |
785 | ||
786 | if (sr_scpi_read_begin(scpi) != SR_OK) | |
787 | return SR_ERR; | |
ff01b0ea | 788 | |
26e8c6a2 GS |
789 | /* |
790 | * Assume an initial maximum length, optionally gets adjusted below. | |
791 | * Prepare a NULL return value for when error paths will be taken. | |
792 | */ | |
ff01b0ea | 793 | response = g_string_sized_new(1024); |
d64be25b SB |
794 | |
795 | timeout = g_get_monotonic_time() + scpi->read_timeout_us; | |
796 | ||
ff01b0ea SB |
797 | *scpi_response = NULL; |
798 | ||
26e8c6a2 | 799 | /* Get (the first chunk of) the response. */ |
d64be25b SB |
800 | while (response->len < 2) { |
801 | ret = sr_scpi_read_response(scpi, response, timeout); | |
802 | if (ret < 0) { | |
803 | g_string_free(response, TRUE); | |
804 | return ret; | |
805 | } | |
ff01b0ea SB |
806 | } |
807 | ||
26e8c6a2 GS |
808 | /* |
809 | * SCPI protocol data blocks are preceeded with a length spec. | |
810 | * The length spec consists of a '#' marker, one digit which | |
811 | * specifies the character count of the length spec, and the | |
812 | * respective number of characters which specify the data block's | |
813 | * length. Raw data bytes follow (thus one must no longer assume | |
814 | * that the received input stream would be an ASCIIZ string). | |
815 | * | |
816 | * Get the data block length, and strip off the length spec from | |
817 | * the input buffer, leaving just the data bytes. | |
818 | */ | |
ff01b0ea SB |
819 | if (response->str[0] != '#') { |
820 | g_string_free(response, TRUE); | |
821 | return SR_ERR_DATA; | |
822 | } | |
ff01b0ea | 823 | buf[0] = response->str[1]; |
26e8c6a2 | 824 | buf[1] = '\0'; |
ff01b0ea SB |
825 | ret = sr_atol(buf, &llen); |
826 | if ((ret != SR_OK) || (llen == 0)) { | |
827 | g_string_free(response, TRUE); | |
828 | return ret; | |
829 | } | |
d64be25b SB |
830 | |
831 | while (response->len < (unsigned long)(2 + llen)) { | |
832 | ret = sr_scpi_read_response(scpi, response, timeout); | |
833 | if (ret < 0) { | |
834 | g_string_free(response, TRUE); | |
835 | return ret; | |
836 | } | |
837 | } | |
838 | ||
ff01b0ea | 839 | memcpy(buf, &response->str[2], llen); |
26e8c6a2 | 840 | buf[llen] = '\0'; |
ff01b0ea SB |
841 | ret = sr_atol(buf, &datalen); |
842 | if ((ret != SR_OK) || (datalen == 0)) { | |
843 | g_string_free(response, TRUE); | |
844 | return ret; | |
845 | } | |
ff01b0ea SB |
846 | g_string_erase(response, 0, 2 + llen); |
847 | ||
26e8c6a2 GS |
848 | /* |
849 | * If the initially assumed length does not cover the data block | |
850 | * length, then re-allocate the buffer size to the now known | |
851 | * length, and keep reading more chunks of response data. | |
852 | */ | |
ff01b0ea SB |
853 | if (response->len < (unsigned long)(datalen)) { |
854 | int oldlen = response->len; | |
855 | g_string_set_size(response, datalen); | |
856 | g_string_set_size(response, oldlen); | |
857 | } | |
d64be25b | 858 | |
ff01b0ea | 859 | while (response->len < (unsigned long)(datalen)) { |
d64be25b SB |
860 | ret = sr_scpi_read_response(scpi, response, timeout); |
861 | if (ret < 0) { | |
ff01b0ea SB |
862 | g_string_free(response, TRUE); |
863 | return ret; | |
864 | } | |
d64be25b SB |
865 | if (ret > 0) |
866 | timeout = g_get_monotonic_time() + scpi->read_timeout_us; | |
ff01b0ea SB |
867 | } |
868 | ||
26e8c6a2 | 869 | /* Convert received data to byte array. */ |
ff01b0ea SB |
870 | *scpi_response = g_byte_array_new_take( |
871 | (guint8*)g_string_free(response, FALSE), datalen); | |
872 | ||
d64be25b | 873 | return SR_OK; |
ff01b0ea SB |
874 | } |
875 | ||
7b9d7320 DJ |
876 | /** |
877 | * Send the *IDN? SCPI command, receive the reply, parse it and store the | |
878 | * reply as a sr_scpi_hw_info structure in the supplied scpi_response pointer. | |
879 | * | |
d5976d8b UH |
880 | * The hw_info structure must be freed by the caller via sr_scpi_hw_info_free(). |
881 | * | |
23f43dff | 882 | * @param scpi Previously initialised SCPI device structure. |
7b9d7320 DJ |
883 | * @param scpi_response Pointer where to store the hw_info structure. |
884 | * | |
c0d25779 | 885 | * @return SR_OK upon success, SR_ERR* on failure. |
7b9d7320 | 886 | */ |
23f43dff | 887 | SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi, |
7b9d7320 DJ |
888 | struct sr_scpi_hw_info **scpi_response) |
889 | { | |
c0d25779 | 890 | int num_tokens, ret; |
7b9d7320 DJ |
891 | char *response; |
892 | gchar **tokens; | |
7b9d7320 DJ |
893 | struct sr_scpi_hw_info *hw_info; |
894 | ||
895 | response = NULL; | |
896 | tokens = NULL; | |
897 | ||
c0d25779 BV |
898 | ret = sr_scpi_get_string(scpi, SCPI_CMD_IDN, &response); |
899 | if (ret != SR_OK && !response) | |
900 | return ret; | |
7b9d7320 | 901 | |
77c16c04 ML |
902 | sr_info("Got IDN string: '%s'", response); |
903 | ||
7b9d7320 DJ |
904 | /* |
905 | * The response to a '*IDN?' is specified by the SCPI spec. It contains | |
906 | * a comma-separated list containing the manufacturer name, instrument | |
907 | * model, serial number of the instrument and the firmware version. | |
908 | */ | |
909 | tokens = g_strsplit(response, ",", 0); | |
910 | ||
911 | for (num_tokens = 0; tokens[num_tokens] != NULL; num_tokens++); | |
912 | ||
0c08023f | 913 | if (num_tokens < 4) { |
d5976d8b | 914 | sr_dbg("IDN response not according to spec: %80.s.", response); |
7b9d7320 DJ |
915 | g_strfreev(tokens); |
916 | g_free(response); | |
c0d25779 | 917 | return SR_ERR_DATA; |
7b9d7320 DJ |
918 | } |
919 | g_free(response); | |
920 | ||
91219afc | 921 | hw_info = g_malloc0(sizeof(struct sr_scpi_hw_info)); |
558d438d BV |
922 | hw_info->manufacturer = g_strstrip(g_strdup(tokens[0])); |
923 | hw_info->model = g_strstrip(g_strdup(tokens[1])); | |
924 | hw_info->serial_number = g_strstrip(g_strdup(tokens[2])); | |
925 | hw_info->firmware_version = g_strstrip(g_strdup(tokens[3])); | |
7b9d7320 DJ |
926 | |
927 | g_strfreev(tokens); | |
928 | ||
929 | *scpi_response = hw_info; | |
930 | ||
931 | return SR_OK; | |
932 | } | |
933 | ||
934 | /** | |
935 | * Free a sr_scpi_hw_info struct. | |
936 | * | |
937 | * @param hw_info Pointer to the struct to free. | |
938 | * | |
939 | * This function is safe to call with a NULL pointer. | |
940 | */ | |
941 | SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info) | |
942 | { | |
943 | if (hw_info) { | |
944 | g_free(hw_info->manufacturer); | |
945 | g_free(hw_info->model); | |
946 | g_free(hw_info->serial_number); | |
947 | g_free(hw_info->firmware_version); | |
948 | g_free(hw_info); | |
949 | } | |
950 | } |