src/scpi/scpi.c

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