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