]>
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 | ||
6ec6c43b | 20 | #include <config.h> |
7b9d7320 DJ |
21 | #include <glib.h> |
22 | #include <string.h> | |
c1aae900 | 23 | #include <libsigrok/libsigrok.h> |
515ab088 | 24 | #include "libsigrok-internal.h" |
5a1afc09 | 25 | #include "scpi.h" |
7b9d7320 | 26 | |
3544f848 | 27 | #define LOG_PREFIX "scpi" |
7b9d7320 DJ |
28 | |
29 | #define SCPI_READ_RETRIES 100 | |
1a46cc62 | 30 | #define SCPI_READ_RETRY_TIMEOUT_US (10 * 1000) |
7b9d7320 | 31 | |
aa1e3b40 DJ |
32 | /** |
33 | * Parse a string representation of a boolean-like value into a gboolean. | |
34 | * Similar to sr_parse_boolstring but rejects strings which do not represent | |
35 | * a boolean-like value. | |
36 | * | |
37 | * @param str String to convert. | |
38 | * @param ret Pointer to a gboolean where the result of the conversion will be | |
39 | * stored. | |
40 | * | |
41 | * @return SR_OK on success, SR_ERR on failure. | |
42 | */ | |
d5976d8b | 43 | static int parse_strict_bool(const char *str, gboolean *ret) |
aa1e3b40 DJ |
44 | { |
45 | if (!str) | |
46 | return SR_ERR_ARG; | |
47 | ||
48 | if (!g_strcmp0(str, "1") || | |
49 | !g_ascii_strncasecmp(str, "y", 1) || | |
50 | !g_ascii_strncasecmp(str, "t", 1) || | |
51 | !g_ascii_strncasecmp(str, "yes", 3) || | |
52 | !g_ascii_strncasecmp(str, "true", 4) || | |
53 | !g_ascii_strncasecmp(str, "on", 2)) { | |
aa1e3b40 DJ |
54 | *ret = TRUE; |
55 | return SR_OK; | |
aa1e3b40 DJ |
56 | } else if (!g_strcmp0(str, "0") || |
57 | !g_ascii_strncasecmp(str, "n", 1) || | |
58 | !g_ascii_strncasecmp(str, "f", 1) || | |
59 | !g_ascii_strncasecmp(str, "no", 2) || | |
60 | !g_ascii_strncasecmp(str, "false", 5) || | |
61 | !g_ascii_strncasecmp(str, "off", 3)) { | |
aa1e3b40 DJ |
62 | *ret = FALSE; |
63 | return SR_OK; | |
64 | } | |
65 | ||
66 | return SR_ERR; | |
67 | } | |
68 | ||
f754c146 | 69 | SR_PRIV extern const struct sr_scpi_dev_inst scpi_serial_dev; |
104ed125 AJ |
70 | SR_PRIV extern const struct sr_scpi_dev_inst scpi_tcp_raw_dev; |
71 | SR_PRIV extern const struct sr_scpi_dev_inst scpi_tcp_rigol_dev; | |
20ed3cee | 72 | SR_PRIV extern const struct sr_scpi_dev_inst scpi_usbtmc_libusb_dev; |
f754c146 | 73 | SR_PRIV extern const struct sr_scpi_dev_inst scpi_vxi_dev; |
1fb2312f | 74 | SR_PRIV extern const struct sr_scpi_dev_inst scpi_visa_dev; |
7343ad1e | 75 | SR_PRIV extern const struct sr_scpi_dev_inst scpi_libgpib_dev; |
f754c146 AJ |
76 | |
77 | static const struct sr_scpi_dev_inst *scpi_devs[] = { | |
104ed125 AJ |
78 | &scpi_tcp_raw_dev, |
79 | &scpi_tcp_rigol_dev, | |
20ed3cee AJ |
80 | #ifdef HAVE_LIBUSB_1_0 |
81 | &scpi_usbtmc_libusb_dev, | |
82 | #endif | |
613c1108 | 83 | #if HAVE_RPC |
f754c146 AJ |
84 | &scpi_vxi_dev, |
85 | #endif | |
1fb2312f ML |
86 | #ifdef HAVE_LIBREVISA |
87 | &scpi_visa_dev, | |
88 | #endif | |
bb2a4ed4 | 89 | #ifdef HAVE_LIBGPIB |
7343ad1e | 90 | &scpi_libgpib_dev, |
bb2a4ed4 | 91 | #endif |
f754c146 | 92 | #ifdef HAVE_LIBSERIALPORT |
d9251a2c | 93 | &scpi_serial_dev, /* Must be last as it matches any resource. */ |
f754c146 AJ |
94 | #endif |
95 | }; | |
96 | ||
85b69c2b | 97 | static struct sr_dev_inst *sr_scpi_scan_resource(struct drv_context *drvc, |
b541f837 AJ |
98 | const char *resource, const char *serialcomm, |
99 | struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi)) | |
100 | { | |
101 | struct sr_scpi_dev_inst *scpi; | |
102 | struct sr_dev_inst *sdi; | |
103 | ||
104 | if (!(scpi = scpi_dev_inst_new(drvc, resource, serialcomm))) | |
105 | return NULL; | |
106 | ||
107 | if (sr_scpi_open(scpi) != SR_OK) { | |
108 | sr_info("Couldn't open SCPI device."); | |
109 | sr_scpi_free(scpi); | |
110 | return NULL; | |
111 | }; | |
112 | ||
a00106b7 | 113 | sdi = probe_device(scpi); |
b541f837 AJ |
114 | |
115 | sr_scpi_close(scpi); | |
a00106b7 ML |
116 | |
117 | if (sdi) | |
118 | sdi->status = SR_ST_INACTIVE; | |
119 | else | |
120 | sr_scpi_free(scpi); | |
121 | ||
122 | return sdi; | |
b541f837 AJ |
123 | } |
124 | ||
125 | SR_PRIV GSList *sr_scpi_scan(struct drv_context *drvc, GSList *options, | |
126 | struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi)) | |
127 | { | |
85b69c2b BV |
128 | GSList *resources, *l, *devices; |
129 | struct sr_dev_inst *sdi; | |
b541f837 AJ |
130 | const char *resource = NULL; |
131 | const char *serialcomm = NULL; | |
132 | gchar **res; | |
133 | unsigned i; | |
134 | ||
135 | for (l = options; l; l = l->next) { | |
136 | struct sr_config *src = l->data; | |
137 | switch (src->key) { | |
138 | case SR_CONF_CONN: | |
139 | resource = g_variant_get_string(src->data, NULL); | |
140 | break; | |
141 | case SR_CONF_SERIALCOMM: | |
142 | serialcomm = g_variant_get_string(src->data, NULL); | |
143 | break; | |
144 | } | |
145 | } | |
146 | ||
85b69c2b | 147 | devices = NULL; |
b541f837 AJ |
148 | for (i = 0; i < ARRAY_SIZE(scpi_devs); i++) { |
149 | if ((resource && strcmp(resource, scpi_devs[i]->prefix)) | |
150 | || !scpi_devs[i]->scan) | |
151 | continue; | |
152 | resources = scpi_devs[i]->scan(drvc); | |
153 | for (l = resources; l; l = l->next) { | |
154 | res = g_strsplit(l->data, ":", 2); | |
85b69c2b | 155 | if (res[0] && (sdi = sr_scpi_scan_resource(drvc, res[0], |
b2c02b07 | 156 | serialcomm ? serialcomm : res[1], probe_device))) { |
85b69c2b | 157 | devices = g_slist_append(devices, sdi); |
b2c02b07 SA |
158 | sdi->connection_id = g_strdup(l->data); |
159 | } | |
b541f837 AJ |
160 | g_strfreev(res); |
161 | } | |
162 | g_slist_free_full(resources, g_free); | |
163 | } | |
164 | ||
85b69c2b BV |
165 | if (!devices && resource) { |
166 | sdi = sr_scpi_scan_resource(drvc, resource, serialcomm, probe_device); | |
cfd8ec53 BV |
167 | if (sdi) |
168 | devices = g_slist_append(NULL, sdi); | |
85b69c2b | 169 | } |
b541f837 AJ |
170 | |
171 | /* Tack a copy of the newly found devices onto the driver list. */ | |
172 | if (devices) | |
85b69c2b | 173 | drvc->instances = g_slist_concat(drvc->instances, g_slist_copy(devices)); |
b541f837 AJ |
174 | |
175 | return devices; | |
176 | } | |
177 | ||
17bdda58 AJ |
178 | SR_PRIV struct sr_scpi_dev_inst *scpi_dev_inst_new(struct drv_context *drvc, |
179 | const char *resource, const char *serialcomm) | |
c3515cea AJ |
180 | { |
181 | struct sr_scpi_dev_inst *scpi = NULL; | |
f754c146 AJ |
182 | const struct sr_scpi_dev_inst *scpi_dev; |
183 | gchar **params; | |
184 | unsigned i; | |
c3515cea | 185 | |
f754c146 AJ |
186 | for (i = 0; i < ARRAY_SIZE(scpi_devs); i++) { |
187 | scpi_dev = scpi_devs[i]; | |
188 | if (!strncmp(resource, scpi_dev->prefix, strlen(scpi_dev->prefix))) { | |
189 | sr_dbg("Opening %s device %s.", scpi_dev->name, resource); | |
190 | scpi = g_malloc(sizeof(*scpi)); | |
191 | *scpi = *scpi_dev; | |
192 | scpi->priv = g_malloc0(scpi->priv_size); | |
37ef582d | 193 | scpi->read_timeout_us = 1000 * 1000; |
f754c146 | 194 | params = g_strsplit(resource, "/", 0); |
17bdda58 | 195 | if (scpi->dev_inst_new(scpi->priv, drvc, resource, |
f754c146 AJ |
196 | params, serialcomm) != SR_OK) { |
197 | sr_scpi_free(scpi); | |
198 | scpi = NULL; | |
199 | } | |
200 | g_strfreev(params); | |
201 | break; | |
202 | } | |
c3515cea | 203 | } |
f754c146 | 204 | |
c3515cea AJ |
205 | return scpi; |
206 | } | |
207 | ||
23f43dff ML |
208 | /** |
209 | * Open SCPI device. | |
210 | * | |
211 | * @param scpi Previously initialized SCPI device structure. | |
212 | * | |
213 | * @return SR_OK on success, SR_ERR on failure. | |
214 | */ | |
215 | SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi) | |
216 | { | |
04229f7b | 217 | return scpi->open(scpi); |
23f43dff ML |
218 | } |
219 | ||
220 | /** | |
221 | * Add an event source for an SCPI device. | |
222 | * | |
7efe889e | 223 | * @param session The session to add the event source to. |
23f43dff ML |
224 | * @param scpi Previously initialized SCPI device structure. |
225 | * @param events Events to check for. | |
226 | * @param timeout Max time to wait before the callback is called, ignored if 0. | |
227 | * @param cb Callback function to add. Must not be NULL. | |
228 | * @param cb_data Data for the callback function. Can be NULL. | |
229 | * | |
230 | * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or | |
231 | * SR_ERR_MALLOC upon memory allocation errors. | |
232 | */ | |
102f1239 BV |
233 | SR_PRIV int sr_scpi_source_add(struct sr_session *session, |
234 | struct sr_scpi_dev_inst *scpi, int events, int timeout, | |
235 | sr_receive_data_callback cb, void *cb_data) | |
23f43dff | 236 | { |
102f1239 | 237 | return scpi->source_add(session, scpi->priv, events, timeout, cb, cb_data); |
23f43dff ML |
238 | } |
239 | ||
240 | /** | |
241 | * Remove event source for an SCPI device. | |
242 | * | |
7efe889e | 243 | * @param session The session to remove the event source from. |
23f43dff ML |
244 | * @param scpi Previously initialized SCPI device structure. |
245 | * | |
246 | * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or | |
247 | * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon | |
248 | * internal errors. | |
249 | */ | |
102f1239 BV |
250 | SR_PRIV int sr_scpi_source_remove(struct sr_session *session, |
251 | struct sr_scpi_dev_inst *scpi) | |
23f43dff | 252 | { |
102f1239 | 253 | return scpi->source_remove(session, scpi->priv); |
23f43dff ML |
254 | } |
255 | ||
7b9d7320 DJ |
256 | /** |
257 | * Send a SCPI command. | |
258 | * | |
23f43dff | 259 | * @param scpi Previously initialized SCPI device structure. |
504f40a5 | 260 | * @param format Format string, to be followed by any necessary arguments. |
7b9d7320 DJ |
261 | * |
262 | * @return SR_OK on success, SR_ERR on failure. | |
263 | */ | |
23f43dff | 264 | SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi, |
504f40a5 | 265 | const char *format, ...) |
7b9d7320 | 266 | { |
87c41083 ML |
267 | va_list args; |
268 | int ret; | |
269 | ||
270 | va_start(args, format); | |
271 | ret = sr_scpi_send_variadic(scpi, format, args); | |
272 | va_end(args); | |
273 | ||
274 | return ret; | |
275 | } | |
276 | ||
277 | /** | |
278 | * Send a SCPI command with a variadic argument list. | |
279 | * | |
280 | * @param scpi Previously initialized SCPI device structure. | |
281 | * @param format Format string. | |
282 | * @param args Argument list. | |
283 | * | |
284 | * @return SR_OK on success, SR_ERR on failure. | |
285 | */ | |
286 | SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi, | |
287 | const char *format, va_list args) | |
288 | { | |
289 | va_list args_copy; | |
504f40a5 ML |
290 | char *buf; |
291 | int len, ret; | |
292 | ||
504f40a5 | 293 | /* Get length of buffer required. */ |
87c41083 ML |
294 | va_copy(args_copy, args); |
295 | len = vsnprintf(NULL, 0, format, args_copy); | |
296 | va_end(args_copy); | |
504f40a5 ML |
297 | |
298 | /* Allocate buffer and write out command. */ | |
055804e8 | 299 | buf = g_malloc0(len + 2); |
87c41083 | 300 | vsprintf(buf, format, args); |
055804e8 SB |
301 | if (buf[len - 1] != '\n') |
302 | buf[len] = '\n'; | |
504f40a5 ML |
303 | |
304 | /* Send command. */ | |
305 | ret = scpi->send(scpi->priv, buf); | |
306 | ||
307 | /* Free command buffer. */ | |
308 | g_free(buf); | |
309 | ||
310 | return ret; | |
23f43dff | 311 | } |
7b9d7320 | 312 | |
23f43dff | 313 | /** |
05c644ea | 314 | * Begin receiving an SCPI reply. |
23f43dff ML |
315 | * |
316 | * @param scpi Previously initialised SCPI device structure. | |
23f43dff | 317 | * |
05c644ea | 318 | * @return SR_OK on success, SR_ERR on failure. |
23f43dff | 319 | */ |
05c644ea | 320 | SR_PRIV int sr_scpi_read_begin(struct sr_scpi_dev_inst *scpi) |
23f43dff | 321 | { |
05c644ea | 322 | return scpi->read_begin(scpi->priv); |
23f43dff | 323 | } |
7b9d7320 | 324 | |
a1ff9c18 ML |
325 | /** |
326 | * Read part of a response from SCPI device. | |
327 | * | |
328 | * @param scpi Previously initialised SCPI device structure. | |
329 | * @param buf Buffer to store result. | |
330 | * @param maxlen Maximum number of bytes to read. | |
331 | * | |
332 | * @return Number of bytes read, or SR_ERR upon failure. | |
333 | */ | |
05c644ea | 334 | SR_PRIV int sr_scpi_read_data(struct sr_scpi_dev_inst *scpi, |
a1ff9c18 ML |
335 | char *buf, int maxlen) |
336 | { | |
05c644ea ML |
337 | return scpi->read_data(scpi->priv, buf, maxlen); |
338 | } | |
339 | ||
340 | /** | |
341 | * Check whether a complete SCPI response has been received. | |
342 | * | |
343 | * @param scpi Previously initialised SCPI device structure. | |
344 | * | |
345 | * @return 1 if complete, 0 otherwise. | |
346 | */ | |
347 | SR_PRIV int sr_scpi_read_complete(struct sr_scpi_dev_inst *scpi) | |
348 | { | |
349 | return scpi->read_complete(scpi->priv); | |
a1ff9c18 ML |
350 | } |
351 | ||
23f43dff ML |
352 | /** |
353 | * Close SCPI device. | |
354 | * | |
355 | * @param scpi Previously initialized SCPI device structure. | |
356 | * | |
357 | * @return SR_OK on success, SR_ERR on failure. | |
358 | */ | |
359 | SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi) | |
360 | { | |
04229f7b | 361 | return scpi->close(scpi); |
23f43dff | 362 | } |
7b9d7320 | 363 | |
23f43dff ML |
364 | /** |
365 | * Free SCPI device. | |
366 | * | |
367 | * @param scpi Previously initialized SCPI device structure. | |
368 | * | |
369 | * @return SR_OK on success, SR_ERR on failure. | |
370 | */ | |
371 | SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi) | |
372 | { | |
373 | scpi->free(scpi->priv); | |
f754c146 | 374 | g_free(scpi->priv); |
23f43dff | 375 | g_free(scpi); |
7b9d7320 DJ |
376 | } |
377 | ||
378 | /** | |
379 | * Send a SCPI command, receive the reply and store the reply in scpi_response. | |
380 | * | |
23f43dff | 381 | * @param scpi Previously initialised SCPI device structure. |
7b9d7320 | 382 | * @param command The SCPI command to send to the device (can be NULL). |
d5976d8b | 383 | * @param scpi_response Pointer where to store the SCPI response. |
7b9d7320 | 384 | * |
c0d25779 | 385 | * @return SR_OK on success, SR_ERR* on failure. |
7b9d7320 | 386 | */ |
23f43dff | 387 | SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi, |
d5976d8b | 388 | const char *command, char **scpi_response) |
7b9d7320 | 389 | { |
ff01b0ea SB |
390 | GString *response; |
391 | response = g_string_sized_new(1024); | |
392 | ||
393 | if (sr_scpi_get_data(scpi, command, &response) != SR_OK) { | |
394 | if (response) | |
395 | g_string_free(response, TRUE); | |
396 | return SR_ERR; | |
397 | } | |
398 | ||
399 | /* Get rid of trailing linefeed if present */ | |
400 | if (response->len >= 1 && response->str[response->len - 1] == '\n') | |
401 | g_string_truncate(response, response->len - 1); | |
402 | ||
403 | /* Get rid of trailing carriage return if present */ | |
404 | if (response->len >= 1 && response->str[response->len - 1] == '\r') | |
405 | g_string_truncate(response, response->len - 1); | |
406 | ||
407 | sr_spew("Got response: '%.70s', length %" G_GSIZE_FORMAT ".", | |
408 | response->str, response->len); | |
409 | ||
410 | *scpi_response = g_string_free(response, FALSE); | |
411 | ||
412 | return SR_OK; | |
413 | } | |
414 | ||
415 | SR_PRIV int sr_scpi_get_data(struct sr_scpi_dev_inst *scpi, | |
416 | const char *command, GString **scpi_response) | |
417 | { | |
05c644ea ML |
418 | int len; |
419 | GString *response; | |
37ef582d | 420 | gint64 laststart, now; |
d3de86f3 | 421 | unsigned int offset; |
ff01b0ea | 422 | int space; |
05c644ea | 423 | |
ad21865f | 424 | /* Optionally send caller provided command. */ |
d3de86f3 | 425 | if (command) { |
23f43dff | 426 | if (sr_scpi_send(scpi, command) != SR_OK) |
7b9d7320 | 427 | return SR_ERR; |
d3de86f3 | 428 | } |
7b9d7320 | 429 | |
ad21865f | 430 | /* Initiate SCPI read operation. */ |
05c644ea ML |
431 | if (sr_scpi_read_begin(scpi) != SR_OK) |
432 | return SR_ERR; | |
433 | ||
ad21865f | 434 | /* Keep reading until completion or until timeout. */ |
3b95bd91 | 435 | laststart = g_get_monotonic_time(); |
9092e668 | 436 | |
ff01b0ea | 437 | response = *scpi_response; |
ff01b0ea | 438 | offset = response->len; |
05c644ea ML |
439 | |
440 | while (!sr_scpi_read_complete(scpi)) { | |
ad21865f | 441 | /* Resize the buffer when free space drops below a threshold. */ |
ff01b0ea SB |
442 | space = response->allocated_len - response->len; |
443 | if (space < 128) { | |
444 | g_string_set_size(response, response->len + 1024); | |
ad21865f | 445 | g_string_set_size(response, offset); |
ff01b0ea SB |
446 | space = response->allocated_len - response->len; |
447 | } | |
ad21865f | 448 | /* Read another chunk of the response. */ |
ff01b0ea | 449 | len = sr_scpi_read_data(scpi, &response->str[offset], space); |
05c644ea | 450 | if (len < 0) { |
3b95bd91 | 451 | sr_err("Incompletely read SCPI response."); |
05c644ea | 452 | return SR_ERR; |
37ef582d SB |
453 | } |
454 | ||
455 | now = g_get_monotonic_time(); | |
456 | ||
457 | if (len > 0) { | |
458 | laststart = now; | |
90084681 GS |
459 | offset += len; |
460 | g_string_set_size(response, offset); | |
37ef582d SB |
461 | } else if ((now - laststart) >= scpi->read_timeout_us) { |
462 | /* Quit reading after a period of time without receiving data. */ | |
9092e668 | 463 | sr_err("Timed out waiting for SCPI response."); |
37ef582d | 464 | return SR_ERR_TIMEOUT; |
9092e668 | 465 | } |
05c644ea ML |
466 | } |
467 | ||
05c644ea | 468 | return SR_OK; |
d730f70e DJ |
469 | } |
470 | ||
471 | /** | |
472 | * Send a SCPI command, read the reply, parse it as a bool value and store the | |
473 | * result in scpi_response. | |
474 | * | |
23f43dff | 475 | * @param scpi Previously initialised SCPI device structure. |
d730f70e DJ |
476 | * @param command The SCPI command to send to the device (can be NULL). |
477 | * @param scpi_response Pointer where to store the parsed result. | |
478 | * | |
c0d25779 | 479 | * @return SR_OK on success, SR_ERR* on failure. |
d730f70e | 480 | */ |
23f43dff | 481 | SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi, |
d730f70e DJ |
482 | const char *command, gboolean *scpi_response) |
483 | { | |
484 | int ret; | |
485 | char *response; | |
486 | ||
487 | response = NULL; | |
488 | ||
c0d25779 BV |
489 | ret = sr_scpi_get_string(scpi, command, &response); |
490 | if (ret != SR_OK && !response) | |
491 | return ret; | |
d730f70e | 492 | |
d5976d8b | 493 | if (parse_strict_bool(response, scpi_response) == SR_OK) |
d730f70e DJ |
494 | ret = SR_OK; |
495 | else | |
c0d25779 | 496 | ret = SR_ERR_DATA; |
d730f70e DJ |
497 | |
498 | g_free(response); | |
499 | ||
500 | return ret; | |
501 | } | |
502 | ||
503 | /** | |
504 | * Send a SCPI command, read the reply, parse it as an integer and store the | |
505 | * result in scpi_response. | |
506 | * | |
23f43dff | 507 | * @param scpi Previously initialised SCPI device structure. |
d730f70e DJ |
508 | * @param command The SCPI command to send to the device (can be NULL). |
509 | * @param scpi_response Pointer where to store the parsed result. | |
510 | * | |
c0d25779 | 511 | * @return SR_OK on success, SR_ERR* on failure. |
d730f70e | 512 | */ |
23f43dff | 513 | SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi, |
d5976d8b | 514 | const char *command, int *scpi_response) |
d730f70e DJ |
515 | { |
516 | int ret; | |
517 | char *response; | |
518 | ||
519 | response = NULL; | |
520 | ||
c0d25779 BV |
521 | ret = sr_scpi_get_string(scpi, command, &response); |
522 | if (ret != SR_OK && !response) | |
523 | return ret; | |
d730f70e DJ |
524 | |
525 | if (sr_atoi(response, scpi_response) == SR_OK) | |
526 | ret = SR_OK; | |
527 | else | |
c0d25779 | 528 | ret = SR_ERR_DATA; |
d730f70e DJ |
529 | |
530 | g_free(response); | |
531 | ||
532 | return ret; | |
533 | } | |
534 | ||
535 | /** | |
536 | * Send a SCPI command, read the reply, parse it as a float and store the | |
537 | * result in scpi_response. | |
538 | * | |
23f43dff | 539 | * @param scpi Previously initialised SCPI device structure. |
d730f70e DJ |
540 | * @param command The SCPI command to send to the device (can be NULL). |
541 | * @param scpi_response Pointer where to store the parsed result. | |
542 | * | |
c0d25779 | 543 | * @return SR_OK on success, SR_ERR* on failure. |
d730f70e | 544 | */ |
23f43dff | 545 | SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi, |
d730f70e DJ |
546 | const char *command, float *scpi_response) |
547 | { | |
548 | int ret; | |
549 | char *response; | |
550 | ||
551 | response = NULL; | |
552 | ||
c0d25779 BV |
553 | ret = sr_scpi_get_string(scpi, command, &response); |
554 | if (ret != SR_OK && !response) | |
555 | return ret; | |
d730f70e | 556 | |
13dbd151 | 557 | if (sr_atof_ascii(response, scpi_response) == SR_OK) |
d730f70e DJ |
558 | ret = SR_OK; |
559 | else | |
c0d25779 | 560 | ret = SR_ERR_DATA; |
d730f70e DJ |
561 | |
562 | g_free(response); | |
563 | ||
564 | return ret; | |
565 | } | |
566 | ||
567 | /** | |
568 | * Send a SCPI command, read the reply, parse it as a double and store the | |
569 | * result in scpi_response. | |
570 | * | |
23f43dff | 571 | * @param scpi Previously initialised SCPI device structure. |
d730f70e DJ |
572 | * @param command The SCPI command to send to the device (can be NULL). |
573 | * @param scpi_response Pointer where to store the parsed result. | |
574 | * | |
c0d25779 | 575 | * @return SR_OK on success, SR_ERR* on failure. |
d730f70e | 576 | */ |
23f43dff | 577 | SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi, |
d5976d8b | 578 | const char *command, double *scpi_response) |
d730f70e DJ |
579 | { |
580 | int ret; | |
581 | char *response; | |
582 | ||
583 | response = NULL; | |
584 | ||
c0d25779 BV |
585 | ret = sr_scpi_get_string(scpi, command, &response); |
586 | if (ret != SR_OK && !response) | |
587 | return ret; | |
d730f70e DJ |
588 | |
589 | if (sr_atod(response, scpi_response) == SR_OK) | |
590 | ret = SR_OK; | |
591 | else | |
c0d25779 | 592 | ret = SR_ERR_DATA; |
d730f70e DJ |
593 | |
594 | g_free(response); | |
595 | ||
7b9d7320 DJ |
596 | return ret; |
597 | } | |
598 | ||
f5922ade DJ |
599 | /** |
600 | * Send a SCPI *OPC? command, read the reply and return the result of the | |
601 | * command. | |
602 | * | |
23f43dff | 603 | * @param scpi Previously initialised SCPI device structure. |
f5922ade | 604 | * |
c0d25779 | 605 | * @return SR_OK on success, SR_ERR* on failure. |
f5922ade | 606 | */ |
23f43dff | 607 | SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi) |
f5922ade DJ |
608 | { |
609 | unsigned int i; | |
610 | gboolean opc; | |
611 | ||
0a1f7b09 | 612 | for (i = 0; i < SCPI_READ_RETRIES; i++) { |
23f43dff | 613 | sr_scpi_get_bool(scpi, SCPI_CMD_OPC, &opc); |
f5922ade DJ |
614 | if (opc) |
615 | return SR_OK; | |
1a46cc62 | 616 | g_usleep(SCPI_READ_RETRY_TIMEOUT_US); |
f5922ade DJ |
617 | } |
618 | ||
619 | return SR_ERR; | |
620 | } | |
621 | ||
8acbb89a DJ |
622 | /** |
623 | * Send a SCPI command, read the reply, parse it as comma separated list of | |
624 | * floats and store the as an result in scpi_response. | |
625 | * | |
23f43dff | 626 | * @param scpi Previously initialised SCPI device structure. |
8acbb89a DJ |
627 | * @param command The SCPI command to send to the device (can be NULL). |
628 | * @param scpi_response Pointer where to store the parsed result. | |
629 | * | |
c0d25779 | 630 | * @return SR_OK upon successfully parsing all values, SR_ERR* upon a parsing |
d5976d8b UH |
631 | * error or upon no response. The allocated response must be freed by |
632 | * the caller in the case of an SR_OK as well as in the case of | |
633 | * parsing error. | |
8acbb89a | 634 | */ |
23f43dff | 635 | SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi, |
d5976d8b | 636 | const char *command, GArray **scpi_response) |
8acbb89a DJ |
637 | { |
638 | int ret; | |
639 | float tmp; | |
640 | char *response; | |
d5976d8b | 641 | gchar **ptr, **tokens; |
8acbb89a DJ |
642 | GArray *response_array; |
643 | ||
8acbb89a DJ |
644 | response = NULL; |
645 | tokens = NULL; | |
646 | ||
c0d25779 BV |
647 | ret = sr_scpi_get_string(scpi, command, &response); |
648 | if (ret != SR_OK && !response) | |
649 | return ret; | |
8acbb89a DJ |
650 | |
651 | tokens = g_strsplit(response, ",", 0); | |
652 | ptr = tokens; | |
653 | ||
654 | response_array = g_array_sized_new(TRUE, FALSE, sizeof(float), 256); | |
655 | ||
d5976d8b | 656 | while (*ptr) { |
13dbd151 | 657 | if (sr_atof_ascii(*ptr, &tmp) == SR_OK) |
8acbb89a DJ |
658 | response_array = g_array_append_val(response_array, |
659 | tmp); | |
660 | else | |
c0d25779 | 661 | ret = SR_ERR_DATA; |
8acbb89a DJ |
662 | |
663 | ptr++; | |
664 | } | |
665 | g_strfreev(tokens); | |
666 | g_free(response); | |
667 | ||
c0d25779 | 668 | if (ret != SR_OK && response_array->len == 0) { |
8acbb89a DJ |
669 | g_array_free(response_array, TRUE); |
670 | *scpi_response = NULL; | |
c0d25779 | 671 | return SR_ERR_DATA; |
8acbb89a DJ |
672 | } |
673 | ||
674 | *scpi_response = response_array; | |
675 | ||
1a323dd8 DJ |
676 | return ret; |
677 | } | |
678 | ||
679 | /** | |
680 | * Send a SCPI command, read the reply, parse it as comma separated list of | |
681 | * unsigned 8 bit integers and store the as an result in scpi_response. | |
682 | * | |
23f43dff | 683 | * @param scpi Previously initialised SCPI device structure. |
1a323dd8 DJ |
684 | * @param command The SCPI command to send to the device (can be NULL). |
685 | * @param scpi_response Pointer where to store the parsed result. | |
686 | * | |
c0d25779 | 687 | * @return SR_OK upon successfully parsing all values, SR_ERR* upon a parsing |
d5976d8b UH |
688 | * error or upon no response. The allocated response must be freed by |
689 | * the caller in the case of an SR_OK as well as in the case of | |
690 | * parsing error. | |
1a323dd8 | 691 | */ |
23f43dff | 692 | SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi, |
d5976d8b | 693 | const char *command, GArray **scpi_response) |
1a323dd8 | 694 | { |
d5976d8b | 695 | int tmp, ret; |
1a323dd8 | 696 | char *response; |
d5976d8b | 697 | gchar **ptr, **tokens; |
1a323dd8 DJ |
698 | GArray *response_array; |
699 | ||
1a323dd8 DJ |
700 | response = NULL; |
701 | tokens = NULL; | |
702 | ||
c0d25779 BV |
703 | ret = sr_scpi_get_string(scpi, command, &response); |
704 | if (ret != SR_OK && !response) | |
705 | return ret; | |
1a323dd8 DJ |
706 | |
707 | tokens = g_strsplit(response, ",", 0); | |
708 | ptr = tokens; | |
709 | ||
710 | response_array = g_array_sized_new(TRUE, FALSE, sizeof(uint8_t), 256); | |
711 | ||
d5976d8b | 712 | while (*ptr) { |
1a323dd8 DJ |
713 | if (sr_atoi(*ptr, &tmp) == SR_OK) |
714 | response_array = g_array_append_val(response_array, | |
715 | tmp); | |
716 | else | |
c0d25779 | 717 | ret = SR_ERR_DATA; |
1a323dd8 DJ |
718 | |
719 | ptr++; | |
720 | } | |
721 | g_strfreev(tokens); | |
722 | g_free(response); | |
723 | ||
724 | if (response_array->len == 0) { | |
725 | g_array_free(response_array, TRUE); | |
726 | *scpi_response = NULL; | |
c0d25779 | 727 | return SR_ERR_DATA; |
1a323dd8 DJ |
728 | } |
729 | ||
730 | *scpi_response = response_array; | |
731 | ||
8acbb89a DJ |
732 | return ret; |
733 | } | |
d3de86f3 | 734 | |
ff01b0ea SB |
735 | /** |
736 | * Send a SCPI command, read the reply, parse it as binary data with a | |
737 | * "definite length block" header and store the as an result in scpi_response. | |
738 | * | |
739 | * @param scpi Previously initialised SCPI device structure. | |
740 | * @param command The SCPI command to send to the device (can be NULL). | |
741 | * @param scpi_response Pointer where to store the parsed result. | |
742 | * | |
743 | * @return SR_OK upon successfully parsing all values, SR_ERR* upon a parsing | |
744 | * error or upon no response. The allocated response must be freed by | |
745 | * the caller in the case of an SR_OK as well as in the case of | |
746 | * parsing error. | |
747 | */ | |
748 | SR_PRIV int sr_scpi_get_block(struct sr_scpi_dev_inst *scpi, | |
749 | const char *command, GByteArray **scpi_response) | |
750 | { | |
751 | int ret; | |
752 | GString* response; | |
26e8c6a2 | 753 | char buf[10]; |
ff01b0ea SB |
754 | long llen; |
755 | long datalen; | |
756 | ||
26e8c6a2 GS |
757 | /* |
758 | * Assume an initial maximum length, optionally gets adjusted below. | |
759 | * Prepare a NULL return value for when error paths will be taken. | |
760 | */ | |
ff01b0ea SB |
761 | response = g_string_sized_new(1024); |
762 | *scpi_response = NULL; | |
763 | ||
26e8c6a2 | 764 | /* Get (the first chunk of) the response. */ |
ff01b0ea SB |
765 | ret = sr_scpi_get_data(scpi, command, &response); |
766 | if (ret != SR_OK) { | |
767 | g_string_free(response, TRUE); | |
768 | return ret; | |
769 | } | |
770 | ||
26e8c6a2 GS |
771 | /* |
772 | * SCPI protocol data blocks are preceeded with a length spec. | |
773 | * The length spec consists of a '#' marker, one digit which | |
774 | * specifies the character count of the length spec, and the | |
775 | * respective number of characters which specify the data block's | |
776 | * length. Raw data bytes follow (thus one must no longer assume | |
777 | * that the received input stream would be an ASCIIZ string). | |
778 | * | |
779 | * Get the data block length, and strip off the length spec from | |
780 | * the input buffer, leaving just the data bytes. | |
781 | */ | |
ff01b0ea SB |
782 | if (response->str[0] != '#') { |
783 | g_string_free(response, TRUE); | |
784 | return SR_ERR_DATA; | |
785 | } | |
ff01b0ea | 786 | buf[0] = response->str[1]; |
26e8c6a2 | 787 | buf[1] = '\0'; |
ff01b0ea SB |
788 | ret = sr_atol(buf, &llen); |
789 | if ((ret != SR_OK) || (llen == 0)) { | |
790 | g_string_free(response, TRUE); | |
791 | return ret; | |
792 | } | |
ff01b0ea | 793 | memcpy(buf, &response->str[2], llen); |
26e8c6a2 | 794 | buf[llen] = '\0'; |
ff01b0ea SB |
795 | ret = sr_atol(buf, &datalen); |
796 | if ((ret != SR_OK) || (datalen == 0)) { | |
797 | g_string_free(response, TRUE); | |
798 | return ret; | |
799 | } | |
ff01b0ea SB |
800 | g_string_erase(response, 0, 2 + llen); |
801 | ||
26e8c6a2 GS |
802 | /* |
803 | * If the initially assumed length does not cover the data block | |
804 | * length, then re-allocate the buffer size to the now known | |
805 | * length, and keep reading more chunks of response data. | |
806 | */ | |
ff01b0ea SB |
807 | if (response->len < (unsigned long)(datalen)) { |
808 | int oldlen = response->len; | |
809 | g_string_set_size(response, datalen); | |
810 | g_string_set_size(response, oldlen); | |
811 | } | |
ff01b0ea | 812 | while (response->len < (unsigned long)(datalen)) { |
26e8c6a2 GS |
813 | ret = sr_scpi_get_data(scpi, NULL, &response); |
814 | if (ret != SR_OK) { | |
ff01b0ea SB |
815 | g_string_free(response, TRUE); |
816 | return ret; | |
817 | } | |
818 | } | |
819 | ||
26e8c6a2 | 820 | /* Convert received data to byte array. */ |
ff01b0ea SB |
821 | *scpi_response = g_byte_array_new_take( |
822 | (guint8*)g_string_free(response, FALSE), datalen); | |
823 | ||
824 | return ret; | |
825 | } | |
826 | ||
7b9d7320 DJ |
827 | /** |
828 | * Send the *IDN? SCPI command, receive the reply, parse it and store the | |
829 | * reply as a sr_scpi_hw_info structure in the supplied scpi_response pointer. | |
830 | * | |
d5976d8b UH |
831 | * The hw_info structure must be freed by the caller via sr_scpi_hw_info_free(). |
832 | * | |
23f43dff | 833 | * @param scpi Previously initialised SCPI device structure. |
7b9d7320 DJ |
834 | * @param scpi_response Pointer where to store the hw_info structure. |
835 | * | |
c0d25779 | 836 | * @return SR_OK upon success, SR_ERR* on failure. |
7b9d7320 | 837 | */ |
23f43dff | 838 | SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi, |
7b9d7320 DJ |
839 | struct sr_scpi_hw_info **scpi_response) |
840 | { | |
c0d25779 | 841 | int num_tokens, ret; |
7b9d7320 DJ |
842 | char *response; |
843 | gchar **tokens; | |
7b9d7320 DJ |
844 | struct sr_scpi_hw_info *hw_info; |
845 | ||
846 | response = NULL; | |
847 | tokens = NULL; | |
848 | ||
c0d25779 BV |
849 | ret = sr_scpi_get_string(scpi, SCPI_CMD_IDN, &response); |
850 | if (ret != SR_OK && !response) | |
851 | return ret; | |
7b9d7320 | 852 | |
77c16c04 ML |
853 | sr_info("Got IDN string: '%s'", response); |
854 | ||
7b9d7320 DJ |
855 | /* |
856 | * The response to a '*IDN?' is specified by the SCPI spec. It contains | |
857 | * a comma-separated list containing the manufacturer name, instrument | |
858 | * model, serial number of the instrument and the firmware version. | |
859 | */ | |
860 | tokens = g_strsplit(response, ",", 0); | |
861 | ||
862 | for (num_tokens = 0; tokens[num_tokens] != NULL; num_tokens++); | |
863 | ||
0c08023f | 864 | if (num_tokens < 4) { |
d5976d8b | 865 | sr_dbg("IDN response not according to spec: %80.s.", response); |
7b9d7320 DJ |
866 | g_strfreev(tokens); |
867 | g_free(response); | |
c0d25779 | 868 | return SR_ERR_DATA; |
7b9d7320 DJ |
869 | } |
870 | g_free(response); | |
871 | ||
91219afc | 872 | hw_info = g_malloc0(sizeof(struct sr_scpi_hw_info)); |
558d438d BV |
873 | hw_info->manufacturer = g_strstrip(g_strdup(tokens[0])); |
874 | hw_info->model = g_strstrip(g_strdup(tokens[1])); | |
875 | hw_info->serial_number = g_strstrip(g_strdup(tokens[2])); | |
876 | hw_info->firmware_version = g_strstrip(g_strdup(tokens[3])); | |
7b9d7320 DJ |
877 | |
878 | g_strfreev(tokens); | |
879 | ||
880 | *scpi_response = hw_info; | |
881 | ||
882 | return SR_OK; | |
883 | } | |
884 | ||
885 | /** | |
886 | * Free a sr_scpi_hw_info struct. | |
887 | * | |
888 | * @param hw_info Pointer to the struct to free. | |
889 | * | |
890 | * This function is safe to call with a NULL pointer. | |
891 | */ | |
892 | SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info) | |
893 | { | |
894 | if (hw_info) { | |
895 | g_free(hw_info->manufacturer); | |
896 | g_free(hw_info->model); | |
897 | g_free(hw_info->serial_number); | |
898 | g_free(hw_info->firmware_version); | |
899 | g_free(hw_info); | |
900 | } | |
901 | } |