]> sigrok.org Git - libsigrok.git/blob - src/scpi/scpi.c
Introduce standard cleanup helper
[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  *
6  * This program is free software: you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation, either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
18  */
19
20 #include <config.h>
21 #include <glib.h>
22 #include <string.h>
23 #include <libsigrok/libsigrok.h>
24 #include "libsigrok-internal.h"
25 #include "scpi.h"
26
27 #define LOG_PREFIX "scpi"
28
29 #define SCPI_READ_RETRIES 100
30 #define SCPI_READ_RETRY_TIMEOUT_US (10 * 1000)
31
32 /**
33  * Parse a string representation of a boolean-like value into a gboolean.
34  * Similar to sr_parse_boolstring but rejects strings which do not represent
35  * a boolean-like value.
36  *
37  * @param str String to convert.
38  * @param ret Pointer to a gboolean where the result of the conversion will be
39  * stored.
40  *
41  * @return SR_OK on success, SR_ERR on failure.
42  */
43 static int parse_strict_bool(const char *str, gboolean *ret)
44 {
45         if (!str)
46                 return SR_ERR_ARG;
47
48         if (!g_strcmp0(str, "1") ||
49             !g_ascii_strncasecmp(str, "y", 1) ||
50             !g_ascii_strncasecmp(str, "t", 1) ||
51             !g_ascii_strncasecmp(str, "yes", 3) ||
52             !g_ascii_strncasecmp(str, "true", 4) ||
53             !g_ascii_strncasecmp(str, "on", 2)) {
54                 *ret = TRUE;
55                 return SR_OK;
56         } else if (!g_strcmp0(str, "0") ||
57                    !g_ascii_strncasecmp(str, "n", 1) ||
58                    !g_ascii_strncasecmp(str, "f", 1) ||
59                    !g_ascii_strncasecmp(str, "no", 2) ||
60                    !g_ascii_strncasecmp(str, "false", 5) ||
61                    !g_ascii_strncasecmp(str, "off", 3)) {
62                 *ret = FALSE;
63                 return SR_OK;
64         }
65
66         return SR_ERR;
67 }
68
69 SR_PRIV extern const struct sr_scpi_dev_inst scpi_serial_dev;
70 SR_PRIV extern const struct sr_scpi_dev_inst scpi_tcp_raw_dev;
71 SR_PRIV extern const struct sr_scpi_dev_inst scpi_tcp_rigol_dev;
72 SR_PRIV extern const struct sr_scpi_dev_inst scpi_usbtmc_libusb_dev;
73 SR_PRIV extern const struct sr_scpi_dev_inst scpi_vxi_dev;
74 SR_PRIV extern const struct sr_scpi_dev_inst scpi_visa_dev;
75 SR_PRIV extern const struct sr_scpi_dev_inst scpi_libgpib_dev;
76
77 static const struct sr_scpi_dev_inst *scpi_devs[] = {
78         &scpi_tcp_raw_dev,
79         &scpi_tcp_rigol_dev,
80 #ifdef HAVE_LIBUSB_1_0
81         &scpi_usbtmc_libusb_dev,
82 #endif
83 #if HAVE_RPC
84         &scpi_vxi_dev,
85 #endif
86 #ifdef HAVE_LIBREVISA
87         &scpi_visa_dev,
88 #endif
89 #ifdef HAVE_LIBGPIB
90         &scpi_libgpib_dev,
91 #endif
92 #ifdef HAVE_LIBSERIALPORT
93         &scpi_serial_dev,  /* must be last as it matches any resource */
94 #endif
95 };
96
97 static struct sr_dev_inst *sr_scpi_scan_resource(struct drv_context *drvc,
98                 const char *resource, const char *serialcomm,
99                 struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi))
100 {
101         struct sr_scpi_dev_inst *scpi;
102         struct sr_dev_inst *sdi;
103
104         if (!(scpi = scpi_dev_inst_new(drvc, resource, serialcomm)))
105                 return NULL;
106
107         if (sr_scpi_open(scpi) != SR_OK) {
108                 sr_info("Couldn't open SCPI device.");
109                 sr_scpi_free(scpi);
110                 return NULL;
111         };
112
113         sdi = probe_device(scpi);
114
115         sr_scpi_close(scpi);
116
117         if (sdi)
118                 sdi->status = SR_ST_INACTIVE;
119         else
120                 sr_scpi_free(scpi);
121
122         return sdi;
123 }
124
125 SR_PRIV GSList *sr_scpi_scan(struct drv_context *drvc, GSList *options,
126                 struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi))
127 {
128         GSList *resources, *l, *devices;
129         struct sr_dev_inst *sdi;
130         const char *resource = NULL;
131         const char *serialcomm = NULL;
132         gchar **res;
133         unsigned i;
134
135         for (l = options; l; l = l->next) {
136                 struct sr_config *src = l->data;
137                 switch (src->key) {
138                 case SR_CONF_CONN:
139                         resource = g_variant_get_string(src->data, NULL);
140                         break;
141                 case SR_CONF_SERIALCOMM:
142                         serialcomm = g_variant_get_string(src->data, NULL);
143                         break;
144                 }
145         }
146
147         devices = NULL;
148         for (i = 0; i < ARRAY_SIZE(scpi_devs); i++) {
149                 if ((resource && strcmp(resource, scpi_devs[i]->prefix))
150                     || !scpi_devs[i]->scan)
151                         continue;
152                 resources = scpi_devs[i]->scan(drvc);
153                 for (l = resources; l; l = l->next) {
154                         res = g_strsplit(l->data, ":", 2);
155                         if (res[0] && (sdi = sr_scpi_scan_resource(drvc, res[0],
156                                        serialcomm ? serialcomm : res[1], probe_device))) {
157                                 devices = g_slist_append(devices, sdi);
158                                 sdi->connection_id = g_strdup(l->data);
159                         }
160                         g_strfreev(res);
161                 }
162                 g_slist_free_full(resources, g_free);
163         }
164
165         if (!devices && resource) {
166                 sdi = sr_scpi_scan_resource(drvc, resource, serialcomm, probe_device);
167                 if (sdi)
168                         devices = g_slist_append(NULL, sdi);
169         }
170
171         /* Tack a copy of the newly found devices onto the driver list. */
172         if (devices)
173                 drvc->instances = g_slist_concat(drvc->instances, g_slist_copy(devices));
174
175         return devices;
176 }
177
178 SR_PRIV struct sr_scpi_dev_inst *scpi_dev_inst_new(struct drv_context *drvc,
179                 const char *resource, const char *serialcomm)
180 {
181         struct sr_scpi_dev_inst *scpi = NULL;
182         const struct sr_scpi_dev_inst *scpi_dev;
183         gchar **params;
184         unsigned i;
185
186         for (i = 0; i < ARRAY_SIZE(scpi_devs); i++) {
187                 scpi_dev = scpi_devs[i];
188                 if (!strncmp(resource, scpi_dev->prefix, strlen(scpi_dev->prefix))) {
189                         sr_dbg("Opening %s device %s.", scpi_dev->name, resource);
190                         scpi = g_malloc(sizeof(*scpi));
191                         *scpi = *scpi_dev;
192                         scpi->priv = g_malloc0(scpi->priv_size);
193                         scpi->read_timeout_ms = 1000;
194                         params = g_strsplit(resource, "/", 0);
195                         if (scpi->dev_inst_new(scpi->priv, drvc, resource,
196                                                params, serialcomm) != SR_OK) {
197                                 sr_scpi_free(scpi);
198                                 scpi = NULL;
199                         }
200                         g_strfreev(params);
201                         break;
202                 }
203         }
204
205         return scpi;
206 }
207
208 /**
209  * Open SCPI device.
210  *
211  * @param scpi Previously initialized SCPI device structure.
212  *
213  * @return SR_OK on success, SR_ERR on failure.
214  */
215 SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi)
216 {
217         return scpi->open(scpi);
218 }
219
220 /**
221  * Add an event source for an SCPI device.
222  *
223  * @param session The session to add the event source to.
224  * @param scpi Previously initialized SCPI device structure.
225  * @param events Events to check for.
226  * @param timeout Max time to wait before the callback is called, ignored if 0.
227  * @param cb Callback function to add. Must not be NULL.
228  * @param cb_data Data for the callback function. Can be NULL.
229  *
230  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
231  *         SR_ERR_MALLOC upon memory allocation errors.
232  */
233 SR_PRIV int sr_scpi_source_add(struct sr_session *session,
234                 struct sr_scpi_dev_inst *scpi, int events, int timeout,
235                 sr_receive_data_callback cb, void *cb_data)
236 {
237         return scpi->source_add(session, scpi->priv, events, timeout, cb, cb_data);
238 }
239
240 /**
241  * Remove event source for an SCPI device.
242  *
243  * @param session The session to remove the event source from.
244  * @param scpi Previously initialized SCPI device structure.
245  *
246  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
247  *         SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
248  *         internal errors.
249  */
250 SR_PRIV int sr_scpi_source_remove(struct sr_session *session,
251                 struct sr_scpi_dev_inst *scpi)
252 {
253         return scpi->source_remove(session, scpi->priv);
254 }
255
256 /**
257  * Send a SCPI command.
258  *
259  * @param scpi Previously initialized SCPI device structure.
260  * @param format Format string, to be followed by any necessary arguments.
261  *
262  * @return SR_OK on success, SR_ERR on failure.
263  */
264 SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi,
265                          const char *format, ...)
266 {
267         va_list args;
268         int ret;
269
270         va_start(args, format);
271         ret = sr_scpi_send_variadic(scpi, format, args);
272         va_end(args);
273
274         return ret;
275 }
276
277 /**
278  * Send a SCPI command with a variadic argument list.
279  *
280  * @param scpi Previously initialized SCPI device structure.
281  * @param format Format string.
282  * @param args Argument list.
283  *
284  * @return SR_OK on success, SR_ERR on failure.
285  */
286 SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
287                          const char *format, va_list args)
288 {
289         va_list args_copy;
290         char *buf;
291         int len, ret;
292
293         /* Get length of buffer required. */
294         va_copy(args_copy, args);
295         len = vsnprintf(NULL, 0, format, args_copy);
296         va_end(args_copy);
297
298         /* Allocate buffer and write out command. */
299         buf = g_malloc0(len + 2);
300         vsprintf(buf, format, args);
301         if (buf[len - 1] != '\n')
302                 buf[len] = '\n';
303
304         /* Send command. */
305         ret = scpi->send(scpi->priv, buf);
306
307         /* Free command buffer. */
308         g_free(buf);
309
310         return ret;
311 }
312
313 /**
314  * Begin receiving an SCPI reply.
315  *
316  * @param scpi Previously initialised SCPI device structure.
317  *
318  * @return SR_OK on success, SR_ERR on failure.
319  */
320 SR_PRIV int sr_scpi_read_begin(struct sr_scpi_dev_inst *scpi)
321 {
322         return scpi->read_begin(scpi->priv);
323 }
324
325 /**
326  * Read part of a response from SCPI device.
327  *
328  * @param scpi Previously initialised SCPI device structure.
329  * @param buf Buffer to store result.
330  * @param maxlen Maximum number of bytes to read.
331  *
332  * @return Number of bytes read, or SR_ERR upon failure.
333  */
334 SR_PRIV int sr_scpi_read_data(struct sr_scpi_dev_inst *scpi,
335                         char *buf, int maxlen)
336 {
337         return scpi->read_data(scpi->priv, buf, maxlen);
338 }
339
340 /**
341  * Check whether a complete SCPI response has been received.
342  *
343  * @param scpi Previously initialised SCPI device structure.
344  *
345  * @return 1 if complete, 0 otherwise.
346  */
347 SR_PRIV int sr_scpi_read_complete(struct sr_scpi_dev_inst *scpi)
348 {
349         return scpi->read_complete(scpi->priv);
350 }
351
352 /**
353  * Close SCPI device.
354  *
355  * @param scpi Previously initialized SCPI device structure.
356  *
357  * @return SR_OK on success, SR_ERR on failure.
358  */
359 SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi)
360 {
361         return scpi->close(scpi);
362 }
363
364 /**
365  * Free SCPI device.
366  *
367  * @param scpi Previously initialized SCPI device structure.
368  *
369  * @return SR_OK on success, SR_ERR on failure.
370  */
371 SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi)
372 {
373         scpi->free(scpi->priv);
374         g_free(scpi->priv);
375         g_free(scpi);
376 }
377
378 /**
379  * Send a SCPI command, receive the reply and store the reply in scpi_response.
380  *
381  * @param scpi Previously initialised SCPI device structure.
382  * @param command The SCPI command to send to the device (can be NULL).
383  * @param scpi_response Pointer where to store the SCPI response.
384  *
385  * @return SR_OK on success, SR_ERR* on failure.
386  */
387 SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
388                                const char *command, char **scpi_response)
389 {
390         char buf[256];
391         int len;
392         GString *response;
393         gint64 laststart;
394         unsigned int elapsed_ms;
395
396         if (command)
397                 if (sr_scpi_send(scpi, command) != SR_OK)
398                         return SR_ERR;
399
400         if (sr_scpi_read_begin(scpi) != SR_OK)
401                 return SR_ERR;
402
403         laststart = g_get_monotonic_time();
404
405         response = g_string_new("");
406
407         *scpi_response = NULL;
408
409         while (!sr_scpi_read_complete(scpi)) {
410                 len = sr_scpi_read_data(scpi, buf, sizeof(buf));
411                 if (len < 0) {
412                         sr_err("Incompletely read SCPI response.");
413                         g_string_free(response, TRUE);
414                         return SR_ERR;
415                 } else if (len > 0) {
416                         laststart = g_get_monotonic_time();
417                 }
418                 g_string_append_len(response, buf, len);
419                 elapsed_ms = (g_get_monotonic_time() - laststart) / 1000;
420                 if (elapsed_ms >= scpi->read_timeout_ms) {
421                         sr_err("Timed out waiting for SCPI response.");
422                         g_string_free(response, TRUE);
423                         return SR_ERR;
424                 }
425         }
426
427         /* Get rid of trailing linefeed if present */
428         if (response->len >= 1 && response->str[response->len - 1] == '\n')
429                 g_string_truncate(response, response->len - 1);
430
431         /* Get rid of trailing carriage return if present */
432         if (response->len >= 1 && response->str[response->len - 1] == '\r')
433                 g_string_truncate(response, response->len - 1);
434
435         sr_spew("Got response: '%.70s', length %" G_GSIZE_FORMAT ".",
436                 response->str, response->len);
437
438         *scpi_response = g_string_free(response, FALSE);
439
440         return SR_OK;
441 }
442
443 /**
444  * Send a SCPI command, read the reply, parse it as a bool value and store the
445  * result in scpi_response.
446  *
447  * @param scpi Previously initialised SCPI device structure.
448  * @param command The SCPI command to send to the device (can be NULL).
449  * @param scpi_response Pointer where to store the parsed result.
450  *
451  * @return SR_OK on success, SR_ERR* on failure.
452  */
453 SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
454                              const char *command, gboolean *scpi_response)
455 {
456         int ret;
457         char *response;
458
459         response = NULL;
460
461         ret = sr_scpi_get_string(scpi, command, &response);
462         if (ret != SR_OK && !response)
463                 return ret;
464
465         if (parse_strict_bool(response, scpi_response) == SR_OK)
466                 ret = SR_OK;
467         else
468                 ret = SR_ERR_DATA;
469
470         g_free(response);
471
472         return ret;
473 }
474
475 /**
476  * Send a SCPI command, read the reply, parse it as an integer and store the
477  * result in scpi_response.
478  *
479  * @param scpi Previously initialised SCPI device structure.
480  * @param command The SCPI command to send to the device (can be NULL).
481  * @param scpi_response Pointer where to store the parsed result.
482  *
483  * @return SR_OK on success, SR_ERR* on failure.
484  */
485 SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
486                             const char *command, int *scpi_response)
487 {
488         int ret;
489         char *response;
490
491         response = NULL;
492
493         ret = sr_scpi_get_string(scpi, command, &response);
494         if (ret != SR_OK && !response)
495                 return ret;
496
497         if (sr_atoi(response, scpi_response) == SR_OK)
498                 ret = SR_OK;
499         else
500                 ret = SR_ERR_DATA;
501
502         g_free(response);
503
504         return ret;
505 }
506
507 /**
508  * Send a SCPI command, read the reply, parse it as a float and store the
509  * result in scpi_response.
510  *
511  * @param scpi Previously initialised SCPI device structure.
512  * @param command The SCPI command to send to the device (can be NULL).
513  * @param scpi_response Pointer where to store the parsed result.
514  *
515  * @return SR_OK on success, SR_ERR* on failure.
516  */
517 SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
518                               const char *command, float *scpi_response)
519 {
520         int ret;
521         char *response;
522
523         response = NULL;
524
525         ret = sr_scpi_get_string(scpi, command, &response);
526         if (ret != SR_OK && !response)
527                 return ret;
528
529         if (sr_atof_ascii(response, scpi_response) == SR_OK)
530                 ret = SR_OK;
531         else
532                 ret = SR_ERR_DATA;
533
534         g_free(response);
535
536         return ret;
537 }
538
539 /**
540  * Send a SCPI command, read the reply, parse it as a double and store the
541  * result in scpi_response.
542  *
543  * @param scpi Previously initialised SCPI device structure.
544  * @param command The SCPI command to send to the device (can be NULL).
545  * @param scpi_response Pointer where to store the parsed result.
546  *
547  * @return SR_OK on success, SR_ERR* on failure.
548  */
549 SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
550                                const char *command, double *scpi_response)
551 {
552         int ret;
553         char *response;
554
555         response = NULL;
556
557         ret = sr_scpi_get_string(scpi, command, &response);
558         if (ret != SR_OK && !response)
559                 return ret;
560
561         if (sr_atod(response, scpi_response) == SR_OK)
562                 ret = SR_OK;
563         else
564                 ret = SR_ERR_DATA;
565
566         g_free(response);
567
568         return ret;
569 }
570
571 /**
572  * Send a SCPI *OPC? command, read the reply and return the result of the
573  * command.
574  *
575  * @param scpi Previously initialised SCPI device structure.
576  *
577  * @return SR_OK on success, SR_ERR* on failure.
578  */
579 SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi)
580 {
581         unsigned int i;
582         gboolean opc;
583
584         for (i = 0; i < SCPI_READ_RETRIES; i++) {
585                 sr_scpi_get_bool(scpi, SCPI_CMD_OPC, &opc);
586                 if (opc)
587                         return SR_OK;
588                 g_usleep(SCPI_READ_RETRY_TIMEOUT_US);
589         }
590
591         return SR_ERR;
592 }
593
594 /**
595  * Send a SCPI command, read the reply, parse it as comma separated list of
596  * floats and store the as an result in scpi_response.
597  *
598  * @param scpi Previously initialised SCPI device structure.
599  * @param command The SCPI command to send to the device (can be NULL).
600  * @param scpi_response Pointer where to store the parsed result.
601  *
602  * @return SR_OK upon successfully parsing all values, SR_ERR* upon a parsing
603  *         error or upon no response. The allocated response must be freed by
604  *         the caller in the case of an SR_OK as well as in the case of
605  *         parsing error.
606  */
607 SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
608                                const char *command, GArray **scpi_response)
609 {
610         int ret;
611         float tmp;
612         char *response;
613         gchar **ptr, **tokens;
614         GArray *response_array;
615
616         response = NULL;
617         tokens = NULL;
618
619         ret = sr_scpi_get_string(scpi, command, &response);
620         if (ret != SR_OK && !response)
621                 return ret;
622
623         tokens = g_strsplit(response, ",", 0);
624         ptr = tokens;
625
626         response_array = g_array_sized_new(TRUE, FALSE, sizeof(float), 256);
627
628         while (*ptr) {
629                 if (sr_atof_ascii(*ptr, &tmp) == SR_OK)
630                         response_array = g_array_append_val(response_array,
631                                                             tmp);
632                 else
633                         ret = SR_ERR_DATA;
634
635                 ptr++;
636         }
637         g_strfreev(tokens);
638         g_free(response);
639
640         if (ret != SR_OK && response_array->len == 0) {
641                 g_array_free(response_array, TRUE);
642                 *scpi_response = NULL;
643                 return SR_ERR_DATA;
644         }
645
646         *scpi_response = response_array;
647
648         return ret;
649 }
650
651 /**
652  * Send a SCPI command, read the reply, parse it as comma separated list of
653  * unsigned 8 bit integers and store the as an result in scpi_response.
654  *
655  * @param scpi Previously initialised SCPI device structure.
656  * @param command The SCPI command to send to the device (can be NULL).
657  * @param scpi_response Pointer where to store the parsed result.
658  *
659  * @return SR_OK upon successfully parsing all values, SR_ERR* upon a parsing
660  *         error or upon no response. The allocated response must be freed by
661  *         the caller in the case of an SR_OK as well as in the case of
662  *         parsing error.
663  */
664 SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
665                                const char *command, GArray **scpi_response)
666 {
667         int tmp, ret;
668         char *response;
669         gchar **ptr, **tokens;
670         GArray *response_array;
671
672         response = NULL;
673         tokens = NULL;
674
675         ret = sr_scpi_get_string(scpi, command, &response);
676         if (ret != SR_OK && !response)
677                 return ret;
678
679         tokens = g_strsplit(response, ",", 0);
680         ptr = tokens;
681
682         response_array = g_array_sized_new(TRUE, FALSE, sizeof(uint8_t), 256);
683
684         while (*ptr) {
685                 if (sr_atoi(*ptr, &tmp) == SR_OK)
686                         response_array = g_array_append_val(response_array,
687                                                             tmp);
688                 else
689                         ret = SR_ERR_DATA;
690
691                 ptr++;
692         }
693         g_strfreev(tokens);
694         g_free(response);
695
696         if (response_array->len == 0) {
697                 g_array_free(response_array, TRUE);
698                 *scpi_response = NULL;
699                 return SR_ERR_DATA;
700         }
701
702         *scpi_response = response_array;
703
704         return ret;
705 }
706
707 /**
708  * Send the *IDN? SCPI command, receive the reply, parse it and store the
709  * reply as a sr_scpi_hw_info structure in the supplied scpi_response pointer.
710  *
711  * The hw_info structure must be freed by the caller via sr_scpi_hw_info_free().
712  *
713  * @param scpi Previously initialised SCPI device structure.
714  * @param scpi_response Pointer where to store the hw_info structure.
715  *
716  * @return SR_OK upon success, SR_ERR* on failure.
717  */
718 SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
719                               struct sr_scpi_hw_info **scpi_response)
720 {
721         int num_tokens, ret;
722         char *response;
723         gchar **tokens;
724         struct sr_scpi_hw_info *hw_info;
725
726         response = NULL;
727         tokens = NULL;
728
729         ret = sr_scpi_get_string(scpi, SCPI_CMD_IDN, &response);
730         if (ret != SR_OK && !response)
731                 return ret;
732
733         sr_info("Got IDN string: '%s'", response);
734
735         /*
736          * The response to a '*IDN?' is specified by the SCPI spec. It contains
737          * a comma-separated list containing the manufacturer name, instrument
738          * model, serial number of the instrument and the firmware version.
739          */
740         tokens = g_strsplit(response, ",", 0);
741
742         for (num_tokens = 0; tokens[num_tokens] != NULL; num_tokens++);
743
744         if (num_tokens < 4) {
745                 sr_dbg("IDN response not according to spec: %80.s.", response);
746                 g_strfreev(tokens);
747                 g_free(response);
748                 return SR_ERR_DATA;
749         }
750         g_free(response);
751
752         hw_info = g_malloc0(sizeof(struct sr_scpi_hw_info));
753         hw_info->manufacturer = g_strstrip(g_strdup(tokens[0]));
754         hw_info->model = g_strstrip(g_strdup(tokens[1]));
755         hw_info->serial_number = g_strstrip(g_strdup(tokens[2]));
756         hw_info->firmware_version = g_strstrip(g_strdup(tokens[3]));
757
758         g_strfreev(tokens);
759
760         *scpi_response = hw_info;
761
762         return SR_OK;
763 }
764
765 /**
766  * Free a sr_scpi_hw_info struct.
767  *
768  * @param hw_info Pointer to the struct to free.
769  *
770  * This function is safe to call with a NULL pointer.
771  */
772 SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info)
773 {
774         if (hw_info) {
775                 g_free(hw_info->manufacturer);
776                 g_free(hw_info->model);
777                 g_free(hw_info->serial_number);
778                 g_free(hw_info->firmware_version);
779                 g_free(hw_info);
780         }
781 }