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