scpi: document callers' responsibility to free getters' allocated memory
[libsigrok.git] / src / scpi / scpi.c
1 /*
2  * This file is part of the libsigrok project.
3  *
4  * Copyright (C) 2013 poljar (Damir Jelić) <poljarinho@gmail.com>
5  * Copyright (C) 2015 Bert Vermeulen <bert@biot.com>
6  *
7  * This program is free software: you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation, either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
19  */
20
21 #include <config.h>
22 #include <glib.h>
23 #include <string.h>
24 #include <libsigrok/libsigrok.h>
25 #include "libsigrok-internal.h"
26 #include "scpi.h"
27
28 #define LOG_PREFIX "scpi"
29
30 #define SCPI_READ_RETRIES 100
31 #define SCPI_READ_RETRY_TIMEOUT_US (10 * 1000)
32
33 static const char *scpi_vendors[][2] = {
34         { "Agilent Technologies", "Agilent" },
35         { "CHROMA", "Chroma" },
36         { "Chroma ATE", "Chroma" },
37         { "HEWLETT-PACKARD", "HP" },
38         { "Keysight Technologies", "Keysight" },
39         { "PHILIPS", "Philips" },
40         { "RIGOL TECHNOLOGIES", "Rigol" },
41 };
42
43 /**
44  * Parse a string representation of a boolean-like value into a gboolean.
45  * Similar to sr_parse_boolstring but rejects strings which do not represent
46  * a boolean-like value.
47  *
48  * @param str String to convert.
49  * @param ret Pointer to a gboolean where the result of the conversion will be
50  * stored.
51  *
52  * @return SR_OK on success, SR_ERR on failure.
53  */
54 static int parse_strict_bool(const char *str, gboolean *ret)
55 {
56         if (!str)
57                 return SR_ERR_ARG;
58
59         if (!g_strcmp0(str, "1") ||
60             !g_ascii_strncasecmp(str, "y", 1) ||
61             !g_ascii_strncasecmp(str, "t", 1) ||
62             !g_ascii_strncasecmp(str, "yes", 3) ||
63             !g_ascii_strncasecmp(str, "true", 4) ||
64             !g_ascii_strncasecmp(str, "on", 2)) {
65                 *ret = TRUE;
66                 return SR_OK;
67         } else if (!g_strcmp0(str, "0") ||
68                    !g_ascii_strncasecmp(str, "n", 1) ||
69                    !g_ascii_strncasecmp(str, "f", 1) ||
70                    !g_ascii_strncasecmp(str, "no", 2) ||
71                    !g_ascii_strncasecmp(str, "false", 5) ||
72                    !g_ascii_strncasecmp(str, "off", 3)) {
73                 *ret = FALSE;
74                 return SR_OK;
75         }
76
77         return SR_ERR;
78 }
79
80 SR_PRIV extern const struct sr_scpi_dev_inst scpi_serial_dev;
81 SR_PRIV extern const struct sr_scpi_dev_inst scpi_tcp_raw_dev;
82 SR_PRIV extern const struct sr_scpi_dev_inst scpi_tcp_rigol_dev;
83 SR_PRIV extern const struct sr_scpi_dev_inst scpi_usbtmc_libusb_dev;
84 SR_PRIV extern const struct sr_scpi_dev_inst scpi_vxi_dev;
85 SR_PRIV extern const struct sr_scpi_dev_inst scpi_visa_dev;
86 SR_PRIV extern const struct sr_scpi_dev_inst scpi_libgpib_dev;
87
88 static const struct sr_scpi_dev_inst *scpi_devs[] = {
89         &scpi_tcp_raw_dev,
90         &scpi_tcp_rigol_dev,
91 #ifdef HAVE_LIBUSB_1_0
92         &scpi_usbtmc_libusb_dev,
93 #endif
94 #if HAVE_RPC
95         &scpi_vxi_dev,
96 #endif
97 #ifdef HAVE_LIBREVISA
98         &scpi_visa_dev,
99 #endif
100 #ifdef HAVE_LIBGPIB
101         &scpi_libgpib_dev,
102 #endif
103 #ifdef HAVE_SERIAL_COMM
104         &scpi_serial_dev, /* Must be last as it matches any resource. */
105 #endif
106 };
107
108 static struct sr_dev_inst *sr_scpi_scan_resource(struct drv_context *drvc,
109                 const char *resource, const char *serialcomm,
110                 struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi))
111 {
112         struct sr_scpi_dev_inst *scpi;
113         struct sr_dev_inst *sdi;
114
115         if (!(scpi = scpi_dev_inst_new(drvc, resource, serialcomm)))
116                 return NULL;
117
118         if (sr_scpi_open(scpi) != SR_OK) {
119                 sr_info("Couldn't open SCPI device.");
120                 sr_scpi_free(scpi);
121                 return NULL;
122         };
123
124         sdi = probe_device(scpi);
125
126         sr_scpi_close(scpi);
127
128         if (sdi)
129                 sdi->status = SR_ST_INACTIVE;
130         else
131                 sr_scpi_free(scpi);
132
133         return sdi;
134 }
135
136 /**
137  * Send a SCPI command with a variadic argument list without mutex.
138  *
139  * @param scpi Previously initialized SCPI device structure.
140  * @param format Format string.
141  * @param args Argument list.
142  *
143  * @return SR_OK on success, SR_ERR on failure.
144  */
145 static int scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
146                          const char *format, va_list args)
147 {
148         va_list args_copy;
149         char *buf;
150         int len, ret;
151
152         /* Get length of buffer required. */
153         va_copy(args_copy, args);
154         len = sr_vsnprintf_ascii(NULL, 0, format, args_copy);
155         va_end(args_copy);
156
157         /* Allocate buffer and write out command. */
158         buf = g_malloc0(len + 2);
159         sr_vsprintf_ascii(buf, format, args);
160         if (buf[len - 1] != '\n')
161                 buf[len] = '\n';
162
163         /* Send command. */
164         ret = scpi->send(scpi->priv, buf);
165
166         /* Free command buffer. */
167         g_free(buf);
168
169         return ret;
170 }
171
172 /**
173  * Send a SCPI command without mutex.
174  *
175  * @param scpi Previously initialized SCPI device structure.
176  * @param format Format string, to be followed by any necessary arguments.
177  *
178  * @return SR_OK on success, SR_ERR on failure.
179  */
180 static int scpi_send(struct sr_scpi_dev_inst *scpi, const char *format, ...)
181 {
182         va_list args;
183         int ret;
184
185         va_start(args, format);
186         ret = scpi_send_variadic(scpi, format, args);
187         va_end(args);
188
189         return ret;
190 }
191
192 /**
193  * Send data to SCPI device without mutex.
194  *
195  * TODO: This is only implemented in TcpRaw, but never used.
196  * TODO: Use Mutex at all?
197  *
198  * @param scpi Previously initialised SCPI device structure.
199  * @param buf Buffer with data to send.
200  * @param len Number of bytes to send.
201  *
202  * @return Number of bytes read, or SR_ERR upon failure.
203  */
204 static int scpi_write_data(struct sr_scpi_dev_inst *scpi, char *buf, int maxlen)
205 {
206         return scpi->write_data(scpi->priv, buf, maxlen);
207 }
208
209 /**
210  * Read part of a response from SCPI device without mutex.
211  *
212  * @param scpi Previously initialised SCPI device structure.
213  * @param buf Buffer to store result.
214  * @param maxlen Maximum number of bytes to read.
215  *
216  * @return Number of bytes read, or SR_ERR upon failure.
217  */
218 static int scpi_read_data(struct sr_scpi_dev_inst *scpi, char *buf, int maxlen)
219 {
220         return scpi->read_data(scpi->priv, buf, maxlen);
221 }
222
223 /**
224  * Do a non-blocking read of up to the allocated length, and
225  * check if a timeout has occured, without mutex.
226  *
227  * @param scpi Previously initialised SCPI device structure.
228  * @param response Buffer to which the response is appended.
229  * @param abs_timeout_us Absolute timeout in microseconds
230  *
231  * @return read length on success, SR_ERR* on failure.
232  */
233 static int scpi_read_response(struct sr_scpi_dev_inst *scpi,
234                                 GString *response, gint64 abs_timeout_us)
235 {
236         int len, space;
237
238         space = response->allocated_len - response->len;
239         len = scpi->read_data(scpi->priv, &response->str[response->len], space);
240
241         if (len < 0) {
242                 sr_err("Incompletely read SCPI response.");
243                 return SR_ERR;
244         }
245
246         if (len > 0) {
247                 g_string_set_size(response, response->len + len);
248                 return len;
249         }
250
251         if (g_get_monotonic_time() > abs_timeout_us) {
252                 sr_err("Timed out waiting for SCPI response.");
253                 return SR_ERR_TIMEOUT;
254         }
255
256         return 0;
257 }
258
259 /**
260  * Send a SCPI command, receive the reply and store the reply in
261  * scpi_response, without mutex.
262  *
263  * @param scpi Previously initialised SCPI device structure.
264  * @param command The SCPI command to send to the device.
265  * @param scpi_response Pointer where to store the SCPI response.
266  *
267  * @return SR_OK on success, SR_ERR on failure.
268  */
269 static int scpi_get_data(struct sr_scpi_dev_inst *scpi,
270                                 const char *command, GString **scpi_response)
271 {
272         int ret;
273         GString *response;
274         int space;
275         gint64 timeout;
276
277         /* Optionally send caller provided command. */
278         if (command) {
279                 if (scpi_send(scpi, command) != SR_OK)
280                         return SR_ERR;
281         }
282
283         /* Initiate SCPI read operation. */
284         if (sr_scpi_read_begin(scpi) != SR_OK)
285                 return SR_ERR;
286
287         /* Keep reading until completion or until timeout. */
288         timeout = g_get_monotonic_time() + scpi->read_timeout_us;
289
290         response = *scpi_response;
291
292         while (!sr_scpi_read_complete(scpi)) {
293                 /* Resize the buffer when free space drops below a threshold. */
294                 space = response->allocated_len - response->len;
295                 if (space < 128) {
296                         int oldlen = response->len;
297                         g_string_set_size(response, oldlen + 1024);
298                         g_string_set_size(response, oldlen);
299                 }
300
301                 /* Read another chunk of the response. */
302                 ret = scpi_read_response(scpi, response, timeout);
303
304                 if (ret < 0)
305                         return ret;
306                 if (ret > 0)
307                         timeout = g_get_monotonic_time() + scpi->read_timeout_us;
308         }
309
310         return SR_OK;
311 }
312
313 SR_PRIV GSList *sr_scpi_scan(struct drv_context *drvc, GSList *options,
314                 struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi))
315 {
316         GSList *resources, *l, *devices;
317         struct sr_dev_inst *sdi;
318         const char *resource = NULL;
319         const char *serialcomm = NULL;
320         gchar **res;
321         unsigned i;
322
323         for (l = options; l; l = l->next) {
324                 struct sr_config *src = l->data;
325                 switch (src->key) {
326                 case SR_CONF_CONN:
327                         resource = g_variant_get_string(src->data, NULL);
328                         break;
329                 case SR_CONF_SERIALCOMM:
330                         serialcomm = g_variant_get_string(src->data, NULL);
331                         break;
332                 }
333         }
334
335         devices = NULL;
336         for (i = 0; i < ARRAY_SIZE(scpi_devs); i++) {
337                 if ((resource && strcmp(resource, scpi_devs[i]->prefix))
338                     || !scpi_devs[i]->scan)
339                         continue;
340                 resources = scpi_devs[i]->scan(drvc);
341                 for (l = resources; l; l = l->next) {
342                         res = g_strsplit(l->data, ":", 2);
343                         if (res[0] && (sdi = sr_scpi_scan_resource(drvc, res[0],
344                                        serialcomm ? serialcomm : res[1], probe_device))) {
345                                 devices = g_slist_append(devices, sdi);
346                                 sdi->connection_id = g_strdup(l->data);
347                         }
348                         g_strfreev(res);
349                 }
350                 g_slist_free_full(resources, g_free);
351         }
352
353         if (!devices && resource) {
354                 sdi = sr_scpi_scan_resource(drvc, resource, serialcomm, probe_device);
355                 if (sdi)
356                         devices = g_slist_append(NULL, sdi);
357         }
358
359         /* Tack a copy of the newly found devices onto the driver list. */
360         if (devices)
361                 drvc->instances = g_slist_concat(drvc->instances, g_slist_copy(devices));
362
363         return devices;
364 }
365
366 SR_PRIV struct sr_scpi_dev_inst *scpi_dev_inst_new(struct drv_context *drvc,
367                 const char *resource, const char *serialcomm)
368 {
369         struct sr_scpi_dev_inst *scpi = NULL;
370         const struct sr_scpi_dev_inst *scpi_dev;
371         gchar **params;
372         unsigned i;
373
374         for (i = 0; i < ARRAY_SIZE(scpi_devs); i++) {
375                 scpi_dev = scpi_devs[i];
376                 if (!strncmp(resource, scpi_dev->prefix, strlen(scpi_dev->prefix))) {
377                         sr_dbg("Opening %s device %s.", scpi_dev->name, resource);
378                         scpi = g_malloc(sizeof(*scpi));
379                         *scpi = *scpi_dev;
380                         scpi->priv = g_malloc0(scpi->priv_size);
381                         scpi->read_timeout_us = 1000 * 1000;
382                         params = g_strsplit(resource, "/", 0);
383                         if (scpi->dev_inst_new(scpi->priv, drvc, resource,
384                                                params, serialcomm) != SR_OK) {
385                                 sr_scpi_free(scpi);
386                                 scpi = NULL;
387                         }
388                         g_strfreev(params);
389                         break;
390                 }
391         }
392
393         return scpi;
394 }
395
396 /**
397  * Open SCPI device.
398  *
399  * @param scpi Previously initialized SCPI device structure.
400  *
401  * @return SR_OK on success, SR_ERR on failure.
402  */
403 SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi)
404 {
405         g_mutex_init(&scpi->scpi_mutex);
406
407         return scpi->open(scpi);
408 }
409
410 /**
411  * Get the connection ID of the SCPI device.
412  *
413  * Callers must free the allocated memory regardless of the routine's
414  * return code. See @ref g_free().
415  *
416  * @param[in] scpi Previously initialized SCPI device structure.
417  * @param[out] connection_id Pointer where to store the connection ID.
418  *
419  * @return SR_OK on success, SR_ERR on failure.
420  */
421 SR_PRIV int sr_scpi_connection_id(struct sr_scpi_dev_inst *scpi,
422                 char **connection_id)
423 {
424         return scpi->connection_id(scpi, connection_id);
425 }
426
427 /**
428  * Add an event source for an SCPI device.
429  *
430  * @param session The session to add the event source to.
431  * @param scpi Previously initialized SCPI device structure.
432  * @param events Events to check for.
433  * @param timeout Max time to wait before the callback is called, ignored if 0.
434  * @param cb Callback function to add. Must not be NULL.
435  * @param cb_data Data for the callback function. Can be NULL.
436  *
437  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
438  *         SR_ERR_MALLOC upon memory allocation errors.
439  */
440 SR_PRIV int sr_scpi_source_add(struct sr_session *session,
441                 struct sr_scpi_dev_inst *scpi, int events, int timeout,
442                 sr_receive_data_callback cb, void *cb_data)
443 {
444         return scpi->source_add(session, scpi->priv, events, timeout, cb, cb_data);
445 }
446
447 /**
448  * Remove event source for an SCPI device.
449  *
450  * @param session The session to remove the event source from.
451  * @param scpi Previously initialized SCPI device structure.
452  *
453  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
454  *         SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
455  *         internal errors.
456  */
457 SR_PRIV int sr_scpi_source_remove(struct sr_session *session,
458                 struct sr_scpi_dev_inst *scpi)
459 {
460         return scpi->source_remove(session, scpi->priv);
461 }
462
463 /**
464  * Send a SCPI command.
465  *
466  * @param scpi Previously initialized SCPI device structure.
467  * @param format Format string, to be followed by any necessary arguments.
468  *
469  * @return SR_OK on success, SR_ERR on failure.
470  */
471 SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi,
472                          const char *format, ...)
473 {
474         va_list args;
475         int ret;
476
477         va_start(args, format);
478         g_mutex_lock(&scpi->scpi_mutex);
479         ret = scpi_send_variadic(scpi, format, args);
480         g_mutex_unlock(&scpi->scpi_mutex);
481         va_end(args);
482
483         return ret;
484 }
485
486 /**
487  * Send a SCPI command with a variadic argument list.
488  *
489  * @param scpi Previously initialized SCPI device structure.
490  * @param format Format string.
491  * @param args Argument list.
492  *
493  * @return SR_OK on success, SR_ERR on failure.
494  */
495 SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
496                          const char *format, va_list args)
497 {
498         int ret;
499
500         g_mutex_lock(&scpi->scpi_mutex);
501         ret = scpi_send_variadic(scpi, format, args);
502         g_mutex_unlock(&scpi->scpi_mutex);
503
504         return ret;
505 }
506
507 /**
508  * Begin receiving an SCPI reply.
509  *
510  * @param scpi Previously initialised SCPI device structure.
511  *
512  * @return SR_OK on success, SR_ERR on failure.
513  */
514 SR_PRIV int sr_scpi_read_begin(struct sr_scpi_dev_inst *scpi)
515 {
516         return scpi->read_begin(scpi->priv);
517 }
518
519 /**
520  * Read part of a response from SCPI device.
521  *
522  * @param scpi Previously initialised SCPI device structure.
523  * @param buf Buffer to store result.
524  * @param maxlen Maximum number of bytes to read.
525  *
526  * @return Number of bytes read, or SR_ERR upon failure.
527  */
528 SR_PRIV int sr_scpi_read_data(struct sr_scpi_dev_inst *scpi,
529                         char *buf, int maxlen)
530 {
531         int ret;
532
533         g_mutex_lock(&scpi->scpi_mutex);
534         ret = scpi_read_data(scpi, buf, maxlen);
535         g_mutex_unlock(&scpi->scpi_mutex);
536
537         return ret;
538 }
539
540 /**
541  * Send data to SCPI device.
542  *
543  * TODO: This is only implemented in TcpRaw, but never used.
544  * TODO: Use Mutex at all?
545  *
546  * @param scpi Previously initialised SCPI device structure.
547  * @param buf Buffer with data to send.
548  * @param len Number of bytes to send.
549  *
550  * @return Number of bytes read, or SR_ERR upon failure.
551  */
552 SR_PRIV int sr_scpi_write_data(struct sr_scpi_dev_inst *scpi,
553                         char *buf, int maxlen)
554 {
555         int ret;
556
557         g_mutex_lock(&scpi->scpi_mutex);
558         ret = scpi_write_data(scpi, buf, maxlen);
559         g_mutex_unlock(&scpi->scpi_mutex);
560
561         return ret;
562 }
563
564 /**
565  * Check whether a complete SCPI response has been received.
566  *
567  * @param scpi Previously initialised SCPI device structure.
568  *
569  * @return 1 if complete, 0 otherwise.
570  */
571 SR_PRIV int sr_scpi_read_complete(struct sr_scpi_dev_inst *scpi)
572 {
573         return scpi->read_complete(scpi->priv);
574 }
575
576 /**
577  * Close SCPI device.
578  *
579  * @param scpi Previously initialized SCPI device structure.
580  *
581  * @return SR_OK on success, SR_ERR on failure.
582  */
583 SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi)
584 {
585         int ret;
586
587         g_mutex_lock(&scpi->scpi_mutex);
588         ret = scpi->close(scpi);
589         g_mutex_unlock(&scpi->scpi_mutex);
590         g_mutex_clear(&scpi->scpi_mutex);
591
592         return ret;
593 }
594
595 /**
596  * Free SCPI device.
597  *
598  * @param scpi Previously initialized SCPI device structure. If NULL,
599  *             this function does nothing.
600  */
601 SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi)
602 {
603         if (!scpi)
604                 return;
605
606         scpi->free(scpi->priv);
607         g_free(scpi->priv);
608         g_free(scpi->actual_channel_name);
609         g_free(scpi);
610 }
611
612 /**
613  * Send a SCPI command, receive the reply and store the reply in scpi_response.
614  *
615  * Callers must free the allocated memory regardless of the routine's
616  * return code. See @ref g_free().
617  *
618  * @param[in] scpi Previously initialised SCPI device structure.
619  * @param[in] command The SCPI command to send to the device (can be NULL).
620  * @param[out] scpi_response Pointer where to store the SCPI response.
621  *
622  * @return SR_OK on success, SR_ERR* on failure.
623  */
624 SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
625                                const char *command, char **scpi_response)
626 {
627         GString *response;
628
629         *scpi_response = NULL;
630
631         response = g_string_sized_new(1024);
632         if (sr_scpi_get_data(scpi, command, &response) != SR_OK) {
633                 if (response)
634                         g_string_free(response, TRUE);
635                 return SR_ERR;
636         }
637
638         /* Get rid of trailing linefeed if present */
639         if (response->len >= 1 && response->str[response->len - 1] == '\n')
640                 g_string_truncate(response, response->len - 1);
641
642         /* Get rid of trailing carriage return if present */
643         if (response->len >= 1 && response->str[response->len - 1] == '\r')
644                 g_string_truncate(response, response->len - 1);
645
646         sr_spew("Got response: '%.70s', length %" G_GSIZE_FORMAT ".",
647                 response->str, response->len);
648
649         *scpi_response = g_string_free(response, FALSE);
650
651         return SR_OK;
652 }
653
654 /**
655  * Do a non-blocking read of up to the allocated length, and
656  * check if a timeout has occured.
657  *
658  * @param scpi Previously initialised SCPI device structure.
659  * @param response Buffer to which the response is appended.
660  * @param abs_timeout_us Absolute timeout in microseconds
661  *
662  * @return read length on success, SR_ERR* on failure.
663  */
664 SR_PRIV int sr_scpi_read_response(struct sr_scpi_dev_inst *scpi,
665                                   GString *response, gint64 abs_timeout_us)
666 {
667         int ret;
668
669         g_mutex_lock(&scpi->scpi_mutex);
670         ret = scpi_read_response(scpi, response, abs_timeout_us);
671         g_mutex_unlock(&scpi->scpi_mutex);
672
673         return ret;
674 }
675
676 SR_PRIV int sr_scpi_get_data(struct sr_scpi_dev_inst *scpi,
677                              const char *command, GString **scpi_response)
678 {
679         int ret;
680
681         g_mutex_lock(&scpi->scpi_mutex);
682         ret = scpi_get_data(scpi, command, scpi_response);
683         g_mutex_unlock(&scpi->scpi_mutex);
684
685         return ret;
686 }
687
688 /**
689  * Send a SCPI command, read the reply, parse it as a bool value and store the
690  * result in scpi_response.
691  *
692  * @param scpi Previously initialised SCPI device structure.
693  * @param command The SCPI command to send to the device (can be NULL).
694  * @param scpi_response Pointer where to store the parsed result.
695  *
696  * @return SR_OK on success, SR_ERR* on failure.
697  */
698 SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
699                              const char *command, gboolean *scpi_response)
700 {
701         int ret;
702         char *response;
703
704         response = NULL;
705
706         ret = sr_scpi_get_string(scpi, command, &response);
707         if (ret != SR_OK && !response)
708                 return ret;
709
710         if (parse_strict_bool(response, scpi_response) == SR_OK)
711                 ret = SR_OK;
712         else
713                 ret = SR_ERR_DATA;
714
715         g_free(response);
716
717         return ret;
718 }
719
720 /**
721  * Send a SCPI command, read the reply, parse it as an integer and store the
722  * result in scpi_response.
723  *
724  * @param scpi Previously initialised SCPI device structure.
725  * @param command The SCPI command to send to the device (can be NULL).
726  * @param scpi_response Pointer where to store the parsed result.
727  *
728  * @return SR_OK on success, SR_ERR* on failure.
729  */
730 SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
731                             const char *command, int *scpi_response)
732 {
733         int ret;
734         struct sr_rational ret_rational;
735         char *response;
736
737         response = NULL;
738
739         ret = sr_scpi_get_string(scpi, command, &response);
740         if (ret != SR_OK && !response)
741                 return ret;
742
743         ret = sr_parse_rational(response, &ret_rational);
744         if (ret == SR_OK && (ret_rational.p % ret_rational.q) == 0) {
745                 *scpi_response = ret_rational.p / ret_rational.q;
746         } else {
747                 sr_dbg("get_int: non-integer rational=%" PRId64 "/%" PRIu64,
748                         ret_rational.p, ret_rational.q);
749                 ret = SR_ERR_DATA;
750         }
751
752         g_free(response);
753
754         return ret;
755 }
756
757 /**
758  * Send a SCPI command, read the reply, parse it as a float and store the
759  * result in scpi_response.
760  *
761  * @param scpi Previously initialised SCPI device structure.
762  * @param command The SCPI command to send to the device (can be NULL).
763  * @param scpi_response Pointer where to store the parsed result.
764  *
765  * @return SR_OK on success, SR_ERR* on failure.
766  */
767 SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
768                               const char *command, float *scpi_response)
769 {
770         int ret;
771         char *response;
772
773         response = NULL;
774
775         ret = sr_scpi_get_string(scpi, command, &response);
776         if (ret != SR_OK && !response)
777                 return ret;
778
779         if (sr_atof_ascii(response, scpi_response) == SR_OK)
780                 ret = SR_OK;
781         else
782                 ret = SR_ERR_DATA;
783
784         g_free(response);
785
786         return ret;
787 }
788
789 /**
790  * Send a SCPI command, read the reply, parse it as a double and store the
791  * result in scpi_response.
792  *
793  * @param scpi Previously initialised SCPI device structure.
794  * @param command The SCPI command to send to the device (can be NULL).
795  * @param scpi_response Pointer where to store the parsed result.
796  *
797  * @return SR_OK on success, SR_ERR* on failure.
798  */
799 SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
800                                const char *command, double *scpi_response)
801 {
802         int ret;
803         char *response;
804
805         response = NULL;
806
807         ret = sr_scpi_get_string(scpi, command, &response);
808         if (ret != SR_OK && !response)
809                 return ret;
810
811         if (sr_atod_ascii(response, scpi_response) == SR_OK)
812                 ret = SR_OK;
813         else
814                 ret = SR_ERR_DATA;
815
816         g_free(response);
817
818         return ret;
819 }
820
821 /**
822  * Send a SCPI *OPC? command, read the reply and return the result of the
823  * command.
824  *
825  * @param scpi Previously initialised SCPI device structure.
826  *
827  * @return SR_OK on success, SR_ERR* on failure.
828  */
829 SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi)
830 {
831         unsigned int i;
832         gboolean opc;
833
834         for (i = 0; i < SCPI_READ_RETRIES; i++) {
835                 opc = FALSE;
836                 sr_scpi_get_bool(scpi, SCPI_CMD_OPC, &opc);
837                 if (opc)
838                         return SR_OK;
839                 g_usleep(SCPI_READ_RETRY_TIMEOUT_US);
840         }
841
842         return SR_ERR;
843 }
844
845 /**
846  * Send a SCPI command, read the reply, parse it as comma separated list of
847  * floats and store the as an result in scpi_response.
848  *
849  * Callers must free the allocated memory (unless it's NULL) regardless of
850  * the routine's return code. See @ref g_array_free().
851  *
852  * @param[in] scpi Previously initialised SCPI device structure.
853  * @param[in] command The SCPI command to send to the device (can be NULL).
854  * @param[out] scpi_response Pointer where to store the parsed result.
855  *
856  * @return SR_OK upon successfully parsing all values, SR_ERR* upon a parsing
857  *         error or upon no response.
858  */
859 SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
860                                const char *command, GArray **scpi_response)
861 {
862         int ret;
863         float tmp;
864         char *response;
865         gchar **ptr, **tokens;
866         GArray *response_array;
867
868         *scpi_response = NULL;
869         response = NULL;
870         tokens = NULL;
871
872         ret = sr_scpi_get_string(scpi, command, &response);
873         if (ret != SR_OK && !response)
874                 return ret;
875
876         tokens = g_strsplit(response, ",", 0);
877         ptr = tokens;
878
879         response_array = g_array_sized_new(TRUE, FALSE, sizeof(float), 256);
880
881         while (*ptr) {
882                 if (sr_atof_ascii(*ptr, &tmp) == SR_OK)
883                         response_array = g_array_append_val(response_array,
884                                                             tmp);
885                 else
886                         ret = SR_ERR_DATA;
887
888                 ptr++;
889         }
890         g_strfreev(tokens);
891         g_free(response);
892
893         if (ret != SR_OK && response_array->len == 0) {
894                 g_array_free(response_array, TRUE);
895                 return SR_ERR_DATA;
896         }
897
898         *scpi_response = response_array;
899
900         return ret;
901 }
902
903 /**
904  * Send a SCPI command, read the reply, parse it as comma separated list of
905  * unsigned 8 bit integers and store the as an result in scpi_response.
906  *
907  * Callers must free the allocated memory (unless it's NULL) regardless of
908  * the routine's return code. See @ref g_array_free().
909  *
910  * @param[in] scpi Previously initialised SCPI device structure.
911  * @param[in] command The SCPI command to send to the device (can be NULL).
912  * @param[out] scpi_response Pointer where to store the parsed result.
913  *
914  * @return SR_OK upon successfully parsing all values, SR_ERR* upon a parsing
915  *         error or upon no response.
916  */
917 SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
918                                const char *command, GArray **scpi_response)
919 {
920         int tmp, ret;
921         char *response;
922         gchar **ptr, **tokens;
923         GArray *response_array;
924
925         *scpi_response = NULL;
926         response = NULL;
927         tokens = NULL;
928
929         ret = sr_scpi_get_string(scpi, command, &response);
930         if (ret != SR_OK && !response)
931                 return ret;
932
933         tokens = g_strsplit(response, ",", 0);
934         ptr = tokens;
935
936         response_array = g_array_sized_new(TRUE, FALSE, sizeof(uint8_t), 256);
937
938         while (*ptr) {
939                 if (sr_atoi(*ptr, &tmp) == SR_OK)
940                         response_array = g_array_append_val(response_array,
941                                                             tmp);
942                 else
943                         ret = SR_ERR_DATA;
944
945                 ptr++;
946         }
947         g_strfreev(tokens);
948         g_free(response);
949
950         if (response_array->len == 0) {
951                 g_array_free(response_array, TRUE);
952                 return SR_ERR_DATA;
953         }
954
955         *scpi_response = response_array;
956
957         return ret;
958 }
959
960 /**
961  * Send a SCPI command, read the reply, parse it as binary data with a
962  * "definite length block" header and store the as an result in scpi_response.
963  *
964  * Callers must free the allocated memory (unless it's NULL) regardless of
965  * the routine's return code. See @ref g_byte_array_free().
966  *
967  * @param[in] scpi Previously initialised SCPI device structure.
968  * @param[in] command The SCPI command to send to the device (can be NULL).
969  * @param[out] scpi_response Pointer where to store the parsed result.
970  *
971  * @return SR_OK upon successfully parsing all values, SR_ERR* upon a parsing
972  *         error or upon no response.
973  */
974 SR_PRIV int sr_scpi_get_block(struct sr_scpi_dev_inst *scpi,
975                                const char *command, GByteArray **scpi_response)
976 {
977         int ret;
978         GString* response;
979         gsize oldlen;
980         char buf[10];
981         long llen;
982         long datalen;
983         gint64 timeout;
984
985         *scpi_response = NULL;
986
987         g_mutex_lock(&scpi->scpi_mutex);
988
989         if (command)
990                 if (scpi_send(scpi, command) != SR_OK) {
991                         g_mutex_unlock(&scpi->scpi_mutex);
992                         return SR_ERR;
993                 }
994
995         if (sr_scpi_read_begin(scpi) != SR_OK) {
996                 g_mutex_unlock(&scpi->scpi_mutex);
997                 return SR_ERR;
998         }
999
1000         /*
1001          * Assume an initial maximum length, optionally gets adjusted below.
1002          * Prepare a NULL return value for when error paths will be taken.
1003          */
1004         response = g_string_sized_new(1024);
1005
1006         timeout = g_get_monotonic_time() + scpi->read_timeout_us;
1007
1008         /* Get (the first chunk of) the response. */
1009         do {
1010                 ret = scpi_read_response(scpi, response, timeout);
1011                 if (ret < 0) {
1012                         g_mutex_unlock(&scpi->scpi_mutex);
1013                         g_string_free(response, TRUE);
1014                         return ret;
1015                 }
1016         } while (response->len < 2);
1017
1018         /*
1019          * SCPI protocol data blocks are preceeded with a length spec.
1020          * The length spec consists of a '#' marker, one digit which
1021          * specifies the character count of the length spec, and the
1022          * respective number of characters which specify the data block's
1023          * length. Raw data bytes follow (thus one must no longer assume
1024          * that the received input stream would be an ASCIIZ string).
1025          *
1026          * Get the data block length, and strip off the length spec from
1027          * the input buffer, leaving just the data bytes.
1028          */
1029         if (response->str[0] != '#') {
1030                 g_mutex_unlock(&scpi->scpi_mutex);
1031                 g_string_free(response, TRUE);
1032                 return SR_ERR_DATA;
1033         }
1034         buf[0] = response->str[1];
1035         buf[1] = '\0';
1036         ret = sr_atol(buf, &llen);
1037         if ((ret != SR_OK) || (llen == 0)) {
1038                 g_mutex_unlock(&scpi->scpi_mutex);
1039                 g_string_free(response, TRUE);
1040                 return ret;
1041         }
1042
1043         while (response->len < (unsigned long)(2 + llen)) {
1044                 ret = scpi_read_response(scpi, response, timeout);
1045                 if (ret < 0) {
1046                         g_mutex_unlock(&scpi->scpi_mutex);
1047                         g_string_free(response, TRUE);
1048                         return ret;
1049                 }
1050         }
1051
1052         memcpy(buf, &response->str[2], llen);
1053         buf[llen] = '\0';
1054         ret = sr_atol(buf, &datalen);
1055         if ((ret != SR_OK) || (datalen == 0)) {
1056                 g_mutex_unlock(&scpi->scpi_mutex);
1057                 g_string_free(response, TRUE);
1058                 return ret;
1059         }
1060         g_string_erase(response, 0, 2 + llen);
1061
1062         /*
1063          * Re-allocate the buffer size to the now known length
1064          * and keep reading more chunks of response data.
1065          */
1066         oldlen = response->len;
1067         g_string_set_size(response, datalen);
1068         g_string_set_size(response, oldlen);
1069
1070         if (oldlen < (unsigned long)(datalen)) {
1071                 do {
1072                         oldlen = response->len;
1073                         ret = scpi_read_response(scpi, response, timeout);
1074
1075                         /* On timeout truncate the buffer and send the partial response
1076                          * instead of getting stuck on timeouts...
1077                          */
1078                         if (ret == SR_ERR_TIMEOUT) {
1079                                 datalen = oldlen;
1080                                 break;
1081                         }
1082                         if (ret < 0) {
1083                                 g_mutex_unlock(&scpi->scpi_mutex);
1084                                 g_string_free(response, TRUE);
1085                                 return ret;
1086                         }
1087                         if (ret > 0)
1088                                 timeout = g_get_monotonic_time() + scpi->read_timeout_us;
1089                 } while (response->len < (unsigned long)(datalen));
1090         }
1091
1092         g_mutex_unlock(&scpi->scpi_mutex);
1093
1094         /* Convert received data to byte array. */
1095         *scpi_response = g_byte_array_new_take(
1096                 (guint8*)g_string_free(response, FALSE), datalen);
1097
1098         return SR_OK;
1099 }
1100
1101 /**
1102  * Send the *IDN? SCPI command, receive the reply, parse it and store the
1103  * reply as a sr_scpi_hw_info structure in the supplied scpi_response pointer.
1104  *
1105  * Callers must free the allocated memory regardless of the routine's
1106  * return code. See @ref sr_scpi_hw_info_free().
1107  *
1108  * @param[in] scpi Previously initialised SCPI device structure.
1109  * @param[out] scpi_response Pointer where to store the hw_info structure.
1110  *
1111  * @return SR_OK upon success, SR_ERR* on failure.
1112  */
1113 SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
1114                               struct sr_scpi_hw_info **scpi_response)
1115 {
1116         int num_tokens, ret;
1117         char *response;
1118         gchar **tokens;
1119         struct sr_scpi_hw_info *hw_info;
1120         gchar *idn_substr;
1121
1122         *scpi_response = NULL;
1123         response = NULL;
1124         tokens = NULL;
1125
1126         ret = sr_scpi_get_string(scpi, SCPI_CMD_IDN, &response);
1127         if (ret != SR_OK && !response)
1128                 return ret;
1129
1130         /*
1131          * The response to a '*IDN?' is specified by the SCPI spec. It contains
1132          * a comma-separated list containing the manufacturer name, instrument
1133          * model, serial number of the instrument and the firmware version.
1134          *
1135          * BEWARE! Although strictly speaking a smaller field count is invalid,
1136          * this implementation also accepts IDN responses with one field less,
1137          * and assumes that the serial number is missing. Some GWInstek DMMs
1138          * were found to do this. Keep warning about this condition, which may
1139          * need more consideration later.
1140          */
1141         tokens = g_strsplit(response, ",", 0);
1142         num_tokens = g_strv_length(tokens);
1143         if (num_tokens < 3) {
1144                 sr_dbg("IDN response not according to spec: '%s'", response);
1145                 g_strfreev(tokens);
1146                 g_free(response);
1147                 return SR_ERR_DATA;
1148         }
1149         if (num_tokens < 4) {
1150                 sr_warn("Short IDN response, assume missing serial number.");
1151         }
1152         g_free(response);
1153
1154         hw_info = g_malloc0(sizeof(struct sr_scpi_hw_info));
1155
1156         idn_substr = g_strstr_len(tokens[0], -1, "IDN ");
1157         if (idn_substr == NULL)
1158                 hw_info->manufacturer = g_strstrip(g_strdup(tokens[0]));
1159         else
1160                 hw_info->manufacturer = g_strstrip(g_strdup(idn_substr + 4));
1161
1162         hw_info->model = g_strstrip(g_strdup(tokens[1]));
1163         if (num_tokens < 4) {
1164                 hw_info->serial_number = g_strdup("Unknown");
1165                 hw_info->firmware_version = g_strstrip(g_strdup(tokens[2]));
1166         } else {
1167                 hw_info->serial_number = g_strstrip(g_strdup(tokens[2]));
1168                 hw_info->firmware_version = g_strstrip(g_strdup(tokens[3]));
1169         }
1170
1171         g_strfreev(tokens);
1172
1173         *scpi_response = hw_info;
1174
1175         return SR_OK;
1176 }
1177
1178 /**
1179  * Free a sr_scpi_hw_info struct.
1180  *
1181  * @param hw_info Pointer to the struct to free. If NULL, this
1182  *                function does nothing.
1183  */
1184 SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info)
1185 {
1186         if (!hw_info)
1187                 return;
1188
1189         g_free(hw_info->manufacturer);
1190         g_free(hw_info->model);
1191         g_free(hw_info->serial_number);
1192         g_free(hw_info->firmware_version);
1193         g_free(hw_info);
1194 }
1195
1196 /**
1197  * Remove potentially enclosing pairs of quotes, un-escape content.
1198  * This implementation modifies the caller's buffer when quotes are found
1199  * and doubled quote characters need to get removed from the content.
1200  *
1201  * @param[in, out] s    The SCPI string to check and un-quote.
1202  *
1203  * @return The start of the un-quoted string.
1204  */
1205 SR_PRIV const char *sr_scpi_unquote_string(char *s)
1206 {
1207         size_t s_len;
1208         char quotes[3];
1209         char *rdptr;
1210
1211         /* Immediately bail out on invalid or short input. */
1212         if (!s || !*s)
1213                 return s;
1214         s_len = strlen(s);
1215         if (s_len < 2)
1216                 return s;
1217
1218         /* Check for matching quote characters front and back. */
1219         if (s[0] != '\'' && s[0] != '"')
1220                 return s;
1221         if (s[0] != s[s_len - 1])
1222                 return s;
1223
1224         /* Need to strip quotes, and un-double quote chars inside. */
1225         quotes[0] = quotes[1] = *s;
1226         quotes[2] = '\0';
1227         s[s_len - 1] = '\0';
1228         s++;
1229         rdptr = s;
1230         while ((rdptr = strstr(rdptr, quotes)) != NULL) {
1231                 memmove(rdptr, rdptr + 1, strlen(rdptr));
1232                 rdptr++;
1233         }
1234
1235         return s;
1236 }
1237
1238 SR_PRIV const char *sr_vendor_alias(const char *raw_vendor)
1239 {
1240         unsigned int i;
1241
1242         for (i = 0; i < ARRAY_SIZE(scpi_vendors); i++) {
1243                 if (!g_ascii_strcasecmp(raw_vendor, scpi_vendors[i][0]))
1244                         return scpi_vendors[i][1];
1245         }
1246
1247         return raw_vendor;
1248 }
1249
1250 SR_PRIV const char *sr_scpi_cmd_get(const struct scpi_command *cmdtable,
1251                 int command)
1252 {
1253         unsigned int i;
1254         const char *cmd;
1255
1256         if (!cmdtable)
1257                 return NULL;
1258
1259         cmd = NULL;
1260         for (i = 0; cmdtable[i].string; i++) {
1261                 if (cmdtable[i].command == command) {
1262                         cmd = cmdtable[i].string;
1263                         break;
1264                 }
1265         }
1266
1267         return cmd;
1268 }
1269
1270 SR_PRIV int sr_scpi_cmd(const struct sr_dev_inst *sdi,
1271                 const struct scpi_command *cmdtable,
1272                 int channel_command, const char *channel_name,
1273                 int command, ...)
1274 {
1275         struct sr_scpi_dev_inst *scpi;
1276         va_list args;
1277         int ret;
1278         const char *channel_cmd;
1279         const char *cmd;
1280
1281         scpi = sdi->conn;
1282
1283         if (!(cmd = sr_scpi_cmd_get(cmdtable, command))) {
1284                 /* Device does not implement this command, that's OK. */
1285                 return SR_OK;
1286         }
1287
1288         g_mutex_lock(&scpi->scpi_mutex);
1289
1290         /* Select channel. */
1291         channel_cmd = sr_scpi_cmd_get(cmdtable, channel_command);
1292         if (channel_cmd && channel_name &&
1293                         g_strcmp0(channel_name, scpi->actual_channel_name)) {
1294                 sr_spew("sr_scpi_cmd(): new channel = %s", channel_name);
1295                 g_free(scpi->actual_channel_name);
1296                 scpi->actual_channel_name = g_strdup(channel_name);
1297                 ret = scpi_send(scpi, channel_cmd, channel_name);
1298                 if (ret != SR_OK)
1299                         return ret;
1300         }
1301
1302         va_start(args, command);
1303         ret = scpi_send_variadic(scpi, cmd, args);
1304         va_end(args);
1305
1306         g_mutex_unlock(&scpi->scpi_mutex);
1307
1308         return ret;
1309 }
1310
1311 SR_PRIV int sr_scpi_cmd_resp(const struct sr_dev_inst *sdi,
1312                 const struct scpi_command *cmdtable,
1313                 int channel_command, const char *channel_name,
1314                 GVariant **gvar, const GVariantType *gvtype, int command, ...)
1315 {
1316         struct sr_scpi_dev_inst *scpi;
1317         va_list args;
1318         const char *channel_cmd;
1319         const char *cmd;
1320         GString *response;
1321         char *s;
1322         gboolean b;
1323         double d;
1324         int ret;
1325
1326         scpi = sdi->conn;
1327
1328         if (!(cmd = sr_scpi_cmd_get(cmdtable, command))) {
1329                 /* Device does not implement this command. */
1330                 return SR_ERR_NA;
1331         }
1332
1333         g_mutex_lock(&scpi->scpi_mutex);
1334
1335         /* Select channel. */
1336         channel_cmd = sr_scpi_cmd_get(cmdtable, channel_command);
1337         if (channel_cmd && channel_name &&
1338                         g_strcmp0(channel_name, scpi->actual_channel_name)) {
1339                 sr_spew("sr_scpi_cmd_get(): new channel = %s", channel_name);
1340                 g_free(scpi->actual_channel_name);
1341                 scpi->actual_channel_name = g_strdup(channel_name);
1342                 ret = scpi_send(scpi, channel_cmd, channel_name);
1343                 if (ret != SR_OK)
1344                         return ret;
1345         }
1346
1347         va_start(args, command);
1348         ret = scpi_send_variadic(scpi, cmd, args);
1349         va_end(args);
1350         if (ret != SR_OK) {
1351                 g_mutex_unlock(&scpi->scpi_mutex);
1352                 return ret;
1353         }
1354
1355         response = g_string_sized_new(1024);
1356         ret = scpi_get_data(scpi, NULL, &response);
1357         if (ret != SR_OK) {
1358                 g_mutex_unlock(&scpi->scpi_mutex);
1359                 if (response)
1360                         g_string_free(response, TRUE);
1361                 return ret;
1362         }
1363
1364         g_mutex_unlock(&scpi->scpi_mutex);
1365
1366         /* Get rid of trailing linefeed if present */
1367         if (response->len >= 1 && response->str[response->len - 1] == '\n')
1368                 g_string_truncate(response, response->len - 1);
1369
1370         /* Get rid of trailing carriage return if present */
1371         if (response->len >= 1 && response->str[response->len - 1] == '\r')
1372                 g_string_truncate(response, response->len - 1);
1373
1374         s = g_string_free(response, FALSE);
1375
1376         ret = SR_OK;
1377         if (g_variant_type_equal(gvtype, G_VARIANT_TYPE_BOOLEAN)) {
1378                 if ((ret = parse_strict_bool(s, &b)) == SR_OK)
1379                         *gvar = g_variant_new_boolean(b);
1380         } else if (g_variant_type_equal(gvtype, G_VARIANT_TYPE_DOUBLE)) {
1381                 if ((ret = sr_atod_ascii(s, &d)) == SR_OK)
1382                         *gvar = g_variant_new_double(d);
1383         } else if (g_variant_type_equal(gvtype, G_VARIANT_TYPE_STRING)) {
1384                 *gvar = g_variant_new_string(s);
1385         } else {
1386                 sr_err("Unable to convert to desired GVariant type.");
1387                 ret = SR_ERR_NA;
1388         }
1389
1390         g_free(s);
1391
1392         return ret;
1393 }