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