]>
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 | ||
7b9d7320 DJ |
20 | #include <glib.h> |
21 | #include <string.h> | |
c1aae900 | 22 | #include <libsigrok/libsigrok.h> |
515ab088 | 23 | #include "libsigrok-internal.h" |
5a1afc09 | 24 | #include "scpi.h" |
7b9d7320 | 25 | |
3544f848 | 26 | #define LOG_PREFIX "scpi" |
7b9d7320 DJ |
27 | |
28 | #define SCPI_READ_RETRIES 100 | |
1a46cc62 | 29 | #define SCPI_READ_RETRY_TIMEOUT_US (10 * 1000) |
7b9d7320 | 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 | * |
c0d25779 | 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; | |
3b95bd91 | 386 | gint64 laststart; |
9092e668 | 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 | ||
3b95bd91 | 396 | laststart = g_get_monotonic_time(); |
9092e668 | 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) { | |
3b95bd91 | 405 | sr_err("Incompletely read SCPI response."); |
05c644ea ML |
406 | g_string_free(response, TRUE); |
407 | return SR_ERR; | |
3b95bd91 MK |
408 | } else if (len > 0) { |
409 | laststart = g_get_monotonic_time(); | |
05c644ea ML |
410 | } |
411 | g_string_append_len(response, buf, len); | |
3b95bd91 MK |
412 | elapsed_ms = (g_get_monotonic_time() - laststart) / 1000; |
413 | if (elapsed_ms >= scpi->read_timeout_ms) { | |
9092e668 ML |
414 | sr_err("Timed out waiting for SCPI response."); |
415 | g_string_free(response, TRUE); | |
416 | return SR_ERR; | |
417 | } | |
05c644ea ML |
418 | } |
419 | ||
d03dfac6 ML |
420 | /* Get rid of trailing linefeed if present */ |
421 | if (response->len >= 1 && response->str[response->len - 1] == '\n') | |
422 | g_string_truncate(response, response->len - 1); | |
423 | ||
edbd0925 ML |
424 | /* Get rid of trailing carriage return if present */ |
425 | if (response->len >= 1 && response->str[response->len - 1] == '\r') | |
426 | g_string_truncate(response, response->len - 1); | |
427 | ||
05c644ea ML |
428 | *scpi_response = response->str; |
429 | g_string_free(response, FALSE); | |
430 | ||
3b95bd91 | 431 | sr_spew("Got response: '%.70s', length %d.", *scpi_response, strlen(*scpi_response)); |
cf9f4bc5 | 432 | |
05c644ea | 433 | return SR_OK; |
d730f70e DJ |
434 | } |
435 | ||
436 | /** | |
437 | * Send a SCPI command, read the reply, parse it as a bool value and store the | |
438 | * result in scpi_response. | |
439 | * | |
23f43dff | 440 | * @param scpi Previously initialised SCPI device structure. |
d730f70e DJ |
441 | * @param command The SCPI command to send to the device (can be NULL). |
442 | * @param scpi_response Pointer where to store the parsed result. | |
443 | * | |
c0d25779 | 444 | * @return SR_OK on success, SR_ERR* on failure. |
d730f70e | 445 | */ |
23f43dff | 446 | SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi, |
d730f70e DJ |
447 | const char *command, gboolean *scpi_response) |
448 | { | |
449 | int ret; | |
450 | char *response; | |
451 | ||
452 | response = NULL; | |
453 | ||
c0d25779 BV |
454 | ret = sr_scpi_get_string(scpi, command, &response); |
455 | if (ret != SR_OK && !response) | |
456 | return ret; | |
d730f70e | 457 | |
d5976d8b | 458 | if (parse_strict_bool(response, scpi_response) == SR_OK) |
d730f70e DJ |
459 | ret = SR_OK; |
460 | else | |
c0d25779 | 461 | ret = SR_ERR_DATA; |
d730f70e DJ |
462 | |
463 | g_free(response); | |
464 | ||
465 | return ret; | |
466 | } | |
467 | ||
468 | /** | |
469 | * Send a SCPI command, read the reply, parse it as an integer and store the | |
470 | * result in scpi_response. | |
471 | * | |
23f43dff | 472 | * @param scpi Previously initialised SCPI device structure. |
d730f70e DJ |
473 | * @param command The SCPI command to send to the device (can be NULL). |
474 | * @param scpi_response Pointer where to store the parsed result. | |
475 | * | |
c0d25779 | 476 | * @return SR_OK on success, SR_ERR* on failure. |
d730f70e | 477 | */ |
23f43dff | 478 | SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi, |
d5976d8b | 479 | const char *command, int *scpi_response) |
d730f70e DJ |
480 | { |
481 | int ret; | |
482 | char *response; | |
483 | ||
484 | response = NULL; | |
485 | ||
c0d25779 BV |
486 | ret = sr_scpi_get_string(scpi, command, &response); |
487 | if (ret != SR_OK && !response) | |
488 | return ret; | |
d730f70e DJ |
489 | |
490 | if (sr_atoi(response, scpi_response) == SR_OK) | |
491 | ret = SR_OK; | |
492 | else | |
c0d25779 | 493 | ret = SR_ERR_DATA; |
d730f70e DJ |
494 | |
495 | g_free(response); | |
496 | ||
497 | return ret; | |
498 | } | |
499 | ||
500 | /** | |
501 | * Send a SCPI command, read the reply, parse it as a float and store the | |
502 | * result in scpi_response. | |
503 | * | |
23f43dff | 504 | * @param scpi Previously initialised SCPI device structure. |
d730f70e DJ |
505 | * @param command The SCPI command to send to the device (can be NULL). |
506 | * @param scpi_response Pointer where to store the parsed result. | |
507 | * | |
c0d25779 | 508 | * @return SR_OK on success, SR_ERR* on failure. |
d730f70e | 509 | */ |
23f43dff | 510 | SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi, |
d730f70e DJ |
511 | const char *command, float *scpi_response) |
512 | { | |
513 | int ret; | |
514 | char *response; | |
515 | ||
516 | response = NULL; | |
517 | ||
c0d25779 BV |
518 | ret = sr_scpi_get_string(scpi, command, &response); |
519 | if (ret != SR_OK && !response) | |
520 | return ret; | |
d730f70e | 521 | |
13dbd151 | 522 | if (sr_atof_ascii(response, scpi_response) == SR_OK) |
d730f70e DJ |
523 | ret = SR_OK; |
524 | else | |
c0d25779 | 525 | ret = SR_ERR_DATA; |
d730f70e DJ |
526 | |
527 | g_free(response); | |
528 | ||
529 | return ret; | |
530 | } | |
531 | ||
532 | /** | |
533 | * Send a SCPI command, read the reply, parse it as a double and store the | |
534 | * result in scpi_response. | |
535 | * | |
23f43dff | 536 | * @param scpi Previously initialised SCPI device structure. |
d730f70e DJ |
537 | * @param command The SCPI command to send to the device (can be NULL). |
538 | * @param scpi_response Pointer where to store the parsed result. | |
539 | * | |
c0d25779 | 540 | * @return SR_OK on success, SR_ERR* on failure. |
d730f70e | 541 | */ |
23f43dff | 542 | SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi, |
d5976d8b | 543 | const char *command, double *scpi_response) |
d730f70e DJ |
544 | { |
545 | int ret; | |
546 | char *response; | |
547 | ||
548 | response = NULL; | |
549 | ||
c0d25779 BV |
550 | ret = sr_scpi_get_string(scpi, command, &response); |
551 | if (ret != SR_OK && !response) | |
552 | return ret; | |
d730f70e DJ |
553 | |
554 | if (sr_atod(response, scpi_response) == SR_OK) | |
555 | ret = SR_OK; | |
556 | else | |
c0d25779 | 557 | ret = SR_ERR_DATA; |
d730f70e DJ |
558 | |
559 | g_free(response); | |
560 | ||
7b9d7320 DJ |
561 | return ret; |
562 | } | |
563 | ||
f5922ade DJ |
564 | /** |
565 | * Send a SCPI *OPC? command, read the reply and return the result of the | |
566 | * command. | |
567 | * | |
23f43dff | 568 | * @param scpi Previously initialised SCPI device structure. |
f5922ade | 569 | * |
c0d25779 | 570 | * @return SR_OK on success, SR_ERR* on failure. |
f5922ade | 571 | */ |
23f43dff | 572 | SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi) |
f5922ade DJ |
573 | { |
574 | unsigned int i; | |
575 | gboolean opc; | |
576 | ||
577 | for (i = 0; i < SCPI_READ_RETRIES; ++i) { | |
23f43dff | 578 | sr_scpi_get_bool(scpi, SCPI_CMD_OPC, &opc); |
f5922ade DJ |
579 | if (opc) |
580 | return SR_OK; | |
1a46cc62 | 581 | g_usleep(SCPI_READ_RETRY_TIMEOUT_US); |
f5922ade DJ |
582 | } |
583 | ||
584 | return SR_ERR; | |
585 | } | |
586 | ||
8acbb89a DJ |
587 | /** |
588 | * Send a SCPI command, read the reply, parse it as comma separated list of | |
589 | * floats and store the as an result in scpi_response. | |
590 | * | |
23f43dff | 591 | * @param scpi Previously initialised SCPI device structure. |
8acbb89a DJ |
592 | * @param command The SCPI command to send to the device (can be NULL). |
593 | * @param scpi_response Pointer where to store the parsed result. | |
594 | * | |
c0d25779 | 595 | * @return SR_OK upon successfully parsing all values, SR_ERR* upon a parsing |
d5976d8b UH |
596 | * error or upon no response. The allocated response must be freed by |
597 | * the caller in the case of an SR_OK as well as in the case of | |
598 | * parsing error. | |
8acbb89a | 599 | */ |
23f43dff | 600 | SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi, |
d5976d8b | 601 | const char *command, GArray **scpi_response) |
8acbb89a DJ |
602 | { |
603 | int ret; | |
604 | float tmp; | |
605 | char *response; | |
d5976d8b | 606 | gchar **ptr, **tokens; |
8acbb89a DJ |
607 | GArray *response_array; |
608 | ||
609 | ret = SR_OK; | |
610 | response = NULL; | |
611 | tokens = NULL; | |
612 | ||
c0d25779 BV |
613 | ret = sr_scpi_get_string(scpi, command, &response); |
614 | if (ret != SR_OK && !response) | |
615 | return ret; | |
8acbb89a DJ |
616 | |
617 | tokens = g_strsplit(response, ",", 0); | |
618 | ptr = tokens; | |
619 | ||
620 | response_array = g_array_sized_new(TRUE, FALSE, sizeof(float), 256); | |
621 | ||
d5976d8b | 622 | while (*ptr) { |
13dbd151 | 623 | if (sr_atof_ascii(*ptr, &tmp) == SR_OK) |
8acbb89a DJ |
624 | response_array = g_array_append_val(response_array, |
625 | tmp); | |
626 | else | |
c0d25779 | 627 | ret = SR_ERR_DATA; |
8acbb89a DJ |
628 | |
629 | ptr++; | |
630 | } | |
631 | g_strfreev(tokens); | |
632 | g_free(response); | |
633 | ||
c0d25779 | 634 | if (ret != SR_OK && response_array->len == 0) { |
8acbb89a DJ |
635 | g_array_free(response_array, TRUE); |
636 | *scpi_response = NULL; | |
c0d25779 | 637 | return SR_ERR_DATA; |
8acbb89a DJ |
638 | } |
639 | ||
640 | *scpi_response = response_array; | |
641 | ||
1a323dd8 DJ |
642 | return ret; |
643 | } | |
644 | ||
645 | /** | |
646 | * Send a SCPI command, read the reply, parse it as comma separated list of | |
647 | * unsigned 8 bit integers and store the as an result in scpi_response. | |
648 | * | |
23f43dff | 649 | * @param scpi Previously initialised SCPI device structure. |
1a323dd8 DJ |
650 | * @param command The SCPI command to send to the device (can be NULL). |
651 | * @param scpi_response Pointer where to store the parsed result. | |
652 | * | |
c0d25779 | 653 | * @return SR_OK upon successfully parsing all values, SR_ERR* upon a parsing |
d5976d8b UH |
654 | * error or upon no response. The allocated response must be freed by |
655 | * the caller in the case of an SR_OK as well as in the case of | |
656 | * parsing error. | |
1a323dd8 | 657 | */ |
23f43dff | 658 | SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi, |
d5976d8b | 659 | const char *command, GArray **scpi_response) |
1a323dd8 | 660 | { |
d5976d8b | 661 | int tmp, ret; |
1a323dd8 | 662 | char *response; |
d5976d8b | 663 | gchar **ptr, **tokens; |
1a323dd8 DJ |
664 | GArray *response_array; |
665 | ||
666 | ret = SR_OK; | |
667 | response = NULL; | |
668 | tokens = NULL; | |
669 | ||
c0d25779 BV |
670 | ret = sr_scpi_get_string(scpi, command, &response); |
671 | if (ret != SR_OK && !response) | |
672 | return ret; | |
1a323dd8 DJ |
673 | |
674 | tokens = g_strsplit(response, ",", 0); | |
675 | ptr = tokens; | |
676 | ||
677 | response_array = g_array_sized_new(TRUE, FALSE, sizeof(uint8_t), 256); | |
678 | ||
d5976d8b | 679 | while (*ptr) { |
1a323dd8 DJ |
680 | if (sr_atoi(*ptr, &tmp) == SR_OK) |
681 | response_array = g_array_append_val(response_array, | |
682 | tmp); | |
683 | else | |
c0d25779 | 684 | ret = SR_ERR_DATA; |
1a323dd8 DJ |
685 | |
686 | ptr++; | |
687 | } | |
688 | g_strfreev(tokens); | |
689 | g_free(response); | |
690 | ||
691 | if (response_array->len == 0) { | |
692 | g_array_free(response_array, TRUE); | |
693 | *scpi_response = NULL; | |
c0d25779 | 694 | return SR_ERR_DATA; |
1a323dd8 DJ |
695 | } |
696 | ||
697 | *scpi_response = response_array; | |
698 | ||
8acbb89a DJ |
699 | return ret; |
700 | } | |
701 | ||
7b9d7320 DJ |
702 | /** |
703 | * Send the *IDN? SCPI command, receive the reply, parse it and store the | |
704 | * reply as a sr_scpi_hw_info structure in the supplied scpi_response pointer. | |
705 | * | |
d5976d8b UH |
706 | * The hw_info structure must be freed by the caller via sr_scpi_hw_info_free(). |
707 | * | |
23f43dff | 708 | * @param scpi Previously initialised SCPI device structure. |
7b9d7320 DJ |
709 | * @param scpi_response Pointer where to store the hw_info structure. |
710 | * | |
c0d25779 | 711 | * @return SR_OK upon success, SR_ERR* on failure. |
7b9d7320 | 712 | */ |
23f43dff | 713 | SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi, |
7b9d7320 DJ |
714 | struct sr_scpi_hw_info **scpi_response) |
715 | { | |
c0d25779 | 716 | int num_tokens, ret; |
7b9d7320 DJ |
717 | char *response; |
718 | gchar **tokens; | |
7b9d7320 DJ |
719 | struct sr_scpi_hw_info *hw_info; |
720 | ||
721 | response = NULL; | |
722 | tokens = NULL; | |
723 | ||
c0d25779 BV |
724 | ret = sr_scpi_get_string(scpi, SCPI_CMD_IDN, &response); |
725 | if (ret != SR_OK && !response) | |
726 | return ret; | |
7b9d7320 | 727 | |
77c16c04 ML |
728 | sr_info("Got IDN string: '%s'", response); |
729 | ||
7b9d7320 DJ |
730 | /* |
731 | * The response to a '*IDN?' is specified by the SCPI spec. It contains | |
732 | * a comma-separated list containing the manufacturer name, instrument | |
733 | * model, serial number of the instrument and the firmware version. | |
734 | */ | |
735 | tokens = g_strsplit(response, ",", 0); | |
736 | ||
737 | for (num_tokens = 0; tokens[num_tokens] != NULL; num_tokens++); | |
738 | ||
0c08023f | 739 | if (num_tokens < 4) { |
d5976d8b | 740 | sr_dbg("IDN response not according to spec: %80.s.", response); |
7b9d7320 DJ |
741 | g_strfreev(tokens); |
742 | g_free(response); | |
c0d25779 | 743 | return SR_ERR_DATA; |
7b9d7320 DJ |
744 | } |
745 | g_free(response); | |
746 | ||
91219afc | 747 | hw_info = g_malloc0(sizeof(struct sr_scpi_hw_info)); |
558d438d BV |
748 | hw_info->manufacturer = g_strstrip(g_strdup(tokens[0])); |
749 | hw_info->model = g_strstrip(g_strdup(tokens[1])); | |
750 | hw_info->serial_number = g_strstrip(g_strdup(tokens[2])); | |
751 | hw_info->firmware_version = g_strstrip(g_strdup(tokens[3])); | |
7b9d7320 DJ |
752 | |
753 | g_strfreev(tokens); | |
754 | ||
755 | *scpi_response = hw_info; | |
756 | ||
757 | return SR_OK; | |
758 | } | |
759 | ||
760 | /** | |
761 | * Free a sr_scpi_hw_info struct. | |
762 | * | |
763 | * @param hw_info Pointer to the struct to free. | |
764 | * | |
765 | * This function is safe to call with a NULL pointer. | |
766 | */ | |
767 | SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info) | |
768 | { | |
769 | if (hw_info) { | |
770 | g_free(hw_info->manufacturer); | |
771 | g_free(hw_info->model); | |
772 | g_free(hw_info->serial_number); | |
773 | g_free(hw_info->firmware_version); | |
774 | g_free(hw_info); | |
775 | } | |
776 | } |