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