]> sigrok.org Git - libsigrok.git/blob - src/scpi/scpi.c
c01791ef5ecebc8ac43300db1248a36081951f92
[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  * @param scpi Previously initialized SCPI device structure.
414  * @param connection_id Pointer where to store the connection ID. The caller
415  *        is responsible for g_free()ing the string when it is no longer needed.
416  *
417  * @return SR_OK on success, SR_ERR on failure.
418  */
419 SR_PRIV int sr_scpi_connection_id(struct sr_scpi_dev_inst *scpi,
420                 char **connection_id)
421 {
422         return scpi->connection_id(scpi, connection_id);
423 }
424
425 /**
426  * Add an event source for an SCPI device.
427  *
428  * @param session The session to add the event source to.
429  * @param scpi Previously initialized SCPI device structure.
430  * @param events Events to check for.
431  * @param timeout Max time to wait before the callback is called, ignored if 0.
432  * @param cb Callback function to add. Must not be NULL.
433  * @param cb_data Data for the callback function. Can be NULL.
434  *
435  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
436  *         SR_ERR_MALLOC upon memory allocation errors.
437  */
438 SR_PRIV int sr_scpi_source_add(struct sr_session *session,
439                 struct sr_scpi_dev_inst *scpi, int events, int timeout,
440                 sr_receive_data_callback cb, void *cb_data)
441 {
442         return scpi->source_add(session, scpi->priv, events, timeout, cb, cb_data);
443 }
444
445 /**
446  * Remove event source for an SCPI device.
447  *
448  * @param session The session to remove the event source from.
449  * @param scpi Previously initialized SCPI device structure.
450  *
451  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
452  *         SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
453  *         internal errors.
454  */
455 SR_PRIV int sr_scpi_source_remove(struct sr_session *session,
456                 struct sr_scpi_dev_inst *scpi)
457 {
458         return scpi->source_remove(session, scpi->priv);
459 }
460
461 /**
462  * Send a SCPI command.
463  *
464  * @param scpi Previously initialized SCPI device structure.
465  * @param format Format string, to be followed by any necessary arguments.
466  *
467  * @return SR_OK on success, SR_ERR on failure.
468  */
469 SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi,
470                          const char *format, ...)
471 {
472         va_list args;
473         int ret;
474
475         va_start(args, format);
476         g_mutex_lock(&scpi->scpi_mutex);
477         ret = scpi_send_variadic(scpi, format, args);
478         g_mutex_unlock(&scpi->scpi_mutex);
479         va_end(args);
480
481         return ret;
482 }
483
484 /**
485  * Send a SCPI command with a variadic argument list.
486  *
487  * @param scpi Previously initialized SCPI device structure.
488  * @param format Format string.
489  * @param args Argument list.
490  *
491  * @return SR_OK on success, SR_ERR on failure.
492  */
493 SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
494                          const char *format, va_list args)
495 {
496         int ret;
497
498         g_mutex_lock(&scpi->scpi_mutex);
499         ret = scpi_send_variadic(scpi, format, args);
500         g_mutex_unlock(&scpi->scpi_mutex);
501
502         return ret;
503 }
504
505 /**
506  * Begin receiving an SCPI reply.
507  *
508  * @param scpi Previously initialised SCPI device structure.
509  *
510  * @return SR_OK on success, SR_ERR on failure.
511  */
512 SR_PRIV int sr_scpi_read_begin(struct sr_scpi_dev_inst *scpi)
513 {
514         return scpi->read_begin(scpi->priv);
515 }
516
517 /**
518  * Read part of a response from SCPI device.
519  *
520  * @param scpi Previously initialised SCPI device structure.
521  * @param buf Buffer to store result.
522  * @param maxlen Maximum number of bytes to read.
523  *
524  * @return Number of bytes read, or SR_ERR upon failure.
525  */
526 SR_PRIV int sr_scpi_read_data(struct sr_scpi_dev_inst *scpi,
527                         char *buf, int maxlen)
528 {
529         int ret;
530
531         g_mutex_lock(&scpi->scpi_mutex);
532         ret = scpi_read_data(scpi, buf, maxlen);
533         g_mutex_unlock(&scpi->scpi_mutex);
534
535         return ret;
536 }
537
538 /**
539  * Send data to SCPI device.
540  *
541  * TODO: This is only implemented in TcpRaw, but never used.
542  * TODO: Use Mutex at all?
543  *
544  * @param scpi Previously initialised SCPI device structure.
545  * @param buf Buffer with data to send.
546  * @param len Number of bytes to send.
547  *
548  * @return Number of bytes read, or SR_ERR upon failure.
549  */
550 SR_PRIV int sr_scpi_write_data(struct sr_scpi_dev_inst *scpi,
551                         char *buf, int maxlen)
552 {
553         int ret;
554
555         g_mutex_lock(&scpi->scpi_mutex);
556         ret = scpi_write_data(scpi, buf, maxlen);
557         g_mutex_unlock(&scpi->scpi_mutex);
558
559         return ret;
560 }
561
562 /**
563  * Check whether a complete SCPI response has been received.
564  *
565  * @param scpi Previously initialised SCPI device structure.
566  *
567  * @return 1 if complete, 0 otherwise.
568  */
569 SR_PRIV int sr_scpi_read_complete(struct sr_scpi_dev_inst *scpi)
570 {
571         return scpi->read_complete(scpi->priv);
572 }
573
574 /**
575  * Close SCPI device.
576  *
577  * @param scpi Previously initialized SCPI device structure.
578  *
579  * @return SR_OK on success, SR_ERR on failure.
580  */
581 SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi)
582 {
583         int ret;
584
585         g_mutex_lock(&scpi->scpi_mutex);
586         ret = scpi->close(scpi);
587         g_mutex_unlock(&scpi->scpi_mutex);
588         g_mutex_clear(&scpi->scpi_mutex);
589
590         return ret;
591 }
592
593 /**
594  * Free SCPI device.
595  *
596  * @param scpi Previously initialized SCPI device structure. If NULL,
597  *             this function does nothing.
598  */
599 SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi)
600 {
601         if (!scpi)
602                 return;
603
604         scpi->free(scpi->priv);
605         g_free(scpi->priv);
606         g_free(scpi->actual_channel_name);
607         g_free(scpi);
608 }
609
610 /**
611  * Send a SCPI command, receive the reply and store the reply in scpi_response.
612  *
613  * @param scpi Previously initialised SCPI device structure.
614  * @param command The SCPI command to send to the device (can be NULL).
615  * @param scpi_response Pointer where to store the SCPI response.
616  *
617  * @return SR_OK on success, SR_ERR* on failure.
618  */
619 SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
620                                const char *command, char **scpi_response)
621 {
622         GString *response;
623
624         *scpi_response = NULL;
625
626         response = g_string_sized_new(1024);
627         if (sr_scpi_get_data(scpi, command, &response) != SR_OK) {
628                 if (response)
629                         g_string_free(response, TRUE);
630                 return SR_ERR;
631         }
632
633         /* Get rid of trailing linefeed if present */
634         if (response->len >= 1 && response->str[response->len - 1] == '\n')
635                 g_string_truncate(response, response->len - 1);
636
637         /* Get rid of trailing carriage return if present */
638         if (response->len >= 1 && response->str[response->len - 1] == '\r')
639                 g_string_truncate(response, response->len - 1);
640
641         sr_spew("Got response: '%.70s', length %" G_GSIZE_FORMAT ".",
642                 response->str, response->len);
643
644         *scpi_response = g_string_free(response, FALSE);
645
646         return SR_OK;
647 }
648
649 /**
650  * Do a non-blocking read of up to the allocated length, and
651  * check if a timeout has occured.
652  *
653  * @param scpi Previously initialised SCPI device structure.
654  * @param response Buffer to which the response is appended.
655  * @param abs_timeout_us Absolute timeout in microseconds
656  *
657  * @return read length on success, SR_ERR* on failure.
658  */
659 SR_PRIV int sr_scpi_read_response(struct sr_scpi_dev_inst *scpi,
660                                   GString *response, gint64 abs_timeout_us)
661 {
662         int ret;
663
664         g_mutex_lock(&scpi->scpi_mutex);
665         ret = scpi_read_response(scpi, response, abs_timeout_us);
666         g_mutex_unlock(&scpi->scpi_mutex);
667
668         return ret;
669 }
670
671 SR_PRIV int sr_scpi_get_data(struct sr_scpi_dev_inst *scpi,
672                              const char *command, GString **scpi_response)
673 {
674         int ret;
675
676         g_mutex_lock(&scpi->scpi_mutex);
677         ret = scpi_get_data(scpi, command, scpi_response);
678         g_mutex_unlock(&scpi->scpi_mutex);
679
680         return ret;
681 }
682
683 /**
684  * Send a SCPI command, read the reply, parse it as a bool value and store the
685  * result in scpi_response.
686  *
687  * @param scpi Previously initialised SCPI device structure.
688  * @param command The SCPI command to send to the device (can be NULL).
689  * @param scpi_response Pointer where to store the parsed result.
690  *
691  * @return SR_OK on success, SR_ERR* on failure.
692  */
693 SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
694                              const char *command, gboolean *scpi_response)
695 {
696         int ret;
697         char *response;
698
699         response = NULL;
700
701         ret = sr_scpi_get_string(scpi, command, &response);
702         if (ret != SR_OK && !response)
703                 return ret;
704
705         if (parse_strict_bool(response, scpi_response) == SR_OK)
706                 ret = SR_OK;
707         else
708                 ret = SR_ERR_DATA;
709
710         g_free(response);
711
712         return ret;
713 }
714
715 /**
716  * Send a SCPI command, read the reply, parse it as an integer and store the
717  * result in scpi_response.
718  *
719  * @param scpi Previously initialised SCPI device structure.
720  * @param command The SCPI command to send to the device (can be NULL).
721  * @param scpi_response Pointer where to store the parsed result.
722  *
723  * @return SR_OK on success, SR_ERR* on failure.
724  */
725 SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
726                             const char *command, int *scpi_response)
727 {
728         int ret;
729         struct sr_rational ret_rational;
730         char *response;
731
732         response = NULL;
733
734         ret = sr_scpi_get_string(scpi, command, &response);
735         if (ret != SR_OK && !response)
736                 return ret;
737
738         ret = sr_parse_rational(response, &ret_rational);
739         if (ret == SR_OK && (ret_rational.p % ret_rational.q) == 0) {
740                 *scpi_response = ret_rational.p / ret_rational.q;
741         } else {
742                 sr_dbg("get_int: non-integer rational=%" PRId64 "/%" PRIu64,
743                         ret_rational.p, ret_rational.q);
744                 ret = SR_ERR_DATA;
745         }
746
747         g_free(response);
748
749         return ret;
750 }
751
752 /**
753  * Send a SCPI command, read the reply, parse it as a float and store the
754  * result in scpi_response.
755  *
756  * @param scpi Previously initialised SCPI device structure.
757  * @param command The SCPI command to send to the device (can be NULL).
758  * @param scpi_response Pointer where to store the parsed result.
759  *
760  * @return SR_OK on success, SR_ERR* on failure.
761  */
762 SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
763                               const char *command, float *scpi_response)
764 {
765         int ret;
766         char *response;
767
768         response = NULL;
769
770         ret = sr_scpi_get_string(scpi, command, &response);
771         if (ret != SR_OK && !response)
772                 return ret;
773
774         if (sr_atof_ascii(response, scpi_response) == SR_OK)
775                 ret = SR_OK;
776         else
777                 ret = SR_ERR_DATA;
778
779         g_free(response);
780
781         return ret;
782 }
783
784 /**
785  * Send a SCPI command, read the reply, parse it as a double and store the
786  * result in scpi_response.
787  *
788  * @param scpi Previously initialised SCPI device structure.
789  * @param command The SCPI command to send to the device (can be NULL).
790  * @param scpi_response Pointer where to store the parsed result.
791  *
792  * @return SR_OK on success, SR_ERR* on failure.
793  */
794 SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
795                                const char *command, double *scpi_response)
796 {
797         int ret;
798         char *response;
799
800         response = NULL;
801
802         ret = sr_scpi_get_string(scpi, command, &response);
803         if (ret != SR_OK && !response)
804                 return ret;
805
806         if (sr_atod_ascii(response, scpi_response) == SR_OK)
807                 ret = SR_OK;
808         else
809                 ret = SR_ERR_DATA;
810
811         g_free(response);
812
813         return ret;
814 }
815
816 /**
817  * Send a SCPI *OPC? command, read the reply and return the result of the
818  * command.
819  *
820  * @param scpi Previously initialised SCPI device structure.
821  *
822  * @return SR_OK on success, SR_ERR* on failure.
823  */
824 SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi)
825 {
826         unsigned int i;
827         gboolean opc;
828
829         for (i = 0; i < SCPI_READ_RETRIES; i++) {
830                 opc = FALSE;
831                 sr_scpi_get_bool(scpi, SCPI_CMD_OPC, &opc);
832                 if (opc)
833                         return SR_OK;
834                 g_usleep(SCPI_READ_RETRY_TIMEOUT_US);
835         }
836
837         return SR_ERR;
838 }
839
840 /**
841  * Send a SCPI command, read the reply, parse it as comma separated list of
842  * floats and store the as an result in scpi_response.
843  *
844  * @param scpi Previously initialised SCPI device structure.
845  * @param command The SCPI command to send to the device (can be NULL).
846  * @param scpi_response Pointer where to store the parsed result.
847  *
848  * @return SR_OK upon successfully parsing all values, SR_ERR* upon a parsing
849  *         error or upon no response. The allocated response must be freed by
850  *         the caller in the case of an SR_OK as well as in the case of
851  *         parsing error.
852  */
853 SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
854                                const char *command, GArray **scpi_response)
855 {
856         int ret;
857         float tmp;
858         char *response;
859         gchar **ptr, **tokens;
860         GArray *response_array;
861
862         *scpi_response = NULL;
863         response = NULL;
864         tokens = NULL;
865
866         ret = sr_scpi_get_string(scpi, command, &response);
867         if (ret != SR_OK && !response)
868                 return ret;
869
870         tokens = g_strsplit(response, ",", 0);
871         ptr = tokens;
872
873         response_array = g_array_sized_new(TRUE, FALSE, sizeof(float), 256);
874
875         while (*ptr) {
876                 if (sr_atof_ascii(*ptr, &tmp) == SR_OK)
877                         response_array = g_array_append_val(response_array,
878                                                             tmp);
879                 else
880                         ret = SR_ERR_DATA;
881
882                 ptr++;
883         }
884         g_strfreev(tokens);
885         g_free(response);
886
887         if (ret != SR_OK && response_array->len == 0) {
888                 g_array_free(response_array, TRUE);
889                 return SR_ERR_DATA;
890         }
891
892         *scpi_response = response_array;
893
894         return ret;
895 }
896
897 /**
898  * Send a SCPI command, read the reply, parse it as comma separated list of
899  * unsigned 8 bit integers and store the as an result in scpi_response.
900  *
901  * @param scpi Previously initialised SCPI device structure.
902  * @param command The SCPI command to send to the device (can be NULL).
903  * @param scpi_response Pointer where to store the parsed result.
904  *
905  * @return SR_OK upon successfully parsing all values, SR_ERR* upon a parsing
906  *         error or upon no response. The allocated response must be freed by
907  *         the caller in the case of an SR_OK as well as in the case of
908  *         parsing error.
909  */
910 SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
911                                const char *command, GArray **scpi_response)
912 {
913         int tmp, ret;
914         char *response;
915         gchar **ptr, **tokens;
916         GArray *response_array;
917
918         *scpi_response = NULL;
919         response = NULL;
920         tokens = NULL;
921
922         ret = sr_scpi_get_string(scpi, command, &response);
923         if (ret != SR_OK && !response)
924                 return ret;
925
926         tokens = g_strsplit(response, ",", 0);
927         ptr = tokens;
928
929         response_array = g_array_sized_new(TRUE, FALSE, sizeof(uint8_t), 256);
930
931         while (*ptr) {
932                 if (sr_atoi(*ptr, &tmp) == SR_OK)
933                         response_array = g_array_append_val(response_array,
934                                                             tmp);
935                 else
936                         ret = SR_ERR_DATA;
937
938                 ptr++;
939         }
940         g_strfreev(tokens);
941         g_free(response);
942
943         if (response_array->len == 0) {
944                 g_array_free(response_array, TRUE);
945                 return SR_ERR_DATA;
946         }
947
948         *scpi_response = response_array;
949
950         return ret;
951 }
952
953 /**
954  * Send a SCPI command, read the reply, parse it as binary data with a
955  * "definite length block" header and store the as an result in scpi_response.
956  *
957  * @param scpi Previously initialised SCPI device structure.
958  * @param command The SCPI command to send to the device (can be NULL).
959  * @param scpi_response Pointer where to store the parsed result.
960  *
961  * @return SR_OK upon successfully parsing all values, SR_ERR* upon a parsing
962  *         error or upon no response. The allocated response must be freed by
963  *         the caller in the case of an SR_OK as well as in the case of
964  *         parsing error.
965  */
966 SR_PRIV int sr_scpi_get_block(struct sr_scpi_dev_inst *scpi,
967                                const char *command, GByteArray **scpi_response)
968 {
969         int ret;
970         GString* response;
971         gsize oldlen;
972         char buf[10];
973         long llen;
974         long datalen;
975         gint64 timeout;
976
977         *scpi_response = NULL;
978
979         g_mutex_lock(&scpi->scpi_mutex);
980
981         if (command)
982                 if (scpi_send(scpi, command) != SR_OK) {
983                         g_mutex_unlock(&scpi->scpi_mutex);
984                         return SR_ERR;
985                 }
986
987         if (sr_scpi_read_begin(scpi) != SR_OK) {
988                 g_mutex_unlock(&scpi->scpi_mutex);
989                 return SR_ERR;
990         }
991
992         /*
993          * Assume an initial maximum length, optionally gets adjusted below.
994          * Prepare a NULL return value for when error paths will be taken.
995          */
996         response = g_string_sized_new(1024);
997
998         timeout = g_get_monotonic_time() + scpi->read_timeout_us;
999
1000         /* Get (the first chunk of) the response. */
1001         do {
1002                 ret = scpi_read_response(scpi, response, timeout);
1003                 if (ret < 0) {
1004                         g_mutex_unlock(&scpi->scpi_mutex);
1005                         g_string_free(response, TRUE);
1006                         return ret;
1007                 }
1008         } while (response->len < 2);
1009
1010         /*
1011          * SCPI protocol data blocks are preceeded with a length spec.
1012          * The length spec consists of a '#' marker, one digit which
1013          * specifies the character count of the length spec, and the
1014          * respective number of characters which specify the data block's
1015          * length. Raw data bytes follow (thus one must no longer assume
1016          * that the received input stream would be an ASCIIZ string).
1017          *
1018          * Get the data block length, and strip off the length spec from
1019          * the input buffer, leaving just the data bytes.
1020          */
1021         if (response->str[0] != '#') {
1022                 g_mutex_unlock(&scpi->scpi_mutex);
1023                 g_string_free(response, TRUE);
1024                 return SR_ERR_DATA;
1025         }
1026         buf[0] = response->str[1];
1027         buf[1] = '\0';
1028         ret = sr_atol(buf, &llen);
1029         if ((ret != SR_OK) || (llen == 0)) {
1030                 g_mutex_unlock(&scpi->scpi_mutex);
1031                 g_string_free(response, TRUE);
1032                 return ret;
1033         }
1034
1035         while (response->len < (unsigned long)(2 + llen)) {
1036                 ret = scpi_read_response(scpi, response, timeout);
1037                 if (ret < 0) {
1038                         g_mutex_unlock(&scpi->scpi_mutex);
1039                         g_string_free(response, TRUE);
1040                         return ret;
1041                 }
1042         }
1043
1044         memcpy(buf, &response->str[2], llen);
1045         buf[llen] = '\0';
1046         ret = sr_atol(buf, &datalen);
1047         if ((ret != SR_OK) || (datalen == 0)) {
1048                 g_mutex_unlock(&scpi->scpi_mutex);
1049                 g_string_free(response, TRUE);
1050                 return ret;
1051         }
1052         g_string_erase(response, 0, 2 + llen);
1053
1054         /*
1055          * Re-allocate the buffer size to the now known length
1056          * and keep reading more chunks of response data.
1057          */
1058         oldlen = response->len;
1059         g_string_set_size(response, datalen);
1060         g_string_set_size(response, oldlen);
1061
1062         if (oldlen < (unsigned long)(datalen)) {
1063                 do {
1064                         oldlen = response->len;
1065                         ret = scpi_read_response(scpi, response, timeout);
1066
1067                         /* On timeout truncate the buffer and send the partial response
1068                          * instead of getting stuck on timeouts...
1069                          */
1070                         if (ret == SR_ERR_TIMEOUT) {
1071                                 datalen = oldlen;
1072                                 break;
1073                         }
1074                         if (ret < 0) {
1075                                 g_mutex_unlock(&scpi->scpi_mutex);
1076                                 g_string_free(response, TRUE);
1077                                 return ret;
1078                         }
1079                         if (ret > 0)
1080                                 timeout = g_get_monotonic_time() + scpi->read_timeout_us;
1081                 } while (response->len < (unsigned long)(datalen));
1082         }
1083
1084         g_mutex_unlock(&scpi->scpi_mutex);
1085
1086         /* Convert received data to byte array. */
1087         *scpi_response = g_byte_array_new_take(
1088                 (guint8*)g_string_free(response, FALSE), datalen);
1089
1090         return SR_OK;
1091 }
1092
1093 /**
1094  * Send the *IDN? SCPI command, receive the reply, parse it and store the
1095  * reply as a sr_scpi_hw_info structure in the supplied scpi_response pointer.
1096  *
1097  * The hw_info structure must be freed by the caller via sr_scpi_hw_info_free().
1098  *
1099  * @param scpi Previously initialised SCPI device structure.
1100  * @param scpi_response Pointer where to store the hw_info structure.
1101  *
1102  * @return SR_OK upon success, SR_ERR* on failure.
1103  */
1104 SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
1105                               struct sr_scpi_hw_info **scpi_response)
1106 {
1107         int num_tokens, ret;
1108         char *response;
1109         gchar **tokens;
1110         struct sr_scpi_hw_info *hw_info;
1111         gchar *idn_substr;
1112
1113         *scpi_response = NULL;
1114         response = NULL;
1115         tokens = NULL;
1116
1117         ret = sr_scpi_get_string(scpi, SCPI_CMD_IDN, &response);
1118         if (ret != SR_OK && !response)
1119                 return ret;
1120
1121         /*
1122          * The response to a '*IDN?' is specified by the SCPI spec. It contains
1123          * a comma-separated list containing the manufacturer name, instrument
1124          * model, serial number of the instrument and the firmware version.
1125          *
1126          * BEWARE! Although strictly speaking a smaller field count is invalid,
1127          * this implementation also accepts IDN responses with one field less,
1128          * and assumes that the serial number is missing. Some GWInstek DMMs
1129          * were found to do this. Keep warning about this condition, which may
1130          * need more consideration later.
1131          */
1132         tokens = g_strsplit(response, ",", 0);
1133         num_tokens = g_strv_length(tokens);
1134         if (num_tokens < 3) {
1135                 sr_dbg("IDN response not according to spec: '%s'", response);
1136                 g_strfreev(tokens);
1137                 g_free(response);
1138                 return SR_ERR_DATA;
1139         }
1140         if (num_tokens < 4) {
1141                 sr_warn("Short IDN response, assume missing serial number.");
1142         }
1143         g_free(response);
1144
1145         hw_info = g_malloc0(sizeof(struct sr_scpi_hw_info));
1146
1147         idn_substr = g_strstr_len(tokens[0], -1, "IDN ");
1148         if (idn_substr == NULL)
1149                 hw_info->manufacturer = g_strstrip(g_strdup(tokens[0]));
1150         else
1151                 hw_info->manufacturer = g_strstrip(g_strdup(idn_substr + 4));
1152
1153         hw_info->model = g_strstrip(g_strdup(tokens[1]));
1154         if (num_tokens < 4) {
1155                 hw_info->serial_number = g_strdup("Unknown");
1156                 hw_info->firmware_version = g_strstrip(g_strdup(tokens[2]));
1157         } else {
1158                 hw_info->serial_number = g_strstrip(g_strdup(tokens[2]));
1159                 hw_info->firmware_version = g_strstrip(g_strdup(tokens[3]));
1160         }
1161
1162         g_strfreev(tokens);
1163
1164         *scpi_response = hw_info;
1165
1166         return SR_OK;
1167 }
1168
1169 /**
1170  * Free a sr_scpi_hw_info struct.
1171  *
1172  * @param hw_info Pointer to the struct to free. If NULL, this
1173  *                function does nothing.
1174  */
1175 SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info)
1176 {
1177         if (!hw_info)
1178                 return;
1179
1180         g_free(hw_info->manufacturer);
1181         g_free(hw_info->model);
1182         g_free(hw_info->serial_number);
1183         g_free(hw_info->firmware_version);
1184         g_free(hw_info);
1185 }
1186
1187 /**
1188  * Remove potentially enclosing pairs of quotes, un-escape content.
1189  * This implementation modifies the caller's buffer when quotes are found
1190  * and doubled quote characters need to get removed from the content.
1191  *
1192  * @param[in, out] s    The SCPI string to check and un-quote.
1193  *
1194  * @return The start of the un-quoted string.
1195  */
1196 SR_PRIV const char *sr_scpi_unquote_string(char *s)
1197 {
1198         size_t s_len;
1199         char quotes[3];
1200         char *rdptr;
1201
1202         /* Immediately bail out on invalid or short input. */
1203         if (!s || !*s)
1204                 return s;
1205         s_len = strlen(s);
1206         if (s_len < 2)
1207                 return s;
1208
1209         /* Check for matching quote characters front and back. */
1210         if (s[0] != '\'' && s[0] != '"')
1211                 return s;
1212         if (s[0] != s[s_len - 1])
1213                 return s;
1214
1215         /* Need to strip quotes, and un-double quote chars inside. */
1216         quotes[0] = quotes[1] = *s;
1217         quotes[2] = '\0';
1218         s[s_len - 1] = '\0';
1219         s++;
1220         rdptr = s;
1221         while ((rdptr = strstr(rdptr, quotes)) != NULL) {
1222                 memmove(rdptr, rdptr + 1, strlen(rdptr));
1223                 rdptr++;
1224         }
1225
1226         return s;
1227 }
1228
1229 SR_PRIV const char *sr_vendor_alias(const char *raw_vendor)
1230 {
1231         unsigned int i;
1232
1233         for (i = 0; i < ARRAY_SIZE(scpi_vendors); i++) {
1234                 if (!g_ascii_strcasecmp(raw_vendor, scpi_vendors[i][0]))
1235                         return scpi_vendors[i][1];
1236         }
1237
1238         return raw_vendor;
1239 }
1240
1241 SR_PRIV const char *sr_scpi_cmd_get(const struct scpi_command *cmdtable,
1242                 int command)
1243 {
1244         unsigned int i;
1245         const char *cmd;
1246
1247         if (!cmdtable)
1248                 return NULL;
1249
1250         cmd = NULL;
1251         for (i = 0; cmdtable[i].string; i++) {
1252                 if (cmdtable[i].command == command) {
1253                         cmd = cmdtable[i].string;
1254                         break;
1255                 }
1256         }
1257
1258         return cmd;
1259 }
1260
1261 SR_PRIV int sr_scpi_cmd(const struct sr_dev_inst *sdi,
1262                 const struct scpi_command *cmdtable,
1263                 int channel_command, const char *channel_name,
1264                 int command, ...)
1265 {
1266         struct sr_scpi_dev_inst *scpi;
1267         va_list args;
1268         int ret;
1269         const char *channel_cmd;
1270         const char *cmd;
1271
1272         scpi = sdi->conn;
1273
1274         if (!(cmd = sr_scpi_cmd_get(cmdtable, command))) {
1275                 /* Device does not implement this command, that's OK. */
1276                 return SR_OK;
1277         }
1278
1279         g_mutex_lock(&scpi->scpi_mutex);
1280
1281         /* Select channel. */
1282         channel_cmd = sr_scpi_cmd_get(cmdtable, channel_command);
1283         if (channel_cmd && channel_name &&
1284                         g_strcmp0(channel_name, scpi->actual_channel_name)) {
1285                 sr_spew("sr_scpi_cmd(): new channel = %s", channel_name);
1286                 g_free(scpi->actual_channel_name);
1287                 scpi->actual_channel_name = g_strdup(channel_name);
1288                 ret = scpi_send(scpi, channel_cmd, channel_name);
1289                 if (ret != SR_OK)
1290                         return ret;
1291         }
1292
1293         va_start(args, command);
1294         ret = scpi_send_variadic(scpi, cmd, args);
1295         va_end(args);
1296
1297         g_mutex_unlock(&scpi->scpi_mutex);
1298
1299         return ret;
1300 }
1301
1302 SR_PRIV int sr_scpi_cmd_resp(const struct sr_dev_inst *sdi,
1303                 const struct scpi_command *cmdtable,
1304                 int channel_command, const char *channel_name,
1305                 GVariant **gvar, const GVariantType *gvtype, int command, ...)
1306 {
1307         struct sr_scpi_dev_inst *scpi;
1308         va_list args;
1309         const char *channel_cmd;
1310         const char *cmd;
1311         GString *response;
1312         char *s;
1313         gboolean b;
1314         double d;
1315         int ret;
1316
1317         scpi = sdi->conn;
1318
1319         if (!(cmd = sr_scpi_cmd_get(cmdtable, command))) {
1320                 /* Device does not implement this command. */
1321                 return SR_ERR_NA;
1322         }
1323
1324         g_mutex_lock(&scpi->scpi_mutex);
1325
1326         /* Select channel. */
1327         channel_cmd = sr_scpi_cmd_get(cmdtable, channel_command);
1328         if (channel_cmd && channel_name &&
1329                         g_strcmp0(channel_name, scpi->actual_channel_name)) {
1330                 sr_spew("sr_scpi_cmd_get(): new channel = %s", channel_name);
1331                 g_free(scpi->actual_channel_name);
1332                 scpi->actual_channel_name = g_strdup(channel_name);
1333                 ret = scpi_send(scpi, channel_cmd, channel_name);
1334                 if (ret != SR_OK)
1335                         return ret;
1336         }
1337
1338         va_start(args, command);
1339         ret = scpi_send_variadic(scpi, cmd, args);
1340         va_end(args);
1341         if (ret != SR_OK) {
1342                 g_mutex_unlock(&scpi->scpi_mutex);
1343                 return ret;
1344         }
1345
1346         response = g_string_sized_new(1024);
1347         ret = scpi_get_data(scpi, NULL, &response);
1348         if (ret != SR_OK) {
1349                 g_mutex_unlock(&scpi->scpi_mutex);
1350                 if (response)
1351                         g_string_free(response, TRUE);
1352                 return ret;
1353         }
1354
1355         g_mutex_unlock(&scpi->scpi_mutex);
1356
1357         /* Get rid of trailing linefeed if present */
1358         if (response->len >= 1 && response->str[response->len - 1] == '\n')
1359                 g_string_truncate(response, response->len - 1);
1360
1361         /* Get rid of trailing carriage return if present */
1362         if (response->len >= 1 && response->str[response->len - 1] == '\r')
1363                 g_string_truncate(response, response->len - 1);
1364
1365         s = g_string_free(response, FALSE);
1366
1367         ret = SR_OK;
1368         if (g_variant_type_equal(gvtype, G_VARIANT_TYPE_BOOLEAN)) {
1369                 if ((ret = parse_strict_bool(s, &b)) == SR_OK)
1370                         *gvar = g_variant_new_boolean(b);
1371         } else if (g_variant_type_equal(gvtype, G_VARIANT_TYPE_DOUBLE)) {
1372                 if ((ret = sr_atod_ascii(s, &d)) == SR_OK)
1373                         *gvar = g_variant_new_double(d);
1374         } else if (g_variant_type_equal(gvtype, G_VARIANT_TYPE_STRING)) {
1375                 *gvar = g_variant_new_string(s);
1376         } else {
1377                 sr_err("Unable to convert to desired GVariant type.");
1378                 ret = SR_ERR_NA;
1379         }
1380
1381         g_free(s);
1382
1383         return ret;
1384 }