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