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