]> sigrok.org Git - libsigrok.git/blame - src/scpi/scpi.c
scpi: Add support for arbitray/definite length block data retrieval
[libsigrok.git] / src / scpi / scpi.c
CommitLineData
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 43static 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 69SR_PRIV extern const struct sr_scpi_dev_inst scpi_serial_dev;
104ed125
AJ
70SR_PRIV extern const struct sr_scpi_dev_inst scpi_tcp_raw_dev;
71SR_PRIV extern const struct sr_scpi_dev_inst scpi_tcp_rigol_dev;
20ed3cee 72SR_PRIV extern const struct sr_scpi_dev_inst scpi_usbtmc_libusb_dev;
f754c146 73SR_PRIV extern const struct sr_scpi_dev_inst scpi_vxi_dev;
1fb2312f 74SR_PRIV extern const struct sr_scpi_dev_inst scpi_visa_dev;
7343ad1e 75SR_PRIV extern const struct sr_scpi_dev_inst scpi_libgpib_dev;
f754c146
AJ
76
77static 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
AJ
92#ifdef HAVE_LIBSERIALPORT
93 &scpi_serial_dev, /* must be last as it matches any resource */
94#endif
95};
96
85b69c2b 97static 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
125SR_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
178SR_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);
9092e668 193 scpi->read_timeout_ms = 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 */
215SR_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
233SR_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
250SR_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 264SR_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 */
286SR_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 320SR_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 334SR_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 */
347SR_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 */
359SR_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 */
371SR_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 387SR_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
415SR_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;
3b95bd91 420 gint64 laststart;
9092e668 421 unsigned int elapsed_ms;
ff01b0ea
SB
422 unsigned int offset = 0;
423 int space;
05c644ea 424
7b9d7320 425 if (command)
23f43dff 426 if (sr_scpi_send(scpi, command) != SR_OK)
7b9d7320
DJ
427 return SR_ERR;
428
05c644ea
ML
429 if (sr_scpi_read_begin(scpi) != SR_OK)
430 return SR_ERR;
431
3b95bd91 432 laststart = g_get_monotonic_time();
9092e668 433
ff01b0ea 434 response = *scpi_response;
05c644ea 435
ff01b0ea 436 offset = response->len;
05c644ea
ML
437
438 while (!sr_scpi_read_complete(scpi)) {
ff01b0ea
SB
439 space = response->allocated_len - response->len;
440 if (space < 128) {
441 g_string_set_size(response, response->len + 1024);
442 space = response->allocated_len - response->len;
443 }
444 len = sr_scpi_read_data(scpi, &response->str[offset], space);
05c644ea 445 if (len < 0) {
3b95bd91 446 sr_err("Incompletely read SCPI response.");
05c644ea 447 return SR_ERR;
3b95bd91
MK
448 } else if (len > 0) {
449 laststart = g_get_monotonic_time();
05c644ea 450 }
ff01b0ea
SB
451 offset += len;
452 g_string_set_size(response, offset);
3b95bd91
MK
453 elapsed_ms = (g_get_monotonic_time() - laststart) / 1000;
454 if (elapsed_ms >= scpi->read_timeout_ms) {
9092e668 455 sr_err("Timed out waiting for SCPI response.");
9092e668
ML
456 return SR_ERR;
457 }
05c644ea
ML
458 }
459
05c644ea 460 return SR_OK;
d730f70e
DJ
461}
462
463/**
464 * Send a SCPI command, read the reply, parse it as a bool value and store the
465 * result in scpi_response.
466 *
23f43dff 467 * @param scpi Previously initialised SCPI device structure.
d730f70e
DJ
468 * @param command The SCPI command to send to the device (can be NULL).
469 * @param scpi_response Pointer where to store the parsed result.
470 *
c0d25779 471 * @return SR_OK on success, SR_ERR* on failure.
d730f70e 472 */
23f43dff 473SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
d730f70e
DJ
474 const char *command, gboolean *scpi_response)
475{
476 int ret;
477 char *response;
478
479 response = NULL;
480
c0d25779
BV
481 ret = sr_scpi_get_string(scpi, command, &response);
482 if (ret != SR_OK && !response)
483 return ret;
d730f70e 484
d5976d8b 485 if (parse_strict_bool(response, scpi_response) == SR_OK)
d730f70e
DJ
486 ret = SR_OK;
487 else
c0d25779 488 ret = SR_ERR_DATA;
d730f70e
DJ
489
490 g_free(response);
491
492 return ret;
493}
494
495/**
496 * Send a SCPI command, read the reply, parse it as an integer and store the
497 * result in scpi_response.
498 *
23f43dff 499 * @param scpi Previously initialised SCPI device structure.
d730f70e
DJ
500 * @param command The SCPI command to send to the device (can be NULL).
501 * @param scpi_response Pointer where to store the parsed result.
502 *
c0d25779 503 * @return SR_OK on success, SR_ERR* on failure.
d730f70e 504 */
23f43dff 505SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
d5976d8b 506 const char *command, int *scpi_response)
d730f70e
DJ
507{
508 int ret;
509 char *response;
510
511 response = NULL;
512
c0d25779
BV
513 ret = sr_scpi_get_string(scpi, command, &response);
514 if (ret != SR_OK && !response)
515 return ret;
d730f70e
DJ
516
517 if (sr_atoi(response, scpi_response) == SR_OK)
518 ret = SR_OK;
519 else
c0d25779 520 ret = SR_ERR_DATA;
d730f70e
DJ
521
522 g_free(response);
523
524 return ret;
525}
526
527/**
528 * Send a SCPI command, read the reply, parse it as a float and store the
529 * result in scpi_response.
530 *
23f43dff 531 * @param scpi Previously initialised SCPI device structure.
d730f70e
DJ
532 * @param command The SCPI command to send to the device (can be NULL).
533 * @param scpi_response Pointer where to store the parsed result.
534 *
c0d25779 535 * @return SR_OK on success, SR_ERR* on failure.
d730f70e 536 */
23f43dff 537SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
d730f70e
DJ
538 const char *command, float *scpi_response)
539{
540 int ret;
541 char *response;
542
543 response = NULL;
544
c0d25779
BV
545 ret = sr_scpi_get_string(scpi, command, &response);
546 if (ret != SR_OK && !response)
547 return ret;
d730f70e 548
13dbd151 549 if (sr_atof_ascii(response, scpi_response) == SR_OK)
d730f70e
DJ
550 ret = SR_OK;
551 else
c0d25779 552 ret = SR_ERR_DATA;
d730f70e
DJ
553
554 g_free(response);
555
556 return ret;
557}
558
559/**
560 * Send a SCPI command, read the reply, parse it as a double and store the
561 * result in scpi_response.
562 *
23f43dff 563 * @param scpi Previously initialised SCPI device structure.
d730f70e
DJ
564 * @param command The SCPI command to send to the device (can be NULL).
565 * @param scpi_response Pointer where to store the parsed result.
566 *
c0d25779 567 * @return SR_OK on success, SR_ERR* on failure.
d730f70e 568 */
23f43dff 569SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
d5976d8b 570 const char *command, double *scpi_response)
d730f70e
DJ
571{
572 int ret;
573 char *response;
574
575 response = NULL;
576
c0d25779
BV
577 ret = sr_scpi_get_string(scpi, command, &response);
578 if (ret != SR_OK && !response)
579 return ret;
d730f70e
DJ
580
581 if (sr_atod(response, scpi_response) == SR_OK)
582 ret = SR_OK;
583 else
c0d25779 584 ret = SR_ERR_DATA;
d730f70e
DJ
585
586 g_free(response);
587
7b9d7320
DJ
588 return ret;
589}
590
f5922ade
DJ
591/**
592 * Send a SCPI *OPC? command, read the reply and return the result of the
593 * command.
594 *
23f43dff 595 * @param scpi Previously initialised SCPI device structure.
f5922ade 596 *
c0d25779 597 * @return SR_OK on success, SR_ERR* on failure.
f5922ade 598 */
23f43dff 599SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi)
f5922ade
DJ
600{
601 unsigned int i;
602 gboolean opc;
603
0a1f7b09 604 for (i = 0; i < SCPI_READ_RETRIES; i++) {
23f43dff 605 sr_scpi_get_bool(scpi, SCPI_CMD_OPC, &opc);
f5922ade
DJ
606 if (opc)
607 return SR_OK;
1a46cc62 608 g_usleep(SCPI_READ_RETRY_TIMEOUT_US);
f5922ade
DJ
609 }
610
611 return SR_ERR;
612}
613
8acbb89a
DJ
614/**
615 * Send a SCPI command, read the reply, parse it as comma separated list of
616 * floats and store the as an result in scpi_response.
617 *
23f43dff 618 * @param scpi Previously initialised SCPI device structure.
8acbb89a
DJ
619 * @param command The SCPI command to send to the device (can be NULL).
620 * @param scpi_response Pointer where to store the parsed result.
621 *
c0d25779 622 * @return SR_OK upon successfully parsing all values, SR_ERR* upon a parsing
d5976d8b
UH
623 * error or upon no response. The allocated response must be freed by
624 * the caller in the case of an SR_OK as well as in the case of
625 * parsing error.
8acbb89a 626 */
23f43dff 627SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
d5976d8b 628 const char *command, GArray **scpi_response)
8acbb89a
DJ
629{
630 int ret;
631 float tmp;
632 char *response;
d5976d8b 633 gchar **ptr, **tokens;
8acbb89a
DJ
634 GArray *response_array;
635
8acbb89a
DJ
636 response = NULL;
637 tokens = NULL;
638
c0d25779
BV
639 ret = sr_scpi_get_string(scpi, command, &response);
640 if (ret != SR_OK && !response)
641 return ret;
8acbb89a
DJ
642
643 tokens = g_strsplit(response, ",", 0);
644 ptr = tokens;
645
646 response_array = g_array_sized_new(TRUE, FALSE, sizeof(float), 256);
647
d5976d8b 648 while (*ptr) {
13dbd151 649 if (sr_atof_ascii(*ptr, &tmp) == SR_OK)
8acbb89a
DJ
650 response_array = g_array_append_val(response_array,
651 tmp);
652 else
c0d25779 653 ret = SR_ERR_DATA;
8acbb89a
DJ
654
655 ptr++;
656 }
657 g_strfreev(tokens);
658 g_free(response);
659
c0d25779 660 if (ret != SR_OK && response_array->len == 0) {
8acbb89a
DJ
661 g_array_free(response_array, TRUE);
662 *scpi_response = NULL;
c0d25779 663 return SR_ERR_DATA;
8acbb89a
DJ
664 }
665
666 *scpi_response = response_array;
667
1a323dd8
DJ
668 return ret;
669}
670
671/**
672 * Send a SCPI command, read the reply, parse it as comma separated list of
673 * unsigned 8 bit integers and store the as an result in scpi_response.
674 *
23f43dff 675 * @param scpi Previously initialised SCPI device structure.
1a323dd8
DJ
676 * @param command The SCPI command to send to the device (can be NULL).
677 * @param scpi_response Pointer where to store the parsed result.
678 *
c0d25779 679 * @return SR_OK upon successfully parsing all values, SR_ERR* upon a parsing
d5976d8b
UH
680 * error or upon no response. The allocated response must be freed by
681 * the caller in the case of an SR_OK as well as in the case of
682 * parsing error.
1a323dd8 683 */
23f43dff 684SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
d5976d8b 685 const char *command, GArray **scpi_response)
1a323dd8 686{
d5976d8b 687 int tmp, ret;
1a323dd8 688 char *response;
d5976d8b 689 gchar **ptr, **tokens;
1a323dd8
DJ
690 GArray *response_array;
691
1a323dd8
DJ
692 response = NULL;
693 tokens = NULL;
694
c0d25779
BV
695 ret = sr_scpi_get_string(scpi, command, &response);
696 if (ret != SR_OK && !response)
697 return ret;
1a323dd8
DJ
698
699 tokens = g_strsplit(response, ",", 0);
700 ptr = tokens;
701
702 response_array = g_array_sized_new(TRUE, FALSE, sizeof(uint8_t), 256);
703
d5976d8b 704 while (*ptr) {
1a323dd8
DJ
705 if (sr_atoi(*ptr, &tmp) == SR_OK)
706 response_array = g_array_append_val(response_array,
707 tmp);
708 else
c0d25779 709 ret = SR_ERR_DATA;
1a323dd8
DJ
710
711 ptr++;
712 }
713 g_strfreev(tokens);
714 g_free(response);
715
716 if (response_array->len == 0) {
717 g_array_free(response_array, TRUE);
718 *scpi_response = NULL;
c0d25779 719 return SR_ERR_DATA;
1a323dd8
DJ
720 }
721
722 *scpi_response = response_array;
723
8acbb89a
DJ
724 return ret;
725}
ff01b0ea
SB
726/**
727 * Send a SCPI command, read the reply, parse it as binary data with a
728 * "definite length block" header and store the as an result in scpi_response.
729 *
730 * @param scpi Previously initialised SCPI device structure.
731 * @param command The SCPI command to send to the device (can be NULL).
732 * @param scpi_response Pointer where to store the parsed result.
733 *
734 * @return SR_OK upon successfully parsing all values, SR_ERR* upon a parsing
735 * error or upon no response. The allocated response must be freed by
736 * the caller in the case of an SR_OK as well as in the case of
737 * parsing error.
738 */
739SR_PRIV int sr_scpi_get_block(struct sr_scpi_dev_inst *scpi,
740 const char *command, GByteArray **scpi_response)
741{
742 int ret;
743 GString* response;
744
745 char buf[10] = { 0 };
746 long llen;
747 long datalen;
748
749 response = g_string_sized_new(1024);
750 *scpi_response = NULL;
751
752 ret = sr_scpi_get_data(scpi, command, &response);
753 if (ret != SR_OK) {
754 g_string_free(response, TRUE);
755 return ret;
756 }
757
758 if (response->str[0] != '#') {
759 g_string_free(response, TRUE);
760 return SR_ERR_DATA;
761 }
762
763 buf[0] = response->str[1];
764 ret = sr_atol(buf, &llen);
765 if ((ret != SR_OK) || (llen == 0)) {
766 g_string_free(response, TRUE);
767 return ret;
768 }
769
770 memcpy(buf, &response->str[2], llen);
771 ret = sr_atol(buf, &datalen);
772 if ((ret != SR_OK) || (datalen == 0)) {
773 g_string_free(response, TRUE);
774 return ret;
775 }
776
777 // strip header
778 g_string_erase(response, 0, 2 + llen);
779
780 if (response->len < (unsigned long)(datalen)) {
781 int oldlen = response->len;
782 g_string_set_size(response, datalen);
783 g_string_set_size(response, oldlen);
784 }
785
786 while (response->len < (unsigned long)(datalen)) {
787 if (sr_scpi_get_data(scpi, NULL, &response) != SR_OK) {
788 g_string_free(response, TRUE);
789 return ret;
790 }
791 }
792
793 *scpi_response = g_byte_array_new_take(
794 (guint8*)g_string_free(response, FALSE), datalen);
795
796 return ret;
797}
798
8acbb89a 799
7b9d7320
DJ
800/**
801 * Send the *IDN? SCPI command, receive the reply, parse it and store the
802 * reply as a sr_scpi_hw_info structure in the supplied scpi_response pointer.
803 *
d5976d8b
UH
804 * The hw_info structure must be freed by the caller via sr_scpi_hw_info_free().
805 *
23f43dff 806 * @param scpi Previously initialised SCPI device structure.
7b9d7320
DJ
807 * @param scpi_response Pointer where to store the hw_info structure.
808 *
c0d25779 809 * @return SR_OK upon success, SR_ERR* on failure.
7b9d7320 810 */
23f43dff 811SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
7b9d7320
DJ
812 struct sr_scpi_hw_info **scpi_response)
813{
c0d25779 814 int num_tokens, ret;
7b9d7320
DJ
815 char *response;
816 gchar **tokens;
7b9d7320
DJ
817 struct sr_scpi_hw_info *hw_info;
818
819 response = NULL;
820 tokens = NULL;
821
c0d25779
BV
822 ret = sr_scpi_get_string(scpi, SCPI_CMD_IDN, &response);
823 if (ret != SR_OK && !response)
824 return ret;
7b9d7320 825
77c16c04
ML
826 sr_info("Got IDN string: '%s'", response);
827
7b9d7320
DJ
828 /*
829 * The response to a '*IDN?' is specified by the SCPI spec. It contains
830 * a comma-separated list containing the manufacturer name, instrument
831 * model, serial number of the instrument and the firmware version.
832 */
833 tokens = g_strsplit(response, ",", 0);
834
835 for (num_tokens = 0; tokens[num_tokens] != NULL; num_tokens++);
836
0c08023f 837 if (num_tokens < 4) {
d5976d8b 838 sr_dbg("IDN response not according to spec: %80.s.", response);
7b9d7320
DJ
839 g_strfreev(tokens);
840 g_free(response);
c0d25779 841 return SR_ERR_DATA;
7b9d7320
DJ
842 }
843 g_free(response);
844
91219afc 845 hw_info = g_malloc0(sizeof(struct sr_scpi_hw_info));
558d438d
BV
846 hw_info->manufacturer = g_strstrip(g_strdup(tokens[0]));
847 hw_info->model = g_strstrip(g_strdup(tokens[1]));
848 hw_info->serial_number = g_strstrip(g_strdup(tokens[2]));
849 hw_info->firmware_version = g_strstrip(g_strdup(tokens[3]));
7b9d7320
DJ
850
851 g_strfreev(tokens);
852
853 *scpi_response = hw_info;
854
855 return SR_OK;
856}
857
858/**
859 * Free a sr_scpi_hw_info struct.
860 *
861 * @param hw_info Pointer to the struct to free.
862 *
863 * This function is safe to call with a NULL pointer.
864 */
865SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info)
866{
867 if (hw_info) {
868 g_free(hw_info->manufacturer);
869 g_free(hw_info->model);
870 g_free(hw_info->serial_number);
871 g_free(hw_info->firmware_version);
872 g_free(hw_info);
873 }
874}