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