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         sdi = probe_device(scpi);
 114
 115         sr_scpi_close(scpi);
 116
 117         if (sdi)
 118                 sdi->status = SR_ST_INACTIVE;
 119         else
 120                 sr_scpi_free(scpi);
 121
 122         return sdi;
 123 }
 124
 125 SR_PRIV GSList *sr_scpi_scan(struct drv_context *drvc, GSList *options,
 126                 struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi))
 127 {
 128         GSList *resources, *l, *devices;
 129         struct sr_dev_inst *sdi;
 130         const char *resource = NULL;
 131         const char *serialcomm = NULL;
 132         gchar **res;
 133         unsigned i;
 134
 135         for (l = options; l; l = l->next) {
 136                 struct sr_config *src = l->data;
 137                 switch (src->key) {
 138                 case SR_CONF_CONN:
 139                         resource = g_variant_get_string(src->data, NULL);
 140                         break;
 141                 case SR_CONF_SERIALCOMM:
 142                         serialcomm = g_variant_get_string(src->data, NULL);
 143                         break;
 144                 }
 145         }
 146
 147         devices = NULL;
 148         for (i = 0; i < ARRAY_SIZE(scpi_devs); i++) {
 149                 if ((resource && strcmp(resource, scpi_devs[i]->prefix))
 150                     || !scpi_devs[i]->scan)
 151                         continue;
 152                 resources = scpi_devs[i]->scan(drvc);
 153                 for (l = resources; l; l = l->next) {
 154                         res = g_strsplit(l->data, ":", 2);
 155                         if (res[0] && (sdi = sr_scpi_scan_resource(drvc, res[0],
 156                                        serialcomm ? serialcomm : res[1], probe_device))) {
 157                                 devices = g_slist_append(devices, sdi);
 158                                 sdi->connection_id = g_strdup(l->data);
 159                         }
 160                         g_strfreev(res);
 161                 }
 162                 g_slist_free_full(resources, g_free);
 163         }
 164
 165         if (!devices && resource) {
 166                 sdi = sr_scpi_scan_resource(drvc, resource, serialcomm, probe_device);
 167                 if (sdi)
 168                         devices = g_slist_append(NULL, sdi);
 169         }
 170
 171         /* Tack a copy of the newly found devices onto the driver list. */
 172         if (devices)
 173                 drvc->instances = g_slist_concat(drvc->instances, g_slist_copy(devices));
 174
 175         return devices;
 176 }
 177
 178 SR_PRIV struct sr_scpi_dev_inst *scpi_dev_inst_new(struct drv_context *drvc,
 179                 const char *resource, const char *serialcomm)
 180 {
 181         struct sr_scpi_dev_inst *scpi = NULL;
 182         const struct sr_scpi_dev_inst *scpi_dev;
 183         gchar **params;
 184         unsigned i;
 185
 186         for (i = 0; i < ARRAY_SIZE(scpi_devs); i++) {
 187                 scpi_dev = scpi_devs[i];
 188                 if (!strncmp(resource, scpi_dev->prefix, strlen(scpi_dev->prefix))) {
 189                         sr_dbg("Opening %s device %s.", scpi_dev->name, resource);
 190                         scpi = g_malloc(sizeof(*scpi));
 191                         *scpi = *scpi_dev;
 192                         scpi->priv = g_malloc0(scpi->priv_size);
 193                         scpi->read_timeout_us = 1000 * 1000;
 194                         params = g_strsplit(resource, "/", 0);
 195                         if (scpi->dev_inst_new(scpi->priv, drvc, resource,
 196                                                params, serialcomm) != SR_OK) {
 197                                 sr_scpi_free(scpi);
 198                                 scpi = NULL;
 199                         }
 200                         g_strfreev(params);
 201                         break;
 202                 }
 203         }
 204
 205         return scpi;
 206 }
 207
 208 /**
 209  * Open SCPI device.
 210  *
 211  * @param scpi Previously initialized SCPI device structure.
 212  *
 213  * @return SR_OK on success, SR_ERR on failure.
 214  */
 215 SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi)
 216 {
 217         return scpi->open(scpi);
 218 }
 219
 220 /**
 221  * Add an event source for an SCPI device.
 222  *
 223  * @param session The session to add the event source to.
 224  * @param scpi Previously initialized SCPI device structure.
 225  * @param events Events to check for.
 226  * @param timeout Max time to wait before the callback is called, ignored if 0.
 227  * @param cb Callback function to add. Must not be NULL.
 228  * @param cb_data Data for the callback function. Can be NULL.
 229  *
 230  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
 231  *         SR_ERR_MALLOC upon memory allocation errors.
 232  */
 233 SR_PRIV int sr_scpi_source_add(struct sr_session *session,
 234                 struct sr_scpi_dev_inst *scpi, int events, int timeout,
 235                 sr_receive_data_callback cb, void *cb_data)
 236 {
 237         return scpi->source_add(session, scpi->priv, events, timeout, cb, cb_data);
 238 }
 239
 240 /**
 241  * Remove event source for an SCPI device.
 242  *
 243  * @param session The session to remove the event source from.
 244  * @param scpi Previously initialized SCPI device structure.
 245  *
 246  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
 247  *         SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
 248  *         internal errors.
 249  */
 250 SR_PRIV int sr_scpi_source_remove(struct sr_session *session,
 251                 struct sr_scpi_dev_inst *scpi)
 252 {
 253         return scpi->source_remove(session, scpi->priv);
 254 }
 255
 256 /**
 257  * Send a SCPI command.
 258  *
 259  * @param scpi Previously initialized SCPI device structure.
 260  * @param format Format string, to be followed by any necessary arguments.
 261  *
 262  * @return SR_OK on success, SR_ERR on failure.
 263  */
 264 SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi,
 265                          const char *format, ...)
 266 {
 267         va_list args;
 268         int ret;
 269
 270         va_start(args, format);
 271         ret = sr_scpi_send_variadic(scpi, format, args);
 272         va_end(args);
 273
 274         return ret;
 275 }
 276
 277 /**
 278  * Send a SCPI command with a variadic argument list.
 279  *
 280  * @param scpi Previously initialized SCPI device structure.
 281  * @param format Format string.
 282  * @param args Argument list.
 283  *
 284  * @return SR_OK on success, SR_ERR on failure.
 285  */
 286 SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
 287                          const char *format, va_list args)
 288 {
 289         va_list args_copy;
 290         char *buf;
 291         int len, ret;
 292
 293         /* Get length of buffer required. */
 294         va_copy(args_copy, args);
 295         len = vsnprintf(NULL, 0, format, args_copy);
 296         va_end(args_copy);
 297
 298         /* Allocate buffer and write out command. */
 299         buf = g_malloc0(len + 2);
 300         vsprintf(buf, format, args);
 301         if (buf[len - 1] != '\n')
 302                 buf[len] = '\n';
 303
 304         /* Send command. */
 305         ret = scpi->send(scpi->priv, buf);
 306
 307         /* Free command buffer. */
 308         g_free(buf);
 309
 310         return ret;
 311 }
 312
 313 /**
 314  * Begin receiving an SCPI reply.
 315  *
 316  * @param scpi Previously initialised SCPI device structure.
 317  *
 318  * @return SR_OK on success, SR_ERR on failure.
 319  */
 320 SR_PRIV int sr_scpi_read_begin(struct sr_scpi_dev_inst *scpi)
 321 {
 322         return scpi->read_begin(scpi->priv);
 323 }
 324
 325 /**
 326  * Read part of a response from SCPI device.
 327  *
 328  * @param scpi Previously initialised SCPI device structure.
 329  * @param buf Buffer to store result.
 330  * @param maxlen Maximum number of bytes to read.
 331  *
 332  * @return Number of bytes read, or SR_ERR upon failure.
 333  */
 334 SR_PRIV int sr_scpi_read_data(struct sr_scpi_dev_inst *scpi,
 335                         char *buf, int maxlen)
 336 {
 337         return scpi->read_data(scpi->priv, buf, maxlen);
 338 }
 339
 340 /**
 341  * Send data to SCPI device.
 342  *
 343  * @param scpi Previously initialised SCPI device structure.
 344  * @param buf Buffer with data to send.
 345  * @param len Number of bytes to send.
 346  *
 347  * @return Number of bytes read, or SR_ERR upon failure.
 348  */
 349 SR_PRIV int sr_scpi_write_data(struct sr_scpi_dev_inst *scpi,
 350                         char *buf, int maxlen)
 351 {
 352         return scpi->write_data(scpi->priv, buf, maxlen);
 353 }
 354
 355 /**
 356  * Check whether a complete SCPI response has been received.
 357  *
 358  * @param scpi Previously initialised SCPI device structure.
 359  *
 360  * @return 1 if complete, 0 otherwise.
 361  */
 362 SR_PRIV int sr_scpi_read_complete(struct sr_scpi_dev_inst *scpi)
 363 {
 364         return scpi->read_complete(scpi->priv);
 365 }
 366
 367 /**
 368  * Close SCPI device.
 369  *
 370  * @param scpi Previously initialized SCPI device structure.
 371  *
 372  * @return SR_OK on success, SR_ERR on failure.
 373  */
 374 SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi)
 375 {
 376         return scpi->close(scpi);
 377 }
 378
 379 /**
 380  * Free SCPI device.
 381  *
 382  * @param scpi Previously initialized SCPI device structure. If NULL,
 383  *             this function does nothing.
 384  */
 385 SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi)
 386 {
 387         if (!scpi)
 388                 return;
 389
 390         scpi->free(scpi->priv);
 391         g_free(scpi->priv);
 392         g_free(scpi);
 393 }
 394
 395 /**
 396  * Send a SCPI command, receive the reply and store the reply in scpi_response.
 397  *
 398  * @param scpi Previously initialised SCPI device structure.
 399  * @param command The SCPI command to send to the device (can be NULL).
 400  * @param scpi_response Pointer where to store the SCPI response.
 401  *
 402  * @return SR_OK on success, SR_ERR* on failure.
 403  */
 404 SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
 405                                const char *command, char **scpi_response)
 406 {
 407         GString *response;
 408         response = g_string_sized_new(1024);
 409
 410         if (sr_scpi_get_data(scpi, command, &response) != SR_OK) {
 411                 if (response)
 412                         g_string_free(response, TRUE);
 413                 return SR_ERR;
 414         }
 415
 416         /* Get rid of trailing linefeed if present */
 417         if (response->len >= 1 && response->str[response->len - 1] == '\n')
 418                 g_string_truncate(response, response->len - 1);
 419
 420         /* Get rid of trailing carriage return if present */
 421         if (response->len >= 1 && response->str[response->len - 1] == '\r')
 422                 g_string_truncate(response, response->len - 1);
 423
 424         sr_spew("Got response: '%.70s', length %" G_GSIZE_FORMAT ".",
 425                 response->str, response->len);
 426
 427         *scpi_response = g_string_free(response, FALSE);
 428
 429         return SR_OK;
 430 }
 431
 432 /**
 433  * Do a non-blocking read of up to the allocated length, and
 434  * check if a timeout has occured.
 435  *
 436  * @param scpi Previously initialised SCPI device structure.
 437  * @param response Buffer to which the response is appended.
 438  * @param abs_timeout_us Absolute timeout in microseconds
 439  *
 440  * @return read length on success, SR_ERR* on failure.
 441  */
 442 SR_PRIV int sr_scpi_read_response(struct sr_scpi_dev_inst *scpi,
 443                                   GString *response, gint64 abs_timeout_us)
 444 {
 445         int len, space;
 446
 447         space = response->allocated_len - response->len;
 448         len = sr_scpi_read_data(scpi, &response->str[response->len], space);
 449
 450         if (len < 0) {
 451                 sr_err("Incompletely read SCPI response.");
 452                 return SR_ERR;
 453         }
 454
 455         if (len > 0) {
 456                 g_string_set_size(response, response->len + len);
 457                 return len;
 458         }
 459
 460         if (g_get_monotonic_time() > abs_timeout_us) {
 461                 sr_err("Timed out waiting for SCPI response.");
 462                 return SR_ERR_TIMEOUT;
 463         }
 464
 465         return 0;
 466 }
 467
 468 SR_PRIV int sr_scpi_get_data(struct sr_scpi_dev_inst *scpi,
 469                              const char *command, GString **scpi_response)
 470 {
 471         int ret;
 472         GString *response;
 473         int space;
 474         gint64 timeout;
 475
 476         /* Optionally send caller provided command. */
 477         if (command) {
 478                 if (sr_scpi_send(scpi, command) != SR_OK)
 479                         return SR_ERR;
 480         }
 481
 482         /* Initiate SCPI read operation. */
 483         if (sr_scpi_read_begin(scpi) != SR_OK)
 484                 return SR_ERR;
 485
 486         /* Keep reading until completion or until timeout. */
 487         timeout = g_get_monotonic_time() + scpi->read_timeout_us;
 488
 489         response = *scpi_response;
 490
 491         while (!sr_scpi_read_complete(scpi)) {
 492                 /* Resize the buffer when free space drops below a threshold. */
 493                 space = response->allocated_len - response->len;
 494                 if (space < 128) {
 495                         int oldlen = response->len;
 496                         g_string_set_size(response, oldlen + 1024);
 497                         g_string_set_size(response, oldlen);
 498                 }
 499
 500                 /* Read another chunk of the response. */
 501                 ret = sr_scpi_read_response(scpi, response, timeout);
 502
 503                 if (ret < 0)
 504                         return ret;
 505                 if (ret > 0)
 506                         timeout = g_get_monotonic_time() + scpi->read_timeout_us;
 507         }
 508
 509         return SR_OK;
 510 }
 511
 512 /**
 513  * Send a SCPI command, read the reply, parse it as a bool value and store the
 514  * result in scpi_response.
 515  *
 516  * @param scpi Previously initialised SCPI device structure.
 517  * @param command The SCPI command to send to the device (can be NULL).
 518  * @param scpi_response Pointer where to store the parsed result.
 519  *
 520  * @return SR_OK on success, SR_ERR* on failure.
 521  */
 522 SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
 523                              const char *command, gboolean *scpi_response)
 524 {
 525         int ret;
 526         char *response;
 527
 528         response = NULL;
 529
 530         ret = sr_scpi_get_string(scpi, command, &response);
 531         if (ret != SR_OK && !response)
 532                 return ret;
 533
 534         if (parse_strict_bool(response, scpi_response) == SR_OK)
 535                 ret = SR_OK;
 536         else
 537                 ret = SR_ERR_DATA;
 538
 539         g_free(response);
 540
 541         return ret;
 542 }
 543
 544 /**
 545  * Send a SCPI command, read the reply, parse it as an integer and store the
 546  * result in scpi_response.
 547  *
 548  * @param scpi Previously initialised SCPI device structure.
 549  * @param command The SCPI command to send to the device (can be NULL).
 550  * @param scpi_response Pointer where to store the parsed result.
 551  *
 552  * @return SR_OK on success, SR_ERR* on failure.
 553  */
 554 SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
 555                             const char *command, int *scpi_response)
 556 {
 557         int ret;
 558         char *response;
 559
 560         response = NULL;
 561
 562         ret = sr_scpi_get_string(scpi, command, &response);
 563         if (ret != SR_OK && !response)
 564                 return ret;
 565
 566         if (sr_atoi(response, scpi_response) == SR_OK)
 567                 ret = SR_OK;
 568         else
 569                 ret = SR_ERR_DATA;
 570
 571         g_free(response);
 572
 573         return ret;
 574 }
 575
 576 /**
 577  * Send a SCPI command, read the reply, parse it as a float and store the
 578  * result in scpi_response.
 579  *
 580  * @param scpi Previously initialised SCPI device structure.
 581  * @param command The SCPI command to send to the device (can be NULL).
 582  * @param scpi_response Pointer where to store the parsed result.
 583  *
 584  * @return SR_OK on success, SR_ERR* on failure.
 585  */
 586 SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
 587                               const char *command, float *scpi_response)
 588 {
 589         int ret;
 590         char *response;
 591
 592         response = NULL;
 593
 594         ret = sr_scpi_get_string(scpi, command, &response);
 595         if (ret != SR_OK && !response)
 596                 return ret;
 597
 598         if (sr_atof_ascii(response, scpi_response) == SR_OK)
 599                 ret = SR_OK;
 600         else
 601                 ret = SR_ERR_DATA;
 602
 603         g_free(response);
 604
 605         return ret;
 606 }
 607
 608 /**
 609  * Send a SCPI command, read the reply, parse it as a double and store the
 610  * result in scpi_response.
 611  *
 612  * @param scpi Previously initialised SCPI device structure.
 613  * @param command The SCPI command to send to the device (can be NULL).
 614  * @param scpi_response Pointer where to store the parsed result.
 615  *
 616  * @return SR_OK on success, SR_ERR* on failure.
 617  */
 618 SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
 619                                const char *command, double *scpi_response)
 620 {
 621         int ret;
 622         char *response;
 623
 624         response = NULL;
 625
 626         ret = sr_scpi_get_string(scpi, command, &response);
 627         if (ret != SR_OK && !response)
 628                 return ret;
 629
 630         if (sr_atod(response, scpi_response) == SR_OK)
 631                 ret = SR_OK;
 632         else
 633                 ret = SR_ERR_DATA;
 634
 635         g_free(response);
 636
 637         return ret;
 638 }
 639
 640 /**
 641  * Send a SCPI *OPC? command, read the reply and return the result of the
 642  * command.
 643  *
 644  * @param scpi Previously initialised SCPI device structure.
 645  *
 646  * @return SR_OK on success, SR_ERR* on failure.
 647  */
 648 SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi)
 649 {
 650         unsigned int i;
 651         gboolean opc;
 652
 653         for (i = 0; i < SCPI_READ_RETRIES; i++) {
 654                 sr_scpi_get_bool(scpi, SCPI_CMD_OPC, &opc);
 655                 if (opc)
 656                         return SR_OK;
 657                 g_usleep(SCPI_READ_RETRY_TIMEOUT_US);
 658         }
 659
 660         return SR_ERR;
 661 }
 662
 663 /**
 664  * Send a SCPI command, read the reply, parse it as comma separated list of
 665  * floats and store the as an result in scpi_response.
 666  *
 667  * @param scpi Previously initialised SCPI device structure.
 668  * @param command The SCPI command to send to the device (can be NULL).
 669  * @param scpi_response Pointer where to store the parsed result.
 670  *
 671  * @return SR_OK upon successfully parsing all values, SR_ERR* upon a parsing
 672  *         error or upon no response. The allocated response must be freed by
 673  *         the caller in the case of an SR_OK as well as in the case of
 674  *         parsing error.
 675  */
 676 SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
 677                                const char *command, GArray **scpi_response)
 678 {
 679         int ret;
 680         float tmp;
 681         char *response;
 682         gchar **ptr, **tokens;
 683         GArray *response_array;
 684
 685         response = NULL;
 686         tokens = NULL;
 687
 688         ret = sr_scpi_get_string(scpi, command, &response);
 689         if (ret != SR_OK && !response)
 690                 return ret;
 691
 692         tokens = g_strsplit(response, ",", 0);
 693         ptr = tokens;
 694
 695         response_array = g_array_sized_new(TRUE, FALSE, sizeof(float), 256);
 696
 697         while (*ptr) {
 698                 if (sr_atof_ascii(*ptr, &tmp) == SR_OK)
 699                         response_array = g_array_append_val(response_array,
 700                                                             tmp);
 701                 else
 702                         ret = SR_ERR_DATA;
 703
 704                 ptr++;
 705         }
 706         g_strfreev(tokens);
 707         g_free(response);
 708
 709         if (ret != SR_OK && response_array->len == 0) {
 710                 g_array_free(response_array, TRUE);
 711                 *scpi_response = NULL;
 712                 return SR_ERR_DATA;
 713         }
 714
 715         *scpi_response = response_array;
 716
 717         return ret;
 718 }
 719
 720 /**
 721  * Send a SCPI command, read the reply, parse it as comma separated list of
 722  * unsigned 8 bit integers and store the as an result in scpi_response.
 723  *
 724  * @param scpi Previously initialised SCPI device structure.
 725  * @param command The SCPI command to send to the device (can be NULL).
 726  * @param scpi_response Pointer where to store the parsed result.
 727  *
 728  * @return SR_OK upon successfully parsing all values, SR_ERR* upon a parsing
 729  *         error or upon no response. The allocated response must be freed by
 730  *         the caller in the case of an SR_OK as well as in the case of
 731  *         parsing error.
 732  */
 733 SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
 734                                const char *command, GArray **scpi_response)
 735 {
 736         int tmp, ret;
 737         char *response;
 738         gchar **ptr, **tokens;
 739         GArray *response_array;
 740
 741         response = NULL;
 742         tokens = NULL;
 743
 744         ret = sr_scpi_get_string(scpi, command, &response);
 745         if (ret != SR_OK && !response)
 746                 return ret;
 747
 748         tokens = g_strsplit(response, ",", 0);
 749         ptr = tokens;
 750
 751         response_array = g_array_sized_new(TRUE, FALSE, sizeof(uint8_t), 256);
 752
 753         while (*ptr) {
 754                 if (sr_atoi(*ptr, &tmp) == SR_OK)
 755                         response_array = g_array_append_val(response_array,
 756                                                             tmp);
 757                 else
 758                         ret = SR_ERR_DATA;
 759
 760                 ptr++;
 761         }
 762         g_strfreev(tokens);
 763         g_free(response);
 764
 765         if (response_array->len == 0) {
 766                 g_array_free(response_array, TRUE);
 767                 *scpi_response = NULL;
 768                 return SR_ERR_DATA;
 769         }
 770
 771         *scpi_response = response_array;
 772
 773         return ret;
 774 }
 775
 776 /**
 777  * Send a SCPI command, read the reply, parse it as binary data with a
 778  * "definite length block" header and store the as an result in scpi_response.
 779  *
 780  * @param scpi Previously initialised SCPI device structure.
 781  * @param command The SCPI command to send to the device (can be NULL).
 782  * @param scpi_response Pointer where to store the parsed result.
 783  *
 784  * @return SR_OK upon successfully parsing all values, SR_ERR* upon a parsing
 785  *         error or upon no response. The allocated response must be freed by
 786  *         the caller in the case of an SR_OK as well as in the case of
 787  *         parsing error.
 788  */
 789 SR_PRIV int sr_scpi_get_block(struct sr_scpi_dev_inst *scpi,
 790                                const char *command, GByteArray **scpi_response)
 791 {
 792         int ret;
 793         GString* response;
 794         char buf[10];
 795         long llen;
 796         long datalen;
 797         gint64 timeout;
 798
 799         if (command)
 800                 if (sr_scpi_send(scpi, command) != SR_OK)
 801                         return SR_ERR;
 802
 803         if (sr_scpi_read_begin(scpi) != SR_OK)
 804                 return SR_ERR;
 805
 806         /*
 807          * Assume an initial maximum length, optionally gets adjusted below.
 808          * Prepare a NULL return value for when error paths will be taken.
 809          */
 810         response = g_string_sized_new(1024);
 811
 812         timeout = g_get_monotonic_time() + scpi->read_timeout_us;
 813
 814         *scpi_response = NULL;
 815
 816         /* Get (the first chunk of) the response. */
 817         while (response->len < 2) {
 818                 ret = sr_scpi_read_response(scpi, response, timeout);
 819                 if (ret < 0) {
 820                         g_string_free(response, TRUE);
 821                         return ret;
 822                 }
 823         }
 824
 825         /*
 826          * SCPI protocol data blocks are preceeded with a length spec.
 827          * The length spec consists of a '#' marker, one digit which
 828          * specifies the character count of the length spec, and the
 829          * respective number of characters which specify the data block's
 830          * length. Raw data bytes follow (thus one must no longer assume
 831          * that the received input stream would be an ASCIIZ string).
 832          *
 833          * Get the data block length, and strip off the length spec from
 834          * the input buffer, leaving just the data bytes.
 835          */
 836         if (response->str[0] != '#') {
 837                 g_string_free(response, TRUE);
 838                 return SR_ERR_DATA;
 839         }
 840         buf[0] = response->str[1];
 841         buf[1] = '\0';
 842         ret = sr_atol(buf, &llen);
 843         if ((ret != SR_OK) || (llen == 0)) {
 844                 g_string_free(response, TRUE);
 845                 return ret;
 846         }
 847
 848         while (response->len < (unsigned long)(2 + llen)) {
 849                 ret = sr_scpi_read_response(scpi, response, timeout);
 850                 if (ret < 0) {
 851                         g_string_free(response, TRUE);
 852                         return ret;
 853                 }
 854         }
 855
 856         memcpy(buf, &response->str[2], llen);
 857         buf[llen] = '\0';
 858         ret = sr_atol(buf, &datalen);
 859         if ((ret != SR_OK) || (datalen == 0)) {
 860                 g_string_free(response, TRUE);
 861                 return ret;
 862         }
 863         g_string_erase(response, 0, 2 + llen);
 864
 865         /*
 866          * If the initially assumed length does not cover the data block
 867          * length, then re-allocate the buffer size to the now known
 868          * length, and keep reading more chunks of response data.
 869          */
 870         if (response->len < (unsigned long)(datalen)) {
 871                 int oldlen = response->len;
 872                 g_string_set_size(response, datalen);
 873                 g_string_set_size(response, oldlen);
 874         }
 875
 876         while (response->len < (unsigned long)(datalen)) {
 877                 ret = sr_scpi_read_response(scpi, response, timeout);
 878                 if (ret < 0) {
 879                         g_string_free(response, TRUE);
 880                         return ret;
 881                 }
 882                 if (ret > 0)
 883                         timeout = g_get_monotonic_time() + scpi->read_timeout_us;
 884         }
 885
 886         /* Convert received data to byte array. */
 887         *scpi_response = g_byte_array_new_take(
 888                 (guint8*)g_string_free(response, FALSE), datalen);
 889
 890         return SR_OK;
 891 }
 892
 893 /**
 894  * Send the *IDN? SCPI command, receive the reply, parse it and store the
 895  * reply as a sr_scpi_hw_info structure in the supplied scpi_response pointer.
 896  *
 897  * The hw_info structure must be freed by the caller via sr_scpi_hw_info_free().
 898  *
 899  * @param scpi Previously initialised SCPI device structure.
 900  * @param scpi_response Pointer where to store the hw_info structure.
 901  *
 902  * @return SR_OK upon success, SR_ERR* on failure.
 903  */
 904 SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
 905                               struct sr_scpi_hw_info **scpi_response)
 906 {
 907         int num_tokens, ret;
 908         char *response;
 909         gchar **tokens;
 910         struct sr_scpi_hw_info *hw_info;
 911
 912         response = NULL;
 913         tokens = NULL;
 914
 915         ret = sr_scpi_get_string(scpi, SCPI_CMD_IDN, &response);
 916         if (ret != SR_OK && !response)
 917                 return ret;
 918
 919         sr_info("Got IDN string: '%s'", response);
 920
 921         /*
 922          * The response to a '*IDN?' is specified by the SCPI spec. It contains
 923          * a comma-separated list containing the manufacturer name, instrument
 924          * model, serial number of the instrument and the firmware version.
 925          */
 926         tokens = g_strsplit(response, ",", 0);
 927
 928         for (num_tokens = 0; tokens[num_tokens] != NULL; num_tokens++);
 929
 930         if (num_tokens < 4) {
 931                 sr_dbg("IDN response not according to spec: %80.s.", response);
 932                 g_strfreev(tokens);
 933                 g_free(response);
 934                 return SR_ERR_DATA;
 935         }
 936         g_free(response);
 937
 938         hw_info = g_malloc0(sizeof(struct sr_scpi_hw_info));
 939         hw_info->manufacturer = g_strstrip(g_strdup(tokens[0]));
 940         hw_info->model = g_strstrip(g_strdup(tokens[1]));
 941         hw_info->serial_number = g_strstrip(g_strdup(tokens[2]));
 942         hw_info->firmware_version = g_strstrip(g_strdup(tokens[3]));
 943
 944         g_strfreev(tokens);
 945
 946         *scpi_response = hw_info;
 947
 948         return SR_OK;
 949 }
 950
 951 /**
 952  * Free a sr_scpi_hw_info struct.
 953  *
 954  * @param hw_info Pointer to the struct to free. If NULL, this
 955  *                function does nothing.
 956  */
 957 SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info)
 958 {
 959         if (!hw_info)
 960                 return;
 961
 962         g_free(hw_info->manufacturer);
 963         g_free(hw_info->model);
 964         g_free(hw_info->serial_number);
 965         g_free(hw_info->firmware_version);
 966         g_free(hw_info);
 967 }