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