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